/usr/include/ola/CallbackRunner.h is in libola-dev 0.9.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | /*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* CallbackRunner.h
* Automatically execute a 0-arg callback when this object goes out of scope.
* Copyright (C) 2011 Simon Newton
*/
/**
* @defgroup callback_helpers Callback Helpers
* @brief A series a Callback helpers that simplify complex behavior.
* @note Please see CallbackRunner.h and MultiCallback.h for examples of each.
*
* @addtogroup callback_helpers
* @{
* @file CallbackRunner.h
* @brief Automatically execute a 0-arg callback when it goes out of scope.
* @examplepara
* @code
* void Foo(MyCallback *on_complete) {
* CallbackRunner runner(on_complete);
* // do work here, which may contain return statements, on_complete will
* // always be executed.
* }
* @endcode
* @}
*/
#ifndef INCLUDE_OLA_CALLBACKRUNNER_H_
#define INCLUDE_OLA_CALLBACKRUNNER_H_
#include <ola/base/Macro.h>
namespace ola {
/**
* @addtogroup callback_helpers
* @{
*/
/**
* @class CallbackRunner <ola/CallbackRunner.h>
* @brief Automatically execute a callback when it goes out of scope.
* @tparam CallbackClass An class which has a Run() method.
*
* This is useful if the function or method has multiple return points and
* you need to ensure that the callback is always executed before the function
* returns. It's most useful for handling RPCs.
*
* @examplepara
* @code
* int Foo(MyCallback *callback) {
* CallbackRunner runner(callback);
* if (...) {
* // do something here.
* return 1;
* } else {
* if (...) {
* // do something here.
* return 2;
* } else {
* // do something here.
* return 3;
* }
* }
* }
* @endcode
*/
template <typename CallbackClass>
class CallbackRunner {
public:
/**
* Construct a new CallbackRunner.
* @param callback the Callback to execute.
*/
explicit CallbackRunner(CallbackClass *callback)
: m_callback(callback) {
}
/**
* Destructor, this executes the callback.
*/
~CallbackRunner() {
m_callback->Run();
}
private:
CallbackClass *m_callback;
DISALLOW_COPY_AND_ASSIGN(CallbackRunner);
};
/**
* @}
*/
} // namespace ola
#endif // INCLUDE_OLA_CALLBACKRUNNER_H_
|