RTC::InPortPushConnector クラス

InPortPushConnector クラス [詳解]

#include <InPortPushConnector.h>

RTC::InPortPushConnector の継承関係図

RTC::InPortPushConnector 連携図

公開メンバ関数
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 ()
	非アクティブ化 [詳解]
基底クラス RTC::InPortConnector に属する継承公開メンバ関数
DATAPORTSTATUS_ENUM	InPortConnector (ConnectorInfo &info, ConnectorListeners &listeners, CdrBufferBase *buffer)
	コンストラクタ [詳解]
virtual	~InPortConnector ()
	デストラクタ [詳解]
virtual const ConnectorInfo &	profile ()
	ConnectorInfo 取得 [詳解]
virtual const char *	id ()
	Connector ID 取得 [詳解]
virtual const char *	name ()
	Connector 名取得 [詳解]
virtual CdrBufferBase *	getBuffer ()
	Buffer を取得する [詳解]
virtual void	setEndian (const bool endian_type)
	endianタイプ設定 [詳解]
virtual bool	isLittleEndian ()
	endian 設定を返す [詳解]
bool	setOutPort (OutPortBase *directOutPort)
	データをダイレクトに書き込むためのOutPortのサーバントを設定する [詳解]
template<typename DataType >
bool	getDirectData (DataType &data)
基底クラス RTC::ConnectorBase に属する継承公開メンバ関数
virtual	~ConnectorBase ()
	デストラクタ [詳解]

限定公開メンバ関数
virtual CdrBufferBase *	createBuffer (ConnectorInfo &info)
	Bufferの生成 [詳解]
void	onConnect ()
	接続確立時にコールバックを呼ぶ [詳解]
void	onDisconnect ()
	接続切断時にコールバックを呼ぶ [詳解]
void	onBufferRead (cdrMemoryStream &data)
void	onBufferEmpty (cdrMemoryStream &data)
void	onBufferReadTimeout (cdrMemoryStream &data)

その他の継承メンバ
基底クラス 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 }
基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数
static const char *	toString (DataPortStatus::Enum status)
	DataPortStatus リターンコードを文字列に変換 [詳解]
基底クラス RTC::InPortConnector に属する継承限定公開変数類
Logger	rtclog
	ロガーストリーム [詳解]
ConnectorInfo	m_profile
	ConnectorInfo. [詳解]
ConnectorListeners &	m_listeners
	ConnectorListenrs への参照 [詳解]
CdrBufferBase *	m_buffer
	Connector が保持している Buffer. [詳解]
bool	m_littleEndian
	接続エンディアン [詳解]
ConnectorListeners *	m_outPortListeners
	OutPort 側の ConnectorListenrs への参照 [詳解]
PortBase *	m_directOutPort
	同一プロセス上のピアOutPortのポインタ [詳解]

詳解

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 ( )

inlinevirtual

アクティブ化

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

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

virtual CdrBufferBase* RTC::InPortPushConnector::createBuffer ( ConnectorInfo &  info )

protectedvirtual

Bufferの生成

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

引数

info

接続情報

戻り値

バッファへのポインタ

参照元 deactivate().

virtual void RTC::InPortPushConnector::deactivate ( )

inlinevirtual

非アクティブ化

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

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

参照先 createBuffer(), onConnect(), onDisconnect().

virtual ReturnCode RTC::InPortPushConnector::disconnect ( )

virtual

接続解除

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

戻り値

PORT_OK

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

void RTC::InPortPushConnector::onBufferEmpty ( cdrMemoryStream &  data )

inlineprotected

参照先 RTC::InPortConnector::m_profile, RTC::ON_BUFFER_EMPTY.

void RTC::InPortPushConnector::onBufferRead ( cdrMemoryStream &  data )

inlineprotected

参照先 RTC::InPortConnector::m_profile, RTC::ON_BUFFER_READ.

void RTC::InPortPushConnector::onBufferReadTimeout ( cdrMemoryStream &  data )

inlineprotected

参照先 RTC::InPortConnector::m_profile, RTC::ON_BUFFER_READ_TIMEOUT.

void RTC::InPortPushConnector::onConnect ( )

protected

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

参照元 deactivate().

void RTC::InPortPushConnector::onDisconnect ( )

protected

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

参照元 deactivate().

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を実装しています。

---

このクラス詳解は次のファイルから抽出されました:

• InPortPushConnector.h