RTC::OutPortPullConnector Class Reference

OutPortPullConnector class. More...

#include <OutPortPullConnector.h>

Inheritance diagram for RTC::OutPortPullConnector:

List of all members.

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

---

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

---

Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM 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

virtual RTC::OutPortPullConnector::~OutPortPullConnector

(

)

[virtual]

Destructor.

This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.

---

Member Function Documentation

virtual void RTC::OutPortPullConnector::activate

(

)

[inline, virtual]

Connector activation.

This operation activates this connector

Implements RTC::ConnectorBase.

CdrBufferBase* RTC::OutPortPullConnector::createBuffer

(

ConnectorInfo &

info

)

create buffer

virtual void RTC::OutPortPullConnector::deactivate

(

)

[inline, virtual]

Connector deactivation.

This operation deactivates this connector

Implements RTC::ConnectorBase.

virtual ReturnCode RTC::OutPortPullConnector::disconnect

(

)

[virtual]

disconnect

This operation destruct and delete the consumer, the publisher and the buffer.

Implements RTC::OutPortConnector.

virtual CdrBufferBase* RTC::OutPortPullConnector::getBuffer

(

)

[virtual]

Getting Buffer.

This operation returns this connector's buffer

Implements RTC::OutPortConnector.

void RTC::OutPortPullConnector::onConnect

(

)

Invoke callback when connection is established.

void RTC::OutPortPullConnector::onDisconnect

(

)

Invoke callback when connection is destroied.

virtual ReturnCode RTC::OutPortPullConnector::write

(

const cdrMemoryStream &

data

)

[virtual]

Writing data.

This operation writes data into publisher and then the data will be transferred to correspondent InPort.

Implements RTC::OutPortConnector.

---

Member Data Documentation

CdrBufferBase* RTC::OutPortPullConnector::m_buffer [protected]

the pointer to the buffer

ConnectorListeners& RTC::OutPortPullConnector::m_listeners [protected]

A reference to a ConnectorListener.

OutPortProvider* RTC::OutPortPullConnector::m_provider [protected]

the pointer to the OutPortProvider