Public Member Functions | Protected Attributes | List of all members
RTT::mqueue::MQSendRecv Class Reference

#include <MQSendRecv.hpp>

Inheritance diagram for RTT::mqueue::MQSendRecv:
Inheritance graph

Public Member Functions

void cleanupStream ()
virtual void mqNewSample (base::DataSourceBase::shared_ptr ds)
bool mqRead (base::DataSourceBase::shared_ptr ds)
virtual bool mqReady (base::DataSourceBase::shared_ptr ds, base::ChannelElementBase *chan)
 MQSendRecv (types::TypeMarshaller const &transport)
bool mqWrite (base::DataSourceBase::shared_ptr ds)
void setupStream (base::DataSourceBase::shared_ptr ds, base::PortInterface *port, ConnPolicy const &policy, bool is_sender)
 ~MQSendRecv ()

Protected Attributes

char * buf
void * marshaller_cookie
int max_size
int mdata_size
bool minit_done
bool mis_sender
mqd_t mqdes
std::string mqname
types::TypeMarshaller const & mtransport

Detailed Description

Implements the sending/receiving of mqueue messages. It can only be OR sender OR receiver (logical XOR).

Definition at line 54 of file MQSendRecv.hpp.

Constructor & Destructor Documentation

MQSendRecv::MQSendRecv ( types::TypeMarshaller const &  transport)

Create a channel element for remote data exchange.

transportThe type specific object that will be used to marshal the data.

Definition at line 64 of file MQSendRecv.cpp.

MQSendRecv::~MQSendRecv ( )

Definition at line 153 of file MQSendRecv.cpp.

Member Function Documentation

void MQSendRecv::cleanupStream ( )

Definition at line 159 of file MQSendRecv.cpp.

void MQSendRecv::mqNewSample ( base::DataSourceBase::shared_ptr  ds)

Adapts the mq send/receive buffer size according to the data in mqdata_source, or the value set in mdata_size;


Definition at line 188 of file MQSendRecv.cpp.

bool MQSendRecv::mqRead ( base::DataSourceBase::shared_ptr  ds)

Read from the message queue.

samplestores the resulting data sample.
true if an item could be read.

Definition at line 246 of file MQSendRecv.cpp.

bool MQSendRecv::mqReady ( base::DataSourceBase::shared_ptr  ds,
base::ChannelElementBase chan 

Works only in receive mode, waits for a new sample and adapts the receive buffer to match it's size.


Definition at line 198 of file MQSendRecv.cpp.

bool MQSendRecv::mqWrite ( base::DataSourceBase::shared_ptr  ds)

Write to the message queue

dsthe data sample to write
is_data_sampletrue if the sample is used for initialization, false if it is a proper write
true if it could be sent.

Definition at line 271 of file MQSendRecv.cpp.

void MQSendRecv::setupStream ( base::DataSourceBase::shared_ptr  ds,
base::PortInterface port,
ConnPolicy const &  policy,
bool  is_sender 

Definition at line 69 of file MQSendRecv.cpp.

Member Data Documentation

char* RTT::mqueue::MQSendRecv::buf

Send/Receive buffer. It is initialized to the size of the value provided by the ConnPolicy or, if the policy has a zero data size, the sample given to setupStream

Its size is saved in max_size

Definition at line 79 of file MQSendRecv.hpp.

void* RTT::mqueue::MQSendRecv::marshaller_cookie

A private blob that is returned by mtransport.getCookie(). It is used by the marshallers if they need private internal data to do the marshalling

Definition at line 67 of file MQSendRecv.hpp.

int RTT::mqueue::MQSendRecv::max_size

The size of buf.

Definition at line 91 of file MQSendRecv.hpp.

int RTT::mqueue::MQSendRecv::mdata_size

The size of the data, as specified in the ConnPolicy when creating the stream, or calculated using the transport when that size was zero.

Definition at line 102 of file MQSendRecv.hpp.

bool RTT::mqueue::MQSendRecv::minit_done

True if setupStream() was called, false after cleanupStream().

Definition at line 87 of file MQSendRecv.hpp.

bool RTT::mqueue::MQSendRecv::mis_sender

True if this object is a sender.

Definition at line 83 of file MQSendRecv.hpp.

mqd_t RTT::mqueue::MQSendRecv::mqdes

MQueue file descriptor.

Definition at line 71 of file MQSendRecv.hpp.

std::string RTT::mqueue::MQSendRecv::mqname

The name of the queue, as specified in the ConnPolicy when creating the stream, or self-calculated when that name was empty.

Definition at line 96 of file MQSendRecv.hpp.

types::TypeMarshaller const& RTT::mqueue::MQSendRecv::mtransport

Transport marshaller used for size calculations and data updates.

Definition at line 61 of file MQSendRecv.hpp.

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

Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:45