RTT::corba::CRemoteChannelElement Interface Reference

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 to inform this channel element which the other side is such that they can relay a signal or disconnect. More...
oneway void	remoteSignal ()
	Used by the 'remote' side to inform this channel element that new data is available for reading. More...
void	remoteDisconnect (in boolean forward)
	Used by the 'remote' side to inform this channel element that the connection is been cleaned up. More...
boolean	inputReady ()
	Used during connection setup to pass on an example of the data. More...
boolean	channelReady (in CConnPolicy cp)
	Checks if the connection channel elements are ready for a given input port. More...
CFlowStatus	read (out any sample, in boolean copy_old_data)
	Reads from this Channel Element. More...
CWriteStatus	write (in any sample)
	Writes into this Channel Element. More...
oneway void	writeOneway (in any sample)
	Writes into this Channel Element (one-way) More...
void	disconnect ()
	Disconnect and dispose this object. More...

Detailed Description

The advanced channel element interface, used by Orocos to relay over-CORBA data flow connections.

Definition at line 97 of file DataFlow.idl.

Member Function Documentation

boolean RTT::corba::CChannelElement::channelReady ( in CConnPolicy  cp )

inherited

Checks if the connection channel elements are ready for a given input port.

This is typically called by the createConnection setup logic to see if the input side agrees with the connection and can use it. For example, the input port can use this opportunity to check the

Exceptions

CNoSuchPortException

if input_port is not an input port or not present in this interface.

Returns

false if the connection could not be used.

void RTT::corba::CChannelElement::disconnect ( )

inherited

Disconnect and dispose this object.

You may no longer use this object after calling this method.

boolean RTT::corba::CChannelElement::inputReady ( )

inherited

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.

CFlowStatus RTT::corba::CChannelElement::read ( out any  sample, in boolean  copy_old_data  )

inherited

Reads from this Channel Element.

void RTT::corba::CRemoteChannelElement::remoteDisconnect

(

in boolean

forward

)

Used by the 'remote' side to inform this channel element that the connection is been cleaned up.

Parameters

forward

Since channel elements are chained, we need to know who initiated the disconnect: starting from the output port (forward == true) or from the input port (forward == false)

oneway void 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 to inform this channel element which the other side is such that they can relay a signal or disconnect.

CWriteStatus RTT::corba::CChannelElement::write ( in any  sample )

inherited

Writes into this Channel Element.

Returns

NotConnected if the channel became invalid

oneway void RTT::corba::CChannelElement::writeOneway ( in any  sample )

inherited

Writes into this Channel Element (one-way)

---

The documentation for this interface was generated from the following file:

• rtt/transports/corba/DataFlow.idl