$TkStat: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Retrieve task's statistics into string<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Retrieve task's statistics into string<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TkStat function.</p> | ||
This function allows retrieval of a specific task's statistics into a string. | This function allows retrieval of a specific task's statistics into a string. | ||
| Line 11: | Line 11: | ||
The second argument is 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. | The second argument is 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. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %STRING = $TkStat(stat_list, task_num) | <p class="syntax"><section begin="syntax" /> %STRING = $TkStat(stat_list, task_num) | ||
| Line 18: | Line 19: | ||
<p class="caption">%STRING is made up of 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.</p> | <p class="caption">%STRING is made up of 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.</p> | ||
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. | |||
<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 | ||
| Line 28: | Line 30: | ||
</p> | </p> | ||
The following program displays some totals for subtask 1. | |||
<p class="code"> B | <p class="code"> B | ||
| Line 37: | Line 38: | ||
%DATA = $TkStat('CPU STDEQ LKWAIT', 1) | %DATA = $TkStat('CPU STDEQ LKWAIT', 1) | ||
IF $LEN(%DATA) = 4 THEN | IF $LEN(%DATA) = 4 THEN | ||
PRINT '$TKSTAT ERROR... RC = ' WITH $UNBIN(%DATA) | |||
STOP | |||
END IF | END IF | ||
| Line 47: | Line 48: | ||
END | END | ||
</p> | </p> | ||
<ul class="smallAndTightList"> | |||
<li>[[Sirius $Functions]] | |||
</ul> | </ul> | ||
<p class="caption">Products authorizing $TkStat | <p class="caption">Products authorizing $TkStat | ||
</p> | </p> | ||
[[Category:$Functions|$TkStat]] | [[Category:$Functions|$TkStat]] | ||
Revision as of 20:43, 8 February 2011
<section begin="desc" />Retrieve task's statistics into string<section end="desc" />
Most Sirius $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.
The first argument is 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 $StatD with the returned string. For more information about available statistics, see the "SirMon User's Guide".
The second argument is 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.
Syntax
<section begin="syntax" /> %STRING = $TkStat(stat_list, task_num) <section end="syntax" />
$TkStat Function
%STRING is made up of 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.
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.
-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
$TkStat return codes
The following program displays some totals for subtask 1.
B %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