C++ Rest SDK
The C++ REST SDK is a Microsoft project for cloud-based client-server communication in native code using a modern asynchronous C++ API design. This project aims to help C++ developers connect to and interact with services.
Public Member Functions | Protected Member Functions | Friends | List of all members
web::http::http_pipeline_stage Class Referenceabstract

HTTP client handler class, used to represent an HTTP pipeline stage. More...

#include <http_msg.h>

Inheritance diagram for web::http::http_pipeline_stage:
web::http::client::details::http_network_handler web::http::details::function_pipeline_wrapper web::http::oauth1::details::oauth1_handler web::http::oauth2::details::oauth2_handler

Public Member Functions

virtual pplx::task< http_responsepropagate (http_request request)=0
 Runs this stage against the given request and passes onto the next stage. More...
 

Protected Member Functions

const std::shared_ptr< http_pipeline_stage > & next_stage () const
 Gets the next stage in the pipeline. More...
 
std::shared_ptr< http_pipeline_stagecurrent_stage ()
 Gets a shared pointer to this pipeline stage. More...
 

Friends

class http_pipeline
 

Detailed Description

HTTP client handler class, used to represent an HTTP pipeline stage.

When a request goes out, it passes through a series of stages, customizable by the application and/or libraries. The default stage will interact with lower-level communication layers to actually send the message on the network. When creating a client instance, an application may add pipeline stages in front of the already existing stages. Each stage has a reference to the next stage available in the

See also
http_pipeline_stage::next_stage Method

value.

Member Function Documentation

std::shared_ptr<http_pipeline_stage> web::http::http_pipeline_stage::current_stage ( )
inlineprotected

Gets a shared pointer to this pipeline stage.

Returns
A shared pointer to a pipeline stage.
const std::shared_ptr<http_pipeline_stage>& web::http::http_pipeline_stage::next_stage ( ) const
inlineprotected

Gets the next stage in the pipeline.

Returns
A shared pointer to a pipeline stage.
virtual pplx::task<http_response> web::http::http_pipeline_stage::propagate ( http_request  request)
pure virtual

Runs this stage against the given request and passes onto the next stage.

Parameters
requestThe HTTP request.
Returns
A task of the HTTP response.

Implemented in web::http::details::function_pipeline_wrapper, web::http::oauth1::details::oauth1_handler, web::http::oauth2::details::oauth2_handler, and web::http::client::details::http_network_handler.


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