iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | List of all members
iox::capro::ServiceDescription Class Reference

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>

Classes

struct  ClassHash
 

Public Member Functions

 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.
 
ServiceDescriptionoperator= (const ServiceDescription &) noexcept=default
 
ServiceDescriptionoperator= (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
 

Static Public Member Functions

static cxx::expected< ServiceDescription, cxx::Serialization::Error > deserialize (const cxx::Serialization &serialized) noexcept
 de-serialization of a ServiceDescription.
 

Detailed Description

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.

Member Function Documentation

◆ deserialize()

static cxx::expected< ServiceDescription, cxx::Serialization::Error > iox::capro::ServiceDescription::deserialize ( const cxx::Serialization &  serialized)
staticnoexcept

de-serialization of a ServiceDescription.

Parameters
[in]serialized,Serializationobject from which the ServiceDescription shall be created
Returns
cxx::expected that either has a ServiceDescription or cxx::Serialization::Error stored inside

◆ getClassHash()

ClassHash iox::capro::ServiceDescription::getClassHash ( ) const
noexcept

Getter for class hash

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