iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::bb Namespace Reference

Namespaces

namespace  detail
 
namespace  duration_literals
 
namespace  platform
 
namespace  stl
 

Classes

class  Duration
 
class  FileName
 Represents a single file name. It is not allowed to contain any path elements like "./some_file" or "path/to/file". Just a plain old simple "my_file.bla". More...
 
class  FilePath
 Represents a path to a file. It is not allowed to end with a path separator since this would then be a path to a directory. A valid file path is for instance "path/to/file" but not "path/to/file/". More...
 
struct  From
 
struct  From< std::chrono::microseconds, Duration >
 Construct a Duration object from std::chrono::microseconds. More...
 
struct  From< std::chrono::milliseconds, Duration >
 Construct a Duration object from std::chrono::milliseconds. More...
 
struct  From< std::chrono::nanoseconds, Duration >
 Construct a Duration object from std::chrono::nanoseconds. More...
 
struct  From< std::chrono::seconds, Duration >
 Construct a Duration object from std::chrono::seconds. More...
 
struct  IsSlice
 
struct  IsSlice< Slice< T > >
 
struct  IsStaticString
 
struct  IsStaticString< StaticString< N > >
 
struct  IsStaticVector
 
struct  IsStaticVector< StaticVector< T, N > >
 
class  Layout
 
struct  Lossy
 Helper struct to indicate a lossy conversion, e.g. from an unbounded type into a bounded type. More...
 
class  Path
 Represents a path to a file or a directory. More...
 
class  SemanticString
 The SemanticString is a string which has an inner syntax and restrictions to valid content. Examples are for instance. More...
 
class  Slice
 A class representing a slice of contiguous elements of type T. More...
 
class  StaticString
 
class  StaticVector
 A resizable container with compile-time fixed static capacity and contiguous inplace storage. More...
 

Typedefs

template<typename T , typename E >
using Expected = iox2::bb::variation::Expected< T, E >
 
template<typename E >
using Unexpected = iox2::bb::variation::Unexpected< E >
 
using InPlaceT = iox2::bb::variation::InPlaceT
 
using UnexpectT = iox2::bb::variation::UnexpectT
 
template<typename T >
using Optional = iox2::bb::variation::Optional< T >
 
using NulloptT = iox2::bb::variation::NulloptT
 
template<typename T >
using MutableSlice = Slice< T >
 
template<typename T >
using ImmutableSlice = Slice< const T >
 
template<typename Signature , uint64_t Capacity = DEFAULT_FUNCTION_CAPACITY>
using StaticFunction = detail::StaticFunction< Capacity, Signature >
 A static memory replacement for std::function.
 
template<uint64_t Capacity>
using DoesContainInvalidCharacter = bool(*)(const StaticString< Capacity > &value)
 
template<uint64_t Capacity>
using DoesContainInvalidContent = bool(*)(const StaticString< Capacity > &value)
 
template<typename T , typename ReturnType >
using RequireStaticStringOrCharArray = typename std::enable_if_t< IsStaticString< T >::value||legacy::is_char_array< T >::value, ReturnType >
 

Enumerations

enum class  LayoutCreationError : uint8_t { InvalidAlignment }
 Defines all errors that can occur while creating a new [Layout]. More...
 
enum class  SemanticStringError : uint8_t { InvalidContent , ExceedsMaximumLength }
 Defines errors which can occur when modifying or creating a SemanticString. More...
 

Functions

template<>
constexpr auto from< int, iox2::bb::SemanticStringError > (const int value) noexcept -> iox2::bb::SemanticStringError
 
template<>
constexpr auto from< iox2::bb::SemanticStringError, iox2_semantic_string_error_e > (const iox2::bb::SemanticStringError value) noexcept -> iox2_semantic_string_error_e
 
template<>
auto from< iox2::bb::SemanticStringError, const char * > (const iox2::bb::SemanticStringError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ServiceType > (const int value) noexcept -> iox2::ServiceType
 
template<>
constexpr auto from< iox2::ServiceType, iox2_service_type_e > (const iox2::ServiceType value) noexcept -> iox2_service_type_e
 
template<>
constexpr auto from< int, iox2::NodeCreationFailure > (const int value) noexcept -> iox2::NodeCreationFailure
 
template<>
constexpr auto from< iox2::NodeCreationFailure, iox2_node_creation_failure_e > (const iox2::NodeCreationFailure value) noexcept -> iox2_node_creation_failure_e
 
template<>
auto from< iox2::NodeCreationFailure, const char * > (const iox2::NodeCreationFailure value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::CallbackProgression > (const int value) noexcept -> iox2::CallbackProgression
 
template<>
constexpr auto from< iox2::CallbackProgression, iox2_callback_progression_e > (const iox2::CallbackProgression value) noexcept -> iox2_callback_progression_e
 
template<>
constexpr auto from< int, iox2::NodeListFailure > (const int value) noexcept -> iox2::NodeListFailure
 
template<>
constexpr auto from< iox2::NodeListFailure, iox2_node_list_failure_e > (const iox2::NodeListFailure value) noexcept -> iox2_node_list_failure_e
 
template<>
auto from< iox2::NodeListFailure, const char * > (const iox2::NodeListFailure value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::NodeWaitFailure > (const int value) noexcept -> iox2::NodeWaitFailure
 
template<>
constexpr auto from< iox2::NodeWaitFailure, iox2_node_wait_failure_e > (const iox2::NodeWaitFailure value) noexcept -> iox2_node_wait_failure_e
 
template<>
auto from< iox2::NodeWaitFailure, const char * > (const iox2::NodeWaitFailure value) noexcept -> const char *
 
template<>
constexpr auto from< iox2::MessagingPattern, iox2_messaging_pattern_e > (const iox2::MessagingPattern value) noexcept -> iox2_messaging_pattern_e
 
template<>
constexpr auto from< int, iox2::ServiceDetailsError > (const int value) noexcept -> iox2::ServiceDetailsError
 
template<>
constexpr auto from< iox2::ServiceDetailsError, iox2_service_details_error_e > (const iox2::ServiceDetailsError value) noexcept -> iox2_service_details_error_e
 
template<>
auto from< iox2::ServiceDetailsError, const char * > (const iox2::ServiceDetailsError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::EventOpenOrCreateError > (const int value) noexcept -> iox2::EventOpenOrCreateError
 
template<>
constexpr auto from< iox2::EventOpenOrCreateError, iox2_event_open_or_create_error_e > (const iox2::EventOpenOrCreateError value) noexcept -> iox2_event_open_or_create_error_e
 
template<>
auto from< iox2::EventOpenOrCreateError, const char * > (const iox2::EventOpenOrCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::EventOpenError > (const int value) noexcept -> iox2::EventOpenError
 
template<>
constexpr auto from< iox2::EventOpenError, iox2_event_open_or_create_error_e > (const iox2::EventOpenError value) noexcept -> iox2_event_open_or_create_error_e
 
template<>
auto from< iox2::EventOpenError, const char * > (const iox2::EventOpenError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::EventCreateError > (const int value) noexcept -> iox2::EventCreateError
 
template<>
constexpr auto from< iox2::EventCreateError, iox2_event_open_or_create_error_e > (const iox2::EventCreateError value) noexcept -> iox2_event_open_or_create_error_e
 
template<>
auto from< iox2::EventCreateError, const char * > (const iox2::EventCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::PublishSubscribeOpenOrCreateError > (const int value) noexcept -> iox2::PublishSubscribeOpenOrCreateError
 
template<>
constexpr auto from< int, iox2::PublishSubscribeOpenError > (const int value) noexcept -> iox2::PublishSubscribeOpenError
 
template<>
constexpr auto from< iox2::PublishSubscribeOpenError, iox2_pub_sub_open_or_create_error_e > (const iox2::PublishSubscribeOpenError value) noexcept -> iox2_pub_sub_open_or_create_error_e
 
template<>
auto from< iox2::PublishSubscribeOpenError, const char * > (const iox2::PublishSubscribeOpenError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::PublishSubscribeCreateError > (const int value) noexcept -> iox2::PublishSubscribeCreateError
 
template<>
constexpr auto from< iox2::PublishSubscribeCreateError, iox2_pub_sub_open_or_create_error_e > (const iox2::PublishSubscribeCreateError value) noexcept -> iox2_pub_sub_open_or_create_error_e
 
template<>
auto from< iox2::PublishSubscribeCreateError, const char * > (const iox2::PublishSubscribeCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< iox2::PublishSubscribeOpenOrCreateError, iox2_pub_sub_open_or_create_error_e > (const iox2::PublishSubscribeOpenOrCreateError value) noexcept -> iox2_pub_sub_open_or_create_error_e
 
template<>
auto from< iox2::PublishSubscribeOpenOrCreateError, const char * > (const iox2::PublishSubscribeOpenOrCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::RequestResponseCreateError > (const int value) noexcept -> iox2::RequestResponseCreateError
 
template<>
constexpr auto from< iox2::RequestResponseCreateError, iox2_request_response_open_or_create_error_e > (const iox2::RequestResponseCreateError value) noexcept -> iox2_request_response_open_or_create_error_e
 
template<>
auto from< iox2::RequestResponseCreateError, const char * > (const iox2::RequestResponseCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::RequestResponseOpenError > (const int value) noexcept -> iox2::RequestResponseOpenError
 
template<>
constexpr auto from< iox2::RequestResponseOpenError, iox2_request_response_open_or_create_error_e > (const iox2::RequestResponseOpenError value) noexcept -> iox2_request_response_open_or_create_error_e
 
template<>
auto from< iox2::RequestResponseOpenError, const char * > (const iox2::RequestResponseOpenError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::RequestResponseOpenOrCreateError > (const int value) noexcept -> iox2::RequestResponseOpenOrCreateError
 
template<>
constexpr auto from< iox2::RequestResponseOpenOrCreateError, iox2_request_response_open_or_create_error_e > (const iox2::RequestResponseOpenOrCreateError value) noexcept -> iox2_request_response_open_or_create_error_e
 
template<>
auto from< iox2::RequestResponseOpenOrCreateError, const char * > (const iox2::RequestResponseOpenOrCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::BlackboardCreateError > (const int value) noexcept -> iox2::BlackboardCreateError
 
template<>
constexpr auto from< iox2::BlackboardCreateError, iox2_blackboard_create_error_e > (const iox2::BlackboardCreateError value) noexcept -> iox2_blackboard_create_error_e
 
template<>
auto from< iox2::BlackboardCreateError, const char * > (const iox2::BlackboardCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::BlackboardOpenError > (const int value) noexcept -> iox2::BlackboardOpenError
 
template<>
constexpr auto from< iox2::BlackboardOpenError, iox2_blackboard_open_error_e > (const iox2::BlackboardOpenError value) noexcept -> iox2_blackboard_open_error_e
 
template<>
auto from< iox2::BlackboardOpenError, const char * > (const iox2::BlackboardOpenError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::WriterCreateError > (const int value) noexcept -> iox2::WriterCreateError
 
template<>
constexpr auto from< iox2::WriterCreateError, iox2_writer_create_error_e > (const iox2::WriterCreateError value) noexcept -> iox2_writer_create_error_e
 
template<>
auto from< iox2::WriterCreateError, const char * > (const iox2::WriterCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::EntryHandleMutError > (const int value) noexcept -> iox2::EntryHandleMutError
 
template<>
constexpr auto from< iox2::EntryHandleMutError, iox2_entry_handle_mut_error_e > (const iox2::EntryHandleMutError value) noexcept -> iox2_entry_handle_mut_error_e
 
template<>
auto from< iox2::EntryHandleMutError, const char * > (const iox2::EntryHandleMutError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ReaderCreateError > (const int value) noexcept -> iox2::ReaderCreateError
 
template<>
constexpr auto from< iox2::ReaderCreateError, iox2_reader_create_error_e > (const iox2::ReaderCreateError value) noexcept -> iox2_reader_create_error_e
 
template<>
auto from< iox2::ReaderCreateError, const char * > (const iox2::ReaderCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::EntryHandleError > (const int value) noexcept -> iox2::EntryHandleError
 
template<>
constexpr auto from< iox2::EntryHandleError, iox2_entry_handle_error_e > (const iox2::EntryHandleError value) noexcept -> iox2_entry_handle_error_e
 
template<>
auto from< iox2::EntryHandleError, const char * > (const iox2::EntryHandleError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ClientCreateError > (const int value) noexcept -> iox2::ClientCreateError
 
template<>
constexpr auto from< iox2::ClientCreateError, iox2_client_create_error_e > (const iox2::ClientCreateError value) noexcept -> iox2_client_create_error_e
 
template<>
auto from< iox2::ClientCreateError, const char * > (const iox2::ClientCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ServerCreateError > (const int value) noexcept -> iox2::ServerCreateError
 
template<>
constexpr auto from< iox2::ServerCreateError, iox2_server_create_error_e > (const iox2::ServerCreateError value) noexcept -> iox2_server_create_error_e
 
template<>
auto from< iox2::ServerCreateError, const char * > (const iox2::ServerCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::NotifierCreateError > (const int value) noexcept -> iox2::NotifierCreateError
 
template<>
constexpr auto from< iox2::NotifierCreateError, iox2_notifier_create_error_e > (const iox2::NotifierCreateError value) noexcept -> iox2_notifier_create_error_e
 
template<>
auto from< iox2::NotifierCreateError, const char * > (const iox2::NotifierCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ListenerCreateError > (const int value) noexcept -> iox2::ListenerCreateError
 
template<>
constexpr auto from< iox2::ListenerCreateError, iox2_listener_create_error_e > (const iox2::ListenerCreateError value) noexcept -> iox2_listener_create_error_e
 
template<>
auto from< iox2::ListenerCreateError, const char * > (const iox2::ListenerCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::NotifierNotifyError > (const int value) noexcept -> iox2::NotifierNotifyError
 
template<>
constexpr auto from< iox2::NotifierNotifyError, iox2_notifier_notify_error_e > (const iox2::NotifierNotifyError value) noexcept -> iox2_notifier_notify_error_e
 
template<>
auto from< iox2::NotifierNotifyError, const char * > (const iox2::NotifierNotifyError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ListenerWaitError > (const int value) noexcept -> iox2::ListenerWaitError
 
template<>
constexpr auto from< iox2::ListenerWaitError, iox2_listener_wait_error_e > (const iox2::ListenerWaitError value) noexcept -> iox2_listener_wait_error_e
 
template<>
auto from< iox2::ListenerWaitError, const char * > (const iox2::ListenerWaitError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::PublisherCreateError > (const int value) noexcept -> iox2::PublisherCreateError
 
template<>
constexpr auto from< iox2::PublisherCreateError, iox2_publisher_create_error_e > (const iox2::PublisherCreateError value) noexcept -> iox2_publisher_create_error_e
 
template<>
auto from< iox2::PublisherCreateError, const char * > (const iox2::PublisherCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::SubscriberCreateError > (const int value) noexcept -> iox2::SubscriberCreateError
 
template<>
constexpr auto from< iox2::SubscriberCreateError, iox2_subscriber_create_error_e > (const iox2::SubscriberCreateError value) noexcept -> iox2_subscriber_create_error_e
 
template<>
auto from< iox2::SubscriberCreateError, const char * > (const iox2::SubscriberCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::SendError > (const int value) noexcept -> iox2::SendError
 
template<>
constexpr auto from< iox2::SendError, iox2_send_error_e > (const iox2::SendError value) noexcept -> iox2_send_error_e
 
template<>
auto from< iox2::SendError, const char * > (const iox2::SendError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ReceiveError > (const int value) noexcept -> iox2::ReceiveError
 
template<>
constexpr auto from< iox2::ReceiveError, iox2_receive_error_e > (const iox2::ReceiveError value) noexcept -> iox2_receive_error_e
 
template<>
auto from< iox2::ReceiveError, const char * > (const iox2::ReceiveError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::LoanError > (const int value) noexcept -> iox2::LoanError
 
template<>
constexpr auto from< iox2::LoanError, iox2_loan_error_e > (const iox2::LoanError value) noexcept -> iox2_loan_error_e
 
template<>
auto from< iox2::LoanError, const char * > (const iox2::LoanError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::RequestSendError > (const int value) noexcept -> iox2::RequestSendError
 
template<>
constexpr auto from< iox2::RequestSendError, iox2_request_send_error_e > (const iox2::RequestSendError value) noexcept -> iox2_request_send_error_e
 
template<>
auto from< iox2::RequestSendError, const char * > (const iox2::RequestSendError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::TypeVariant > (const int value) noexcept -> iox2::TypeVariant
 
template<>
constexpr auto from< int, iox2::ServiceListError > (const int value) noexcept -> iox2::ServiceListError
 
template<>
constexpr auto from< iox2::ServiceListError, iox2_service_list_error_e > (const iox2::ServiceListError value) noexcept -> iox2_service_list_error_e
 
template<>
auto from< iox2::ServiceListError, const char * > (const iox2::ServiceListError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::MessagingPattern > (const int value) noexcept -> iox2::MessagingPattern
 
template<>
constexpr auto from< int, iox2::BackpressureStrategy > (const int value) noexcept -> iox2::BackpressureStrategy
 
template<>
constexpr auto from< iox2::BackpressureStrategy, int > (const iox2::BackpressureStrategy value) noexcept -> int
 
template<>
constexpr auto from< int, iox2::ConnectionFailure > (const int value) noexcept -> iox2::ConnectionFailure
 
template<>
constexpr auto from< iox2::ConnectionFailure, iox2_connection_failure_e > (const iox2::ConnectionFailure value) noexcept -> iox2_connection_failure_e
 
template<>
auto from< iox2::ConnectionFailure, const char * > (const iox2::ConnectionFailure value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::ConfigCreationError > (const int value) noexcept -> iox2::ConfigCreationError
 
template<>
constexpr auto from< iox2::ConfigCreationError, iox2_config_creation_error_e > (const iox2::ConfigCreationError value) noexcept -> iox2_config_creation_error_e
 
template<>
auto from< iox2::ConfigCreationError, const char * > (const iox2::ConfigCreationError value) noexcept -> const char *
 
template<>
constexpr auto from< iox2::LogLevel, iox2_log_level_e > (iox2::LogLevel value) noexcept -> iox2_log_level_e
 
template<>
constexpr auto from< int, iox2::LogLevel > (int value) noexcept -> iox2::LogLevel
 
template<>
constexpr auto from< int, iox2::WaitSetCreateError > (const int value) noexcept -> iox2::WaitSetCreateError
 
template<>
constexpr auto from< iox2::WaitSetCreateError, iox2_waitset_create_error_e > (const iox2::WaitSetCreateError value) noexcept -> iox2_waitset_create_error_e
 
template<>
auto from< iox2::WaitSetCreateError, const char * > (const iox2::WaitSetCreateError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::WaitSetRunResult > (const int value) noexcept -> iox2::WaitSetRunResult
 
template<>
constexpr auto from< iox2::WaitSetRunResult, iox2_waitset_run_result_e > (const iox2::WaitSetRunResult value) noexcept -> iox2_waitset_run_result_e
 
template<>
constexpr auto from< int, iox2::WaitSetAttachmentError > (const int value) noexcept -> iox2::WaitSetAttachmentError
 
template<>
constexpr auto from< iox2::WaitSetAttachmentError, iox2_waitset_attachment_error_e > (const iox2::WaitSetAttachmentError value) noexcept -> iox2_waitset_attachment_error_e
 
template<>
auto from< iox2::WaitSetAttachmentError, const char * > (const iox2::WaitSetAttachmentError value) noexcept -> const char *
 
template<>
constexpr auto from< int, iox2::WaitSetRunError > (const int value) noexcept -> iox2::WaitSetRunError
 
template<>
constexpr auto from< iox2::WaitSetRunError, iox2_waitset_run_error_e > (const iox2::WaitSetRunError value) noexcept -> iox2_waitset_run_error_e
 
template<>
auto from< iox2::WaitSetRunError, const char * > (const iox2::WaitSetRunError value) noexcept -> const char *
 
template<>
constexpr auto from< iox2::SignalHandlingMode, iox2_signal_handling_mode_e > (const iox2::SignalHandlingMode value) noexcept -> iox2_signal_handling_mode_e
 
template<>
constexpr auto from< int, iox2::SignalHandlingMode > (const int value) noexcept -> iox2::SignalHandlingMode
 
template<>
constexpr auto from< iox2::AllocationStrategy, iox2_allocation_strategy_e > (const iox2::AllocationStrategy value) noexcept -> iox2_allocation_strategy_e
 
template<>
constexpr auto from< int, iox2::NodeCleanupFailure > (const int value) noexcept -> iox2::NodeCleanupFailure
 
template<>
constexpr auto from< int, iox2::AttributeVerificationError > (const int value) noexcept -> iox2::AttributeVerificationError
 
template<>
constexpr auto from< int, iox2::AttributeDefinitionError > (const int value) noexcept -> iox2::AttributeDefinitionError
 
template<>
constexpr auto from< iox2_degradation_cause_e, iox2::DegradationCause > (const iox2_degradation_cause_e value) noexcept -> iox2::DegradationCause
 
template<>
constexpr auto from< iox2::DegradationAction, iox2_degradation_action_e > (const iox2::DegradationAction value) noexcept -> iox2_degradation_action_e
 
template<>
constexpr auto from< iox2::BackpressureAction, iox2_backpressure_action_e > (const iox2::BackpressureAction value) noexcept -> iox2_backpressure_action_e
 
template<>
constexpr auto from< iox2_service_remove_error_e, iox2::ServiceRemoveError > (const iox2_service_remove_error_e value) noexcept -> iox2::ServiceRemoveError
 
template<typename T >
constexpr auto operator* (const T &lhs, const Duration &rhs) noexcept -> Duration
 creates Duration object by multiplying object T with a duration. On overflow duration will saturate to Duration::max()
 
template<typename T >
constexpr auto operator*= (T &lhs IOX2_MAYBE_UNUSED, const Duration &rhs IOX2_MAYBE_UNUSED) noexcept -> T &
 Dummy implementation with a static assert. Assigning the result of a Duration multiplication with 'operator*=' to an arithmetic type is not supported.
 
constexpr auto operator== (const Duration &lhs, const Duration &rhs) noexcept -> bool
 Equal to operator.
 
constexpr auto operator!= (const Duration &lhs, const Duration &rhs) noexcept -> bool
 Not equal to operator.
 
constexpr auto operator< (const Duration &lhs, const Duration &rhs) noexcept -> bool
 Less than operator.
 
constexpr auto operator> (const Duration &lhs, const Duration &rhs) noexcept -> bool
 Greater than operator.
 
constexpr auto operator<= (const Duration &lhs, const Duration &rhs) noexcept -> bool
 Less than or equal to operator.
 
constexpr auto operator>= (const Duration &lhs, const Duration &rhs) noexcept -> bool
 Greater than or equal to operator.
 
template<typename E >
constexpr auto err (const E &error) -> Unexpected< E >
 
template<typename E , std::enable_if_t<!std::is_lvalue_reference< E >::value, bool > = true>
constexpr auto err (E &&error) -> Unexpected< E >
 
template<typename SourceType , typename DestinationType >
constexpr auto from (const SourceType value) noexcept -> typename detail::ExtractIntoType< DestinationType >::TargetType
 Converts a value of type SourceType to a corresponding value of type DestinationType. This function needs to be specialized by the user for the types to be converted. If a partial specialization is needed, please have a look at 'From'.
 
template<typename DestinationType , typename SourceType >
constexpr auto into (const SourceType value) noexcept -> typename detail::ExtractIntoType< DestinationType >::TargetType
 Converts a value of type SourceType to a corresponding value of type DestinationType. This is a convenience function which is automatically available when 'from' is implemented. This function shall therefore not be specialized but always the 'from' function.
 

Variables

constexpr InPlaceT IN_PLACE = iox2::bb::variation::IN_PLACE
 
constexpr UnexpectT UNEXPECT = iox2::bb::variation::UNEXPECT
 
constexpr NulloptT NULLOPT = iox2::bb::variation::NULLOPT
 
constexpr uint64_t DEFAULT_FUNCTION_CAPACITY { 128U }
 

Typedef Documentation

◆ DoesContainInvalidCharacter

template<uint64_t Capacity>
using iox2::bb::DoesContainInvalidCharacter = typedef bool (*)(const StaticString<Capacity>& value)

Definition at line 32 of file static_string.hpp.

◆ DoesContainInvalidContent

template<uint64_t Capacity>
using iox2::bb::DoesContainInvalidContent = typedef bool (*)(const StaticString<Capacity>& value)

Definition at line 35 of file static_string.hpp.

◆ Expected

template<typename T , typename E >
using iox2::bb::Expected = typedef iox2::bb::variation::Expected<T, E>

Definition at line 22 of file expected.hpp.

◆ ImmutableSlice

template<typename T >
using iox2::bb::ImmutableSlice = typedef Slice<const T>

Definition at line 95 of file slice.hpp.

◆ InPlaceT

using iox2::bb::InPlaceT = typedef iox2::bb::variation::InPlaceT

Definition at line 26 of file expected.hpp.

◆ MutableSlice

template<typename T >
using iox2::bb::MutableSlice = typedef Slice<T>

Definition at line 92 of file slice.hpp.

◆ NulloptT

using iox2::bb::NulloptT = typedef iox2::bb::variation::NulloptT

Definition at line 26 of file optional.hpp.

◆ Optional

template<typename T >
using iox2::bb::Optional = typedef iox2::bb::variation::Optional<T>

Definition at line 25 of file optional.hpp.

◆ RequireStaticStringOrCharArray

template<typename T , typename ReturnType >
using iox2::bb::RequireStaticStringOrCharArray = typedef typename std::enable_if_t<IsStaticString<T>::value || legacy::is_char_array<T>::value, ReturnType>

Definition at line 64 of file static_string.hpp.

◆ StaticFunction

template<typename Signature , uint64_t Capacity = DEFAULT_FUNCTION_CAPACITY>
using iox2::bb::StaticFunction = typedef detail::StaticFunction<Capacity, Signature>

A static memory replacement for std::function.

   Allows storing a callable with a given signature if its size does not exceed a limit.
   This limit can be adjusted by changing the Bytes parameter.
   The iox2::bb::Function objects own everything needed to invoke the underlying callable and can be safely
   stored. They also support copy and move semantics in natural way by copying or moving the underlying
   callable.

   Similarly to std::function, they cannot be stored in Shared Memory to be invoked in a different process.

   For the API see 'detail::StaticFunction'.
Template Parameters
SignatureThe signature of the callable to be stored, e.g. int (char, void*).
CapacityThe static storage capacity available to store a callable in bytes.
Note
If the static storage is insufficient to store the callable we get a compile time error.

Definition at line 42 of file static_function.hpp.

◆ Unexpected

template<typename E >
using iox2::bb::Unexpected = typedef iox2::bb::variation::Unexpected<E>

Definition at line 24 of file expected.hpp.

◆ UnexpectT

using iox2::bb::UnexpectT = typedef iox2::bb::variation::UnexpectT

Definition at line 27 of file expected.hpp.

Enumeration Type Documentation

◆ LayoutCreationError

enum class iox2::bb::LayoutCreationError : uint8_t
strong

Defines all errors that can occur while creating a new [Layout].

Enumerator
InvalidAlignment 

The provided alignment was not a power of two.

Definition at line 24 of file layout.hpp.

◆ SemanticStringError

enum class iox2::bb::SemanticStringError : uint8_t
strong

Defines errors which can occur when modifying or creating a SemanticString.

Enumerator
InvalidContent 
ExceedsMaximumLength 

Definition at line 26 of file semantic_string.hpp.

Function Documentation

◆ err() [1/2]

template<typename E >
constexpr auto iox2::bb::err ( const E &  error) -> Unexpected<E>
constexpr

Definition at line 33 of file expected.hpp.

Referenced by iox2::Listener< ServiceType >::blocking_wait(), iox2::PortFactoryClient< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::create(), iox2::PortFactoryListener< S >::create(), iox2::ServiceBuilderBlackboardCreator< KeyType, S >::create(), iox2::ServiceBuilderPublishSubscribe< Payload, UserHeader, S >::create(), iox2::ServiceBuilderRequestResponse< RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader, S >::create(), iox2::PortFactoryPublisher< S, Payload, UserHeader >::create(), iox2::PortFactoryReader< S, KeyType >::create(), iox2::PortFactoryServer< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::create(), iox2::PortFactorySubscriber< S, Payload, UserHeader >::create(), iox2::PortFactoryWriter< S, KeyType >::create(), iox2::bb::Layout::create(), iox2::ServiceBuilderBlackboardCreator< KeyType, S >::create_with_attributes(), iox2::ServiceBuilderPublishSubscribe< Payload, UserHeader, S >::create_with_attributes(), iox2::ServiceBuilderRequestResponse< RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader, S >::create_with_attributes(), iox2::Reader< S, KeyType >::entry(), iox2::Writer< S, KeyType >::entry(), iox2::Server< Service, RequestPayload, RequestHeader, ResponsePayload, ResponseHeader >::has_requests(), iox2::Subscriber< S, Payload, UserHeader >::has_samples(), iox2::bb::SemanticString< Child, Capacity, DoesContainInvalidContentCall, DoesContainInvalidCharacterCall >::insert(), iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan(), iox2::ActiveRequest< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan(), iox2::Publisher< S, Payload, UserHeader >::loan(), iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_slice(), iox2::ActiveRequest< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_slice(), iox2::Publisher< S, Payload, UserHeader >::loan_slice(), iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_slice_uninit(), iox2::ActiveRequest< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_slice_uninit(), iox2::Publisher< S, Payload, UserHeader >::loan_slice_uninit(), iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_uninit(), iox2::ActiveRequest< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_uninit(), iox2::Publisher< S, Payload, UserHeader >::loan_uninit(), iox2::PortFactoryBlackboard< S, KeyType >::nodes(), iox2::PortFactoryPublishSubscribe< S, Payload, UserHeader >::nodes(), iox2::PortFactoryRequestResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::nodes(), iox2::ServiceBuilderBlackboardOpener< KeyType, S >::open(), iox2::ServiceBuilderPublishSubscribe< Payload, UserHeader, S >::open(), iox2::ServiceBuilderRequestResponse< RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader, S >::open(), iox2::ServiceBuilderPublishSubscribe< Payload, UserHeader, S >::open_or_create(), iox2::ServiceBuilderRequestResponse< RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader, S >::open_or_create(), iox2::ServiceBuilderPublishSubscribe< Payload, UserHeader, S >::open_or_create_with_attributes(), iox2::ServiceBuilderRequestResponse< RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader, S >::open_or_create_with_attributes(), iox2::ServiceBuilderBlackboardOpener< KeyType, S >::open_with_attributes(), iox2::ServiceBuilderPublishSubscribe< Payload, UserHeader, S >::open_with_attributes(), iox2::ServiceBuilderRequestResponse< RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader, S >::open_with_attributes(), iox2::Server< Service, RequestPayload, RequestHeader, ResponsePayload, ResponseHeader >::receive(), iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::receive(), iox2::Subscriber< S, Payload, UserHeader >::receive(), iox2::send(), iox2::send(), iox2::send(), iox2::Publisher< S, Payload, UserHeader >::send_copy(), iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::send_copy(), iox2::ActiveRequest< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::send_copy(), iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::send_slice_copy(), iox2::Publisher< S, Payload, UserHeader >::send_slice_copy(), iox2::ActiveRequest< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::send_slice_copy(), iox2::Listener< ServiceType >::timed_wait(), iox2::Listener< ServiceType >::try_wait(), and iox2::Publisher< S, Payload, UserHeader >::update_connections().

◆ err() [2/2]

template<typename E , std::enable_if_t<!std::is_lvalue_reference< E >::value, bool > = true>
constexpr auto iox2::bb::err ( E &&  error) -> Unexpected<E>
constexpr

Definition at line 38 of file expected.hpp.

◆ from()

template<typename SourceType , typename DestinationType >
constexpr auto iox2::bb::from ( const SourceType  value) -> typename detail::ExtractIntoType<DestinationType>::TargetType
constexprnoexcept

Converts a value of type SourceType to a corresponding value of type DestinationType. This function needs to be specialized by the user for the types to be converted. If a partial specialization is needed, please have a look at 'From'.

Note
If the conversion is potentially lossy 'Destination from<Source, Destination>(...)' should not be used but instead either one or both of:
  • 'Destination from<Source, Lossy<Destination>>(...)'
  • 'optional<Destination> from<Source, optional<Destination>>(...)' The 'Destination from<Source, Destination>(...)' implementation should have a 'static_assert' with a hint of the reason, e.g. lossy conversion and a hint to use 'Destination into<Lossy<Destination>>(...)' or 'optional<Destination> into<optional<Destination>>(...)'. The 'std_string_support.hpp' can be used as a source of inspiration for an implementation and error message.
    enum class LowLevel
    {
    FileDescriptorInvalid,
    FileDescriptorCorrupt,
    Timeout
    };
    enum class HighLevel
    {
    FileDescriptorError,
    Timeout
    };
    namespace iox
    {
    template <>
    constexpr HighLevel from<LowLevel, HighLevel>(LowLevel e) noexcept
    {
    switch (e)
    {
    case LowLevel::FileDescriptorCorrupt:
    return HighLevel::FileDescriptorError;
    case LowLevel::FileDescriptorInvalid:
    return HighLevel::FileDescriptorError;
    case LowLevel::Timeout:
    return HighLevel::Timeout;
    }
    }
    } } // namespace iox
Template Parameters
SourceTypeis the 'from' type
DestinationTypeis the 'to' type
Parameters
[in]valueof type SourceType to convert to DestinationType
Returns
converted value of SourceType to corresponding value of DestinationType

Definition at line 105 of file into.hpp.

References iox2::bb::From< SourceType, DestinationType >::from().

◆ from< int, iox2::AttributeDefinitionError >()

template<>
constexpr auto iox2::bb::from< int, iox2::AttributeDefinitionError > ( const int  value) -> iox2::AttributeDefinitionError
constexprnoexcept

Definition at line 2734 of file enum_translation.hpp.

References iox2::ExceedsMaxSupportedAttributes, and IOX2_UNREACHABLE.

◆ from< int, iox2::AttributeVerificationError >()

template<>
constexpr auto iox2::bb::from< int, iox2::AttributeVerificationError > ( const int  value) -> iox2::AttributeVerificationError
constexprnoexcept

◆ from< int, iox2::BackpressureStrategy >()

template<>
constexpr auto iox2::bb::from< int, iox2::BackpressureStrategy > ( const int  value) -> iox2::BackpressureStrategy
constexprnoexcept

◆ from< int, iox2::bb::SemanticStringError >()

template<>
constexpr auto iox2::bb::from< int, iox2::bb::SemanticStringError > ( const int  value) -> iox2::bb::SemanticStringError
constexprnoexcept

Definition at line 57 of file enum_translation.hpp.

References ExceedsMaximumLength, InvalidContent, and IOX2_UNREACHABLE.

◆ from< int, iox2::BlackboardCreateError >()

◆ from< int, iox2::BlackboardOpenError >()

◆ from< int, iox2::CallbackProgression >()

template<>
constexpr auto iox2::bb::from< int, iox2::CallbackProgression > ( const int  value) -> iox2::CallbackProgression
constexprnoexcept

Definition at line 153 of file enum_translation.hpp.

References iox2::Continue, IOX2_UNREACHABLE, and iox2::Stop.

◆ from< int, iox2::ClientCreateError >()

◆ from< int, iox2::ConfigCreationError >()

◆ from< int, iox2::ConnectionFailure >()

template<>
constexpr auto iox2::bb::from< int, iox2::ConnectionFailure > ( const int  value) -> iox2::ConnectionFailure
constexprnoexcept

◆ from< int, iox2::EntryHandleError >()

template<>
constexpr auto iox2::bb::from< int, iox2::EntryHandleError > ( const int  value) -> iox2::EntryHandleError
constexprnoexcept

Definition at line 1765 of file enum_translation.hpp.

References iox2::EntryDoesNotExist, and IOX2_UNREACHABLE.

◆ from< int, iox2::EntryHandleMutError >()

template<>
constexpr auto iox2::bb::from< int, iox2::EntryHandleMutError > ( const int  value) -> iox2::EntryHandleMutError
constexprnoexcept

◆ from< int, iox2::EventCreateError >()

◆ from< int, iox2::EventOpenError >()

◆ from< int, iox2::EventOpenOrCreateError >()

◆ from< int, iox2::ListenerCreateError >()

◆ from< int, iox2::ListenerWaitError >()

template<>
constexpr auto iox2::bb::from< int, iox2::ListenerWaitError > ( const int  value) -> iox2::ListenerWaitError
constexprnoexcept

◆ from< int, iox2::LoanError >()

template<>
constexpr auto iox2::bb::from< int, iox2::LoanError > ( const int  value) -> iox2::LoanError
constexprnoexcept

◆ from< int, iox2::LogLevel >()

template<>
constexpr auto iox2::bb::from< int, iox2::LogLevel > ( int  value) -> iox2::LogLevel
constexprnoexcept

◆ from< int, iox2::MessagingPattern >()

template<>
constexpr auto iox2::bb::from< int, iox2::MessagingPattern > ( const int  value) -> iox2::MessagingPattern
constexprnoexcept

◆ from< int, iox2::NodeCleanupFailure >()

◆ from< int, iox2::NodeCreationFailure >()

template<>
constexpr auto iox2::bb::from< int, iox2::NodeCreationFailure > ( const int  value) -> iox2::NodeCreationFailure
constexprnoexcept

◆ from< int, iox2::NodeListFailure >()

template<>
constexpr auto iox2::bb::from< int, iox2::NodeListFailure > ( const int  value) -> iox2::NodeListFailure
constexprnoexcept

◆ from< int, iox2::NodeWaitFailure >()

template<>
constexpr auto iox2::bb::from< int, iox2::NodeWaitFailure > ( const int  value) -> iox2::NodeWaitFailure
constexprnoexcept

Definition at line 215 of file enum_translation.hpp.

References iox2::Interrupt, IOX2_UNREACHABLE, and iox2::TerminationRequest.

◆ from< int, iox2::NotifierCreateError >()

◆ from< int, iox2::NotifierNotifyError >()

template<>
constexpr auto iox2::bb::from< int, iox2::NotifierNotifyError > ( const int  value) -> iox2::NotifierNotifyError
constexprnoexcept

◆ from< int, iox2::PublisherCreateError >()

◆ from< int, iox2::PublishSubscribeCreateError >()

◆ from< int, iox2::PublishSubscribeOpenError >()

◆ from< int, iox2::PublishSubscribeOpenOrCreateError >()

◆ from< int, iox2::ReaderCreateError >()

template<>
constexpr auto iox2::bb::from< int, iox2::ReaderCreateError > ( const int  value) -> iox2::ReaderCreateError
constexprnoexcept

◆ from< int, iox2::ReceiveError >()

template<>
constexpr auto iox2::bb::from< int, iox2::ReceiveError > ( const int  value) -> iox2::ReceiveError
constexprnoexcept

◆ from< int, iox2::RequestResponseCreateError >()

◆ from< int, iox2::RequestResponseOpenError >()

◆ from< int, iox2::RequestResponseOpenOrCreateError >()

template<>
constexpr auto iox2::bb::from< int, iox2::RequestResponseOpenOrCreateError > ( const int  value) -> iox2::RequestResponseOpenOrCreateError
constexprnoexcept

◆ from< int, iox2::RequestSendError >()

◆ from< int, iox2::SendError >()

◆ from< int, iox2::ServerCreateError >()

◆ from< int, iox2::ServiceDetailsError >()

◆ from< int, iox2::ServiceListError >()

template<>
constexpr auto iox2::bb::from< int, iox2::ServiceListError > ( const int  value) -> iox2::ServiceListError
constexprnoexcept

◆ from< int, iox2::ServiceType >()

template<>
constexpr auto iox2::bb::from< int, iox2::ServiceType > ( const int  value) -> iox2::ServiceType
constexprnoexcept

Definition at line 90 of file enum_translation.hpp.

References IOX2_UNREACHABLE, iox2::Ipc, and iox2::Local.

◆ from< int, iox2::SignalHandlingMode >()

template<>
constexpr auto iox2::bb::from< int, iox2::SignalHandlingMode > ( const int  value) -> iox2::SignalHandlingMode
constexprnoexcept

◆ from< int, iox2::SubscriberCreateError >()

◆ from< int, iox2::TypeVariant >()

template<>
constexpr auto iox2::bb::from< int, iox2::TypeVariant > ( const int  value) -> iox2::TypeVariant
constexprnoexcept

Definition at line 2300 of file enum_translation.hpp.

References iox2::Dynamic, iox2::FixedSize, and IOX2_UNREACHABLE.

◆ from< int, iox2::WaitSetAttachmentError >()

◆ from< int, iox2::WaitSetCreateError >()

template<>
constexpr auto iox2::bb::from< int, iox2::WaitSetCreateError > ( const int  value) -> iox2::WaitSetCreateError
constexprnoexcept

◆ from< int, iox2::WaitSetRunError >()

template<>
constexpr auto iox2::bb::from< int, iox2::WaitSetRunError > ( const int  value) -> iox2::WaitSetRunError
constexprnoexcept

◆ from< int, iox2::WaitSetRunResult >()

template<>
constexpr auto iox2::bb::from< int, iox2::WaitSetRunResult > ( const int  value) -> iox2::WaitSetRunResult
constexprnoexcept

◆ from< int, iox2::WriterCreateError >()

◆ from< iox2::AllocationStrategy, iox2_allocation_strategy_e >()

template<>
constexpr auto iox2::bb::from< iox2::AllocationStrategy, iox2_allocation_strategy_e > ( const iox2::AllocationStrategy  value) -> iox2_allocation_strategy_e
constexprnoexcept

Definition at line 2683 of file enum_translation.hpp.

References iox2::BestFit, IOX2_UNREACHABLE, iox2::PowerOfTwo, and iox2::Static.

◆ from< iox2::BackpressureAction, iox2_backpressure_action_e >()

template<>
constexpr auto iox2::bb::from< iox2::BackpressureAction, iox2_backpressure_action_e > ( const iox2::BackpressureAction  value) -> iox2_backpressure_action_e
constexprnoexcept

◆ from< iox2::BackpressureStrategy, int >()

template<>
constexpr auto iox2::bb::from< iox2::BackpressureStrategy, int > ( const iox2::BackpressureStrategy  value) -> int
constexprnoexcept

◆ from< iox2::bb::SemanticStringError, const char * >()

template<>
auto iox2::bb::from< iox2::bb::SemanticStringError, const char * > ( const iox2::bb::SemanticStringError  value) -> const char*
inlinenoexcept

Definition at line 84 of file enum_translation.hpp.

◆ from< iox2::bb::SemanticStringError, iox2_semantic_string_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::bb::SemanticStringError, iox2_semantic_string_error_e > ( const iox2::bb::SemanticStringError  value) -> iox2_semantic_string_error_e
constexprnoexcept

Definition at line 70 of file enum_translation.hpp.

References ExceedsMaximumLength, InvalidContent, and IOX2_UNREACHABLE.

◆ from< iox2::BlackboardCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::BlackboardCreateError, const char * > ( const iox2::BlackboardCreateError  value) -> const char*
inlinenoexcept

Definition at line 1567 of file enum_translation.hpp.

◆ from< iox2::BlackboardCreateError, iox2_blackboard_create_error_e >()

◆ from< iox2::BlackboardOpenError, const char * >()

template<>
auto iox2::bb::from< iox2::BlackboardOpenError, const char * > ( const iox2::BlackboardOpenError  value) -> const char*
inlinenoexcept

Definition at line 1652 of file enum_translation.hpp.

◆ from< iox2::BlackboardOpenError, iox2_blackboard_open_error_e >()

◆ from< iox2::CallbackProgression, iox2_callback_progression_e >()

template<>
constexpr auto iox2::bb::from< iox2::CallbackProgression, iox2_callback_progression_e > ( const iox2::CallbackProgression  value) -> iox2_callback_progression_e
constexprnoexcept

Definition at line 166 of file enum_translation.hpp.

References iox2::Continue, IOX2_UNREACHABLE, and iox2::Stop.

◆ from< iox2::ClientCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::ClientCreateError, const char * > ( const iox2::ClientCreateError  value) -> const char*
inlinenoexcept

Definition at line 1830 of file enum_translation.hpp.

◆ from< iox2::ClientCreateError, iox2_client_create_error_e >()

◆ from< iox2::ConfigCreationError, const char * >()

template<>
auto iox2::bb::from< iox2::ConfigCreationError, const char * > ( const iox2::ConfigCreationError  value) -> const char*
inlinenoexcept

Definition at line 2459 of file enum_translation.hpp.

◆ from< iox2::ConfigCreationError, iox2_config_creation_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::ConfigCreationError, iox2_config_creation_error_e > ( const iox2::ConfigCreationError  value) -> iox2_config_creation_error_e
constexprnoexcept

◆ from< iox2::ConnectionFailure, const char * >()

template<>
auto iox2::bb::from< iox2::ConnectionFailure, const char * > ( const iox2::ConnectionFailure  value) -> const char*
inlinenoexcept

Definition at line 2412 of file enum_translation.hpp.

◆ from< iox2::ConnectionFailure, iox2_connection_failure_e >()

template<>
constexpr auto iox2::bb::from< iox2::ConnectionFailure, iox2_connection_failure_e > ( const iox2::ConnectionFailure  value) -> iox2_connection_failure_e
constexprnoexcept

◆ from< iox2::DegradationAction, iox2_degradation_action_e >()

template<>
constexpr auto iox2::bb::from< iox2::DegradationAction, iox2_degradation_action_e > ( const iox2::DegradationAction  value) -> iox2_degradation_action_e
constexprnoexcept

◆ from< iox2::EntryHandleError, const char * >()

template<>
auto iox2::bb::from< iox2::EntryHandleError, const char * > ( const iox2::EntryHandleError  value) -> const char*
inlinenoexcept

Definition at line 1787 of file enum_translation.hpp.

◆ from< iox2::EntryHandleError, iox2_entry_handle_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::EntryHandleError, iox2_entry_handle_error_e > ( const iox2::EntryHandleError  value) -> iox2_entry_handle_error_e
constexprnoexcept

Definition at line 1776 of file enum_translation.hpp.

References iox2::EntryDoesNotExist, and IOX2_UNREACHABLE.

◆ from< iox2::EntryHandleMutError, const char * >()

template<>
auto iox2::bb::from< iox2::EntryHandleMutError, const char * > ( const iox2::EntryHandleMutError  value) -> const char*
inlinenoexcept

Definition at line 1724 of file enum_translation.hpp.

◆ from< iox2::EntryHandleMutError, iox2_entry_handle_mut_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::EntryHandleMutError, iox2_entry_handle_mut_error_e > ( const iox2::EntryHandleMutError  value) -> iox2_entry_handle_mut_error_e
constexprnoexcept

◆ from< iox2::EventCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::EventCreateError, const char * > ( const iox2::EventCreateError  value) -> const char*
inlinenoexcept

Definition at line 695 of file enum_translation.hpp.

◆ from< iox2::EventCreateError, iox2_event_open_or_create_error_e >()

◆ from< iox2::EventOpenError, const char * >()

template<>
auto iox2::bb::from< iox2::EventOpenError, const char * > ( const iox2::EventOpenError  value) -> const char*
inlinenoexcept

Definition at line 592 of file enum_translation.hpp.

◆ from< iox2::EventOpenError, iox2_event_open_or_create_error_e >()

◆ from< iox2::EventOpenOrCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::EventOpenOrCreateError, const char * > ( const iox2::EventOpenOrCreateError  value) -> const char*
inlinenoexcept

Definition at line 467 of file enum_translation.hpp.

◆ from< iox2::EventOpenOrCreateError, iox2_event_open_or_create_error_e >()

◆ from< iox2::ListenerCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::ListenerCreateError, const char * > ( const iox2::ListenerCreateError  value) -> const char*
inlinenoexcept

Definition at line 1946 of file enum_translation.hpp.

◆ from< iox2::ListenerCreateError, iox2_listener_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::ListenerCreateError, iox2_listener_create_error_e > ( const iox2::ListenerCreateError  value) -> iox2_listener_create_error_e
constexprnoexcept

◆ from< iox2::ListenerWaitError, const char * >()

template<>
auto iox2::bb::from< iox2::ListenerWaitError, const char * > ( const iox2::ListenerWaitError  value) -> const char*
inlinenoexcept

Definition at line 2019 of file enum_translation.hpp.

◆ from< iox2::ListenerWaitError, iox2_listener_wait_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::ListenerWaitError, iox2_listener_wait_error_e > ( const iox2::ListenerWaitError  value) -> iox2_listener_wait_error_e
constexprnoexcept

◆ from< iox2::LoanError, const char * >()

template<>
auto iox2::bb::from< iox2::LoanError, const char * > ( const iox2::LoanError  value) -> const char*
inlinenoexcept

Definition at line 2232 of file enum_translation.hpp.

◆ from< iox2::LoanError, iox2_loan_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::LoanError, iox2_loan_error_e > ( const iox2::LoanError  value) -> iox2_loan_error_e
constexprnoexcept

◆ from< iox2::LogLevel, iox2_log_level_e >()

template<>
constexpr auto iox2::bb::from< iox2::LogLevel, iox2_log_level_e > ( iox2::LogLevel  value) -> iox2_log_level_e
constexprnoexcept

◆ from< iox2::MessagingPattern, iox2_messaging_pattern_e >()

template<>
constexpr auto iox2::bb::from< iox2::MessagingPattern, iox2_messaging_pattern_e > ( const iox2::MessagingPattern  value) -> iox2_messaging_pattern_e
constexprnoexcept

◆ from< iox2::NodeCreationFailure, const char * >()

template<>
auto iox2::bb::from< iox2::NodeCreationFailure, const char * > ( const iox2::NodeCreationFailure  value) -> const char*
inlinenoexcept

Definition at line 147 of file enum_translation.hpp.

◆ from< iox2::NodeCreationFailure, iox2_node_creation_failure_e >()

template<>
constexpr auto iox2::bb::from< iox2::NodeCreationFailure, iox2_node_creation_failure_e > ( const iox2::NodeCreationFailure  value) -> iox2_node_creation_failure_e
constexprnoexcept

◆ from< iox2::NodeListFailure, const char * >()

template<>
auto iox2::bb::from< iox2::NodeListFailure, const char * > ( const iox2::NodeListFailure  value) -> const char*
inlinenoexcept

Definition at line 210 of file enum_translation.hpp.

◆ from< iox2::NodeListFailure, iox2_node_list_failure_e >()

template<>
constexpr auto iox2::bb::from< iox2::NodeListFailure, iox2_node_list_failure_e > ( const iox2::NodeListFailure  value) -> iox2_node_list_failure_e
constexprnoexcept

◆ from< iox2::NodeWaitFailure, const char * >()

template<>
auto iox2::bb::from< iox2::NodeWaitFailure, const char * > ( const iox2::NodeWaitFailure  value) -> const char*
inlinenoexcept

Definition at line 241 of file enum_translation.hpp.

◆ from< iox2::NodeWaitFailure, iox2_node_wait_failure_e >()

template<>
constexpr auto iox2::bb::from< iox2::NodeWaitFailure, iox2_node_wait_failure_e > ( const iox2::NodeWaitFailure  value) -> iox2_node_wait_failure_e
constexprnoexcept

Definition at line 228 of file enum_translation.hpp.

References iox2::Interrupt, IOX2_UNREACHABLE, and iox2::TerminationRequest.

◆ from< iox2::NotifierCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::NotifierCreateError, const char * > ( const iox2::NotifierCreateError  value) -> const char*
inlinenoexcept

Definition at line 1905 of file enum_translation.hpp.

◆ from< iox2::NotifierCreateError, iox2_notifier_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::NotifierCreateError, iox2_notifier_create_error_e > ( const iox2::NotifierCreateError  value) -> iox2_notifier_create_error_e
constexprnoexcept

◆ from< iox2::NotifierNotifyError, const char * >()

template<>
auto iox2::bb::from< iox2::NotifierNotifyError, const char * > ( const iox2::NotifierNotifyError  value) -> const char*
inlinenoexcept

Definition at line 1983 of file enum_translation.hpp.

◆ from< iox2::NotifierNotifyError, iox2_notifier_notify_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::NotifierNotifyError, iox2_notifier_notify_error_e > ( const iox2::NotifierNotifyError  value) -> iox2_notifier_notify_error_e
constexprnoexcept

◆ from< iox2::PublisherCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::PublisherCreateError, const char * > ( const iox2::PublisherCreateError  value) -> const char*
inlinenoexcept

Definition at line 2059 of file enum_translation.hpp.

◆ from< iox2::PublisherCreateError, iox2_publisher_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::PublisherCreateError, iox2_publisher_create_error_e > ( const iox2::PublisherCreateError  value) -> iox2_publisher_create_error_e
constexprnoexcept

◆ from< iox2::PublishSubscribeCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::PublishSubscribeCreateError, const char * > ( const iox2::PublishSubscribeCreateError  value) -> const char*
inlinenoexcept

Definition at line 1005 of file enum_translation.hpp.

◆ from< iox2::PublishSubscribeCreateError, iox2_pub_sub_open_or_create_error_e >()

◆ from< iox2::PublishSubscribeOpenError, const char * >()

template<>
auto iox2::bb::from< iox2::PublishSubscribeOpenError, const char * > ( const iox2::PublishSubscribeOpenError  value) -> const char*
inlinenoexcept

Definition at line 896 of file enum_translation.hpp.

◆ from< iox2::PublishSubscribeOpenError, iox2_pub_sub_open_or_create_error_e >()

◆ from< iox2::PublishSubscribeOpenOrCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::PublishSubscribeOpenOrCreateError, const char * > ( const iox2::PublishSubscribeOpenOrCreateError  value) -> const char*
inlinenoexcept

Definition at line 1084 of file enum_translation.hpp.

◆ from< iox2::PublishSubscribeOpenOrCreateError, iox2_pub_sub_open_or_create_error_e >()

◆ from< iox2::ReaderCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::ReaderCreateError, const char * > ( const iox2::ReaderCreateError  value) -> const char*
inlinenoexcept

Definition at line 1760 of file enum_translation.hpp.

◆ from< iox2::ReaderCreateError, iox2_reader_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::ReaderCreateError, iox2_reader_create_error_e > ( const iox2::ReaderCreateError  value) -> iox2_reader_create_error_e
constexprnoexcept

◆ from< iox2::ReceiveError, const char * >()

template<>
auto iox2::bb::from< iox2::ReceiveError, const char * > ( const iox2::ReceiveError  value) -> const char*
inlinenoexcept

Definition at line 2194 of file enum_translation.hpp.

◆ from< iox2::ReceiveError, iox2_receive_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::ReceiveError, iox2_receive_error_e > ( const iox2::ReceiveError  value) -> iox2_receive_error_e
constexprnoexcept

◆ from< iox2::RequestResponseCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::RequestResponseCreateError, const char * > ( const iox2::RequestResponseCreateError  value) -> const char*
inlinenoexcept

Definition at line 1197 of file enum_translation.hpp.

◆ from< iox2::RequestResponseCreateError, iox2_request_response_open_or_create_error_e >()

◆ from< iox2::RequestResponseOpenError, const char * >()

template<>
auto iox2::bb::from< iox2::RequestResponseOpenError, const char * > ( const iox2::RequestResponseOpenError  value) -> const char*
inlinenoexcept

Definition at line 1336 of file enum_translation.hpp.

◆ from< iox2::RequestResponseOpenError, iox2_request_response_open_or_create_error_e >()

◆ from< iox2::RequestResponseOpenOrCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::RequestResponseOpenOrCreateError, const char * > ( const iox2::RequestResponseOpenOrCreateError  value) -> const char*
inlinenoexcept

Definition at line 1500 of file enum_translation.hpp.

◆ from< iox2::RequestResponseOpenOrCreateError, iox2_request_response_open_or_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::RequestResponseOpenOrCreateError, iox2_request_response_open_or_create_error_e > ( const iox2::RequestResponseOpenOrCreateError  value) -> iox2_request_response_open_or_create_error_e
constexprnoexcept

◆ from< iox2::RequestSendError, const char * >()

template<>
auto iox2::bb::from< iox2::RequestSendError, const char * > ( const iox2::RequestSendError  value) -> const char*
inlinenoexcept

Definition at line 2295 of file enum_translation.hpp.

◆ from< iox2::RequestSendError, iox2_request_send_error_e >()

◆ from< iox2::SendError, const char * >()

template<>
auto iox2::bb::from< iox2::SendError, const char * > ( const iox2::SendError  value) -> const char*
inlinenoexcept

Definition at line 2159 of file enum_translation.hpp.

◆ from< iox2::SendError, iox2_send_error_e >()

◆ from< iox2::ServerCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::ServerCreateError, const char * > ( const iox2::ServerCreateError  value) -> const char*
inlinenoexcept

Definition at line 1869 of file enum_translation.hpp.

◆ from< iox2::ServerCreateError, iox2_server_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::ServerCreateError, iox2_server_create_error_e > ( const iox2::ServerCreateError  value) -> iox2_server_create_error_e
constexprnoexcept

◆ from< iox2::ServiceDetailsError, const char * >()

template<>
auto iox2::bb::from< iox2::ServiceDetailsError, const char * > ( const iox2::ServiceDetailsError  value) -> const char*
inlinenoexcept

Definition at line 318 of file enum_translation.hpp.

◆ from< iox2::ServiceDetailsError, iox2_service_details_error_e >()

◆ from< iox2::ServiceListError, const char * >()

template<>
auto iox2::bb::from< iox2::ServiceListError, const char * > ( const iox2::ServiceListError  value) -> const char*
inlinenoexcept

Definition at line 2339 of file enum_translation.hpp.

◆ from< iox2::ServiceListError, iox2_service_list_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::ServiceListError, iox2_service_list_error_e > ( const iox2::ServiceListError  value) -> iox2_service_list_error_e
constexprnoexcept

◆ from< iox2::ServiceType, iox2_service_type_e >()

template<>
constexpr auto iox2::bb::from< iox2::ServiceType, iox2_service_type_e > ( const iox2::ServiceType  value) -> iox2_service_type_e
constexprnoexcept

Definition at line 103 of file enum_translation.hpp.

References IOX2_UNREACHABLE, iox2::Ipc, and iox2::Local.

◆ from< iox2::SignalHandlingMode, iox2_signal_handling_mode_e >()

template<>
constexpr auto iox2::bb::from< iox2::SignalHandlingMode, iox2_signal_handling_mode_e > ( const iox2::SignalHandlingMode  value) -> iox2_signal_handling_mode_e
constexprnoexcept

◆ from< iox2::SubscriberCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::SubscriberCreateError, const char * > ( const iox2::SubscriberCreateError  value) -> const char*
inlinenoexcept

Definition at line 2100 of file enum_translation.hpp.

◆ from< iox2::SubscriberCreateError, iox2_subscriber_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::SubscriberCreateError, iox2_subscriber_create_error_e > ( const iox2::SubscriberCreateError  value) -> iox2_subscriber_create_error_e
constexprnoexcept

◆ from< iox2::WaitSetAttachmentError, const char * >()

template<>
auto iox2::bb::from< iox2::WaitSetAttachmentError, const char * > ( const iox2::WaitSetAttachmentError  value) -> const char*
inlinenoexcept

Definition at line 2606 of file enum_translation.hpp.

◆ from< iox2::WaitSetAttachmentError, iox2_waitset_attachment_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::WaitSetAttachmentError, iox2_waitset_attachment_error_e > ( const iox2::WaitSetAttachmentError  value) -> iox2_waitset_attachment_error_e
constexprnoexcept

◆ from< iox2::WaitSetCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::WaitSetCreateError, const char * > ( const iox2::WaitSetCreateError  value) -> const char*
inlinenoexcept

Definition at line 2532 of file enum_translation.hpp.

◆ from< iox2::WaitSetCreateError, iox2_waitset_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::WaitSetCreateError, iox2_waitset_create_error_e > ( const iox2::WaitSetCreateError  value) -> iox2_waitset_create_error_e
constexprnoexcept

◆ from< iox2::WaitSetRunError, const char * >()

template<>
auto iox2::bb::from< iox2::WaitSetRunError, const char * > ( const iox2::WaitSetRunError  value) -> const char*
inlinenoexcept

Definition at line 2650 of file enum_translation.hpp.

◆ from< iox2::WaitSetRunError, iox2_waitset_run_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::WaitSetRunError, iox2_waitset_run_error_e > ( const iox2::WaitSetRunError  value) -> iox2_waitset_run_error_e
constexprnoexcept

◆ from< iox2::WaitSetRunResult, iox2_waitset_run_result_e >()

template<>
constexpr auto iox2::bb::from< iox2::WaitSetRunResult, iox2_waitset_run_result_e > ( const iox2::WaitSetRunResult  value) -> iox2_waitset_run_result_e
constexprnoexcept

◆ from< iox2::WriterCreateError, const char * >()

template<>
auto iox2::bb::from< iox2::WriterCreateError, const char * > ( const iox2::WriterCreateError  value) -> const char*
inlinenoexcept

Definition at line 1692 of file enum_translation.hpp.

◆ from< iox2::WriterCreateError, iox2_writer_create_error_e >()

template<>
constexpr auto iox2::bb::from< iox2::WriterCreateError, iox2_writer_create_error_e > ( const iox2::WriterCreateError  value) -> iox2_writer_create_error_e
constexprnoexcept

◆ from< iox2_degradation_cause_e, iox2::DegradationCause >()

template<>
constexpr auto iox2::bb::from< iox2_degradation_cause_e, iox2::DegradationCause > ( const iox2_degradation_cause_e  value) -> iox2::DegradationCause
constexprnoexcept

◆ from< iox2_service_remove_error_e, iox2::ServiceRemoveError >()

template<>
constexpr auto iox2::bb::from< iox2_service_remove_error_e, iox2::ServiceRemoveError > ( const iox2_service_remove_error_e  value) -> iox2::ServiceRemoveError
constexprnoexcept

◆ into()

template<typename DestinationType , typename SourceType >
constexpr auto iox2::bb::into ( const SourceType  value) -> typename detail::ExtractIntoType<DestinationType>::TargetType
constexprnoexcept

Converts a value of type SourceType to a corresponding value of type DestinationType. This is a convenience function which is automatically available when 'from' is implemented. This function shall therefore not be specialized but always the 'from' function.

Bar b = iox2::bb::into<Bar>(Foo::ENUM_VALUE);
Template Parameters
DestinationTypeis the 'to' type
SourceTypeis the 'from' type
Parameters
[in]valueof type SourceType to convert to DestinationType
Returns
converted value of SourceType to corresponding value of DestinationType

Definition at line 120 of file into.hpp.

◆ operator!=()

constexpr auto iox2::bb::operator!= ( const Duration lhs,
const Duration rhs 
) -> bool
constexprnoexcept

Not equal to operator.

Parameters
[in]lhsis the left hand side of the comparison
[in]rhsis the right hand side of the comparison
Returns
true if duration not equal to rhs

Definition at line 349 of file duration.hpp.

◆ operator*()

template<typename T >
constexpr auto iox2::bb::operator* ( const T &  lhs,
const Duration rhs 
) -> Duration
constexprnoexcept

creates Duration object by multiplying object T with a duration. On overflow duration will saturate to Duration::max()

Template Parameters
Tis an arithmetic type for the multiplicator
Parameters
[in]lhsis the multiplicator
[in]rhsis the multiplicant
Returns
a new Duration object
Attention
Since negative durations are not allowed, the duration will be clamped to 0

Definition at line 320 of file duration.hpp.

◆ operator*=()

template<typename T >
constexpr auto iox2::bb::operator*= ( T &lhs  IOX2_MAYBE_UNUSED,
const Duration &rhs  IOX2_MAYBE_UNUSED 
) -> T&
constexprnoexcept

Dummy implementation with a static assert. Assigning the result of a Duration multiplication with 'operator*=' to an arithmetic type is not supported.

Definition at line 328 of file duration.hpp.

References iox2::legacy::always_false_v.

◆ operator<()

constexpr auto iox2::bb::operator< ( const Duration lhs,
const Duration rhs 
) -> bool
constexprnoexcept

Less than operator.

Parameters
[in]lhsis the left hand side of the comparison
[in]rhsis the right hand side of the comparison
Returns
true if duration is less than rhs

Definition at line 358 of file duration.hpp.

◆ operator<=()

constexpr auto iox2::bb::operator<= ( const Duration lhs,
const Duration rhs 
) -> bool
constexprnoexcept

Less than or equal to operator.

Parameters
[in]lhsis the left hand side of the comparison
[in]rhsis the right hand side of the comparison
Returns
true if duration is less than or equal to rhs

Definition at line 378 of file duration.hpp.

◆ operator==()

constexpr auto iox2::bb::operator== ( const Duration lhs,
const Duration rhs 
) -> bool
constexprnoexcept

Equal to operator.

Parameters
[in]lhsis the left hand side of the comparison
[in]rhsis the right hand side of the comparison
Returns
true if duration equal to rhs

Definition at line 340 of file duration.hpp.

◆ operator>()

constexpr auto iox2::bb::operator> ( const Duration lhs,
const Duration rhs 
) -> bool
constexprnoexcept

Greater than operator.

Parameters
[in]lhsis the left hand side of the comparison
[in]rhsis the right hand side of the comparison
Returns
true if duration is greater than rhs

Definition at line 368 of file duration.hpp.

◆ operator>=()

constexpr auto iox2::bb::operator>= ( const Duration lhs,
const Duration rhs 
) -> bool
constexprnoexcept

Greater than or equal to operator.

Parameters
[in]lhsis the left hand side of the comparison
[in]rhsis the right hand side of the comparison
Returns
true if duration is greater than or equal to rhs

Definition at line 387 of file duration.hpp.

Variable Documentation

◆ DEFAULT_FUNCTION_CAPACITY

constexpr uint64_t iox2::bb::DEFAULT_FUNCTION_CAPACITY { 128U }
constexpr

Definition at line 21 of file static_function.hpp.

◆ IN_PLACE

constexpr InPlaceT iox2::bb::IN_PLACE = iox2::bb::variation::IN_PLACE
constexpr

Definition at line 29 of file expected.hpp.

◆ NULLOPT

constexpr NulloptT iox2::bb::NULLOPT = iox2::bb::variation::NULLOPT
constexpr

◆ UNEXPECT

constexpr UnexpectT iox2::bb::UNEXPECT = iox2::bb::variation::UNEXPECT
constexpr

Definition at line 30 of file expected.hpp.