requestHandler.h

/* Copyright (c) 2005-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef LUNCHBOX_REQUESTHANDLER_H
#define LUNCHBOX_REQUESTHANDLER_H

#include <lunchbox/api.h>    // LUNCHBOX_API definition
#include <lunchbox/thread.h> // thread-safety macros
#include <lunchbox/types.h>
#include <servus/uint128_t.h>

namespace lunchbox
{
namespace detail
{
class RequestHandler;
}

class RequestHandler : public boost::noncopyable
{
public:
    LUNCHBOX_API RequestHandler();

    LUNCHBOX_API ~RequestHandler();

    template <class T>
    Request<T> registerRequest(void* data = 0);

    uint32_t registerRequest(void* data = 0) { return _register(data); }
    LUNCHBOX_API void unregisterRequest(const uint32_t requestID);

    LUNCHBOX_API bool waitRequest(
        const uint32_t requestID, void*& result,
        const uint32_t timeout = LB_TIMEOUT_INDEFINITE);

    LUNCHBOX_API bool waitRequest(
        const uint32_t requestID, uint32_t& result,
        const uint32_t timeout = LB_TIMEOUT_INDEFINITE);
    LUNCHBOX_API bool waitRequest(
        const uint32_t requestID, bool& result,
        const uint32_t timeout = LB_TIMEOUT_INDEFINITE);
    LUNCHBOX_API bool waitRequest(
        const uint32_t requestID, servus::uint128_t& result,
        const uint32_t timeout = LB_TIMEOUT_INDEFINITE);
    LUNCHBOX_API bool waitRequest(const uint32_t requestID);

    LUNCHBOX_API void* getRequestData(const uint32_t requestID);

    LUNCHBOX_API void serveRequest(const uint32_t requestID, void* result = 0);
    LUNCHBOX_API void serveRequest(const uint32_t requestID, uint32_t result);
    LUNCHBOX_API void serveRequest(const uint32_t requestID, bool result);
    LUNCHBOX_API void serveRequest(const uint32_t requestID,
                                   const servus::uint128_t& result);
    LUNCHBOX_API bool hasPendingRequests() const;

    LUNCHBOX_API bool isRequestReady(const uint32_t) const; 

private:
    detail::RequestHandler* const _impl;

    LUNCHBOX_API uint32_t _register(void* data);
    LB_TS_VAR(_thread);
};
}

#include <lunchbox/request.h>

namespace lunchbox
{
template <class T>
inline Request<T> RequestHandler::registerRequest(void* data)
{
    return Request<T>(*this, _register(data));
}
}

#endif // LUNCHBOX_REQUESTHANDLER_H