RTC::OutPortPullConnector Class Reference

OutPortPullConnector class. More...

#include <OutPortPullConnector.h>

Inheritance diagram for RTC::OutPortPullConnector:

Collaboration diagram for RTC::OutPortPullConnector:

Public Member Functions
	OutPortPullConnector (ConnectorInfo info, OutPortProvider *provider, ConnectorListenersBase *listeners, CdrBufferBase *buffer=nullptr)
	Constructor.
	~OutPortPullConnector () override
	Destructor.
DataPortStatus	write (ByteDataStreamBase *data) override
	Writing data.
BufferStatus	read (ByteData &data) override
DataPortStatus	disconnect () override
	disconnect
CdrBufferBase *	getBuffer () override
	Getting Buffer.
void	activate () override
	Connector activation.
void	deactivate () override
	Connector deactivation.
void	onConnect ()
	Invoke callback when connection is established .
void	onDisconnect ()
	Invoke callback when connection is destroied .
Public Member Functions inherited from RTC::OutPortConnector
	OutPortConnector (ConnectorInfo &info, ConnectorListenersBase *listeners)
	Constructor .
	~OutPortConnector () override
	Destructor .
const ConnectorInfo &	profile () override
	Getting Profile.
const char *	id () override
	Getting Connector ID.
const char *	name () override
	Getting Connector name.
virtual void	setEndian (bool endian_type)
	Setting an endian type.
virtual bool	isLittleEndian ()
	return it whether endian setting.
template<class DataType >
DataPortStatus	write (DataType &data)
	The conversion template of the data type.
bool	setInPort (InPortBase *directInPort)
virtual void	setPullDirectMode ()
virtual bool	pullDirectMode ()
virtual void	unsubscribeInterface (const coil::Properties &prop)
Public Member Functions inherited from RTC::ConnectorBase
virtual	~ConnectorBase ()=default
	Destructor .

Static Public Member Functions
static CdrBufferBase *	createBuffer (ConnectorInfo &info)
	create buffer

Protected Attributes
OutPortProvider *	m_provider
	the pointer to the OutPortProvider
ConnectorListenersBase *	m_listeners
	A reference to a ConnectorListener .
CdrBufferBase *	m_buffer
	the pointer to the buffer
Protected Attributes inherited from RTC::OutPortConnector
Logger	rtclog
	Logger streamf .
ConnectorInfo	m_profile
	PortProfile of the Port .
bool	m_littleEndian
	Connected Endian .
PortBase *	m_directInPort
	InProt pointer to the peer in the same process .
ConnectorListenersBase *	m_listeners
	A reference to a ConnectorListener .
ConnectorListenersBase *	m_inPortListeners
	A pointer to a InPort's ConnectorListener .
bool	m_directMode
std::string	m_marshaling_type
ByteDataStreamBase *	m_cdr

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

OutPortPullConnector()

RTC::OutPortPullConnector::OutPortPullConnector	(	ConnectorInfo	info,
		OutPortProvider *	provider,
		ConnectorListenersBase *	listeners,
		CdrBufferBase *	buffer = nullptr )

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

~OutPortPullConnector()

RTC::OutPortPullConnector::~OutPortPullConnector ( )

override

Destructor.

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

Member Function Documentation

activate()

void RTC::OutPortPullConnector::activate ( )

inlineoverridevirtual

Connector activation.

This operation activates this connector

Implements RTC::ConnectorBase.

createBuffer()

static CdrBufferBase * RTC::OutPortPullConnector::createBuffer ( ConnectorInfo & info )

static

create buffer

deactivate()

void RTC::OutPortPullConnector::deactivate ( )

inlineoverridevirtual

Connector deactivation.

This operation deactivates this connector

Implements RTC::ConnectorBase.

disconnect()

DataPortStatus RTC::OutPortPullConnector::disconnect ( )

overridevirtual

disconnect

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

Implements RTC::OutPortConnector.

getBuffer()

CdrBufferBase * RTC::OutPortPullConnector::getBuffer ( )

overridevirtual

Getting Buffer.

This operation returns this connector's buffer

Implements RTC::OutPortConnector.

onConnect()

void RTC::OutPortPullConnector::onConnect

(

)

Invoke callback when connection is established .

onDisconnect()

void RTC::OutPortPullConnector::onDisconnect

(

)

Invoke callback when connection is destroied .

read()

BufferStatus RTC::OutPortPullConnector::read ( ByteData & data )

overridevirtual

Reimplemented from RTC::OutPortConnector.

write()

DataPortStatus RTC::OutPortPullConnector::write ( ByteDataStreamBase * data )

overridevirtual

Writing data.

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

Implements RTC::OutPortConnector.

Member Data Documentation

m_buffer

CdrBufferBase* RTC::OutPortPullConnector::m_buffer

protected

the pointer to the buffer

m_listeners

ConnectorListenersBase* RTC::OutPortPullConnector::m_listeners

protected

A reference to a ConnectorListener .

m_provider

OutPortProvider* RTC::OutPortPullConnector::m_provider

protected

the pointer to the OutPortProvider

---

The documentation for this class was generated from the following file:

• OutPortPullConnector.h