A class for customizing the publication options for a topic or service advertised. E.g.: Set the scope of a topic/service.
More...
#include <AdvertiseOptions.hh>
A class for customizing the publication options for a topic or service advertised. E.g.: Set the scope of a topic/service.
ignition/transport/AdvertiseOptions.hh
◆ AdvertiseOptions() [1/2]
◆ AdvertiseOptions() [2/2]
Copy constructor.
- Parameters
-
◆ ~AdvertiseOptions()
◆ MsgLength()
size_t MsgLength |
( |
| ) |
const |
Get the total length of the message.
- Returns
- Return the length of the message in bytes.
◆ operator!=()
Inequality operator. This function checks if the given options do not have identical values to this object.
- Parameters
-
[in] | _other | The options to compare against. |
- Returns
- True if this object does not match the provided object.
◆ operator=()
Assignment operator.
- Parameters
-
- Returns
- A reference to this instance.
◆ operator==()
Equality operator. This function checks if the given AdvertiseOptions has identical content to this object.
- Parameters
-
[in] | _other | The 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] | _buffer | Destination buffer in which the options will be serialized. |
- Returns
- Number of bytes serialized.
◆ Scope()
Get the scope used in this topic/service.
- Returns
- The scope.
- See also
- SetScope.
-
Scope_t.
◆ SetScope()
void SetScope |
( |
const Scope_t & |
_scope | ) |
|
Set the scope of the topic or service.
- Parameters
-
- See also
- Scope.
-
Scope_t.
◆ Unpack()
size_t Unpack |
( |
const char * |
_buffer | ) |
|
Deserialize and set the options. The input buffer is unpacked and used to set this object's options.
- Parameters
-
[in] | _buffer | Input buffer with the data to be deserialized. |
◆ operator<<
Stream insertion operator.
- Parameters
-
The documentation for this class was generated from the following file: