Inquire Channel Listener Status (Response) on Multiplatforms
The response to the Inquire Channel Listener Status (MQCMD_INQUIRE_LISTENER_STATUS) command consists of the response header followed by the ListenerName structure and the requested combination of attribute parameter structures.
If a generic listener name was specified, one such message is generated for each listener found.
- Always returned:
- ListenerName
- Returned if requested:
- Adapter, Backlog, ChannelCount, Commands, IPAddress, ListenerDesc, LocalName, NetbiosNames, Port, ProcessId, Sessions, Socket, StartDate, StartMode, StartTime, Status, TPname, TransportType
Response data
- Adapter (MQCFIN)
- Adapter number (parameter identifier: MQIACH_ADAPTER).
The adapter number on which NetBIOS listens.
- Backlog (MQCFIN)
- Backlog (parameter identifier: MQIACH_BACKLOG).
The number of concurrent connection requests that the listener supports.
- Commands (MQCFIN)
- Adapter number (parameter identifier: MQIACH_COMMAND_COUNT).
The number of commands that the listener can use.
- IPAddress (MQCFST)
- IP address (parameter identifier: MQCACH_IP_ADDRESS).
IP address for the listener specified in IPv4 dotted decimal, IPv6 hexadecimal notation, or alphanumeric host name form.
The maximum length of the string is MQ_CONN_NAME_LENGTH
- ListenerDesc (MQCFST)
- Description of listener definition (parameter identifier: MQCACH_LISTENER_DESC).
The maximum length of the string is MQ_LISTENER_DESC_LENGTH.
- ListenerName (MQCFST)
- Name of listener definition (parameter identifier: MQCACH_LISTENER_NAME).
The maximum length of the string is MQ_LISTENER_NAME_LENGTH.
- LocalName (MQCFST)
- NetBIOS local name (parameter identifier: MQCACH_LOCAL_NAME).
The NetBIOS local name that the listener uses.
The maximum length of the string is MQ_CONN_NAME_LENGTH
- NetbiosNames (MQCFIN)
- NetBIOS names (parameter identifier: MQIACH_NAME_COUNT).
The number of names that the listener supports.
- Port (MQCFIN)
- Port number (parameter identifier: MQIACH_PORT).
The port number for TCP/IP.
- ProcessId (MQCFIN)
- Process identifier (parameter identifier: MQIACF_PROCESS_ID).
The operating system process identifier associated with the listener.
- Sessions (MQCFIN)
- NetBIOS sessions (parameter identifier: MQIACH_SESSION_COUNT).
The number of sessions that the listener can use.
- Socket (MQCFIN)
- SPX socket number (parameter identifier: MQIACH_SOCKET).
The SPX socket on which the listener is to listen.
- StartDate (MQCFST)
- Start date (parameter identifier: MQCACH_LISTENER_START_DATE).
The date, in the form yyyy-mm-dd, on which the listener was started.
The maximum length of the string is MQ_DATE_LENGTH
- StartMode (MQCFIN)
- Service mode (parameter identifier: MQIACH_LISTENER_CONTROL).
Specifies how the listener is to be started and stopped. The value can be any of the following values:
- MQSVC_CONTROL_MANUAL
- The listener is not to be started automatically or stopped automatically. It is to be controlled by user command. MQSVC_CONTROL_MANUAL is the default value.
- MQSVC_CONTROL_Q_MGR
- The listener being defined is to be started and stopped at the same time as the queue manager is started and stopped.
- MQSVC_CONTROL_Q_MGR_START
- The listener is to be started at the same time as the queue manager is started, but is not request to stop when the queue manager is stopped.
- StartTime (MQCFST)
- Start date (parameter identifier: MQCACH_LISTENER_START_TIME).
The time, in the form hh.mm.ss, at which the listener was started.
The maximum length of the string is MQ_TIME_LENGTH
- Status (MQCFIN)
- Listener status (parameter identifier: MQIACH_LISTENER_STATUS).
The status of the listener. The value can be any of the following values:
- MQSVC_STATUS_STARTING
- The listener is in the process of initializing.
- MQSVC_STATUS_RUNNING
- The listener is running.
- MQSVC_STATUS_STOPPING
- The listener is stopping.
- TPName (MQCFST)
- Transaction program name (parameter identifier: MQCACH_TP_NAME).
The LU 6.2 transaction program name.
The maximum length of the string is MQ_TP_NAME_LENGTH
- TransportType (MQCFIN)
- Transmission protocol (parameter identifier: MQIACH_XMIT_PROTOCOL_TYPE).
The value can be:
- MQXPT_TCP
- TCP.
- MQXPT_LU62
- LU 6.2. MQXPT_LU62 is valid only on Windows.
- MQXPT_NETBIOS
- NetBIOS. MQXPT_NETBIOS is valid only on Windows.
- MQXPT_SPX
- SPX. MQXPT_SPX is valid only on Windows.
Parent topic: Definitions of the Programmable Command Formats