azure-core
Public Member Functions | List of all members
Azure::Core::Http::WinHttpTransport Class Reference

Concrete implementation of an HTTP transport that uses WinHTTP when sending and receiving requests and responses over the wire.

#include <win_http_transport.hpp>

Inheritance diagram for Azure::Core::Http::WinHttpTransport:
Azure::Core::Http::HttpTransport

Public Member Functions

 WinHttpTransport (WinHttpTransportOptions const &options=WinHttpTransportOptions())
 Constructs WinHttpTransport. More...
 
 WinHttpTransport (Azure::Core::Http::Policies::TransportOptions const &options)
 Constructs WinHttpTransport. More...
 
virtual std::unique_ptr< RawResponseSend (Request &request, Context const &context) override
 Implements the HTTP transport interface to send an HTTP Request and produce an HTTP RawResponse. More...
 
- Public Member Functions inherited from Azure::Core::Http::HttpTransport
virtual ~HttpTransport ()
 Destructs HttpTransport.
 

Additional Inherited Members

- Protected Member Functions inherited from Azure::Core::Http::HttpTransport
 HttpTransport ()=default
 Constructs a default instance of HttpTransport.
 
 HttpTransport (const HttpTransport &other)=default
 Constructs HttpTransport by copying another instance of HttpTransport. More...
 
 HttpTransport (HttpTransport &&other)=default
 Constructs HttpTransport by moving another instance of HttpTransport. More...
 
HttpTransportoperator= (const HttpTransport &other)=default
 Assigns HttpTransport to another instance of HttpTransport. More...
 
virtual bool HasWebSocketSupport () const
 Returns true if the HttpTransport supports WebSockets (the ability to communicate bidirectionally on the TCP connection used by the HTTP transport).
 

Constructor & Destructor Documentation

◆ WinHttpTransport() [1/2]

WinHttpTransport::WinHttpTransport ( WinHttpTransportOptions const &  options = WinHttpTransportOptions())
Parameters
optionsOptional parameter to override the default settings.

◆ WinHttpTransport() [2/2]

WinHttpTransport::WinHttpTransport ( Azure::Core::Http::Policies::TransportOptions const &  options)
Parameters
optionsOptional parameter to override the default settings.

Constructs WinHttpTransport object based on common Azure HTTP Transport Options

Parameters
optionsCommon Azure Core Transport Options to override the default settings.

Member Function Documentation

◆ Send()

std::unique_ptr< RawResponse > WinHttpTransport::Send ( Request request,
Context const &  context 
)
overridevirtual
Parameters
contextA context to control the request lifetime.
requestan HTTP request to be send.
Returns
A unique pointer to an HTTP RawResponse.

Implements Azure::Core::Http::HttpTransport.


The documentation for this class was generated from the following files: