OgreResourceBackgroundQueue.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __ResourceBackgroundQueue_H__
29 #define __ResourceBackgroundQueue_H__
30 
31 
32 #include "OgrePrerequisites.h"
33 #include "OgreCommon.h"
34 #include "OgreSingleton.h"
35 #include "OgreResource.h"
36 #include "OgreWorkQueue.h"
37 #include "OgreHeaderPrefix.h"
38 
39 namespace Ogre {
49 
52  {
54  bool error;
57 
59  };
60 
61 
81  class _OgreExport ResourceBackgroundQueue : public Singleton<ResourceBackgroundQueue>, public ResourceAlloc,
83  {
84  public:
94  {
95  public:
102  virtual void operationCompleted(BackgroundProcessTicket ticket, const BackgroundProcessResult& result) = 0;
104  virtual ~Listener() {}
105 
106  };
107 
108  protected:
109 
113  {
114  RT_INITIALISE_GROUP = 0,
115  RT_INITIALISE_ALL_GROUPS = 1,
116  RT_PREPARE_GROUP = 2,
117  RT_PREPARE_RESOURCE = 3,
118  RT_LOAD_GROUP = 4,
119  RT_LOAD_RESOURCE = 5,
120  RT_UNLOAD_GROUP = 6,
121  RT_UNLOAD_RESOURCE = 7
122  };
125  {
131  bool isManual;
136 
137  _OgreExport friend std::ostream& operator<<(std::ostream& o, const ResourceRequest& r)
138  { (void)r; return o; }
139  };
140 
143 
146  {
148  : resource(r), request(req)
149  {}
150 
153 
154  _OgreExport friend std::ostream& operator<<(std::ostream& o, const ResourceResponse& r)
155  { (void)r; return o; }
156  };
157 
159 
160  public:
163 
167  virtual void initialise(void);
168 
172  virtual void shutdown(void);
173 
183  const String& name, Listener* listener = 0);
184 
194  Listener* listener = 0);
204  Listener* listener = 0);
205 
215  Listener* listener = 0);
216 
217 
225  const String& resType, const String& name,
226  Listener* listener = 0);
227 
235  const String& resType, ResourceHandle handle,
236  Listener* listener = 0);
237 
245  Listener* listener = 0);
246 
247 
264  const String& resType, const String& name,
265  const String& group, bool isManual = false,
266  ManualResourceLoader* loader = 0,
267  const NameValuePairList* loadParams = 0,
268  Listener* listener = 0);
269 
286  const String& resType, const String& name,
287  const String& group, bool isManual = false,
288  ManualResourceLoader* loader = 0,
289  const NameValuePairList* loadParams = 0,
290  Listener* listener = 0);
305 
309 
311  bool canHandleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
315  bool canHandleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
317  void handleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
318 
351 
352  };
353 
357 }
358 
359 #include "OgreHeaderSuffix.h"
360 
361 #endif
362 
OgreHeaderSuffix.h
Ogre::ResourceHandle
unsigned long long int ResourceHandle
Definition: OgreResource.h:41
Ogre::ResourceBackgroundQueue::RequestType
RequestType
Enumerates the type of requests.
Definition: OgreResourceBackgroundQueue.h:113
Ogre::ResourceBackgroundQueue::handleRequest
WorkQueue::Response * handleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
Implementation for WorkQueue::RequestHandler.
Ogre::ResourceBackgroundQueue::Listener::~Listener
virtual ~Listener()
Need virtual destructor in case subclasses use it.
Definition: OgreResourceBackgroundQueue.h:104
Ogre::WorkQueue
Interface to a general purpose request / response style background work queue.
Definition: OgreWorkQueue.h:71
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre::WorkQueue::Request
General purpose request structure.
Definition: OgreWorkQueue.h:84
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::ResourceBackgroundQueue::~ResourceBackgroundQueue
virtual ~ResourceBackgroundQueue()
Ogre::ResourceBackgroundQueue::Listener
This abstract listener interface lets you get notifications of completed background processes instead...
Definition: OgreResourceBackgroundQueue.h:94
OgreSingleton.h
Ogre::ResourceBackgroundQueue::ResourceRequest::groupName
String groupName
Definition: OgreResourceBackgroundQueue.h:130
Ogre::ResourceBackgroundQueue::ResourceRequest::resourceName
String resourceName
Definition: OgreResourceBackgroundQueue.h:127
Ogre::ResourceBackgroundQueue::mOutstandingRequestSet
OutstandingRequestSet mOutstandingRequestSet
Definition: OgreResourceBackgroundQueue.h:142
Ogre::set
Definition: OgrePrerequisites.h:520
Ogre::ResourceBackgroundQueue
This class is used to perform Resource operations in a background thread.
Definition: OgreResourceBackgroundQueue.h:83
Ogre::ResourceBackgroundQueue::mWorkQueueChannel
uint16 mWorkQueueChannel
Definition: OgreResourceBackgroundQueue.h:110
Ogre::ResourceBackgroundQueue::shutdown
virtual void shutdown(void)
Shut down the background queue system.
Ogre::ResourceBackgroundQueue::getSingletonPtr
static ResourceBackgroundQueue * getSingletonPtr(void)
Override standard Singleton retrieval.
Ogre::ResourceBackgroundQueue::ResourceResponse::operator<<
_OgreExport friend std::ostream & operator<<(std::ostream &o, const ResourceResponse &r)
Definition: OgreResourceBackgroundQueue.h:154
Ogre::ResourceBackgroundQueue::ResourceRequest::operator<<
_OgreExport friend std::ostream & operator<<(std::ostream &o, const ResourceRequest &r)
Definition: OgreResourceBackgroundQueue.h:137
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360
Ogre::WorkQueue::Response
General purpose response structure.
Definition: OgreWorkQueue.h:123
Ogre::ResourceBackgroundQueue::initialiseResourceGroup
virtual BackgroundProcessTicket initialiseResourceGroup(const String &name, Listener *listener=0)
Initialise a resource group in the background.
Ogre::WorkQueue::RequestID
unsigned long long int RequestID
Numeric identifier for a request.
Definition: OgreWorkQueue.h:79
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::ResourceBackgroundQueue::ResourceResponse::resource
ResourcePtr resource
Definition: OgreResourceBackgroundQueue.h:151
Ogre::NameValuePairList
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
Ogre::ResourceBackgroundQueue::ResourceResponse
Struct that holds details of queued notifications.
Definition: OgreResourceBackgroundQueue.h:146
Ogre::ResourceBackgroundQueue::unload
virtual BackgroundProcessTicket unload(const String &resType, ResourceHandle handle, Listener *listener=0)
Unload a single resource in the background.
Ogre::ResourceBackgroundQueue::unloadResourceGroup
virtual BackgroundProcessTicket unloadResourceGroup(const String &name, Listener *listener=0)
Unloads a resource group in the background.
Ogre::ResourceBackgroundQueue::ResourceRequest
Encapsulates a queued request for the background queue.
Definition: OgreResourceBackgroundQueue.h:125
Ogre::ResourceBackgroundQueue::initialise
virtual void initialise(void)
Initialise the background queue system.
Ogre::ResourceBackgroundQueue::prepare
virtual BackgroundProcessTicket prepare(const String &resType, const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, Listener *listener=0)
Prepare a single resource in the background.
Ogre::ResourceBackgroundQueue::canHandleRequest
bool canHandleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
Implementation for WorkQueue::RequestHandler.
OgreHeaderPrefix.h
Ogre::ResourceBackgroundQueue::ResourceRequest::loader
ManualResourceLoader * loader
Definition: OgreResourceBackgroundQueue.h:132
Ogre::ResourceBackgroundQueue::ResourceRequest::isManual
bool isManual
Definition: OgreResourceBackgroundQueue.h:131
OgrePrerequisites.h
Ogre::WorkQueue::ResponseHandler
Interface definition for a handler of responses.
Definition: OgreWorkQueue.h:197
Ogre::Singleton
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:65
OgreResource.h
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::ResourceBackgroundQueue::abortRequest
void abortRequest(BackgroundProcessTicket ticket)
Aborts background process.
OgreCommon.h
Ogre::ResourceBackgroundQueue::load
virtual BackgroundProcessTicket load(const String &resType, const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, Listener *listener=0)
Load a single resource in the background.
Ogre::ResourceBackgroundQueue::ResourceRequest::type
RequestType type
Definition: OgreResourceBackgroundQueue.h:126
Ogre::ResourceBackgroundQueue::getSingleton
static ResourceBackgroundQueue & getSingleton(void)
Override standard Singleton retrieval.
Ogre::ResourceBackgroundQueue::ResourceRequest::listener
Listener * listener
Definition: OgreResourceBackgroundQueue.h:134
Ogre::ResourceBackgroundQueue::ResourceRequest::result
BackgroundProcessResult result
Definition: OgreResourceBackgroundQueue.h:135
Ogre::SharedPtr< Resource >
Ogre::BackgroundProcessResult::error
bool error
Whether an error occurred.
Definition: OgreResourceBackgroundQueue.h:54
Ogre::ResourceBackgroundQueue::loadResourceGroup
virtual BackgroundProcessTicket loadResourceGroup(const String &name, Listener *listener=0)
Loads a resource group in the background.
Ogre::ResourceBackgroundQueue::ResourceRequest::loadParams
NameValuePairList * loadParams
Definition: OgreResourceBackgroundQueue.h:133
Ogre::ResourceBackgroundQueue::ResourceRequest::resourceHandle
ResourceHandle resourceHandle
Definition: OgreResourceBackgroundQueue.h:128
OgreWorkQueue.h
Ogre::ResourceBackgroundQueue::handleResponse
void handleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
Implementation for WorkQueue::ResponseHandler.
Ogre::BackgroundProcessResult::message
String message
Any messages from the process.
Definition: OgreResourceBackgroundQueue.h:56
Ogre::ResourceBackgroundQueue::Listener::operationCompleted
virtual void operationCompleted(BackgroundProcessTicket ticket, const BackgroundProcessResult &result)=0
Called when a requested operation completes, queued into main thread.
Ogre::BackgroundProcessResult
Encapsulates the result of a background queue request.
Definition: OgreResourceBackgroundQueue.h:52
Ogre::ResourceBackgroundQueue::isProcessComplete
virtual bool isProcessComplete(BackgroundProcessTicket ticket)
Returns whether a previously queued process has completed or not.
Ogre::ResourceBackgroundQueue::ResourceResponse::ResourceResponse
ResourceResponse(ResourcePtr r, const ResourceRequest &req)
Definition: OgreResourceBackgroundQueue.h:147
Ogre::BackgroundProcessTicket
WorkQueue::RequestID BackgroundProcessTicket
Identifier of a background process.
Definition: OgreResourceBackgroundQueue.h:48
Ogre::ResourceBackgroundQueue::ResourceBackgroundQueue
ResourceBackgroundQueue()
Ogre::WorkQueue::RequestHandler
Interface definition for a handler of requests.
Definition: OgreWorkQueue.h:162
Ogre::ResourceBackgroundQueue::initialiseAllResourceGroups
virtual BackgroundProcessTicket initialiseAllResourceGroups(Listener *listener=0)
Initialise all resource groups which are yet to be initialised in the background.
Ogre::ResourceBackgroundQueue::OutstandingRequestSet
set< BackgroundProcessTicket >::type OutstandingRequestSet
Definition: OgreResourceBackgroundQueue.h:141
Ogre::BackgroundProcessResult::BackgroundProcessResult
BackgroundProcessResult()
Definition: OgreResourceBackgroundQueue.h:58
Ogre::ManualResourceLoader
Interface describing a manual resource loader.
Definition: OgreResource.h:515
Ogre::ResourceBackgroundQueue::addRequest
BackgroundProcessTicket addRequest(ResourceRequest &req)
Ogre::ResourceBackgroundQueue::canHandleResponse
bool canHandleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
Implementation for WorkQueue::ResponseHandler.
Ogre::ResourceBackgroundQueue::prepareResourceGroup
virtual BackgroundProcessTicket prepareResourceGroup(const String &name, Listener *listener=0)
Prepares a resource group in the background.
Ogre::ResourceBackgroundQueue::ResourceRequest::resourceType
String resourceType
Definition: OgreResourceBackgroundQueue.h:129
Ogre::ResourceBackgroundQueue::ResourceResponse::request
ResourceRequest request
Definition: OgreResourceBackgroundQueue.h:152
Ogre::ResourceBackgroundQueue::unload
virtual BackgroundProcessTicket unload(const String &resType, const String &name, Listener *listener=0)
Unload a single resource in the background.

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.