CSFML

- Main Page
- Data Structures
- Files

- File List
- Globals

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 {
42 sfHttpGet,
43 sfHttpPost,
44 sfHttpHead
45 } sfHttpMethod;
46
47
52 typedef enum
53 {
54 // 2xx: success
55 sfHttpOk = 200,
56 sfHttpCreated = 201,
57 sfHttpAccepted = 202,
58 sfHttpNoContent = 204,
59 sfHttpResetContent = 205,
60 sfHttpPartialContent = 206,
61
62 // 3xx: redirection
63 sfHttpMultipleChoices = 300,
64 sfHttpMovedPermanently = 301,
65 sfHttpMovedTemporarily = 302,
66 sfHttpNotModified = 304,
67
68 // 4xx: client error
69 sfHttpBadRequest = 400,
70 sfHttpUnauthorized = 401,
71 sfHttpForbidden = 403,
72 sfHttpNotFound = 404,
73 sfHttpRangeNotSatisfiable = 407,
74
75 // 5xx: server error
76 sfHttpInternalServerError = 500,
77 sfHttpNotImplemented = 501,
78 sfHttpBadGateway = 502,
79 sfHttpServiceNotAvailable = 503,
80 sfHttpGatewayTimeout = 504,
81 sfHttpVersionNotSupported = 505,
82
83 // 10xx: SFML custom codes
84 sfHttpInvalidResponse = 1000,
85 sfHttpConnectionFailed = 1001
86 } sfHttpStatus;
87
88
95 CSFML_NETWORK_API sfHttpRequest* sfHttpRequest_create(void);
96
103 CSFML_NETWORK_API void sfHttpRequest_destroy(sfHttpRequest* httpRequest);
104
119 CSFML_NETWORK_API void sfHttpRequest_setField(sfHttpRequest* httpRequest, const char* field, const char* value);
120
132 CSFML_NETWORK_API void sfHttpRequest_setMethod(sfHttpRequest* httpRequest, sfHttpMethod method);
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
178 CSFML_NETWORK_API void sfHttpResponse_destroy(sfHttpResponse* httpResponse);
179
193 CSFML_NETWORK_API const char* sfHttpResponse_getField(const sfHttpResponse* httpResponse, const char* field);
194
208 CSFML_NETWORK_API sfHttpStatus sfHttpResponse_getStatus(const sfHttpResponse* httpResponse);
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
252 CSFML_NETWORK_API sfHttp* sfHttp_create(void);
253
260 CSFML_NETWORK_API void sfHttp_destroy(sfHttp* http);
261
278 CSFML_NETWORK_API void sfHttp_setHost(sfHttp* http, const char* host, unsigned short port);
279
299 CSFML_NETWORK_API sfHttpResponse* sfHttp_sendRequest(sfHttp* http, const sfHttpRequest* request, sfTime timeout);
300
301
302 #endif // SFML_HTTP_H
sfHttpMovedPermanently
The requested page has permanently moved to a new location.
Definition: Http.h:64
Types.h
sfHttpMovedTemporarily
The requested page has temporarily moved to a new location.
Definition: Http.h:65
sfHttp_destroy
CSFML_NETWORK_API void sfHttp_destroy(sfHttp *http)
Destroy a Http object.
sfHttpServiceNotAvailable
The server is temporarily unavailable (overloaded, in maintenance, ...)
Definition: Http.h:79
sfHttpGatewayTimeout
The gateway server couldn't receive a response from the source server.
Definition: Http.h:80
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition: Network/Export.h:43
sfHttpNotFound
The requested page doesn't exist.
Definition: Http.h:72
sfHttpGet
Request in get mode, standard method to retrieve a page.
Definition: Http.h:42
sfHttpRequest_setField
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.
sfHttpBadGateway
The gateway server has received an error from the source server.
Definition: Http.h:78
sfHttpMethod
sfHttpMethod
Enumerate the available HTTP methods for a request.
Definition: Http.h:40
sfHttpPartialContent
The server has sent a part of the resource, as a response to a partial GET request.
Definition: Http.h:60
sfHttpRequest_setMethod
CSFML_NETWORK_API void sfHttpRequest_setMethod(sfHttpRequest *httpRequest, sfHttpMethod method)
Set a HTTP request method.
sfHttpResponse_getMinorVersion
CSFML_NETWORK_API unsigned int sfHttpResponse_getMinorVersion(const sfHttpResponse *httpResponse)
Get the minor HTTP version number of a HTTP response.
sfHttpRequest_create
CSFML_NETWORK_API sfHttpRequest * sfHttpRequest_create(void)
Create a new HTTP request.
sfHttpRequest
struct sfHttpRequest sfHttpRequest
Definition: Network/Types.h:33
sfHttpRequest_setHttpVersion
CSFML_NETWORK_API void sfHttpRequest_setHttpVersion(sfHttpRequest *httpRequest, unsigned int major, unsigned int minor)
Set the HTTP version of a HTTP request.
sfHttpInvalidResponse
Response is not a valid HTTP one.
Definition: Http.h:84
sfHttpResponse_getBody
CSFML_NETWORK_API const char * sfHttpResponse_getBody(const sfHttpResponse *httpResponse)
Get the body of a HTTP response.
sfHttpNotModified
For conditionnal requests, means the requested page hasn't changed and doesn't need to be refreshed...
Definition: Http.h:66
sfHttpVersionNotSupported
The server doesn't support the requested HTTP version.
Definition: Http.h:81
sfHttpResetContent
The server informs the client that it should clear the view (form) that caused the request to be sent...
Definition: Http.h:59
sfHttpOk
Most common code returned when operation was successful.
Definition: Http.h:55
sfHttpAccepted
The request has been accepted, but will be processed later by the server.
Definition: Http.h:57
sfHttpResponse_destroy
CSFML_NETWORK_API void sfHttpResponse_destroy(sfHttpResponse *httpResponse)
Destroy a HTTP response.
sfHttpResponse_getMajorVersion
CSFML_NETWORK_API unsigned int sfHttpResponse_getMajorVersion(const sfHttpResponse *httpResponse)
Get the major HTTP version number of a HTTP response.
sfHttpForbidden
The requested page cannot be accessed at all, even with authentification.
Definition: Http.h:71
sfHttpResponse_getStatus
CSFML_NETWORK_API sfHttpStatus sfHttpResponse_getStatus(const sfHttpResponse *httpResponse)
Get the status code of a HTTP reponse.
sfTime
Represents a time value.
Definition: Time.h:38
sfHttpMultipleChoices
The requested page can be accessed from several locations.
Definition: Http.h:63
sfHttpResponse
struct sfHttpResponse sfHttpResponse
Definition: Network/Types.h:34
sfHttpBadRequest
The server couldn't understand the request (syntax error)
Definition: Http.h:69
sfHttpNoContent
Sent when the server didn't send any data in return.
Definition: Http.h:58
sfHttpPost
Request in post mode, usually to send data to a page.
Definition: Http.h:43
sfHttpNotImplemented
The server doesn't implement a requested feature.
Definition: Http.h:77
sfHttp_sendRequest
CSFML_NETWORK_API sfHttpResponse * sfHttp_sendRequest(sfHttp *http, const sfHttpRequest *request, sfTime timeout)
Send a HTTP request and return the server's response.
sfHttpHead
Request a page's header only.
Definition: Http.h:44
sfHttpConnectionFailed
Connection with server failed.
Definition: Http.h:85
sfHttpRequest_setBody
CSFML_NETWORK_API void sfHttpRequest_setBody(sfHttpRequest *httpRequest, const char *body)
Set the body of a HTTP request.
sfHttp_create
CSFML_NETWORK_API sfHttp * sfHttp_create(void)
Create a new Http object.
sfHttpRangeNotSatisfiable
The server can't satisfy the partial GET request (with a "Range" header field)
Definition: Http.h:73
sfHttp_setHost
CSFML_NETWORK_API void sfHttp_setHost(sfHttp *http, const char *host, unsigned short port)
Set the target host of a HTTP object.
sfHttpUnauthorized
The requested page needs an authentification to be accessed.
Definition: Http.h:70
sfHttpRequest_setUri
CSFML_NETWORK_API void sfHttpRequest_setUri(sfHttpRequest *httpRequest, const char *uri)
Set a HTTP request URI.
sfHttpRequest_destroy
CSFML_NETWORK_API void sfHttpRequest_destroy(sfHttpRequest *httpRequest)
Destroy a HTTP request.
sfHttpResponse_getField
CSFML_NETWORK_API const char * sfHttpResponse_getField(const sfHttpResponse *httpResponse, const char *field)
Get the value of a field of a HTTP response.
Export.h
Time.h
sfHttpCreated
The resource has successfully been created.
Definition: Http.h:56
sfHttpStatus
sfHttpStatus
Enumerate all the valid status codes for a response.
Definition: Http.h:52
sfHttpInternalServerError
The server encountered an unexpected error.
Definition: Http.h:76
sfHttp
struct sfHttp sfHttp
Definition: Network/Types.h:35