OGRE  1.9.0
OgreDefaultWorkQueueStandard.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2This source file is a part of OGRE
3(Object-oriented Graphics Rendering Engine)
4
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8Permission is hereby granted, free of charge, to any person obtaining a copy
9of this software and associated documentation files (the "Software"), to deal
10in the Software without restriction, including without limitation the rights
11to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12copies of the Software, and to permit persons to whom the Software is
13furnished to do so, subject to the following conditions:
14
15The above copyright notice and this permission notice shall be included in
16all copies or substantial portions of the Software.
17
18THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24THE SOFTWARE
25-------------------------------------------------------------------------*/
26#ifndef __OgreDefaultWorkQueueStandard_H__
27#define __OgreDefaultWorkQueueStandard_H__
28
29#include "../OgreWorkQueue.h"
30
31namespace Ogre
32{
39 {
40 public:
41
42 DefaultWorkQueue(const String& name = StringUtil::BLANK);
44
46 virtual void _threadMain();
47
49 virtual void shutdown();
50
52 virtual void startup(bool forceRestart = true);
53
54 protected:
59 virtual void waitForNextRequest();
60
62 virtual void notifyThreadRegistered();
63
64 virtual void notifyWorkers();
65
68 OGRE_MUTEX(mInitMutex);
71
72 OGRE_THREAD_SYNCHRONISER(mRequestCondition);
73#if OGRE_THREAD_SUPPORT
74 typedef vector<OGRE_THREAD_TYPE*>::type WorkerThreadList;
75 WorkerThreadList mWorkers;
76#endif
77
78 };
79
80}
81
82#endif
#define _OgreExport
Definition: OgrePlatform.h:260
Base for a general purpose request / response style background work queue.
Implementation of a general purpose request / response style background work queue.
virtual void _threadMain()
Main function for each thread spawned.
virtual void startup(bool forceRestart=true)
Start up the queue with the options that have been set.
virtual void waitForNextRequest()
To be called by a separate thread; will return immediately if there are items in the queue,...
virtual void notifyThreadRegistered()
Notify that a thread has registered itself with the render system.
OGRE_THREAD_SYNCHRONISER(mInitSync)
Synchroniser token to wait / notify on thread init.
virtual void shutdown()
Shut down the queue.
OGRE_MUTEX(mInitMutex)
Init notification mutex (must lock before waiting on initCondition)
OGRE_THREAD_SYNCHRONISER(mRequestCondition)
virtual void notifyWorkers()
Notify workers about a new request.
DefaultWorkQueue(const String &name=StringUtil::BLANK)
_StringBase String
std::vector< T, A > type