Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets

A factory for socket based connections contexts.

Creates the .

The options. The logger.

Create a for a socket.

The socket for the connection.

Options for .

Create a new instance.

The number of I/O queues used to process requests. Set to 0 to directly schedule I/O to the ThreadPool.

Defaults to rounded down and clamped between 1 and 16.

Wait until there is data available to allocate a buffer. Setting this to false can increase throughput at the cost of increased memory usage.

Defaults to true.

Gets or sets the maximum unconsumed incoming bytes the transport will buffer.

Gets or sets the maximum outgoing bytes the transport will buffer before applying write backpressure.

Inline application and transport continuations instead of dispatching to the threadpool.

This will run application code on the IO thread which is why this is unsafe. It is recommended to set the DOTNET_SYSTEM_NET_SOCKETS_INLINE_COMPLETIONS environment variable to '1' when using this setting to also inline the completions at the runtime layer as well. This setting can make performance worse if there is expensive work that will end up holding onto the IO thread for longer than needed. Test to make sure this setting helps performance.

A factory for socket based connections.

Options for socket based transports.

The number of I/O queues used to process requests. Set to 0 to directly schedule I/O to the ThreadPool.

Defaults to rounded down and clamped between 1 and 16.

Wait until there is data available to allocate a buffer. Setting this to false can increase throughput at the cost of increased memory usage.

Defaults to true.

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

Defaults to true.

The maximum length of the pending connection queue.

Defaults to 512.

Gets or sets the maximum unconsumed incoming bytes the transport will buffer.

Gets or sets the maximum outgoing bytes the transport will buffer before applying write backpressure.

Inline application and transport continuations instead of dispatching to the threadpool.

This will run application code on the IO thread which is why this is unsafe. It is recommended to set the DOTNET_SYSTEM_NET_SOCKETS_INLINE_COMPLETIONS environment variable to '1' when using this setting to also inline the completions at the runtime layer as well. This setting can make performance worse if there is expensive work that will end up holding onto the IO thread for longer than needed. Test to make sure this setting helps performance.

A function used to create a new to listen with. If not set, is used.

Implementors are expected to call on the . Please note that calls as part of its implementation, so implementors using this method do not need to call it again.

Creates a default instance of for the given that can be used by a connection listener to listen for inbound requests. is called by this method.

An . A instance.

The Socket transport does not support binding to file handles. Consider using the libuv transport instead.

Only ListenType.IPEndPoint is supported by the Socket Transport. https://go.microsoft.com/fwlink/?linkid=874850

Transport is already bound.

extension methods to configure the Socket transport to be used by Kestrel.

Specify Sockets as the transport to be used by Kestrel.

The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure. The Microsoft.AspNetCore.Hosting.IWebHostBuilder.

Specify Sockets as the transport to be used by Kestrel.

The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure. A callback to configure Libuv options. The Microsoft.AspNetCore.Hosting.IWebHostBuilder.

Used to allocate and distribute re-usable blocks of memory.

This default value passed in to Rent to use the default value for the pool.

Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The individual blocks are then treated as independent array segments.

Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.

This object cannot be instantiated outside of the static Create method

Wraps an array allocated in the pinned object heap in a reusable block of managed memory

Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.

Used to allocate and distribute re-usable blocks of memory.

The size of a block. 4096 is chosen because most operating systems use 4k pages.

Max allocation block size for pooled blocks, larger values can be leased but they will be disposed after use rather than returned to the pool.

The size of a block. 4096 is chosen because most operating systems use 4k pages.

Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects and add them to this collection. When memory is requested it is taken from here first, and when it is returned it is re-added.

This is part of implementing the IDisposable pattern.

This default value passed in to Rent to use the default value for the pool.

Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return a new tracking object into the pool. This will only happen if there is a bug in the server, however it is necessary to avoid leaving "dead zones" in the slab due to lost block tracking objects.

The block to return. It must have been acquired by calling Lease on the same memory pool instance.