Skip to main content

"describeMqttSession"

Use the "describeMqttSession" action to view information about a client's MQTT session

The "describeMqttSession" action requires a "clientName" and returns information about its MQTT session.

Request example

{
  "api": "mq",
  "action": "describeMqttSession",
  "params":
  {
    "clientName": "a unique MQTT client identifier or empty string"
  },
  "apiVersion": "1.0",
  "debug": "max",
  "requestId": "optionalUniqueRequestIdFromTheClient",
  "authToken": "replaceWithAuthTokenFromCreateSession"
}

Use the "describeMqttSession" action to view information about a client's MQTT session

describeMqttSessiondescribe Mqtt SessionjsonActionJSON MQ message API

Params

Table 1. Params property summaries

Property

Description

Default

Type

Limits (inclusive)

clientName

specifies the unique name that identifies the client to the FairCom MQTT engine

""

string

0 to 65,550 bytes



"clientName"

The "clientName" property is an optional string of up to 65550 characters containing a client name that uniquely identifies the client to the FairCom MQTT engine. 

The MQTT protocol allows only one connection per client identifier because each connection is stateful. If another client with the same "clientName" is already connected, the MQTT broker disconnects the other client and vice-versa. 

The JSON MQ Message API behaves differently because it is stateless; it allows multiple processes to simultaneously use the same client identifier to manage sessions, subscribe to topics, send messages to topics, and retrieve messages from topics.