$JpStat: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$JpStat}} | {{DISPLAYTITLE:$JpStat}} | ||
<span class="pageSubtitle">Retrieve | <span class="pageSubtitle">Retrieve Janus port's statistics into string</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $JpStat function.</p> | ||
This function allows retrieval of a specific <var class="product">Janus</var> port into a string. | This function allows retrieval of a specific <var class="product">Janus</var> port into a string. | ||
| Line 8: | Line 8: | ||
The <var>$JpStat</var> function accepts two arguments and returns a string made up of an error code, the port name, | The <var>$JpStat</var> function accepts two arguments and returns a string made up of an error code, the port name, | ||
and returned statistics. | and returned statistics. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">%string = <var>$JpStat</var>(statList, portName)</p> | <p class="syntax">%string = <var>$JpStat</var>(statList, portName)</p> | ||
< | |||
data, the first | ===Syntax terms=== | ||
<table class="syntaxTable"> | |||
<tr><th>%string</th> | |||
<td>A string made up of a combination of binary and character string | |||
data, the first four bytes of which is an [[#Return codes|error code]]. If the error code is negative, <var class="term">%string</var> will be only four bytes long. </td></tr> | |||
<tr><th>statList</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. For more information about available statistics, see the <var class="book">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.</td></tr> | |||
<tr><th>portName</th> | |||
<td>The <var class="product">Janus</var> port name for which data is to be returned.</td></tr> | |||
</table> | |||
===Return codes=== | |||
<p class="code"> -5 - Required parameter not specified | |||
-12 - Invalid parameter | |||
-14 - Result string would be longer than 255 bytes | |||
</p> | |||
==Usage notes== | |||
The data returned by <var>$JpStat</var> is a combination of binary and character string data: | The data returned by <var>$JpStat</var> is a combination of binary and character string data: | ||
<ul> | <ul> | ||
<li>The first 4 bytes containing an error code. If the error code is negative, only | <li>The first 4 bytes containing an error code (described above). If the error code is negative, only four bytes are returned. | ||
If the error code is positive, it contains a number of milliseconds since the | 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. | ||
</ul> | </ul> | ||
When a positive error code is returned: | When a positive error code is returned: | ||
| Line 28: | Line 42: | ||
<li>The next 2 bytes (that is, starting at byte number 35) contain the binary number 1. | <li>The next 2 bytes (that is, starting at byte number 35) contain the binary number 1. | ||
<li>The port name is followed by the result statistics, starting at byte number 37. | <li>The port name is followed by the result statistics, starting at byte number 37. | ||
Statistics | Statistics that have string values are returned as eight bytes, left justified, blank filled. | ||
Numeric statistics are returned as | Numeric statistics are returned as four-byte binary values. | ||
</ul> | </ul> | ||
==Example== | |||
The following program displays some totals for the port named <code>DATA.INFO</code>: | The following program displays some totals for the port named <code>DATA.INFO</code>: | ||
| Line 63: | Line 70: | ||
<li>[[Sirius $Functions]] | <li>[[Sirius $Functions]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$JpStat]] | [[Category:$Functions|$JpStat]] | ||
Revision as of 20:32, 4 April 2013
Retrieve Janus port's statistics into string
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $JpStat function.
This function allows retrieval of a specific Janus port into a string.
The $JpStat function accepts two arguments and returns a string made up of an error code, the port name, and returned statistics.
Syntax
%string = $JpStat(statList, portName)
Syntax terms
| %string | A string made up of a combination of binary and character string data, the first four bytes of which is an error code. If the error code is negative, %string will be only four bytes long. |
|---|---|
| statList | 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. |
| portName | The Janus port name for which data is to be returned. |
Return codes
-5 - Required parameter not specified -12 - Invalid parameter -14 - Result string would be longer than 255 bytes
Usage notes
The data returned by $JpStat is a combination of binary and character string data:
- The first 4 bytes containing an error code (described above). If the error code is negative, only four 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 30 bytes (that is, starting at byte number 5) contain the port name.
- The next 2 bytes (that is, starting at byte number 35) contain the binary number 1.
- The port name is followed by the result statistics, starting at byte number 37. Statistics that have string values are returned as eight bytes, left justified, blank filled. Numeric statistics are returned as four-byte binary values.
Example
The following program displays some totals for the port named DATA.INFO:
B %data is string len 255 %data = $jpStat('ACTIVE STATUS', 'DATA.INFO') if $len(%data) = 4 then print '$jpStat error... rc = ' with $unbin(%data) stop end if print 'Name = ' with $substr(%data, 5, 30) print 'Active = ' with $unbin( $substr(%data, 5 + 32, 4) ) print 'Status = ' with $substr(%data, 5 + 32 + 4, 8) end