iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::ServiceName Class Reference

The name of a [Service]. More...

#include <service_name.hpp>

Public Member Functions

 ServiceName (ServiceName &&) noexcept
 
auto operator= (ServiceName &&) noexcept -> ServiceName &
 
 ServiceName (const ServiceName &)
 
auto operator= (const ServiceName &) -> ServiceName &
 
 ~ServiceName ()
 
auto as_view () const -> ServiceNameView
 Creates a [ServiceNameView].
 
auto to_string () const -> iox2::bb::StaticString< IOX2_SERVICE_NAME_LENGTH >
 Returns a [iox2::bb::StaticString] containing the [ServiceName].
 

Static Public Member Functions

static auto create (const char *value) -> iox2::bb::Expected< ServiceName, bb::SemanticStringError >
 Creates a new [ServiceName]. The name is not allowed to be empty.
 

Friends

class ServiceNameView
 

Detailed Description

The name of a [Service].

Definition at line 58 of file service_name.hpp.

Constructor & Destructor Documentation

◆ ServiceName() [1/2]

iox2::ServiceName::ServiceName ( ServiceName &&  )
noexcept

◆ ServiceName() [2/2]

iox2::ServiceName::ServiceName ( const ServiceName )

◆ ~ServiceName()

iox2::ServiceName::~ServiceName ( )

Member Function Documentation

◆ as_view()

auto iox2::ServiceName::as_view ( ) const -> ServiceNameView

Creates a [ServiceNameView].

◆ create()

static auto iox2::ServiceName::create ( const char *  value) -> iox2::bb::Expected< ServiceName, bb::SemanticStringError >
static

Creates a new [ServiceName]. The name is not allowed to be empty.

◆ operator=() [1/2]

auto iox2::ServiceName::operator= ( const ServiceName ) -> ServiceName &

◆ operator=() [2/2]

auto iox2::ServiceName::operator= ( ServiceName &&  ) -> ServiceName &
noexcept

◆ to_string()

auto iox2::ServiceName::to_string ( ) const -> iox2::bb::StaticString< IOX2_SERVICE_NAME_LENGTH >

Returns a [iox2::bb::StaticString] containing the [ServiceName].

Friends And Related Symbol Documentation

◆ ServiceNameView

friend class ServiceNameView
friend

Definition at line 76 of file service_name.hpp.


The documentation for this class was generated from the following file: