RTT::internal::ConnectionManager Class Reference

#include <ConnectionManager.hpp>

Public Types
typedef boost::tuple < boost::shared_ptr< ConnID > , base::ChannelElementBase::shared_ptr, ConnPolicy >	ChannelDescriptor
Public Member Functions
void	addConnection (ConnID *port_id, base::ChannelElementBase::shared_ptr channel_input, ConnPolicy policy)
void	clear ()
bool	connected () const
	ConnectionManager (base::PortInterface *port)
template<typename Pred >
bool	delete_if (Pred pred)
bool	disconnect (base::PortInterface *port)
void	disconnect ()
template<typename Pred >
std::pair< bool, ChannelDescriptor >	find_if (Pred pred, bool copy_old_data)
std::list< ChannelDescriptor >	getChannels () const
base::ChannelElementBase *	getCurrentChannel () const
bool	isSingleConnection () const
bool	removeConnection (ConnID *port_id)
template<typename Pred >
void	select_reader_channel (Pred pred, bool copy_old_data)
	~ConnectionManager ()
Protected Member Functions
bool	eraseConnection (ChannelDescriptor &descriptor)
bool	findMatchingPort (ConnID const *conn_id, ChannelDescriptor const &descriptor)
void	updateCurrentChannel (bool reset_current)
Protected Attributes
RTT::os::Mutex	connection_lock
os::Mutex	connection_resize_mtx
std::list< ChannelDescriptor >	connections
ChannelDescriptor	cur_channel
base::PortInterface *	mport

Detailed Description

Manages connections between ports. This class is used for input and output ports in order to manage their channels. TODO: use the mutex lock !!!

Definition at line 77 of file ConnectionManager.hpp.

Member Typedef Documentation

typedef boost::tuple<boost::shared_ptr<ConnID>, base::ChannelElementBase::shared_ptr, ConnPolicy> RTT::internal::ConnectionManager::ChannelDescriptor

A Channel (= connection) is described by an opaque ConnID object, the first element of the channel and the policy of the channel. The policy is only given for read-only access, modifying it will not have any effect on the connection.

Definition at line 86 of file ConnectionManager.hpp.

Constructor & Destructor Documentation

RTT::internal::ConnectionManager::ConnectionManager ( base::PortInterface * port )

Creates a connection manager to manage the connections of port.

Parameters:

port

The port whose connections to manage.

Definition at line 61 of file ConnectionManager.cpp.

RTT::internal::ConnectionManager::~ConnectionManager ( )

Definition at line 66 of file ConnectionManager.cpp.

Member Function Documentation

void RTT::internal::ConnectionManager::addConnection	(	ConnID *	port_id,
		base::ChannelElementBase::shared_ptr	channel_input,
		ConnPolicy	policy
	)

Helper method for port-to-port connection establishment. This is the last step in adding a connection to an output port and also validates if the connection is sound.

Returns:: false if the connection failed to work, true otherwise.

void RTT::internal::ConnectionManager::clear ( )

Clears (removes) all data in the manager's connections. After this call, all channels will return NoData, until new data is written.

Definition at line 79 of file ConnectionManager.cpp.

bool RTT::internal::ConnectionManager::connected ( ) const

Returns true if there is at least one channel registered in this port's list of outputs

Definition at line 125 of file ConnectionManager.cpp.

template<typename Pred >

bool RTT::internal::ConnectionManager::delete_if ( Pred pred ) [inline]

Definition at line 119 of file ConnectionManager.hpp.

bool RTT::internal::ConnectionManager::disconnect ( base::PortInterface * port )

Removes the channel that connects this port to port

Definition at line 97 of file ConnectionManager.cpp.

void RTT::internal::ConnectionManager::disconnect ( )

Disconnect all connections.

Definition at line 114 of file ConnectionManager.cpp.

bool RTT::internal::ConnectionManager::eraseConnection ( ConnectionManager::ChannelDescriptor & descriptor ) [protected]

Helper method for disconnect()

Unconditionally removes the given connection and return true

Definition at line 103 of file ConnectionManager.cpp.

template<typename Pred >

std::pair<bool, ChannelDescriptor> RTT::internal::ConnectionManager::find_if	(	Pred	pred,
		bool	copy_old_data
	)			`[inline]`

Definition at line 158 of file ConnectionManager.hpp.

bool RTT::internal::ConnectionManager::findMatchingPort	(	ConnID const *	conn_id,
		ChannelDescriptor const &	descriptor
	)			`[protected]`

Helper method for disconnect(PortInterface*)

This method removes the channel listed in descriptor from the list of output channels if port has the same id that the one listed in descriptor.

Returns:: true if the descriptor matches, false otherwise

Definition at line 84 of file ConnectionManager.cpp.

std::list<ChannelDescriptor> RTT::internal::ConnectionManager::getChannels ( ) const [inline]

Returns a list of all channels managed by this object.

Definition at line 192 of file ConnectionManager.hpp.

base::ChannelElementBase* RTT::internal::ConnectionManager::getCurrentChannel ( ) const [inline]

Returns the first added channel or if select_if was called, the selected channel.

See also:: select_if to change the current channel.

Returns:

Definition at line 185 of file ConnectionManager.hpp.

bool RTT::internal::ConnectionManager::isSingleConnection ( ) const [inline]

Returns true if this manager manages only one connection.

Returns:

Definition at line 178 of file ConnectionManager.hpp.

bool RTT::internal::ConnectionManager::removeConnection ( ConnID * port_id )

Definition at line 138 of file ConnectionManager.cpp.

template<typename Pred >

void RTT::internal::ConnectionManager::select_reader_channel	(	Pred	pred,
		bool	copy_old_data
	)			`[inline]`

Selects a connection as the current channel if pred(connection) is true. It will first check the current channel ( getCurrentChannel() ), if that does not satisfy pred, iterate over all connections. If none satisfy pred, the current channel remains unchanged.

Parameters:

pred

Definition at line 144 of file ConnectionManager.hpp.

void RTT::internal::ConnectionManager::updateCurrentChannel ( bool reset_current ) [protected]

Definition at line 89 of file ConnectionManager.cpp.