Skip to content

iox::capro🔗

Classes🔗

Name
class 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.

Types🔗

Name
enum uint16_t Interfaces { INTERNAL = 0, ESOC, SOMEIP, AMQP, MQTT, DDS, SIGNAL, MTA, ROS1, INTERFACE_END}
Describes from which interface the service is coming from.
enum uint16_t Scope { WORLDWIDE, LOCAL, INVALID}
Scope of a service description.
using iox::cxx::nullopt_t Wildcard_t
Used to search for any string.
using cxx::string< 100 > IdString_t

Functions🔗

Name
bool serviceMatch(const ServiceDescription & first, const ServiceDescription & second)
Compare two service descriptions via their values in member variables and return bool if match.
std::ostream & operator<<(std::ostream & stream, const ServiceDescription & service)
Convenience stream operator to easily use the [ServiceDescription]() with std::ostream.
log::LogStream & operator<<(log::LogStream & stream, const ServiceDescription & service)
Convenience stream operator to easily use the [ServiceDescription]() with log::LogStream.

Attributes🔗

Name
constexpr Wildcard_t Wildcard
constexpr int32_t MAX_NUMBER_OF_CHARS
constexpr size_t CLASS_HASH_ELEMENT_COUNT
constexpr const char * INTERFACE_NAMES
constexpr char ScopeTypeString

Types Documentation🔗

enum Interfaces🔗

Enumerator Value Description
INTERNAL 0 Used for services, which are locally on this system and not coming over a gateway.
ESOC Canonical protocol for CAN Bus.
SOMEIP SOME/IP.
AMQP Advanced Message Queuing Protocol.
MQTT Message Queuing Telemetry Transport.
DDS Data Distribution Service.
SIGNAL Universal Measurement and Calibration Protocol (XCP)
MTA Measurement technology adapter.
ROS1 Robot Operating System 1.
INTERFACE_END End of enum.

Describes from which interface the service is coming from.

enum Scope🔗

Enumerator Value Description
WORLDWIDE
LOCAL
INVALID

Scope of a service description.

using Wildcard_t🔗

using iox::capro::Wildcard_t = typedef iox::cxx::nullopt_t;

Used to search for any string.

using IdString_t🔗

using iox::capro::IdString_t = typedef cxx::string<100>;

Functions Documentation🔗

function serviceMatch🔗

bool serviceMatch(
    const ServiceDescription & first,
    const ServiceDescription & second
)

Compare two service descriptions via their values in member variables and return bool if match.

Parameters:

Return: Bool if comparison match or not

function operator<<🔗

std::ostream & operator<<(
    std::ostream & stream,
    const ServiceDescription & service
)

Convenience stream operator to easily use the [ServiceDescription]() with std::ostream.

Parameters:

  • stream output stream to write the message to
  • service ServiceDescription that shall be converted

Return: the reference to stream which was provided as input parameter

function operator<<🔗

log::LogStream & operator<<(
    log::LogStream & stream,
    const ServiceDescription & service
)

Convenience stream operator to easily use the [ServiceDescription]() with log::LogStream.

Parameters:

  • stream output LogStream to write the message to
  • service ServiceDescription that shall be converted

Return: the reference to stream which was provided as input parameter

Attributes Documentation🔗

variable Wildcard🔗

constexpr Wildcard_t Wildcard;

variable MAX_NUMBER_OF_CHARS🔗

static constexpr int32_t MAX_NUMBER_OF_CHARS = 64;

variable CLASS_HASH_ELEMENT_COUNT🔗

static constexpr size_t CLASS_HASH_ELEMENT_COUNT {4U};

variable INTERFACE_NAMES🔗

constexpr const char * INTERFACE_NAMES = {"INTERNAL", "ESOC", "SOMEIP", "AMQP", "DDS", "SIGNAL", "MTA", "ROS1", "END"};

variable ScopeTypeString🔗

constexpr char ScopeTypeString = {"WORLDWIDE", "INTERNAL", "INVALID"};

Updated on 31 May 2022 at 11:34:55 CEST