$JpStat - Revision history

JAL: /* Syntax */ add "unsigned"

2016-10-04T14:54:26Z

Syntax: add "unsigned"

← Older revision		Revision as of 14:54, 4 October 2016
Line 35:		Line 35:
	<ul>		<ul>
	<li>If exactly four bytes are returned, the bytes contain a binary number that is an error code; these are described above.		<li>If exactly four bytes are returned, the bytes contain a binary number that is an error code; these are described above.
	Otherwise, the first four bytes contain the binary number of milliseconds since the Online region was brought up. This provides a convenient number for calculating rates for the statistics. </li>		Otherwise, the first four bytes contain the unsigned binary number of milliseconds since the Online region was brought up. This provides a convenient number for calculating rates for the statistics. </li>

	<li>The next 30 bytes (that is, starting at byte number 5) contain the port name. </li>		<li>The next 30 bytes (that is, starting at byte number 5) contain the port name. </li>

JAL: clarify return value

2016-10-03T21:43:27Z

clarify return value

← Older revision		Revision as of 21:43, 3 October 2016
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve Janus port's statistics into string</span>		<span class="pageSubtitle">Retrieve Janus port'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 $JpStat 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>$JpStat</var> 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 15:		Line 15:
	<table>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string ~~made up of~~ a combination of binary and character string		<td>A string that might be 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>		data. For details, see the "Usage notes," below. </td></tr>

	<tr><th>statList</th>		<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="product">[[SirMon#SirMon topics\|SirMon]]</var> ~~wiki~~ pages.</td></tr>		<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. For more information about available statistics, see the <var class="product">[[SirMon#SirMon topics\|SirMon]]</var> M204wiki pages.</td></tr>

	<tr><th>portName</th>		<tr><th>portName</th>
Line 26:		Line 26:

	===Return codes===		===Return codes===
	<p class="code"> -5 ~~—~~ Required parameter not specified		<p class="code"> -5 Required parameter not specified
	-12 ~~—~~ Invalid parameter		-12 Invalid parameter
	-14 ~~—~~ Result string would be longer than 255 bytes		-14 Result string would be longer than 255 bytes
	</p>		</p>

	==Usage notes==		==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 string that might be a combination of binary and character string data:
	<ul>		<ul>
	<li>~~The first 4~~ bytes ~~containing~~ an error code (described above). If the ~~error code is negative, only~~ four bytes ~~are returned.~~		<li>If exactly four bytes are returned, the bytes contain a binary number that is an error code; these are described above.
	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.		Otherwise, the first four bytes contain the binary number of milliseconds since the Online region was brought up. This provides a convenient number for calculating rates for the statistics. </li>
	</ul>
	~~When a positive error code is returned:~~		<li>The next 30 bytes (that is, starting at byte number 5) contain the port name. </li>
	~~<ul>~~
	<li>The next 30 bytes (that is, starting at byte number 5) contain the port name.		<li>The next 2 bytes (that is, starting at byte number 35) contain the binary number 1. </li>
	<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 that have string values are returned as eight bytes, left justified, blank filled.		Statistics that have string values are returned as eight bytes, left justified, blank filled.
	Numeric statistics are returned as four-byte binary values.		Numeric statistics are returned as four-byte binary values. </li>
	</ul>		</ul>

JAL: link repair

2016-09-13T17:02:12Z

link repair

← Older revision		Revision as of 17:02, 13 September 2016
Line 10:		Line 10:

	==Syntax==		==Syntax==
	<p class="syntax">%string = <~~var~~>~~$JpStat~~</~~var~~>~~(statList~~, portName)</p>		<p class="syntax">%string = $JpStat(<span class="term">statList</span>, <span class="term">portName</span>)</p>

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string made up of a combination of binary and character string		<td>A string made up of a combination of binary and character string
Line 19:		Line 19:

	<tr><th>statList</th>		<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>		<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="product">[[SirMon#SirMon topics\|SirMon]]</var> wiki pages.</td></tr>

	<tr><th>portName</th>		<tr><th>portName</th>
Line 26:		Line 26:

	===Return codes===		===Return codes===
	<p class="code"> -5 - Required parameter not specified		<p class="code"> -5 — Required parameter not specified
	-12 - Invalid parameter		-12 — Invalid parameter
	-14 - Result string would be longer than 255 bytes		-14 — Result string would be longer than 255 bytes
	</p>		</p>

Line 49:		Line 49:
	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>:

	<p class="code"> B		<p class="code">B

	%data is string len 255		%data is string len 255

	%data = $jpStat('ACTIVE STATUS', 'DATA.INFO')		%data = $jpStat('ACTIVE STATUS', 'DATA.INFO')
	if $len(%data) = 4 then		if $len(%data) = 4 then
	print '$jpStat error... rc = ' with $unbin(%data)		print '$jpStat error... rc = ' with $unbin(%data)
	stop		stop
	end if		end if

	print 'Name = ' with $substr(%data, 5, 30)		print 'Name = ' with $substr(%data, 5, 30)
	print 'Active = ' with $unbin( $substr(%data, 5 + 32, 4) )		print 'Active = ' with $unbin( $substr(%data, 5 + 32, 4) )
	print 'Status = ' with $substr(%data, 5 + 32 + 4, 8)		print 'Status = ' with $substr(%data, 5 + 32 + 4, 8)

	end		end
	</p>		</p>

JAL: /* Products authorizing {{PAGENAMEE}} */

2014-08-13T20:43:01Z

Products authorizing {{PAGENAMEE}}

← Older revision		Revision as of 20:43, 13 August 2014
Line 68:		Line 68:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius ~~$Functions~~]]		<li>[[List of $functions\|Sirius functions]]</li>
	</ul>		</ul>


	[[Category:$Functions\|$JpStat]]		[[Category:$Functions\|$JpStat]]

JALWiccan: Automatically generated page update

2013-07-18T20:52:45Z

Automatically generated page update

← Older revision		Revision as of 20:52, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve Janus port's statistics into string</span>		<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 $JpStat function.</p>		<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 $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.

Admin at 20:32, 4 April 2013

2013-04-04T20:32:10Z

← Older revision		Revision as of 20:32, 4 April 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$JpStat}}		{{DISPLAYTITLE:$JpStat}}
	<span class="pageSubtitle">Retrieve ~~<var class="product">~~Janus~~</var>~~ port's statistics into string</span>		<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 ~~<var>~~$JpStat~~</var>~~ function.</p>		<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.

	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 <var>[[$StatD]]</var> with the returned string. For more information about available statistics, see the <var class="product">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.

	~~The second argument is the <var class="product">Janus</var> port name for which data is to be returned.~~

	==Syntax==		==Syntax==
	<p class="syntax">%string = <var>$JpStat</var>(statList, portName)</p>		<p class="syntax">%string = <var>$JpStat</var>(statList, portName)</p>
	<p>%string is made up of a combination of binary and character string
	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>		===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 4 bytes are returned.		<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 ~~online~~ region was brought up. This provides a convenient number for calculating rates for the statistics.		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 ~~which~~ have string values are returned as 8 bytes, left justified, blank filled.		Statistics that have string values are returned as eight bytes, left justified, blank filled.
	Numeric statistics are returned as 4 byte binary values.		Numeric statistics are returned as four-byte binary values.
	</ul>		</ul>

	~~<p class~~=~~"code">~~		==Example==
	~~-5 - Required parameter not specified~~
	~~-12 - Invalid parameter~~
	~~-14 - Result string would be longer than 255 bytes~~
	~~</p>~~
	~~<p class~~=~~"caption"><var>$JpStat</var> return codes~~
	~~</p>~~

	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>

	~~<p>~~
	~~</p>~~

	[[Category:$Functions\|$JpStat]]		[[Category:$Functions\|$JpStat]]

Dme at 18:15, 3 April 2013

2013-04-03T18:15:39Z

← Older revision		Revision as of 18:15, 3 April 2013
Line 14:		Line 14:

	==Syntax==		==Syntax==
	<p class="syntax">%string = <var>$JpStat</var>(~~stat_list~~, ~~task_num~~)</p>		<p class="syntax">%string = <var>$JpStat</var>(statList, portName)</p>
	<p>%string is made up of a combination of binary and character string		<p>%string is made up of a combination of binary and character string
	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>		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>
Line 25:		Line 25:
	When a positive error code is returned:		When a positive error code is returned:
	<ul>		<ul>
	<li>The next 32 bytes (that is, starting at byte number 5) contain the port name.		<li>The next 30 bytes (that is, starting at byte number 5) contain the port name.
			<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 which have string values are returned as 8 bytes, left justified, blank filled.		Statistics which have string values are returned as 8 bytes, left justified, blank filled.
Line 51:		Line 52:
	end if		end if

	print 'Name = ' with $substr(%data, 5, 32)		print 'Name = ' with $substr(%data, 5, 30)
	print 'Active = ' with $unbin( $substr(%data, 5 + 32, 4) )		print 'Active = ' with $unbin( $substr(%data, 5 + 32, 4) )
	print 'Status = ' with $substr(%data, 5 + 32 + 4, 8)		print 'Status = ' with $substr(%data, 5 + 32 + 4, 8)

Dme: Created page with "{{DISPLAYTITLE:$JpStat}} Retrieve `Janus` port's statistics into string
Most Sirius $functions ..."

2013-04-03T16:34:35Z

Created page with "{{DISPLAYTITLE:$JpStat}} Retrieve <var class="product">Janus</var> port's statistics into string Most Sirius $functions ..."

New page

{{DISPLAYTITLE:$JpStat}}
Retrieve <var class="product">Janus</var> port's statistics into string

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$JpStat</var> function.

This function allows retrieval of a specific <var class="product">Janus</var> port into a string.

The <var>$JpStat</var> function accepts two arguments and returns a string made up of an error code, the port name,
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 <var>[[$StatD]]</var> with the returned string. For more information about available statistics, see the <var class="product">[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]</var>.

The second argument is the <var class="product">Janus</var> port name for which data is to be returned.

==Syntax==
%string = <var>$JpStat</var>(stat_list, task_num)
%string is made up of a combination of binary and character string
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 <var>$JpStat</var> is a combination of binary and character string data:
<ul>
<li>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.
</ul>
When a positive error code is returned:
<ul>
<li>The next 32 bytes (that is, starting at byte number 5) contain the port name.
<li>The port name is followed by the result statistics, starting at byte number 37.
Statistics which have string values are returned as 8 bytes, left justified, blank filled.
Numeric statistics are returned as 4 byte binary values.
</ul>


-5 - Required parameter not specified
-12 - Invalid parameter
-14 - Result string would be longer than 255 bytes

<var>$JpStat</var> return codes


The following program displays some totals for the port named <code>DATA.INFO</code>:

 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, 32)
print 'Active = ' with $unbin( $substr(%data, 5 + 32, 4) )
print 'Status = ' with $substr(%data, 5 + 32 + 4, 8)

end


==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<li>[[Sirius $Functions]]
</ul>




[[Category:$Functions|$JpStat]]