Home
MQCFH - PCF header
Each message or response in PCF format starts with an MQCFH structure. The field contents of the MQCFH structure for WebSphere MQ Publish/Subscribe are as follows:
- Type (MQLONG)
- Structure type.
The following values are valid:
- MQCFT_COMMAND
- Command message (for example, Publish, Register Subscribers).
- MQCFT_RESPONSE
- Message is a response to a command.
- StrucLength (MQLONG)
- Structure length. The value must be MQCFH_STRUC_LENGTH.
- V(MQLONG)
- Structure version number. The value must be MQCFH_VERSION_1.
- Command (MQLONG)
- Command identifier.
For a command message, this identifies the function to be performed. For a response message, it identifies the command to which this is the reply. The following values are valid:
- MQCMD_DELETE_PUBLICATION
- Delete Publication
- MQCMD_DEREGISTER_PUBLISHER
- Deregister Publisher
- MQCMD_DEREGISTER_SUBSCRIBER
- Deregister Subscriber
- MQCMD_PUBLISH
- Publish
- MQCMD_REGISTER_PUBLISHER
- Register Publisher
- MQCMD_REGISTER_SUBSCRIBER
- Register Subscriber
- MQCMD_REQUEST_UPDATE
- Request Update
- MQCMD_BROKER_INTERNAL
- Used internally by brokers
- MsgSeqNumber (MQLONG)
- Message sequence number. The value must be 1 for WebSphere MQ Publish/Subscribe messages and responses.
- Control (MQLONG)
- Control options.
The value must be MQCFC_LAST for WebSphere MQ Publish/Subscribe messages and responses.
- CompCode (MQLONG)
- Completion code.
This field is meaningful only for a response; its value is not significant for a command. The following values are possible:
- MQCC_OK
- Command completed successfully.
- MQCC_WARNING
- Command completed with warning.
- MQCC_FAILED
- Command failed.
- Reason (MQLONG)
- Reason code qualifying completion code.
This field is meaningful only for a response; its value is not significant for a command.
The reason codes that might be returned in response to a command are listed in Reason codes returned from publish/subscribe messages.
- ParameterCount (MQLONG)
- Count of parameter structures (MQCFIN, MQCFST) following.
The value of this field is zero or greater.
Home