client.h

Go to the documentation of this file.

/*
 * Copyright © 2013 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 */
#ifndef CORE_NET_HTTP_CLIENT_H_
#define CORE_NET_HTTP_CLIENT_H_

#include <core/net/visibility.h>

#include <core/net/http/method.h>
#include <core/net/http/request.h>

#include <chrono>
#include <iosfwd>
#include <memory>

namespace core
{
namespace net
{

struct Uri;

namespace http
{
class ContentType;
class Request;

class CORE_NET_DLL_PUBLIC Client
{
public:
    struct Errors
    {
        Errors() = delete;

        struct HttpMethodNotSupported : public http::Error
        {
            HttpMethodNotSupported(Method method, const core::Location&);
            Method method;
        };
    };

    struct Timings
    {
        typedef std::chrono::duration<double> Seconds;

        struct Statistics
        {
            Seconds max{Seconds::max()};
            Seconds min{Seconds::max()};
            Seconds mean{Seconds::max()};
            Seconds variance{Seconds::max()};
        };

        Statistics name_look_up{};
        Statistics connect{};
        Statistics app_connect{};
        Statistics pre_transfer{};
        Statistics start_transfer{};
        Statistics total{};
    };

    Client(const Client&) = delete;
    virtual ~Client() = default;

    Client& operator=(const Client&) = delete;
    bool operator==(const Client&) const = delete;

    virtual std::string uri_to_string (const core::net::Uri& uri) const;

    virtual std::string url_escape(const std::string& s) const = 0;

    virtual std::string base64_encode(const std::string& s) const = 0;

    virtual std::string base64_decode(const std::string& s) const = 0;

    virtual Timings timings() = 0;

    virtual void run() = 0;

    virtual void stop() = 0;

    virtual std::shared_ptr<Request> get(const Request::Configuration& configuration) = 0;

    virtual std::shared_ptr<Request> head(const Request::Configuration& configuration) = 0;

    virtual std::shared_ptr<Request> put(const Request::Configuration& configuration, std::istream& payload, std::size_t size) = 0;

    virtual std::shared_ptr<Request> post(const Request::Configuration& configuration, const std::string& payload, const std::string& type) = 0;

    virtual std::shared_ptr<Request> post_form(const Request::Configuration& configuration, const std::map<std::string, std::string>& values);

protected:
    Client() = default;
};

CORE_NET_DLL_PUBLIC std::shared_ptr<Client> make_client();
}
}
}

#endif // CORE_NET_HTTP_CLIENT_H_