requests.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef EVENTS_REQUESTS_H
#define EVENTS_REQUESTS_H

#include <list>

#include <boost/bind.hpp>

#include "src/common/types.h"
#include "src/common/ptrlist.h"
#include "src/common/singleton.h"
#include "src/common/thread.h"

#include "src/graphics/types.h"

#include "src/events/requesttypes.h"

namespace Graphics {
    class Texture;
}

namespace Events {

typedef Common::PtrList<Request>  RequestList;
typedef RequestList::iterator RequestID;

class RequestManager : public Common::Singleton<RequestManager>, public Common::Thread {
public:
    ~RequestManager();

    void init();
    void deinit();

    void dispatch(RequestID request);
    void waitReply(RequestID request);
    void forget(RequestID request);

    void dispatchAndWait(RequestID request);
    void dispatchAndForget(RequestID request);

    void sync();

    template<typename T> T callInMainThread(const MainThreadFunctor<T> &f) {
        MainThreadCallerFunctor caller(boost::bind(&MainThreadFunctor<T>::operator(), f));

        callInMainThread(caller);
        if (!f.getError().empty()) {
            throw Common::Exception(f.getError());
        }

        return f.getReturnValue();
    }

    RequestID rebuild(Graphics::GLContainer &glContainer);
    RequestID destroy(Graphics::GLContainer &glContainer);

    // Singleton
    static void destroy();

private:
    Common::Mutex _mutexUse; 

    RequestList _requests; 

    RequestID newRequest(ITCEvent type);

    void clearList();

    void collectGarbage();

    void threadMethod();

    void callInMainThread(const MainThreadCallerFunctor &caller);
};

} // End of namespace Events

#define RequestMan Events::RequestManager::instance()

#endif // EVENTS_REQUESTS_H