|
OpenRTM-aist
1.1.2
|
PublisherNew クラス [詳解]
#include <PublisherNew.h>
公開型 | |
| 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 | PublisherNew () |
| コンストラクタ [詳解] | |
| virtual | ~PublisherNew (void) |
| デストラクタ [詳解] | |
| virtual ReturnCode | init (coil::Properties &prop) |
| 初期化 [詳解] | |
| virtual ReturnCode | setConsumer (InPortConsumer *consumer) |
| InPortコンシューマのセット [詳解] | |
| virtual ReturnCode | setBuffer (CdrBufferBase *buffer) |
| バッファのセット [詳解] | |
| virtual ReturnCode | setListener (ConnectorInfo &info, ConnectorListeners *listeners) |
| リスナを設定する。 [詳解] | |
| virtual ReturnCode | write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec) |
| データを書き込む [詳解] | |
| virtual bool | isActive () |
| アクティブ化確認 [詳解] | |
| virtual ReturnCode | activate () |
| アクティブ化する [詳解] | |
| virtual ReturnCode | deactivate () |
| 非アクティブ化する [詳解] | |
| virtual int | svc (void) |
| スレッド実行関数 [詳解] | |
基底クラス RTC::PublisherBase に属する継承公開メンバ関数 | |
| virtual DATAPORTSTATUS_ENUM | ~PublisherBase (void) |
| デストラクタ [詳解] | |
| virtual void | release () |
| Publisher を破棄する。 [詳解] | |
限定公開型 | |
| enum | Policy { ALL, FIFO, SKIP, NEW } |
限定公開メンバ関数 | |
| void | setPushPolicy (const coil::Properties &prop) |
| PushPolicy の設定 [詳解] | |
| bool | createTask (const coil::Properties &prop) |
| Task の設定 [詳解] | |
| ReturnCode | pushAll () |
| push "all" policy [詳解] | |
| ReturnCode | pushFifo () |
| push "fifo" policy [詳解] | |
| ReturnCode | pushSkip () |
| push "skip" policy [詳解] | |
| ReturnCode | pushNew () |
| push "new" policy [詳解] | |
| ReturnCode | convertReturn (BufferStatus::Enum status, const cdrMemoryStream &data) |
| BufferStatus から DataPortStatus への変換 [詳解] | |
| ReturnCode | invokeListener (DataPortStatus::Enum status, const cdrMemoryStream &data) |
| DataPortStatusに従ってリスナへ通知する関数を呼び出す。 [詳解] | |
| void | onBufferWrite (const cdrMemoryStream &data) |
| ON_BUFFER_WRITEのリスナへ通知する。 [詳解] | |
| void | onBufferFull (const cdrMemoryStream &data) |
| ON_BUFFER_FULLリスナへイベントを通知する。 [詳解] | |
| void | onBufferWriteTimeout (const cdrMemoryStream &data) |
| ON_BUFFER_WRITE_TIMEOUTのリスナへ通知する。 [詳解] | |
| void | onBufferWriteOverwrite (const cdrMemoryStream &data) |
| ON_BUFFER_OVERWRITEのリスナへ通知する。 [詳解] | |
| void | onBufferRead (const cdrMemoryStream &data) |
| ON_BUFFER_READのリスナへ通知する。 [詳解] | |
| void | onSend (const cdrMemoryStream &data) |
| ON_SENDのリスナへ通知する。 [詳解] | |
| void | onReceived (const cdrMemoryStream &data) |
| ON_RECEIVEDのリスナへ通知する。 [詳解] | |
| void | onReceiverFull (const cdrMemoryStream &data) |
| ON_RECEIVER_FULLのリスナへ通知する。 [詳解] | |
| void | onReceiverTimeout (const cdrMemoryStream &data) |
| ON_RECEIVER_TIMEOUTのリスナへ通知する。 [詳解] | |
| void | onReceiverError (const cdrMemoryStream &data) |
| ON_RECEIVER_ERRORのリスナへ通知する。 [詳解] | |
| void | onSenderError () |
| ON_SENDER_ERRORのリスナへ通知する。 [詳解] | |
その他の継承メンバ | |
基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数 | |
| static const char * | toString (DataPortStatus::Enum status) |
| DataPortStatus リターンコードを文字列に変換 [詳解] | |
PublisherNew クラス
バッファ内に新規データが格納されたタイミングで、その新規データを送信する。 データ送出タイミングを待つコンシューマを、送出する側とは異なるスレッドで 動作させる場合に使用。 Publisherの駆動は、データ送出のタイミングになるまでブロックされ、 送出タイミングの通知を受けると、即座にコンシューマの送出処理を呼び出す。
| typedef coil::Mutex RTC::PublisherNew::Mutex |
|
protected |
| DATAPORTSTATUS_ENUM RTC::PublisherNew::PublisherNew | ( | ) |
コンストラクタ
コンストラクタ
|
virtual |
デストラクタ
デストラクタ
|
virtual |
アクティブ化する
Publisher をアクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を開始する。初期 化が行われていないなどにより、事前条件を満たさない場合、エラーコー ド PRECONDITION_NOT_MET を返す。
RTC::PublisherBaseを実装しています。
|
protected |
BufferStatus から DataPortStatus への変換
バッファからの戻り値を DataPortStatus::Enum 型へ変換する関数。そ れぞれ、以下のように変換される。変換時にコールバックを呼ぶ場合、 コールバク関数も付記する。
| status | BufferStatus |
| data | cdrMemoryStream |
|
protected |
Task の設定
|
virtual |
非アクティブ化する
Publisher を非アクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を停止する。初期 化が行われていないなどにより、事前条件を満たさない場合、エラーコー ド PRECONDITION_NOT_MET を返す。
RTC::PublisherBaseを実装しています。
|
virtual |
初期化
このクラスのオブジェクトを使用するのに先立ち、必ずこの関数を呼び 出す必要がある。引数には、このオブジェクトの各種設定情報を含む Properties を与える。データをプッシュする際のポリシーとして publisher.push_policy をキーとする値に、all, fifo, skip, new の いずれかを与えることができる。
以下のオプションを与えることができる。
| property | 本Publisherの駆動制御情報を設定したPropertyオブジェクト |
RTC::PublisherBaseを実装しています。
|
protected |
|
virtual |
アクティブ化確認
Publisher はデータポートと同期して activate/deactivate される。 activate() / deactivate() 関数によって、アクティブ状態と非アクティ ブ状態が切り替わる。この関数により、現在アクティブ状態か、非アク ティブ状態かを確認することができる。
RTC::PublisherBaseを実装しています。
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
ON_SENDER_ERRORのリスナへ通知する。
| data | cdrMemoryStream |
|
protected |
push "all" policy
|
protected |
push "fifo" policy
|
protected |
push "new" policy
|
protected |
push "skip" policy
|
virtual |
バッファのセット
この関数では、この Publisher に関連付けられるバッファをセットする。 バッファオブジェクトがヌルポインタの場合、INVALID_ARGSが返される。 それ以外の場合は、PORT_OK が返される。
| buffer | CDR buffer へのポインタ |
RTC::PublisherBaseを実装しています。
|
virtual |
InPortコンシューマのセット
この関数では、この Publisher に関連付けられるコンシューマをセットする。 コンシューマオブジェクトがヌルポインタの場合、INVALID_ARGSが返される。 それ以外の場合は、PORT_OK が返される。
| consumer | Consumer へのポインタ |
RTC::PublisherBaseを実装しています。
|
virtual |
リスナを設定する。
Publisher に対してリスナオブジェクト ConnectorListeners を設定する。 各種リスナオブジェクトを含む ConnectorListeners をセットすることで、 バッファの読み書き、データの送信時等にこれらのリスナをコールする。 ConnectorListeners オブジェクトの所有権はポートまたは RTObject が持ち Publisher 削除時に ConnectorListeners は削除されることはない。 ConnectorListeners がヌルポインタの場合 INVALID_ARGS を返す。
| info | ConnectorProfile をローカル化したオブジェクト ConnectorInfo |
| listeners | リスナを多数保持する ConnectorListeners オブジェクト |
RTC::PublisherBaseを実装しています。
|
protected |
PushPolicy の設定
|
virtual |
スレッド実行関数
coil::PeriodicTask により周期実行されるタスク実行関数。
|
virtual |
データを書き込む
Publisher が保持するバッファに対してデータを書き込む。コンシュー マ、バッファ、リスナ等が適切に設定されていない等、Publisher オブ ジェクトが正しく初期化されていない場合、この関数を呼び出すとエラー コード PRECONDITION_NOT_MET が返され、バッファへの書き込み等の操 作は一切行われない。
バッファへの書き込みと、InPortへのデータの送信は非同期的に行われ るため、この関数は、InPortへのデータ送信の結果を示す、 CONNECTION_LOST, BUFFER_FULL などのリターンコードを返すことがあ る。この場合、データのバッファへの書き込みは行われない。
バッファへの書き込みに対して、バッファがフル状態、バッファのエ ラー、バッファへの書き込みがタイムアウトした場合、バッファの事前 条件が満たされない場合にはそれぞれ、エラーコード BUFFER_FULL, BUFFER_ERROR, BUFFER_TIMEOUT, PRECONDITION_NOT_MET が返される。
これら以外のエラーの場合、PORT_ERROR が返される。
| data | 書き込むデータ |
| sec | タイムアウト時間 |
| nsec | タイムアウト時間 |
RTC::PublisherBaseを実装しています。
1.8.11