Class TcpDeviceOptions

Namespace

ProtoTest.Devices.Tcp

Assembly

ProtoTest.Devices.Tcp.dll

How the TCP transports connect, listen and read. Code sets defaults through the client registration (AddTcpClient(..., configure) or AddTcpListener(..., configure)); ProtoTest:Devices:Tcp overrides them per environment. One set applies to the whole run.

public sealed class TcpDeviceOptions : IProtoConfigurableOptions

Inheritance

object

TcpDeviceOptions

Implements

IProtoConfigurableOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ProtoConfigurableOptionsExtensions.BindFromConfiguration(IProtoConfigurableOptions, IConfiguration)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, bool, JsonSerializerOptions?)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Fields

ConfigurationSectionName

The configuration section this type binds from.

public const string ConfigurationSectionName = "ProtoTest:Devices:Tcp"

Field Value

string

Properties

AcceptTimeout

Gets or sets how long a listening device waits for the system under test to connect, counted from its first send or receive. Defaults to 30 seconds.

public TimeSpan AcceptTimeout { get; set; }

Property Value

TimeSpan

ConnectTimeout

Gets or sets how long a connection attempt may take. Defaults to 10 seconds.

public TimeSpan ConnectTimeout { get; set; }

Property Value

TimeSpan

MaxFrameBytes

Gets or sets the most bytes a receive buffers without completing a frame. Defaults to 1 MiB; more fails with a framing error that shows the first bytes, which usually means the framer is wrong.

public int MaxFrameBytes { get; set; }

Property Value

int

NoDelay

Gets or sets whether small writes go out at once instead of waiting to batch. Defaults to true.

public bool NoDelay { get; set; }

Property Value

bool

Methods

Validate()

Validates the resolved options once, after code callbacks and configuration have been applied. A bad value is a configuration error and must throw here rather than fail the first test that happens to use it. The default does nothing.

public void Validate()