#include <ZmqSink.hpp>

Collaboration diagram for NES::ZmqSink:

Public Member Functions
	ZmqSink (SinkFormatPtr format, Runtime::NodeEnginePtr nodeEngine, uint32_t numOfProducers, const std::string &host, uint16_t port, bool internal, SharedQueryId sharedQueryId, DecomposedQueryId decomposedQueryId, DecomposedQueryPlanVersion decomposedQueryVersion, uint64_t numberOfOrigins=1)

	~ZmqSink () override

bool	writeData (Runtime::TupleBuffer &inputBuffer, Runtime::WorkerContextRef) override

void	setup () override
	virtual method to setup sink @Note this method will be overwritten by derived classes More...

void	shutdown () override
	virtual method to shutdown sink @Note this method will be overwritten by derived classes More...

std::string	toString () const override
	virtual function to get a string describing the particular sink @Note this function is overwritten by the particular data sink More...

int	getPort () const
	Get zmq sink port. More...

std::string	getHost () const
	Get Zmq address name. More...

SinkMediumTypes	getSinkMediumType () override
	method to return the type of medium More...

Public Member Functions inherited from NES::SinkMedium
	SinkMedium (SinkFormatPtr sinkFormat, Runtime::NodeEnginePtr nodeEngine, uint32_t numOfProducers, SharedQueryId sharedQueryId, DecomposedQueryId decomposedQueryId, DecomposedQueryPlanVersion decomposedQueryVersion)
	public constructor for data sink More...

	SinkMedium (SinkFormatPtr sinkFormat, Runtime::NodeEnginePtr nodeEngine, uint32_t numOfProducers, SharedQueryId sharedQueryId, DecomposedQueryId decomposedQueryId, DecomposedQueryPlanVersion decomposedQueryVersion, uint64_t numberOfOrigins)
	public constructor for data sink More...

virtual bool	writeData (Runtime::TupleBuffer &inputBuffer, Runtime::WorkerContext &workerContext)=0
	method to write a TupleBuffer More...

SharedQueryId	getSharedQueryId () const
	get the id of the owning plan More...

DecomposedQueryId	getParentPlanId () const
	get the subplan id of the owning plan More...

DecomposedQueryPlanVersion	getParentPlanVersion () const
	get the subplan version of the owning plan More...

uint64_t	getNumberOfWrittenOutBuffers ()
	debug function for testing to get number of written buffers More...

uint64_t	getNumberOfWrittenOutTuples ()
	debug function for testing to get number of written tuples More...

SchemaPtr	getSchemaPtr () const
	method to return the current schema of the sink More...

std::string	getSinkFormat ()
	method to get the format as string More...

void	reconfigure (Runtime::ReconfigurationMessage &message, Runtime::WorkerContext &context) override

void	postReconfigurationCallback (Runtime::ReconfigurationMessage &message) override

OperatorId	getOperatorId () const
	Get operator id. More...

void	setMigrationFlag ()
	Sets that sink is used for state migration. More...

bool	isForMigration () const
	Check whether this sink is used for state migration. More...

Public Member Functions inherited from NES::Runtime::Reconfigurable
	~Reconfigurable () NES_NOEXCEPT(false) override=default

Public Member Functions inherited from NES::detail::virtual_enable_shared_from_this< Reconfigurable, false >
	~virtual_enable_shared_from_this () NES_NOEXCEPT(isNoexceptDestructible) override=default

std::shared_ptr< T1 >	shared_from_this ()

std::weak_ptr< T1 >	weak_from_this ()

Public Member Functions inherited from NES::detail::virtual_enable_shared_from_this_base< isNoexceptDestructible >
virtual	~virtual_enable_shared_from_this_base () NES_NOEXCEPT(isNoexceptDestructible)=default

Additional Inherited Members
Protected Attributes inherited from NES::SinkMedium
SinkFormatPtr	sinkFormat

bool	schemaWritten

Runtime::NodeEnginePtr	nodeEngine

std::atomic< uint32_t >	activeProducers
	termination machinery More...

SharedQueryId	sharedQueryId

DecomposedQueryId	decomposedQueryId

DecomposedQueryPlanVersion	decomposedQueryVersion

uint64_t	numberOfOrigins

uint64_t	sentBuffer {0}

uint64_t	sentTuples {0}

std::recursive_mutex	writeMutex

bool	migration {false}

Constructor & Destructor Documentation

◆ ZmqSink()

NES::ZmqSink::ZmqSink	(	SinkFormatPtr	format,
		Runtime::NodeEnginePtr	nodeEngine,
		uint32_t	numOfProducers,
		const std::string &	host,
		uint16_t	port,
		bool	internal,
		SharedQueryId	sharedQueryId,
		DecomposedQueryId	decomposedQueryId,
		DecomposedQueryPlanVersion	decomposedQueryVersion,
		uint64_t	numberOfOrigins = `1`
	)

References host, and NES_DEBUG.

◆ ~ZmqSink()

NES::ZmqSink::~ZmqSink ( )

override

XXX:

References NES_ASSERT2_FMT, NES_DEBUG, and NES_ERROR.

Member Function Documentation

◆ getHost()

std::string NES::ZmqSink::getHost ( ) const

Get Zmq address name.

◆ getPort()

int NES::ZmqSink::getPort ( ) const

Get zmq sink port.

◆ getSinkMediumType()

SinkMediumTypes NES::ZmqSink::getSinkMediumType ( )

overridevirtual

method to return the type of medium

Returns: type of medium

Implements NES::SinkMedium.

References NES::ZMQ_SINK.

◆ setup()

void NES::ZmqSink::setup ( )

overridevirtual

virtual method to setup sink @Note this method will be overwritten by derived classes

Implements NES::SinkMedium.

◆ shutdown()

void NES::ZmqSink::shutdown ( )

overridevirtual

virtual method to shutdown sink @Note this method will be overwritten by derived classes

Implements NES::SinkMedium.

◆ toString()

std::string NES::ZmqSink::toString ( ) const

overridevirtual

virtual function to get a string describing the particular sink @Note this function is overwritten by the particular data sink

Returns: string with name and additional information about the sink

Implements NES::SinkMedium.

References NES::SinkMedium::sinkFormat.

◆ writeData()

bool NES::ZmqSink::writeData	(	Runtime::TupleBuffer &	inputBuffer,
		Runtime::WorkerContextRef
	)

override

References NES::Runtime::TupleBuffer::getBufferSize(), NES::Runtime::TupleBuffer::getNumberOfTuples(), NES::Runtime::TupleBuffer::getWatermark(), NES_DEBUG, NES_ERROR, NES_WARNING, NES::SinkMedium::schemaWritten, NES::SinkMedium::sentBuffer, NES::SinkMedium::sinkFormat, and NES::SinkMedium::writeMutex.

Here is the call graph for this function:

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

/nebulastream/nes-runtime/include/Sinks/Mediums/ZmqSink.hpp
/nebulastream/nes-runtime/src/Sinks/Mediums/ZmqSink.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ZmqSink()

◆ ~ZmqSink()

Member Function Documentation

◆ getHost()

◆ getPort()

◆ getSinkMediumType()

◆ setup()

◆ shutdown()

◆ toString()

◆ writeData()