MySQL 9.1.0
Source Code Documentation
sentry.h
Go to the documentation of this file.
1/* Copyright (c) 2020, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef CONTAINER_SENTRY_INCLUDED
25#define CONTAINER_SENTRY_INCLUDED
26
27#include <functional>
28
29namespace raii {
30/**
31 Generic sentry class that invokes some callable object of type F upon disposal
32 of an instance of this class.
33
34 Check C++ documentation for the definition of `Callable` named requirement for
35 more information.
36 */
37template <typename F = std::function<void()>>
38class Sentry {
39 public:
40 /**
41 Constructor for the class that stores the callable object passed as
42 argument, to be invoked upon disposal of the object.
43
44 @param dispose The callable object to be invoked upon disposal of the
45 object.
46 */
47 Sentry(F dispose);
48 /**
49 Destructor for the class. It will call the stored callable.
50 */
51 virtual ~Sentry();
52
53 private:
54 /** The callable to be invoked upon disposal of the object. */
56};
57} // namespace raii
58
59template <typename F>
60raii::Sentry<F>::Sentry(F dispose) : m_dispose{dispose} {}
61
62template <typename F>
64 this->m_dispose();
65}
66
67#endif // CONTAINER_SENTRY_INCLUDED
Generic sentry class that invokes some callable object of type F upon disposal of an instance of this...
Definition: sentry.h:38
virtual ~Sentry()
Destructor for the class.
Definition: sentry.h:63
Sentry(F dispose)
Constructor for the class that stores the callable object passed as argument, to be invoked upon disp...
Definition: sentry.h:60
F m_dispose
The callable to be invoked upon disposal of the object.
Definition: sentry.h:55
Definition: sentry.h:29