PublisherFlush

java.lang.Object
- jp.go.aist.rtm.RTC.port.publisher.PublisherBase
- - jp.go.aist.rtm.RTC.port.publisher.PublisherFlush

すべての実装されたインタフェース:

ObjectCreator<PublisherBase>, ObjectDestructor
```
public class PublisherFlush
extends PublisherBase
implements ObjectCreator<PublisherBase>, ObjectDestructor
```
データ送出を待つコンシューマを、送出する側と同じスレッドで動作させる場合に使用します。

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected Logbuf rtcout

フィールド
修飾子とタイプ	フィールドと説明
`protected Logbuf`	`rtcout`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PublisherFlush()
コンストラクタ

コンストラクタ
コンストラクタと説明
`PublisherFlush()` コンストラクタ

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`ReturnCode`	`activate()` activate
`PublisherBase`	`creator_()` creator_
`ReturnCode`	`deactivate()` deactivate
`void`	`destruct()` 当該Publisherが不要となり破棄される際に、PublisherFactoryにより呼び出されます。
`void`	`destructor_(java.lang.Object obj)` destructor_
`protected void`	`finalize()` ファイナライザです。
`java.lang.String`	`getName()` getName
`ReturnCode`	`init(Properties prop)` init initialization
`boolean`	`isActive()` write
`protected void`	`onReceived(DataRef<org.omg.CORBA.portable.OutputStream> data)`
`protected void`	`onReceiverError(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onReceiverFull(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onReceiverTimeout(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onSend(DataRef<org.omg.CORBA.portable.OutputStream> data)` Connector data listener functions
`static void`	`PublisherFlushInit()` PublisherFlushInit
`ReturnCode`	`setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)` setBuffer Setting buffer
`ReturnCode`	`setConsumer(InPortConsumer consumer)` setConsumer Store InPort consumer
`ReturnCode`	`setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)` Setting buffer pointer
`ReturnCode`	`write(org.omg.CORBA.portable.OutputStream data)`
`ReturnCode`	`write(org.omg.CORBA.portable.OutputStream data, int sec, int usec)` データを書き込む {@.ja Publisher が保持するコンシューマに対してデータを書き込む。

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.publisher.PublisherBase
release

クラスから継承されたメソッド java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - rtcout
```
protected Logbuf rtcout
```
- コンストラクタの詳細
  - PublisherFlush
```
public PublisherFlush()
```
    コンストラクタ
- メソッドの詳細
  - destruct
```
public void destruct()
```
    当該Publisherが不要となり破棄される際に、PublisherFactoryにより呼び出されます。
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    ファイナライザです。
    
    オーバーライド:
    
    finalize クラス内 java.lang.Object
    
    例外:
    
    java.lang.Throwable
  - init
```
public ReturnCode init(Properties prop)
```
    init
    
    initialization
    
    定義:
    
    init クラス内 PublisherBase
    
    パラメータ:
    
    prop -
    
    戻り値:
    
    ReturnCode
  - setConsumer
```
public ReturnCode setConsumer(InPortConsumer consumer)
```
    setConsumer
    
    Store InPort consumer
    
    定義:
    
    setConsumer クラス内 PublisherBase
    
    パラメータ:
    
    consumer -
    
    戻り値:
    
    ReturnCode
  - setBuffer
```
public ReturnCode setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
```
    setBuffer
    
    Setting buffer
    
    定義:
    
    setBuffer クラス内 PublisherBase
    
    パラメータ:
    
    buffer -
    
    戻り値:
    
    ReturnCode
  - setListener
```
public ReturnCode setListener(ConnectorBase.ConnectorInfo info,
                              ConnectorListeners listeners)
```
    Setting buffer pointer
    
    定義:
    
    setListener クラス内 PublisherBase
    
    戻り値:
    
    ReturnCode
  - write
```
public ReturnCode write(org.omg.CORBA.portable.OutputStream data,
                        int sec,
                        int usec)
```
    データを書き込む
    Publisher が保持するコンシューマに対してデータを書き込む。コンシューマ、リスナ等が適切に設定されていない等、Publisher オブジェクトが正しく初期化されていない場合、この関数を呼び出すとエラーコード PRECONDITION_NOT_MET が返され、コンシューマへの書き込み等の操作は一切行われない。コンシューマへの書き込みに対して、コンシューマがフル状態、コンシューマのエラー、コンシューマへの書き込みがタイムアウトした場合にはそれぞれ、エラーコード SEND_FULL, SEND_ERROR, SEND_TIMEOUT が返される。これら以外のエラーの場合、PORT_ERROR が返される。
    
    定義:
    
    write クラス内 PublisherBase
    
    パラメータ:
    
    data - 書き込むデータ
    
    sec - タイムアウト時間
    
    usec - タイムアウト時間
    
    戻り値:
    
    PORT_OK 正常終了 PRECONDITION_NO_MET consumer, buffer, listener等が適切に設定されていない等、このオブジェクトの事前条件を満たさない場合。 SEND_FULL 送信先がフル状態 SEND_TIMEOUT 送信先がタイムアウトした CONNECTION_LOST 接続が切断されたことを検知した。
  - write
```
public ReturnCode write(org.omg.CORBA.portable.OutputStream data)
```
    定義:
    
    write クラス内 PublisherBase
  - isActive
```
public boolean isActive()
```
    write
    
    定義:
    
    isActive クラス内 PublisherBase
    
    戻り値:
    
    boolean
  - activate
```
public ReturnCode activate()
```
    activate
    
    定義:
    
    activate クラス内 PublisherBase
    
    戻り値:
    
    ReturnCode
  - deactivate
```
public ReturnCode deactivate()
```
    deactivate
    
    定義:
    
    deactivate クラス内 PublisherBase
    
    戻り値:
    
    ReturnCode
  - creator_
```
public PublisherBase creator_()
```
    creator_
    
    定義:
    
    creator_ インタフェース内 ObjectCreator<PublisherBase>
    
    戻り値:
    
    Object Created instances
  - destructor_
```
public void destructor_(java.lang.Object obj)
```
    destructor_
    
    定義:
    
    destructor_ インタフェース内 ObjectDestructor
    
    パラメータ:
    
    obj - The target instances for destruction
  - PublisherFlushInit
```
public static void PublisherFlushInit()
```
    PublisherFlushInit
  - getName
```
public java.lang.String getName()
```
    getName
    
    定義:
    
    getName クラス内 PublisherBase
    
    戻り値:
    
    String
  - onSend
```
protected void onSend(DataRef<org.omg.CORBA.portable.OutputStream> data)
```
    Connector data listener functions
  - onReceived
```
protected void onReceived(DataRef<org.omg.CORBA.portable.OutputStream> data)
```
  - onReceiverFull
```
protected void onReceiverFull(org.omg.CORBA.portable.OutputStream data)
```
  - onReceiverTimeout
```
protected void onReceiverTimeout(org.omg.CORBA.portable.OutputStream data)
```
  - onReceiverError
```
protected void onReceiverError(org.omg.CORBA.portable.OutputStream data)
```

クラス PublisherFlush

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.publisher.PublisherBase

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

rtcout

コンストラクタの詳細

PublisherFlush

メソッドの詳細

destruct

finalize

init

setConsumer

setBuffer

setListener

write

write

isActive

activate

deactivate

creator_

destructor_

PublisherFlushInit

getName

onSend

onReceived

onReceiverFull

onReceiverTimeout

onReceiverError