OpenRTM_aist.ConnectorListener.ConnectorDataListener クラス

[詳解]

OpenRTM_aist.ConnectorListener.ConnectorDataListener の継承関係図

公開メンバ関数
	toString (status)

詳解

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

コアロジックが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

TODO: The "object" class inheritance must be removed in Python3

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

メソッド詳解

toString()

OpenRTM_aist.ConnectorListener.ConnectorDataListener.toString

(

status

)

ConnectorDataListenerType を文字列に変換

ConnectorDataListenerType を文字列に変換する

引数

type	変換対象 ConnectorDataListenerType

戻り値

文字列変換結果

---

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

• ConnectorListener.py