Ignition Transport

API Reference

8.1.0

A class to provide different options for a subscription. 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. 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. More...
 
bool Throttled () const
 Whether the subscription has been throttled. More...
 

Protected Attributes

std::unique_ptr< SubscribeOptionsPrivate > dataPtr
 

Detailed Description

A class to provide different options for a subscription.

ignition/transport/SubscribeOptions.hh

Constructor & Destructor Documentation

◆ SubscribeOptions() [1/2]

Constructor.

◆ SubscribeOptions() [2/2]

SubscribeOptions ( const SubscribeOptions _otherSubscribeOpts)

Copy constructor.

Parameters
[in]_otherSubscribeOptsSubscribeOptions to copy.

◆ ~SubscribeOptions()

Destructor.

Member Function Documentation

◆ MsgsPerSec()

uint64_t MsgsPerSec ( ) const

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

Returns
The maximum number of messages per second.

◆ 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]_newMsgsPerSecMaximum 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: