Table of Contents

Class MqttMsgConnack

Namespace
nanoFramework.M2Mqtt.Messages
Assembly
nanoFramework.M2Mqtt.dll

Class for CONNACK message from broker to client

public class MqttMsgConnack : MqttMsgBase
Inheritance
MqttMsgConnack
Inherited Members
Extension Methods

Constructors

MqttMsgConnack()

Constructor

public MqttMsgConnack()

Properties

AssignedClientIdentifier

The client ID to use to connect to the server. This must replace the initial Client ID used for the connection, v5.0 only

public string AssignedClientIdentifier { get; set; }

Property Value

string

AuthenticationData

Authentication Data, v5.0 only

public byte[] AuthenticationData { get; set; }

Property Value

byte[]

AuthenticationMethod

Authentication Method, v5.0 only

public string AuthenticationMethod { get; set; }

Property Value

string

MaximumQoS

True if there is a maximum QoS, v5.0 only

public bool MaximumQoS { get; set; }

Property Value

bool

Reason

The Reason as a string, v5.0 only

public string Reason { get; set; }

Property Value

string

ReceiveMaximum

Receive Maximum, v5.0 only

public ushort ReceiveMaximum { get; set; }

Property Value

ushort

ResponseInformation

Used as the basis for creating a Response Topic, v5.0 only

public string ResponseInformation { get; set; }

Property Value

string

RetainAvailable

True if retain is available, v5.0 only

public bool RetainAvailable { get; set; }

Property Value

bool

ReturnCode

Return Code

public MqttReasonCode ReturnCode { get; set; }

Property Value

MqttReasonCode

ServerKeepAlive

Use this value instead of the one present in the client sent on Connect, v5.0 only

public ushort ServerKeepAlive { get; set; }

Property Value

ushort

ServerReference

Used by the Client to identify another Server to use, v5.0 only

public string ServerReference { get; set; }

Property Value

string

SessionExpiryInterval

Session Expiry Interval, v5.0 only

public uint SessionExpiryInterval { get; set; }

Property Value

uint

SessionPresent

Session present flag

public bool SessionPresent { get; set; }

Property Value

bool

SharedSubscriptionAvailable

True if Shared Subscription are Available on the server, v5.0 only

public bool SharedSubscriptionAvailable { get; set; }

Property Value

bool

SubscriptionIdentifiersAvailable

True if Subscription Identifiers are Available on the server, v5.0 only

public bool SubscriptionIdentifiersAvailable { get; set; }

Property Value

bool

TopicAliasMaximum

TopicAliasMaximum, v5.0 only

public ushort TopicAliasMaximum { get; set; }

Property Value

ushort

WildcardSubscriptionAvailable

True if Wildcard Subscription are Available on the server, v5.0 only

public bool WildcardSubscriptionAvailable { get; set; }

Property Value

bool

Methods

GetBytes(MqttProtocolVersion)

Returns the bytes that represents the current object.

public override byte[] GetBytes(MqttProtocolVersion protocolVersion)

Parameters

protocolVersion MqttProtocolVersion

MQTT protocol version

Returns

byte[]

An array of bytes that represents the current object.

Parse(byte, MqttProtocolVersion, IMqttNetworkChannel)

Parse bytes for a CONNACK message

public static MqttMsgConnack Parse(byte fixedHeaderFirstByte, MqttProtocolVersion protocolVersion, IMqttNetworkChannel channel)

Parameters

fixedHeaderFirstByte byte

First fixed header byte

protocolVersion MqttProtocolVersion

Protocol Version

channel IMqttNetworkChannel

Channel connected to the broker

Returns

MqttMsgConnack

CONNACK message instance

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.