SimpleWServerOptions

The SimpleWServerOptions allows you to pass configuration options to the main SimpleWServer class.

Socket options

/// <summary>
/// This option will set the maximum length of the pending connections queue.
/// </summary>
public int ListenBacklog { get; set; } = 1024;

/// <summary>
/// Specifies whether the Socket is a dual-mode socket used for both IPv4 and IPv6.
/// Will work only if socket is bound on IPv6 address.
/// </summary>
public bool DualMode { get; set; }

/// <summary>
/// This option will enable/disable Nagle's algorithm for TCP protocol
/// </summary>
public bool TcpNoDelay { get; set; }

/// <summary>
/// This option will enable/disable SO_REUSEADDR if the OS support this feature
/// </summary>
public bool ReuseAddress { get; set; }

/// <summary>
/// This option will enable/disable SO_EXCLUSIVEADDRUSE if the OS support this feature
/// </summary>
public bool ExclusiveAddressUse { get; set; }

/// <summary>
/// This option will enable SO_REUSEPORT if the OS support this feature (linux only)
/// </summary>
public bool ReusePort { get; set; }

/// <summary>
/// This option will run the accept socket on each machine's core
/// </summary>
public bool AcceptPerCore { get; set; }

/// <summary>
/// This option will setup SO_KEEPALIVE if the OS support this feature
/// </summary>
public bool TcpKeepAlive { get; set; }

/// <summary>
/// The number of seconds a TCP connection will remain alive/idle before keepalive probes are sent to the remote
/// </summary>
public int TcpKeepAliveTime { get; set; } = -1;

/// <summary>
/// The number of seconds a TCP connection will wait for a keepalive response before sending another keepalive probe
/// </summary>
public int TcpKeepAliveInterval { get; set; } = -1;

/// <summary>
/// The number of TCP keep alive probes that will be sent before the connection is terminated
/// </summary>
public int TcpKeepAliveRetryCount { get; set; } = -1;

/// <summary>
/// Option: receive buffer size
/// </summary>
public int ReceiveBufferSize { get; set; } = 16 * 1024;

Session options

/// <summary>
/// Idle timeout (if no data received during timeout, then close connection)
/// Set TimeSpan.MinValue to disable.
/// </summary>
public TimeSpan SessionTimeout { get; set; } = TimeSpan.FromSeconds(30);

Security options

/// <summary>
/// Max size of request headers in bytes (default: 64 KB)
/// </summary>
public int MaxRequestHeaderSize { get; set; } = 64 * 1024;

/// <summary>
/// Max size of request body in bytes (default: 10 MB)
/// </summary>
public long MaxRequestBodySize { get; set; } = 10 * 1024 * 1024;

/// <summary>
/// Maximum time allowed to receive a complete HTTP request header block
/// Protects against slowloris attacks that send headers very slowly.
/// Use <see cref="TimeSpan.MinValue"/> to disable this protection.
/// Default recommended value: 5 seconds.
/// </summary>
public TimeSpan RequestHeadersTimeout { get; set; } = TimeSpan.FromSeconds(5);

/// <summary>
/// Minimum sustained body receive rate, in bytes per second,
/// required after <see cref="RequestBodyGracePeriod"/> has elapsed.
/// If the request body progresses slower than this rate, the connection
/// is considered too slow and will be closed.
/// Set 0 to disable this protection.
/// Default: 256 bytes/s.
/// </summary>
public int MinRequestBodyDataRateBytesPerSecond { get; set; } = 256;

/// <summary>
/// Grace period applied before enforcing
/// <see cref="MinRequestBodyDataRateBytesPerSecond"/>.
/// This gives the client a short time window before the minimum body
/// receive rate check begins.
/// Set <see cref="TimeSpan.Zero"/> for no grace period.
/// Default: 5 seconds.
/// </summary>
public TimeSpan RequestBodyGracePeriod { get; set; } = TimeSpan.FromSeconds(5);

Handler

/// <summary>
/// When a RequestAborted cancellation token is get inside an async handler,
/// a task is run periodically to poll the underlying socket
/// to detect when the client disconnects.
/// Default polling every 250ms (TimeSpan.Zero to disable)
/// </summary>
public TimeSpan SocketDisconnectPollInterval { get; set; } = TimeSpan.FromMilliseconds(250);