Multiplatforms での MQCMD_INQUIRE_LISTENER_STATUS (Inquire Channel Listener Status)

Inquire Channel Listener Status (MQCMD_INQUIRE_LISTENER_STATUS) PCF コマンドは、1 つ以上の IBM® MQ リスナー・インスタンスの状況について照会します。

状況情報を取得するリスナーの名前を指定してください。特定のリスナー名または総称リスナー名のどちらかを使用してリスナーを指定できます。総称リスナー名を使用することにより、次のいずれかの情報を表示できます。

単一のアスタリスク (*) を使用して、すべてのリスナー定義の状況情報を表示できます。
指定した名前に一致する 1 つ以上のリスナーの状況情報。

必要なパラメーター

ListenerName (MQCFST)

リスナー名 (パラメーター ID: MQCACH_LISTENER_NAME)。

総称リスナー名がサポートされています。総称名とは、例えば ABC* のように、文字ストリングの後にアスタリスク (*) を付けたものです。これにより、指定した文字ストリングで始まる名前のすべてのリスナーが選択されます。アスタリスクだけを指定した場合、可能なすべての名前に一致することになります。

要求した属性とは無関係に、リスナー名は常に返されます。

ストリングの最大長は MQ_LISTENER_NAME_LENGTH です。

オプション・パラメーター

IntegerFilterCommand (MQCFIF)

整数フィルター・コマンド記述子。パラメーター ID は、MQIACF_ALL を除く、ListenerStatusAttrsで使用可能な整数タイプ・パラメーターの ID でなければなりません。このパラメーターは、フィルター条件を指定してコマンドからの出力を制限する場合に使用します。このフィルター条件の使用については、 MQCFIF-PCF 整数フィルター・パラメーターを参照してください。

整数フィルターを指定する場合、StringFilterCommandパラメーターを使用してストリング・フィルターを同時に指定することはできません。

ListenerStatusAttrs (MQCFIL)

リスナー状況属性 (パラメーター ID: MQIACF_LISTENER_STATUS_ATTRS)。

属性リストには、次の値を単独で指定できます (このパラメーターを指定しない場合はデフォルト値が使用される)。

MQIACF_ALL: すべての属性。

または、以下の組み合わせ。

MQCACH_IP_ADDRESS: リスナーの IP アドレス。
MQCACH_LISTENER_DESC: リスナー定義の記述。
MQCACH_LISTENER_NAME: リスナー定義の名前。
MQCACH_LISTENER_START_DATE: リスナーが開始された日付。
MQCACH_LISTENER_START_TIME: リスナーが開始された時刻。
MQCACH_LOCAL_NAME: リスナーが使用する NetBIOS ローカル名。 MQCACH_LOCAL_NAME は、Windows でのみ有効です。
MQCACH_TP_NAME: LU6.2 トランザクション・プログラム名。 MQCACH_TP_NAME は、Windows でのみ有効です。
MQIACF_PROCESS_ID: リスナーに関連付けられたオペレーティング・システム・プロセス ID。
MQIACH_ADAPTER: NetBIOS が listen するアダプター番号。 MQIACH_ADAPTER は、Windows でのみ有効です。
MQIACH_BACKLOG: リスナーがサポートする並行接続要求の数。
MQIACH_COMMAND_COUNT: リスナーが使用できるコマンドの数。 MQIACH_COMMAND_COUNT は、Windows でのみ有効です。
MQIACH_LISTENER_CONTROL: リスナーの開始方法と停止方法。
MQIACH_LISTENER_STATUS: リスナーの状況。
MQIACH_NAME_COUNT: リスナーが使用可能な名前の数。 MQIACH_NAME_COUNT は、Windows でのみ有効です。
MQIACH_PORT: TCP/IP のポート番号。
MQIACH_SESSION_COUNT: リスナーが使用できるセッションの数。 MQIACH_SESSION_COUNT は、Windows でのみ有効です。
MQIACH_SOCKET: SPX ソケット。 MQIACH_SOCKET は、Windows でのみ有効です。
MQIACH_XMIT_PROTOCOL_TYPE: トランスポート・タイプ。

StringFilterCommand (MQCFSF)

ストリング・フィルター・コマンド記述子。パラメーター ID は、MQCACH_LISTENER_NAME を除く、ListenerStatusAttrsで使用可能なストリング・タイプ・パラメーターの ID でなければなりません。このパラメーターは、フィルター条件を指定してコマンドからの出力を制限する場合に使用します。このフィルター条件の使用については、 MQCFSF-PCF ストリング・フィルター・パラメーターを参照してください。

ストリング・フィルターを指定する場合、IntegerFilterCommandパラメーターを使用して整数フィルターを同時に指定することはできません。

エラー・コード

このコマンドは、「すべてのコマンドに適用されるエラー・コード」に示されている値に加えて、以下のエラー・コードを応答形式ヘッダーに返す場合があります。

理由 (MQLONG)

値には以下のいずれかの値を指定できます。

MQRCCF_LSTR_STATUS_NOT_FOUND: リスナー状況が見つかりません。