RTT::CleanupHandle Class Reference
A connection Handle of a (connected) slot which disconnects and cleans up (free all resources) a slot from a signal in its destructor. More...
#include <rtt/Handle.hpp>
Inheritance diagram for RTT::CleanupHandle:
Public Member Functions | |
| CleanupHandle (const Handle &hs) | |
| ~CleanupHandle () | |
| Cleanup all signal and slot connection resources. | |
| bool | connect () |
| (Re-)Connect the slot with the signal. | |
| bool | disconnect () |
| Disconnect the slot from the signal. | |
| bool | connected () const |
| Inspect if this Handle represents a connected signal and slot. | |
| operator bool () const | |
| Inspect if this Handle is pointing to a valid (existing) connection. | |
| bool | ready () const |
| Inspect if this handle is pointing to valid (existing) connection(s). | |
Protected Attributes | |
| connection_t | m_conn |
| This is actually a smart pointer which always points to an existing connection object. | |
Detailed Description
A connection Handle of a (connected) slot which disconnects and cleans up (free all resources) a slot from a signal in its destructor.
Definition at line 153 of file Handle.hpp.
Constructor & Destructor Documentation
| RTT::CleanupHandle::~CleanupHandle | ( | ) |
Cleanup all signal and slot connection resources.
If connected, disconnect the slot from the signal.
Member Function Documentation
| bool RTT::Handle::connect | ( | ) | [inherited] |
(Re-)Connect the slot with the signal.
- Return values:
-
true the slot is connected. false no valid signal or slot in this Handle
Referenced by RTT::EventProcessor::connect(), and RTT::Event< void() >::connect().
| bool RTT::Handle::connected | ( | ) | const [inherited] |
Inspect if this Handle represents a connected signal and slot.
- Returns:
- true if a connection is present.
| bool RTT::Handle::disconnect | ( | ) | [inherited] |
Disconnect the slot from the signal.
- Return values:
-
true the slot is disconnected. false no valid signal or slot in this Handle
| RTT::Handle::operator bool | ( | ) | const [inherited] |
| bool RTT::Handle::ready | ( | ) | const [inherited] |
Inspect if this handle is pointing to valid (existing) connection(s).
- Returns:
- false if no connection(s) is associated with this handle.
The documentation for this class was generated from the following file:
- rtt/Handle.hpp
