RTT::internal::SignalBase Class Reference

#include <SignalBase.hpp>

Inheritance diagram for RTT::internal::SignalBase:

Public Types
typedef ConnectionBase::shared_ptr	connection_t
typedef ListLockFree< connection_t >	connections_list

Public Member Functions
virtual int	arity () const =0
void	destroy ()
void	disconnect ()
void	reserve (size_t conns)
virtual	~SignalBase ()

Protected Member Functions
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
bool	emitting
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 ListLockFree<connection_t> RTT::internal::SignalBase::connections_list

Definition at line 133 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::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 251 of file SignalBase.cpp.

void RTT::internal::SignalBase::disconnect

(

)

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

Definition at line 240 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 267 of file SignalBase.cpp.

Friends And Related Function Documentation

friend class ConnectionBase

friend

Definition at line 144 of file SignalBase.hpp.

Member Data Documentation

bool RTT::internal::SignalBase::emitting

protected

Definition at line 171 of file SignalBase.hpp.

connections_list RTT::internal::SignalBase::mconnections

protected

Definition at line 154 of file SignalBase.hpp.

---

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

• SignalBase.hpp
• SignalBase.cpp