Collage  1.2.1
High-performance C++ library for developing object-oriented distributed applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
worker.h
1 
2 /* Copyright (c) 2011-2014, Stefan Eilemann <eile@eyescale.ch>
3  *
4  * This file is part of Collage <https://github.com/Eyescale/Collage>
5  *
6  * This library is free software; you can redistribute it and/or modify it under
7  * the terms of the GNU Lesser General Public License version 2.1 as published
8  * by the Free Software Foundation.
9  *
10  * This library is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with this library; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 #ifndef CO_WORKER_H
21 #define CO_WORKER_H
22 
23 #include <co/api.h> // CO_API definition
24 #include <co/types.h>
25 #include <lunchbox/thread.h> // base class
26 #include <limits.h>
27 
28 #ifdef COLLAGE_SHARED
29 # define CO_WORKER_API CO_API
30 #else
31 # define CO_WORKER_API
32 #endif
33 
34 namespace co
35 {
37 template< class Q > class WorkerThread : public lunchbox::Thread
38 {
39 public:
41  explicit WorkerThread( const size_t maxSize = ULONG_MAX )
42  : _commands( maxSize ) {}
43 
45  virtual ~WorkerThread() {}
46 
48  Q* getWorkerQueue() { return &_commands; }
49 
50 protected:
52  CO_WORKER_API void run() override;
53 
55  virtual bool stopRunning() { return false; }
56 
58  virtual bool notifyIdle() { return false; }
59 
60 private:
62  Q _commands;
63 };
64 
65 typedef WorkerThread< CommandQueue > Worker; // instantiated in worker.cpp
66 }
67 #endif //CO_WORKER_H
Defines export visibility macros for library Collage.
CO_WORKER_API void run() override
Definition: worker.ipp:25
WorkerThread(const size_t maxSize=ULONG_MAX)
Construct a new worker thread.
Definition: worker.h:41
virtual bool stopRunning()
Definition: worker.h:55
virtual bool notifyIdle()
Definition: worker.h:58
virtual ~WorkerThread()
Destruct the worker.
Definition: worker.h:45
Q * getWorkerQueue()
Definition: worker.h:48