Class MqttClientTcpConfiguration
The configuration of the TCP connection to the MQTT message broker.
Inheritance
MqttClientTcpConfiguration
Assembly: Silverback.Integration.MQTT.dll
Syntax
public record MqttClientTcpConfiguration : MqttClientChannelConfiguration, IValidatableSettings, IEquatable<MqttClientChannelConfiguration>, IEquatable<MqttClientTcpConfiguration>
Constructors
MqttClientTcpConfiguration()
The configuration of the TCP connection to the MQTT message broker.
Declaration
public MqttClientTcpConfiguration()
MqttClientTcpConfiguration(MqttClientTcpConfiguration)
The configuration of the TCP connection to the MQTT message broker.
Declaration
protected MqttClientTcpConfiguration(MqttClientTcpConfiguration original)
Parameters
Properties
AddressFamily
Gets the address family of the underlying Socket.
Declaration
public AddressFamily AddressFamily { get; init; }
Property Value
BufferSize
Gets the size of both the receive and send buffers of the underlying Socket.
Declaration
public int BufferSize { get; init; }
Property Value
DualMode
Gets a value that specifies whether the underlying Socket is a dual-mode socket used for both IPv4 and IPv6.
Declaration
public bool? DualMode { get; init; }
Property Value
EqualityContract
The configuration of the TCP connection to the MQTT message broker.
Declaration
protected override Type EqualityContract { get; }
Property Value
Overrides
LingerState
Declaration
public LingerOption? LingerState { get; init; }
Property Value
LocalEndpoint
Gets the local endpoint (network card) which is used by the client. If null the OS will select the network card.
Declaration
public EndPoint? LocalEndpoint { get; init; }
Property Value
NoDelay
Gets a value indicating whether the underlying Socket is a dual-mode socket used for both IPv4 and IPv6.
Declaration
public bool NoDelay { get; init; }
Property Value
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.
Declaration
public ProtocolType ProtocolType { get; init; }
Property Value
RemoteEndpoint
Gets the remote endpoint (server).
Declaration
public EndPoint? RemoteEndpoint { get; init; }
Property Value
Methods
Equals(MqttClientChannelConfiguration?)
The configuration of the TCP connection to the MQTT message broker.
Declaration
public override sealed bool Equals(MqttClientChannelConfiguration? other)
Parameters
Returns
Overrides
Equals(MqttClientTcpConfiguration?)
The configuration of the TCP connection to the MQTT message broker.
Declaration
public virtual bool Equals(MqttClientTcpConfiguration? other)
Parameters
Returns
Equals(object?)
The configuration of the TCP connection to the MQTT message broker.
Declaration
public override bool Equals(object? obj)
Parameters
| Type |
Name |
Description |
| object |
obj |
|
Returns
Overrides
GetHashCode()
The configuration of the TCP connection to the MQTT message broker.
Declaration
public override int GetHashCode()
Returns
Overrides
PrintMembers(StringBuilder)
The configuration of the TCP connection to the MQTT message broker.
Declaration
protected override bool PrintMembers(StringBuilder builder)
Parameters
Returns
Overrides
ToString()
The configuration of the TCP connection to the MQTT message broker.
Declaration
public override string ToString()
Returns
Overrides
Validate()
Declaration
public override void Validate()
Overrides
Operators
operator ==(MqttClientTcpConfiguration?, MqttClientTcpConfiguration?)
The configuration of the TCP connection to the MQTT message broker.
Declaration
public static bool operator ==(MqttClientTcpConfiguration? left, MqttClientTcpConfiguration? right)
Parameters
Returns
operator !=(MqttClientTcpConfiguration?, MqttClientTcpConfiguration?)
The configuration of the TCP connection to the MQTT message broker.
Declaration
public static bool operator !=(MqttClientTcpConfiguration? left, MqttClientTcpConfiguration? right)
Parameters
Returns
Implements