Http.hpp

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Network

Http.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// 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_HPP
#define SFML_HTTP_HPP

// Headers
#include <SFML/System/NonCopyable.hpp>
#include <SFML/Network/IPAddress.hpp>
#include <SFML/Network/SocketTCP.hpp>
#include <map>
#include <string>
 
 
namespace sf
{
class SFML_API Http : NonCopyable
{
public :

    class SFML_API Request
    {
    public :

        enum Method
        {
            Get,  
            Post, 
            Head  
        };

        Request(Method RequestMethod = Get, const std::string& URI = "/", const std::string& Body = "");

        void SetField(const std::string& Field, const std::string& Value);

        void SetMethod(Method RequestMethod);

        void SetURI(const std::string& URI);

        void SetHttpVersion(unsigned int Major, unsigned int Minor);

        void SetBody(const std::string& Body);
 
    private :
 
        friend class Http;

        std::string ToString() const;

        bool HasField(const std::string& Field) const;

        // Types
        typedef std::map<std::string, std::string> FieldTable;

        // Member data
        FieldTable   myFields;       
        Method       myMethod;       
        std::string  myURI;          
        unsigned int myMajorVersion; 
        unsigned int myMinorVersion; 
        std::string  myBody;         
    };

    class SFML_API Response
    {
    public :

        enum Status
        {
            // 2xx: success
            Ok        = 200, 
            Created   = 201, 
            Accepted  = 202, 
            NoContent = 204, 
 
            // 3xx: redirection
            MultipleChoices  = 300, 
            MovedPermanently = 301, 
            MovedTemporarily = 302, 
            NotModified      = 304, 
 
            // 4xx: client error
            BadRequest   = 400, 
            Unauthorized = 401, 
            Forbidden    = 403, 
            NotFound     = 404, 
 
            // 5xx: server error
            InternalServerError = 500, 
            NotImplemented      = 501, 
            BadGateway          = 502, 
            ServiceNotAvailable = 503, 
 
            // 10xx: SFML custom codes
            InvalidResponse  = 1000, 
            ConnectionFailed = 1001  
        };

        Response();

        const std::string& GetField(const std::string& Field) const;

        Status GetStatus() const;

        unsigned int GetMajorHttpVersion() const;

        unsigned int GetMinorHttpVersion() const;

        const std::string& GetBody() const;
 
    private :
 
        friend class Http;

        void FromString(const std::string& Data);

        // Types
        typedef std::map<std::string, std::string> FieldTable;

        // Member data
        FieldTable   myFields;       
        Status       myStatus;       
        unsigned int myMajorVersion; 
        unsigned int myMinorVersion; 
        std::string  myBody;         
    };

    Http();

    Http(const std::string& Host, unsigned short Port = 0);

    void SetHost(const std::string& Host, unsigned short Port = 0);

    Response SendRequest(const Request& Req, float Timeout = 0.f);
 
private :

    // Member data
    SocketTCP      myConnection; 
    IPAddress      myHost;       
    std::string    myHostName;   
    unsigned short myPort;       
};
 
} // namespace sf
 
 
#endif // SFML_HTTP_HPP