Messages

 

The qmb_util utility allows you to control the behavior of a target QMB process (by sending a control message to that process) without having to close the process or rewrite the client or server application. Control messages are requests to the QMB Server sent via the BEA MessageQ API function pams_put_msg.

This appendix describes the control messages that can be sent to QMB processes using qmb_util:

• DUMP_QTABLES

• EVENT_LOG

• LOAD_CONFIG

• NEW_LOG

• PURGE_CI

• PURGE_CI_ALL

• QMB_TERMINATE

• RSQ_REGISTER

• TRACE_LOG

For more information on the qmb_util utility, see Using the BEA MessageQ MQSeries Connection Utility in Managing the BEA MessageQ MQSeries Connection Environment.

DUMP_QTABLES

The DUMP_QTABLES message dumps IBM MQSeries Message Descriptor (MQMD) to a log file.

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_DUMP_QTABLES
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None

EVENT_LOG

The EVENT_LOG message toggles QMB Server event logging. If event logging is enabled (that is, if you started the QMB with the -e parameter), use this message type to disable event logging. Likewise, if event logging is disabled, use this message type to enable event logging.

This message must be sent to each QMB Server that requires a change in event logging status.

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_EVENT_LOG
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None.

LOAD_CONFIG

The LOAD_CONFIG message reloads the QMB configuration file. Sending this message to the permanent QMBMD server results in messages being transmitted to the associated QMBDM server and all Temporary Primary Queues (TPQs).

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_LOAD_CONFIG
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None

NEW_LOG

The NEW_LOG message closes the existing log and opens a new log. Sending this message to the permanent QMBDM server results in messages being transmitted to the associated QMBMD server and all of their Temporary Primary Queues (TPQs).

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_NEW_LOG
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None

PURGE_CI

The PURGE_CI message purges all nonpersistent connection indexes (CI) from the CI table. This message is processed only by the permanent QMBDM server

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_PURGE_CI
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None

PURGE_CI_ALL

The PURGE_CI_ALL message purges all CIs from the CI table. This message is processed only by the permanent QMBDM server

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_PURGE_CI_ALL
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None

QMB_TERMINATE

The QMB_TERMINATE message terminates a QMB Server. If this message is sent to a Permanent QMB Server, the termination request is forwarded to all associated TPQs.

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_QMB_TERMINATE
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None

RSQ_REGISTER

The RSQ_REGISTER message requires the RSQ registration structure in the message body of the message structure. Sending this message to the permanent QMBDM server results in messages being transmitted to the associated QMBMD server and all Temporary Primary Queues (TPQs).

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_RSQ_REGISTER
Class	MSG_CLAS_QMB
Size	sizeof(rsq_reg_struct);

RSQ Registration Structure

typedef struct {              /* (MAX_MQS_LEN = 49)           */
   char      lsq[49];         /* LSQ name to assign RSQ to    */
   char      lowner;          /* LSQ Owner [D]MQ or [M]QS     */
   char      rsq[49];         /* RSQ name of MQS Appl Queue   */
   char      rfu;             /* Reserved Future Use          */
   q_address rsq_add;         /* DMQ address of  DMQ RSQ      */
} rsq_reg_struct;

TRACE_LOG

The TRACE_LOG message toggles internal trace logging. If trace logging is on (that is, if you started the QMB with the -t parameter), use this message type to toggle trace logging off. Likewise, if trace logging is off, use this message type to toggle trace logging on.

If verbose tracing is enabled, this message disables trace logging. Verbose logging can only be enabled using the -v parameter on the QMB Server command line.

This message must be sent to each QMB Server that requires a change in trace logging status.

C Message Structure

#include qmb_user.h

Arguments

Arguments	pams_put_msg Format
Type	MSG_TYPE_TRACE_LOG
Class	MSG_CLAS_QMB
Size	0

Message Data Fields

None