Chapter 4 . Corrections to Documentation

This section contains corrections to the documentation that accompanies the Version 4.0A release.


Corrections to the Installation and Configuration Guide for UNIX

This section provides corrections to the BEA MessageQ Installation and Configuration Guide for UNIX, part number 850-001005-002.

Correction to Installation Instructions (page 1-5)

The description of the installation of MessageQ software from the BEA CD-ROM distribution media contains the following errors:

Known Difference Between MAX_CLIENTS file on UNIX and OpenVMS Platforms (page 3-19)

The MAX_CLIENTS field in the %CLS section of the group initialization file is used to limit the number of clients on OpenVMS systems only. This parameter is ignored on UNIX platforms. The maximum number of clients that can be configured and running on UNIX systems is restricted by system resources and is not controlled by the MessageQ MAX_CLIENTS configuration parameter.

Correction to Description of Queue Number parameter (page 3-28)

The description of the queue number parameter incorrectly states that a queue can appear only once in the %QCT section of the group initialization file. A queue can actually appear in the %QCT section several times, however, the last valid entry supersedes all previous entries.

Caution When Using Global Naming (pages 3-34 through 3-37)

It is important to note that when using the naming feature, all path specifications must use the front slash (/) character regardless of whether the path specified is on a UNIX, Windows NT, or OpenVMS system. Using a backslash character (\) for the path specification is not valid.

Restriction on Stopping Links Using the Monitor Utility (page 4-12)

When you stop a link using the Monitor utility, it is important to understand that you can only restart the link from the same group on which it was stopped. For example, if the Monitor utility is connected to group A and you stop the link to group B, you must restart the link from group A. It can not be restarted from group B.

Correction to Modifiable Queue Characteristics (page 4-21)

Table 4-3 on page 4-21 of the BEA MessageQ Installation and Configuration Guide for UNIX incorrectly states that there are no runtime restrictions in changing the Security setting for a queue in the Queue Configuration Table (%QCT) section of the group initialization file. To change this queue characteristic at runtime, the queue does not need to be stopped, however, no process can be attached to it.

Addition of Performance Test Utility Documentation

The Performance Test utility enables users to test the message throughput of their current configuration by sending messages in a selected MessageQ configuration and reporting messaging rates. This utility runs as a MessageQ application and is invoked using a simple command line interface. The utility can send or receive a series of messages up to the maximum message size of 4MB and supports all Delivery Modes and Undeliverable Message Actions.

The Performance Test utility has two modes of operation, client or server. When running as a client, it begins by sending messages. When running as a server, it begins by waiting for messages to arrive.

The MessageQ Performance Test utility requires the following environment:

If you have installed MessageQ Server software on a Windows NT system, run the Performance Test utility by typing the following command:

dmqperftest [optional parameters]

If you have installed the MessageQ Client software on a Windows 95 or Windows NT system, run the Performance Test utility by typing the following command:

dmqclperftest [optional parameters]

Table 4-1 describes the optional parameters that can be used to control the operation of this utility.
Table 1: MessageQ Performance Test Command Parameters

Optional Switch Description

-? or -h

Prints a listing of command line parameters.

-q <queue>

Attaches to the queue number provided. If a zero (0) is used, the utility attaches to a temporary queue. In client mode, the default is zero. In server mode, the default is one (1).

-t <queue> or <group.queue>

The target queue to receive messages. If the group number is omitted or is zero, the local group is assumed. In client mode, the default group is local and the default queue is one (1). In server mode, the default group and queue is the source address sent by the client.

-n <number>

In client mode, this parameter specifies the number of messages to send. The default is 10,000 messages.

-b <number>

In client mode, this parameter specifies the number of messages to send before waiting for returned messages. The default if 50 messages.

-l <number>

The length of the message in bytes. The defaut is 1000 bytes.

-d <delivery>

The delivery mode in string form (may be upper or lower case). The default is no notification memory (NN_MEM).

-u <uma>

The deliverable message action (may be upper or lower case). The default is discard (DISC).

-x

Explicitly confirm each message. The queue must have the explicit confirmation attribute enabled.

-r

In client mode, receives the messages sent back by the server. In server mode, returns messages back to the client. If omitted, clients only send messages and servers only receive messages.

-v

Prints additional returned status information.

-c

Operate as a client. A client sends messages. It may receive returned messages by using -r switch. The client will exit when it finishes sending/receiving the number of messages provided with the -n switch.

-s

Operate as a server. A server receives message. The server has three modes of operations. It can absorb the received messages. This is the default mode. It can return the message to the client by using the -r switch. Or, it can forward the messages to another server by using the -r switch and by supplying a target by using the -t switch. If neither the -c or -s switch is supplied, then the -s is assumed. The server will continue running and must be terminated with a CTRL-C.

The Performance Test utility outputs an online report of each performance test. Reports are displayed in tabular form with the output of a new header when the screen is filled with 24 lines. Rates are presented in messages per second, time is in seconds. The display is updated every 5 seconds. Table 4-2 describes the data field on each report.

Performance Test Report

Field Description

Current

The rate calculated between 5 second intervals.

Average

The overall rate for this run.

Peak

The highest rate reached for this run.

Sent

The number of messages sent thus far.

Received

The number of messages received thus far.

Time

The time accoumulated while sending or receiving messages. This is used to calculate the average. This is not the same as the elapsed real time.

The following examples illustrate how to use the Performance Test utility in both client and server modes. These examples provide the syntax for using the utility on a MessageQ Server system. To run these examples on a MessageQ Client system, use the executable file name dmqclperftest and the same parameter settings.

Use the defaults to send messages from the client to the server:
In client mode... In server mode...

Attach to a temporary queue and send a message to queue 1:

Attach to queue 1 and receive messages:

dmqperftest -c

dmqperftest

Send messages from the client to the server, server returns messages to the client:
In client mode... In server mode...

Attach to a temporary queue, sends messages to queue 1 and receives returned messages:

Attach to queue 1, receive and return messages to the client:

dmqperftest -c -r

dmqperftest -r

Send recoverable messagse from the client to the server:
In client mode... In server mode...

Attach to a temporary queue, sends messages to queue 2:

Attach to queue 2 and receives messages:

dmqperftest -c -q 1
-t 0.2 -d wf_dqf -u saf

dmqperftest -s -q 2

Send messages from the client to server 1, server forwards the messages to server 2::
In client mode... Server 1... Server 2...

Attach to a temporary queue and send messages to queue 1:

Attach to queue 1, receive and forward messages to queue 2:

Attach to queue 2 and receive messages:

dmqperftest -c

dmqperftest -r -t 0.2

dmqperftest -q 2


Corrections to the Programmer's Guide

This section provides corrections to the BEA MessageQ Programmer's Guide, part number 850-001006-002.

Correction to the pams_read_jrn Function Description (page 8-111)

The prototypes for the source and target arguments are incorrected stated as "q_address". The correct prototype for these arguments is "int32*".