#include <OutPortPullConnector.h>

Inheritance diagram for RTC::OutPortPullConnector:

Public Member Functions
virtual void	activate ()
	Connector activation.
CdrBufferBase *	createBuffer (ConnectorInfo &info)
	create buffer
virtual void	deactivate ()
	Connector deactivation.
virtual ReturnCode	disconnect ()
	disconnect
virtual CdrBufferBase *	getBuffer ()
	Getting Buffer.
void	onConnect ()
	Invoke callback when connection is established.
void	onDisconnect ()
	Invoke callback when connection is destroied.
DATAPORTSTATUS_ENUM	OutPortPullConnector (ConnectorInfo info, OutPortProvider provider, ConnectorListeners &listeners, CdrBufferBase buffer=0)
	Constructor.
virtual ReturnCode	write (const cdrMemoryStream &data)
	Writing data.
virtual	~OutPortPullConnector ()
	Destructor.
Protected Attributes
CdrBufferBase *	m_buffer
	the pointer to the buffer
ConnectorListeners &	m_listeners
	A reference to a ConnectorListener.
OutPortProvider *	m_provider
	the pointer to the OutPortProvider

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: