Http.h

Go to the documentation of this file.

 
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_HTTP_H
#define SFML_HTTP_H
 
// Headers
#include <SFML/Network/Export.h>
#include <SFML/Network/Types.h>
#include <SFML/System/Time.h>
 
 
typedef enum
{
    sfHttpGet,   
    sfHttpPost,  
    sfHttpHead,  
    sfHttpPut,   
    sfHttpDelete 
} sfHttpMethod;
 
 
typedef enum
{
    // 2xx: success
    sfHttpOk             = 200, 
    sfHttpCreated        = 201, 
    sfHttpAccepted       = 202, 
    sfHttpNoContent      = 204, 
    sfHttpResetContent   = 205, 
    sfHttpPartialContent = 206, 
 
    // 3xx: redirection
    sfHttpMultipleChoices  = 300, 
    sfHttpMovedPermanently = 301, 
    sfHttpMovedTemporarily = 302, 
    sfHttpNotModified      = 304, 
 
    // 4xx: client error
    sfHttpBadRequest          = 400, 
    sfHttpUnauthorized        = 401, 
    sfHttpForbidden           = 403, 
    sfHttpNotFound            = 404, 
    sfHttpRangeNotSatisfiable = 407, 
 
    // 5xx: server error
    sfHttpInternalServerError = 500, 
    sfHttpNotImplemented      = 501, 
    sfHttpBadGateway          = 502, 
    sfHttpServiceNotAvailable = 503, 
    sfHttpGatewayTimeout      = 504, 
    sfHttpVersionNotSupported = 505, 
 
    // 10xx: SFML custom codes
    sfHttpInvalidResponse  = 1000, 
    sfHttpConnectionFailed = 1001  
} sfHttpStatus;
 
 
CSFML_NETWORK_API sfHttpRequest* sfHttpRequest_create(void);
 
CSFML_NETWORK_API void sfHttpRequest_destroy(sfHttpRequest* httpRequest);
 
CSFML_NETWORK_API void sfHttpRequest_setField(sfHttpRequest* httpRequest, const char* field, const char* value);
 
CSFML_NETWORK_API void sfHttpRequest_setMethod(sfHttpRequest* httpRequest, sfHttpMethod method);
 
CSFML_NETWORK_API void sfHttpRequest_setUri(sfHttpRequest* httpRequest, const char* uri);
 
CSFML_NETWORK_API void sfHttpRequest_setHttpVersion(sfHttpRequest* httpRequest, unsigned int major, unsigned int minor);
 
CSFML_NETWORK_API void sfHttpRequest_setBody(sfHttpRequest* httpRequest, const char* body);
 
CSFML_NETWORK_API void sfHttpResponse_destroy(sfHttpResponse* httpResponse);
 
CSFML_NETWORK_API const char* sfHttpResponse_getField(const sfHttpResponse* httpResponse, const char* field);
 
CSFML_NETWORK_API sfHttpStatus sfHttpResponse_getStatus(const sfHttpResponse* httpResponse);
 
CSFML_NETWORK_API unsigned int sfHttpResponse_getMajorVersion(const sfHttpResponse* httpResponse);
 
CSFML_NETWORK_API unsigned int sfHttpResponse_getMinorVersion(const sfHttpResponse* httpResponse);
 
CSFML_NETWORK_API const char* sfHttpResponse_getBody(const sfHttpResponse* httpResponse);
 
CSFML_NETWORK_API sfHttp* sfHttp_create(void);
 
CSFML_NETWORK_API void sfHttp_destroy(sfHttp* http);
 
CSFML_NETWORK_API void sfHttp_setHost(sfHttp* http, const char* host, unsigned short port);
 
CSFML_NETWORK_API sfHttpResponse* sfHttp_sendRequest(sfHttp* http, const sfHttpRequest* request, sfTime timeout);
 
 
#endif // SFML_HTTP_H