Skip to content

iox::capro::ServiceDescription🔗

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. #include <iceoryx_posh/capro/service_description.hpp>

Public Classes🔗

Name
struct ClassHash

Public Functions🔗

Name
const IdString_t & getServiceIDString() const
const IdString_t & getInstanceIDString() const
const IdString_t & getEventIDString() const
ClassHash getClassHash() const
ServiceDescription()
default C'tor
ServiceDescription(const ServiceDescription & ) =default
ServiceDescription(ServiceDescription && ) =default
~ServiceDescription() =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)
construction of the capro service description using fixed strings to create an event service description
bool operator==(const ServiceDescription & rhs) const
compare operator.
bool operator!=(const ServiceDescription & rhs) const
negation of compare operator.
bool operator<(const ServiceDescription & rhs) const
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 & ) =default
ServiceDescription & operator=(ServiceDescription && ) =default
operator cxx::Serialization() const
serialization of the capro description.
bool isLocal() const
void setLocal()
Scope getScope() const
Returns the scope of a ServiceDescription.
Interfaces getSourceInterface() const
Returns the interface form where the service is coming from.
cxx::expected< ServiceDescription, cxx::Serialization::Error > deserialize(const cxx::Serialization & serialized)
de-serialization of a ServiceDescription.

Public Functions Documentation🔗

function getServiceIDString🔗

const IdString_t & getServiceIDString() const

Getters for the string IDs

function getInstanceIDString🔗

const IdString_t & getInstanceIDString() const

function getEventIDString🔗

const IdString_t & getEventIDString() const

function getClassHash🔗

ClassHash getClassHash() const

Getter for class hash

function ServiceDescription🔗

ServiceDescription()

default C'tor

function ServiceDescription🔗

ServiceDescription(
    const ServiceDescription & 
) =default

function ServiceDescription🔗

ServiceDescription(
    ServiceDescription && 
) =default

function ~ServiceDescription🔗

~ServiceDescription() =default

function ServiceDescription🔗

ServiceDescription(
    const IdString_t & service,
    const IdString_t & instance,
    const IdString_t & event,
    ClassHash m_classHash ={0U, 0U, 0U, 0U},
    Interfaces interfaceSource =Interfaces::INTERNAL
)

construction of the capro service description using fixed strings to create an event service description

function operator==🔗

bool operator==(
    const ServiceDescription & rhs
) const

compare operator.

function operator!=🔗

bool operator!=(
    const ServiceDescription & rhs
) const

negation of compare operator.

function operator<🔗

bool operator<(
    const ServiceDescription & rhs
) const

Uses the underlying m_**String compare method to provide an order. This is needed to use ServiceDescription in sorted containers like map or set.

function operator=🔗

ServiceDescription & operator=(
    const ServiceDescription & 
) =default

function operator=🔗

ServiceDescription & operator=(
    ServiceDescription && 
) =default

function operator cxx::Serialization🔗

explicit operator cxx::Serialization() const

serialization of the capro description.

function isLocal🔗

bool isLocal() const

function setLocal🔗

void setLocal()

function getScope🔗

Scope getScope() const

Returns the scope of a ServiceDescription.

function getSourceInterface🔗

Interfaces getSourceInterface() const

Returns the interface form where the service is coming from.

function deserialize🔗

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

de-serialization of a ServiceDescription.

Parameters:

Return: cxx::expected that either has a ServiceDescription or cxx::Serialization::Error stored inside


Updated on 2 April 2022 at 16:37:47 CEST