All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Files | Namespaces | Classes | Typedefs | Functions
Transport

Handles transportation of messages. More...

Files

file  TransportTypes.hh
 Forward declarations for transport.
 

Namespaces

namespace  gazebo::transport
 Transport namespace.
 

Classes

class  gazebo::transport::CallbackHelper
 A helper class to handle callbacks when messages arrive. More...
 
class  gazebo::transport::CallbackHelperT< M >
 Callback helper Template. More...
 
class  gazebo::transport::Connection
 TCP/IP Connection. More...
 
class  gazebo::transport::ConnectionManager
 Manager of connections. More...
 
class  gazebo::transport::DebugCallbackHelper
 
class  gazebo::transport::IOManager
 Managers boost::asio IO. More...
 
class  gazebo::transport::Node
 A node can advertise and subscribe topics, publish on advertised topics and listen to subscribed topics. More...
 
class  gazebo::transport::Publication
 A publication for a topic. More...
 
class  gazebo::transport::PublicationTransport
 Reads data from a remote advertiser, and passes the data along to local subscribers. More...
 
class  gazebo::transport::Publisher
 A publisher of messages on a topic. More...
 
class  gazebo::transport::SubscribeOptions
 Options for a subscription. More...
 
class  gazebo::transport::Subscriber
 A subscriber to a topic. More...
 
class  gazebo::transport::SubscriptionTransport
 Handles sending data over the wire to remote subscribers. More...
 
class  gazebo::transport::TopicManager
 Manages topics and their subscriptions. More...
 

Typedefs

typedef CallbackHelper * gazebo::transport::CallbackHelperPtr
 boost shared pointer to transport::CallbackHelper
 

Functions

void gazebo::transport::clear_buffers ()
 clear any remaining communication buffers
 
void gazebo::transport::fini ()
 Cleanup the transport component.
 
bool gazebo::transport::get_master_uri (std::string &master_host, unsigned int &master_port)
 Get the hostname and port of the master from the GAZEBO_MASTER_URI environment variable.
 
void gazebo::transport::get_topic_namespaces (std::list< std::string > &_namespaces)
 Return all the namespace (world names) on the master.
 
bool gazebo::transport::init (const std::string &master_host="", unsigned int master_port=0)
 Initialize the transport system.
 
bool gazebo::transport::is_stopped ()
 Return true if the transport system is stopped.
 
void gazebo::transport::pause_incoming (bool _pause)
 Set to true to pause incoming messages.
 
msgs::Response gazebo::transport::request (const std::string &_worldName, const msgs::Request &_request)
 Send a request, and receive a response.
 
void gazebo::transport::run ()
 Run the transport component.
 
void gazebo::transport::stop ()
 Stop the transport component from running.
 

Detailed Description

Handles transportation of messages.

Typedef Documentation

typedef CallbackHelper* gazebo::transport::CallbackHelperPtr

boost shared pointer to transport::CallbackHelper

Function Documentation

void gazebo::transport::clear_buffers ( )

clear any remaining communication buffers

void gazebo::transport::fini ( )

Cleanup the transport component.

bool gazebo::transport::get_master_uri ( std::string &  master_host,
unsigned int &  master_port 
)

Get the hostname and port of the master from the GAZEBO_MASTER_URI environment variable.

Parameters
master_hostThe hostname of the master is set to this param
master_portThe port of the master is set to this param
Returns
False if the GAZEBO_MASTER_URI was not found
void gazebo::transport::get_topic_namespaces ( std::list< std::string > &  _namespaces)

Return all the namespace (world names) on the master.

bool gazebo::transport::init ( const std::string &  master_host = "",
unsigned int  master_port = 0 
)

Initialize the transport system.

Parameters
master_hostThe hostname or IP of the master. Leave empty to use pull address from the GAZEBO_MASTER_URI env var.
master_portThe port of the master. Leave empty to use pull address from the GAZEBO_MASTER_URI env var.
bool gazebo::transport::is_stopped ( )

Return true if the transport system is stopped.

void gazebo::transport::pause_incoming ( bool  _pause)

Set to true to pause incoming messages.

They are still queued for later delivery

msgs::Response gazebo::transport::request ( const std::string &  _worldName,
const msgs::Request &  _request 
)

Send a request, and receive a response.

void gazebo::transport::run ( )

Run the transport component.

This starts message passing. This is a blocking call

void gazebo::transport::stop ( )

Stop the transport component from running.