/usr/include/ola/thread/ExecutorInterface.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 | /*
* 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
*
* ExecutorInterface.h
* Copyright (C) 2011 Simon Newton
*/
#ifndef INCLUDE_OLA_THREAD_EXECUTORINTERFACE_H_
#define INCLUDE_OLA_THREAD_EXECUTORINTERFACE_H_
#include <ola/Callback.h>
namespace ola {
namespace thread {
/**
* @brief Defer execution of a \ref callbacks "callback".
*
* The executor interface provides a method to defer execution of a callback.
* Often we want to break the call stack, say if we need to run a callback that
* modify / delete a non-reentrant object in our call stack.
*/
class ExecutorInterface {
public :
ExecutorInterface() {}
virtual ~ExecutorInterface() {}
/**
* @brief Execute the supplied callback at some point in the future.
* @param callback the callback to run.
*
* This method provides the following guarantees:
* - The callback will not be run immediately.
* - The callback will be run at some point in the future. That is, the
* callback will not leak. Any remaining pending callbacks will be run
* during the destruction of the class implementing ExecutorInterface.
* - For a given thread, callbacks will be run in the order in which they
* were added.
*
* When queuing callbacks, you ether need to ensure that either:
* - The objects used in the callback outlive the ExecutorInterface
* - That the calback is run before the objects are deleted.
*
* To achieve the latter it's common to keep track of the number of
* outstanding callbacks and then call DrainCallbacks() in the destructor
* if the number of outstanding callbacks is non-0.
*/
virtual void Execute(ola::BaseCallback0<void> *callback) = 0;
/**
* @brief Run all callbacks until there are none left.
*/
virtual void DrainCallbacks() = 0;
};
} // namespace thread
} // namespace ola
#endif // INCLUDE_OLA_THREAD_EXECUTORINTERFACE_H_
|