http_client.h

/***
 * Copyright (C) Microsoft. All rights reserved.
 * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
 *
 * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
 *
 * HTTP Library: Client-side APIs.
 *
 * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
 *
 * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 ****/
#pragma once

#ifndef CASA_HTTP_CLIENT_H
#define CASA_HTTP_CLIENT_H

#if defined(__cplusplus_winrt)
#if !defined(__WRL_NO_DEFAULT_LIB__)
#define __WRL_NO_DEFAULT_LIB__
#endif
#include <msxml6.h>
#include <wrl.h>
namespace web
{
namespace http
{
namespace client
{
typedef IXMLHTTPRequest2* native_handle;
}
} // namespace http
} // namespace web
#else
namespace web
{
namespace http
{
namespace client
{
typedef void* native_handle;
}
} // namespace http
} // namespace web
#endif // __cplusplus_winrt

#include "cpprest/asyncrt_utils.h"
#include "cpprest/certificate_info.h"
#include "cpprest/details/basic_types.h"
#include "cpprest/details/web_utilities.h"
#include "cpprest/http_msg.h"
#include "cpprest/json.h"
#include "cpprest/uri.h"
#include "pplx/pplxtasks.h"
#include <limits>
#include <memory>

#if _WIN32_WINNT >= _WIN32_WINNT_VISTA
#include "cpprest/oauth1.h"
#endif

#include "cpprest/oauth2.h"

#if !defined(_WIN32) && !defined(__cplusplus_winrt) || defined(CPPREST_FORCE_HTTP_CLIENT_ASIO)
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wconversion"
#endif
#include "boost/asio/ssl.hpp"
#if defined(__clang__)
#pragma clang diagnostic pop
#endif
#endif

/// The web namespace contains functionality common to multiple protocols like HTTP and WebSockets.
namespace web
{
/// Declarations and functionality for the HTTP protocol.
namespace http
{
/// HTTP client side library.
namespace client
{
// credentials and web_proxy class has been moved from web::http::client namespace to web namespace.
// The below using declarations ensure we don't break existing code.
// Please use the web::credentials and web::web_proxy class going forward.
using web::credentials;
using web::web_proxy;

/// <summary>
/// HTTP client configuration class, used to set the possible configuration options
/// used to create an http_client instance.
/// </summary>
class http_client_config
{
public:
    http_client_config()
        : m_guarantee_order(false)
        , m_timeout(std::chrono::seconds(30))
        , m_chunksize(0)
        , m_request_compressed(false)
#if !defined(__cplusplus_winrt)
        , m_validate_certificates(true)
#endif
        , m_certificate_chain_callback([](const std::shared_ptr<certificate_info>&) -> bool { return true; })
#if !defined(_WIN32) && !defined(__cplusplus_winrt) || defined(CPPREST_FORCE_HTTP_CLIENT_ASIO)
        , m_tlsext_sni_enabled(true)
#endif
#if (defined(_WIN32) && !defined(__cplusplus_winrt)) || defined(CPPREST_FORCE_HTTP_CLIENT_WINHTTPPAL)
        , m_buffer_request(false)
#endif
        , m_max_redirects(10)
        , m_https_to_http_redirects(false)
    {
    }

#if _WIN32_WINNT >= _WIN32_WINNT_VISTA
    /// <summary>
    /// Get OAuth 1.0 configuration.
    /// </summary>
    /// <returns>Shared pointer to OAuth 1.0 configuration.</returns>
    const std::shared_ptr<oauth1::experimental::oauth1_config> oauth1() const { return m_oauth1; }

    /// <summary>
    /// Set OAuth 1.0 configuration.
    /// </summary>
    /// <param name="config">OAuth 1.0 configuration to set.</param>
    void set_oauth1(oauth1::experimental::oauth1_config config)
    {
        m_oauth1 = std::make_shared<oauth1::experimental::oauth1_config>(std::move(config));
    }
#endif

    /// <summary>
    /// Get OAuth 2.0 configuration.
    /// </summary>
    /// <returns>Shared pointer to OAuth 2.0 configuration.</returns>
    const std::shared_ptr<oauth2::experimental::oauth2_config> oauth2() const { return m_oauth2; }

    /// <summary>
    /// Set OAuth 2.0 configuration.
    /// </summary>
    /// <param name="config">OAuth 2.0 configuration to set.</param>
    void set_oauth2(oauth2::experimental::oauth2_config config)
    {
        m_oauth2 = std::make_shared<oauth2::experimental::oauth2_config>(std::move(config));
    }

    /// <summary>
    /// Get the web proxy object
    /// </summary>
    /// <returns>A reference to the web proxy object.</returns>
    const web_proxy& proxy() const { return m_proxy; }

    /// <summary>
    /// Set the web proxy object
    /// </summary>
    /// <param name="proxy">A reference to the web proxy object.</param>
    void set_proxy(web_proxy proxy) { m_proxy = std::move(proxy); }

    /// <summary>
    /// Get the client credentials
    /// </summary>
    /// <returns>A reference to the client credentials.</returns>
    const http::client::credentials& credentials() const { return m_credentials; }

    /// <summary>
    /// Set the client credentials
    /// </summary>
    /// <param name="cred">A reference to the client credentials.</param>
    void set_credentials(const http::client::credentials& cred) { m_credentials = cred; }

    /// <summary>
    /// Get the 'guarantee order' property
    /// </summary>
    /// <returns>The value of the property.</returns>
    bool guarantee_order() const { return m_guarantee_order; }

    /// <summary>
    /// Set the 'guarantee order' property
    /// </summary>
    /// <param name="guarantee_order">The value of the property.</param>
    CASABLANCA_DEPRECATED(
        "Confusing API will be removed in future releases. If you need to order HTTP requests use task continuations.")
    void set_guarantee_order(bool guarantee_order) { m_guarantee_order = guarantee_order; }

    /// <summary>
    /// Get the timeout
    /// </summary>
    /// <returns>The timeout (in seconds) used for each send and receive operation on the client.</returns>
    utility::seconds timeout() const { return std::chrono::duration_cast<utility::seconds>(m_timeout); }

    /// <summary>
    /// Get the timeout
    /// </summary>
    /// <returns>The timeout (in whatever duration) used for each send and receive operation on the client.</returns>
    template<class T>
    T timeout() const
    {
        return std::chrono::duration_cast<T>(m_timeout);
    }
    /// <summary>
    /// Set the timeout
    /// </summary>
    /// <param name="timeout">The timeout (duration from microseconds range and up) used for each send and receive
    /// operation on the client.</param>
    template<class T>
    void set_timeout(const T& timeout)
    {
        m_timeout = std::chrono::duration_cast<std::chrono::microseconds>(timeout);
    }

    /// <summary>
    /// Get the client chunk size.
    /// </summary>
    /// <returns>The internal buffer size used by the http client when sending and receiving data from the
    /// network.</returns>
    size_t chunksize() const { return m_chunksize == 0 ? 64 * 1024 : m_chunksize; }

    /// <summary>
    /// Sets the client chunk size.
    /// </summary>
    /// <param name="size">The internal buffer size used by the http client when sending and receiving data from the
    /// network.</param> <remarks>This is a hint -- an implementation may disregard the setting and use some other chunk
    /// size.</remarks>
    void set_chunksize(size_t size) { m_chunksize = size; }

    /// <summary>
    /// Returns true if the default chunk size is in use.
    /// <remarks>If true, implementations are allowed to choose whatever size is best.</remarks>
    /// </summary>
    /// <returns>True if default, false if set by user.</returns>
    bool is_default_chunksize() const { return m_chunksize == 0; }

    /// <summary>
    /// Checks if requesting a compressed response using Content-Encoding is turned on, the default is off.
    /// </summary>
    /// <returns>True if a content-encoded compressed response is allowed, false otherwise</returns>
    bool request_compressed_response() const { return m_request_compressed; }

    /// <summary>
    /// Request that the server respond with a compressed body using Content-Encoding; to use Transfer-Encoding, do not
    /// set this, and specify a vector of <see cref="web::http::details::compression::decompress_factory" /> pointers
    /// to the set_decompress_factories method of the <see cref="web::http::http_request" /> object for the request.
    /// If true and the server does not support compression, this will have no effect.
    /// The response body is internally decompressed before the consumer receives the data.
    /// </summary>
    /// <param name="request_compressed">True to turn on content-encoded response body compression, false
    /// otherwise.</param> <remarks>Please note there is a performance cost due to copying the request data. Currently
    /// only supported on Windows and OSX.</remarks>
    void set_request_compressed_response(bool request_compressed) { m_request_compressed = request_compressed; }

#if !defined(__cplusplus_winrt)
    /// <summary>
    /// Gets the server certificate validation property.
    /// </summary>
    /// <returns>True if certificates are to be verified, false otherwise.</returns>
    bool validate_certificates() const { return m_validate_certificates; }

    /// <summary>
    /// Sets the server certificate validation property.
    /// </summary>
    /// <param name="validate_certs">False to turn ignore all server certificate validation errors, true
    /// otherwise.</param> <remarks>Note ignoring certificate errors can be dangerous and should be done with
    /// caution.</remarks>
    void set_validate_certificates(bool validate_certs) { m_validate_certificates = validate_certs; }
#endif

#if (defined(_WIN32) && !defined(__cplusplus_winrt)) || defined(CPPREST_FORCE_HTTP_CLIENT_WINHTTPPAL)
    /// <summary>
    /// Checks if request data buffering is turned on, the default is off.
    /// </summary>
    /// <returns>True if buffering is enabled, false otherwise</returns>
    bool buffer_request() const { return m_buffer_request; }

    /// <summary>
    /// Sets the request buffering property.
    /// If true, in cases where the request body/stream doesn't support seeking the request data will be buffered.
    /// This can help in situations where an authentication challenge might be expected.
    /// </summary>
    /// <param name="buffer_request">True to turn on buffer, false otherwise.</param>
    /// <remarks>Please note there is a performance cost due to copying the request data.</remarks>
    void set_buffer_request(bool buffer_request) { m_buffer_request = buffer_request; }
#endif

    /// <summary>
    /// Get the maximum number of redirects to follow automatically.
    /// A value of 0 indicates that no automatic redirection is performed.
    /// </summary>
    /// <returns>The maximum number of redirects to follow automatically.</returns>
    /// <remarks>This is a hint -- an implementation may enforce a lower value.</remarks>
    size_t max_redirects() const { return m_max_redirects; }

    /// <summary>
    /// Set the maximum number of redirects to follow automatically.
    /// A value of 0 indicates that no automatic redirection is performed.
    /// </summary>
    /// <param name="max_redirects">The maximum number of redirects to follow automatically.</param>
    /// <remarks>This is a hint -- an implementation may enforce a lower value.</remarks>
    void set_max_redirects(size_t max_redirects) { m_max_redirects = max_redirects; }

    /// <summary>
    /// Checks if HTTPS to HTTP redirects are automatically followed.
    /// </summary>
    /// <returns>True if HTTPS to HTTP redirects are automatically followed, false otherwise.</returns>
    bool https_to_http_redirects() const { return m_https_to_http_redirects; }

    /// <summary>
    /// Sets if HTTPS to HTTP redirects are automatically followed.
    /// </summary>
    /// <param name="https_to_http_redirects">True if HTTPS to HTTP redirects are to be automatically
    /// followed, false otherwise.</param>
    void set_https_to_http_redirects(bool https_to_http_redirects)
    {
        m_https_to_http_redirects = https_to_http_redirects;
    }

    /// <summary>
    /// Sets a callback to enable custom setting of platform specific options.
    /// </summary>
    /// <remarks>
    /// The native_handle is the following type depending on the underlying platform:
    ///     Windows Desktop, WinHTTP - HINTERNET (session)
    /// </remarks>
    /// <param name="callback">A user callback allowing for customization of the session</param>
    void set_nativesessionhandle_options(const std::function<void(native_handle)>& callback)
    {
        m_set_user_nativesessionhandle_options = callback;
    }

    /// <summary>
    /// Invokes a user's callback to allow for customization of the session.
    /// </summary>
    /// <remarks>Internal Use Only</remarks>
    /// <param name="handle">A internal implementation handle.</param>
    void _invoke_nativesessionhandle_options(native_handle handle) const
    {
        if (m_set_user_nativesessionhandle_options) m_set_user_nativesessionhandle_options(handle);
    }

    /// <summary>
    /// Sets a callback to enable custom setting of platform specific options.
    /// </summary>
    /// <remarks>
    /// The native_handle is the following type depending on the underlying platform:
    ///     Windows Desktop, WinHTTP - HINTERNET
    ///     Windows Runtime, WinRT - IXMLHTTPRequest2 *
    ///     All other platforms, Boost.Asio:
    ///         https - boost::asio::ssl::stream<boost::asio::ip::tcp::socket &> *
    ///         http - boost::asio::ip::tcp::socket *
    /// </remarks>
    /// <param name="callback">A user callback allowing for customization of the request</param>
    void set_nativehandle_options(const std::function<void(native_handle)>& callback)
    {
        m_set_user_nativehandle_options = callback;
    }

    /// <summary>
    /// Invokes a user's callback to allow for customization of the request.
    /// </summary>
    /// <param name="handle">A internal implementation handle.</param>
    void invoke_nativehandle_options(native_handle handle) const
    {
        if (m_set_user_nativehandle_options) m_set_user_nativehandle_options(handle);
    }


    /// <summary>
    /// Set the certificate chain callback. If set, HTTP client will call this callback in a blocking manner during HTTP
    /// connection.
    /// </summary>
    void set_user_certificate_chain_callback(const CertificateChainFunction& callback)
    {
        m_certificate_chain_callback = callback;
    }

    /// <summary>
    /// Invokes the certificate chain callback.
    /// </summary>
    /// <param name="certificate_info">Pointer to the certificate_info struct that has the certificate
    /// information.</param> <returns>True if the consumer code allows the connection, false otherwise. False will
    /// terminate the HTTP connection.</returns>
    bool invoke_certificate_chain_callback(const std::shared_ptr<certificate_info>& certificate_Info) const
    {
        return m_certificate_chain_callback(certificate_Info);
    }

#if !defined(_WIN32) && !defined(__cplusplus_winrt) || defined(CPPREST_FORCE_HTTP_CLIENT_ASIO)
    /// <summary>
    /// Sets a callback to enable custom setting of the ssl context, at construction time.
    /// </summary>
    /// <param name="callback">A user callback allowing for customization of the ssl context at construction
    /// time.</param>
    void set_ssl_context_callback(const std::function<void(boost::asio::ssl::context&)>& callback)
    {
        m_ssl_context_callback = callback;
    }

    /// <summary>
    /// Gets the user's callback to allow for customization of the ssl context.
    /// </summary>
    const std::function<void(boost::asio::ssl::context&)>& get_ssl_context_callback() const
    {
        return m_ssl_context_callback;
    }

    /// <summary>
    /// Gets the TLS extension server name indication (SNI) status.
    /// </summary>
    /// <returns>True if TLS server name indication is enabled, false otherwise.</returns>
    bool is_tlsext_sni_enabled() const { return m_tlsext_sni_enabled; }

    /// <summary>
    /// Sets the TLS extension server name indication (SNI) status.
    /// </summary>
    /// <param name="tlsext_sni_enabled">False to disable the TLS (ClientHello) extension for server name indication,
    /// true otherwise.</param> <remarks>Note: This setting is enabled by default as it is required in most virtual
    /// hosting scenarios.</remarks>
    void set_tlsext_sni_enabled(bool tlsext_sni_enabled) { m_tlsext_sni_enabled = tlsext_sni_enabled; }
#endif

private:
#if _WIN32_WINNT >= _WIN32_WINNT_VISTA
    std::shared_ptr<oauth1::experimental::oauth1_config> m_oauth1;
#endif

    std::shared_ptr<oauth2::experimental::oauth2_config> m_oauth2;
    web_proxy m_proxy;
    http::client::credentials m_credentials;
    // Whether or not to guarantee ordering, i.e. only using one underlying TCP connection.
    bool m_guarantee_order;

    std::chrono::microseconds m_timeout;
    size_t m_chunksize;
    bool m_request_compressed;

#if !defined(__cplusplus_winrt)
    // IXmlHttpRequest2 doesn't allow configuration of certificate verification.
    bool m_validate_certificates;
#endif

    CertificateChainFunction m_certificate_chain_callback;
    std::function<void(native_handle)> m_set_user_nativehandle_options;
    std::function<void(native_handle)> m_set_user_nativesessionhandle_options;

#if !defined(_WIN32) && !defined(__cplusplus_winrt) || defined(CPPREST_FORCE_HTTP_CLIENT_ASIO)
    std::function<void(boost::asio::ssl::context&)> m_ssl_context_callback;
    bool m_tlsext_sni_enabled;
#endif
#if (defined(_WIN32) && !defined(__cplusplus_winrt)) || defined(CPPREST_FORCE_HTTP_CLIENT_WINHTTPPAL)
    bool m_buffer_request;
#endif

    size_t m_max_redirects;
    bool m_https_to_http_redirects;
};

class http_pipeline;

/// <summary>
/// HTTP client class, used to maintain a connection to an HTTP service for an extended session.
/// </summary>
class http_client
{
public:
    /// <summary>
    /// Creates a new http_client connected to specified uri.
    /// </summary>
    /// <param name="base_uri">A string representation of the base uri to be used for all requests. Must start with
    /// either "http://" or "https://"</param>
    _ASYNCRTIMP http_client(const uri& base_uri);

    /// <summary>
    /// Creates a new http_client connected to specified uri.
    /// </summary>
    /// <param name="base_uri">A string representation of the base uri to be used for all requests. Must start with
    /// either "http://" or "https://"</param> <param name="client_config">The http client configuration object
    /// containing the possible configuration options to initialize the <c>http_client</c>. </param>
    _ASYNCRTIMP http_client(const uri& base_uri, const http_client_config& client_config);

    /// <summary>
    /// Note the destructor doesn't necessarily close the connection and release resources.
    /// The connection is reference counted with the http_responses.
    /// </summary>
    _ASYNCRTIMP ~http_client() CPPREST_NOEXCEPT;

    /// <summary>
    /// Gets the base URI.
    /// </summary>
    /// <returns>
    /// A base URI initialized in constructor
    /// </returns>
    _ASYNCRTIMP const uri& base_uri() const;

    /// <summary>
    /// Get client configuration object
    /// </summary>
    /// <returns>A reference to the client configuration object.</returns>
    _ASYNCRTIMP const http_client_config& client_config() const;

    /// <summary>
    /// Adds an HTTP pipeline stage to the client.
    /// </summary>
    /// <param name="handler">A function object representing the pipeline stage.</param>
    _ASYNCRTIMP void add_handler(const std::function<pplx::task<http_response> __cdecl(
                                     http_request, std::shared_ptr<http::http_pipeline_stage>)>& handler);

    /// <summary>
    /// Adds an HTTP pipeline stage to the client.
    /// </summary>
    /// <param name="stage">A shared pointer to a pipeline stage.</param>
    _ASYNCRTIMP void add_handler(const std::shared_ptr<http::http_pipeline_stage>& stage);

    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="request">Request to send.</param>
    /// <param name="token">Cancellation token for cancellation of this request operation.</param>
    /// <returns>An asynchronous operation that is completed once a response from the request is received.</returns>
    _ASYNCRTIMP pplx::task<http_response> request(
        http_request request, const pplx::cancellation_token& token = pplx::cancellation_token::none());

    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="token">Cancellation token for cancellation of this request operation.</param>
    /// <returns>An asynchronous operation that is completed once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="token">Cancellation token for cancellation of this request operation.</param>
    /// <returns>An asynchronous operation that is completed once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utility::string_t& path_query_fragment,
                                      const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        msg.set_request_uri(path_query_fragment);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body_data">The data to be used as the message body, represented using the json
    /// object library.</param> <param name="token">Cancellation token for cancellation of this request
    /// operation.</param> <returns>An asynchronous operation that is completed once a response from the request is
    /// received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utility::string_t& path_query_fragment,
                                      const json::value& body_data,
                                      const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        msg.set_request_uri(path_query_fragment);
        msg.set_body(body_data);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request with a string body. Assumes the
    /// character encoding of the string is UTF-8.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="content_type">A string holding the MIME type of the message body.</param> <param
    /// name="body_data">String containing the text to use in the message body.</param> <param name="token">Cancellation
    /// token for cancellation of this request operation.</param> <returns>An asynchronous operation that is completed
    /// once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utf8string& path_query_fragment,
                                      const utf8string& body_data,
                                      const utf8string& content_type = "text/plain; charset=utf-8",
                                      const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        msg.set_request_uri(::utility::conversions::to_string_t(path_query_fragment));
        msg.set_body(body_data, content_type);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request with a string body. Assumes the
    /// character encoding of the string is UTF-8.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="content_type">A string holding the MIME type of the message body.</param> <param
    /// name="body_data">String containing the text to use in the message body.</param> <param name="token">Cancellation
    /// token for cancellation of this request operation.</param> <returns>An asynchronous operation that is completed
    /// once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utf8string& path_query_fragment,
                                      utf8string&& body_data,
                                      const utf8string& content_type = "text/plain; charset=utf-8",
                                      const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        msg.set_request_uri(::utility::conversions::to_string_t(path_query_fragment));
        msg.set_body(std::move(body_data), content_type);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request with a string body. Assumes the
    /// character encoding of the string is UTF-16 will perform conversion to UTF-8.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="content_type">A string holding the MIME type of the message body.</param> <param
    /// name="body_data">String containing the text to use in the message body.</param> <param name="token">Cancellation
    /// token for cancellation of this request operation.</param> <returns>An asynchronous operation that is completed
    /// once a response from the request is received.</returns>
    pplx::task<http_response> request(
        const method& mtd,
        const utf16string& path_query_fragment,
        const utf16string& body_data,
        const utf16string& content_type = utility::conversions::to_utf16string("text/plain"),
        const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        msg.set_request_uri(::utility::conversions::to_string_t(path_query_fragment));
        msg.set_body(body_data, content_type);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request with a string body. Assumes the
    /// character encoding of the string is UTF-8.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body_data">String containing the text to use in the message body.</param> <param
    /// name="token">Cancellation token for cancellation of this request operation.</param> <returns>An asynchronous
    /// operation that is completed once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utf8string& path_query_fragment,
                                      const utf8string& body_data,
                                      const pplx::cancellation_token& token)
    {
        return request(mtd, path_query_fragment, body_data, "text/plain; charset=utf-8", token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request with a string body. Assumes the
    /// character encoding of the string is UTF-8.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body_data">String containing the text to use in the message body.</param> <param
    /// name="token">Cancellation token for cancellation of this request operation.</param> <returns>An asynchronous
    /// operation that is completed once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utf8string& path_query_fragment,
                                      utf8string&& body_data,
                                      const pplx::cancellation_token& token)
    {
        http_request msg(mtd);
        msg.set_request_uri(::utility::conversions::to_string_t(path_query_fragment));
        msg.set_body(std::move(body_data), "text/plain; charset=utf-8");
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request with a string body. Assumes
    /// the character encoding of the string is UTF-16 will perform conversion to UTF-8.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body_data">String containing the text to use in the message body.</param> <param
    /// name="token">Cancellation token for cancellation of this request operation.</param> <returns>An asynchronous
    /// operation that is completed once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utf16string& path_query_fragment,
                                      const utf16string& body_data,
                                      const pplx::cancellation_token& token)
    {
        return request(
            mtd, path_query_fragment, body_data, ::utility::conversions::to_utf16string("text/plain"), token);
    }

#if !defined(__cplusplus_winrt)
    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body">An asynchronous stream representing the body data.</param> <param
    /// name="content_type">A string holding the MIME type of the message body.</param> <param name="token">Cancellation
    /// token for cancellation of this request operation.</param> <returns>A task that is completed once a response from
    /// the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utility::string_t& path_query_fragment,
                                      const concurrency::streams::istream& body,
                                      const utility::string_t& content_type = _XPLATSTR("application/octet-stream"),
                                      const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        msg.set_request_uri(path_query_fragment);
        msg.set_body(body, content_type);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body">An asynchronous stream representing the body data.</param> <param
    /// name="token">Cancellation token for cancellation of this request operation.</param> <returns>A task that is
    /// completed once a response from the request is received.</returns>
    pplx::task<http_response> request(const method& mtd,
                                      const utility::string_t& path_query_fragment,
                                      const concurrency::streams::istream& body,
                                      const pplx::cancellation_token& token)
    {
        return request(mtd, path_query_fragment, body, _XPLATSTR("application/octet-stream"), token);
    }
#endif // __cplusplus_winrt

    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body">An asynchronous stream representing the body data.</param> <param
    /// name="content_length">Size of the message body.</param> <param name="content_type">A string holding the MIME
    /// type of the message body.</param> <param name="token">Cancellation token for cancellation of this request
    /// operation.</param> <returns>A task that is completed once a response from the request is received.</returns>
    /// <remarks>Winrt requires to provide content_length.</remarks>
    pplx::task<http_response> request(const method& mtd,
                                      const utility::string_t& path_query_fragment,
                                      const concurrency::streams::istream& body,
                                      size_t content_length,
                                      const utility::string_t& content_type = _XPLATSTR("application/octet-stream"),
                                      const pplx::cancellation_token& token = pplx::cancellation_token::none())
    {
        http_request msg(mtd);
        msg.set_request_uri(path_query_fragment);
        msg.set_body(body, content_length, content_type);
        return request(msg, token);
    }

    /// <summary>
    /// Asynchronously sends an HTTP request.
    /// </summary>
    /// <param name="mtd">HTTP request method.</param>
    /// <param name="path_query_fragment">String containing the path, query, and fragment, relative to the http_client's
    /// base URI.</param> <param name="body">An asynchronous stream representing the body data.</param> <param
    /// name="content_length">Size of the message body.</param> <param name="token">Cancellation token for cancellation
    /// of this request operation.</param> <returns>A task that is completed once a response from the request is
    /// received.</returns> <remarks>Winrt requires to provide content_length.</remarks>
    pplx::task<http_response> request(const method& mtd,
                                      const utility::string_t& path_query_fragment,
                                      const concurrency::streams::istream& body,
                                      size_t content_length,
                                      const pplx::cancellation_token& token)
    {
        return request(mtd, path_query_fragment, body, content_length, _XPLATSTR("application/octet-stream"), token);
    }

private:
    std::shared_ptr<::web::http::client::http_pipeline> m_pipeline;
};

namespace details
{
#if defined(_WIN32) || defined(CPPREST_FORCE_HTTP_CLIENT_WINHTTPPAL)
extern const utility::char_t* get_with_body_err_msg;
#endif

} // namespace details

} // namespace client
} // namespace http
} // namespace web

#endif