$TkStat: Difference between revisions

Revision as of 21:11, 3 October 2016

Retrieve task's statistics into string

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TkStat function.

This function allows retrieval of a specific task's statistics into a string.

The $TkStat function accepts two argument and returns a string made up of an error code and returned statistics.

Syntax

%string = $TkStat(stat_list, task_num)

Syntax terms

%string

A string containing binary data. If the string is exactly four bytes, it contains an error code.

Otherwise, the first four bytes contain the number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics.

The next ten bytes contain blanks, then follows two bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.

stat_list

A string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of four bytes. This facilitates the use of $StatD with the returned string.

For more information about available statistics, see the SirMon M204wiki pages.

task_num

The task number of the task for which data is to be returned. The maintask is always task number 0. Other tasks are only available for Onlines running the MP/204 feature.

Return codes

-5 Required parameter not specified -12 Invalid parameter (argument 2 > NMPSUBS) -13 STAT not linked in -14 Result string would be longer than 255 bytes

Example

The following program displays some totals for subtask 1:

Begin %data IS STRING LEN 255 %data = $TkStat('CPU STDEQ LKWAIT', 1) IF $LEN(%data) = 4 THEN PRINT '$TKSTAT ERROR... RC = ' WITH $Unbin(%data) STOP END IF PRINT 'CPU = ' WITH $Unbin( $Substr(%data, 17, 4) ) PRINT 'STDEQ = ' WITH $Unbin( $Substr(%data, 21, 4) ) PRINT 'LKWAIT = ' WITH $Unbin( $Substr(%data, 25, 4) ) End

Products authorizing $TkStat

Sirius functions

@@ Line 2: / Line 2: @@
 <span class="pageSubtitle">Retrieve task's statistics into string</span>
-<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TkStat function.</p>
+<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$TkStat</var> function.</p>
 This function allows retrieval of a specific task's statistics into a string.
@@ Line 15: / Line 15: @@
 <table>
 <tr><th>%string</th>
-<td>Binary data, the first 4 bytes of which is an error code. If the error code is negative %string will only be 4 bytes long.</td></tr>
+<td>A string containing binary data. If the string is exactly four bytes, it contains an [[#Return codes|error code]].
+<p>
+Otherwise, the first four bytes contain the number of milliseconds that the Online has been up. This provides a convenient number for calculating rates for the statistics. </p>
+<p>
+The next ten bytes contain blanks, then follows two bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.</p></td></tr>
 <tr><th>stat_list</th>
-<td>A string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of <var>$StatD</var> with the returned string.
+<td>A string of blank-delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of four bytes. This facilitates the use of <var>$StatD</var> with the returned string.
 <p>
-For more information about available statistics, see the <var class="book">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.</p> </td></tr>
+For more information about available statistics, see the <var class="book">[[SirMon]]</var> M204wiki pages.</p> </td></tr>
 <tr><th>task_num</th>
-<td>The task number of the task for which data is to be returned. The maintask is always task number 0. Other tasks are only available for Onlines running the MP/204 feature.</td></tr>
+<td>The task number of the task for which data is to be returned. The maintask is always task number 0. Other tasks are only available for Onlines running the [[MP/204]] feature.</td></tr>
 </table>
 ===Return codes===
-<p class="code"> -5 - Required parameter not specified
+<p class="code"> -5   Required parameter not specified
--12 - Invalid parameter (argument 2 > NMPSUBS)
+-12   Invalid parameter (argument 2 > NMPSUBS)
--13 - STAT not linked in
+-13   STAT not linked in
--14 - Result string would be longer than 255 bytes
+-14   Result string would be longer than 255 bytes
 </p>
-==Usage notes==
-<ul>
-<li>The data returned by $TkStat is binary with the first 4 bytes containing an error code. If the error code is negative, only 4 bytes are returned. If the error code is positive, it contains a number of milliseconds since the online region was brought up. This provides a convenient number for calculating rates for the statistics. When a positive error code is returned the next 10 bytes contain blanks followed by 2 bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.
-</ul>
 ==Example==
 The following program displays some totals for subtask 1:
-<p class="code">B
+<p class="code">Begin
+%data IS STRING LEN 255
-%DATA IS STRING LEN 255
+%data = $TkStat('CPU STDEQ LKWAIT', 1)
+IF $LEN(%data) = 4 THEN
-%DATA = $TkStat('CPU STDEQ LKWAIT', 1)
+    PRINT '$TKSTAT ERROR... RC = ' WITH $Unbin(%data)
-IF $LEN(%DATA) = 4 THEN
-    PRINT '$TKSTAT ERROR... RC = ' WITH $UNBIN(%DATA)
     STOP
 END IF
-PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) )
+PRINT 'CPU = ' WITH $Unbin( $Substr(%data, 17, 4) )
-PRINT 'STDEQ = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) )
+PRINT 'STDEQ = ' WITH $Unbin( $Substr(%data, 21, 4) )
-PRINT 'LKWAIT = ' WITH $UNBIN( $SUBSTR(%DATA, 25, 4) )
+PRINT 'LKWAIT = ' WITH $Unbin( $Substr(%data, 25, 4) )
+End
-END
 </p>