The advanced channel element interface, used by Orocos to relay over-CORBA data flow connections. More...
import "rtt/transports/corba/DataFlow.idl";
Inheritance diagram for RTT::corba::CRemoteChannelElement:
Public Member Functions | |
| void | setRemoteSide (in CRemoteChannelElement other) |
| Used during connection setup to pass on an example of the data. | |
| boolean | remoteSignal () |
| Used by the 'remote' side to inform this channel element that new data is available for reading. | |
| void | remoteDisconnect (in boolean writer_to_reader) |
| Used by the 'remote' side to inform this channel element that the connection is been cleaned up. | |
| CFlowStatus | read (out any sample, in boolean copy_old_data) |
| Reads from this Channel Element. | |
| boolean | write (in any sample) |
| Writes into this Channel Element. | |
| void | disconnect () |
| Disconnect and dispose this object. | |
Detailed Description
The advanced channel element interface, used by Orocos to relay over-CORBA data flow connections.
Definition at line 56 of file DataFlow.idl.
Member Function Documentation
| void RTT::corba::CChannelElement::disconnect | ( | ) | [inherited] |
Disconnect and dispose this object.
You may no longer use this object after calling this method.
| void RTT::corba::CRemoteChannelElement::remoteDisconnect | ( | in boolean | writer_to_reader | ) |
Used by the 'remote' side to inform this channel element that the connection is been cleaned up.
- Parameters:
-
writer_to_reader Since channel elements are chained, we need to know who initiated the disconnect: starting from the output port (writer_to_reader == true) or from the input port (writer_to_reader == false)
| boolean RTT::corba::CRemoteChannelElement::remoteSignal | ( | ) |
Used by the 'remote' side to inform this channel element that new data is available for reading.
- Returns:
- false if this channel became invalidated.
| void RTT::corba::CRemoteChannelElement::setRemoteSide | ( | in CRemoteChannelElement | other | ) |
Used during connection setup to pass on an example of the data.
This is done behind the scenes by the connection logic.
- Note:
- : not implemented yet. Called by the input port to indicate that it's ready to be used. This is done behind the scenes by the connection logic.
- : not implemented yet. Used to inform this channel element which the other side is such that they can relay a signal or disconnect.
| boolean RTT::corba::CChannelElement::write | ( | in any | sample | ) | [inherited] |
Writes into this Channel Element.
- Returns:
- false if the channel became invalid
The documentation for this interface was generated from the following file:
- rtt/transports/corba/DataFlow.idl
