ignition::transport::SubscribeOptions Class Reference

ignition/transport/SubscribeOptions.hh More...

#include <SubscribeOptions.hh>

Public Member Functions
	SubscribeOptions ()
	Constructor. More...
	SubscribeOptions (const SubscribeOptions &_otherSubscribeOpts)
	Copy constructor. More...
	~SubscribeOptions ()
	Destructor. More...
uint64_t	MsgsPerSec () const
	Get the maximum number of messages per seconds received per topic. More...
void	SetMsgsPerSec (const uint64_t _newMsgsPerSec)
	Set the maximum number of messages per second received per topic. More...
bool	Throttled () const
	Whether the subscription has been throttled. More...

Protected Attributes
std::unique_ptr < SubscribeOptionsPrivate >	dataPtr

Detailed Description

ignition/transport/SubscribeOptions.hh

A class to provide different options for a subscription.

Constructor & Destructor Documentation

ignition::transport::SubscribeOptions::SubscribeOptions

(

)

Constructor.

ignition::transport::SubscribeOptions::SubscribeOptions

(

const SubscribeOptions &

_otherSubscribeOpts

)

Copy constructor.

Parameters

[in]

_otherSubscribeOpts

SubscribeOptions to copy.

ignition::transport::SubscribeOptions::~SubscribeOptions

(

)

Destructor.

Member Function Documentation

uint64_t ignition::transport::SubscribeOptions::MsgsPerSec

(

)

const

Get the maximum number of messages per seconds received per topic.

Returns

The maximum number of messages per second.

void ignition::transport::SubscribeOptions::SetMsgsPerSec

(

const uint64_t

_newMsgsPerSec

)

Set the maximum number of messages per second received per topic.

Note that we calculate the minimum period of a message based on the msgs/sec rate. Any message received since the last subscription callback and the duration of the period will be discarded.

Parameters

[in]

_newMsgsPerSec

Maximum number of messages per second.

bool ignition::transport::SubscribeOptions::Throttled

(

)

const

Whether the subscription has been throttled.

Returns

true when the subscription is throttled or false otherwise.

See Also

SetMsgsPerSec

MsgsPerSec

Member Data Documentation

std::unique_ptr<SubscribeOptionsPrivate> ignition::transport::SubscribeOptions::dataPtr

protected

---

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

• SubscribeOptions.hh