MQTTConnackProperties (STRUCT)ΒΆ

TYPE MQTTConnackProperties : STRUCT

Properties of CONNACK, AUTH and DISCONNECT packets (MQTT V5).

InOut:

Name

Type

Comment

udiSessionExpiryInterval

UDINT

Session Expiry Interval in seconds.

wsAssignedClientIdentifier

WSTRING

Assigned Client Identifier: If the Client connects using a zero length Client Identifier, the Server MUST respond with a CONNACK containing an Assigned Client Identifier.

uiServerKeepAlive

UINT

The Keep Alive is a time interval measured in seconds. It is the maximum time interval that is permitted to elapse between the point at which the Client finishes transmitting one MQTT Control Packet and the point it starts sending the next. The server Keep Alive interval overwrites the value of the input tPingInterval.

xAuthPacketReceived

BOOL

TRUE, if a AUTH Packet has been received. The data is stored in wsAuthenticationMethod, bAuthenticationData and udiAuthenticationDataSize. The ReasonCode is stored in MQTTClient.eReaonCode. The response to the server can be send via the method MQTTClient.SendAuth().

wsAuthenticationMethod

WSTRING

Name of the authentication method

bAuthenticationData

ARRAY [0..MQTTParam.g_udiMaxAuthDataSize] OF BYTE

Binary Data containing authentication data

udiAuthenticationDataSize

UDINT

Size of pbAuthenticationData

wsResponseInformation

WSTRING

Basis for Response Topics.

wsServerReference

WSTRING

String which can be used to identify another Server to use. The Server uses a Server Reference in either a CONNACK or DISCONNECT packet with Reason code of 0x9C (Use another server) or Reason Code 0x9D (Server moved).

wsReasonString

WSTRING

String representing the reason for the disconnect.

uiReceiveMaximum

UINT

The Server uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently for the Client.

uiTopicAliasMaximum

UINT

The maximum value of topic aliases.

bMaximumQoS

BYTE

Maximum allowed QoS of the server. A value of 255 means that the value has not been set.

bRetainAvailable

BYTE

Retain Available: A value of 0 means that retained messages are not supported. A value of 1 means retained messages are supported. A value of 255 means that the value has not been set.

udiMaximumPacketSize

UDINT

Maximum packet size of the server A value of 0 means that the value has not been set.

bWildcardSubscriptionAvailable

BYTE

Wildcard Subscription Available: A value is 0 means that Wildcard Subscriptions are not supported. A value of 1 means Wildcard Subscriptions are supported. A value of 255 means that the value has not been set.

bSubscriptionIdentifierAvailable

BYTE

Subscription Identifiers Available: A value is 0 means that Subscription Identifiers are not supported. A value of 1 means Subscription Identifiers are supported. A value of 255 means that the value has not been set.

bSharedSubscriptionAvailable

BYTE

Shared Subscription Available: A value of 1 means Shared 1356 Subscriptions are supported. If not present, then Shared Subscriptions are supported. A value of 255 means that the value has not been set.

userProperties

ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair

Received user prperties