OpenRTM-aist
1.2.1
|
OutPortPushConnector class. More...
#include <OutPortPushConnector.h>
Public Member Functions | |
DATAPORTSTATUS_ENUM | OutPortPushConnector (ConnectorInfo info, InPortConsumer *consumer, ConnectorListeners &listeners, CdrBufferBase *buffer=0) |
Constructor. More... | |
virtual | ~OutPortPushConnector () |
Destructor. More... | |
virtual ReturnCode | write (cdrMemoryStream &data) |
Writing data. More... | |
virtual ReturnCode | disconnect () |
disconnect More... | |
virtual void | activate () |
Connector activation. More... | |
virtual void | deactivate () |
Connector deactivation. More... | |
virtual CdrBufferBase * | getBuffer () |
Getting Buffer. More... | |
Public Member Functions inherited from RTC::OutPortConnector | |
DATAPORTSTATUS_ENUM | OutPortConnector (ConnectorInfo &info, ConnectorListeners &listeners) |
Constructor. More... | |
virtual | ~OutPortConnector () |
Destructor. More... | |
const ConnectorInfo & | profile () |
Getting Profile. More... | |
const char * | id () |
Getting Connector ID. More... | |
const char * | name () |
Getting Connector name. More... | |
virtual void | setEndian (const bool endian_type) |
Setting an endian type. More... | |
virtual bool | isLittleEndian () |
return it whether endian setting. More... | |
template<class DataType > | |
ReturnCode | write (DataType &data) |
The conversion template of the data type. More... | |
bool | setInPort (InPortBase *directInPort) |
virtual void | setPullDirectMode () |
virtual bool | pullDirectMode () |
Public Member Functions inherited from RTC::ConnectorBase | |
virtual | ~ConnectorBase () |
Destructor. More... | |
Protected Member Functions | |
virtual PublisherBase * | createPublisher (ConnectorInfo &info) |
create buffer More... | |
virtual CdrBufferBase * | createBuffer (ConnectorInfo &info) |
create buffer More... | |
void | onConnect () |
Invoke callback when connection is established. More... | |
void | onDisconnect () |
Invoke callback when connection is destroied. More... | |
OutPortPushConnector class.
Connector class of OutPort for push type dataflow. When "push" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the OutPort. This connector and InPortPushConnector make a pair and realize push type dataflow of data ports. One connector corresponds to one connection which provides a data stream. Connector is distinguished by ID of the UUID that is generated at establishing connection.
OutPortPushConnector owns and manages the following objects.
Data written into the OutPort is passed to OutPortPushConnector::write(), and the connector writes into the publisher. The publisher gets data from the buffer based on the policy and it is transferred to InPort by pushing it into the InPortConsumer.
DATAPORTSTATUS_ENUM RTC::OutPortPushConnector::OutPortPushConnector | ( | ConnectorInfo | info, |
InPortConsumer * | consumer, | ||
ConnectorListeners & | listeners, | ||
CdrBufferBase * | buffer = 0 |
||
) |
Constructor.
OutPortPushConnector's constructor is given the following arguments. According to ConnectorInfo which includes connection information, a publisher and a buffer are created. It is also given a pointer to the consumer object for the InPort interface. The owner-ship of the pointer is owned by this OutPortPushConnector, it has responsibility to destruct the InPortConsumer. OutPortPushConnector also has ConnectorListeners to provide event callback mechanisms, and they would be called at the proper timing. If data buffer is given by OutPortBase, the pointer to the buffer is also given as arguments.
info | ConnectorInfo |
consumer | InPortConsumer |
listeners | ConnectorListeners type lsitener object list |
buffer | CdrBufferBase type buffer |
|
virtual |
Destructor.
This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.
|
virtual |
|
protectedvirtual |
create buffer
This function creates a buffer based on given information.
info | Connector information |
|
protectedvirtual |
create buffer
This function creates a publisher based on given information.
info | Connector information |
|
virtual |
|
virtual |
disconnect
This operation destruct and delete the consumer, the publisher and the buffer.
Implements RTC::OutPortConnector.
|
virtual |
|
protected |
Invoke callback when connection is established.
|
protected |
Invoke callback when connection is destroied.
|
virtual |
Writing data.
This operation writes data into publisher and then the data will be transferred to correspondent InPort. If data is written properly, this function will return PORT_OK return code. Except normal return, CONNECTION_LOST, BUFFER_FULL, BUFFER_ERROR, PORT_ERROR, BUFFER_TIMEOUT and PRECONDITION_NO_MET will be returned as error codes.
Implements RTC::OutPortConnector.