|
||||||||||
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.OutPortConnector
jp.go.aist.rtm.RTC.port.OutPortPullConnector
public class OutPortPullConnector
OutPortPullConnector class
Connector class of OutPort for pull type dataflow. When "pull" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the OutPort. This connector and InPortPullConnector make a pair and realize pull type dataflow of data ports. One connector corresponds to one connection which provides a data stream. Connector is distinguished by ID of the UUID that is generated at establishing connection. OutPortPullConnector owns and manages the following objects.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class jp.go.aist.rtm.RTC.port.ConnectorBase |
---|
ConnectorBase.ConnectorInfo, ConnectorBase.ConnectorInfoHolder |
Field Summary | |
---|---|
protected BufferBase<org.omg.CORBA.portable.OutputStream> |
m_buffer
the pointer to the buffer |
protected OutPortProvider |
m_provider
the pointer to the OutPortProvider |
Fields inherited from class jp.go.aist.rtm.RTC.port.OutPortConnector |
---|
m_isLittleEndian, m_profile, rtcout |
Constructor Summary | |
---|---|
OutPortPullConnector(ConnectorBase.ConnectorInfo profile,
OutPortProvider provider,
ConnectorListeners listeners)
Constructor |
|
OutPortPullConnector(ConnectorBase.ConnectorInfo profile,
OutPortProvider provider,
ConnectorListeners listeners,
BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
Constructor |
Method Summary | ||
---|---|---|
void |
activate()
Connector activation |
|
protected BufferBase<org.omg.CORBA.portable.OutputStream> |
createBuffer(ConnectorBase.ConnectorInfo profile)
create buffer |
|
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. |
|
|
write(DataType data)
Writing data |
Methods inherited from class jp.go.aist.rtm.RTC.port.OutPortConnector |
---|
id, isLittleEndian, name, profile, setEndian |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected OutPortProvider m_provider
the pointer to the OutPortProvider
protected BufferBase<org.omg.CORBA.portable.OutputStream> m_buffer
the pointer to the buffer
Constructor Detail |
---|
public OutPortPullConnector(ConnectorBase.ConnectorInfo profile, OutPortProvider provider, ConnectorListeners listeners, BufferBase<org.omg.CORBA.portable.OutputStream> buffer) throws java.lang.Exception
OutPortPullConnector'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 OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortProvider. OutPortPullConnector 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.
profile
-
ConnectorInfoprovider
-
OutPortProviderlisteners
-
ConnectorListeners type lsitener object listbuffer
-
CdrBufferBase type buffer
java.lang.Exception
public OutPortPullConnector(ConnectorBase.ConnectorInfo profile, OutPortProvider provider, ConnectorListeners listeners) throws java.lang.Exception
OutPortPullConnector'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 OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortProvider. OutPortPullConnector also has ConnectorListeners to provide event callback mechanisms, and they would be called at the proper timing.
profile
-
ConnectorInfoprovider
-
OutPortProviderlisteners
-
ConnectorListeners type lsitener object list
java.lang.Exception
Method Detail |
---|
public <DataType> ReturnCode write(DataType data)
This operation writes data into publisher and then the data will be transferred to correspondent InPort.
write
in class OutPortConnector
public ReturnCode disconnect()
This operation destruct and delete the consumer, the publisher and the buffer.
disconnect
in class OutPortConnector
public BufferBase<org.omg.CORBA.portable.OutputStream> getBuffer()
This operation returns this connector's buffer
getBuffer
in class OutPortConnector
protected BufferBase<org.omg.CORBA.portable.OutputStream> createBuffer(ConnectorBase.ConnectorInfo profile)
profile
-
specify the buffer kind
protected void onConnect()
protected void onDisconnect()
public void activate()
This operation activates this connector
activate
in class ConnectorBase
public void deactivate()
This operation deactivates this connector
deactivate
in class ConnectorBase
public void setOutPortBase(OutPortBase outportbase)
setOutPortBase
in class OutPortConnector
outportbase
-
OutPortBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |