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
type ListenOptions = class
    interface IEndPointInformation
type ListenOptions = class
    interface IEndPointInformation
    interface IConnectionBuilder
type ListenOptions = class
    interface IConnectionBuilder
Public Class ListenOptions
Implements IEndPointInformation
Public Class ListenOptions
Implements IConnectionBuilder, IEndPointInformation
Public Class ListenOptions
Implements IConnectionBuilder
Inheritance
ListenOptions
Implements

Properties

ApplicationServices
ConnectionAdapters

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

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()
ToString()
Use(Func<ConnectionDelegate,ConnectionDelegate>)

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

Extension Methods

Run(IConnectionBuilder, Func<ConnectionContext,Task>)
Use(IConnectionBuilder, Func<ConnectionContext,Func<Task>,Task>)
UseConnectionHandler<TConnectionHandler>(IConnectionBuilder)
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.

UseHttps(ListenOptions, Action<HttpsConnectionAdapterOptions>)

Configure Kestrel to use HTTPS.

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