Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12345]

Niox2
Nconfig
CNode	All configurable settings of a [Node]
CService	All configurable settings of a [Service]
CGlobal	The global settings
CPublishSubscribe
CEvent
CRequestResponse
CBlackboard
CDefaults
Ninternal
CCallbackContext
CPlacementDefault
CPlacementDefault< void >
CResizableMemoryPublishSubscribe	Internal helper class to handle dynamic memory allocations used in e.g. flatbuffers
CResizableMemoryRequest	Internal helper class to handle dynamic memory allocations used in e.g. flatbuffers
CResizableMemoryResponse	Internal helper class to handle dynamic memory allocations used in e.g. flatbuffers
CHasPayloadTypeNameMember
CHasPayloadTypeNameMember< Payload, decltype((void) Payload::IOX2_TYPE_NAME)>
CHasPayloadTypeNameSpecialization
CHasPayloadTypeNameSpecialization< Payload, decltype((void) TypeNameSpecialization< Payload >::value())>
CHasMarker
CHasMarker< Required< T >, Required >
Nbb
Ndetail
CRawByteStorage
CStorageMemoryLayoutMetrics
CSourceLocation
CStaticFunction
CStaticFunction< Capacity, Signature< ReturnType, Args... > >	A static alternative of std::function which is fixed size
CExtractIntoType	Helper struct to get the actual destination type 'T' for 'into' with an additional indirection like 'into<Lossy<T>>'
CExtractIntoType< Lossy< T > >	Helper struct to get the actual destination type 'T' for 'into<Lossy<T>>'
Nstl
Ndetail
CNulloptTConstructorTag
COptionalValueHolder
CInPlaceT
CUnexpectT
CUnexpected
CExpected
COptional	A drop-in replacement for C++17 std::optional
CNulloptT	A drop-in replacement for C++17 std::nullopt_t for use with Optional
Ntesting
CTestingErrorHandler	Defines the test reaction of dynamic error handling
CErrorHandlerSetup	This class hooks into gTest to automatically resets the error handler on the start of a test
CLogPrinter	This class hooks into gTest to automatically clear the log messages on the start of a test an print the cached log messages from failed tests
CTestingLogger	This logger is used for tests. It caches all the log messages and prints them to the console when a test fails. For debug purposes this behaviour can be overwritten with the 'IOX2_TESTING_ALLOW_LOG' environment variable, e.g. 'IOX2_TESTING_ALLOW_LOG=ON ./hoofs_moduletests –gtest_filter=SharedMemoryObject_Test*'. Furthermore, it can also be used to check for the occurrence on specific log messages, e.g. when a function is expected to log an error
CStaticString
CUncheckedConstAccessor
CUncheckedAccessor
CUncheckedAccessorCodeUnits
CConstAccessorCodeUnits	This class provides the interface for accessing individual code units of the string
CDuration
CFileName	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"
CFilePath	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/"
CLossy	Helper struct to indicate a lossy conversion, e.g. from an unbounded type into a bounded type
CFrom
CLayout
CPath	Represents a path to a file or a directory
CSemanticString	The SemanticString is a string which has an inner syntax and restrictions to valid content. Examples are for instance
CSlice	A class representing a slice of contiguous elements of type T
CIsSlice
CIsSlice< Slice< T > >
CIsStaticString
CIsStaticString< StaticString< N > >
CStaticVector	A resizable container with compile-time fixed static capacity and contiguous inplace storage
CUncheckedConstAccessor
CUncheckedAccessor	Users of this class must ensure that all memory accesses stay within bounds of the accessed vector's memory
CIsStaticVector
CIsStaticVector< StaticVector< T, N > >
CFrom< std::chrono::nanoseconds, Duration >	Construct a Duration object from std::chrono::nanoseconds
CFrom< std::chrono::microseconds, Duration >	Construct a Duration object from std::chrono::microseconds
CFrom< std::chrono::milliseconds, Duration >	Construct a Duration object from std::chrono::milliseconds
CFrom< std::chrono::seconds, Duration >	Construct a Duration object from std::chrono::seconds
Nlegacy
Nconcurrent
CAtomic	A thin wrapper for a 'std::atomic' which ensures that all atomic operations are always lock-free in order to ensure safe usage across processes in shared memory. For detailed documentation please have a look at https://en.cppreference.com/w/cpp/atomic/atomic
Ndetail
CDeprecationMarker
Cok	Helper struct to create an expected which is signalling success more easily
Cok< void >	Helper struct to handle 'void' value type specialization
Cerr	Helper struct to create an expected which is signalling an error more easily
Cexpected_storage	Helper class to be able to handle 'void' value type specialization
Cexpected_storage< void, ErrorType >	Helper struct to handle 'void' value type specialization
Ccompare_expected_value	Helper struct for 'operator==' to be able to handle 'void' value type specialization
Ccompare_expected_value< void, E >	Helper struct to handle 'void' value type specialization
CDefaultHooks	Default hooks for the PolymorphicHandler
CPosixCallDetails
Ner
CConfigurationTag
CConfigurationParameters
CConfigurationParameters< ConfigurationTag >
CDefaultErrorHandler	Defines the default reaction of dynamic error handling. The default reaction is to do nothing apart from logging and termination on panic. As this is common for all error handling of the given custom implementation, this happens in the reporting API before the (polymorphic) custom behavior is invoked
CErrorDescriptor	Contains all required information about the error. Can be extended as needed without breaking the interface
CErrorHandlerInterface	Defines the dynamic error handling interface (i.e. changeable at runtime)
CRuntimeErrorKind
CFatalKind
CAssertViolationKind
CEnforceViolationKind
CIsFatal
CIsFatal< FatalKind >
CIsFatal< AssertViolationKind >
CIsFatal< EnforceViolationKind >
CErrorCode
CModuleId
CViolation
Ninternal
Cis_in_place_index
Cis_in_place_index< in_place_index< N > >
Cis_in_place_type
Cis_in_place_type< in_place_type< T > >
Cdoes_contain_type
Cdoes_contain_type< TypeToCheck, T >
Cget_index_of_type
Cget_index_of_type< N, Type, Type, Targs... >
Cget_type_at_index
Cget_type_at_index< N, N, T, Targs... >
Ccall_at_index
Ccall_at_index< N, T >
Nlog
Ninternal
CLogger	This class acts as common interface for the Logger. It provides the common functionality and inherits from the BaseLogger which is provided as template parameter. Please have a look at the design document for more details
CConsoleLogger	A minimal logger implementation which outputs the log messages to the console
CLogBuffer	Provides access to the log buffer if direct access is required
CLogHex	Helper struct to log in hexadecimal format
CLogOct	Helper struct to log in octal format
CLogBin	Helper struct to log in binary format
CLogRaw	Helper struct to log in raw bytes
CLogStream	This class provides the public interface to the logger and is used with the 'IOX2_LOG' macro. In order to add support for custom data types 'operator<<' needs to be implement for the custom type
Cconvert	Collection of static methods for conversion from and to string
Cin_place_t	Helper struct which is used to call the in-place-construction constructor
Cunexpect_t	Helper struct which is used to call the in-place-construction constructor for error types
CHoofsErrorType
Cin_place_index	Helper struct to perform an emplacement at a predefined index in the constructor of a variant
Cin_place_type	Helper struct to perform an emplacement of a predefined type in in the constructor of a variant
Cexpected	Implementation of the C++23 expected class which can contain an error or a success value
CPolymorphicHandler	Implements a singleton handler that has a default instance and can be changed to another instance at runtime. All instances have to derive from the same interface. The singleton handler owns the default instance but all other instances are created externally
CPosixCallBuilder
CPosixCallResult	Result of a posix call
CPosixCallEvaluator	Class which is created by the verificator to evaluate the result of a posix call
CPosixCallVerificator	Class which verifies the return value of a posix function call
CStaticLifetimeGuard	Manages a static instance of type T in a way so that each existing StaticLifetimeGuard prevents the destruction of the instance
Cadd_const_conditionally	Conditionally add const to type T if C has the const qualifier
Cadd_const_conditionally< T, const C >
Cis_invocable	Verifies whether the passed Callable type is in fact invocable with the given arguments
Cis_invocable_r	Verifies whether the passed Callable type is in fact invocable with the given arguments and the result of the invocation is convertible to ReturnType
Cis_function_pointer	Check whether T is a function pointer with arbitrary signature
Cis_function_pointer< ReturnType(*)(ArgTypes...)>
Cis_char_array	Struct to check whether an argument is a char array
Cis_char_array< char[N]>
Cnegation	Implementation of C++17 negation
Cbool_pack
Cconjunction	Implementation of C++17 std::conjunction
Cconjunction< Arg >
Cconjunction< Arg, Args... >
Cremove_cvref	Implementation of C++20's std::remove_cvref
CZeroedBuffer	Struct used as policy parameter in UninitializedArray to wrap an array with all elements zeroed
Celement_t
CNonZeroedBuffer	Struct used as policy parameter in UninitializedArray to wrap an uninitialized array
Celement_t
CUninitializedArray	Wrapper class for a C-style array of type ElementType and size Capacity. Per default it is uninitialized but all elements can be zeroed via template parameter ZeroedBuffer
Cvariant	Variant implementation from the C++17 standard with C++11. The interface is inspired by the C++17 standard but it has changes in get and emplace since we are not allowed to throw exceptions
CActiveRequest
CAttribute
CAttributeView
CAttributeSetView
CAttributeSet	Represents all service attributes. They can be set when the service is created
CAttributeSpecifier
CAttributeVerifier
CBackpressureInfo	The info passed to the [BackpressureHandler]
CCleanupState
CClient	Sends [RequestMut]s to a [Server] in a request-response based communication
CClientDetailsView	Contains the communication settings of the connected [Client]
CConfigView	Non-owning view of a [Config]
CConfig
CDegradationInfo	The degradation info passed to the [DegradationHandler]
CDynamicConfigBlackboard
CDynamicConfigEvent
CDynamicConfigPublishSubscribe
CDynamicConfigRequestResponse
CBlackboardValue	A wrapper for the value returned by [EntryHandle::get()]
CEntryHandle	A handle for direct read access to a specific blackboard value
CEntryHandleMut	A handle for direct write access to a specific blackboard value
CEntryValueUninit	Wrapper around an uninitialized entry value that can be used for a zero-copy update
CEventActivation
CEventId	Type that allows to identify an event uniquely
CFileDescriptorBased	Abstract class that can be implemented by a class that is based on a [FileDescriptor]
CFileDescriptorView	A view to a [FileDescriptor]
CFileDescriptor
CHeaderPublishSubscribe	Sample header used by [MessagingPattern::PublishSubscribe]
CRequestHeader	Request header used by [MessagingPattern::RequestResponse]
CResponseHeader	Response header used by [MessagingPattern::RequestResponse]
CPublisher	Sending endpoint of a publish-subscriber based communication
CListener	Represents the receiving endpoint of an event based communication
CIsListenerFdBased
CIsListenerFdBased< ServiceType::Ipc >
CIsListenerFdBased< ServiceType::Local >
CListenerDetailsView	Contains the communication settings of the connected [Listener]
CLog
CFlatbuffer	Identifies payloads that are serialized via flatbuffer
CCustomHeaderMarker	User header type for a service whose user header type details are set at runtime
CCustomPayloadMarker	Payload element for a service whose payload type details are set at runtime
CTypeDetail
CMessageTypeDetails	Contains all type information to the header and payload type
CNode
CNodeBuilder	Creates a new [Node]
CNodeDetails	Contains details of a [Node]
CNodeNameView	Non-owning view of a [NodeName]
CNodeName	Represent the name for a [Node]
CAliveNodeView	Contains all details of a [Node] that is alive
CDeadNodeView	Contains all details of a [Node] that is dead
CNodeState	Describes the state of a [Node]
CNotifier	Represents the sending endpoint of an event based communication
CNotifierDetailsView	Contains the communication settings of the connected [Notifier]
CPayloadInfo
CPayloadInfo< bb::Slice< T > >
CRequestMut
CPendingResponse
CPortFactoryBlackboard	Represents the port factory of a [Service] with [MessagingPattern::Blackboard]
CPortFactoryClient
CPortFactoryEvent	Represents the port factory of a [Service] with [MessagingPattern::Event]
CPortFactoryListener
CPortFactoryNotifier
CPortFactoryPublishSubscribe
CPortFactoryPublisher
CPortFactoryReader
CPortFactoryRequestResponse
CPortFactoryServer
CPortFactorySubscriber
CPortFactoryWriter
CPortNameView	Non-owning view of a [PortName]
CPortName	Represent the name for a [Port]
CPublisherDetailsView	Contains the communication settings of the connected [Publisher]
CReader	Reading endpoint of a blackboard based communication
CReaderDetailsView	Contains the communication settings of the connected [Reader]
CRequestMutUninit
CResponse
CResponseMut
CResponseMutUninit
CSample
CSampleMut
CSampleMutUninit
CServer
CServerDetailsView	Contains the communication settings of the connected [Server]
CService
CServiceBuilder	Builder to create or open [Service]s
CServiceBuilderBlackboardCreator	Builder to create new [MessagingPattern::Blackboard] based [Service]s
CServiceBuilderBlackboardOpener
CServiceBuilderEvent	Builder to create new [MessagingPattern::Event] based [Service]s
CServiceBuilderPublishSubscribe	Builder to create new [MessagingPattern::PublishSubscribe] based [Service]s
CServiceBuilderRequestResponse
CServiceDetails
CServiceHash	Represents the unique if of a [Service]
CServiceNameView	Non-owning view of a [ServiceName]
CServiceName	The name of a [Service]
CStaticConfig	Defines a common set of static service configuration details every service shares
CStaticConfigBlackboard
CStaticConfigEvent
CStaticConfigPublishSubscribe
CStaticConfigRequestResponse
CSubscriber	The receiving endpoint of a publish-subscribe communication
CSubscriberDetailsView	Contains the communication settings of the connected [Subscriber]
CTypeNameSpecialization
CUniqueNodeId	The system-wide unique id of a [Node]
CUniquePublisherId	The system-wide unique id of a [Publisher]
CUniqueSubscriberId	The system-wide unique id of a [Subscriber]
CUniqueNotifierId	The system-wide unique id of a [Notifier]
CUniqueListenerId	The system-wide unique id of a [Listener]
CUniqueClientId	The system-wide unique id of a [Client]
CUniqueServerId	The system-wide unique id of a [Server]
CUniqueReaderId	The system-wide unique id of a [Reader]
CUniqueWriterId	The system-wide unique id of a [Writer]
CWaitSetGuard
CWaitSetAttachmentId	Represents an attachment to the [WaitSet]
CWaitSet
CWaitSetBuilder	The builder for the [WaitSet]
CWriter	Producing endpoint of a blackboard based communication
CWriterDetailsView	Contains the communication settings of the connected [Writer]
Nstd
Chash< iox2::WaitSetAttachmentId< iox2::ServiceType::Ipc > >
Chash< iox2::WaitSetAttachmentId< iox2::ServiceType::Local > >