ClientId Property

A string that uniquely identifies this instance of the component to the server.

Syntax

public string ClientId { get; set; }
Public Property ClientId As String

Default Value

""

Remarks

The ClientId string is used by the server to uniquely identify each client that is connected to it. In MQTT 5, when the SessionExpInterval config is set to a positive value, the server will also associate it with any session state data that needs to be saved for the length of time specified when the component is disconnected.

If ClientId is empty when Connect is called, the component's behavior depends on value of CleanSession. If CleanSession is True, the component will automatically generate a unique value for ClientId before connecting. If CleanSession is False, the component throws an exception.

This property is not available at design time.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 .NET Edition - Version 20.0 [Build 8162]