jp.go.aist.rtm.RTC.port

Class OutPortPushConnector

java.lang.Object

jp.go.aist.rtm.RTC.port.ConnectorBase

jp.go.aist.rtm.RTC.port.OutPortConnector

jp.go.aist.rtm.RTC.port.OutPortPushConnector

public class OutPortPushConnector
extends OutPortConnector

Nested Class Summary

Nested classes/interfaces inherited from class jp.go.aist.rtm.RTC.port.ConnectorBase

ConnectorBase.ConnectorInfo, ConnectorBase.ConnectorInfoHolder

Field Summary

Fields inherited from class jp.go.aist.rtm.RTC.port.OutPortConnector

m_directInPort, m_directMode, m_inPortListeners, m_isLittleEndian, m_profile, rtcout

Constructor Summary

Constructors

Constructor and Description
OutPortPushConnector(ConnectorBase.ConnectorInfo profile, ConnectorListeners listeners, InPortConsumer consumer) Constructor
OutPortPushConnector(ConnectorBase.ConnectorInfo profile, InPortConsumer consumer, ConnectorListeners listeners, BufferBase<org.omg.CORBA.portable.OutputStream> buffer) Constructor

Method Summary

Modifier and Type	Method and Description
void	activate() Connector activation
protected BufferBase<org.omg.CORBA.portable.OutputStream>	createBuffer(ConnectorBase.ConnectorInfo profile) create buffer
protected PublisherBase	createPublisher(ConnectorBase.ConnectorInfo profile) create publisher
void	deactivate() Connector deactivation
ReturnCode	disconnect() disconnect
BufferBase<org.omg.CORBA.portable.OutputStream>	getBuffer() Getting Buffer
protected void	onConnect() Invoke callback when connection is established
protected void	onDisconnect() Invoke callback when connection is destroied
void	setOutPortBase(OutPortBase outportbase) Stores OutPortBase.
<DataType> ReturnCode	write(DataType data) Writing data

Methods inherited from class jp.go.aist.rtm.RTC.port.OutPortConnector

directMode, id, isLittleEndian, name, profile, setDirectMode, setEndian, setInPort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutPortPushConnector

public OutPortPushConnector(ConnectorBase.ConnectorInfo profile,
                            InPortConsumer consumer,
                            ConnectorListeners listeners,
                            BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
                     throws java.lang.Exception

Constructor

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

Parameters:

profile - ConnectorInfo

consumer - InPortConsumer

listeners - ConnectorListeners type lsitener object list

buffer - CdrBufferBase type buffer

Throws:

java.lang.Exception

OutPortPushConnector

public OutPortPushConnector(ConnectorBase.ConnectorInfo profile,
                            ConnectorListeners listeners,
                            InPortConsumer consumer)
                     throws java.lang.Exception

Constructor

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

Parameters:

profile - ConnectorInfo

consumer - InPortConsumer

listeners - ConnectorListeners type lsitener object list

Throws:

java.lang.Exception

Method Detail

write

public <DataType> ReturnCode write(DataType data)

Writing data

This operation writes data into publisher and then the data will be transferred to correspondent InPort. If data is written properly, this function will return PORT_OK return code. Except normal return, CONNECTION_LOST, BUFFER_FULL, BUFFER_ERROR, PORT_ERROR, BUFFER_TIMEOUT and PRECONDITION_NO_MET will be returned as error codes.

Specified by:

write in class OutPortConnector

Parameters:

data - Data

Returns:

ReturnCode PORT_OK Normal return CONNECTION_LOST Connectin lost BUFFER_FULL Buffer full BUFFER_ERROR Buffer error BUFFER_TIMEOUT Timeout PRECONDITION_NOT_MET Precondition not met PORT_ERROR Other error

disconnect

public ReturnCode disconnect()

disconnect

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

Specified by:

disconnect in class OutPortConnector

Returns:

ReturnCode

activate

public void activate()

Connector activation

This operation activates this connector

Specified by:

activate in class ConnectorBase

getBuffer

public BufferBase<org.omg.CORBA.portable.OutputStream> getBuffer()

Getting Buffer

This operation returns this connector's buffer

Specified by:

getBuffer in class OutPortConnector

Returns:

Connector's buffer

setOutPortBase

public void setOutPortBase(OutPortBase outportbase)

Stores OutPortBase.

Specified by:

setOutPortBase in class OutPortConnector

Parameters:

outportbase - OutPortBase

deactivate

public void deactivate()

Connector deactivation

This operation deactivates this connector

Specified by:

deactivate in class ConnectorBase

createPublisher

protected PublisherBase createPublisher(ConnectorBase.ConnectorInfo profile)

create publisher

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