The GenericMemoryBlock is an implementation of a MemoryBlock for a common use case. More...
#include <generic_memory_block.hpp>
Inheritance diagram for iox::roudi::GenericMemoryBlock< T >:
Collaboration diagram for iox::roudi::GenericMemoryBlock< T >:
Public Member Functions | |
| GenericMemoryBlock (const GenericMemoryBlock &)=delete | |
| GenericMemoryBlock (GenericMemoryBlock &&)=delete | |
| GenericMemoryBlock & | operator= (const GenericMemoryBlock &)=delete |
| GenericMemoryBlock & | operator= (GenericMemoryBlock &&)=delete |
| uint64_t | size () const noexcept override |
| Implementation of MemoryBlock::size. More... | |
| uint64_t | alignment () const noexcept override |
| Implementation of MemoryBlock::alignment. More... | |
| void | destroy () noexcept override |
| Implementation of MemoryBlock::destroy. | |
| template<typename... Targs> | |
| cxx::optional< T * > | emplace (Targs &&... args) noexcept |
| A new element is constructed by forwarding the arguments to the constructor of T. If the MemoryBlock has a value then the destructor of T is called. More... | |
| cxx::optional< T * > | value () const noexcept |
| This function enables the access to the underlying type. More... | |
 Public Member Functions inherited from iox::roudi::MemoryBlock | |
| MemoryBlock (const MemoryBlock &)=delete | |
| MemoryBlock (MemoryBlock &&)=delete | |
| MemoryBlock & | operator= (const MemoryBlock &)=delete |
| MemoryBlock & | operator= (MemoryBlock &&)=delete |
| virtual void | memoryAvailable (void *memory) noexcept |
| This function is called once the memory is available and is therefore the earliest possibility to use the memory. More... | |
| cxx::optional< void * > | memory () const noexcept |
| This function provides the pointer to the requested memory. More... | |
Friends | |
| class | MemoryProvider |
Detailed Description
template<typename T>
class iox::roudi::GenericMemoryBlock< T >
The GenericMemoryBlock is an implementation of a MemoryBlock for a common use case.
Member Function Documentation
◆ alignment()
template<typename T >
|
overridevirtualnoexcept |
Implementation of MemoryBlock::alignment.
- Returns
- the alignment of type T
Implements iox::roudi::MemoryBlock.
◆ emplace()
template<typename T >
template<typename... Targs>
|
noexcept |
A new element is constructed by forwarding the arguments to the constructor of T. If the MemoryBlock has a value then the destructor of T is called.
- Parameters
-
[in] args are perfectly forwarded to the constructor of T to perform a placement new
- Returns
- an optional pointer to the underlying type, cxx::nullopt_t if memory was not yet available
◆ size()
template<typename T >
|
overridevirtualnoexcept |
◆ value()
template<typename T >
|
noexcept |
This function enables the access to the underlying type.
- Returns
- an optional pointer to the underlying type, cxx::nullopt_t if value is not initialized
The documentation for this class was generated from the following files:
- iceoryx_posh/roudi/memory/generic_memory_block.hpp
- iceoryx_posh/internal/roudi/memory/generic_memory_block.inl
