Struct MessageBrokerClientTcpOptions

Namespace

LfrlAnvil.MessageBroker.Client

Assembly

LfrlAnvil.MessageBroker.Client.dll

Represents available TcpClient options during MessageBrokerClient creation.

public readonly record struct MessageBrokerClientTcpOptions : IEquatable<MessageBrokerClientTcpOptions>

Implements

IEquatable<MessageBrokerClientTcpOptions>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

MessageBrokerClientTcpOptions(IPEndPoint?, bool?, MemorySize?)

Represents available TcpClient options during MessageBrokerClient creation.

public MessageBrokerClientTcpOptions(IPEndPoint? LocalEndPoint, bool? NoDelay, MemorySize? SocketBufferSize)

Parameters

LocalEndPoint IPEndPoint

The IPEndPoint to bind the TCP socket to.

NoDelay bool?

Value that disables a delay when send or receive buffers are not full. Equal to false by default.

SocketBufferSize MemorySize?

The size of send and receive buffers. Equal to 65535 B by default. Value will be clamped to [1 B, 65535 B] range.

Properties

Default

Represents default options.

public static MessageBrokerClientTcpOptions Default { get; }

Property Value

MessageBrokerClientTcpOptions

LocalEndPoint

The IPEndPoint to bind the TCP socket to.

public IPEndPoint? LocalEndPoint { get; init; }

Property Value

IPEndPoint

NoDelay

Value that disables a delay when send or receive buffers are not full. Equal to false by default.

public bool? NoDelay { get; init; }

Property Value

bool?

SocketBufferSize

The size of send and receive buffers. Equal to 65535 B by default. Value will be clamped to [1 B, 65535 B] range.

public MemorySize? SocketBufferSize { get; init; }

Property Value

MemorySize?

Methods

SetLocalEndPoint(IPEndPoint?)

Allows to change LocalEndPoint.

[Pure]
public MessageBrokerClientTcpOptions SetLocalEndPoint(IPEndPoint? value)

Parameters

value IPEndPoint

New value.

Returns

MessageBrokerClientTcpOptions

New MessageBrokerClientTcpOptions instance.

SetNoDelay(bool?)

Allows to change NoDelay.

[Pure]
public MessageBrokerClientTcpOptions SetNoDelay(bool? value)

Parameters

value bool?

New value.

Returns

MessageBrokerClientTcpOptions

New MessageBrokerClientTcpOptions instance.

SetSocketBufferSize(MemorySize?)

Allows to change SocketBufferSize.

[Pure]
public MessageBrokerClientTcpOptions SetSocketBufferSize(MemorySize? value)

Parameters

value MemorySize?

New value.

Returns

MessageBrokerClientTcpOptions

New MessageBrokerClientTcpOptions instance.