Open Lighting Architecture: include/ola/thread/CallbackThread.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
CallbackThread.h
1/*
2 * This library is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU Lesser General Public
4 * License as published by the Free Software Foundation; either
5 * version 2.1 of the License, or (at your option) any later version.
6 *
7 * This library is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public
13 * License along with this library; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 * CallbackThread.h
17 * A thread which executes a Callback.
18 * Copyright (C) 2013 Simon Newton
19 */
20
21#ifndef INCLUDE_OLA_THREAD_CALLBACKTHREAD_H_
22#define INCLUDE_OLA_THREAD_CALLBACKTHREAD_H_
23
24#include <ola/Callback.h>
25#include <ola/base/Macro.h>
26#include <ola/thread/Thread.h>
27
28#include <string>
29
30namespace ola {
31namespace thread {
32
36 class CallbackThread : public Thread {
37 public:
38 typedef SingleUseCallback0<void> VoidThreadCallback;
39
45 explicit CallbackThread(VoidThreadCallback *callback,
46 const Options &options = Options())
47 : Thread(options),
48 m_callback(callback) {
49 }
50
51 protected:
52 void *Run() {
53 if (m_callback) {
54 m_callback->Run();
55 }
56 return NULL;
57 }
58
59 private:
60 VoidThreadCallback *m_callback;
61
62 CallbackThread(const CallbackThread &) = delete;
63 const CallbackThread &operator=(const CallbackThread &) = delete;
64};
65} // namespace thread
66} // namespace ola
67#endif // INCLUDE_OLA_THREAD_CALLBACKTHREAD_H_
Callback.h
Macro.h
Helper macros.
ola::SingleUseCallback0
A 0 argument callback which deletes itself after it's run.
Definition Callback.h:141
ola::thread::CallbackThread
A thread which executes a Callback.
Definition CallbackThread.h:36
ola::thread::CallbackThread::CallbackThread
CallbackThread(VoidThreadCallback *callback, const Options &options=Options())
Definition CallbackThread.h:45
ola::thread::CallbackThread::Run
void * Run()
The entry point for the new thread.
Definition CallbackThread.h:52
ola::thread::Thread::Thread
Thread(const Options &options=Options())
Create a new thread with the specified thread options.
Definition Thread.cpp:75
ola::thread
Threads and synchronization mechanisms.
Definition ConsumerThread.cpp:25
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44
ola::thread::Thread::Options
Thread options.
Definition Thread.h:60