class for the identification of a communication event including information on the service, the service instance and the event id. In order to support different communication protocols, two types of members exist: integer and string identifiers. If string IDs are used, the integers are initialized to an invalid number. A class object can be serialized/deserialized, so it is possible to send the information e.g. over a IPC channel.
More...
|
| ServiceDescription (const cxx::Serialization &f_serial) noexcept |
| construction of the capro service description using serialized strings
|
|
| ServiceDescription () noexcept |
| default C'tor
|
|
| ServiceDescription (const ServiceDescription &)=default |
|
| ServiceDescription (ServiceDescription &&)=default |
|
| ServiceDescription (uint16_t f_serviceID, uint16_t f_instanceID) noexcept |
| construction of the capro service description using integers to create a service service description
|
|
| ServiceDescription (const IdString_t &f_service, const IdString_t &f_instance) noexcept |
| construction of the capro service description using fixed strings to create a service service description
|
|
| ServiceDescription (uint16_t f_serviceID, uint16_t f_eventID, uint16_t f_instanceID) noexcept |
| construction of the capro service description using integers to create an event service description
|
|
| ServiceDescription (const IdString_t &f_service, const IdString_t &f_instance, const IdString_t &f_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 |
| compare operator. If wildcards AnyService, AnyInstance or AnyEvent are used as integer IDs, the corresponding member comparisons are skipped. Otherwise, both the integer and the string members are compared.
|
|
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 | hasServiceOnlyDescription () const noexcept |
| Returns true if it contains a service description which does not have events, otherwise it returns false.
|
|
bool | isInternal () const noexcept |
|
void | setInternal () noexcept |
|
Scope | getScope () noexcept |
| Returns the scope of a ServiceDescription.
|
|
bool | isValid () const noexcept |
| Returns true for valid ServiceDescription false for ServiceDescription that contains either of InvalidID/InvalidIDString AnyService/AnyServiceString, AnyInstance/AnyInstanceString, AnyEvent/AnyEventString.
|
|
Interfaces | getSourceInterface () const noexcept |
| Returns the interface form where the service is coming from.
|
|
|
uint16_t | getInstanceID () const noexcept |
|
uint16_t | getServiceID () const noexcept |
|
uint16_t | getEventID () const noexcept |
|
IdString_t | getServiceIDString () const noexcept |
|
IdString_t | getInstanceIDString () const noexcept |
|
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. In order to support different communication protocols, two types of members exist: integer and string identifiers. If string IDs are used, the integers are initialized to an invalid number. A class object can be serialized/deserialized, so it is possible to send the information e.g. over a IPC channel.