destruction_guard.h
Go to the documentation of this file.
1 /*********************************************************************
2 *
3 * Software License Agreement (BSD License)
4 *
5 * Copyright (c) 2009, Willow Garage, Inc.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials provided
17 * with the distribution.
18 * * Neither the name of Willow Garage, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 *
35 * Author: Eitan Marder-Eppstein
36 *********************************************************************/
37 #ifndef ACTIONLIB__DESTRUCTION_GUARD_H_
38 #define ACTIONLIB__DESTRUCTION_GUARD_H_
39 
40 #include <boost/thread/condition.hpp>
41 #include <boost/thread/mutex.hpp>
42 
43 namespace actionlib
44 {
50 {
51 public:
56  : use_count_(0), destructing_(false) {}
57  void destruct()
58  {
59  boost::mutex::scoped_lock lock(mutex_);
60  destructing_ = true;
61  while (use_count_ > 0) {
62  count_condition_.timed_wait(lock, boost::posix_time::milliseconds(1000));
63  }
64  }
65 
70  bool tryProtect()
71  {
72  boost::mutex::scoped_lock lock(mutex_);
73  if (destructing_) {
74  return false;
75  }
76  use_count_++;
77  return true;
78  }
79 
83  void unprotect()
84  {
85  boost::mutex::scoped_lock lock(mutex_);
86  use_count_--;
87  }
88 
94  {
95 public:
101  : guard_(guard), protected_(false)
102  {
104  }
105 
110  bool isProtected()
111  {
112  return protected_;
113  }
114 
119  {
120  if (protected_) {
121  guard_.unprotect();
122  }
123  }
124 
125 private:
128  };
129 
130 private:
131  boost::mutex mutex_;
134  boost::condition count_condition_;
135 };
136 
137 } // namespace actionlib
138 #endif // ACTIONLIB__DESTRUCTION_GUARD_H_
ScopedProtector(DestructionGuard &guard)
Constructor for a ScopedProtector.
bool isProtected()
Checks if the ScopedProtector successfully protected the DestructionGuard.
~ScopedProtector()
Releases protection of the DestructionGuard if necessary.
bool tryProtect()
Attempts to protect the guarded object from being destructed.
This class protects an object from being destructed until all users of that object relinquish control...
void unprotect()
Releases protection on the guarded object.
DestructionGuard()
Constructor for a DestructionGuard.
Protects a DestructionGuard until this object goes out of scope.


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Tue Sep 3 2019 03:41:41