クラス RTC::InPortPushConnector

#include <InPortPushConnector.h>

RTC::InPortPushConnectorに対する継承グラフ

Public メソッド
DATAPORTSTATUS_ENUM	InPortPushConnector (ConnectorInfo info, InPortProvider provider, ConnectorListeners &listeners, CdrBufferBase buffer=0)
	コンストラクタ
virtual	~InPortPushConnector ()
	デストラクタ
virtual ReturnCode	read (cdrMemoryStream &data)
	データの読み出し
virtual ReturnCode	disconnect ()
	接続解除
virtual void	activate ()
	アクティブ化
virtual void	deactivate ()
	非アクティブ化
Protected メソッド
virtual CdrBufferBase *	createBuffer (ConnectorInfo &info)
	Bufferの生成.
void	onConnect ()
	接続確立時にコールバックを呼ぶ
void	onDisconnect ()
	接続切断時にコールバックを呼ぶ

説明

InPortPushConnector クラス.

InPort の push 型データフローのための Connector クラス。このオブジェクトは、接続時に dataflow_type に push が指定された場合、 InPort によって生成・所有され、OutPortPushConnector と対になって、データポートの push 型のデータフローを実現する。一つの接続に対して、一つのデータストリームを提供する唯一の Connector が対応する。 Connector は接続時に生成される UUID 形式の ID により区別される。

InPortPushConnector は以下の三つのオブジェクトを所有し管理する。

InPortProvider
Buffer

OutPort に書き込まれたデータは、OutPortConnector によって InPortProvider::put() にデータが渡される。書き込まれたデータは Connector 内で Buffer にデータが書き込まれる。

から:: 1.0.0

コンストラクタとデストラクタ

DATAPORTSTATUS_ENUM RTC::InPortPushConnector::InPortPushConnector	(	ConnectorInfo	info,
		InPortProvider *	provider,
		ConnectorListeners &	listeners,
		CdrBufferBase *	buffer = `0`
	)

コンストラクタ

InPortPushConnector のコンストラクタはオブジェクト生成時に下記を引数にとる。ConnectorInfo は接続情報を含み、この情報に従いバッファ等を生成する。InPort インターフェースのプロバイダオブジェクトへのポインタを取り、所有権を持つので、InPortPushConnector は InPortProvider の解体責任を持つ。各種イベントに対するコールバック機構を提供する ConnectorListeners を持ち、適切なタイミングでコールバックを呼び出す。データバッファがもし InPortBase から提供される場合はそのポインタを取る。

引数:

	info	ConnectorInfo
	provider	InPortProvider
	listeners	ConnectorListeners 型のリスナオブジェクトリスト
	buffer	CdrBufferBase 型のバッファ

Constructor InPortPushConnector'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 InPort interface. The owner-ship of the pointer is owned by this InPortPushConnector, it has responsibility to destruct the InPortProvider. InPortPushConnector also has ConnectorListeners to provide event callback mechanisms, and they would be called at the proper timing. If data buffer is given by InPortBase, the pointer to the buffer is also given as arguments.

引数:

	info	ConnectorInfo
	provider	InPortProvider
	listeners	ConnectorListeners type lsitener object list
	buffer	CdrBufferBase type buffer

virtual RTC::InPortPushConnector::~InPortPushConnector ( ) [virtual]

デストラクタ

disconnect() が呼ばれ、consumer, publisher, buffer が解体・削除される。

関数

virtual void RTC::InPortPushConnector::activate ( ) [inline, virtual]

アクティブ化

このコネクタをアクティブ化する

RTC::ConnectorBaseを実装しています。

virtual CdrBufferBase* RTC::InPortPushConnector::createBuffer ( ConnectorInfo & info ) [protected, virtual]

Bufferの生成.

与えられた接続情報に基づきバッファを生成する。

引数:

info

接続情報

戻り値:: バッファへのポインタ

virtual void RTC::InPortPushConnector::deactivate ( ) [inline, virtual]

非アクティブ化

このコネクタを非アクティブ化する

RTC::ConnectorBaseを実装しています。

virtual ReturnCode RTC::InPortPushConnector::disconnect ( ) [virtual]

接続解除

consumer, publisher, buffer が解体・削除される。

戻り値:: PORT_OK

RTC::InPortConnectorを実装しています。

void RTC::InPortPushConnector::onConnect ( ) [protected]

接続確立時にコールバックを呼ぶ

void RTC::InPortPushConnector::onDisconnect ( ) [protected]

接続切断時にコールバックを呼ぶ

virtual ReturnCode RTC::InPortPushConnector::read ( cdrMemoryStream & data ) [virtual]

データの読み出し

バッファからデータを読み出す。正常に読み出せた場合、戻り値は PORT_OK となり、data に読み出されたデータが格納される。それ以外の場合には、エラー値として BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET, PORT_ERROR が返される。

戻り値:: PORT_OK 正常終了 BUFFER_EMPTY バッファは空である TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー

RTC::InPortConnectorを実装しています。

クラス RTC::InPortPushConnector

Public メソッド

Protected メソッド

説明

コンストラクタとデストラクタ

関数