MQCFST structure, Type field, StrucLength field" /> MQCFH - PCF header

 

MQCFH - PCF header

The MQCFH structure describes the information that is present at the start of the message data of a monitoring message.

Type

Description: Structure type This indicates the content of the message.
Datatype: MQLONG.
Values:

MQCFT_ACCOUNTING

Message is an accounting message.

MQCFT_EVENT

Message is reporting an event.

MQCFT_REPORT

Message is an activity report.

MQCFT_RESPONSE

Message is a response to a command.

MQCFT_STATISTICS

Message is a statistics message.

MQCFT_TRACE_ROUTE

Message is a trace-route message.

StrucLength

Description: This is the length in bytes of the MQCFH structure
Datatype: MQLONG.
Value:

MQCFH_STRUC_LENGTH

Length of command format header structure.

Version

Description: Structure version number.
Datatype: MQLONG.
Value:

MQCFH_VERSION_1

Vnumber for all events except configuration and command events.

MQCFH_VERSION_2

Vnumber for configuration events.

MQCFH_VERSION_3

Vnumber for command events, activity reports, trace-route messages, accounting and statistics messages.

Command

Description: Specifies the category of the message.
Datatype: MQLONG.
Value: See the following sections for applicable values:

MsgSeqNumber

Description: Message sequence number. This is the sequence number of the message within a set of related messages.
Datatype: MQLONG.

Control

Description: Control options.
Datatype: MQLONG.
Value:

MQCFC_LAST

Last message in the set.

MQCFC_NOT_LAST

Not the last message in the set.

CompCode

Description: Completion code.
Datatype: MQLONG.
Value:

MQCC_OK

Events reporting OK condition, activity reports, trace-route messages, accounting messages, or statistics messages.

MQCC_WARNING

Event reporting warning condition.

Reason

Description: Reason code qualifying completion code.
Datatype: MQLONG.
Value: For event messages:

MQRC_*

Dependent on the event being reported.
Note:
Events with the same reason code are further identified by the ReasonQualifier parameter in the event data.

For activity reports, trace-route messages, accounting messages, and statistics messages:

MQRC_NONE

ParameterCount

Description: Count of parameter structures. This is the number of parameter structures that follow the MQCFH structure.
Datatype: MQLONG.
Value: 0 or greater.