RTC::PublisherFlush クラス

PublisherFlush クラス [詳解]

#include <PublisherFlush.h>

RTC::PublisherFlush の継承関係図

RTC::PublisherFlush 連携図

公開型
typedef coil::Mutex	Mutex
typedef coil::Condition< Mutex >	Condition
typedef coil::Guard< coil::Mutex >	Guard
基底クラス 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 }

公開メンバ関数
DATAPORTSTATUS_ENUM	PublisherFlush ()
	コンストラクタ [詳解]
virtual	~PublisherFlush (void)
	デストラクタ [詳解]
virtual ReturnCode	init (coil::Properties &prop)
	初期化 [詳解]
virtual ReturnCode	setConsumer (InPortConsumer *consumer)
	InPortコンシューマのセット [詳解]
virtual ReturnCode	setBuffer (CdrBufferBase *buffer)
	バッファのセット [詳解]
virtual ::RTC::DataPortStatus::Enum	setListener (ConnectorInfo &profile, RTC::ConnectorListeners *listeners)
	リスナを設定する。 [詳解]
virtual ReturnCode	write (cdrMemoryStream &data, unsigned long sec, unsigned long usec)
	データを書き込む [詳解]
virtual bool	isActive ()
	アクティブ化確認 [詳解]
virtual ReturnCode	activate ()
	アクティブ化する [詳解]
virtual ReturnCode	deactivate ()
	非アクティブ化する [詳解]
基底クラス RTC::PublisherBase に属する継承公開メンバ関数
virtual DATAPORTSTATUS_ENUM	~PublisherBase (void)
	デストラクタ [詳解]
virtual void	release ()
	Publisher を破棄する。 [詳解]

限定公開メンバ関数
void	onSend (cdrMemoryStream &data)
	ON_SENDのリスナへ通知する。 [詳解]
void	onReceived (cdrMemoryStream &data)
	ON_RECEIVEDのリスナへ通知する。 [詳解]
void	onReceiverFull (cdrMemoryStream &data)
	ON_RECEIVER_FULLのリスナへ通知する。 [詳解]
void	onReceiverTimeout (cdrMemoryStream &data)
	ON_RECEIVER_TIMEOUTのリスナへ通知する。 [詳解]
void	onReceiverError (cdrMemoryStream &data)
	ON_RECEIVER_ERRORのリスナへ通知する。 [詳解]

その他の継承メンバ
基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数
static const char *	toString (DataPortStatus::Enum status)
	DataPortStatus リターンコードを文字列に変換 [詳解]

詳解

PublisherFlush クラス

Flush 型 Publisher クラス バッファ内に格納されている未送信データを送信する。 データ送出を待つコンシューマを、送出する側と同じスレッドで動作させる。

型定義メンバ詳解

typedef coil::Condition<Mutex> RTC::PublisherFlush::Condition

typedef coil::Guard<coil::Mutex> RTC::PublisherFlush::Guard

typedef coil::Mutex RTC::PublisherFlush::Mutex

構築子と解体子

DATAPORTSTATUS_ENUM RTC::PublisherFlush::PublisherFlush

(

)

コンストラクタ

コンストラクタ

virtual RTC::PublisherFlush::~PublisherFlush ( void  )

virtual

デストラクタ

デストラクタ

関数詳解

virtual ReturnCode RTC::PublisherFlush::activate ( )

virtual

アクティブ化する

Publisher をアクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を開始する。初期 化が行われていないなどにより、事前条件を満たさない場合、エラーコー ド PRECONDITION_NOT_MET を返す。

戻り値

PORT_OK 正常終了 PRECONDITION_NOT_MET 事前条件を満たさない

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

virtual ReturnCode RTC::PublisherFlush::deactivate ( )

virtual

非アクティブ化する

Publisher を非アクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を停止する。初期 化が行われていないなどにより、事前条件を満たさない場合、エラーコー ド PRECONDITION_NOT_MET を返す。

戻り値

PORT_OK 正常終了 PRECONDITION_NOT_MET 事前条件を満たさない

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

virtual ReturnCode RTC::PublisherFlush::init ( coil::Properties &  prop )

virtual

初期化

このクラスのオブジェクトを使用するのに先立ち、必ずこの関数を呼び 出す必要がある。ただし、この PublisherFlush は現状で初期化するパ ラメータを持たない。

引数

property

本Publisherの駆動制御情報を設定したPropertyオブジェクト

戻り値

ReturnCode PORT_OK 正常終了 INVALID_ARGS Properties が不正な値を含む

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

virtual bool RTC::PublisherFlush::isActive ( )

virtual

アクティブ化確認

Publisher はデータポートと同期して activate/deactivate される。 activate() / deactivate() 関数によって、アクティブ状態と非アクティ ブ状態が切り替わる。この関数により、現在アクティブ状態か、非アク ティブ状態かを確認することができる。

戻り値

状態確認結果(アクティブ状態:true、非アクティブ状態:false)

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

void RTC::PublisherFlush::onReceived ( cdrMemoryStream &  data )

inlineprotected

ON_RECEIVEDのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_RECEIVED.

void RTC::PublisherFlush::onReceiverError ( cdrMemoryStream &  data )

inlineprotected

ON_RECEIVER_ERRORのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 DLL_EXPORT, RTC::ON_RECEIVER_ERROR, PublisherFlushInit().

void RTC::PublisherFlush::onReceiverFull ( cdrMemoryStream &  data )

inlineprotected

ON_RECEIVER_FULLのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_RECEIVER_FULL.

void RTC::PublisherFlush::onReceiverTimeout ( cdrMemoryStream &  data )

inlineprotected

ON_RECEIVER_TIMEOUTのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_RECEIVER_TIMEOUT.

void RTC::PublisherFlush::onSend ( cdrMemoryStream &  data )

inlineprotected

ON_SENDのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_SEND.

virtual ReturnCode RTC::PublisherFlush::setBuffer ( CdrBufferBase *  buffer )

virtual

バッファのセット

PublisherFlushでは、バッファを使用しないため、いかなる場合も PORT_OK を返す。

引数

buffer

CDRバッファ

戻り値

PORT_OK 正常終了

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

virtual ReturnCode RTC::PublisherFlush::setConsumer ( InPortConsumer *  consumer )

virtual

InPortコンシューマのセット

この関数では、この Publisher に関連付けられるコンシューマをセットする。 コンシューマオブジェクトがヌルポインタの場合、INVALID_ARGSが返される。 それ以外の場合は、PORT_OK が返される。

引数

consumer

Consumer へのポインタ

戻り値

ReturnCode PORT_OK 正常終了 INVALID_ARGS 引数に不正な値が含まれている

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

virtual ::RTC::DataPortStatus::Enum RTC::PublisherFlush::setListener ( ConnectorInfo &  profile, RTC::ConnectorListeners *  listeners  )

virtual

リスナを設定する。

Publisher に対してリスナオブジェクト ConnectorListeners を設定する。 各種リスナオブジェクトを含む ConnectorListeners をセットすることで、 バッファの読み書き、データの送信時等にこれらのリスナをコールする。 ConnectorListeners オブジェクトの所有権はポートまたは RTObject が持ち Publisher 削除時に ConnectorListeners は削除されることはない。 ConnectorListeners がヌルポインタの場合 INVALID_ARGS を返す。

引数

info	ConnectorProfile をローカル化したオブジェクト ConnectorInfo
listeners	リスナを多数保持する ConnectorListeners オブジェクト

戻り値

PORT_OK 正常終了 INVALID_ARGS 不正な引数

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

virtual ReturnCode RTC::PublisherFlush::write ( cdrMemoryStream &  data, unsigned long  sec, unsigned long  usec  )

virtual

データを書き込む

Publisher が保持するコンシューマに対してデータを書き込む。コン シューマ、リスナ等が適切に設定されていない等、Publisher オブジェ クトが正しく初期化されていない場合、この関数を呼び出すとエラーコー ド PRECONDITION_NOT_MET が返され、コンシューマへの書き込み等の操 作は一切行われない。

コンシューマへの書き込みに対して、コンシューマがフル状態、コン シューマのエラー、コンシューマへの書き込みがタイムアウトした場合 にはそれぞれ、エラーコード SEND_FULL, SEND_ERROR, SEND_TIMEOUT が返される。

これら以外のエラーの場合、PORT_ERROR が返される。

引数

data	書き込むデータ
sec	タイムアウト時間
nsec	タイムアウト時間

戻り値

PORT_OK 正常終了 PRECONDITION_NO_MET consumer, buffer, listener等が適切に設定 されていない等、このオブジェクトの事前条件 を満たさない場合。 SEND_FULL 送信先がフル状態 SEND_TIMEOUT 送信先がタイムアウトした CONNECTION_LOST 接続が切断されたことを検知した。

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

---

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

• PublisherFlush.h