Class MqttClientTcpOptions

Namespace

MQTTnet.Client

Assembly

MQTTnet.dll

public sealed class MqttClientTcpOptions : IMqttClientChannelOptions

Inheritance

object

MqttClientTcpOptions

Implements

IMqttClientChannelOptions

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MqttClientTcpOptions()

public MqttClientTcpOptions()

Properties

AddressFamily

public AddressFamily AddressFamily { get; set; }

Property Value

AddressFamily

BufferSize

public int BufferSize { get; set; }

Property Value

int

DualMode

Gets or sets whether the underlying socket should run in dual mode. Leaving this null will avoid setting this value at socket level. Setting this a value other than null will throw an exception when only IPv4 is supported on the machine.

public bool? DualMode { get; set; }

Property Value

bool?

LingerState

public LingerOption LingerState { get; set; }

Property Value

LingerOption

LocalEndpoint

Gets the local endpoint (network card) which is used by the client. Set it to null to let the OS select the network card.

public EndPoint LocalEndpoint { get; set; }

Property Value

EndPoint

NoDelay

Enables or disables the Nagle algorithm for the socket. This is only supported for TCP. For other protocol types the value is ignored. Default: true

public bool NoDelay { get; set; }

Property Value

bool

Port

[Obsolete("Use RemoteEndpoint or MqttClientOptionsBuilder instead.")]
public int? Port { get; set; }

Property Value

int?

ProtocolType

The MQTT transport is usually TCP but when using other endpoint types like unix sockets it must be changed (IP for unix sockets).

public ProtocolType ProtocolType { get; set; }

Property Value

ProtocolType

RemoteEndpoint

public EndPoint RemoteEndpoint { get; set; }

Property Value

EndPoint

Server

[Obsolete("Use RemoteEndpoint or MqttClientOptionsBuilder instead.")]
public string Server { get; set; }

Property Value

string

TlsOptions

public MqttClientTlsOptions TlsOptions { get; set; }

Property Value

MqttClientTlsOptions

Methods

ToString()

public override string ToString()

Returns

string