All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
gazebo::transport::ConnectionManager Class Reference

Manager of connections. More...

#include <transport/transport.hh>

Inheritance diagram for gazebo::transport::ConnectionManager:
Inheritance graph
[legend]
Collaboration diagram for gazebo::transport::ConnectionManager:
Collaboration graph
[legend]

Public Member Functions

void Advertise (const std::string &_topic, const std::string &_msgType)
 Advertise a topic. More...
 
ConnectionPtr ConnectToRemoteHost (const std::string &_host, unsigned int _port)
 Connect to a remote server. More...
 
void Fini ()
 Finalize the connection manager. More...
 
void GetAllPublishers (std::list< msgs::Publish > &_publishers)
 Explicitly update the publisher list. More...
 
void GetTopicNamespaces (std::list< std::string > &_namespaces)
 Get all the topic namespaces. More...
 
bool Init (const std::string &_masterHost, unsigned int _masterPort, uint32_t _timeoutIterations=30)
 Initialize the connection manager. More...
 
bool IsRunning () const
 Is the manager running? More...
 
void RegisterTopicNamespace (const std::string &_name)
 Register a new topic namespace. More...
 
void RemoveConnection (ConnectionPtr &_conn)
 Remove a connection from the manager. More...
 
void Run ()
 Run the connection manager loop. More...
 
void Stop ()
 Stop the conneciton manager. More...
 
void Subscribe (const std::string &_topic, const std::string &_msgType, bool _latching)
 Subscribe to a topic. More...
 
void TriggerUpdate ()
 Inform the connection manager that it needs an update. More...
 
void Unadvertise (const std::string &_topic)
 Unadvertise a topic. More...
 
void Unsubscribe (const msgs::Subscribe &_sub)
 Unsubscribe from a topic. More...
 
void Unsubscribe (const std::string &_topic, const std::string &_msgType)
 Unsubscribe from a topic. More...
 

Protected Attributes

std::vector< event::ConnectionPtreventConnections
 

Additional Inherited Members

- Static Public Member Functions inherited from SingletonT< ConnectionManager >
static ConnectionManager * Instance ()
 Get an instance of the singleton. More...
 
- Protected Member Functions inherited from SingletonT< ConnectionManager >
 SingletonT ()
 Constructor. More...
 
virtual ~SingletonT ()
 Destructor. More...
 

Detailed Description

Manager of connections.

Member Function Documentation

void gazebo::transport::ConnectionManager::Advertise ( const std::string &  _topic,
const std::string &  _msgType 
)

Advertise a topic.

Parameters
[in]_topicThe topic to advertise
[in]_msgTypeThe type of the topic
ConnectionPtr gazebo::transport::ConnectionManager::ConnectToRemoteHost ( const std::string &  _host,
unsigned int  _port 
)

Connect to a remote server.

Parameters
[in]_hostHost to connect to
[in]_portPort to connect to
Returns
Pointer to the connection; can be null (if connection failed)
void gazebo::transport::ConnectionManager::Fini ( )

Finalize the connection manager.

void gazebo::transport::ConnectionManager::GetAllPublishers ( std::list< msgs::Publish > &  _publishers)

Explicitly update the publisher list.

Parameters
[out]_publishersThe updated list of publishers is written here
void gazebo::transport::ConnectionManager::GetTopicNamespaces ( std::list< std::string > &  _namespaces)

Get all the topic namespaces.

Parameters
[out]_namespacesThe list of namespace is written here
bool gazebo::transport::ConnectionManager::Init ( const std::string &  _masterHost,
unsigned int  _masterPort,
uint32_t  _timeoutIterations = 30 
)

Initialize the connection manager.

Parameters
[in]_masterHostHost where the master is running.
[in]_masterPortPort where the master is running.
[in]_timeoutIterationsNumber of times to wait for a connection to master.
Returns
true if initialization succeeded, false otherwise
bool gazebo::transport::ConnectionManager::IsRunning ( ) const

Is the manager running?

Returns
true if running, false otherwise
void gazebo::transport::ConnectionManager::RegisterTopicNamespace ( const std::string &  _name)

Register a new topic namespace.

Parameters
[in]_nameThe name of the topic namespace to be registered
void gazebo::transport::ConnectionManager::RemoveConnection ( ConnectionPtr _conn)

Remove a connection from the manager.

Parameters
[in]_connThe connection to be removed
void gazebo::transport::ConnectionManager::Run ( )

Run the connection manager loop.

Does not return until stopped.

void gazebo::transport::ConnectionManager::Stop ( )

Stop the conneciton manager.

void gazebo::transport::ConnectionManager::Subscribe ( const std::string &  _topic,
const std::string &  _msgType,
bool  _latching 
)

Subscribe to a topic.

Parameters
[in]_topicThe topic to subscribe to.
[in]_msgTypeThe type of the topic.
[in]_latchingIf true, latch the latest incoming message; otherwise don't.
void gazebo::transport::ConnectionManager::TriggerUpdate ( )

Inform the connection manager that it needs an update.

void gazebo::transport::ConnectionManager::Unadvertise ( const std::string &  _topic)

Unadvertise a topic.

Parameters
[in]_topicThe topic to unadvertise
void gazebo::transport::ConnectionManager::Unsubscribe ( const msgs::Subscribe &  _sub)

Unsubscribe from a topic.

Parameters
[in]_subA subscription object
void gazebo::transport::ConnectionManager::Unsubscribe ( const std::string &  _topic,
const std::string &  _msgType 
)

Unsubscribe from a topic.

Parameters
[in]_topicThe topic to unsubscribe from
[in]_msgTypeThe type of the topic

Member Data Documentation

std::vector<event::ConnectionPtr> gazebo::transport::ConnectionManager::eventConnections
protected

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