/AWS1/CL_IOPGETCONNRESPONSE¶
GetConnectionResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_connected TYPE /AWS1/IOPCONNECTED /AWS1/IOPCONNECTED¶
The connection state of the client. Returns
trueif the client is currently connected, orfalseif the client is not connected.
iv_thingname TYPE /AWS1/IOPTHINGNAME /AWS1/IOPTHINGNAME¶
The name of the thing associated with the principal of the MQTT client, if applicable.
iv_cleansession TYPE /AWS1/IOPCLEANSESSION /AWS1/IOPCLEANSESSION¶
Indicates whether the client is using a clean session. Returns
truefor clean sessions orfalsefor persistent sessions.
iv_sourceip TYPE /AWS1/IOPSOURCEIP /AWS1/IOPSOURCEIP¶
The IP address of the client that initiated the connection.
iv_sourceport TYPE /AWS1/IOPSOURCEPORT /AWS1/IOPSOURCEPORT¶
The client's source port.
iv_targetip TYPE /AWS1/IOPTARGETIP /AWS1/IOPTARGETIP¶
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
iv_targetport TYPE /AWS1/IOPTARGETPORT /AWS1/IOPTARGETPORT¶
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
iv_keepaliveduration TYPE /AWS1/IOPKEEPALIVEDURATION /AWS1/IOPKEEPALIVEDURATION¶
The keep-alive interval in seconds that the client specified when establishing the connection.
iv_connectedsince TYPE /AWS1/IOPTIMESTAMP /AWS1/IOPTIMESTAMP¶
Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
iv_disconnectedsince TYPE /AWS1/IOPTIMESTAMP /AWS1/IOPTIMESTAMP¶
Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
iv_disconnectreason TYPE /AWS1/IOPDISCONNECTREASON /AWS1/IOPDISCONNECTREASON¶
The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
iv_sessionexpiry TYPE /AWS1/IOPSESSIONEXPIRY /AWS1/IOPSESSIONEXPIRY¶
The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
iv_clientid TYPE /AWS1/IOPCLIENTID /AWS1/IOPCLIENTID¶
The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.
iv_vpcendpointid TYPE /AWS1/IOPVPCENDPOINTID /AWS1/IOPVPCENDPOINTID¶
The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
Queryable Attributes¶
connected¶
The connection state of the client. Returns
trueif the client is currently connected, orfalseif the client is not connected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTED() |
Getter for CONNECTED |
thingName¶
The name of the thing associated with the principal of the MQTT client, if applicable.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THINGNAME() |
Getter for THINGNAME, with configurable default |
ASK_THINGNAME() |
Getter for THINGNAME w/ exceptions if field has no value |
HAS_THINGNAME() |
Determine if THINGNAME has a value |
cleanSession¶
Indicates whether the client is using a clean session. Returns
truefor clean sessions orfalsefor persistent sessions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLEANSESSION() |
Getter for CLEANSESSION |
sourceIp¶
The IP address of the client that initiated the connection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEIP() |
Getter for SOURCEIP, with configurable default |
ASK_SOURCEIP() |
Getter for SOURCEIP w/ exceptions if field has no value |
HAS_SOURCEIP() |
Determine if SOURCEIP has a value |
sourcePort¶
The client's source port.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEPORT() |
Getter for SOURCEPORT |
targetIp¶
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETIP() |
Getter for TARGETIP, with configurable default |
ASK_TARGETIP() |
Getter for TARGETIP w/ exceptions if field has no value |
HAS_TARGETIP() |
Determine if TARGETIP has a value |
targetPort¶
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETPORT() |
Getter for TARGETPORT |
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 |
connectedSince¶
Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTEDSINCE() |
Getter for CONNECTEDSINCE |
disconnectedSince¶
Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISCONNECTEDSINCE() |
Getter for DISCONNECTEDSINCE |
disconnectReason¶
The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
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 |
sessionExpiry¶
The session expiry interval in seconds for the MQTT client connection. This is configured by the user. 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 |
clientId¶
The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.
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 |
vpcEndpointId¶
The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCENDPOINTID() |
Getter for VPCENDPOINTID, with configurable default |
ASK_VPCENDPOINTID() |
Getter for VPCENDPOINTID w/ exceptions if field has no value |
HAS_VPCENDPOINTID() |
Determine if VPCENDPOINTID has a value |