Public Types | Public Member Functions | List of all members
RTT::mqueue::MQTemplateProtocolBase< T > Class Template Reference

#include <MQTemplateProtocolBase.hpp>

Inheritance diagram for RTT::mqueue::MQTemplateProtocolBase< T >:
Inheritance graph

Public Types

typedef T UserType

Public Member Functions

virtual base::ChannelElementBase::shared_ptr createStream (base::PortInterface *port, const ConnPolicy &policy, bool is_sender) const
- Public Member Functions inherited from RTT::types::TypeMarshaller
virtual void * createCookie () const
virtual void deleteCookie (void *cookie) const
virtual std::pair< void const *, int > fillBlob (base::DataSourceBase::shared_ptr source, void *blob, int size, void *cookie=0) const =0
virtual unsigned int getSampleSize (base::DataSourceBase::shared_ptr sample, void *cookie=0) const =0
virtual bool updateFromBlob (const void *blob, int size, base::DataSourceBase::shared_ptr target, void *cookie=0) const =0
- Public Member Functions inherited from RTT::types::TypeTransporter
virtual ~TypeTransporter ()

Detailed Description

template<class T>
class RTT::mqueue::MQTemplateProtocolBase< T >

For each transportable type T, specify the conversion functions.

This can only be used if T is a trivial type without meaningful (copy) constructor. For all other cases, or in doubt, use the MQSerializationProtocol class.

Definition at line 60 of file MQTemplateProtocolBase.hpp.

Member Typedef Documentation

template<class T >
typedef T RTT::mqueue::MQTemplateProtocolBase< T >::UserType

The given T parameter is the type for reading DataSources.

Definition at line 67 of file MQTemplateProtocolBase.hpp.

Member Function Documentation

template<class T >
virtual base::ChannelElementBase::shared_ptr RTT::mqueue::MQTemplateProtocolBase< T >::createStream ( base::PortInterface port,
const ConnPolicy policy,
bool  is_sender 
) const

Creates a streaming channel element for reading or writing over this transport. It returns a ChannelElementBase that provides the implementation of sending or receiving data through the transport. Both sender and receiver find each other using the channel_id argument. Transports that do not support streaming may return null

portThe port for which this channel is setup.
channel_idIf the transport receives a non-empty channel_id, it will create a channel that connects to this id. If channel id is empty, it will be filled in with a unique identifier that identifies this channel. This allows the local caller to connect to the remote channel in a second invocation of createRemoteChannel.
is_senderSet to true in case you will write() to this channel element, set it to false in case you will read() from this channel element.
null in case streaming is not supported by this transport or a valid channel element otherwise.

Implements RTT::types::TypeTransporter.

Definition at line 69 of file MQTemplateProtocolBase.hpp.

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

Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:47