MQWQR - Cluster workload queue-record structure

 


The MQWQR structure contains information relating to one of the possible destinations for the message. There is one MQWQR structure for each instance of the destination queue.

This structure is supported in the following environments: AIX, Compaq Tru64 UNIX, Compaq OpenVMS Alpha, Compaq NonStop Kernel, HP-UX, Linux, OS/2, z/OS, OS/400, Solaris, and Windows.

 

Fields

StrucId  (MQCHAR4) 
Structure identifier.

The value is:

MQWQR_STRUC_ID
Identifier for cluster workload queue record.

For the C programming language, the constant MQWQR_STRUC_ID_ARRAY is also defined; this has the same value as MQWQR_STRUC_ID, but is an array of characters instead of a string.

This is an input field to the exit.

Version  (MQLONG) 
Structure version number.

The value is:

MQWQR_VERSION_1
Version-1 cluster workload queue record.

The following constant specifies the version number of the current version:

MQWQR_CURRENT_VERSION
Current version of cluster workload queue record.

This is an input field to the exit.

StrucLength  (MQLONG) 
Length of MQWQR structure.

The value is:

MQWQR_LENGTH_1
Length of version-1 cluster workload queue record.

The following constant specifies the length of the current version:

MQWQR_CURRENT_LENGTH
Length of current version of cluster workload queue record.

This is an input field to the exit.

QFlags  (MQLONG) 
Queue flags.

These are bit flags that indicate various properties of the queue. The following flag is defined:

MQQF_LOCAL_Q
Destination is a local queue.

Note:
Other flags in the field might be set by the queue manager for internal purposes.

This is an input field to the exit.

QName  (MQCHAR48) 
Queue name.

The length of this field is given by MQ_Q_NAME_LENGTH. This is an input field to the exit.

QMgrIdentifier  (MQCHAR48) 
Queue-manager identifier.

This is a string that acts as a unique identifier for the queue manager that hosts the instance of the queue described by this MQWQR structure. The identifier is generated by the queue manager.

The length of this field is given by MQ_Q_MGR_IDENTIFIER_LENGTH. This is an input field to the exit.

ClusterRecOffset  (MQLONG) 
Offset of first cluster record.

This is the offset of the first MQWCR structure that belongs to this MQWQR structure. The offset is measured in bytes from the start of the MQWQR structure.

This is an input field to the exit.

QType  (MQLONG) 
Queue type.

The following values are possible:

MQCQT_LOCAL_Q
Local queue.

MQCQT_ALIAS_Q
Alias queue.

MQCQT_REMOTE_Q
Remote queue.

MQCQT_Q_MGR_ALIAS
Queue-manager alias.

This is an input field to the exit.

QDesc  (MQCHAR64) 
Queue description.

This is the value of the QDesc queue attribute as defined on the queue manager that hosts the instance of the destination queue described by this MQWQR structure.

The length of this field is given by MQ_Q_DESC_LENGTH. This is an input field to the exit.

DefBind  (MQLONG) 
Default binding.

This is the value of the DefBind queue attribute as defined on the queue manager that hosts the instance of the destination queue described by this MQWQR structure. The following values are possible:

MQBND_BIND_ON_OPEN
Binding fixed by  MQOPEN  call.

MQBND_BIND_NOT_FIXED
Binding not fixed.

This is an input field to the exit.

DefPersistence  (MQLONG) 
Default message persistence.

This is the value of the DefPersistence queue attribute as defined on the queue manager that hosts the instance of the destination queue described by this MQWQR structure. The following values are possible:

MQPER_PERSISTENT
Message is persistent.

MQPER_NOT_PERSISTENT
Message is not persistent.

This is an input field to the exit.

DefPriority  (MQLONG) 
Default message priority.

This is the value of the DefPriority queue attribute as defined on the queue manager that hosts the instance of the destination queue described by this MQWQR structure. Priorities are in the range zero (lowest) through MaxPriority (highest), where MaxPriority is the queue-manager attribute of the queue manager that hosts this instance of the destination queue.

This is an input field to the exit.

InhibitPut  (MQLONG) 
Whether put operations on the queue are allowed.

This is the value of the InhibitPut queue attribute as defined on the queue manager that hosts the instance of the destination queue described by this MQWQR structure. The following values are possible:

MQQA_PUT_INHIBITED
Put operations are inhibited.

MQQA_PUT_ALLOWED
Put operations are allowed.

This is an input field to the exit.

 

C declaration

typedef struct tagMQWQR {
  MQCHAR4   StrucId;           /* Structure identifier */
  MQLONG    Version;           /* Structure version number */
  MQLONG    StrucLength;       /* Length of MQWQR structure */
  MQLONG    QFlags;            /* Queue flags */
  MQCHAR48  QName;             /* Queue name */
  MQCHAR48  QMgrIdentifier;    /* Queue-manager identifier */
  MQLONG    ClusterRecOffset;  /* Offset of first cluster record */
  MQLONG    QType;             /* Queue type */
  MQCHAR64  QDesc;             /* Queue description */
  MQLONG    DefBind;           /* Default binding */
  MQLONG    DefPersistence;    /* Default message persistence */
  MQLONG    DefPriority;       /* Default message priority */
  MQLONG    InhibitPut;        /* Whether put operations on the queue
                                  are allowed */
} MQWQR;

 

System/390 assembler declaration

MQWQR                          DSECT
MQWQR_STRUCID                  DS   CL4      Structure identifier
MQWQR_VERSION                  DS   F        Structure version number
MQWQR_STRUCLENGTH              DS   F        Length of MQWQR structure
MQWQR_QFLAGS                   DS   F        Queue flags
MQWQR_QNAME                    DS   CL48     Queue name
MQWQR_QMGRIDENTIFIER           DS   CL48     Queue-manager identifier
MQWQR_CLUSTERRECOFFSET         DS   F        Offset of first cluster
*                                            record
MQWQR_QTYPE                    DS   F        Queue type
MQWQR_QDESC                    DS   CL64     Queue description
MQWQR_DEFBIND                  DS   F        Default binding
MQWQR_DEFPERSISTENCE           DS   F        Default message persistence
MQWQR_DEFPRIORITY              DS   F        Default message priority
MQWQR_INHIBITPUT               DS   F        Whether put operations on
*                                            the queue are allowed
MQWQR_LENGTH                   EQU  *-MQWQR  Length of structure
                               ORG  MQWQR
MQWQR_AREA                     DS   CL(MQWQR_LENGTH)