Inquire Topic Status (Response)

The response of the Inquire topic (MQCMD_INQUIRE_TOPIC_STATUS) command consists of the response header, followed by the TopicString structure, and the requested combination of attribute parameter structures (where applicable). The Inquire Topic Status command returns the values requested when the StatusType is MQIACF_TOPIC_STATUS. The Inquire Topic Status command returns the values requested when the StatusType is MQIACF_TOPIC_STATUS_SUB. The Inquire Topic Status command returns the values requested when the StatusType is MQIACF_TOPIC_STATUS_PUB.

    Always returned:
    TopicString

    Returned if requested and StatusType is MQIACF_TOPIC_STATUS:
    Cluster, ClusterPubRoute, CommInfo, DefPriority, DefaultPutResponse, DefPersistence, DurableSubscriptions, InhibitPublications, InhibitSubscriptions, AdminTopicName, Multicast, DurableModelQName, NonDurableModelQName, PersistentMessageDelivery, NonPersistentMessageDelivery, RetainedPublication, PublishCount, SubscriptionScope, SubscriptionCount, PublicationScope, UseDLQ Note: The Inquire Topic Status command returns only resolved values for the topic, and no AS_PARENT values.

    Returned if requested and StatusType is MQIACF_TOPIC_SUB:
    SubscriptionId, SubscriptionUserId, Durable, SubscriptionType, ResumeDate, ResumeTime, LastMessageDate, LastMessageTime, NumberOfMessages, ActiveConnection

    Returned if requested and StatusType is MQIACF_TOPIC_PUB:
    LastPublishDate, LastPublishTime, NumberOfPublishes, ActiveConnection


Response data (TOPIC_STATUS)

    ClusterName (MQCFST)
    The name of the cluster to which this topic belongs. (parameter identifier: MQCA_CLUSTER_NAME).

    The maximum length of the string is MQ_CLUSTER_NAME_LENGTH. Setting this parameter to a cluster that this queue manager is a member of makes all queue managers in the cluster aware of this topic. Any publication to this topic or a topic string below it put to any queue manager in the cluster is propagated to subscriptions on any other queue manager in the cluster. For more details, see Distributed publish/subscribe networks.

    The value can be any of the following values:

      Blank
      If no topic object above this topic in the topic tree has set this parameter to a cluster name, then this topic does not belong to a cluster. Publications and subscriptions for this topic are not propagated to publish/subscribe cluster-connected queue managers. If a topic node higher in the topic tree has a cluster name set, publications and subscriptions to this topic are also propagated throughout the cluster.
      This value is the default value for this parameter if no value is specified.

      String
      The topic belongs to this cluster. It is not recommended that this is set to a different cluster from a topic object above this topic object in the topic tree. Other queue managers in the cluster will honor this object's definition unless a local definition of the same name exists on those queue managers.
      Additionally, if PublicationScope or SubscriptionScope are set to MQSCOPE_ALL, this value is the cluster to be used for the propagation of publications and subscriptions, for this topic, to publish/subscribe cluster-connected queue managers.

    ClusterPubRoute (MQCFIN)
    The routing behavior to use for this topic in the cluster (parameter identifier: MQIA_CLUSTER_PUB_ROUTE). The values can be as follows:

      MQCLROUTE_DIRECT
      A publication on this topic string, originating from this queue manager, is sent direct to any queue manager in the cluster with a matching subscription.

      MQCLROUTE_TOPIC_HOST
      A publication on this topic string, originating from this queue manager, is sent to one of the queue managers in the cluster that hosts a definition of the corresponding clustered topic object, and from there to any queue manager in the cluster with a matching subscription.

      MQCLROUTE_NONE
      This topic node is not clustered.

    CommInfo (MQCFST)
    The name of the communication information object (parameter identifier: MQCA_COMM_INFO_NAME).

    Shows the resolved value of the name of the communication information object to be used for this topic node.

    The maximum length of the string is MQ_COMM_INFO_NAME_LENGTH.

    DefPersistence (MQCFIN)
    Default persistence (parameter identifier: MQIA_TOPIC_DEF_PERSISTENCE).

    Returned value:

      MQPER_PERSISTENT
      Message is persistent.

      MQPER_NOT_PERSISTENT
      Message is not persistent.

    DefaultPutResponse (MQCFIN)
    Default put response (parameter identifier: MQIA_DEF_PUT_RESPONSE_TYPE).

    Returned value:

      MQPRT_SYNC_RESPONSE
      The put operation is issued synchronously, returning a response.

      MQPRT_ASYNC_RESPONSE
      The put operation is issued asynchronously, returning a subset of MQMD fields.

    DefPriority (MQCFIN)
    Default priority (parameter identifier: MQIA_DEF_PRIORITY).

    Shows the resolved default priority of messages published to the topic.

    DurableSubscriptions (MQCFIN)
    Whether applications are permitted to make durable subscriptions (parameter identifier: MQIA_DURABLE_SUB).

    Returned value:

      MQSUB_DURABLE_ALLOWED
      Durable subscriptions are permitted.

      MQSUB_DURABLE_INHIBITED
      Durable subscriptions are not permitted.

    InhibitPublications (MQCFIN)
    Whether publications are allowed for this topic (parameter identifier: MQIA_INHIBIT_PUB).

    Returned value:

      MQTA_PUB_INHIBITED
      Publications are inhibited for this topic.

      MQTA_PUB_ALLOWED
      Publications are allowed for this topic.

    InhibitSubscriptions (MQCFIN)
    Whether subscriptions are allowed for this topic (parameter identifier: MQIA_INHIBIT_SUB).

    Returned value:

      MQTA_SUB_INHIBITED
      Subscriptions are inhibited for this topic.

      MQTA_SUB_ALLOWED
      Subscriptions are allowed for this topic.

    AdminTopicName (MQCFST)
    Topic object name (parameter identifier: MQCA_ADMIN_TOPIC_NAME).

    If the topic is an admin-node, the command displays the associated topic object name containing the node configuration. If the field is not an admin-node the command displays a blank.

    The maximum length of the string is MQ_TOPIC_NAME_LENGTH.

    Multicast (MQCFIN)
    Whether multicast is used for this topic (parameter identifier: MQIA_MULTICAST).

    Returned value:

      MQMC_ENABLED
      Multicast can be used.

      MQMC_DISABLED
      Multicast is not used.

      MQMC_ONLY
      Only Multicast publish/subscribe can be used on this topic.

    DurableModelQName (MQCFST)
    The name of the model queue used for managed durable subscriptions (parameter identifier: MQCA_MODEL_DURABLE_Q).

    Shows the resolved value of the name of the model queue to be used for durable subscriptions that request the queue manager to manage the destination of publications.

    The maximum length of the string is MQ_Q_NAME_LENGTH.

    NonDurableModelQName (MQCFST)
    The name of the model queue for managed non-durable subscriptions (parameter identifier: MQCA_MODEL_NON_DURABLE_Q).

    The maximum length of the string is MQ_Q_NAME_LENGTH.

    PersistentMessageDelivery (MQCFIN)
    Delivery mechanism for persistent messages published to this topic (parameter identifier: MQIA_PM_DELIVERY).

    Returned value:

      MQDLV_ALL
      Persistent messages must be delivered to all subscribers, irrespective of durability, for the MQPUT call to report success. If a delivery failure to any subscriber occurs, no other subscribers receive the message and the MQPUT call fails.

      MQDLV_ALL_DUR
      Persistent messages must be delivered to all durable subscribers. Failure to deliver a persistent message to any non-durable subscribers does not return an error to the MQPUT call. If a delivery failure to a durable subscriber occurs, no subscribers receive the message and the MQPUT call fails.

      MQDLV_ALL_AVAIL
      Persistent messages are delivered to all subscribers that can accept the message. Failure to deliver the message to any subscriber does not prevent other subscribers from receiving the message.

    NonPersistentMessageDelivery (MQCFIN)
    Delivery mechanism for non-persistent messages published to this topic (parameter identifier: MQIA_NPM_DELIVERY).

    Returned value:

      MQDLV_ALL
      Non-persistent messages must be delivered to all subscribers, irrespective of durability, for the MQPUT call to report success. If a delivery failure to any subscriber occurs, no other subscribers receive the message and the MQPUT call fails.

      MQDLV_ALL_DUR
      Non-persistent messages must be delivered to all durable subscribers. Failure to deliver a non-persistent message to any non-durable subscribers does not return an error to the MQPUT call. If a delivery failure to a durable subscriber occurs, no subscribers receive the message and the MQPUT call fails.

      MQDLV_ALL_AVAIL
      Non-persistent messages are delivered to all subscribers that can accept the message. Failure to deliver the message to any subscriber does not prevent other subscribers from receiving the message.

    RetainedPublication (MQCFIN)
    Whether there is a retained publication for this topic (parameter identifier: MQIACF_RETAINED_PUBLICATION).

    Returned value:

      MQQSO_YES
      There is a retained publication for this topic.

      MQQSO_NO
      There is no retained publication for this topic.

    PublishCount (MQCFIN)
    Publish count (parameter identifier: MQIA_PUB_COUNT).

    The number of applications currently publishing to the topic.

    SubscriptionCount (MQCFIN)
    Subscription count (parameter identifier: MQIA_SUB_COUNT).

    The number of subscribers for this topic string, including durable subscribers who are not currently connected.

    SubscriptionScope (MQCFIN)
    Determines whether this queue manager propagates subscriptions for this topic to queue managers as part of a hierarchy or as part of a publish/subscribe cluster (parameter identifier: MQIA_SUB_SCOPE).

    Returned value:

      MQSCOPE_QMGR
      The queue manager does not propagate subscriptions for this topic to other queue managers.

      MQSCOPE_ALL
      The queue manager propagates subscriptions for this topic to hierarchically connected queue managers and to publish/subscribe cluster connected queues.

    PublicationScope (MQCFIN)
    Determines whether this queue manager propagates publications for this topic to queue managers as part of a hierarchy or as part of a publish/subscribe cluster (parameter identifier: MQIA_PUB_SCOPE).

    Returned value:

      MQSCOPE_QMGR
      The queue manager does not propagate publications for this topic to other queue managers.

      MQSCOPE_ALL
      The queue manager propagates publications for this topic to hierarchically connected queue managers and to publish/subscribe cluster connected queues.

    UseDLQ (MQCFIN)
    Determines whether the dead-letter queue is used when publication messages cannot be delivered to their correct subscriber queue (parameter identifier: MQIA_USE_DEAD_LETTER_Q). The value can be any of the following values:

      MQUSEDLQ_NO
      Publication messages that cannot be delivered to their correct subscriber queue are treated as a failure to put the message. The MQPUT of an application to a topic fails in accordance with the settings of MQIA_NPM_DELIVERY and MQIA_PM_DELIVERY.

      MQUSEDLQ_YES
      If the DEADQ queue manager attribute provides the name of a dead-letter queue then it is used, otherwise the behavior is as for MQUSEDLQ_NO.


Response data (TOPIC_STATUS_SUB)

    SubscriptionId (MQCFBS)
    Subscription identifier (parameter identifier: MQBACF_SUB_ID).

    The queue manager assigns SubscriptionId as an all time unique identifier for this subscription.

    The maximum length of the string is MQ_CORREL_ID_LENGTH.

    SubscriptionUserId (MQCFST)
    The user ID that owns this subscription (parameter identifier: MQCACF_SUB_USER_ID).

    The maximum length of the string is MQ_USER_ID_LENGTH.

    Durable (MQCFIN)
    Whether this subscription is a durable subscription (parameter identifier: MQIACF_DURABLE_SUBSCRIPTION).

      MQSUB_DURABLE_YES
      The subscription persists, even if the creating application disconnects from the queue manager or issues an MQCLOSE call for the subscription. The queue manager reinstates the subscription during restart.

      MQSUB_DURABLE_NO
      The subscription is non-durable. The queue manager removes the subscription when the creating application disconnects from the queue manager or issues an MQCLOSE call for the subscription. If the subscription has a destination class (DESTCLAS) of MANAGED, the queue manager removes any messages not yet consumed when it closes the subscription.

    SubscriptionType (MQCFIN)
    The type of subscription (parameter identifier: MQIACF_SUB_TYPE).

    The value can be:

    ResumeDate (MQCFST)
    Date of the most recent MQSUB call that connected to this subscription (parameter identifier: MQCA_RESUME_DATE).

    The maximum length of the string is MQ_DATE_LENGTH.

    ResumeTime (MQCFST)
    Time of the most recent MQSUB call that connected to this subscription (parameter identifier: MQCA_RESUME_TIME).

    The maximum length of the string is MQ_TIME_LENGTH.

    LastMessageDate (MQCFST)
    Date on which an MQPUT call last sent a message to this subscription. The queue manager updates the date field after the MQPUT call successfully puts a message to the destination specified by this subscription (parameter identifier: MQCACF_LAST_MSG_DATE). The maximum length of the string is MQ_DATE_LENGTH. Note: An MQSUBRQ call updates this value.

    LastMessageTime (MQCFST)
    Time at which an MQPUT call last sent a message to this subscription. The queue manager updates the time field after the MQPUT call successfully puts a message to the destination specified by this subscription (parameter identifier: MQCACF_LAST_MSG_TIME). The maximum length of the string is MQ_TIME_LENGTH. Note: An MQSUBRQ call updates this value.

    NumberOfMessages (MQCFIN)
    Number of messages put to the destination specified by this subscription (parameter identifier: MQIACF_MESSAGE_COUNT). Note: An MQSUBRQ call updates this value.

    ActiveConnection (MQCFBS)
    The currently active ConnectionId (CONNID) that opened this subscription (parameter identifier: MQBACF_CONNECTION_ID).

    The maximum length of the string is MQ_CONNECTION_ID_LENGTH.


Response data (TOPIC_STATUS_PUB)

    LastPublicationDate (MQCFST)
    Date on which this publisher last sent a message (parameter identifier: MQCACF_LAST_PUB_DATE).

    The maximum length of the string is MQ_DATE_LENGTH.

    LastPublicationTime (MQCFST)
    Time at which this publisher last sent a message (parameter identifier: MQCACF_LAST_PUB_TIME).

    The maximum length of the string is MQ_TIME_LENGTH.

    NumberOfPublishes (MQCFIN)
    Number of publishes made by this publisher (parameter identifier: MQIACF_PUBLISH_COUNT).

    ActiveConnection (MQCFBS)
    The currently active ConnectionId (CONNID) associated with the handle that has this topic open for publish (parameter identifier: MQBACF_CONNECTION_ID).

    The maximum length of the string is MQ_CONNECTION_ID_LENGTH.

Parent topic: Definitions of the Programmable Command Formats