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