ignition/transport/SubscribeOptions.hh
More...
#include <SubscribeOptions.hh>
ignition/transport/SubscribeOptions.hh
A class to provide different options for a subscription.
§ SubscribeOptions() [1/2]
ignition::transport::SubscribeOptions::SubscribeOptions |
( |
| ) |
|
§ SubscribeOptions() [2/2]
ignition::transport::SubscribeOptions::SubscribeOptions |
( |
const SubscribeOptions & |
_otherSubscribeOpts | ) |
|
Copy constructor.
- Parameters
-
§ ~SubscribeOptions()
ignition::transport::SubscribeOptions::~SubscribeOptions |
( |
| ) |
|
§ MsgsPerSec()
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.
§ SetMsgsPerSec()
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. |
§ Throttled()
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
§ dataPtr
The documentation for this class was generated from the following file: