fhb_S_Timer Command

The fhb_S_Timer command allows you to create and manage a records file that reports throughput measurements of your FSI Hot Backup system on a single record. To measure the throughput on multiple records, see fhb_S_Timer_enqueue Command.

You can also report throughput measurements of your FSI Hot Backup system on a single record using the fhb_S_Timer_enqueue.sub_Subroutine from a FlashBASIC program (described below).

NOTE	The Primary and Secondary FSI Hot Backup servers must be configured and operational for throughput measurement to occur.

Syntax

fhb_S_Timer Command QueueNum Comment

Parameter(s)

Command

Specifies the command to run. If no command is specified, the default is enqueue.

create

Creates the timer records file which is a special data level of the FHB file (in the FSIDM account). When running this command, the secondary FSI Hot Backup server must be configured. After running this command, the secondary server must be restarted to enable throughput measurement.

display

Displays a throughput measurement report on the screen. The report includes the following information:

Date and time the timer record first entered the primary queue on the primary server.

The destination helper queue number for the timer record.
The "in" time (time that elapsed from the primary enqueuing to the timer record's placement in the secondary queue on the secondary server).
The "out" time (time that elapsed from the secondary enqueuing to the timer record's removal from the secondary queue on the secondary server).

If there are no records to report, this message displays:

No timer records to display

clear

Clears all accumulated records from the timer records file.

remove

Deletes the timer records file (if present). When running this command, the secondary FSI Hot Backup server must be configured but not running.

enqueue

(Default) Enqueues a single record. When running this form of the command, a Queue# must be specified.

QueueNum

Specifies the destination helper queue number. This only applies when running the enqueue form of the command.

Comment

Optional comment for the measurement display. This only applies when running the enqueue form of the command.

Example(s)

The example below illustrates creating a new timer records file.

fhb_S_Timer create

Secondary Timer Queue created

Please stop and restart the Secondary Server to enable

The example below illustrates clearing all accumulated records from the timer records file.

fhb_S_Timer clear

The example below illustrates deleting the timer records file.

fhb_S_Timer remove

The example below illustrates enqueueing a record destined to be processed by helper queue number 1. The text A/P Month End will be displayed with the measurement display.

fhb_S_Timer enqueue 1 A/P Month End

The example below illustrates enqueueing a record destined to be processed by helper queue number 2. The text End of Day will be displayed with the measurement display. Note that even though the enqueue command keyword is not supplied, the command still runs as normal since enqueue is the default command.

fhb_S_Timer 2 End of Day

The example below illustrates enqueueing a record destined to be processed by helper queue number 3. In this case, no comment text will be displayed with the measurement display.

fhb_S_Timer 3

The example below illustrates displaying a throughput measurement report on the screen. The report includes the date and time the timer record first entered the primary queue on the primary server, the destination helper queue number for the timer record, the in time (time that elapsed from the primary enqueuing to the timer record's placement in the secondary queue on the secondary server) and the out time (time that elapsed from the secondary enqueuing to the timer record's removal from the secondary queue on the secondary server).

fhb_S_Timer display

Secondary Queue Throughput

12/23/10 16:19:44 Q#1 in: 00:03:14 out: 00:00:01

12/23/10 16:19:44 Q#3 in: 00:03:14 out: 00:00:01

fhb_S_Timer_enqueue.sub Subroutine

The fhb_S_Timer_enqueue.sub subroutine allows you to enqueue a single timer record from your own FlashBASIC program. See the fhb_S_Timer command parameters (described above) for descriptions of the arguments employed in this subroutine.

Example 1

The example below illustrates enqueueing a record destined for helper queue number 1 with a measurement display comment of "comment text". The subroutine is a single-argument subroutine that assumes the destination queue number is the first element of the space-delimited argument. If there is anything after the first space in the argument, it is treated as a comment. In this example the argument is a variable which was pre-loaded with the queue number and a comment. Since the argument is a variable, it can be tested for subroutine return errors as shown in the example.

031 sub_arg = \1 comment text\

032 call fhb_S_Timer_enqueue.sub(sub_arg)

033 if sub_arg # \\ then go ProcessErrorCondition

Example 2

The example below illustrates enqueueing a record destined for helper queue number 2 with a measurement display comment of "comment text". In this example the argument is a literal which contains the queue number and a comment. Since the argument is a literal, it cannot be tested for subroutine return errors as in the previous example.

032 call fhb_S_Timer_enqueue.sub("2 comment text")

Example 3

The example below illustrates enqueueing a record destined for helper queue number 3 with no comment or error-checking capability. This is the shortest form of the subroutine's usage.

032 call fhb_S_Timer_enqueue.sub(3)