RTT::internal::SignalBase Class Reference

#include <SignalBase.hpp>

Inheritance diagram for RTT::internal::SignalBase:

Public Types
typedef ConnectionBase::shared_ptr	connection_t
typedef std::list< connection_t >	connections_list
typedef connections_list::iterator	const_iterator
typedef connections_list::iterator	iterator
Public Member Functions
virtual int	arity () const =0
void	destroy ()
void	disconnect ()
void	reserve (size_t conns)
virtual	~SignalBase ()
Protected Member Functions
void	cleanup ()
void	conn_connect (connection_t conn)
void	conn_destroy (connection_t conn)
void	conn_disconnect (connection_t conn)
void	conn_setup (connection_t conn)
	SignalBase ()
Protected Attributes
int	concount
bool	emitting
iterator	itend
RTT::os::MutexRecursive	m
connections_list	mconnections
Private Member Functions
const SignalBase &	operator= (const SignalBase &)
	SignalBase (const SignalBase &)
Friends
class	ConnectionBase

Detailed Description

The base signal class which stores connection objects. It implements real-time management of connections, such that connection/disconnetion of a handler is always thread-safe and real-time.

Definition at line 128 of file SignalBase.hpp.

Member Typedef Documentation

typedef ConnectionBase::shared_ptr RTT::internal::SignalBase::connection_t

Definition at line 131 of file SignalBase.hpp.

typedef std::list< connection_t > RTT::internal::SignalBase::connections_list

Definition at line 138 of file SignalBase.hpp.

typedef connections_list::iterator RTT::internal::SignalBase::const_iterator

Definition at line 141 of file SignalBase.hpp.

typedef connections_list::iterator RTT::internal::SignalBase::iterator

Definition at line 140 of file SignalBase.hpp.

Constructor & Destructor Documentation

RTT::internal::SignalBase::SignalBase ( ) [protected]

Definition at line 210 of file SignalBase.cpp.

RTT::internal::SignalBase::~SignalBase ( ) [virtual]

Deletes this Signal and will destroy all connections and handles of this object. It is not necessary to call disconnect() or disconnect() prior to destroying a SignalBase.

Definition at line 229 of file SignalBase.cpp.

RTT::internal::SignalBase::SignalBase ( const SignalBase & ) [private]

Member Function Documentation

virtual int RTT::internal::SignalBase::arity ( ) const [pure virtual]

Returns the arity (the number of arguments) of this signal.

Implemented in RTT::internal::OROCOS_SIGNAL_N< R, SlotFunctionT >.

void RTT::internal::SignalBase::cleanup ( ) [protected]

Erase all empty list items after emit().

Definition at line 176 of file SignalBase.cpp.

void RTT::internal::SignalBase::conn_connect ( connection_t conn ) [protected]

Definition at line 103 of file SignalBase.cpp.

void RTT::internal::SignalBase::conn_destroy ( connection_t conn ) [protected]

Definition at line 130 of file SignalBase.cpp.

void RTT::internal::SignalBase::conn_disconnect ( connection_t conn ) [protected]

Definition at line 146 of file SignalBase.cpp.

void RTT::internal::SignalBase::conn_setup ( connection_t conn ) [protected]

Definition at line 88 of file SignalBase.cpp.

void RTT::internal::SignalBase::destroy ( )

Destroys all connections. This will destroy all connections of this Event. All Handles will be disconnected and unable to reconnect.

Definition at line 252 of file SignalBase.cpp.

void RTT::internal::SignalBase::disconnect ( )

Disconnects all connections. All Handles will be disconnected, but able to reconnect.

Definition at line 241 of file SignalBase.cpp.

const SignalBase& RTT::internal::SignalBase::operator= ( const SignalBase & ) [private]

void RTT::internal::SignalBase::reserve ( size_t conns )

Reserves memory for a number of connections. Use this method to efficiently reserve memory for possible connections. If not used, the event will reserve memory in batch, depending upon demand. This does not impair/influence real-time performance, only memory efficiency.

Parameters:

conns

The number of connections to reserve memory for.

Definition at line 268 of file SignalBase.cpp.