Transport

Handles transportation of messages. More...

Classes
class	CallbackHelper
	A helper class to handle callbacks when messages arrive. More...
class	CallbackHelperT< M >
	Callback helper Template. More...
class	DebugCallbackHelper
class	Connection
	TCP/IP Connection. More...
class	ConnectionManager
	Manager of connections. More...
class	IOManager
	Managers boost::asio IO. More...
class	Node
	A node can advertise and subscribe topics, publish on advertised topics and listen to subscribed topics. More...
class	Publication
	A publication for a topic. More...
class	PublicationTransport
	Reads data from a remote advertiser, and passes the data along to local subscribers. More...
class	Publisher
	A publisher of messages on a topic. More...
class	SubscribeOptions
	Options for a subscription. More...
class	Subscriber
	A subscriber to a topic. More...
class	SubscriptionTransport
	Handles sending data over the wire to remote subscribers. More...
class	TopicManager
	Manages topics and their subscriptions. More...
Namespaces
namespace	gazebo::transport
	Transport namespace.
Files
file	TransportTypes.hh
	Forward declarations for transport.
Typedefs
typedef boost::shared_ptr < CallbackHelper >	CallbackHelperPtr
Functions
bool	get_master_uri (std::string &master_host, unsigned short &master_port)
	Get the hostname and port of the master from the GAZEBO_MASTER_URI environment variable.
bool	init (const std::string &master_host="", unsigned short master_port=0)
	Initialize the transport system.
void	run ()
	Run the transport component.
bool	is_stopped ()
	Return true if the transport system is stopped.
void	stop ()
	Stop the transport component from running.
void	fini ()
	Cleanup the transport component.
void	clear_buffers ()
void	pause_incoming (bool _pause)
	Set to true to pause incoming messages.

---

Detailed Description

Handles transportation of messages.

---

Function Documentation

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

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

Parameters:

master_host	The hostname of the master is set to this param
master_port	The port of the master is set to this param

Returns:

False if the GAZEBO_MASTER_URI was not found

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

Initialize the transport system.

Parameters:

master_host	The hostname or IP of the master. Leave empty to use pull address from the GAZEBO_MASTER_URI env var.
master_port	The port of the master. Leave empty to use pull address from the GAZEBO_MASTER_URI env var.

Referenced by gazebo::sensors::load().

void gazebo::transport::pause_incoming

(

bool

_pause

)

Set to true to pause incoming messages.

They are still queued for later delivery

void gazebo::transport::run

(

)

Run the transport component.

This starts message passing. This is a blocking call

References gazebo::run().

Referenced by gazebo::transport::run().