/AWS1/CL_IOTTHINGCONNECTIVITY¶
The connectivity status of the thing.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_connected TYPE /AWS1/IOTBOOLEAN /AWS1/IOTBOOLEAN¶
True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.
iv_timestamp TYPE /AWS1/IOTCONNECTIVITYTIMESTAMP /AWS1/IOTCONNECTIVITYTIMESTAMP¶
The epoch time (in milliseconds) when the thing last connected or disconnected.
iv_disconnectreason TYPE /AWS1/IOTDISCONNECTREASON /AWS1/IOTDISCONNECTREASON¶
The reason that the client is disconnected.
iv_keepaliveduration TYPE /AWS1/IOTKEEPALIVEDURATION /AWS1/IOTKEEPALIVEDURATION¶
The keep-alive interval in seconds that the client specified when establishing the connection.
iv_cleansession TYPE /AWS1/IOTBOOLEAN /AWS1/IOTBOOLEAN¶
Indicates whether the client is using a clean session. Returns
truefor clean sessions.
iv_sessionexpiry TYPE /AWS1/IOTSESSIONEXPIRY /AWS1/IOTSESSIONEXPIRY¶
The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.
iv_clientid TYPE /AWS1/IOTCLIENTID /AWS1/IOTCLIENTID¶
The unique identifier of the MQTT client.
Queryable Attributes¶
connected¶
True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTED() |
Getter for CONNECTED, with configurable default |
ASK_CONNECTED() |
Getter for CONNECTED w/ exceptions if field has no value |
HAS_CONNECTED() |
Determine if CONNECTED has a value |
timestamp¶
The epoch time (in milliseconds) when the thing last connected or disconnected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIMESTAMP() |
Getter for TIMESTAMP, with configurable default |
ASK_TIMESTAMP() |
Getter for TIMESTAMP w/ exceptions if field has no value |
HAS_TIMESTAMP() |
Determine if TIMESTAMP has a value |
disconnectReason¶
The reason that the client is disconnected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISCONNECTREASON() |
Getter for DISCONNECTREASON, with configurable default |
ASK_DISCONNECTREASON() |
Getter for DISCONNECTREASON w/ exceptions if field has no va |
HAS_DISCONNECTREASON() |
Determine if DISCONNECTREASON has a value |
keepAliveDuration¶
The keep-alive interval in seconds that the client specified when establishing the connection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEEPALIVEDURATION() |
Getter for KEEPALIVEDURATION, with configurable default |
ASK_KEEPALIVEDURATION() |
Getter for KEEPALIVEDURATION w/ exceptions if field has no v |
HAS_KEEPALIVEDURATION() |
Determine if KEEPALIVEDURATION has a value |
cleanSession¶
Indicates whether the client is using a clean session. Returns
truefor clean sessions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLEANSESSION() |
Getter for CLEANSESSION, with configurable default |
ASK_CLEANSESSION() |
Getter for CLEANSESSION w/ exceptions if field has no value |
HAS_CLEANSESSION() |
Determine if CLEANSESSION has a value |
sessionExpiry¶
The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONEXPIRY() |
Getter for SESSIONEXPIRY, with configurable default |
ASK_SESSIONEXPIRY() |
Getter for SESSIONEXPIRY w/ exceptions if field has no value |
HAS_SESSIONEXPIRY() |
Determine if SESSIONEXPIRY has a value |
clientId¶
The unique identifier of the MQTT client.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTID() |
Getter for CLIENTID, with configurable default |
ASK_CLIENTID() |
Getter for CLIENTID w/ exceptions if field has no value |
HAS_CLIENTID() |
Determine if CLIENTID has a value |