|
OpenRTM-aist
1.2.1
|
InPortPullConnector class. More...
#include <InPortPullConnector.h>
Public Member Functions | |
| DATAPORTSTATUS_ENUM | InPortPullConnector (ConnectorInfo info, OutPortConsumer *consumer, ConnectorListeners &listeners, CdrBufferBase *buffer=0) |
| Constructor. More... | |
| virtual | ~InPortPullConnector () |
| Destructor. More... | |
| virtual ReturnCode | read (cdrMemoryStream &data) |
| Destructor. More... | |
| virtual ReturnCode | disconnect () |
| Disconnect connection. More... | |
| virtual void | activate () |
| Connector activation. More... | |
| virtual void | deactivate () |
| Connector deactivation. More... | |
 Public Member Functions inherited from RTC::InPortConnector | |
| DATAPORTSTATUS_ENUM | InPortConnector (ConnectorInfo &info, ConnectorListeners &listeners, CdrBufferBase *buffer) |
| Constructor. More... | |
| virtual | ~InPortConnector () |
| Destructor. More... | |
| virtual const ConnectorInfo & | profile () |
| Getting ConnectorInfo. More... | |
| virtual const char * | id () |
| Getting Connector ID. More... | |
| virtual const char * | name () |
| Getting Connector name. More... | |
| virtual CdrBufferBase * | getBuffer () |
| Getting Buffer. More... | |
| virtual void | setEndian (const bool endian_type) |
| Setting an endian type. More... | |
| virtual bool | isLittleEndian () |
| Whether this connector's endian is little. More... | |
| bool | setOutPort (OutPortBase *directOutPort) |
| template<typename DataType > | |
| bool | getDirectData (DataType &data) |
| Public Member Functions inherited from RTC::ConnectorBase | |
| virtual | ~ConnectorBase () |
| Destructor. More... | |
Protected Member Functions | |
| 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... | |
Additional Inherited Members | |
| Public Types inherited from RTC::DataPortStatus | |
| enum | Enum { PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT, RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET, CONNECTION_LOST, UNKNOWN_ERROR } |
| DataPortStatus return codes. More... | |
| Static Public Member Functions inherited from RTC::DataPortStatus | |
| static const char * | toString (DataPortStatus::Enum status) |
| Convert DataPortStatus into the string. More... | |
| Protected Attributes inherited from RTC::InPortConnector | |
| Logger | rtclog |
| Logger stream. More... | |
| ConnectorInfo | m_profile |
| ConnectorInfo. More... | |
| ConnectorListeners & | m_listeners |
| A reference to a ConnectorListener. More... | |
| CdrBufferBase * | m_buffer |
| Connector's buffer. More... | |
| bool | m_littleEndian |
| Connected Endian. More... | |
| ConnectorListeners * | m_outPortListeners |
| A pointer to a OutPort's ConnectorListener. More... | |
| PortBase * | m_directOutPort |
| OutProt pointer to the peer in the same process. More... | |
InPortPullConnector class.
Connector class of InPort for pull type dataflow. When "pull" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the InPort. This connector and InPortPullConnector make a pair and realize pull 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.
InPortPullConnector owns and manages the following objects.
Data written into the OutPort is passed to the OutPortPullConnector::write(), and is written into the buffer. Consequently, InPort::read() and InPortPullConnector::read() call OutPortConsumer::get(), and it reads data from the buffer of OutPortPullConnector. Finally data would be written into the InPortPullConnector's buffer.
| DATAPORTSTATUS_ENUM RTC::InPortPullConnector::InPortPullConnector | ( | ConnectorInfo | info, |
| OutPortConsumer * | consumer, | ||
| ConnectorListeners & | listeners, | ||
| CdrBufferBase * | buffer = 0 |
||
| ) |
Constructor.
InPortPullConnector's constructor is given the following arguments. According to ConnectorInfo which includes connection information, a buffer is created. It is also given a pointer to the consumer object for the OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortConsumer. OutPortPullConnector 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 | OutPortConsumer |
| 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.
|
inlinevirtual |
|
protected |
create buffer
This function creates a buffer based on given information.
| info | Connector information |
Referenced by deactivate().
|
inlinevirtual |
Connector deactivation.
This operation deactivates this connector
Implements RTC::ConnectorBase.
References createBuffer(), onConnect(), and onDisconnect().
|
virtual |
|
protected |
Invoke callback when connection is established.
Referenced by deactivate().
|
protected |
Invoke callback when connection is destroied.
Referenced by deactivate().
|
virtual |
Destructor.
This function get data from OutPortConsumer. If data is read properly, this function will return PORT_OK return code. Except normal return, BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET and PORT_ERROR will be returned as error codes.
Implements RTC::InPortConnector.
1.8.11
