ClientId Property

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

Object Oriented Interface

public function getClientId();
public function setClientId($value);

Procedural Interface

ipworksiot_mqttsn_get($res, 2 );
ipworksiot_mqttsn_set($res, 2, $value );

Default Value

''

Remarks

The ClientId string is used by the server to uniquely identify each client that is connected to it.

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.

This property is not available at design time.

Data Type

String

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