Orocos Real-Time Toolkit  2.8.3
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RTT::corba::RemoteChannelElement< T > Class Template Reference

Implements the CRemoteChannelElement of the CORBA IDL interface. More...

#include <rtt/transports/corba/RemoteChannelElement.hpp>

Inheritance diagram for RTT::corba::RemoteChannelElement< T >:
RTT::corba::CRemoteChannelElement_i RTT::base::ChannelElement< T > RTT::base::ChannelElementBase

Public Types

typedef T value_t
 
typedef boost::intrusive_ptr< ChannelElement< T > > shared_ptr
 
typedef boost::call_traits< T >::param_type param_t
 
typedef boost::call_traits< T >::reference reference_t
 

Public Member Functions

 RemoteChannelElement (CorbaTypeTransporter const &transport, DataFlowInterface *sender, PortableServer::POA_ptr poa, bool is_pull)
 Create a channel element for remote data exchange. More...
 
 ~RemoteChannelElement ()
 
void _add_ref ()
 Increase the reference count, called from the CORBA side. More...
 
void _remove_ref ()
 Decrease the reference count, called from the CORBA side. More...
 
void remoteSignal () ACE_THROW_SPEC((CORBA
 CORBA IDL function. More...
 
bool signal ()
 Signals that there is new data available on this channel By default, the channel element forwards the call to its output. More...
 
virtual void transferSamples ()
 
void disconnect () ACE_THROW_SPEC((CORBA
 CORBA IDL function. More...
 
void remoteDisconnect (bool writer_to_reader) ACE_THROW_SPEC((CORBA
 
void disconnect (bool writer_to_reader) ACE_THROW_SPEC((CORBA
 CORBA IDL function. More...
 
FlowStatus read (typename base::ChannelElement< T >::reference_t sample, bool copy_old_data)
 
CFlowStatus read (::CORBA::Any_out sample, bool copy_old_data) ACE_THROW_SPEC((CORBA
 CORBA IDL function. More...
 
bool write (typename base::ChannelElement< T >::param_t sample)
 
bool write (const ::CORBA::Any &sample) ACE_THROW_SPEC((CORBA
 CORBA IDL function. More...
 
virtual bool data_sample (typename base::ChannelElement< T >::param_t sample)
 
virtual bool inputReady ()
 CORBA IDL function. More...
 
virtual bool isRemoteElement () const
 This function may be used to identify, if the current element uses a network transport, to send the data to the next Element in the logical chain. More...
 
virtual std::string getRemoteURI () const
 This function returns the URI of the next channel element in the logical chain. More...
 
virtual std::string getLocalURI () const
 This function return the URI of this element. More...
 
virtual std::string getElementName () const
 Returns the class name of this element. More...
 
virtual RTT::corba::CRemoteChannelElement_ptr activate_this ()
 
void setCDataFlowInterface (CDataFlowInterface_i *dataflow)
 
PortableServer::POA_ptr _default_POA ()
 
shared_ptr getOutput ()
 
shared_ptr getInput ()
 
virtual bool data_sample (param_t sample)
 Provides a data sample to initialize this connection. More...
 
virtual value_t data_sample ()
 
virtual bool write (param_t sample)
 Writes a new sample on this connection. More...
 
virtual FlowStatus read (reference_t sample, bool copy_old_data)
 Reads a sample from the connection. More...
 
void removeInput ()
 Removes the input channel (if any). More...
 
ChannelElementBase::shared_ptr getInputEndPoint ()
 Returns the first input channel element of this connection. More...
 
ChannelElementBase::shared_ptr getOutputEndPoint ()
 Returns the last output channel element of this connection. More...
 
void setOutput (shared_ptr output)
 Sets the output of this channel element to output and sets the input of output to this. More...
 
virtual void clear ()
 Clears any data stored by the channel. More...
 
virtual PortInterfacegetPort () const
 Gets the port this channel element is connected to. More...
 
virtual internal::ConnIDgetConnID () const
 Gets the Connection ID of this channel. More...
 

Protected Member Functions

void ref ()
 Increases the reference count. More...
 
void deref ()
 Decreases the reference count, and deletes the object if it is zero. More...
 

Protected Attributes

CRemoteChannelElement_var remote_side
 
RTT::corba::CorbaTypeTransporter const & transport
 
PortableServer::POA_var mpoa
 
CDataFlowInterface_imdataflow
 

Detailed Description

template<typename T>
class RTT::corba::RemoteChannelElement< T >

Implements the CRemoteChannelElement of the CORBA IDL interface.

It converts the C++ calls into CORBA calls and vice versa. A read will cause a call to the remote channel (which is of the same type of this RemoteChannelElement) which returns an Any with the data. A similar mechanism is in place for a write.

Definition at line 59 of file RemoteChannelElement.hpp.

Member Typedef Documentation

template<typename T>
typedef boost::call_traits<T>::param_type RTT::base::ChannelElement< T >::param_t
inherited

Definition at line 59 of file ChannelElement.hpp.

template<typename T>
typedef boost::call_traits<T>::reference RTT::base::ChannelElement< T >::reference_t
inherited

Definition at line 60 of file ChannelElement.hpp.

template<typename T>
typedef boost::intrusive_ptr< ChannelElement<T> > RTT::base::ChannelElement< T >::shared_ptr
inherited

Definition at line 58 of file ChannelElement.hpp.

template<typename T>
typedef T RTT::base::ChannelElement< T >::value_t
inherited

Definition at line 57 of file ChannelElement.hpp.

Constructor & Destructor Documentation

template<typename T>
RTT::corba::RemoteChannelElement< T >::RemoteChannelElement ( CorbaTypeTransporter const &  transport,
DataFlowInterface sender,
PortableServer::POA_ptr  poa,
bool  is_pull 
)
inline

Create a channel element for remote data exchange.

Parameters
transportThe type specific object that will be used to marshal the data.
poaThe POA that manages the underlying CRemoteChannelElement_i.

Definition at line 84 of file RemoteChannelElement.hpp.

References RTT::corba::CorbaDispatcher::Instance(), RTT::corba::CRemoteChannelElement_i::mpoa, RTT::corba::ApplicationServer::orb, and RTT::base::ChannelElementBase::ref().

template<typename T>
RTT::corba::RemoteChannelElement< T >::~RemoteChannelElement ( )
inline

Definition at line 102 of file RemoteChannelElement.hpp.

Member Function Documentation

template<typename T>
void RTT::corba::RemoteChannelElement< T >::_add_ref ( )
inline

Increase the reference count, called from the CORBA side.

Definition at line 107 of file RemoteChannelElement.hpp.

References RTT::base::ChannelElementBase::ref().

PortableServer::POA_ptr CRemoteChannelElement_i::_default_POA ( )
inherited
template<typename T>
void RTT::corba::RemoteChannelElement< T >::_remove_ref ( )
inline

Decrease the reference count, called from the CORBA side.

Definition at line 110 of file RemoteChannelElement.hpp.

References RTT::base::ChannelElementBase::deref().

virtual RTT::corba::CRemoteChannelElement_ptr RTT::corba::CRemoteChannelElement_i::activate_this ( )
inlinevirtualinherited

Definition at line 85 of file DataFlowI.h.

void ChannelElementBase::clear ( )
virtualinherited

Clears any data stored by the channel.

It means that ChannelElement::read() will return false afterwards (provided that no new data has been written on the meantime of course)

By default, the channel element forwards the calls to its input

Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.

Definition at line 117 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::getInput().

Referenced by RTT::internal::ChannelDataElement< T >::clear(), and RTT::internal::ChannelBufferElement< T >::clear().

template<typename T>
virtual bool RTT::base::ChannelElement< T >::data_sample ( param_t  sample)
inlinevirtualinherited

Provides a data sample to initialize this connection.

This is used before the first write() in order to inform this connection of the size of the data. As such enough storage space can be allocated before the actual writing begins.

Returns
false if an error occured that requires the channel to be invalidated.

Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.

Definition at line 82 of file ChannelElement.hpp.

References RTT::base::ChannelElement< T >::data_sample(), and RTT::base::ChannelElement< T >::getOutput().

Referenced by RTT::base::ChannelElement< T >::data_sample(), RTT::InputPort< T >::getDataSample(), and RTT::mqueue::MQChannelElement< T >::inputReady().

template<typename T>
virtual value_t RTT::base::ChannelElement< T >::data_sample ( )
inlinevirtualinherited
template<typename T>
virtual bool RTT::corba::RemoteChannelElement< T >::data_sample ( typename base::ChannelElement< T >::param_t  sample)
inlinevirtual
void ChannelElementBase::deref ( )
protectedinherited

Decreases the reference count, and deletes the object if it is zero.

Definition at line 165 of file ChannelInterface.cpp.

References oro_atomic_dec_and_test().

Referenced by RTT::corba::RemoteChannelElement< T >::_remove_ref(), and RTT::base::intrusive_ptr_release().

template<typename T>
void RTT::corba::RemoteChannelElement< T >::disconnect ( )
inline
template<typename T>
void RTT::corba::RemoteChannelElement< T >::disconnect ( bool  writer_to_reader)
inlinevirtual
internal::ConnID * ChannelElementBase::getConnID ( ) const
virtualinherited

Gets the Connection ID of this channel.

This is only stored in connection endpoints.

Returns
null if no ConnID is associated with this element.

Reimplemented in RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.

Definition at line 136 of file ChannelInterface.cpp.

template<typename T>
virtual std::string RTT::corba::RemoteChannelElement< T >::getElementName ( ) const
inlinevirtual

Returns the class name of this element.

This is primary useful for special case handling in the connection tracking.

Returns
The name of the class of the ChannelElement

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 401 of file RemoteChannelElement.hpp.

template<typename T>
shared_ptr RTT::base::ChannelElement< T >::getInput ( )
inlineinherited
ChannelElementBase::shared_ptr ChannelElementBase::getInputEndPoint ( )
inherited

Returns the first input channel element of this connection.

Will return the channel element the furthest away from the input port, or this if none.

Returns
getInput() ? getInput()->getInputEndPoint() : this

Definition at line 97 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::getInput().

template<typename T>
virtual std::string RTT::corba::RemoteChannelElement< T >::getLocalURI ( ) const
inlinevirtual

This function return the URI of this element.

The URI must be unique.

Returns
URI of this element.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 391 of file RemoteChannelElement.hpp.

References RTT::base::ChannelElementBase::getInput(), and RTT::base::ChannelElementBase::getLocalURI().

template<typename T>
shared_ptr RTT::base::ChannelElement< T >::getOutput ( )
inlineinherited
ChannelElementBase::shared_ptr ChannelElementBase::getOutputEndPoint ( )
inherited

Returns the last output channel element of this connection.

Will return the channel element the furthest away from the output port, or this if none.

Returns
getOutput() ? getOutput()->getOutputEndPoint() : this

Definition at line 102 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::getOutput().

PortInterface * ChannelElementBase::getPort ( ) const
virtualinherited

Gets the port this channel element is connected to.

Returns
null if no port is connected to this element, the port (or a proxy representing the port) otherwise.

Reimplemented in RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.

Definition at line 132 of file ChannelInterface.cpp.

template<typename T>
virtual std::string RTT::corba::RemoteChannelElement< T >::getRemoteURI ( ) const
inlinevirtual

This function returns the URI of the next channel element in the logical chain.

The URI must be unique. E.g: In the local case output->getLocalURI() In the remote case the URI of the remote channel element.

Returns
URI of the next element.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 380 of file RemoteChannelElement.hpp.

References RTT::base::ChannelElementBase::getOutput(), RTT::base::ChannelElementBase::getRemoteURI(), RTT::corba::ApplicationServer::orb, and RTT::corba::CRemoteChannelElement_i::remote_side.

template<typename T>
virtual bool RTT::corba::RemoteChannelElement< T >::inputReady ( )
inlinevirtual
template<typename T>
virtual bool RTT::corba::RemoteChannelElement< T >::isRemoteElement ( ) const
inlinevirtual

This function may be used to identify, if the current element uses a network transport, to send the data to the next Element in the logical chain.

Returns
true if a network transport is used.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 375 of file RemoteChannelElement.hpp.

template<typename T>
virtual FlowStatus RTT::base::ChannelElement< T >::read ( reference_t  sample,
bool  copy_old_data 
)
inlinevirtualinherited

Reads a sample from the connection.

sample is a reference which will get updated if a sample is available. The method returns true if a sample was available, and false otherwise. If false is returned, then sample is not modified by the method

Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.

Definition at line 116 of file ChannelElement.hpp.

References RTT::base::ChannelElement< T >::getInput(), RTT::NoData, and RTT::base::ChannelElement< T >::read().

Referenced by RTT::base::ChannelElement< T >::read(), RTT::corba::RemoteChannelElement< T >::read(), and RTT::mqueue::MQChannelElement< T >::signal().

template<typename T>
FlowStatus RTT::corba::RemoteChannelElement< T >::read ( typename base::ChannelElement< T >::reference_t  sample,
bool  copy_old_data 
)
inline
template<typename T>
CFlowStatus RTT::corba::RemoteChannelElement< T >::read ( ::CORBA::Any_out  sample,
bool  copy_old_data 
)
inline
void ChannelElementBase::ref ( )
protectedinherited
template<typename T>
void RTT::corba::RemoteChannelElement< T >::remoteDisconnect ( bool  writer_to_reader)
inline
template<typename T>
void RTT::corba::RemoteChannelElement< T >::remoteSignal ( )
inline

CORBA IDL function.

Definition at line 117 of file RemoteChannelElement.hpp.

References RTT::base::ChannelElementBase::signal().

void RTT::base::ChannelElementBase::removeInput ( )
inherited

Removes the input channel (if any).

This call may delete channels from memory.

void RTT::corba::CRemoteChannelElement_i::setCDataFlowInterface ( CDataFlowInterface_i dataflow)
inlineinherited

Definition at line 93 of file DataFlowI.h.

References ACE_THROW_SPEC.

Referenced by RTT::corba::CDataFlowInterface_i::deregisterChannel().

void ChannelElementBase::setOutput ( shared_ptr  output)
inherited

Sets the output of this channel element to output and sets the input of output to this.

This implies that this channel element becomes the input of output. There is no setInput function since this function does both setting input and output of this and output.

Parameters
outputthe next element in chain.

Definition at line 69 of file ChannelInterface.cpp.

Referenced by RTT::internal::ConnFactory::buildBufferedChannelInput(), RTT::internal::ConnFactory::buildBufferedChannelOutput(), RTT::internal::ConnFactory::buildChannelInput(), and RTT::corba::CDataFlowInterface_i::deregisterChannel().

template<typename T>
bool RTT::corba::RemoteChannelElement< T >::signal ( )
inlinevirtual

Signals that there is new data available on this channel By default, the channel element forwards the call to its output.

Returns
false if an error occured that requires the channel to be invalidated. In no ways it indicates that the sample has been received by the other side of the channel.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 122 of file RemoteChannelElement.hpp.

References RTT::corba::CorbaDispatcher::dispatchChannel(), RTT::corba::CorbaDispatcher::Instance(), RTT::corba::CRemoteChannelElement_i::remote_side, and RTT::base::ChannelElementBase::signal().

template<typename T>
virtual void RTT::corba::RemoteChannelElement< T >::transferSamples ( )
inlinevirtual
template<typename T>
virtual bool RTT::base::ChannelElement< T >::write ( param_t  sample)
inlinevirtualinherited

Writes a new sample on this connection.

sample is the sample to write.

Returns
false if an error occured that requires the channel to be invalidated. In no ways it indicates that the sample has been received by the other side of the channel.

Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.

Definition at line 103 of file ChannelElement.hpp.

References RTT::base::ChannelElement< T >::getOutput(), and RTT::base::ChannelElement< T >::write().

Referenced by RTT::mqueue::MQChannelElement< T >::signal(), RTT::base::ChannelElement< T >::write(), and RTT::corba::RemoteChannelElement< T >::write().

template<typename T>
bool RTT::corba::RemoteChannelElement< T >::write ( typename base::ChannelElement< T >::param_t  sample)
inline
template<typename T>
bool RTT::corba::RemoteChannelElement< T >::write ( const ::CORBA::Any &  sample)
inline

Member Data Documentation

CDataFlowInterface_i* RTT::corba::CRemoteChannelElement_i::mdataflow
protectedinherited
PortableServer::POA_var RTT::corba::CRemoteChannelElement_i::mpoa
protectedinherited
CRemoteChannelElement_var RTT::corba::CRemoteChannelElement_i::remote_side
protectedinherited
RTT::corba::CorbaTypeTransporter const& RTT::corba::CRemoteChannelElement_i::transport
protectedinherited

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