SubscribeOptions Class Reference

A class to provide different options for a subscription. More...

#include <SubscribeOptions.hh>

Public Member Functions
	SubscribeOptions ()
	Constructor.
	SubscribeOptions (const SubscribeOptions &_otherSubscribeOpts)
	Copy constructor.
	~SubscribeOptions ()
	Destructor.
bool	IgnoreLocalMessages () const
	Whether the local messages should be ignored.
uint64_t	MsgsPerSec () const
	Get the maximum number of messages per seconds received per topic.
void	SetIgnoreLocalMessages (bool _ignore)
	Set the value to ignore local messages or not.
void	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.
bool	Throttled () const
	Whether the subscription has been throttled.

Protected Attributes
std::unique_ptr< SubscribeOptionsPrivate >	dataPtr

Detailed Description

A class to provide different options for a subscription.

gz/transport/SubscribeOptions.hh

Constructor & Destructor Documentation

SubscribeOptions() [1/2]

SubscribeOptions

(

)

Constructor.

SubscribeOptions() [2/2]

SubscribeOptions

(

const SubscribeOptions &

_otherSubscribeOpts

)

Copy constructor.

Parameters

[in]

_otherSubscribeOpts

SubscribeOptions to copy.

~SubscribeOptions()

~SubscribeOptions

(

)

Destructor.

Member Function Documentation

IgnoreLocalMessages()

bool IgnoreLocalMessages

(

)

const

Whether the local messages should be ignored.

Returns

true when the local messages should be ignored or false otherwise.

See also

SetIgnoreLocalMessages

MsgsPerSec()

uint64_t MsgsPerSec

(

)

const

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

Returns

The maximum number of messages per second.

SetIgnoreLocalMessages()

void SetIgnoreLocalMessages

(

bool

_ignore

)

Set the value to ignore local messages or not.

Parameters

[in]

_ignore

True when ignoring local messages or false otherwise.

See also

IgnoreLocalMessages

SetMsgsPerSec()

void 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.

Throttled()

bool 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

dataPtr

std::unique_ptr<SubscribeOptionsPrivate> dataPtr

protected

---

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

• SubscribeOptions.hh