iceoryx_hoofs 2.0.5
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 NDesignPattern
 CCreationThis pattern can be used if you write an abstraction where you have to throw an exception in the constructor when you for instance would like to manage a resource and the constructor was unable to acquire that resource. In this case you inherit from Creation and your class has three more static factory methods - create, placementCreate and verify. create forwards all arguments to the underlying class constructor and if the construction was successful an expected containing the type is returned, otherwise an error value which describes the error. Additionally, this class is providing two protected member variables m_isInitialized and m_errorValue. The user always has to set m_isInitialized to true when the object construction was successful otherwise one sets it to false and write the corresponding error cause in the provided m_errorValue variable which is then returned to the user
 NioxBuilding block to easily create free function for logging in a library context
 Nconcurrent
 CLockFreeQueueImplements a lock free queue (i.e. container with FIFO order) of elements of type T with a fixed Capacity
 CResizeableLockFreeQueueImplements a lock free queue (i.e. container with FIFO order) of elements of type T with a maximum capacity MaxCapacity. The capacity can be defined to be anything between 0 and MaxCapacity at construction time or later at runtime using setCapacity. This is even possible while concurrent push and pop operations are executed, i.e. the queue does not have to be empty. Only one thread will succeed setting its desired capacity if there are more threads trying to change the capacity at the same time (it is unpredictable which thread)
 Ncxx
 Cadd_const_conditionallyConditionally add const to type T if C has the const qualifier
 Cadd_const_conditionally< T, const C >
 CBestFittingTypeGet the best fitting unsigned integer type for a given value at compile time
 CConstMethodCallback
 CconvertCollection of static methods for conversion from and to string
 CDeadlineTimerThis offers the deadline timer functionality. It has user convenient methods to reset the timer [by default it uses the intialized duration], reset timer to a customized duration, check if the timer is active and user can also get to know about the remaining time before the timer goes off
 CerrorHelper struct to create an expected which is signalling an error more easily
 Cexpected< ErrorType >Expected implementation from the C++20 proposal with C++11. The interface is inspired by the proposal but it has changes since we are not allowed to throw an exception
 Cexpected< ValueType, ErrorType >Specialization of the expected class which can contain an error as well as a success value
 Cexpected< void, ErrorType >
 Cforward_listC++11 compatible uni-directional forward list implementation
 Cfunction_ref
 Cfunction_ref< ReturnType(ArgTypes...)>Cxx::function_ref is a non-owning reference to a callable
 CGenericRAIISimple helper class to apply the C++ RAII idiom quickly. You set 2 functions, one which is called in the constructor and another function is called in the destructor which can be useful when handling resources
 Cgreater_or_equal
 Cin_place_indexHelper struct to perform an emplacement at a predefined index in the constructor of a variant
 Cin_place_tHelper struct which is used to call the in-place-construction constructor
 Cin_place_typeHelper struct to perform an emplacement of a predefined type in in the constructor of a variant
 Cis_function_pointerCheck whether T is a function pointer with arbitrary signature
 Cis_function_pointer< ReturnType(*)(ArgTypes...)>
 Cis_invocableVerifies whether the passed Callable type is in fact invocable with the given arguments
 Cis_invocable_rVerifies whether the passed Callable type is in fact invocable with the given arguments and the result of the invocation is convertible to ReturnType
 ClistC++11 compatible bi-directional list implementation
 CMethodCallback
 CNewTypeImplementation of the haskell NewType pattern: https://wiki.haskell.org/Newtype Lets say you would like to have an index which is in the end an integer but with certain restraints. The users should be forced to set it when they are creating it but afterwards it should be immutable. You would like to be able to compare the type as well as to sort it so that it can be stored in a map for instance. An example could be that you would like to have an index class with those properties and some additional methods. Then you can inherit from NewType and add your methods
 Cnot_null
 Cnullopt_tHelper struct which is used to signal an empty optional. It is equivalent to no value
 CoptionalOptional implementation from the C++17 standard with C++11. The interface is analog to the C++17 standard and it can be used in factory functions which can fail
 CPoorMansHeapReserves space on stack for placement new instatiation
 CPoorMansHeapTypeThis is a proxy which must be used for the non default PoorMansHeap ctor
 Crange
 CSerializationSimple serializer which serials every given type into the following format: (The type needs to be convertable into a string via cxx::convert::toString) LENGTH:DATALENGTH:DATA... Example: Serializes "hello", 123, 123.01 into 5:hello3:1236:123.01
 CstackStack implementation with a simple push pop interface
 CstringString implementation with some adjustments in the API, because we are not allowed to throw exceptions or use heap
 CsuccessHelper struct to create an expected which is signalling success more easily
 Csuccess< void >Helper struct to create an error only expected which is signalling success more easily
 CTruncateToCapacity_tStruct used to define a compile time variable which is used to distinguish between constructors with certain behavior
 Cunique_ptrThe unique_ptr class is a heap-less unique ptr implementation, unlike the STL
 CvariantVariant 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
 CVariantQueueWrapper of multiple fifo's
 CvectorC++11 compatible vector implementation. We needed to do some adjustments in the API since we do not use exceptions and we require a data structure which can be located fully in the shared memory
 Nlog
 CLogBin
 CLogBin16
 CLogBin32
 CLogBin64
 CLogBin8
 CLogEntry
 CLogger
 CLogHex
 CLogHex16
 CLogHex32
 CLogHex64
 CLogHex8
 CLogManager
 CLogRawBuffer
 CLogStream
 Nposix
 CCreateNamedSemaphore_t
 CCreateUnnamedSharedMemorySemaphore_t
 CCreateUnnamedSingleProcessSemaphore_t
 CFileLockPosix file lock C++ wrapping class Following RAII, the lock is acquired on creation and released on destruction. Releasing the locks works even if the process crashes with a segfault or using SIGKILL. 'lslocks' can be used to display all system-wide locks (see man page)
 CNamedPipe
 COpenNamedSemaphore_t
 CPosixCallBuilder
 CPosixCallEvaluatorClass which is created by the verificator to evaluate the result of a posix call
 CPosixCallResultResult of a posix call
 CPosixCallVerificatorClass which verifies the return value of a posix function call
 CPosixGroup
 CPosixRights
 CPosixUser
 CSemaphorePosix semaphore C++ Wrapping class
 CSignalGuardThe SignalGuard is a class returned by registerSignalHandler. When it goes out of scope it restores the previous signal action. Typical use case: One would like to override the signal action in main() or some C posix makes it necessary to override the standard signal action before and after the call
 CSignalWatcherThe SignalWatcher waits for SIGINT and SIGTERM. One can wait until the signal has occurred or ask the watcher if it has occurred
 CTimerInterface for timers on POSIX operating systems
 CErrorHandlerThis handler is needed for unit testing, special debugging cases and other corner cases where we'd like to explicitly suppress the error handling