CSFML 3.0.0
Loading...
Searching...
No Matches
Http.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <CSFML/Network/Export.h>
31
32#include <CSFML/Network/Types.h>
33#include <CSFML/System/Time.h>
34
35
40 typedef enum
41{
42 sfHttpGet,
43 sfHttpPost,
44 sfHttpHead,
45 sfHttpPut,
46 sfHttpDelete
47} sfHttpMethod;
48
49
54 typedef enum
55{
56 // 2xx: success
57 sfHttpOk = 200,
58 sfHttpCreated = 201,
59 sfHttpAccepted = 202,
60 sfHttpNoContent = 204,
61 sfHttpResetContent = 205,
62 sfHttpPartialContent = 206,
63
64 // 3xx: redirection
65 sfHttpMultipleChoices = 300,
66 sfHttpMovedPermanently = 301,
67 sfHttpMovedTemporarily = 302,
68 sfHttpNotModified = 304,
69
70 // 4xx: client error
71 sfHttpBadRequest = 400,
72 sfHttpUnauthorized = 401,
73 sfHttpForbidden = 403,
74 sfHttpNotFound = 404,
75 sfHttpRangeNotSatisfiable = 407,
76
77 // 5xx: server error
78 sfHttpInternalServerError = 500,
79 sfHttpNotImplemented = 501,
80 sfHttpBadGateway = 502,
81 sfHttpServiceNotAvailable = 503,
82 sfHttpGatewayTimeout = 504,
83 sfHttpVersionNotSupported = 505,
84
85 // 10xx: SFML custom codes
86 sfHttpInvalidResponse = 1000,
87 sfHttpConnectionFailed = 1001
88} sfHttpStatus;
89
90
97 CSFML_NETWORK_API sfHttpRequest* sfHttpRequest_create(void);
98
105 CSFML_NETWORK_API void sfHttpRequest_destroy(const sfHttpRequest* httpRequest);
106
121 CSFML_NETWORK_API void sfHttpRequest_setField(sfHttpRequest* httpRequest, const char* field, const char* value);
122
134 CSFML_NETWORK_API void sfHttpRequest_setMethod(sfHttpRequest* httpRequest, sfHttpMethod method);
135
147 CSFML_NETWORK_API void sfHttpRequest_setUri(sfHttpRequest* httpRequest, const char* uri);
148
159 CSFML_NETWORK_API void sfHttpRequest_setHttpVersion(sfHttpRequest* httpRequest, unsigned int major, unsigned int minor);
160
172 CSFML_NETWORK_API void sfHttpRequest_setBody(sfHttpRequest* httpRequest, const char* body);
173
180 CSFML_NETWORK_API void sfHttpResponse_destroy(const sfHttpResponse* httpResponse);
181
195 CSFML_NETWORK_API const char* sfHttpResponse_getField(const sfHttpResponse* httpResponse, const char* field);
196
210 CSFML_NETWORK_API sfHttpStatus sfHttpResponse_getStatus(const sfHttpResponse* httpResponse);
211
220 CSFML_NETWORK_API unsigned int sfHttpResponse_getMajorVersion(const sfHttpResponse* httpResponse);
221
230 CSFML_NETWORK_API unsigned int sfHttpResponse_getMinorVersion(const sfHttpResponse* httpResponse);
231
246 CSFML_NETWORK_API const char* sfHttpResponse_getBody(const sfHttpResponse* httpResponse);
247
254 CSFML_NETWORK_API sfHttp* sfHttp_create(void);
255
262 CSFML_NETWORK_API void sfHttp_destroy(const sfHttp* http);
263
280 CSFML_NETWORK_API void sfHttp_setHost(sfHttp* http, const char* host, unsigned short port);
281
301 CSFML_NETWORK_API sfHttpResponse* sfHttp_sendRequest(sfHttp* http, const sfHttpRequest* request, sfTime timeout);
sfHttp_setHost
void sfHttp_setHost(sfHttp *http, const char *host, unsigned short port)
Set the target host of a HTTP object.
sfHttpResponse_getBody
const char * sfHttpResponse_getBody(const sfHttpResponse *httpResponse)
Get the body of a HTTP response.
sfHttpResponse_getMinorVersion
unsigned int sfHttpResponse_getMinorVersion(const sfHttpResponse *httpResponse)
Get the minor HTTP version number of a HTTP response.
sfHttpRequest_setBody
void sfHttpRequest_setBody(sfHttpRequest *httpRequest, const char *body)
Set the body of a HTTP request.
sfHttpResponse_getMajorVersion
unsigned int sfHttpResponse_getMajorVersion(const sfHttpResponse *httpResponse)
Get the major HTTP version number of a HTTP response.
sfHttpRequest_destroy
void sfHttpRequest_destroy(const sfHttpRequest *httpRequest)
Destroy a HTTP request.
sfHttpRequest_create
sfHttpRequest * sfHttpRequest_create(void)
Create a new HTTP request.
sfHttpResponse_destroy
void sfHttpResponse_destroy(const sfHttpResponse *httpResponse)
Destroy a HTTP response.
sfHttpRequest_setUri
void sfHttpRequest_setUri(sfHttpRequest *httpRequest, const char *uri)
Set a HTTP request URI.
sfHttpRequest_setField
void sfHttpRequest_setField(sfHttpRequest *httpRequest, const char *field, const char *value)
Set the value of a header field of a HTTP request.
sfHttp_create
sfHttp * sfHttp_create(void)
Create a new Http object.
sfHttpRequest_setMethod
void sfHttpRequest_setMethod(sfHttpRequest *httpRequest, sfHttpMethod method)
Set a HTTP request method.
sfHttpRequest_setHttpVersion
void sfHttpRequest_setHttpVersion(sfHttpRequest *httpRequest, unsigned int major, unsigned int minor)
Set the HTTP version of a HTTP request.
sfHttpResponse_getStatus
sfHttpStatus sfHttpResponse_getStatus(const sfHttpResponse *httpResponse)
Get the status code of a HTTP response.
sfHttp_destroy
void sfHttp_destroy(const sfHttp *http)
Destroy a Http object.
sfHttpResponse_getField
const char * sfHttpResponse_getField(const sfHttpResponse *httpResponse, const char *field)
Get the value of a field of a HTTP response.
sfHttp_sendRequest
sfHttpResponse * sfHttp_sendRequest(sfHttp *http, const sfHttpRequest *request, sfTime timeout)
Send a HTTP request and return the server's response.
sfHttpStatus
sfHttpStatus
Enumerate all the valid status codes for a response.
Definition Http.h:55
sfHttpResetContent
@ sfHttpResetContent
The server informs the client that it should clear the view (form) that caused the request to be sent...
Definition Http.h:61
sfHttpNotModified
@ sfHttpNotModified
For conditional requests, means the requested page hasn't changed and doesn't need to be refreshed.
Definition Http.h:68
sfHttpInvalidResponse
@ sfHttpInvalidResponse
Response is not a valid HTTP one.
Definition Http.h:86
sfHttpGatewayTimeout
@ sfHttpGatewayTimeout
The gateway server couldn't receive a response from the source server.
Definition Http.h:82
sfHttpMultipleChoices
@ sfHttpMultipleChoices
The requested page can be accessed from several locations.
Definition Http.h:65
sfHttpPartialContent
@ sfHttpPartialContent
The server has sent a part of the resource, as a response to a partial GET request.
Definition Http.h:62
sfHttpServiceNotAvailable
@ sfHttpServiceNotAvailable
The server is temporarily unavailable (overloaded, in maintenance, ...)
Definition Http.h:81
sfHttpMovedTemporarily
@ sfHttpMovedTemporarily
The requested page has temporarily moved to a new location.
Definition Http.h:67
sfHttpInternalServerError
@ sfHttpInternalServerError
The server encountered an unexpected error.
Definition Http.h:78
sfHttpCreated
@ sfHttpCreated
The resource has successfully been created.
Definition Http.h:58
sfHttpNotImplemented
@ sfHttpNotImplemented
The server doesn't implement a requested feature.
Definition Http.h:79
sfHttpMovedPermanently
@ sfHttpMovedPermanently
The requested page has permanently moved to a new location.
Definition Http.h:66
sfHttpNotFound
@ sfHttpNotFound
The requested page doesn't exist.
Definition Http.h:74
sfHttpConnectionFailed
@ sfHttpConnectionFailed
Connection with server failed.
Definition Http.h:87
sfHttpBadGateway
@ sfHttpBadGateway
The gateway server has received an error from the source server.
Definition Http.h:80
sfHttpUnauthorized
@ sfHttpUnauthorized
The requested page needs an authentication to be accessed.
Definition Http.h:72
sfHttpVersionNotSupported
@ sfHttpVersionNotSupported
The server doesn't support the requested HTTP version.
Definition Http.h:83
sfHttpNoContent
@ sfHttpNoContent
Sent when the server didn't send any data in return.
Definition Http.h:60
sfHttpOk
@ sfHttpOk
Most common code returned when operation was successful.
Definition Http.h:57
sfHttpRangeNotSatisfiable
@ sfHttpRangeNotSatisfiable
The server can't satisfy the partial GET request (with a "Range" header field)
Definition Http.h:75
sfHttpAccepted
@ sfHttpAccepted
The request has been accepted, but will be processed later by the server.
Definition Http.h:59
sfHttpBadRequest
@ sfHttpBadRequest
The server couldn't understand the request (syntax error)
Definition Http.h:71
sfHttpForbidden
@ sfHttpForbidden
The requested page cannot be accessed at all, even with authentication.
Definition Http.h:73
sfHttpMethod
sfHttpMethod
Enumerate the available HTTP methods for a request.
Definition Http.h:41
sfHttpDelete
@ sfHttpDelete
Request in delete mode, useful for a REST API.
Definition Http.h:46
sfHttpPut
@ sfHttpPut
Request in put mode, useful for a REST API.
Definition Http.h:45
sfHttpPost
@ sfHttpPost
Request in post mode, usually to send data to a page.
Definition Http.h:43
sfHttpGet
@ sfHttpGet
Request in get mode, standard method to retrieve a page.
Definition Http.h:42
sfHttpHead
@ sfHttpHead
Request a page's header only.
Definition Http.h:44
Export.h
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition Network/Export.h:42
Types.h
sfHttp
struct sfHttp sfHttp
Definition Network/Types.h:34
sfHttpResponse
struct sfHttpResponse sfHttpResponse
Definition Network/Types.h:33
sfHttpRequest
struct sfHttpRequest sfHttpRequest
Definition Network/Types.h:32
Time.h
sfTime
Represents a time value.
Definition Time.h:38