Http/HttpClient.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * HttpClient.h
 *
 * Modified: 2017 - Slavey Karadzhov <slav@attachix.com>
 *
 ****/
 
#pragma once
 
#include "../TcpClient.h"
#include "HttpCommon.h"
#include "HttpRequest.h"
#include "HttpClientConnection.h"
#include <Data/Stream/LimitedMemoryStream.h>
#include <SimpleTimer.h>
 
class HttpClient
{
public:
    virtual ~HttpClient() = default;
 
    /* High-Level Methods */
 
    bool sendRequest(const Url& url, RequestCompletedDelegate requestComplete)
    {
        return send(createRequest(url)->setMethod(HTTP_GET)->onRequestComplete(requestComplete));
    }
 
    bool sendRequest(const HttpMethod method, const Url& url, const HttpHeaders& headers,
                     RequestCompletedDelegate requestComplete)
    {
        return send(createRequest(url)->setMethod(method)->setHeaders(headers)->onRequestComplete(requestComplete));
    }
 
    bool sendRequest(const HttpMethod method, const Url& url, const HttpHeaders& headers, const String& body,
                     RequestCompletedDelegate requestComplete)
    {
        return send(createRequest(url)->setMethod(method)->setHeaders(headers)->setBody(body)->onRequestComplete(
            requestComplete));
    }
 
    bool sendRequest(const HttpMethod method, const Url& url, const HttpHeaders& headers, String&& body,
                     RequestCompletedDelegate requestComplete) noexcept
    {
        return send(createRequest(url)
                        ->setMethod(method)
                        ->setHeaders(headers)
                        ->setBody(std::move(body))
                        ->onRequestComplete(requestComplete));
    }
 
    bool downloadString(const Url& url, RequestCompletedDelegate requestComplete,
                        size_t maxLength = NETWORK_SEND_BUFFER_SIZE)
    {
        return send(createRequest(url)
                        ->setMethod(HTTP_GET)
                        ->setResponseStream(new LimitedMemoryStream(maxLength))
                        ->onRequestComplete(requestComplete));
    }
 
    bool downloadFile(const Url& url, RequestCompletedDelegate requestComplete = nullptr)
    {
        return downloadFile(url, nullptr, requestComplete);
    }
 
    bool downloadFile(const Url& url, const String& saveFileName, RequestCompletedDelegate requestComplete = nullptr);
 
    /* Low Level Methods */
 
    /*
     * @brief This method queues a request and sends it, once it is connected to the remote server.
     * @param HttpRequest* request The request object will be freed inside of the method.
     *                             Do not try to reuse it outside of the send method as it will lead to unpredicted results
     *
     * @retval bool true if the request was queued, false otherwise.
     *
     */
    bool send(HttpRequest* request);
 
    HttpRequest* createRequest(const Url& url)
    {
        return new HttpRequest(url);
    }
 
    static void cleanup()
    {
        httpConnectionPool.clear();
    }
 
protected:
    String getCacheKey(const Url& url)
    {
        return url.Host + ':' + url.getPort();
    }
 
protected:
    using HttpConnectionPool = ObjectMap<String, HttpClientConnection>;
    static HttpConnectionPool httpConnectionPool;
 
private:
    static SimpleTimer cleanUpTimer;
    static void cleanInactive();
};