clientId (property)

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

Syntax

@property (nonatomic,readwrite,assign,getter=clientId,setter=setClientId:) NSString* clientId;
- (NSString*)clientId;
- (void)setClientId:(NSString*)newClientId;

public var clientId: String {
  get {...}
  set {...}
}

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 class is disconnected.

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 iOS Edition - Version 20.0 [Build 8265]