jp.go.aist.rtm.RTC.port.publisher
クラス 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
           
 
コンストラクタの概要
PublisherFlush()
           Constructor
 
メソッドの概要
 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
 boolean isActive()
           write
protected  void onReceived(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(org.omg.CORBA.portable.OutputStream data)
           Connector data listener functions
static void PublisherFlushInit()
           PublisherFlushInit
 ReturnCode setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
           setBuffer
 ReturnCode setConsumer(InPortConsumer consumer)
           setConsumer
 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)
           Write data
 
クラス 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()
Constructor

メソッドの詳細

destruct

public void destruct()

当該Publisherが不要となり破棄される際に、PublisherFactoryにより呼び出されます。


finalize

protected void finalize()
                 throws java.lang.Throwable

ファイナライザです。

オーバーライド:
クラス java.lang.Object 内の finalize
例外:
java.lang.Throwable

init

public ReturnCode init(Properties prop)

init

initialization

定義:
クラス PublisherBase 内の init
パラメータ:
prop -
戻り値:
ReturnCode

setConsumer

public ReturnCode setConsumer(InPortConsumer consumer)

setConsumer

Store InPort consumer

定義:
クラス PublisherBase 内の setConsumer
パラメータ:
consumer -
戻り値:
ReturnCode

setBuffer

public ReturnCode setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)

setBuffer

Setting buffer

定義:
クラス PublisherBase 内の setBuffer
パラメータ:
buffer -
戻り値:
ReturnCode

setListener

public ReturnCode setListener(ConnectorBase.ConnectorInfo info,
                              ConnectorListeners listeners)

Setting buffer pointer

定義:
クラス PublisherBase 内の setListener
戻り値:
ReturnCode

write

public ReturnCode write(org.omg.CORBA.portable.OutputStream data,
                        int sec,
                        int usec)
Write data

This function writes data into the consumer associated with this Publisher. If this function is called without initializing correctly such as a consumer, listeners, etc., error code PRECONDITION_NOT_MET will be returned and no operation of the writing to the consumer etc. will be performed. When publisher writes data to the buffer, if the consumer returns full-status, returns error, is returned with timeout, error codes BUFFER_FULL, BUFFER_ERROR and BUFFER_TIMEOUT will be returned respectively. In other cases, PROT_ERROR will be returned.

定義:
クラス PublisherBase 内の write
パラメータ:
data - Data to be wrote to the buffer
sec - Timeout time in unit seconds
usec - Timeout time in unit micro-seconds
戻り値:
PORT_OK Normal return PRECONDITION_NO_MET Precondition does not met. A consumer, a buffer, listenes are not set properly. SEND_FULL Data was sent but full-status returned SEND_TIMEOUT Data was sent but timeout occurred CONNECTION_LOST detected that the connection has been lost

write

public ReturnCode write(org.omg.CORBA.portable.OutputStream data)
定義:
クラス PublisherBase 内の write

isActive

public boolean isActive()

write

定義:
クラス PublisherBase 内の isActive
戻り値:
boolean

activate

public ReturnCode activate()

activate

定義:
クラス PublisherBase 内の activate
戻り値:
ReturnCode

deactivate

public ReturnCode deactivate()

deactivate

定義:
クラス PublisherBase 内の deactivate
戻り値:
ReturnCode

creator_

public PublisherBase creator_()

creator_

定義:
インタフェース ObjectCreator<PublisherBase> 内の creator_
戻り値:
Object Created instances

destructor_

public void destructor_(java.lang.Object obj)

destructor_

定義:
インタフェース ObjectDestructor 内の destructor_
パラメータ:
obj - The target instances for destruction

PublisherFlushInit

public static void PublisherFlushInit()

PublisherFlushInit


getName

public java.lang.String getName()

getName

定義:
クラス PublisherBase 内の getName
戻り値:
String

onSend

protected void onSend(org.omg.CORBA.portable.OutputStream data)

Connector data listener functions


onReceived

protected void onReceived(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)