#include <FairMQTransportFactoryZMQ.h>

Inheritance diagram for FairMQTransportFactoryZMQ:

Collaboration diagram for FairMQTransportFactoryZMQ:

Public Member Functions
	FairMQTransportFactoryZMQ (const std::string &id="", const fair::mq::ProgOptions *config=nullptr)

	FairMQTransportFactoryZMQ (const FairMQTransportFactoryZMQ &)=delete

FairMQTransportFactoryZMQ	operator= (const FairMQTransportFactoryZMQ &)=delete

FairMQMessagePtr	CreateMessage () override
	Create empty FairMQMessage. More...

FairMQMessagePtr	CreateMessage (const size_t size) override
	Create new FairMQMessage of specified size. More...

FairMQMessagePtr	CreateMessage (void data, const size_t size, fairmq_free_fn ffn, void *hint=nullptr) override
	Create new FairMQMessage with user provided buffer and size. More...

FairMQMessagePtr	CreateMessage (FairMQUnmanagedRegionPtr &region, void data, const size_t size, void hint=0) override
	create a message with the buffer located within the corresponding unmanaged region More...

FairMQSocketPtr	CreateSocket (const std::string &type, const std::string &name) override
	Create a socket.

FairMQPollerPtr	CreatePoller (const std::vector< FairMQChannel > &channels) const override
	Create a poller for a single channel (all subchannels)

FairMQPollerPtr	CreatePoller (const std::vector< FairMQChannel *> &channels) const override
	Create a poller for specific channels.

FairMQPollerPtr	CreatePoller (const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const override
	Create a poller for specific channels (all subchannels)

FairMQUnmanagedRegionPtr	CreateUnmanagedRegion (const size_t size, FairMQRegionCallback callback, const std::string &path="", int flags=0) const override
	Create new UnmanagedRegion. More...

FairMQUnmanagedRegionPtr	CreateUnmanagedRegion (const size_t size, int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0) const override
	Create new UnmanagedRegion. More...

void	SubscribeToRegionEvents (FairMQRegionEventCallback) override
	Subscribe to region events (creation, destruction, ...) More...

void	UnsubscribeFromRegionEvents () override
	Unsubscribe from region events.

std::vector< FairMQRegionInfo >	GetRegionInfo () override

fair::mq::Transport	GetType () const override
	Get transport type.

void	Interrupt () override

void	Resume () override

void	Reset () override

Public Member Functions inherited from FairMQTransportFactory
	FairMQTransportFactory (const std::string &id)

auto	GetId () const -> const std::string

fair::mq::ChannelResource *	GetMemoryResource ()
	Get a pointer to the associated polymorphic memory resource.

	operator fair::mq::ChannelResource * ()

template<typename T >
FairMQMessagePtr	NewSimpleMessage (const T &data)

template<std::size_t N>
FairMQMessagePtr	NewSimpleMessage (const char(&data)[N])

FairMQMessagePtr	NewSimpleMessage (const std::string &str)

template<typename T >
FairMQMessagePtr	NewStaticMessage (const T &data)

FairMQMessagePtr	NewStaticMessage (const std::string &str)

Additional Inherited Members
Static Public Member Functions inherited from FairMQTransportFactory
static auto	CreateTransportFactory (const std::string &type, const std::string &id="", const fair::mq::ProgOptions *config=nullptr) -> std::shared_ptr< FairMQTransportFactory >

static void	FairMQNoCleanup (void , void )

template<typename T >
static void	FairMQSimpleMsgCleanup (void , void obj)

Detailed Description

FairMQTransportFactoryZMQ.h

Since: 2014-01-20

Author: : A. Rybalchenko

Member Function Documentation

◆ CreateMessage() [1/4]

FairMQMessagePtr FairMQTransportFactoryZMQ::CreateMessage ( )

overridevirtual

Create empty FairMQMessage.

Returns: pointer to FairMQMessage

Implements FairMQTransportFactory.

◆ CreateMessage() [2/4]

FairMQMessagePtr FairMQTransportFactoryZMQ::CreateMessage ( const size_t size )

overridevirtual

Create new FairMQMessage of specified size.

Parameters

size	message size

Returns: pointer to FairMQMessage

Implements FairMQTransportFactory.

◆ CreateMessage() [3/4]

FairMQMessagePtr FairMQTransportFactoryZMQ::CreateMessage	(	void *	data,
		const size_t	size,
		fairmq_free_fn *	ffn,
		void *	hint = `nullptr`
	)

overridevirtual

Create new FairMQMessage with user provided buffer and size.

Parameters

data	pointer to user provided buffer
size	size of the user provided buffer
ffn	callback, called when the message is transfered (and can be deleted)
obj	optional helper pointer that can be used in the callback

Returns: pointer to FairMQMessage

Implements FairMQTransportFactory.

◆ CreateMessage() [4/4]

FairMQMessagePtr FairMQTransportFactoryZMQ::CreateMessage	(	FairMQUnmanagedRegionPtr &	unmanagedRegion,
		void *	data,
		const size_t	size,
		void *	hint = `0`
	)

overridevirtual

create a message with the buffer located within the corresponding unmanaged region

Parameters

unmanagedRegion	the unmanaged region that this message buffer belongs to
data	message buffer (must be within the region - checked at runtime by the transport)
size	size of the message
hint	optional parameter, returned to the user in the FairMQRegionCallback

Implements FairMQTransportFactory.

◆ CreateUnmanagedRegion() [1/2]

FairMQUnmanagedRegionPtr FairMQTransportFactoryZMQ::CreateUnmanagedRegion	(	const size_t	size,
		FairMQRegionCallback	callback,
		const std::string &	path = `""`,
		int	flags = `0`
	)		const

overridevirtual

Create new UnmanagedRegion.

Parameters

size	size of the region
callback	callback to be called when a message belonging to this region is no longer needed by the transport
path	optional parameter to pass to the underlying transport
flags	optional parameter to pass to the underlying transport

Returns: pointer to UnmanagedRegion

Implements FairMQTransportFactory.

◆ CreateUnmanagedRegion() [2/2]

FairMQUnmanagedRegionPtr FairMQTransportFactoryZMQ::CreateUnmanagedRegion	(	const size_t	size,
		int64_t	userFlags,
		FairMQRegionCallback	callback = `nullptr`,
		const std::string &	path = `""`,
		int	flags = `0`
	)		const

overridevirtual

Create new UnmanagedRegion.

Parameters

size	size of the region
userFlags	flags to be stored with the region, have no effect on the transport, but can be retrieved from the region by the user
callback	callback to be called when a message belonging to this region is no longer needed by the transport
path	optional parameter to pass to the underlying transport
flags	optional parameter to pass to the underlying transport

Returns: pointer to UnmanagedRegion

Implements FairMQTransportFactory.

◆ SubscribeToRegionEvents()

void FairMQTransportFactoryZMQ::SubscribeToRegionEvents ( FairMQRegionEventCallback callback )

inlineoverridevirtual

Subscribe to region events (creation, destruction, ...)

Parameters

callback the callback that is called when a region event occurs

Implements FairMQTransportFactory.

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

fairmq/zeromq/FairMQTransportFactoryZMQ.h
fairmq/zeromq/FairMQTransportFactoryZMQ.cxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateMessage() [1/4]

◆ CreateMessage() [2/4]

◆ CreateMessage() [3/4]

◆ CreateMessage() [4/4]

◆ CreateUnmanagedRegion() [1/2]

◆ CreateUnmanagedRegion() [2/2]

◆ SubscribeToRegionEvents()