Satori.HttpRequestAdapter Class Reference

HTTP Request adapter which uses the .NET HttpClient to send requests. More...

Inheritance diagram for Satori.HttpRequestAdapter:

Public Member Functions
	HttpRequestAdapter (HttpClient httpClient)
async Task< string >	SendAsync (string method, Uri uri, IDictionary< string, string > headers, byte[] body, int timeout, CancellationToken? userCancelToken)
	Send a HTTP request. Parameters method HTTP method to use for this request. uri The fully qualified URI to use. headers Request headers to set. body Request content body to set. timeoutSec Request timeout. userCancelToken A user-generated token that can be used to cancel the request. Returns A task which resolves to the contents of the response.

Static Public Member Functions
static IHttpAdapter	WithGzip (bool decompression=false, bool compression=false)
	A new HTTP adapter with configuration for gzip support in the underlying HTTP client.
static bool	IsTransientException (Exception e)

Properties
ILogger	Logger [get, set]
	The logger to use with the adapter.
TransientExceptionDelegate	TransientExceptionDelegate [get]
	A delegate used to determine whether or not an error from the server is due to a temporary bad state on the server (i.e., is 'transient').

Detailed Description

HTTP Request adapter which uses the .NET HttpClient to send requests.

Accept header is always set as 'application/json'.

Constructor & Destructor Documentation

HttpRequestAdapter()

Satori.HttpRequestAdapter.HttpRequestAdapter ( HttpClient httpClient )

inline

Member Function Documentation

IsTransientException()

bool Satori.HttpRequestAdapter.IsTransientException ( Exception e )

inlinestatic

SendAsync()

async Task< string > Satori.HttpRequestAdapter.SendAsync ( string method, Uri uri, IDictionary< string, string > headers, byte[] body, int timeout, CancellationToken? userCancelToken )

inline

Send a HTTP request.

Parameters

method	HTTP method to use for this request.
uri	The fully qualified URI to use.
headers	Request headers to set.
body	Request content body to set.
timeoutSec	Request timeout.
userCancelToken	A user-generated token that can be used to cancel the request.

Returns

A task which resolves to the contents of the response.

Implements Satori.IHttpAdapter.

WithGzip()

IHttpAdapter Satori.HttpRequestAdapter.WithGzip ( bool decompression = false, bool compression = false )

inlinestatic

A new HTTP adapter with configuration for gzip support in the underlying HTTP client.

NOTE Decompression does not work with Mono AOT on Android.

Parameters

decompression	If automatic decompression should be enabled with the HTTP adapter.
compression	If automatic compression should be enabled with the HTTP adapter.

Returns

A new HTTP adapter.

Property Documentation

Logger

ILogger Satori.HttpRequestAdapter.Logger

getset

The logger to use with the adapter.

Implements Satori.IHttpAdapter.

TransientExceptionDelegate

TransientExceptionDelegate Satori.HttpRequestAdapter.TransientExceptionDelegate

get

A delegate used to determine whether or not an error from the server is due to a temporary bad state on the server (i.e., is 'transient').

Implements Satori.IHttpAdapter.

---

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

• Satori/HttpRequestAdapter.cs