ListenOptions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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::IEndPointInformationpublic ref class ListenOptions : Microsoft::AspNetCore::Connections::IConnectionBuilder, Microsoft::AspNetCore::Server::Kestrel::Transport::Abstractions::Internal::IEndPointInformationpublic ref class ListenOptions : Microsoft::AspNetCore::Connections::IConnectionBuilderpublic class ListenOptions : Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformationpublic class ListenOptions : Microsoft.AspNetCore.Connections.IConnectionBuilder, Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformationpublic class ListenOptions : Microsoft.AspNetCore.Connections.IConnectionBuilderpublic class ListenOptions : Microsoft.AspNetCore.Connections.IConnectionBuilder, Microsoft.AspNetCore.Connections.IMultiplexedConnectionBuildertype ListenOptions = class
interface IEndPointInformationtype ListenOptions = class
interface IEndPointInformation
interface IConnectionBuildertype ListenOptions = class
interface IConnectionBuildertype ListenOptions = class
interface IConnectionBuilder
interface IMultiplexedConnectionBuilderPublic Class ListenOptions
Implements IEndPointInformationPublic Class ListenOptions
Implements IConnectionBuilder, IEndPointInformationPublic Class ListenOptions
Implements IConnectionBuilderPublic 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 |
| 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 |
Explicit Interface Implementations
| IMultiplexedConnectionBuilder.Build() | |
| IMultiplexedConnectionBuilder.Use(Func<MultiplexedConnectionDelegate,MultiplexedConnectionDelegate>) |