OgreResourceBackgroundQueue.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __ResourceBackgroundQueue_H__
#define __ResourceBackgroundQueue_H__


#include "OgrePrerequisites.h"
#include "OgreCommon.h"
#include "OgreSingleton.h"
#include "OgreResource.h"
#include "OgreWorkQueue.h"

namespace Ogre {
    typedef WorkQueue::RequestID BackgroundProcessTicket;

    struct BackgroundProcessResult
    {
        bool error;
        String message;

        BackgroundProcessResult() : error(false) {}
    };

    
    class _OgreExport ResourceBackgroundQueue : public Singleton<ResourceBackgroundQueue>, public ResourceAlloc, 
        public WorkQueue::RequestHandler, public WorkQueue::ResponseHandler
    {
    public:
        class _OgreExport Listener
        {
        public:
            virtual void operationCompleted(BackgroundProcessTicket ticket, const BackgroundProcessResult& result) = 0;
            virtual ~Listener() {}

        };

    protected:

        uint16 mWorkQueueChannel;
        enum RequestType
        {
            RT_INITIALISE_GROUP = 0,
            RT_INITIALISE_ALL_GROUPS = 1,
            RT_PREPARE_GROUP = 2,
            RT_PREPARE_RESOURCE = 3,
            RT_LOAD_GROUP = 4,
            RT_LOAD_RESOURCE = 5,
            RT_UNLOAD_GROUP = 6,
            RT_UNLOAD_RESOURCE = 7
        };
        struct ResourceRequest
        {
            RequestType type;
            String resourceName;
            ResourceHandle resourceHandle;
            String resourceType;
            String groupName;
            bool isManual; 
            ManualResourceLoader* loader;
            NameValuePairList* loadParams;
            Listener* listener;
            BackgroundProcessResult result;

            _OgreExport friend std::ostream& operator<<(std::ostream& o, const ResourceRequest& r)
            { (void)r; return o; }
        };

        typedef set<BackgroundProcessTicket>::type OutstandingRequestSet;   
        OutstandingRequestSet mOutstandingRequestSet;

        struct ResourceResponse
        {
            ResourceResponse(ResourcePtr r, const ResourceRequest& req)
                : resource(r), request(req)
            {}

            ResourcePtr resource;
            ResourceRequest request;

            _OgreExport friend std::ostream& operator<<(std::ostream& o, const ResourceResponse& r)
            { (void)r; return o; }
        };

        BackgroundProcessTicket addRequest(ResourceRequest& req);

    public:
        ResourceBackgroundQueue();
        virtual ~ResourceBackgroundQueue();

        virtual void initialise(void);

        virtual void shutdown(void);

        virtual BackgroundProcessTicket initialiseResourceGroup(
            const String& name, Listener* listener = 0);

        virtual BackgroundProcessTicket initialiseAllResourceGroups( 
            Listener* listener = 0);
        virtual BackgroundProcessTicket prepareResourceGroup(const String& name, 
            Listener* listener = 0);

        virtual BackgroundProcessTicket loadResourceGroup(const String& name, 
            Listener* listener = 0);


        virtual BackgroundProcessTicket unload(
            const String& resType, const String& name, 
            Listener* listener = 0);

        virtual BackgroundProcessTicket unload(
            const String& resType, ResourceHandle handle, 
            Listener* listener = 0);

        virtual BackgroundProcessTicket unloadResourceGroup(const String& name, 
            Listener* listener = 0);


        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);

        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);
        virtual bool isProcessComplete(BackgroundProcessTicket ticket);

        void abortRequest( BackgroundProcessTicket ticket );

        bool canHandleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
        WorkQueue::Response* handleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
        bool canHandleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
        void handleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);

        static ResourceBackgroundQueue& getSingleton(void);
        static ResourceBackgroundQueue* getSingletonPtr(void);

    };

}

#endif