Class PipelineHandler

Namespace

Amazon.Runtime.Internal

Assembly

AWSSDK.Core.dll

An abstract pipeline handler that has implements IPipelineHandler, and has the default implmentation. This is the base class for most of the handler implementations.

public abstract class PipelineHandler : IPipelineHandler

Inheritance

object

PipelineHandler

Implements

IPipelineHandler

Derived

CallbackHandler

CredentialsRetriever

CSMCallAttemptHandler

CSMCallEventHandler

EndpointDiscoveryHandler

EndpointResolver

ErrorCallbackHandler

ErrorHandler

HttpHandler<TRequestContent>

Marshaller

MetricsHandler

RedirectHandler

RetryHandler

Signer

Unmarshaller

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PipelineHandler()

protected PipelineHandler()

Properties

InnerHandler

The inner handler which is called after the current handler completes it's processing.

public IPipelineHandler InnerHandler { get; set; }

Property Value

IPipelineHandler

Logger

The logger used to log messages.

public virtual ILogger Logger { get; set; }

Property Value

ILogger

OuterHandler

The outer handler which encapsulates the current handler.

public IPipelineHandler OuterHandler { get; set; }

Property Value

IPipelineHandler

Methods

AsyncCallback(IAsyncExecutionContext)

This callback method is called by the callback method of the inner handler as part of asynchronous processing after any underlying asynchronous operations complete.

public void AsyncCallback(IAsyncExecutionContext executionContext)

Parameters

executionContext IAsyncExecutionContext

The execution context, it contains the request and response context.

InvokeAsync(IAsyncExecutionContext)

Contains the processing logic for an asynchronous request invocation. This method should calls InnerHandler.InvokeSync to continue processing of the request by the pipeline.

public virtual IAsyncResult InvokeAsync(IAsyncExecutionContext executionContext)

Parameters

executionContext IAsyncExecutionContext

The execution context which contains both the requests and response context.

Returns

IAsyncResult

IAsyncResult which represent an async operation.

InvokeAsyncCallback(IAsyncExecutionContext)

This callback method contains the processing logic that should be executed after the underlying asynchronous operation completes. This method is called as part of a callback chain which starts from the InvokeAsyncCallback method of the bottommost handler and then invokes each callback method of the handler above it. This method calls OuterHandler.AsyncCallback to continue processing of the request by the pipeline, unless it's the topmost handler.

protected virtual void InvokeAsyncCallback(IAsyncExecutionContext executionContext)

Parameters

executionContext IAsyncExecutionContext

The execution context, it contains the request and response context.

InvokeSync(IExecutionContext)

Contains the processing logic for a synchronous request invocation. This method calls InnerHandler.InvokeSync to continue processing of the request by the pipeline.

public virtual void InvokeSync(IExecutionContext executionContext)

Parameters

executionContext IExecutionContext

The execution context which contains both the requests and response context.

LogMetrics(IExecutionContext)

Logs the metrics for the current execution context.

protected void LogMetrics(IExecutionContext executionContext)

Parameters

executionContext IExecutionContext

The execution context, it contains the request and response context.