Files
@ r25958:603d75b53498
Branch filter:
Location: cpp/openttd-patchpack/source/src/network/core/tcp_http.h - annotation
r25958:603d75b53498
3.9 KiB
text/x-c
Doc: update multiplayer documentation with latest changes (#9552)
Although several places were fixed during the PR making the change,
not all made it in this document.
While at it, removed all kinds of Markdown warnings by an excessive
usage of spacebar in this document.
Although several places were fixed during the PR making the change,
not all made it in this document.
While at it, removed all kinds of Markdown warnings by an excessive
usage of spacebar in this document.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r15934:789c54d0000d r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r15594:ba7e42fbae24 r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r23607:36c15679007d r14427:e0f0ac35263c r23607:36c15679007d r14427:e0f0ac35263c r14427:e0f0ac35263c r14434:ff88a5e07169 r14434:ff88a5e07169 r14434:ff88a5e07169 r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r25458:3aaccd46b7fa r14427:e0f0ac35263c r14427:e0f0ac35263c r25687:bb09d6722f4e r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r23607:36c15679007d r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r25397:c741c77120c8 r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r25397:c741c77120c8 r25388:32b23efdcf4e r25388:32b23efdcf4e r25388:32b23efdcf4e r25388:32b23efdcf4e r14427:e0f0ac35263c r25397:c741c77120c8 r25397:c741c77120c8 r25397:c741c77120c8 r14427:e0f0ac35263c r21410:ae5961f02724 r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r18352:6c15d75d1ab9 r14427:e0f0ac35263c r14427:e0f0ac35263c r23506:bba4d0c6d70d r14427:e0f0ac35263c r14427:e0f0ac35263c r18352:6c15d75d1ab9 r14427:e0f0ac35263c r14427:e0f0ac35263c r23506:bba4d0c6d70d r14427:e0f0ac35263c r25687:bb09d6722f4e r19944:25a78576fb5e r23607:36c15679007d r14427:e0f0ac35263c r14427:e0f0ac35263c r14427:e0f0ac35263c r16849:d593358b4346 | /*
* This file is part of OpenTTD.
* OpenTTD 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, version 2.
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file tcp_http.h Basic functions to receive and send HTTP TCP packets.
*/
#ifndef NETWORK_CORE_TCP_HTTP_H
#define NETWORK_CORE_TCP_HTTP_H
#include "tcp.h"
/** Callback for when the HTTP handler has something to tell us. */
struct HTTPCallback {
/**
* An error has occurred and the connection has been closed.
* @note HTTP socket handler is closed/freed.
*/
virtual void OnFailure() = 0;
/**
* We're receiving data.
* @param data the received data, nullptr when all data has been received.
* @param length the amount of received data, 0 when all data has been received.
* @note When nullptr is sent the HTTP socket handler is closed/freed.
*/
virtual void OnReceiveData(const char *data, size_t length) = 0;
/** Silentium */
virtual ~HTTPCallback() {}
};
/** Base socket handler for HTTP traffic. */
class NetworkHTTPSocketHandler : public NetworkSocketHandler {
private:
char recv_buffer[4096]; ///< Partially received message.
int recv_pos; ///< Current position in buffer.
int recv_length; ///< Length of the data still retrieving.
HTTPCallback *callback; ///< The callback to call for the incoming data.
const char *data; ///< The (POST) data we might want to forward (to a redirect).
int redirect_depth; ///< The depth of the redirection.
int HandleHeader();
int Receive();
public:
SOCKET sock; ///< The socket currently connected to
/**
* Whether this socket is currently bound to a socket.
* @return true when the socket is bound, false otherwise
*/
bool IsConnected() const
{
return this->sock != INVALID_SOCKET;
}
void CloseSocket();
NetworkHTTPSocketHandler(SOCKET sock, HTTPCallback *callback,
const std::string &host, const char *url, const char *data, int depth);
~NetworkHTTPSocketHandler();
static int Connect(char *uri, HTTPCallback *callback,
const char *data = nullptr, int depth = 0);
static void HTTPReceive();
};
/** Connect with a HTTP server and do ONE query. */
class NetworkHTTPContentConnecter : TCPConnecter {
std::string hostname; ///< Hostname we are connecting to.
HTTPCallback *callback; ///< Callback to tell that we received some data (or won't).
const char *url; ///< The URL we want to get at the server.
const char *data; ///< The data to send
int depth; ///< How far we have recursed
public:
/**
* Start the connecting.
* @param hostname The hostname to connect to.
* @param callback The callback for HTTP retrieval.
* @param url The url at the server.
* @param data The data to send.
* @param depth The depth (redirect recursion) of the queries.
*/
NetworkHTTPContentConnecter(const std::string &hostname, HTTPCallback *callback, const char *url, const char *data = nullptr, int depth = 0) :
TCPConnecter(hostname, 80),
hostname(hostname),
callback(callback),
url(stredup(url)),
data(data),
depth(depth)
{
}
/** Free all our allocated data. */
~NetworkHTTPContentConnecter()
{
free(this->url);
}
void OnFailure() override
{
this->callback->OnFailure();
free(this->data);
}
void OnConnect(SOCKET s) override
{
new NetworkHTTPSocketHandler(s, this->callback, this->hostname, this->url, this->data, this->depth);
/* We've relinquished control of data now. */
this->data = nullptr;
}
};
#endif /* NETWORK_CORE_TCP_HTTP_H */
|