gazebo::transport::SubscriptionTransport Class Reference

transport/transport.hh More...

#include <SubscriptionTransport.hh>

Inheritance diagram for gazebo::transport::SubscriptionTransport:

Public Member Functions
	SubscriptionTransport ()
	Constructor. More...
virtual	~SubscriptionTransport ()
	Destructor. More...
const ConnectionPtr &	GetConnection () const
	Get the connection we're using. More...
virtual bool	HandleData (const std::string &_newdata, boost::function< void(uint32_t)> _cb, uint32_t _id)
	Output a message to a connection. More...
virtual bool	HandleMessage (MessagePtr _newMsg)
	Process new incoming message. More...
void	Init (ConnectionPtr _conn, bool _latching)
	Initialize the publication link. More...
virtual bool	IsLocal () const
	Is the callback local? More...
Public Member Functions inherited from gazebo::transport::CallbackHelper
	CallbackHelper (bool _latching=false)
	Constructor. More...
virtual	~CallbackHelper ()
	Destructor. More...
unsigned int	GetId () const
	Get the unique ID of this callback. More...
bool	GetLatching () const
	Is the callback latching? More...
virtual std::string	GetMsgType () const
	Get the typename of the message that is handled. More...
void	SetLatching (bool _latch)
	Set whether this callback is latching. More...

Additional Inherited Members
Protected Attributes inherited from gazebo::transport::CallbackHelper
bool	latching
	True means that the callback helper will get the last published message on the topic. More...
std::mutex	latchingMutex
	Mutex to protect the latching variable. More...

Detailed Description

transport/transport.hh

Handles sending data over the wire to remote subscribers

Constructor & Destructor Documentation

gazebo::transport::SubscriptionTransport::SubscriptionTransport

(

)

Constructor.

virtual gazebo::transport::SubscriptionTransport::~SubscriptionTransport ( )

virtual

Destructor.

Member Function Documentation

const ConnectionPtr& gazebo::transport::SubscriptionTransport::GetConnection

(

)

const

Get the connection we're using.

Returns

Pointer to the connection we're using

virtual bool gazebo::transport::SubscriptionTransport::HandleData ( const std::string &  _newdata, boost::function< void(uint32_t)>  _cb, uint32_t  _id  )

virtual

Output a message to a connection.

Parameters

[in]

_newdata

The message to be handled

Returns

true if the message was handled successfully, false otherwise

Parameters

[in]	_cb	If non-null, callback to be invoked after transmission is complete.
[in]	_id	ID associated with the message data.

Implements gazebo::transport::CallbackHelper.

virtual bool gazebo::transport::SubscriptionTransport::HandleMessage ( MessagePtr  _newMsg )

virtual

Process new incoming message.

Parameters

[in]

_newMsg

Incoming message to be processed

Returns

true if successfully processed; false otherwise

Implements gazebo::transport::CallbackHelper.

void gazebo::transport::SubscriptionTransport::Init	(	ConnectionPtr	_conn,
		bool	_latching
	)

Initialize the publication link.

Parameters

[in]	_conn	The connection to use
[in]	_latching	If true, latch the latest message; if false, don't latch

virtual bool gazebo::transport::SubscriptionTransport::IsLocal ( ) const

virtual

Is the callback local?

Returns

true if the callback is local, false if the callback is tied to a remote connection

Implements gazebo::transport::CallbackHelper.

---

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

• SubscriptionTransport.hh