Classes | Public Member Functions | Private Attributes | List of all members
actionlib::DestructionGuard Class Reference

This class protects an object from being destructed until all users of that object relinquish control of it. More...

#include <destruction_guard.h>

Classes

class  ScopedProtector
 Protects a DestructionGuard until this object goes out of scope. More...
 

Public Member Functions

void destruct ()
 
 DestructionGuard ()
 Constructor for a DestructionGuard. More...
 
bool tryProtect ()
 Attempts to protect the guarded object from being destructed. More...
 
void unprotect ()
 Releases protection on the guarded object. More...
 

Private Attributes

boost::condition count_condition_
 
bool destructing_
 
boost::mutex mutex_
 
int use_count_
 

Detailed Description

This class protects an object from being destructed until all users of that object relinquish control of it.

Definition at line 49 of file destruction_guard.h.

Constructor & Destructor Documentation

actionlib::DestructionGuard::DestructionGuard ( )
inline

Constructor for a DestructionGuard.

Definition at line 55 of file destruction_guard.h.

Member Function Documentation

void actionlib::DestructionGuard::destruct ( )
inline

Definition at line 57 of file destruction_guard.h.

bool actionlib::DestructionGuard::tryProtect ( )
inline

Attempts to protect the guarded object from being destructed.

Returns
True if protection succeeded, false if protection failed

Definition at line 70 of file destruction_guard.h.

void actionlib::DestructionGuard::unprotect ( )
inline

Releases protection on the guarded object.

Definition at line 83 of file destruction_guard.h.

Member Data Documentation

boost::condition actionlib::DestructionGuard::count_condition_
private

Definition at line 134 of file destruction_guard.h.

bool actionlib::DestructionGuard::destructing_
private

Definition at line 133 of file destruction_guard.h.

boost::mutex actionlib::DestructionGuard::mutex_
private

Definition at line 131 of file destruction_guard.h.

int actionlib::DestructionGuard::use_count_
private

Definition at line 132 of file destruction_guard.h.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Wed Jun 5 2019 16:19:36