データポートの Connector において発生する各種イベントに対するコールバックを実現するリスナクラスの基底クラス。 [詳解]

OpenRTM_aist.ConnectorListener.ConnectorDataListener の継承関係図

公開メンバ関数
def	toString (type)
	ConnectorDataListenerType を文字列に変換 [詳解]

詳解

データポートの Connector において発生する各種イベントに対するコールバックを実現するリスナクラスの基底クラス。

複数の ConnectorDataListener を保持し管理するクラス。

コアロジックがOutPortに対してデータ書き込み、InPort側でデータが取得されるまでの間で発生する各種イベントをフックするコールバックを設定することができる。なお、リスナークラスは2種類存在し、バッファフルや送信時のコールバックで、その時点で有効なデータをファンクタの引数として受け取る ConnectorDataListener であり、もう一方はデータエンプティやバッファ読み込み時のタイムアウトなどデータが取得できない場合などにコールされるファンクタの引数に何もとらならい ConnecotorListener がある。

データポートには、接続時にデータの送受信方法についてデータフロー型、サブスクリプション型等を設定することができる。 ConnectorDaataListener/ConnectorListener はともに、様々なイベントに対するコールバックを設定することができるが、これらデータフロー型およびサブスクリプション型の設定に応じて、利用可能なもの利用不可能なものや、呼び出されるタイミングが異なる。以下に、インターフェースがCORBA CDR型の場合のコールバック一覧を示す。

OutPort:

Push型: Subscription Typeによりさらにイベントの種類が分かれる。
- Flush: Flush型にはバッファがないため ON_BUFFER 系のイベントは発生しない
  - ON_SEND
  - ON_RECEIVED
  - ON_RECEIVER_FULL
  - ON_RECEIVER_TIMEOUT
  - ON_RECEIVER_ERROR
  - ON_CONNECT
  - ON_DISCONNECT
- New型
  - ON_BUFFER_WRITE
  - ON_BUFFER_FULL
  - ON_BUFFER_WRITE_TIMEOUT
  - ON_BUFFER_OVERWRITE
  - ON_BUFFER_READ
  - ON_SEND
  - ON_RECEIVED
  - ON_RECEIVER_FULL
  - ON_RECEIVER_TIMEOUT
  - ON_RECEIVER_ERROR
  - ON_SENDER_ERROR
  - ON_CONNECT
  - ON_DISCONNECT
- Periodic型
  - ON_BUFFER_WRITE
  - ON_BUFFER_FULL
  - ON_BUFFER_WRITE_TIMEOUT
  - ON_BUFFER_READ
  - ON_SEND
  - ON_RECEIVED
  - ON_RECEIVER_FULL
  - ON_RECEIVER_TIMEOUT
  - ON_RECEIVER_ERROR
  - ON_BUFFER_EMPTY
  - ON_SENDER_EMPTY
  - ON_SENDER_ERROR
  - ON_CONNECT
  - ON_DISCONNECT
Pull型
- ON_BUFFER_READ
- ON_SEND
- ON_BUFFER_EMPTY
- ON_BUFFER_READ_TIMEOUT
- ON_SENDER_EMPTY
- ON_SENDER_TIMEOUT
- ON_SENDER_ERROR
- ON_CONNECT
- ON_DISCONNECT

InPort:

Push型:
- ON_BUFFER_WRITE
- ON_BUFFER_FULL
- ON_BUFFER_WRITE_TIMEOUT
- ON_BUFFER_WRITE_OVERWRITE
- ON_RECEIVED
- ON_RECEIVER_FULL
- ON_RECEIVER_TIMEOUT
- ON_RECEIVER_ERROR
- ON_CONNECT
- ON_DISCONNECT
Pull型
- ON_CONNECT
- ON_DISCONNECT

メソッド詳解

def OpenRTM_aist.ConnectorListener.ConnectorDataListener.toString ( type )

ConnectorDataListenerType を文字列に変換

ConnectorDataListenerType を文字列に変換する

引数

type	変換対象 ConnectorDataListenerType

戻り値: 文字列変換結果

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

/tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/ConnectorListener.py

公開メンバ関数

詳解

メソッド詳解