win_http_transport.hpp

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/core/context.hpp"
#include "azure/core/http/http.hpp"
#include "azure/core/http/policies/policy.hpp"
#include "azure/core/http/transport.hpp"
#include "azure/core/internal/unique_handle.hpp"
#include "azure/core/nullable.hpp"
#include "azure/core/url.hpp"
 
#include <memory>
#include <string>
#include <vector>
 
namespace Azure { namespace Core { namespace Http {
  namespace _detail {
    class WinHttpRequest;
  }
 
  struct WinHttpTransportOptions final
  {
    bool IgnoreUnknownCertificateAuthority{false};
 
    bool IgnoreInvalidCertificateCommonName{false};
 
    bool EnableSystemDefaultProxy{false};
 
    bool EnableCertificateRevocationListCheck{false};
 
    std::string ProxyInformation;
 
    Azure::Nullable<std::string> ProxyUserName;
 
    Azure::Nullable<std::string> ProxyPassword;
 
    std::vector<std::string> ExpectedTlsRootCertificates;
  };
 
  class WinHttpTransport : public HttpTransport {
  private:
    WinHttpTransportOptions m_options;
    // m_sessionhandle is const to ensure immutability.
    const Azure::Core::_internal::UniqueHandle<void*> m_sessionHandle;
 
    Azure::Core::_internal::UniqueHandle<void*> CreateSessionHandle();
    Azure::Core::_internal::UniqueHandle<void*> CreateConnectionHandle(
        Azure::Core::Url const& url,
        Azure::Core::Context const& context);
 
    std::unique_ptr<_detail::WinHttpRequest> CreateRequestHandle(
        Azure::Core::_internal::UniqueHandle<void*> const& connectionHandle,
        Azure::Core::Url const& url,
        Azure::Core::Http::HttpMethod const& method);
 
    // Callback to allow a derived transport to extract the request handle. Used for WebSocket
    // transports.
    virtual void OnUpgradedConnection(std::unique_ptr<_detail::WinHttpRequest> const&){};
 
  public:
    WinHttpTransport(WinHttpTransportOptions const& options = WinHttpTransportOptions());
 
    WinHttpTransport(Azure::Core::Http::Policies::TransportOptions const& options);
 
    virtual std::unique_ptr<RawResponse> Send(Request& request, Context const& context) override;
 
    // See also:
    // [Core Guidelines C.35: "A base class destructor should be either public
    // and virtual or protected and
    // non-virtual"](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#c35-a-base-class-destructor-should-be-either-public-and-virtual-or-protected-and-non-virtual)
    virtual ~WinHttpTransport();
  };
 
}}} // namespace Azure::Core::Http