Fields in MQWDR - Cluster workload destination record structure

Description of the parameters in the MQWDR - Cluster workload destination record structure.

StrucId ( MQCHAR4 ) - input
The structure identifier for the cluster workload destination record structure.
  • The StrucId value is MQWDR_STRUC_ID.
  • For the C programming language, the constant MQWDR_STRUC_ID_ARRAY is also defined. It has the same value as MQWDR_STRUC_ID. It is an array of characters instead of a string.
Version ( MQLONG ) - input
The structure version number. Version takes one of the following values:
MQWDR_VERSION_1
Version-1 cluster workload destination record.
MQWDR_VERSION_2
Version-2 cluster workload destination record.
MQWDR_CURRENT_VERSION
Current version of cluster workload destination record.
StrucLength ( MQLONG ) - input
The length of MQWDR structure. StrucLength takes one of the following values:
MQWDR_LENGTH_1
Length of version-1 cluster workload destination record.
MQWDR_LENGTH_2
Length of version-2 cluster workload destination record.
MQWDR_CURRENT_LENGTH
Length of current version of cluster workload destination record.
QMgrFlags ( MQLONG ) - input
Queue manager flags indicating properties of the queue manager that hosts the instance of the destination queue described by the MQWDR structure. The following flags are defined:
MQQMF_REPOSITORY_Q_MGR
Destination is a full repository queue manager.
MQQMF_CLUSSDR_USER_DEFINED
Cluster-sender channel was defined manually.
MQQMF_CLUSSDR_AUTO_DEFINED
Cluster-sender channel was defined automatically.
MQQMF_AVAILABLE
Destination queue manager is available to receive messages.
Other values
Other flags in the field might be set by the queue manager for internal purposes.
QMgrIdentifier ( MQCHAR48 ) - input
The queue manager identifier is a unique identifier for the queue manager that hosts the instance of the destination queue described by the MQWDR structure.
  • The identifier is generated by the queue manager.
  • The length of QMgrIdentifier is MQ_Q_MGR_IDENTIFIER_LENGTH.
QMgrName ( MQCHAR48 ) - input
The name of the queue manager that hosts the instance of the destination queue described by the MQWDR structure.
  • QMgrName can be the name of the local queue manager, as well another queue manager in the cluster.
  • The length of QMgrName is MQ_Q_MGR_NAME_LENGTH.
ClusterRecOffset ( MQLONG ) - input
The logical offset of the first MQWCR structure that belongs to the MQWDR structure.
  • For static caches, ClusterRecOffset is the offset of the first MQWCR structure that belongs to the MQWDR structure.
  • The offset is measured in bytes from the start of the MQWDR structure.
  • Do not use the logical offset for pointer arithmetic with dynamic caches. To obtain the address of the next record, the MQXCLWLN call must be used.
ChannelState ( MQLONG ) - input
The state of the channel that links the local queue manager to the queue manager identified by the MQWDR structure. The following values are possible:
MQCHS_BINDING
Channel is negotiating with the partner.
MQCHS_INACTIVE
Channel is not active.
MQCHS_INITIALIZING
Channel is initializing.
MQCHS_PAUSED
Channel has paused.
MQCHS_REQUESTING
Requester channel is requesting connection.
MQCHS_RETRYING
Channel is reattempting to establish connection.
MQCHS_RUNNING
Channel is transferring or waiting for messages.
MQCHS_STARTING
Channel is waiting to become active.
MQCHS_STOPPING
Channel is stopping.
MQCHS_STOPPED
Channel has stopped.
ChannelDefOffset ( MQLONG ) - input
The logical offset of the channel definition ( MQCD ) for the channel that links the local queue manager to the queue manager identified by the MQWDR structure.
  • ChannelDefOffset is like ClusterRecOffset
  • The logical offset cannot be used in pointer arithmetic. To obtain the address of the next record, the MQXCLWLN call must be used.
DestSeqFactor ( MQLONG ) - input
The destination sequence factor that allows a choice of the channel based on weight.
  • DestSeqFactor is used before the queue manager changes it.
  • The workload manager increases DestSeqFactor in a way that ensures messages are distributed down channels according to their weight.
DestSeqNumber ( MQLONG ) - input
The cluster channel destination value before the queue manager changes it.
  • The workload manager increases DestSeqNumber every time a message is put down that channel.
  • Workload exits can use DestSeqNumber to decide which channel to put a message down.