Language

HttpConnectionDispatcherOptions Class

Definition

Namespace:
Microsoft.AspNetCore.Http.Connections
Assembly:
Microsoft.AspNetCore.Http.Connections.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-rc.2.26504.105
Package:
Microsoft.AspNetCore.Http.Connections v1.0.0
Package:
Microsoft.AspNetCore.Http.Connections v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
HttpConnectionDispatcherOptions.cs
Source:
HttpConnectionDispatcherOptions.cs
Source:
HttpConnectionDispatcherOptions.cs

Options used to configure the HTTP connection dispatcher.

public ref class HttpConnectionDispatcherOptions
public class HttpConnectionDispatcherOptions
type HttpConnectionDispatcherOptions = class
Public Class HttpConnectionDispatcherOptions
Inheritance
Object
HttpConnectionDispatcherOptions

Constructors

Name Description
HttpConnectionDispatcherOptions()

Initializes a new instance of the HttpConnectionDispatcherOptions class.

Properties

Name Description
AllowStatefulReconnects

Set to allow connections to reconnect with the same ConnectionId.
ApplicationMaxBufferSize

Gets or sets the maximum buffer size for data written by the application before backpressure is applied.
AuthorizationData

Gets a collection of IAuthorizeData used during HTTP connection pipeline.
CloseOnAuthenticationExpiration

Authenticated connections whose token sets the ExpiresUtc value will be closed and allowed to reconnect when the token expires.
EnableAuthenticationRefresh

When set to true, enables the /refresh endpoint that allows clients to refresh their authentication token without disconnecting. The server will re-authenticate the request and update the connection's ClaimsPrincipal.
LongPolling

Gets the LongPollingOptions used by the long polling transport.
MaximumAuthenticationExpiration

Gets or sets the maximum amount of time, relative to now, that a refreshed authentication expiration is allowed to advance to, regardless of the expiration reported by the authentication ticket. Set to null to leave the ticket's own expiration (or lack of one) unmodified. When set, the value must be greater than Zero.
MinimumProtocolVersion

Gets or sets the minimum protocol version supported by the server. The default value is 0, the lowest possible protocol version.
OnAuthenticationRefresh

An optional callback invoked when the /refresh endpoint has successfully re-authenticated the request but before the connection's user is replaced. Return true to accept the new principal, or false to reject the refresh. When rejected, the endpoint responds with HTTP 403 and the connection's current user remains in place.
TransportMaxBufferSize

Gets or sets the maximum buffer size for data read by the application before backpressure is applied.
Transports

Gets or sets a bitmask combining one or more HttpTransportType values that specify what transports the server should use to receive HTTP requests.
TransportSendTimeout

Gets or sets the amount of time the transport will wait for a send to complete. If a single send exceeds this timeout the connection is closed.
WebSockets

Gets the WebSocketOptions used by the web sockets transport.

Applies to