SubscriptionTransport Class Reference

transport/transport.hh More...

#include <SubscriptionTransport.hh>

Inherits CallbackHelper.

Public Member Functions
	SubscriptionTransport ()
	Constructor. More...
virtual	~SubscriptionTransport ()
	Destructor. More...
const ConnectionPtr &	GetConnection () const
	Get the connection we're using. 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...
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...
void	SetLatching (bool _latch)
	Set whether this callback is latching. More...

Protected Attributes
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

SubscriptionTransport()

SubscriptionTransport

(

)

Constructor.

~SubscriptionTransport()

virtual ~SubscriptionTransport ( )

virtual

Destructor.

Member Function Documentation

GetConnection()

const ConnectionPtr& GetConnection

(

)

const

Get the connection we're using.

Returns

Pointer to the connection we're using

GetId()

unsigned int GetId ( ) const

inherited

Get the unique ID of this callback.

Returns

The unique ID of this callback.

GetLatching()

bool GetLatching ( ) const

inherited

Is the callback latching?

Returns

true if the callback is latching, false otherwise

GetMsgType()

virtual std::string GetMsgType ( ) const

virtualinherited

Get the typename of the message that is handled.

Returns

String representation of the message type

Reimplemented in RawCallbackHelper, and CallbackHelperT< M >.

HandleData()

virtual bool 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 CallbackHelper.

HandleMessage()

virtual bool HandleMessage ( MessagePtr  _newMsg )

virtual

Process new incoming message.

Parameters

[in]

_newMsg

Incoming message to be processed

Returns

true if successfully processed; false otherwise

Implements CallbackHelper.

Init()

void 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

IsLocal()

virtual bool 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 CallbackHelper.

SetLatching()

void SetLatching ( bool  _latch )

inherited

Set whether this callback is latching.

This function should only be used by the Transport library.

Parameters

[in]

_latch

False to turn off latching.

Referenced by CallbackHelperT< M >::HandleData(), RawCallbackHelper::HandleData(), CallbackHelperT< M >::HandleMessage(), and RawCallbackHelper::HandleMessage().

Member Data Documentation

latching

bool latching

protectedinherited

True means that the callback helper will get the last published message on the topic.

latchingMutex

std::mutex latchingMutex

mutableprotectedinherited

Mutex to protect the latching variable.

---

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

• SubscriptionTransport.hh