ListenOptions Class

Definition

Describes either an IPEndPoint, Unix domain socket path, or a file descriptor for an already open socket that Kestrel should bind to or open.

public ref class ListenOptions : Microsoft::AspNetCore::Server::Kestrel::Transport::Abstractions::Internal::IEndPointInformation
public ref class ListenOptions : Microsoft::AspNetCore::Connections::IConnectionBuilder, Microsoft::AspNetCore::Server::Kestrel::Transport::Abstractions::Internal::IEndPointInformation
public ref class ListenOptions : Microsoft::AspNetCore::Connections::IConnectionBuilder
public class ListenOptions : Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation
public class ListenOptions : Microsoft.AspNetCore.Connections.IConnectionBuilder, Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation
public class ListenOptions : Microsoft.AspNetCore.Connections.IConnectionBuilder
public class ListenOptions : Microsoft.AspNetCore.Connections.IConnectionBuilder, Microsoft.AspNetCore.Connections.IMultiplexedConnectionBuilder
type ListenOptions = class
    interface IEndPointInformation
type ListenOptions = class
    interface IEndPointInformation
    interface IConnectionBuilder
type ListenOptions = class
    interface IConnectionBuilder
type ListenOptions = class
    interface IConnectionBuilder
    interface IMultiplexedConnectionBuilder
Public Class ListenOptions
Implements IEndPointInformation
Public Class ListenOptions
Implements IConnectionBuilder, IEndPointInformation
Public Class ListenOptions
Implements IConnectionBuilder
Public Class ListenOptions
Implements IConnectionBuilder, IMultiplexedConnectionBuilder
Inheritance
ListenOptions
Implements
Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation IConnectionBuilder IMultiplexedConnectionBuilder

Properties

ApplicationServices

Gets the application IServiceProvider.

ConnectionAdapters

Gets the List<T> that allows each connection Stream to be intercepted and transformed. Configured by the UseHttps() and UseConnectionLogging(ListenOptions) extension methods.

DisableAltSvcHeader

Gets or sets a value that controls whether the "Alt-Svc" header is included with response headers. The "Alt-Svc" header is used by clients to upgrade HTTP/1.1 and HTTP/2 connections to HTTP/3.

The "Alt-Svc" header is automatically included with a response if Protocols has either HTTP/1.1 or HTTP/2 enabled, and HTTP/3 is enabled. If an "Alt-Svc" header value has already been set by the app then it isn't changed.

EndPoint

Gets the EndPoint.

FileHandle

A file descriptor for the socket to open. Only set if the ListenOptionsType is FileHandleEndPoint.

HandleType
IPEndPoint

The IPEndPoint to bind to. Only set if the ListenOptionsType is IPEndPoint.

KestrelServerOptions

Enables connection middleware to resolve and use services registered by the application during startup. Only set if accessed from the callback of a KestrelServerOptions Listen* method.

NoDelay

Set to false to enable Nagle's algorithm for all connections.

Protocols

The protocols enabled on this endpoint.

SocketPath

The absolute path to a Unix domain socket to bind to. Only set if the ListenOptionsType is UnixDomainSocketEndPoint.

Type

The type of interface being described: either an IPEndPoint, Unix domain socket path, or a file descriptor.

Methods

Build()

Builds the ConnectionDelegate.

ToString()

Returns a string that represents the current object.

Use(Func<ConnectionDelegate,ConnectionDelegate>)

Adds a middleware delegate to the connection pipeline. Configured by the UseHttps() and UseConnectionLogging(ListenOptions) extension methods.

Explicit Interface Implementations

IMultiplexedConnectionBuilder.Build()
IMultiplexedConnectionBuilder.Use(Func<MultiplexedConnectionDelegate,MultiplexedConnectionDelegate>)

Extension Methods

Run(IConnectionBuilder, Func<ConnectionContext,Task>)

Add the given middleware to the connection.

Use(IConnectionBuilder, Func<ConnectionContext,Func<Task>,Task>)

Add the given middleware to the connection.

UseConnectionHandler<TConnectionHandler>(IConnectionBuilder)

Use the given TConnectionHandlerConnectionHandler.

UseConnectionLogging(ListenOptions)

Emits verbose logs for bytes read from and written to the connection.

UseConnectionLogging(ListenOptions, String)

Emits verbose logs for bytes read from and written to the connection.

UseHttps(ListenOptions)

Configure Kestrel to use HTTPS with the default certificate if available. This will throw if no default certificate is configured.

UseHttps(ListenOptions, HttpsConnectionAdapterOptions)

Configure Kestrel to use HTTPS. This does not use default certificates or other defaults specified via config or ConfigureHttpsDefaults(Action<HttpsConnectionAdapterOptions>).

UseHttps(ListenOptions, TlsHandshakeCallbackOptions)

Configure Kestrel to use HTTPS. This does not use default certificates or other defaults specified via config or ConfigureHttpsDefaults(Action<HttpsConnectionAdapterOptions>).

UseHttps(ListenOptions, Action<HttpsConnectionAdapterOptions>)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, ServerOptionsSelectionCallback, Object)

Configure Kestrel to use HTTPS. This does not use default certificates or other defaults specified via config or ConfigureHttpsDefaults(Action<HttpsConnectionAdapterOptions>).

UseHttps(ListenOptions, ServerOptionsSelectionCallback, Object, TimeSpan)

Configure Kestrel to use HTTPS. This does not use default certificates or other defaults specified via config or ConfigureHttpsDefaults(Action<HttpsConnectionAdapterOptions>).

UseHttps(ListenOptions, StoreName, String)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, StoreName, String, Boolean)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, StoreName, String, Boolean, StoreLocation)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, StoreName, String, Boolean, StoreLocation, Action<HttpsConnectionAdapterOptions>)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, X509Certificate2)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, X509Certificate2, Action<HttpsConnectionAdapterOptions>)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, String)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, String, String)

Configure Kestrel to use HTTPS.

UseHttps(ListenOptions, String, String, Action<HttpsConnectionAdapterOptions>)

Configure Kestrel to use HTTPS.

UseHub<THub>(IConnectionBuilder)

Configure the connection to host the specified Hub type.

Applies to