moveit_pro::behaviors::BoundedRetentionQueue::Pin Class Reference

RAII in-use marker for a retained entry; the entry cannot be released while any of its Pins is alive. More...

#include <bounded_retention_queue.hpp>

Public Member Functions
	Pin ()=default
	Pin (const Pin &)=delete
Pin &	operator= (const Pin &)=delete
	Pin (Pin &&other) noexcept
Pin &	operator= (Pin &&other) noexcept
	~Pin ()

Friends
class	BoundedRetentionQueue

Detailed Description

RAII in-use marker for a retained entry; the entry cannot be released while any of its Pins is alive.

Movable, not copyable. A default-constructed Pin pins nothing. Destroy (or overwrite) the Pin when done using the owner's retained data; Pins must not outlive their queue.

Constructor & Destructor Documentation

Pin() [1/3]

moveit_pro::behaviors::BoundedRetentionQueue::Pin::Pin ( )

default

Pin() [2/3]

moveit_pro::behaviors::BoundedRetentionQueue::Pin::Pin ( const Pin &  )

delete

Pin() [3/3]

moveit_pro::behaviors::BoundedRetentionQueue::Pin::Pin ( Pin &&  other )

noexcept

~Pin()

moveit_pro::behaviors::BoundedRetentionQueue::Pin::~Pin

(

)

Member Function Documentation

operator=() [1/2]

Pin & moveit_pro::behaviors::BoundedRetentionQueue::Pin::operator= ( const Pin &  )

delete

operator=() [2/2]

BoundedRetentionQueue::Pin & moveit_pro::behaviors::BoundedRetentionQueue::Pin::operator= ( Pin &&  other )

noexcept

Friends And Related Symbol Documentation

BoundedRetentionQueue

friend class BoundedRetentionQueue

friend

---

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

• bounded_retention_queue.hpp
• bounded_retention_queue.cpp