itch::io::MessageSink Class Reference

A generic streaming sink for parsed ITCH messages. More...

#include <sink.hpp>

Inheritance diagram for itch::io::MessageSink:

Public Member Functions
	MessageSink ()=default
	Default-constructs an empty sink.
	MessageSink (const MessageSink &)=default
	Copy-constructs a sink.
	MessageSink (MessageSink &&) noexcept=default
	Move-constructs a sink.
auto	operator= (const MessageSink &) -> MessageSink &=default
	Copy-assigns a sink.
auto	operator= (MessageSink &&) noexcept -> MessageSink &=default
	Move-assigns a sink.
virtual	~MessageSink ()=default
	Virtual destructor for safe polymorphic destruction.
virtual auto	write (const Message &message) -> void=0
	Consumes one parsed message.
virtual auto	flush () -> void
	Flushes any buffered output. The default is a no-op.

Detailed Description

A generic streaming sink for parsed ITCH messages.

Sinks are the universal output side of the library: a parse callback can hand every message to a sink, which writes it somewhere (CSV, Arrow, a socket, a counter). Implementations override write; flush is optional.

Definition at line 21 of file sink.hpp.

Constructor & Destructor Documentation

MessageSink() [1/3]

itch::io::MessageSink::MessageSink ( )

default

Default-constructs an empty sink.

MessageSink() [2/3]

itch::io::MessageSink::MessageSink ( const MessageSink &  )

default

Copy-constructs a sink.

MessageSink() [3/3]

itch::io::MessageSink::MessageSink ( MessageSink &&  )

defaultnoexcept

Move-constructs a sink.

~MessageSink()

virtual itch::io::MessageSink::~MessageSink ( )

virtualdefault

Virtual destructor for safe polymorphic destruction.

Member Function Documentation

operator=() [1/2]

auto itch::io::MessageSink::operator= ( const MessageSink &  ) -> MessageSink &=default

default

Copy-assigns a sink.

Returns

Reference to this sink.

operator=() [2/2]

auto itch::io::MessageSink::operator= ( MessageSink &&  ) -> MessageSink &=default

defaultnoexcept

Move-assigns a sink.

Returns

Reference to this sink.

write()

virtual auto itch::io::MessageSink::write ( const Message &  message ) -> void

pure virtual

Consumes one parsed message.

Parameters

message

The parsed message to write.

Implemented in itch::io::CsvSink.

flush()

virtual auto itch::io::MessageSink::flush ( ) -> void

inlinevirtual

Flushes any buffered output. The default is a no-op.

Reimplemented in itch::io::CsvSink.

Definition at line 51 of file sink.hpp.

---

The documentation for this class was generated from the following file:

• sink.hpp