SocketTransportOptions Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets
Assembly:
Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.dll
Package:
Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets v2.1.0
Package:
Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
SocketTransportOptions.cs
Source:
SocketTransportOptions.cs
Source:
SocketTransportOptions.cs

Options for socket based transports.

public ref class SocketTransportOptions
public class SocketTransportOptions
type SocketTransportOptions = class
Public Class SocketTransportOptions
Inheritance
Object
SocketTransportOptions

Constructors

SocketTransportOptions()

Properties

Backlog

The maximum length of the pending connection queue.
CreateBoundListenSocket

A function used to create a new Socket to listen with. If not set, CreateDefaultBoundListenSocket(EndPoint) is used.
IOQueueCount

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

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

A value of null or 0 disables backpressure entirely allowing unlimited buffering. Unlimited server buffering is a security risk given untrusted clients.

MaxWriteBufferSize

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

A value of null or 0 disables backpressure entirely allowing unlimited buffering. Unlimited server buffering is a security risk given untrusted clients.

NoDelay

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

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

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

Methods

CreateDefaultBoundListenSocket(EndPoint)

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

Applies to