#include <MQTemplateProtocolBase.hpp>
Public Types | |
| typedef T | UserType |
Public Member Functions | |
| virtual base::ChannelElementBase::shared_ptr | createStream (base::PortInterface *port, const ConnPolicy &policy, bool is_sender) const |
Detailed Description
template<class T>
class RTT::mqueue::MQTemplateProtocolBase< T >
For each transportable type T, specify the conversion functions.
- Warning:
- 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
| typedef T RTT::mqueue::MQTemplateProtocolBase< T >::UserType |
The given T parameter is the type for reading DataSources.
Reimplemented in RTT::mqueue::MQTemplateProtocol< T >.
Definition at line 67 of file MQTemplateProtocolBase.hpp.
Member Function Documentation
| virtual base::ChannelElementBase::shared_ptr RTT::mqueue::MQTemplateProtocolBase< T >::createStream | ( | base::PortInterface * | port, |
| const ConnPolicy & | policy, | ||
| bool | is_sender | ||
| ) | const [inline, virtual] |
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
- Parameters:
-
port The port for which this channel is setup. channel_id If 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_sender Set to true in case you will write() to this channel element, set it to false in case you will read() from this channel element.
- Returns:
- 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: