OutPortPullConnector class. More...
#include <OutPortPullConnector.h>
Public Member Functions | |
| virtual void | activate () |
| Connector activation. More... | |
| CdrBufferBase * | createBuffer (ConnectorInfo &info) |
| create buffer More... | |
| virtual void | deactivate () |
| Connector deactivation. More... | |
| virtual ReturnCode | disconnect () |
| disconnect More... | |
| virtual CdrBufferBase * | getBuffer () |
| Getting Buffer. More... | |
| void | onConnect () |
| Invoke callback when connection is established. More... | |
| void | onDisconnect () |
| Invoke callback when connection is destroied. More... | |
| DATAPORTSTATUS_ENUM | OutPortPullConnector (ConnectorInfo info, OutPortProvider *provider, ConnectorListeners &listeners, CdrBufferBase *buffer=0) |
| Constructor. More... | |
| virtual ReturnCode | write (const cdrMemoryStream &data) |
| Writing data. More... | |
| virtual | ~OutPortPullConnector () |
| Destructor. More... | |
 Public Member Functions inherited from RTC::OutPortConnector | |
| const char * | id () |
| Getting Connector ID. More... | |
| virtual bool | isLittleEndian () |
| return it whether endian setting. More... | |
| const char * | name () |
| Getting Connector name. More... | |
| DATAPORTSTATUS_ENUM | OutPortConnector (ConnectorInfo &info) |
| Constructor. More... | |
| const ConnectorInfo & | profile () |
| Getting Profile. More... | |
| virtual void | setEndian (const bool endian_type) |
| Setting an endian type. More... | |
| template<class DataType > | |
| ReturnCode | write (const DataType &data) |
| The conversion template of the data type. More... | |
| virtual | ~OutPortConnector () |
| Destructor. More... | |
| Public Member Functions inherited from RTC::ConnectorBase | |
| virtual | ~ConnectorBase () |
| Destructor. More... | |
Protected Attributes | |
| CdrBufferBase * | m_buffer |
| the pointer to the buffer More... | |
| ConnectorListeners & | m_listeners |
| A reference to a ConnectorListener. More... | |
| OutPortProvider * | m_provider |
| the pointer to the OutPortProvider More... | |
| Protected Attributes inherited from RTC::OutPortConnector | |
| cdrMemoryStream | m_cdr |
| CDR stream. More... | |
| bool | m_littleEndian |
| Connected Endian. More... | |
| ConnectorInfo | m_profile |
| PortProfile of the Port. More... | |
| Logger | rtclog |
| Logger stream. 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... | |
Detailed Description
OutPortPullConnector class.
Connector class of OutPort 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 OutPort. 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.
OutPortPullConnector owns and manages the following objects.
- InPortConsumer
- Buffer
Data written into the OutPort is passed to OutPortPullConnector::write(), and it is written into the buffer. By reading data from OutPortPullConnector to InPortPullConnector, data transfer is realized.
- Since
- 1.0.0
Definition at line 81 of file OutPortPullConnector.h.
Constructor & Destructor Documentation
| RTC::OutPortPullConnector::OutPortPullConnector | ( | ConnectorInfo | info, |
| OutPortProvider * | provider, | ||
| ConnectorListeners & | listeners, | ||
| CdrBufferBase * | buffer = 0 |
||
| ) |
Constructor.
OutPortPullConnector'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 provider object for the OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortProvider. 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.
- Parameters
-
info ConnectorInfo provider OutPortProvider listeners ConnectorListeners type lsitener object list buffer CdrBufferBase type buffer
Mock OutPortPullConnector
Definition at line 32 of file OutPortPullConnector.cpp.
|
virtual |
Destructor.
This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.
Definition at line 65 of file OutPortPullConnector.cpp.
Member Function Documentation
|
inlinevirtual |
Connector activation.
This operation activates this connector
Implements RTC::ConnectorBase.
Definition at line 213 of file OutPortPullConnector.h.
| CdrBufferBase * RTC::OutPortPullConnector::createBuffer | ( | ConnectorInfo & | info | ) |
create buffer
Definition at line 139 of file OutPortPullConnector.cpp.
|
inlinevirtual |
Connector deactivation.
This operation deactivates this connector
Implements RTC::ConnectorBase.
Definition at line 229 of file OutPortPullConnector.h.
|
virtual |
disconnect
Disconnect connection.
This operation destruct and delete the consumer, the publisher and the buffer.
Implements RTC::OutPortConnector.
Definition at line 92 of file OutPortPullConnector.cpp.
|
virtual |
Getting Buffer.
This operation returns this connector's buffer
Implements RTC::OutPortConnector.
Definition at line 127 of file OutPortPullConnector.cpp.
| void RTC::OutPortPullConnector::onConnect | ( | ) |
Invoke callback when connection is established.
Definition at line 154 of file OutPortPullConnector.cpp.
| void RTC::OutPortPullConnector::onDisconnect | ( | ) |
Invoke callback when connection is destroied.
Definition at line 166 of file OutPortPullConnector.cpp.
|
virtual |
Writing data.
Destructor.
This operation writes data into publisher and then the data will be transferred to correspondent InPort.
Implements RTC::OutPortConnector.
Definition at line 79 of file OutPortPullConnector.cpp.
Member Data Documentation
|
protected |
the pointer to the buffer
Definition at line 285 of file OutPortPullConnector.h.
|
protected |
A reference to a ConnectorListener.
Definition at line 276 of file OutPortPullConnector.h.
|
protected |
the pointer to the OutPortProvider
Definition at line 267 of file OutPortPullConnector.h.
The documentation for this class was generated from the following files: