![[AIX]](ngaix.gif)
![[Windows]](ngwin.gif)
![[Linux]](nglinux.gif)
Inquire Channel Status (Response) (MQTT)
The response to the Inquire Channel Status (MQCMD_INQUIRE_CHANNEL_STATUS) command
consists of the response header followed by the ChannelName
structure and the requested combination of attribute parameter structures.
One PCF response message is generated for each channel instance found that matches the criteria that are specified on the command.
If the ClientIdentifier parameter is not specified, the output of the Inquire Channel Status command is a summary of statuses of all clients that are connected to the channel. One PCF response message is returned per channel.
- Always returned:
ChannelName,ChannelStatus,ChannelType,Connections,
If the ClientIdentifier parameter is specified, separate PCF response messages are returned for each client connection. The ClientIdentifier parameter might be a wildcard, in which the status for all clients that match the ClientIdentifier string is returned (within the limits of MaxResponses and ResponseRestartPoint if they are set).
- Always returned:
ChannelName,ChannelStatus,ChannelType,ClientId- Returned if requested:
ChannelStatusDate,ChannelStatusTime,ClientUser,InDoubtInput,InDoubtOutput,KeepAliveInterval,LastMessageSentDate,LastMessageSentTime,MCAUser,MessagesReceived,MessagesSent,PendingOutbound,Protocol
Response data
- ChannelName (MQCFST)
- Channel name (parameter identifier: MQCACH_CHANNEL_NAME).
The maximum length of the string is MQ_CHANNEL_NAME_LENGTH.
- ChannelStartDate (MQCFST)
- Date on which the channel started, in the form
yyyy-mm-dd(parameter identifier: MQCACH_CHANNEL_START_DATE).The maximum length of the string is MQ_CHANNEL_DATE_LENGTH.
- ChannelStartTime (MQCFST)
- Time at which the channel started, in the form
hh.mm.ss(parameter identifier: MQCACH_CHANNEL_START_TIME).The maximum length of the string is MQ_CHANNEL_TIME_LENGTH.
- ChannelStatus (MQCFIN)
- Channel status (parameter identifier: MQIACH_CHANNEL_STATUS).
The value can be:
- MQCHS_DISCONNECTED
- Channel is disconnected.
- MQCHS_RUNNING
- Channel is transferring or waiting for messages.
- ChannelType (MQCFIN)
- Channel type (parameter identifier: MQIACH_CHANNEL_TYPE).
The value must be:
- MQCHT_MQTT
- Telemetry.
- ClientUser (MQCFST)
- ClientID of the client (parameter identifier: MQCACH_CLIENT_USER_ID).
The maximum length of the string is MQ_CLIENT_USER_ID_LENGTH.
- ConnectionName (MQCFST)
- Connection name (parameter identifier: MQCACH_CONNECTION_NAME).
The maximum length of the string is MQ_CONN_NAME_LENGTH.
- Connections (MQCFIN)
- Current number of MQTT connections connected to this channel (parameter identifier: MQIACF_NAME_LENGTH).
- InDoubtInput (MQCFIN)
- The number of inbound messages to the client that are in doubt (parameter identifier: MQIACH_IN_DOUBT_IN).
- InDoubtOutput (MQCFIN)
- The number of outbound messages from the client that are in doubt (parameter identifier: MQIACH_IN_DOUBT_OUT).
- KeepAliveInterval (MQCFIN)
- KeepAlive interval (parameter identifier: MQIACH_KEEP_ALIVE_INTERVAL).
The interval in milliseconds after which the client is disconnected because of inactivity. If the MQXR service does not receive any communication from the client within the keep alive interval, it disconnects from the client. This interval is calculated based on the MQTT keep alive time sent by the client when it connects. The maximum size is MQ_MQTT_MAX_KEEP_ALIVE.
- LastMsgDate (MQCFST)
- Date on which the last message was sent, or the MQI call was handled, in the form
yyyy-mm-dd(parameter identifier: MQCACH_LAST_MSG_DATE).The maximum length of the string is MQ_CHANNEL_DATE_LENGTH.
- LastMsgTime (MQCFST)
- Time at which the last message was sent, or the MQI call was handled, in the form
hh.mm.ss(parameter identifier: MQCACH_LAST_MSG_TIME).The maximum length of the string is MQ_CHANNEL_TIME_LENGTH.
- MCAUser (MQCFST)
- Message channel agent user identifier (parameter identifier: MQCACH_MCA_USER_ID).
The maximum length of the MCA user identifier is MQ_MCA_USER_ID_LENGTH.
- MsgsReceived (MQCFIN64)
- Number of messages received by the client since it last connected (parameter identifier: MQIACH_MSGS_RECEIVED / MQIACH_MSGS_RCVD).
- MsgsSent (MQCFIN64)
- Number of messages sent by the client since it last connected (parameter identifier: MQIACH_MSGS_SENT).
- PendingOutbound (MQCFIN)
- The number of outbound messages pending (parameter identifier: MQIACH_PENDING_OUT).
- Protocol (MQCFST)
- MQTT protocol supported by this channel (parameter
identifier: MQIACH_PROTOCOL).
Specify one or more of the following options. To specify more than one option, either add the values together (do not add the same constant more than once), or combine the values using the bitwise OR operation (if the programming language supports bit operations).
- MQTTv311 (constant: MQPROTO_MQTTV311)
- MQTTv3 (constant: MQPROTO_MQTTV3)
- HTTP (constant: MQPROTO_HTTP)