Public Member Functions | Protected Attributes | Private Types | List of all members
RTT::Handle Class Reference

The Handle holds the information, and allows manipulation, of a connection between a internal::Signal Handler function and the Signal itself. More...

#include <Handle.hpp>

Inheritance diagram for RTT::Handle:
Inheritance graph
[legend]

Public Member Functions

bool connect ()
 
bool connected () const
 
bool disconnect ()
 
 Handle ()
 the connection type for the slot of this Handle More...
 
 Handle (connection_t conn)
 
 Handle (const Handle &hs)
 
 operator bool () const
 
bool ready () const
 
 ~Handle ()
 

Protected Attributes

connection_t m_conn
 

Private Types

typedef sender_t::connection_t connection_t
 the signal type More...
 
typedef internal::SignalBase sender_t
 

Detailed Description

The Handle holds the information, and allows manipulation, of a connection between a internal::Signal Handler function and the Signal itself.

It is returned by the connect() and setup() methods of Signal and can be used to (dis)connect a handler function from the signal. Handle objects may be assigned to each other and will always point to the same connection. If the last Handle object is destroyed, and is not connected, the connection is destroyed. Thus the resource management (deallocation) is handled by Orocos itself.

To inspect if the Handle points to a valid, existing connection, one can use :

Handle handle;
// ...
if ( !handle ) {
   // not valid !
}

Definition at line 66 of file Handle.hpp.

Member Typedef Documentation

the signal type

Definition at line 70 of file Handle.hpp.

Definition at line 69 of file Handle.hpp.

Constructor & Destructor Documentation

RTT::Handle::Handle ( )

the connection type for the slot of this Handle

Create an empty Handle.

Definition at line 46 of file Handle.cpp.

RTT::Handle::Handle ( connection_t  conn)

Definition at line 51 of file Handle.cpp.

RTT::Handle::Handle ( const Handle hs)

Create a copy-equivalent Handle.

Definition at line 56 of file Handle.cpp.

RTT::Handle::~Handle ( )

No-op destructor, does not change signal/slot state.

Definition at line 61 of file Handle.cpp.

Member Function Documentation

bool RTT::Handle::connect ( )

(Re-)Connect the slot with the signal.

Return values
truethe slot is connected.
falseno valid signal or slot in this Handle

Definition at line 65 of file Handle.cpp.

bool RTT::Handle::connected ( ) const

Inspect if this Handle represents a connected signal and slot.

Returns
true if a connection is present.

Definition at line 79 of file Handle.cpp.

bool RTT::Handle::disconnect ( )

Disconnect the slot from the signal.

Return values
truethe slot is disconnected.
falseno valid signal or slot in this Handle

Definition at line 72 of file Handle.cpp.

RTT::Handle::operator bool ( ) const

Inspect if this Handle is pointing to a valid (existing) connection.

Returns
false if no connection is associated with this Handle.

Definition at line 83 of file Handle.cpp.

bool RTT::Handle::ready ( ) const

Inspect if this handle is pointing to valid (existing) connection(s).

Returns
false if no connection(s) is associated with this handle.

Definition at line 87 of file Handle.cpp.

Member Data Documentation

connection_t RTT::Handle::m_conn
protected

This is actually a smart pointer which always points to an existing connection object.

Definition at line 126 of file Handle.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:46