Ignition Transport

API Reference

4.0.0
AdvertiseMessageOptions Class Reference

A class for customizing the publication options for a topic advertised. E.g.: Set the rate of messages per second published. More...

#include <AdvertiseOptions.hh>

Public Member Functions

 AdvertiseMessageOptions ()
 Constructor.
 
 AdvertiseMessageOptions (const AdvertiseMessageOptions &_other)
 Copy constructor.
 
virtual ~AdvertiseMessageOptions ()
 Destructor.
 
size_t MsgLength () const
 Get the total length of the message.
 
uint64_t MsgsPerSec () const
 Get the maximum number of messages per second to be published.
 
bool operator!= (const AdvertiseMessageOptions &_other) const
 Inequality operator. This function checks if the given options do not have identical values to this object.
 
AdvertiseMessageOptionsoperator= (const AdvertiseMessageOptions &_other)
 Assignment operator.
 
bool operator== (const AdvertiseMessageOptions &_other) const
 Equality operator. This function checks if the given AdvertiseMessageOptions has identical content to this object.
 
size_t Pack (char *_buffer) const
 Serialize the options. The caller has ownership of the buffer and is responsible for its [de]allocation.
 
void SetMsgsPerSec (const uint64_t _newMsgsPerSec)
 Set the maximum number of messages per second to be published. Note that we calculate the minimum period of a message based on the msgs/sec rate. Any message sent since the last Publish() and the duration of the period will be discarded.
 
bool Throttled () const
 Whether the publication has been throttled.
 
size_t Unpack (const char *_buffer)
 Unserialize the options.
 
- Public Member Functions inherited from AdvertiseOptions
 AdvertiseOptions ()
 Constructor.
 
 AdvertiseOptions (const AdvertiseOptions &_other)
 Copy constructor.
 
virtual ~AdvertiseOptions ()
 Destructor.
 
size_t MsgLength () const
 Get the total length of the message.
 
bool operator!= (const AdvertiseOptions &_other) const
 Inequality operator. This function checks if the given options do not have identical values to this object.
 
AdvertiseOptionsoperator= (const AdvertiseOptions &_other)
 Assignment operator.
 
bool operator== (const AdvertiseOptions &_other) const
 Equality operator. This function checks if the given AdvertiseOptions has identical content to this object.
 
size_t Pack (char *_buffer) const
 Serialize the options. The caller has ownership of the buffer and is responsible for its [de]allocation.
 
const Scope_tScope () const
 Get the scope used in this topic/service.
 
void SetScope (const Scope_t &_scope)
 Set the scope of the topic or service.
 
size_t Unpack (const char *_buffer)
 Deserialize and set the options. The input buffer is unpacked and used to set this object's options.
 

Detailed Description

A class for customizing the publication options for a topic advertised. E.g.: Set the rate of messages per second published.

Constructor & Destructor Documentation

◆ AdvertiseMessageOptions() [1/2]

Constructor.

◆ AdvertiseMessageOptions() [2/2]

Copy constructor.

Parameters
[in]_otherAdvertiseMessageOptions to copy.

◆ ~AdvertiseMessageOptions()

virtual ~AdvertiseMessageOptions ( )
virtual

Destructor.

Member Function Documentation

◆ MsgLength()

size_t MsgLength ( ) const

Get the total length of the message.

Returns
Return the length of the message in bytes.

◆ MsgsPerSec()

uint64_t MsgsPerSec ( ) const

Get the maximum number of messages per second to be published.

Returns
The maximum number of messages per second.

◆ operator!=()

bool operator!= ( const AdvertiseMessageOptions & _other) const

Inequality operator. This function checks if the given options do not have identical values to this object.

Parameters
[in]_otherThe options to compare against.
Returns
True if this object does not match the provided object.

◆ operator=()

AdvertiseMessageOptions & operator= ( const AdvertiseMessageOptions & _other)

Assignment operator.

Parameters
[in]_otherThe other AdvertiseMessageOptions.
Returns
A reference to this instance.

◆ operator==()

bool operator== ( const AdvertiseMessageOptions & _other) const

Equality operator. This function checks if the given AdvertiseMessageOptions has identical content to this object.

Parameters
[in]_otherThe options to compare against.
Returns
True if this object matches the provided object.

◆ Pack()

size_t Pack ( char * _buffer) const

Serialize the options. The caller has ownership of the buffer and is responsible for its [de]allocation.

Parameters
[out]_bufferDestination buffer in which the options will be serialized.
Returns
Number of bytes serialized.

◆ SetMsgsPerSec()

void SetMsgsPerSec ( const uint64_t _newMsgsPerSec)

Set the maximum number of messages per second to be published. Note that we calculate the minimum period of a message based on the msgs/sec rate. Any message sent since the last Publish() and the duration of the period will be discarded.

Parameters
[in]_newMsgsPerSecMaximum number of messages per second.

◆ Throttled()

bool Throttled ( ) const

Whether the publication has been throttled.

Returns
true when the publication is throttled or false otherwise.
See also
SetMsgsPerSec
MsgsPerSec

◆ Unpack()

size_t Unpack ( const char * _buffer)

Unserialize the options.

Parameters
[in]_bufferInput buffer with the data to be unserialized.

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