Class MqttClientConnectResult

Namespace

MQTTnet.Client

Assembly

MQTTnet.dll

public sealed class MqttClientConnectResult

Inheritance

object

MqttClientConnectResult

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MqttClientConnectResult()

public MqttClientConnectResult()

Properties

AssignedClientIdentifier

Gets the client identifier which was chosen by the server. MQTTv5 only.

public string AssignedClientIdentifier { get; }

Property Value

string

AuthenticationData

Gets the authentication data. MQTTv5 only.

public byte[] AuthenticationData { get; }

Property Value

byte[]

AuthenticationMethod

Gets the authentication method. MQTTv5 only.

public string AuthenticationMethod { get; }

Property Value

string

IsSessionPresent

Gets a value indicating whether a session was already available or not. MQTTv5 only.

public bool IsSessionPresent { get; }

Property Value

bool

MaximumPacketSize

public uint? MaximumPacketSize { get; }

Property Value

uint?

MaximumQoS

Gets the maximum QoS which is supported by the server. MQTTv5 only.

public MqttQualityOfServiceLevel MaximumQoS { get; }

Property Value

MqttQualityOfServiceLevel

ReasonString

Gets the reason string. MQTTv5 only.

public string ReasonString { get; }

Property Value

string

ReceiveMaximum

public ushort? ReceiveMaximum { get; }

Property Value

ushort?

ResponseInformation

Gets the response information. MQTTv5 only.

public string ResponseInformation { get; }

Property Value

string

ResultCode

Gets the result code. MQTTv5 only.

public MqttClientConnectResultCode ResultCode { get; }

Property Value

MqttClientConnectResultCode

RetainAvailable

Gets whether the server supports retained messages. MQTTv5 only.

public bool RetainAvailable { get; }

Property Value

bool

ServerKeepAlive

MQTTv5 only. Gets the keep alive interval which was chosen by the server instead of the keep alive interval from the client CONNECT packet. A value of 0 indicates that the feature is not used.

public ushort ServerKeepAlive { get; }

Property Value

ushort

ServerReference

Gets an alternate server which should be used instead of the current one. MQTTv5 only.

public string ServerReference { get; }

Property Value

string

SessionExpiryInterval

public uint? SessionExpiryInterval { get; }

Property Value

uint?

SharedSubscriptionAvailable

Gets a value indicating whether the shared subscriptions are available or not. MQTTv5 only.

public bool SharedSubscriptionAvailable { get; }

Property Value

bool

SubscriptionIdentifiersAvailable

Gets a value indicating whether the subscription identifiers are available or not. MQTTv5 only.

public bool SubscriptionIdentifiersAvailable { get; }

Property Value

bool

TopicAliasMaximum

Gets the maximum value for a topic alias. 0 means not supported. MQTTv5 only.

public ushort TopicAliasMaximum { get; }

Property Value

ushort

UserProperties

Gets the user properties. In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT packet. As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add metadata to MQTT messages and pass information between publisher, broker, and subscriber. The feature is very similar to the HTTP header concept. MQTTv5 only.

public List<MqttUserProperty> UserProperties { get; }

Property Value

List<MqttUserProperty>

WildcardSubscriptionAvailable

Gets a value indicating whether wildcards can be used in subscriptions at the current server. MQTTv5 only.

public bool WildcardSubscriptionAvailable { get; }

Property Value

bool