Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

HttpBaseProtocolFilter class

Applies to Windows and Windows Phone

The base protocol filter for an HttpClient instance.

Syntax


public ref class HttpBaseProtocolFilter sealed : IHttpFilter,
    IClosable

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06030000)]

Members

The HttpBaseProtocolFilter class has these types of members:

Constructors

The HttpBaseProtocolFilter class has these constructors.

ConstructorDescription
HttpBaseProtocolFilter Initializes a new instance of the HttpBaseProtocolFilter class.

 

Methods

The HttpBaseProtocolFilter class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
Close [C++, JavaScript]Closes the HttpBaseProtocolFilter instance and releases allocated resources.
Dispose [C#, VB]Performs tasks associated with freeing, releasing, or resetting unmanaged resources.
SendRequestAsync Send an HTTP request using the HttpBaseProtocolFilter as an asynchronous operation.

 

Properties

The HttpBaseProtocolFilter class has these properties.

PropertyAccess typeDescription

AllowAutoRedirect

Read/writeGet or set a value that indicates whether the HttpBaseProtocolFilter should follow redirection responses.

AllowUI

Read/writeGet or set a value that indicates whether the HttpBaseProtocolFilter can prompt for user credentials when requested by the server.

AutomaticDecompression

Read/writeGets or sets a value that indicates whether the HttpBaseProtocolFilter can automatically decompress the HTTP content response.

CacheControl

Read-onlyGet or set the read and write cache control behavior to be used on the HttpBaseProtocolFilter object.

ClientCertificate

Read/writeGet or set the client SSL certificate that will be sent to the server if the server requests a client certificate.

CookieManager

Read-onlyGet the HttpCookieManager with the cookies associated with an app.

IgnorableServerCertificateErrors

Read-onlyGet a vector of SSL server certificate errors that the app might subsequently choose to ignore.

MaxConnectionsPerServer

Read/writeGet or set the maximum number of TCP connections allowed per HTTP server by the HttpBaseProtocolFilter object.

ProxyCredential

Read/writeGet or set the credentials to be used to negotiate with an HTTP proxy.

ServerCredential

Read/writeGet or set the credentials to be used to authenticate with an HTTP server.

UseProxy

Read/writeGet or set a value that indicates whether the HttpBaseProtocolFilter can use a proxy for sending HTTP requests.

 

Remarks

The HttpBaseProtocolFilter class provides the base filter or handler that is used by an HttpClient instance. If no additional filters are added to the HttpClient instance, then the HttpBaseProtocolFilter object will be the only filter.

The HttpBaseProtocolFilter class provides a set of properties for toggling various low-level HTTP stack behaviors.

Additional filters based on the IHttpFilter interface can be added to the filter chain applied to an HttpClient instance that can further handle or process the results from the HttpBaseProtocolFilter object.

The HttpBaseProtocolFilter object throws exceptions when sending HTTP requests or receiving response and network failures occur (loss of connectivity in airplane mode, for example). Developers using HttpClient in apps may prefer to add a filter to catch these exceptions and convert them to HTTP response codes instead.

Requirements

Minimum supported client

Windows 8.1 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Web.Http.Filters
Windows::Web::Http::Filters [C++]

Metadata

Windows.winmd

See also

IClosable
IHttpFilter
Object

 

 

Show:
© 2014 Microsoft. All rights reserved.