Azure::Core::Http::Policies::HttpPolicy Class Reference

HTTP policy base class. More...

#include <policy.hpp>

Inherited by Azure::Core::Http::Policies::_internal::BearerTokenAuthenticationPolicy, Azure::Core::Http::Policies::_internal::LogPolicy, Azure::Core::Http::Policies::_internal::RequestActivityPolicy, Azure::Core::Http::Policies::_internal::RequestIdPolicy, Azure::Core::Http::Policies::_internal::RetryPolicy, Azure::Core::Http::Policies::_internal::TelemetryPolicy, and Azure::Core::Http::Policies::_internal::TransportPolicy.

Public Member Functions
virtual std::unique_ptr< RawResponse >	Send (Request &request, NextHttpPolicy nextPolicy, Context const &context) const =0
	Applies this HTTP policy. More...
virtual	~HttpPolicy ()
	Destructs HttpPolicy.
virtual std::unique_ptr< HttpPolicy >	Clone () const =0
	Creates a clone of this HttpPolicy. More...

Protected Member Functions
	HttpPolicy ()=default
	Constructs a default instance of HttpPolicy.
	HttpPolicy (const HttpPolicy &other)=default
	Constructs a copy of other HttpPolicy. More...
HttpPolicy &	operator= (const HttpPolicy &other)=default
	Assigns this HttpPolicy to copy the other. More...
	HttpPolicy (HttpPolicy &&other)=default
	Contructs HttpPolicy by moving other HttpPolicy. More...

Detailed Description

Note

An HTTP pipeline inside SDK clients is an stack sequence of HTTP policies.

See https://azure.github.io/azure-sdk/general_azurecore.html#the-http-pipeline.

Constructor & Destructor Documentation

HttpPolicy() [1/2]

Azure::Core::Http::Policies::HttpPolicy::HttpPolicy ( const HttpPolicy &  other )

protecteddefault

Parameters

other

Other HttpPolicy to copy.

HttpPolicy() [2/2]

Azure::Core::Http::Policies::HttpPolicy::HttpPolicy ( HttpPolicy &&  other )

protecteddefault

Parameters

other

Other HttpPolicy to move.

Member Function Documentation

Clone()

virtual std::unique_ptr<HttpPolicy> Azure::Core::Http::Policies::HttpPolicy::Clone ( ) const

pure virtual

Returns

A clone of this HttpPolicy.

operator=()

HttpPolicy& Azure::Core::Http::Policies::HttpPolicy::operator= ( const HttpPolicy &  other )

protecteddefault

Parameters

other

Other HttpPolicy to copy.

Returns

A reference to this HttpPolicy.

Send()

virtual std::unique_ptr<RawResponse> Azure::Core::Http::Policies::HttpPolicy::Send ( Request &  request, NextHttpPolicy  nextPolicy, Context const &  context  ) const

pure virtual

Parameters

request	An HTTP request being sent.
nextPolicy	The next HTTP to invoke after this policy has been applied.
context	A context to control the request lifetime.

Returns

An HTTP response after this policy, and all subsequent HTTP policies in the stack sequence of policies have been applied.

---

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

• inc/azure/core/http/policies/policy.hpp