class for the identification of a communication event including information on the service, the service instance and the event id. A class object can be serialized/deserialized, so it is possible to send the information e.g. over a IPC channel.
More...
#include <iceoryx_posh/capro/service_description.hpp>
|
| ServiceDescription () noexcept |
| default C'tor
|
|
| ServiceDescription (const ServiceDescription &) noexcept=default |
|
| ServiceDescription (ServiceDescription &&) noexcept=default |
|
| ServiceDescription (const IdString_t &service, const IdString_t &instance, const IdString_t &event, ClassHash m_classHash={0U, 0U, 0U, 0U}, Interfaces interfaceSource=Interfaces::INTERNAL) noexcept |
| construction of the capro service description using fixed strings to create an event service description
|
|
bool | operator== (const ServiceDescription &rhs) const noexcept |
| compare operator.
|
|
bool | operator!= (const ServiceDescription &rhs) const noexcept |
| negation of compare operator.
|
|
bool | operator< (const ServiceDescription &rhs) const noexcept |
| Uses the underlying m_**String compare method to provide an order. This is needed to use ServiceDescription in sorted containers like map or set.
|
|
ServiceDescription & | operator= (const ServiceDescription &) noexcept=default |
|
ServiceDescription & | operator= (ServiceDescription &&) noexcept=default |
|
| operator cxx::Serialization () const noexcept |
| serialization of the capro description.
|
|
bool | isLocal () const noexcept |
|
void | setLocal () noexcept |
|
Scope | getScope () const noexcept |
| Returns the scope of a ServiceDescription.
|
|
Interfaces | getSourceInterface () const noexcept |
| Returns the interface form where the service is coming from.
|
|
|
const IdString_t & | getServiceIDString () const noexcept |
|
const IdString_t & | getInstanceIDString () const noexcept |
|
const IdString_t & | getEventIDString () const noexcept |
|
|
ClassHash | getClassHash () const noexcept |
|
class for the identification of a communication event including information on the service, the service instance and the event id. A class object can be serialized/deserialized, so it is possible to send the information e.g. over a IPC channel.
◆ deserialize()
static cxx::expected< ServiceDescription, cxx::Serialization::Error > iox::capro::ServiceDescription::deserialize |
( |
const cxx::Serialization & |
serialized | ) |
|
|
staticnoexcept |
◆ getClassHash()
ClassHash iox::capro::ServiceDescription::getClassHash |
( |
| ) |
const |
|
noexcept |
◆ getServiceIDString()
const IdString_t & iox::capro::ServiceDescription::getServiceIDString |
( |
| ) |
const |
|
noexcept |
Getters for the string IDs
The documentation for this class was generated from the following file: