NAME

MQSeries::Utils - Internal utility functions

SYNOPSIS

use MQSeries::Utils qw(ConvertUnit);

my $wait_value = ConvertUnit('Wait', '45s');
my $exp_value = ConvertUnit('Expiry', '1.5m');

DESCRIPTION

The MQSeries::Utils module contains internal helper functions that are generally not of interest to users of the MQSeries module.

FUNCTIONS

ConvertUnit

This function can convert values for the 'Wait' and 'Expiry' options from symbolic values into the numeric values required. Symbolic values are numeric values ending in an 's' for seconds or an 'm' for minutes.

As 'Wait' values are in 1/1000 of a second and 'Expiry' is in 1/10 of a second, using symbolic values can help avoid mistakes such as getting the magnitude of these numbers wrong by one or more orders of magnitude.

VerifyNamedParams

Helper function to verify the named parameters received by other subroutines or methods. If a function uses the hash-like named parameter convention, it can call VerifyNamedParams to verify that all required parameters are present and that no unknown parameters have been specified. If anything is incorrect, a detailed error trace will be printed and the program will be terminated. This function is extremely useful during development, especially when APIs change.

This function takes two required and one optional parameters, all positional:

Params

A reference to the subroutine parameters received

Required

A reference to an array of required parameter names. These must be present and defined. If the parameter name is Carp, the value must be a code reference.

Optional

An optional reference to an array of optional parameter names. These may be present, be 'undef', or may be missing. The types will not be checked.

SEE ALSO

MQSeries(3)