iceoryx_doc  1.0.1
Public Member Functions | List of all members
iox::popo::SampleDeleter< Port > Struct Template Reference

The SampleDeleter struct is a custom deleter in functor form which releases loans to a sample's underlying memory chunk via the corresponding port.. Each port should create its own instance of this deleter struct. More...

#include <sample_deleter.hpp>

Public Member Functions

 SampleDeleter (Port &port)
 
template<typename T >
void operator() (T *const userPayload)
 Handles deletion of the sample. More...
 
template<typename T >
void operator() (const T *const userPayload) const
 Handles deletion of the sample. More...
 

Detailed Description

template<typename Port>
struct iox::popo::SampleDeleter< Port >

The SampleDeleter struct is a custom deleter in functor form which releases loans to a sample's underlying memory chunk via the corresponding port.. Each port should create its own instance of this deleter struct.

Member Function Documentation

◆ operator()() [1/2]

template<typename Port >
template<typename T >
void iox::popo::SampleDeleter< Port >::operator() ( const T *const  userPayload) const

Handles deletion of the sample.

Parameters
[in]userPayloadThe pointer to the user-payload of the sample.

◆ operator()() [2/2]

template<typename Port >
template<typename T >
void iox::popo::SampleDeleter< Port >::operator() ( T *const  userPayload)

Handles deletion of the sample.

Parameters
[in]userPayloadThe pointer to the user-payload of the sample.

The documentation for this struct was generated from the following files: