Microsoft.AspNetCore.Connections.Abstractions

Represents the context for a connection.

Gets or sets a unique identifier to represent this connection in trace logs.

Gets the collection of features provided by the server and middleware available on this connection.

Gets or sets a key/value collection that can be used to share data within the scope of this connection.

Triggered when the client connection is closed.

Gets or sets the local endpoint for this connection.

Gets or sets the remote endpoint for this connection.

Aborts the underlying connection.

A describing the reason the connection is being terminated.

Releases resources for the underlying connection.

A that completes when resources have been released.

A default implementation for .

Initializes a new instance of .

The application services .

extensions.

Use the given .

The of the . The . The .

Add the given to the connection. If you aren't calling the next function, use instead. Prefer using for better performance as shown below:


            builder.Use((context, next) =>
            {
                return next(context);
            });

The . The middleware to add to the . The .

Add the given to the connection. If you aren't calling the next function, use instead.

The . The middleware to add to the . The .

Add the given to the connection.

The . The middleware to add to the . The .

Encapsulates all information about an individual connection.

Gets or sets the that can be used to read or write data on this connection.

Aborts the underlying connection.

A describing the reason the connection is being terminated.

Aborts the underlying connection.

A function that can process a connection.

A representing the connection. A that represents the connection lifetime. When the task completes, the connection will be closed.

Represents an endpoint that multiple connections connect to. For HTTP, endpoints are URLs, for non-HTTP it can be a TCP listener (or similar).

Called when a new connection is accepted to the endpoint.

The new A that represents the connection lifetime. When the task completes, the connection is complete.

The items associated with a given connection.

Initializes a new instance of .

Initializes a new instance of with .

The items for the connection.

Gets or sets the items for the connection.

The default implementation for the .

Creates the without Pipes to avoid upfront allocations. The caller is expected to set the and pipes manually.

The .

Creates the DefaultConnectionContext with the given and pipes.

The . The . The .

An exception that is thrown when there the current address Kestrel is trying to bind to is in use.

Initializes a new instance of .

The exception message.

Initializes a new instance of .

The exception message. The underlying .

An exception that is thrown when a connection is aborted by the server.

Initializes a new instance of .

The exception message.

Initializes a new instance of .

The exception message. The underlying .

An exception thrown when the connection is reset.

Initializes a new instance of .

The exception message.

Initializes a new instance of .

The exception message. The underlying .

Represents the completion action for a connection.

Registers a callback to be invoked after a connection has fully completed processing. This is intended for resource cleanup.

The callback to invoke after the connection has completed processing. The state to pass into the callback.

A feature that represents a connection endpoints.

Gets or sets the local .

Gets or sets the remote .

A feature that represents the connection heartbeat.

Registers the given to be called with the associated on each heartbeat of the connection.

The to invoke. The state for the .

The unique identifier for a given connection.

Gets or sets the connection identifier.

Indicates if the connection transport has an "inherent keep-alive", which means that the transport will automatically inform the client that it is still present.

The most common example of this feature is the Long Polling HTTP transport, which must (due to HTTP limitations) terminate each poll within a particular interval and return a signal indicating "the server is still here, but there is no data yet". This feature allows applications to add keep-alive functionality, but limit it only to transports that don't have some kind of inherent keep-alive.

Gets whether or not the connection has an inherent keep-alive concept.

A bag of items associated with a given connection.

Gets or sets the items associated with the connection.

Represents the lifetime of the connection.

Gets or sets the that is triggered when the connection is closed.

Terminates the current connection.

Enables graceful termination of the connection.

Gets or set an that will be triggered when closing the connection has been requested.

Requests the connection to be closed.

Provides access to tags added to the metrics connection counter. This feature isn't set if the counter isn't enabled.

Gets the tag collection.

Provides access to the connection's underlying .

Gets the underlying .

Provides access to the connection's underlying .

Gets the underlying .

The transport for the connection.

Gets or sets the transport for the connection.

The user associated with the connection.

Gets or sets the user associated with the connection.

The used by the connection.

Gets the used by the connection.

Provides access to a key/value collection that can be used to persist state between connections and requests. Whether a transport supports persisting state depends on the implementation. The transport must support pooling and reusing connection instances for state to be persisted. Because values added to persistent state can live in memory until a connection is no longer pooled, use caution when adding items to this collection to avoid excessive memory use.

Gets a key/value collection that can be used to persist state between connections and requests.

The error code for the protocol being used.

Gets or sets the error code. The property returns -1 if the error code hasn't been set.

Supports aborting individual sides of a connection stream.

Abort the read side of the connection stream.

The error code to send with the abort. A describing the reason to abort the read side of the connection stream.

Abort the write side of the connection stream.

The error code to send with the abort. A describing the reason to abort the write side of the connection stream.

Represents the close action for a stream.

Registers a callback to be invoked when a stream is closed. If the stream is already in a closed state, the callback will be run immediately.

The callback to invoke after the stream is closed. The state to pass into the callback.

The direction of a connection stream

Gets whether or not the connection stream can be read.

Gets whether or not the connection stream can be written.

Represents the identifier for the stream.

Gets the stream identifier.

Represents the details about the TLS handshake.

Gets the .

Gets the host name from the "server_name" (SNI) extension of the client hello if present. See RFC 6066.

Gets the .

Gets the cipher strength.

Gets the .

Gets the hash strength.

Gets the .

Gets the key exchange algorithm strength.

Gets the transfer format of the protocol.

Gets the supported .

Gets or sets the active .

Provides access to connection reconnect operations.

This feature is experimental.

Called when a connection reconnects. The new that application code should write to is passed in.

Allows disabling the reconnect feature so a reconnecting connection will not be allowed anymore.

An endpoint backed by an OS file handle.

Initializes a new instance of .

The file handle. The file handle type.

Gets the file handle.

Gets the file handle type.

Enumerates the types.

This API is unused and no longer supported.

Defines an interface that provides the mechanisms to configure a connection pipeline.

Gets the that provides access to the application's service container.

Adds a middleware delegate to the application's connection pipeline.

The middleware delegate. The .

Builds the delegate used by this application to process connections.

The connection handling delegate.

A factory abstraction for creating connections to an endpoint.

Creates a new connection to an endpoint.

The to connect to. The token to monitor for cancellation requests. The default value is . A that represents the asynchronous connect, yielding the for the new connection when completed.

Defines an interface that represents a listener bound to a specific .

The endpoint that was bound. This may differ from the requested endpoint, such as when the caller requested that any free port be selected.

Begins an asynchronous operation to accept an incoming connection.

The token to monitor for cancellation requests. A that completes when a connection is accepted, yielding the representing the connection.

Stops listening for incoming connections.

The token to monitor for cancellation requests. A that represents the un-bind operation.

Defines an interface that provides the mechanisms for binding to various types of s.

Creates an bound to the specified .

The to bind to. The token to monitor for cancellation requests. A that completes when the listener has been bound, yielding a representing the new listener.

Defines an interface that determines whether the listener factory supports binding to the specified .

This interface should be implemented by and types that want to control want endpoint instances they can bind to.

Returns a value that indicates whether the listener factory supports binding to the specified .

The to bind to. A value that indicates whether the listener factory supports binding to the specified .

Defines an interface that represents a listener bound to a specific .

The endpoint that was bound. This may differ from the requested endpoint, such as when the caller requested that any free port be selected.

Stops listening for incoming connections.

The token to monitor for cancellation requests. A that represents the un-bind operation.

Begins an asynchronous operation to accept an incoming connection.

A feature collection to pass options when accepting a connection. The token to monitor for cancellation requests. A that completes when a connection is accepted, yielding the representing the connection.

Defines an interface that provides the mechanisms to configure a connection pipeline.

Gets the that provides access to the application's service container.

Adds a middleware delegate to the application's connection pipeline.

The middleware delegate. The .

Builds the delegate used by this application to process connections.

The connection handling delegate.

A factory abstraction for creating connections to an endpoint.

Creates a new connection to an endpoint.

The to connect to. A feature collection to pass options when connecting. The token to monitor for cancellation requests. The default value is . A that represents the asynchronous connect, yielding the for the new connection when completed.

Defines an interface that provides the mechanisms for binding to various types of s.

Creates an bound to the specified .

The to bind to. A feature collection to pass options when binding. The token to monitor for cancellation requests. A that completes when the listener has been bound, yielding a representing the new listener.

A default implementation for .

Initializes a new instance of .

The application services .

Encapsulates all information about a multiplexed connection.

Asynchronously accept an incoming stream on the connection.

Creates an outbound connection

A function that can process a connection.

A representing the connection. A that represents the connection lifetime. When the task completes, the connection will be closed.

Represents a Named Pipe endpoint.

Initializes a new instance of the class.

The name of the pipe.

Initializes a new instance of the class.

The name of the pipe. The name of the remote computer to connect to, or "." to specify the local computer.

Gets the name of the remote computer. The server name must be ".", the local computer, when creating a server.

Gets the name of the pipe.

Gets the pipe name represented by this instance.

Per connection state used to determine the TLS options.

Information from the Client Hello message.

The information that was passed when registering the callback.

Information about an individual connection.

Options used to configure a per connection callback for TLS configuration.

The callback to invoke per connection. This property is required.

Optional application state to flow to the callback.

Gets or sets a list of ALPN protocols.

Represents the possible transfer formats.

A binary transport format.

A text transport format.

An defined by a .

Initializes a new instance of the class.

The defining the .

Instantiate a type with constructor arguments provided directly and/or from an .

The service provider used to resolve dependencies The type to activate Constructor arguments not provided by the . An activated object of type instanceType

Instantiate a type with constructor arguments provided directly and/or from an .

The type to activate The service provider used to resolve dependencies Constructor arguments not provided by the . An activated object of type T

Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.

The type of the service The service provider used to resolve dependencies The resolved service or created instance

Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.

The service provider The type of the service The resolved service or created instance