NAME

MQSeries::Command::Request -- OO Class for creating MQSeries Command messages

SYNOPSIS

use MQSeries::Command::Request;
my $request = MQSeries::Command::Request->new
  (
   Command => MQCMD_CHANGE_Q_MGR,
   Parameters =>
   {
    AuthorityEvent => MQEVR_ENABLED,
    InhibitEvent   => MQEVR_ENABLED,
   },
  );

DESCRIPTION

METHODS

PutConvert, GetConvert

Neither of these methods are called by the users application, but are used internally by MQSeries::Queue::Put() and MQSeries::Queue::Get(), as well as MQSeries::QueueManager::Put1().

The GetConvert method will cause a failure, since this class is only to be used for decoding MQSeries events, not generating them. Perhaps a futute release will support the creation of such events.

The PutConvert method decodes the Command and Parameter into a valid message format for the Command Server.

RequestHeader

This method can be used to query the RequestHeader data structure. If no argument is given, then the entire RequestHeader hash is returned. If a single argument is given, then this is interpreted as a specific key, and the value of that key in the RequestHeader hash is returned.

The keys in the RequestHeader hash are the fields from the MQCFH structure. See the "MQSeries Programmable System Management" documentation.

Parameters

This method can be used to query the Parameters data structure. If no argument is given, then the entire Parameters hash is returned. If a single argument is given, then this is interpreted as a specific key, and the value of that key in the Parameters hash is returned.

The keys in the Parameters hash vary, depending on the specific event. In general, these are the strings shown in the documentation for each individual event described in the "MQSeries Programmable System Management" documentation. The data structures in the eventdata in the original event are identified with macros, such as "MQCA_Q_MGR_NAME". Rather than use these (in some cases very cryptic) macros, the strings shown in the IBM MQSeries documentation are used instead. In this case, "QMgrName".

SEE ALSO

MQSeries(3), MQSeries::QueueManager(3), MQSeries::Queue(3), MQSeries::Message(3)