Class RustPlusSocketOptions

Namespace

RustPlusApi

Assembly

RustPlusApi.dll

Tuning options for RustPlusSocket. All values have sensible defaults; pass an instance to the RustPlus constructor only when the defaults don't fit (slow servers, aggressive NATs, latency-sensitive tooling). Configure the instance at construction and treat it as fixed afterwards — the client never mutates it.

public sealed class RustPlusSocketOptions

Inheritance

object

RustPlusSocketOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

KeepAliveInterval

The WebSocket keep-alive ping interval. Default: 20 seconds.

public TimeSpan KeepAliveInterval { get; set; }

Property Value

TimeSpan

ReceiveBufferSize

The receive buffer size in bytes. Map images arrive as multi-megabyte messages, so a larger buffer means far fewer reads per message. Default: 64 KB.

public int ReceiveBufferSize { get; set; }

Property Value

int

RequestTimeout

How long a request waits for its response before faulting with a TimeoutException. Default: 30 seconds.

public TimeSpan RequestTimeout { get; set; }

Property Value

TimeSpan

TeardownTimeout

Bounds teardown waits (graceful close, loop shutdown, pending-request drain) so a wedged loop or dead peer can never hang disposal. Default: 5 seconds.

public TimeSpan TeardownTimeout { get; set; }

Property Value

TimeSpan