|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjp.go.aist.rtm.RTC.port.ConnectorBase
jp.go.aist.rtm.RTC.port.InPortConnector
jp.go.aist.rtm.RTC.port.InPortPushConnector
public class InPortPushConnector
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.InPortConnector |
---|
m_buffer, m_isLittleEndian, m_orb, m_profile, m_spi_orb, rtcout |
Constructor Summary | |
---|---|
InPortPushConnector(ConnectorBase.ConnectorInfo profile,
InPortProvider provider,
ConnectorListeners listeners,
BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
Constructor |
Method Summary | |
---|---|
void |
activate()
Connector activation |
protected ReturnCode |
convertReturn(ReturnCode status)
Converts buffer.ReturnCode into port.ReturnCode. |
protected BufferBase<org.omg.CORBA.portable.OutputStream> |
createBuffer(ConnectorBase.ConnectorInfo profile)
create buffer |
void |
deactivate()
Connector deactivation |
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)
Set the listener. |
Methods inherited from class jp.go.aist.rtm.RTC.port.InPortConnector |
---|
getBuffer, id, isLittleEndian, name, profile, setEndian |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public InPortPushConnector(ConnectorBase.ConnectorInfo profile, InPortProvider provider, ConnectorListeners listeners, BufferBase<org.omg.CORBA.portable.OutputStream> buffer) throws java.lang.Exception
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
-
ConnectorInfoprovider
-
InPortProviderlisteners
-
ConnectorListeners type lsitener object listbuffer
-
CdrBufferBase type buffer
java.lang.Exception
Method Detail |
---|
public void setListener(ConnectorBase.ConnectorInfo profile, ConnectorListeners listeners)
InPortConnector
setListener
in class InPortConnector
profile
-
Connector informationlisteners
-
Listener objectspublic ReturnCode read(DataRef<org.omg.CORBA.portable.InputStream> 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.
read
in class InPortConnector
public ReturnCode disconnect()
This operation destruct and delete the consumer, the publisher and the buffer.
disconnect
in class InPortConnector
public void activate()
This operation activates this connector
activate
in class ConnectorBase
public void deactivate()
This operation deactivates this connector
deactivate
in class ConnectorBase
protected BufferBase<org.omg.CORBA.portable.OutputStream> createBuffer(ConnectorBase.ConnectorInfo profile)
This function creates a buffer based on given information.
profile
-
Connector information
protected void onConnect()
protected void onDisconnect()
protected ReturnCode convertReturn(ReturnCode status)
status
-
jp.go.aist.rtm.RTC.buffer.ReturnCode
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |