jp.go.aist.rtm.RTC.port
クラス InPortPushConnector

java.lang.Object
  上位を拡張 jp.go.aist.rtm.RTC.port.ConnectorBase
      上位を拡張 jp.go.aist.rtm.RTC.port.InPortConnector
          上位を拡張 jp.go.aist.rtm.RTC.port.InPortPushConnector

public class InPortPushConnector
extends InPortConnector


入れ子のクラスの概要
 
クラス jp.go.aist.rtm.RTC.port.ConnectorBase から継承された入れ子のクラス/インタフェース
ConnectorBase.ConnectorInfo, ConnectorBase.ConnectorInfoHolder
 
フィールドの概要
 
クラス jp.go.aist.rtm.RTC.port.InPortConnector から継承されたフィールド
m_buffer, m_isLittleEndian, m_orb, m_profile, m_spi_orb, rtcout
 
コンストラクタの概要
InPortPushConnector(ConnectorBase.ConnectorInfo profile, InPortProvider provider, ConnectorListeners listeners, BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
           Constructor
 
メソッドの概要
 void activate()
           Connector activation
protected  ReturnCode convertReturn(ReturnCode status)
           convertReturn
protected  BufferBase<org.omg.CORBA.portable.OutputStream> createBuffer(ConnectorBase.ConnectorInfo profile)
           create buffer
 void deactivate()
           Connector activation
 ReturnCode disconnect()
           disconnect
protected  void onConnect()
           Invoke callback when connection is established
protected  void onDisconnect()
           Invoke callback when connection is destroied
 ReturnCode read(DataRef<org.omg.CORBA.portable.InputStream> data)
           Reading data
 void setListener(ConnectorBase.ConnectorInfo profile, ConnectorListeners listeners)
           
 
クラス jp.go.aist.rtm.RTC.port.InPortConnector から継承されたメソッド
getBuffer, id, isLittleEndian, name, profile, setEndian
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

InPortPushConnector

public InPortPushConnector(ConnectorBase.ConnectorInfo profile,
                           InPortProvider provider,
                           ConnectorListeners listeners,
                           BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
                    throws java.lang.Exception
Constructor

InPortPushConnector's constructor is given the following arguments. According to ConnectorInfo which includes connection information, a buffer is created. It is also given a pointer to the provider object for the InPort interface. The owner-ship of the pointer is owned by this InPortPushConnector, it has responsibility to destruct the InPortProvider. InPortPushConnector also has ConnectorListeners to provide event callback mechanisms, and they would be called at the proper timing. If data buffer is given by InPortBase, the pointer to the buffer is also given as arguments.

パラメータ:
profile - ConnectorInfo
provider - InPortProvider
listeners - ConnectorListeners type lsitener object list
buffer - CdrBufferBase type buffer
例外:
java.lang.Exception
メソッドの詳細

setListener

public void setListener(ConnectorBase.ConnectorInfo profile,
                        ConnectorListeners listeners)
定義:
クラス InPortConnector 内の setListener

read

public ReturnCode read(DataRef<org.omg.CORBA.portable.InputStream> data)
Reading data

This function reads data from the buffer. If data is read properly, this function will return PORT_OK return code. Except normal return, BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET and PORT_ERROR will be returned as error codes.

定義:
クラス InPortConnector 内の read
戻り値:
PORT_OK Normal return BUFFER_EMPTY Buffer empty TIMEOUT Timeout PRECONDITION_NOT_MET Preconditin not met PORT_ERROR Other error

disconnect

public ReturnCode disconnect()
disconnect

This operation destruct and delete the consumer, the publisher and the buffer.

定義:
クラス InPortConnector 内の disconnect

activate

public void activate()

Connector activation

This operation activates this connector

定義:
クラス ConnectorBase 内の activate

deactivate

public void deactivate()

Connector activation

This operation activates this connector

定義:
クラス ConnectorBase 内の deactivate

createBuffer

protected BufferBase<org.omg.CORBA.portable.OutputStream> createBuffer(ConnectorBase.ConnectorInfo profile)

create buffer


onConnect

protected void onConnect()

Invoke callback when connection is established


onDisconnect

protected void onDisconnect()
Invoke callback when connection is destroied


convertReturn

protected ReturnCode convertReturn(ReturnCode status)

convertReturn