OpenRTM-aist 2.0.2
|
PublisherFlush クラス [詳解]
#include <PublisherFlush.h>
公開メンバ関数 | |
PublisherFlush () | |
コンストラクタ | |
~PublisherFlush () override | |
デストラクタ | |
DataPortStatus | init (coil::Properties &prop) override |
初期化 | |
DataPortStatus | setConsumer (InPortConsumer *consumer) override |
InPortコンシューマのセット | |
DataPortStatus | setBuffer (CdrBufferBase *buffer) override |
バッファのセット | |
::RTC::DataPortStatus | setListener (ConnectorInfo &info, RTC::ConnectorListenersBase *listeners) override |
リスナを設定する。 | |
DataPortStatus | write (ByteDataStreamBase *data, std::chrono::nanoseconds timeout=std::chrono::nanoseconds(-1)) override |
データを書き込む | |
bool | isActive () override |
アクティブ化確認 | |
DataPortStatus | activate () override |
アクティブ化する | |
DataPortStatus | deactivate () override |
非アクティブ化する | |
![]() | |
virtual | ~PublisherBase ()=default |
デストラクタ | |
virtual DataPortStatus | setBuffer (BufferBase< ByteData > *buffer)=0 |
バッファのセット | |
virtual void | release () |
Publisher を破棄する。 | |
限定公開メンバ関数 | |
void | onSend (ByteData &data) |
ON_SENDのリスナへ通知する。 | |
void | onReceived (ByteData &data) |
ON_RECEIVEDのリスナへ通知する。 | |
void | onReceiverFull (ByteData &data) |
ON_RECEIVER_FULLのリスナへ通知する。 | |
void | onReceiverTimeout (ByteData &data) |
ON_RECEIVER_TIMEOUTのリスナへ通知する。 | |
void | onReceiverError (ByteData &data) |
ON_RECEIVER_ERRORのリスナへ通知する。 | |
PublisherFlush クラス
Flush 型 Publisher クラス バッファ内に格納されている未送信データを送信する。 データ送出を待つコンシューマを、送出する側と同じスレッドで動作させる。
RTC::PublisherFlush::PublisherFlush | ( | ) |
コンストラクタ
コンストラクタ
|
override |
デストラクタ
デストラクタ
|
overridevirtual |
アクティブ化する
Publisher をアクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を開始する。初期 化が行われていないなどにより、事前条件を満たさない場合、エラーコー ド PRECONDITION_NOT_MET を返す。
RTC::PublisherBaseを実装しています。
|
overridevirtual |
非アクティブ化する
Publisher を非アクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を停止する。初期 化が行われていないなどにより、事前条件を満たさない場合、エラーコー ド PRECONDITION_NOT_MET を返す。
RTC::PublisherBaseを実装しています。
|
overridevirtual |
初期化
このクラスのオブジェクトを使用するのに先立ち、必ずこの関数を呼び 出す必要がある。ただし、この PublisherFlush は現状で初期化するパ ラメータを持たない。
property | 本Publisherの駆動制御情報を設定したPropertyオブジェクト |
RTC::PublisherBaseを実装しています。
|
overridevirtual |
アクティブ化確認
Publisher はデータポートと同期して activate/deactivate される。 activate() / deactivate() 関数によって、アクティブ状態と非アクティ ブ状態が切り替わる。この関数により、現在アクティブ状態か、非アク ティブ状態かを確認することができる。
RTC::PublisherBaseを実装しています。
|
inlineprotected |
ON_RECEIVEDのリスナへ通知する。
data | cdrMemoryStream |
参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVED.
|
inlineprotected |
ON_RECEIVER_ERRORのリスナへ通知する。
data | cdrMemoryStream |
参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVER_ERROR.
|
inlineprotected |
ON_RECEIVER_FULLのリスナへ通知する。
data | cdrMemoryStream |
参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVER_FULL.
|
inlineprotected |
ON_RECEIVER_TIMEOUTのリスナへ通知する。
data | cdrMemoryStream |
参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVER_TIMEOUT.
|
inlineprotected |
ON_SENDのリスナへ通知する。
data | cdrMemoryStream |
|
override |
バッファのセット
PublisherFlushでは、バッファを使用しないため、いかなる場合も PORT_OK を返す。
buffer | CDRバッファ |
|
overridevirtual |
InPortコンシューマのセット
この関数では、この Publisher に関連付けられるコンシューマをセットする。 コンシューマオブジェクトがヌルポインタの場合、INVALID_ARGSが返される。 それ以外の場合は、PORT_OK が返される。
consumer | Consumer へのポインタ |
RTC::PublisherBaseを実装しています。
|
overridevirtual |
リスナを設定する。
Publisher に対してリスナオブジェクト ConnectorListeners を設定する。 各種リスナオブジェクトを含む ConnectorListeners をセットすることで、 バッファの読み書き、データの送信時等にこれらのリスナをコールする。 ConnectorListeners オブジェクトの所有権はポートまたは RTObject が持ち Publisher 削除時に ConnectorListeners は削除されることはない。 ConnectorListeners がヌルポインタの場合 INVALID_ARGS を返す。
info | ConnectorProfile をローカル化したオブジェクト ConnectorInfo |
listeners | リスナを多数保持する ConnectorListeners オブジェクト |
RTC::PublisherBaseを実装しています。
|
overridevirtual |
データを書き込む
Publisher が保持するコンシューマに対してデータを書き込む。コン シューマ、リスナ等が適切に設定されていない等、Publisher オブジェ クトが正しく初期化されていない場合、この関数を呼び出すとエラーコー ド PRECONDITION_NOT_MET が返され、コンシューマへの書き込み等の操 作は一切行われない。
コンシューマへの書き込みに対して、コンシューマがフル状態、コン シューマのエラー、コンシューマへの書き込みがタイムアウトした場合 にはそれぞれ、エラーコード SEND_FULL, SEND_ERROR, SEND_TIMEOUT が返される。
これら以外のエラーの場合、PORT_ERROR が返される。
data | 書き込むデータ |
timeout | タイムアウト時間 |
RTC::PublisherBaseを実装しています。