$WakeUp - Revision history

EllieWiccan: Automatically generated page update

2018-09-20T23:31:00Z

Automatically generated page update

← Older revision		Revision as of 23:31, 20 September 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Pause user until specified time</span>		<span class="pageSubtitle">Pause user until specified time</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 $WakeUp 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 $WakeUp function.</p>

	The $WakeUp function accepts three arguments and returns a number that is the number of milliseconds since the Online was brought up. It is a [[Calling Sirius Mods $functions\|callable]] $function .		The $WakeUp function accepts three arguments and returns a number that is the number of milliseconds since the Online was brought up. It is a [[Calling Sirius Mods $functions\|callable]] $function .

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

2014-08-13T20:35:56Z

Products authorizing {{PAGENAMEE}}

← Older revision		Revision as of 20:35, 13 August 2014
Line 56:		Line 56:
	==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\|$WakeUp]]		[[Category:$Functions\|$WakeUp]]

JDamon: /* Syntax terms */

2014-07-31T02:30:43Z

Syntax terms

← Older revision		Revision as of 02:30, 31 July 2014
Line 17:		Line 17:
	<tr><th>wake_time</th>		<tr><th>wake_time</th>
	<td>A number indicating the time to wake up, expressed as milliseconds since the Online was brought up.		<td>A number indicating the time to wake up, expressed as milliseconds since the Online was brought up.
	<p>Use %TIME = $WakeUp(0) to acquire the time, in milliseconds, since the run came up. For subsequent $WakeUp calls, %TIME can then be used as the base time for the wake_time parameter. See the following example.</td></tr>		<p>Use %TIME = $WakeUp(0) to acquire the time, in milliseconds, since the run came up. For subsequent $WakeUp calls, %TIME can then be used as the base time for the wake_time parameter. See the following example.</p></td></tr>

	<tr><th>rqtm_flag</th>		<tr><th>rqtm_flag</th>

JDamon: Minor clarification of the wake_time parameter.

2014-07-31T02:28:51Z

Minor clarification of the wake_time parameter.

← Older revision		Revision as of 02:28, 31 July 2014
Line 16:		Line 16:

	<tr><th>wake_time</th>		<tr><th>wake_time</th>
	<td>A number indicating the time to wake up, expressed as milliseconds since the Online was brought up. </td></tr>		<td>A number indicating the time to wake up, expressed as milliseconds since the Online was brought up.
			<p>Use %TIME = $WakeUp(0) to acquire the time, in milliseconds, since the run came up. For subsequent $WakeUp calls, %TIME can then be used as the base time for the wake_time parameter. See the following example.</td></tr>

	<tr><th>rqtm_flag</th>		<tr><th>rqtm_flag</th>

JAL: /* Example */

2013-07-25T00:19:48Z

Example

← Older revision		Revision as of 00:19, 25 July 2013
Line 51:		Line 51:
	READ SCREEN SCREEN3		READ SCREEN SCREEN3
	%TIME = $WakeUp( %TIME + 2300, 1)		%TIME = $WakeUp( %TIME + 2300, 1)
	</p>		</p>

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==

JAL at 00:19, 25 July 2013

2013-07-25T00:19:18Z

← Older revision		Revision as of 00:19, 25 July 2013
Line 4:		Line 4:
	<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 $WakeUp 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 $WakeUp function.</p>

	~~This~~ function ~~can be used to have~~ the ~~user pause until~~ a ~~particular time~~. ~~The chief advantages of $WakeUp over the PAUSE statement are~~		The $WakeUp function accepts three arguments and returns a number that is the number of milliseconds since the Online was brought up. It is a [[Calling Sirius Mods $functions\|callable]] $function .

	~~<ul>~~		==Syntax==
	~~<li>You can wake up at a particular time rather than after a particular number of seconds have passed.~~		<p class="syntax">[%time =] $WakeUp(wake_time, rqtm_flag, [option])
	~~<li>$WakeUp has millisecond resolution versus the second resolution of the PAUSE statement.~~		</p>
	<li>~~$WakeUp allows the wait~~ time ~~to not be counted toward RQTM. This is useful in cases where the pause is simply a standard part of processing rather than a pause to allow some condition to clear.~~
	~~<li>~~$WakeUp ~~will allow a user to break in with a terminal interrupt on VTAM full screen terminals.~~
	</ul>

	~~The $WakeUp function accepts three arguments and returns a number that is the number of milliseconds since the online was brought up~~. ~~As of~~ <~~var class="product"~~>~~[[Sirius Mods]]~~</~~var~~> ~~Version 6.8, it is a [[Calling Sirius Mods $functions\|callable]] $function .~~		===Syntax terms===
			<table>
			<tr><th>%time</th>
			<td>A positive integer.</td></tr>

	~~The first argument is a~~ number indicating the time to wake up expressed as milliseconds since the ~~online~~ was brought up.		<tr><th>wake_time</th>
			<td>A number indicating the time to wake up, expressed as milliseconds since the Online was brought up. </td></tr>

	~~The second argument is a~~ number, which if present and non-zero, indicates that the wait time is not to be included as part of RQTM.		<tr><th>rqtm_flag</th>
			<td>A number, which if present and non-zero, indicates that the wait time is not to be included as part of RQTM. </td></tr>

	~~The third argument is an~~ optional string (<tt>NOURGMSG</tt>, case unimportant) that prevents a user paused by $WakeUp from being immediately wakened if a BROADCAST URGENT message is sent.		<tr><th>option</th>
			<td>An optional string (<code>NOURGMSG</code>, case unimportant) that prevents a user paused by <var>$WakeUp</var> from being immediately wakened if a <code>BROADCAST URGENT</code> message is sent. </td></tr>
			</table>

	The ~~third argument is available as~~ of <var ~~class="product"~~>~~Sirius Mods~~</var> ~~Version 7.2. Prior to~~ <var ~~class="product"~~>~~Sirius Mods~~</var> ~~7.2, $WakeUp completes immediately if~~ a ~~BROADCAST URGENT message is sent to the user~~. ~~The functionality of this argument is also available (though not controlled by an argument) via zap in~~ <var ~~class="product"~~>~~Sirius Mods~~</var> ~~6.7 and 7.1, as described in~~ the <var ~~class="product"~~>~~Sirius Mods~~</var> ~~Release Notes for those versions~~.		==Usage notes==
			<ul>
	~~==Syntax==~~		<li>The chief advantages of <var>$WakeUp</var> over the <var>PAUSE</var> statement are
	<~~p class="syntax"~~>~~[%TIME =]~~ $WakeUp~~(wake_time, rqtm_flag, [option])~~		<ul>
	</p>		<li>You can wake up at a particular time rather than after a particular number of seconds have passed.
	<p>		<li><var>$WakeUp</var> has millisecond resolution versus the second resolution of the <var>PAUSE</var> statement.
	</p>		<li><var>$WakeUp</var> allows the wait time to not be counted toward RQTM. This is useful in cases where the pause is simply a standard part of processing rather than a pause to allow some condition to clear.
	<p>~~%TIME is a positive integer.~~</p>		<li><var>$WakeUp</var> will allow a user to break in with a terminal interrupt on VTAM full screen terminals.
			</ul>
			</ul>

			==Example==
	In the following code fragment, three screens are automatically displayed for 2.3 seconds each. The sleep time is not counted toward RQTM.		In the following code fragment, three screens are automatically displayed for 2.3 seconds each. The sleep time is not counted toward RQTM.

	<p class="code"> %TIME = $WakeUp(0)		<p class="code">%TIME = $WakeUp(0)
	%RC = $FakeEnt		%RC = $FakeEnt
	READ SCREEN SCREEN1		READ SCREEN SCREEN1
	%TIME = $WakeUp( %TIME + 2300, 1)		%TIME = $WakeUp( %TIME + 2300, 1)

	%RC = $FakeEnt		%RC = $FakeEnt
	READ SCREEN SCREEN2		READ SCREEN SCREEN2
	%TIME = $WakeUp( %TIME + 2300, 1)		%TIME = $WakeUp( %TIME + 2300, 1)

	%RC = $FakeEnt		%RC = $FakeEnt
	READ SCREEN SCREEN3		READ SCREEN SCREEN3
	%TIME = $WakeUp( %TIME + 2300, 1)		%TIME = $WakeUp( %TIME + 2300, 1)
			</p>
	</p>

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
Line 51:		Line 57:
	<li>[[Sirius $Functions]]		<li>[[Sirius $Functions]]
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

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

JALWiccan: Automatically generated page update

2013-07-19T18:59:46Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Pause user until specified time</span>		<span class="pageSubtitle">Pause user until specified time</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $WakeUp 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 $WakeUp function.</p>

	This function can be used to have the user pause until a particular time. The chief advantages of $WakeUp over the PAUSE statement are		This function can be used to have the user pause until a particular time. The chief advantages of $WakeUp over the PAUSE statement are

JALWiccan: Automatically generated page update

2013-04-10T18:18:00Z

Automatically generated page update

← Older revision		Revision as of 18:18, 10 April 2013
Line 24:		Line 24:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>[%TIME =] $WakeUp(wake_time, rqtm_flag, [option])		<p class="syntax">[%TIME =] $WakeUp(wake_time, rqtm_flag, [option])
	~~<section end="syntax" />~~</p>		</p>
	<p>		<p>
	</p>		</p>

DmeWiccan: 1 revision

2012-11-07T21:33:01Z

1 revision

← Older revision	Revision as of 21:33, 7 November 2012
(No difference)

JAL at 21:32, 7 November 2012

2012-11-07T21:32:39Z

← Older revision		Revision as of 21:32, 7 November 2012
Line 47:		Line 47:
	</p>		</p>

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