Class MqttClientTcpConfiguration

Namespace

Silverback.Messaging.Configuration.Mqtt

Assembly

Silverback.Integration.MQTT.dll

The configuration of the TCP connection to the MQTT message broker.

public record MqttClientTcpConfiguration : MqttClientChannelConfiguration, IValidatableSettings, IEquatable<MqttClientChannelConfiguration>, IEquatable<MqttClientTcpConfiguration>

Inheritance

object

MqttClientChannelConfiguration

MqttClientTcpConfiguration

Implements

IValidatableSettings

IEquatable<MqttClientChannelConfiguration>

IEquatable<MqttClientTcpConfiguration>

Inherited Members

MqttClientChannelConfiguration.Tls

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

MqttClientTcpConfiguration()

public MqttClientTcpConfiguration()

MqttClientTcpConfiguration(MqttClientTcpConfiguration)

protected MqttClientTcpConfiguration(MqttClientTcpConfiguration original)

Parameters

original MqttClientTcpConfiguration

Properties

AddressFamily

Gets the address family of the underlying Socket.

public AddressFamily AddressFamily { get; init; }

Property Value

AddressFamily

BufferSize

Gets the size of both the receive and send buffers of the underlying Socket.

public int BufferSize { get; init; }

Property Value

int

DualMode

Gets a value that specifies whether the underlying Socket is a dual-mode socket used for both IPv4 and IPv6.

public bool? DualMode { get; init; }

Property Value

bool?

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

LingerState

Gets the LingerOption.

public LingerOption? LingerState { get; init; }

Property Value

LingerOption

LocalEndpoint

Gets the local endpoint (network card) which is used by the client. If null the OS will select the network card.

public EndPoint? LocalEndpoint { get; init; }

Property Value

EndPoint

NoDelay

Gets a value indicating whether the underlying Socket is a dual-mode socket used for both IPv4 and IPv6.

public bool NoDelay { get; init; }

Property Value

bool

ProtocolType

Gets the protocol type, usually TCP but when using other endpoint types like unix sockets it must be changed (IP for unix sockets). The default is Tcp.

public ProtocolType ProtocolType { get; init; }

Property Value

ProtocolType

RemoteEndpoint

Gets the remote endpoint (server).

public EndPoint? RemoteEndpoint { get; init; }

Property Value

EndPoint

Methods

Equals(MqttClientChannelConfiguration?)

public override sealed bool Equals(MqttClientChannelConfiguration? other)

Parameters

other MqttClientChannelConfiguration

Returns

bool

Equals(MqttClientTcpConfiguration?)

public virtual bool Equals(MqttClientTcpConfiguration? other)

Parameters

other MqttClientTcpConfiguration

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

public override void Validate()

Operators

operator ==(MqttClientTcpConfiguration?, MqttClientTcpConfiguration?)

public static bool operator ==(MqttClientTcpConfiguration? left, MqttClientTcpConfiguration? right)

Parameters

left MqttClientTcpConfiguration

right MqttClientTcpConfiguration

Returns

bool

operator !=(MqttClientTcpConfiguration?, MqttClientTcpConfiguration?)

public static bool operator !=(MqttClientTcpConfiguration? left, MqttClientTcpConfiguration? right)

Parameters

left MqttClientTcpConfiguration

right MqttClientTcpConfiguration

Returns

bool