thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
scummvm/backends/networking/curl/sessionrequest.h

74 lines
2.2 KiB
C
Raw Permalink Normal View History

NETWORKING: Enter SessionRequest It is to be used in a Session, though it might be used separately. It must implement keep-alive, but it does not yet. You must not put it to ConnMan by yourself (instead, use start()) and you must call close() after you've finished using this request. You can either work with it in callback, or wait() and simply use its methods (check it's success() and then, for example, use text()). Like this: ``` Networking::SessionRequest *rq = new Networking::SessionRequest(url); rq->startAndWait(); if (rq->success()) warning("HTTP GET: %s", rq->text()); rq->close(); ```
2019-11-02 05:10:41 +07:00
/* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef BACKENDS_NETWORKING_CURL_SESSIONREQUEST_H
#define BACKENDS_NETWORKING_CURL_SESSIONREQUEST_H
#include "backends/networking/curl/curlrequest.h"
#include "common/memstream.h"
#include "common/json.h"
namespace Networking {
#define CURL_SESSION_REQUEST_BUFFER_SIZE 512 * 1024
class SessionRequest: public CurlRequest {
protected:
Common::MemoryWriteStreamDynamic _contentsStream;
byte *_buffer;
char *_text;
bool _started, _complete, _success;
NETWORKING: Enter Session Session allows to reuse SessionRequests to the same host by making them keeping alive connection. Turns out, though, that libcurl already does that for us, and we didn't gain any speedup we thought we'd get. Usage: ``` Networking::Session s; Networking::SessionRequest *request = s.get(url); request->startAndWait(); warning("HTTP GET: %s", request->text()); s.close(); ``` You can still use SessionRequest without Session (but you can't put them on stack!): ``` Networking::SessionRequest *request = new Networking::SessionRequest(url); request->startAndWait(); warning("HTTP GET: %s", request->text()); request->close(); ```
2019-11-03 02:16:00 +07:00
bool reuseStream();
NETWORKING: Enter SessionRequest It is to be used in a Session, though it might be used separately. It must implement keep-alive, but it does not yet. You must not put it to ConnMan by yourself (instead, use start()) and you must call close() after you've finished using this request. You can either work with it in callback, or wait() and simply use its methods (check it's success() and then, for example, use text()). Like this: ``` Networking::SessionRequest *rq = new Networking::SessionRequest(url); rq->startAndWait(); if (rq->success()) warning("HTTP GET: %s", rq->text()); rq->close(); ```
2019-11-02 05:10:41 +07:00
/** Prepares raw bytes from _contentsStream. */
char *getPreparedContents();
virtual void finishError(ErrorResponse error);
virtual void finishSuccess();
public:
SessionRequest(Common::String url, DataCallback cb = nullptr, ErrorCallback ecb = nullptr);
virtual ~SessionRequest();
NETWORKING: Enter Session Session allows to reuse SessionRequests to the same host by making them keeping alive connection. Turns out, though, that libcurl already does that for us, and we didn't gain any speedup we thought we'd get. Usage: ``` Networking::Session s; Networking::SessionRequest *request = s.get(url); request->startAndWait(); warning("HTTP GET: %s", request->text()); s.close(); ``` You can still use SessionRequest without Session (but you can't put them on stack!): ``` Networking::SessionRequest *request = new Networking::SessionRequest(url); request->startAndWait(); warning("HTTP GET: %s", request->text()); request->close(); ```
2019-11-03 02:16:00 +07:00
void start();
void startAndWait();
void reuse(Common::String url, DataCallback cb = nullptr, ErrorCallback ecb = nullptr);
NETWORKING: Enter SessionRequest It is to be used in a Session, though it might be used separately. It must implement keep-alive, but it does not yet. You must not put it to ConnMan by yourself (instead, use start()) and you must call close() after you've finished using this request. You can either work with it in callback, or wait() and simply use its methods (check it's success() and then, for example, use text()). Like this: ``` Networking::SessionRequest *rq = new Networking::SessionRequest(url); rq->startAndWait(); if (rq->success()) warning("HTTP GET: %s", rq->text()); rq->close(); ```
2019-11-02 05:10:41 +07:00
virtual void handle();
virtual void restart();
/** This request DOES NOT delete automatically after calling callbacks. It gets PAUSED, and in order to make it FINISHED (i.e. delete), this method MUST be called. */
JANITORIAL: Remove trailing whitespaces
2021-05-04 11:45:03 +03:00
void close();
NETWORKING: Enter SessionRequest It is to be used in a Session, though it might be used separately. It must implement keep-alive, but it does not yet. You must not put it to ConnMan by yourself (instead, use start()) and you must call close() after you've finished using this request. You can either work with it in callback, or wait() and simply use its methods (check it's success() and then, for example, use text()). Like this: ``` Networking::SessionRequest *rq = new Networking::SessionRequest(url); rq->startAndWait(); if (rq->success()) warning("HTTP GET: %s", rq->text()); rq->close(); ```
2019-11-02 05:10:41 +07:00
bool complete();
bool success();
char *text();
Common::JSONValue *json();
};
} // End of namespace Networking
#endif
Reference in a new issue Copy permalink