The ChunkReceiver is a building block of the shared memory communication infrastructure. It extends the functionality of a ChunkQueuePopper with the abililty to pass chunks to the user side (user process). Together with the ChunkSender, they are the next abstraction layer on top of ChunkDistributor and ChunkQueuePopper. The ChunkRceiver holds the ownership of the SharedChunks and does a bookkeeping which chunks are currently passed to the user side.
More...
#include <chunk_receiver.hpp>
|
using | MemberType_t = ChunkReceiverDataType |
|
using | Base_t = ChunkQueuePopper< typename ChunkReceiverDataType::ChunkQueueData_t > |
|
using | MemberType_t = ChunkReceiverDataType::ChunkQueueData_t |
|
|
const MemberType_t * | getMembers () const noexcept |
|
MemberType_t * | getMembers () noexcept |
|
template<typename ChunkReceiverDataType>
class iox::popo::ChunkReceiver< ChunkReceiverDataType >
The ChunkReceiver is a building block of the shared memory communication infrastructure. It extends the functionality of a ChunkQueuePopper with the abililty to pass chunks to the user side (user process). Together with the ChunkSender, they are the next abstraction layer on top of ChunkDistributor and ChunkQueuePopper. The ChunkRceiver holds the ownership of the SharedChunks and does a bookkeeping which chunks are currently passed to the user side.
◆ release()
template<typename ChunkReceiverDataType >
Release a chunk that was obtained with get.
- Parameters
-
[in] | chunkHeader,pointer | to the ChunkHeader to release |
◆ tryGet()
template<typename ChunkReceiverDataType >
Tries to get the next received chunk. If there is a new one the ChunkHeader of this new chunk is received The ownerhip of the SharedChunk remains in the ChunkReceiver for being able to cleanup if the user process disappears.
- Returns
- New chunk header, ChunkReceiveResult on error or if there are no new chunks in the underlying queue
The documentation for this class was generated from the following files:
- iceoryx_posh/internal/popo/building_blocks/chunk_receiver.hpp
- iceoryx_posh/internal/popo/building_blocks/chunk_receiver.inl