Http.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
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 #ifndef SFML_HTTP_H
26 #define SFML_HTTP_H
27 
29 // Headers
31 #include <SFML/Network/Export.h>
32 #include <SFML/Network/Types.h>
33 #include <SFML/System/Time.h>
34 
35 
40 typedef enum
41 {
45 } sfHttpMethod;
46 
47 
52 typedef enum
53 {
54  // 2xx: success
55  sfHttpOk = 200,
56  sfHttpCreated = 201,
61 
62  // 3xx: redirection
67 
68  // 4xx: client error
74 
75  // 5xx: server error
82 
83  // 10xx: SFML custom codes
86 } sfHttpStatus;
87 
88 
96 
104 
119 CSFML_NETWORK_API void sfHttpRequest_setField(sfHttpRequest* httpRequest, const char* field, const char* value);
120 
133 
145 CSFML_NETWORK_API void sfHttpRequest_setUri(sfHttpRequest* httpRequest, const char* uri);
146 
157 CSFML_NETWORK_API void sfHttpRequest_setHttpVersion(sfHttpRequest* httpRequest, unsigned int major, unsigned int minor);
158 
170 CSFML_NETWORK_API void sfHttpRequest_setBody(sfHttpRequest* httpRequest, const char* body);
171 
179 
193 CSFML_NETWORK_API const char* sfHttpResponse_getField(const sfHttpResponse* httpResponse, const char* field);
194 
209 
218 CSFML_NETWORK_API unsigned int sfHttpResponse_getMajorVersion(const sfHttpResponse* httpResponse);
219 
228 CSFML_NETWORK_API unsigned int sfHttpResponse_getMinorVersion(const sfHttpResponse* httpResponse);
229 
244 CSFML_NETWORK_API const char* sfHttpResponse_getBody(const sfHttpResponse* httpResponse);
245 
253 
261 
278 CSFML_NETWORK_API void sfHttp_setHost(sfHttp* http, const char* host, unsigned short port);
279 
300 
301 
302 #endif // SFML_HTTP_H
The requested page has permanently moved to a new location.
Definition: Http.h:64
The requested page has temporarily moved to a new location.
Definition: Http.h:65
CSFML_NETWORK_API void sfHttp_destroy(sfHttp *http)
Destroy a Http object.
The server is temporarily unavailable (overloaded, in maintenance, ...)
Definition: Http.h:79
The gateway server couldn&#39;t receive a response from the source server.
Definition: Http.h:80
#define CSFML_NETWORK_API
The requested page doesn&#39;t exist.
Definition: Http.h:72
Request in get mode, standard method to retrieve a page.
Definition: Http.h:42
CSFML_NETWORK_API void sfHttpRequest_setField(sfHttpRequest *httpRequest, const char *field, const char *value)
Set the value of a header field of a HTTP request.
The gateway server has received an error from the source server.
Definition: Http.h:78
sfHttpMethod
Enumerate the available HTTP methods for a request.
Definition: Http.h:40
The server has sent a part of the resource, as a response to a partial GET request.
Definition: Http.h:60
CSFML_NETWORK_API void sfHttpRequest_setMethod(sfHttpRequest *httpRequest, sfHttpMethod method)
Set a HTTP request method.
CSFML_NETWORK_API unsigned int sfHttpResponse_getMinorVersion(const sfHttpResponse *httpResponse)
Get the minor HTTP version number of a HTTP response.
CSFML_NETWORK_API sfHttpRequest * sfHttpRequest_create(void)
Create a new HTTP request.
struct sfHttpRequest sfHttpRequest
Definition: Network/Types.h:33
CSFML_NETWORK_API void sfHttpRequest_setHttpVersion(sfHttpRequest *httpRequest, unsigned int major, unsigned int minor)
Set the HTTP version of a HTTP request.
Response is not a valid HTTP one.
Definition: Http.h:84
CSFML_NETWORK_API const char * sfHttpResponse_getBody(const sfHttpResponse *httpResponse)
Get the body of a HTTP response.
For conditionnal requests, means the requested page hasn&#39;t changed and doesn&#39;t need to be refreshed...
Definition: Http.h:66
The server doesn&#39;t support the requested HTTP version.
Definition: Http.h:81
The server informs the client that it should clear the view (form) that caused the request to be sent...
Definition: Http.h:59
Most common code returned when operation was successful.
Definition: Http.h:55
The request has been accepted, but will be processed later by the server.
Definition: Http.h:57
CSFML_NETWORK_API void sfHttpResponse_destroy(sfHttpResponse *httpResponse)
Destroy a HTTP response.
CSFML_NETWORK_API unsigned int sfHttpResponse_getMajorVersion(const sfHttpResponse *httpResponse)
Get the major HTTP version number of a HTTP response.
The requested page cannot be accessed at all, even with authentification.
Definition: Http.h:71
CSFML_NETWORK_API sfHttpStatus sfHttpResponse_getStatus(const sfHttpResponse *httpResponse)
Get the status code of a HTTP reponse.
Represents a time value.
Definition: Time.h:38
The requested page can be accessed from several locations.
Definition: Http.h:63
struct sfHttpResponse sfHttpResponse
Definition: Network/Types.h:34
The server couldn&#39;t understand the request (syntax error)
Definition: Http.h:69
Sent when the server didn&#39;t send any data in return.
Definition: Http.h:58
Request in post mode, usually to send data to a page.
Definition: Http.h:43
The server doesn&#39;t implement a requested feature.
Definition: Http.h:77
CSFML_NETWORK_API sfHttpResponse * sfHttp_sendRequest(sfHttp *http, const sfHttpRequest *request, sfTime timeout)
Send a HTTP request and return the server&#39;s response.
Request a page&#39;s header only.
Definition: Http.h:44
Connection with server failed.
Definition: Http.h:85
CSFML_NETWORK_API void sfHttpRequest_setBody(sfHttpRequest *httpRequest, const char *body)
Set the body of a HTTP request.
CSFML_NETWORK_API sfHttp * sfHttp_create(void)
Create a new Http object.
The server can&#39;t satisfy the partial GET request (with a &quot;Range&quot; header field)
Definition: Http.h:73
CSFML_NETWORK_API void sfHttp_setHost(sfHttp *http, const char *host, unsigned short port)
Set the target host of a HTTP object.
The requested page needs an authentification to be accessed.
Definition: Http.h:70
CSFML_NETWORK_API void sfHttpRequest_setUri(sfHttpRequest *httpRequest, const char *uri)
Set a HTTP request URI.
CSFML_NETWORK_API void sfHttpRequest_destroy(sfHttpRequest *httpRequest)
Destroy a HTTP request.
CSFML_NETWORK_API const char * sfHttpResponse_getField(const sfHttpResponse *httpResponse, const char *field)
Get the value of a field of a HTTP response.
The resource has successfully been created.
Definition: Http.h:56
sfHttpStatus
Enumerate all the valid status codes for a response.
Definition: Http.h:52
The server encountered an unexpected error.
Definition: Http.h:76
struct sfHttp sfHttp
Definition: Network/Types.h:35