request.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef BACKENDS_NETWORKING_CURL_REQUEST_H
#define BACKENDS_NETWORKING_CURL_REQUEST_H

#include "common/callback.h"
#include "common/scummsys.h"
#include "common/str.h"

namespace Networking {

class Request;

template<typename T> struct Response {
    const Request *request;
    T value;

    Response(const Request *rq, T v) : request(rq), value(v) {}
};

struct ErrorResponse {
    Request *request;
    bool interrupted;
    bool failed;
    Common::String response;
    long httpResponseCode;

    ErrorResponse(Request *rq, const Common::String &resp);
    ErrorResponse(Request *rq, bool interrupt, bool failure, const Common::String &resp, long httpCode);
};

typedef Response<void *> DataResponse;
typedef Common::BaseCallback<const DataResponse &> *DataCallback;
typedef Common::BaseCallback<const ErrorResponse &> *ErrorCallback;

enum RequestState {
    PROCESSING,
    PAUSED,
    RETRY,
    FINISHED
};

class Request {
protected:
    DataCallback _callback;

    ErrorCallback _errorCallback;

    RequestState _state;

    uint32 _retryInSeconds;

    virtual void finishError(const ErrorResponse &error, RequestState state = FINISHED);

    virtual void finishSuccess();

public:
    Request(DataCallback cb, ErrorCallback ecb);
    virtual ~Request();

    virtual void handle() = 0;

    virtual void handleRetry();

    virtual void restart() = 0;

    virtual void pause();

    virtual void finish();

    virtual void retry(uint32 seconds);

    RequestState state() const;

    virtual Common::String date() const;
};

} // End of namespace Networking

#endif