Public Types | Public Member Functions | Private Attributes | List of all members
message_filters::Connection Class Reference

Encapsulates a connection from one filter to another (or to a user-specified callback) More...

#include <connection.h>

Public Types

typedef boost::function< void(void)> VoidDisconnectFunction
 
typedef boost::function< void(const Connection &)> WithConnectionDisconnectFunction
 

Public Member Functions

 Connection ()
 
 Connection (const VoidDisconnectFunction &func)
 
 Connection (const WithConnectionDisconnectFunction &func, boost::signals2::connection conn)
 
void disconnect ()
 disconnects this connection More...
 
boost::signals2::connection getBoostConnection () const
 

Private Attributes

boost::signals2::connection connection_
 
WithConnectionDisconnectFunction connection_disconnect_
 
VoidDisconnectFunction void_disconnect_
 

Detailed Description

Encapsulates a connection from one filter to another (or to a user-specified callback)

Definition at line 80 of file connection.h.

Member Typedef Documentation

◆ VoidDisconnectFunction

typedef boost::function<void(void)> message_filters::Connection::VoidDisconnectFunction

Definition at line 115 of file connection.h.

◆ WithConnectionDisconnectFunction

Definition at line 116 of file connection.h.

Constructor & Destructor Documentation

◆ Connection() [1/3]

message_filters::Connection::Connection ( )
inline

Definition at line 117 of file connection.h.

◆ Connection() [2/3]

message_filters::Connection::Connection ( const VoidDisconnectFunction func)

Definition at line 73 of file connection.cpp.

◆ Connection() [3/3]

message_filters::Connection::Connection ( const WithConnectionDisconnectFunction func,
boost::signals2::connection  conn 
)

Definition at line 78 of file connection.cpp.

Member Function Documentation

◆ disconnect()

void message_filters::Connection::disconnect ( )

disconnects this connection

Definition at line 84 of file connection.cpp.

◆ getBoostConnection()

boost::signals2::connection message_filters::Connection::getBoostConnection ( ) const
inline

Definition at line 126 of file connection.h.

Member Data Documentation

◆ connection_

boost::signals2::connection message_filters::Connection::connection_
private

Definition at line 131 of file connection.h.

◆ connection_disconnect_

WithConnectionDisconnectFunction message_filters::Connection::connection_disconnect_
private

Definition at line 130 of file connection.h.

◆ void_disconnect_

VoidDisconnectFunction message_filters::Connection::void_disconnect_
private

Definition at line 129 of file connection.h.


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


message_filters
Author(s): Josh Faust, Vijay Pradeep, Dirk Thomas
autogenerated on Sat Oct 17 2020 19:28:52