RunAsynchronously (Daemon subroutine) - Revision history

JAL2: /* Usage notes */

2012-05-22T20:56:01Z

Usage notes

← Older revision		Revision as of 20:56, 22 May 2012
Line 54:		Line 54:
	<p>Note that this will buy nothing if the requests are CPU-intensive and the request is not running with <code>AMPSUBS>0</code> (requires <var class="product">MP/204</var>). Note also that if the daemons hold or require record locks that might conflict with each other, such a split will not work. Finally, since <var>RunAsynchronously</var> is not allowed for a transactional daemon, such a split is not feasible for transactional daemons.</p>		<p>Note that this will buy nothing if the requests are CPU-intensive and the request is not running with <code>AMPSUBS>0</code> (requires <var class="product">MP/204</var>). Note also that if the daemons hold or require record locks that might conflict with each other, such a split will not work. Finally, since <var>RunAsynchronously</var> is not allowed for a transactional daemon, such a split is not feasible for transactional daemons.</p>

	<li>For more information about asynchronous daemons, see [[Daemon class#Asynchronous and Independent daemons\|"Asynchronous and Independent daemons"]]~~</ul>~~		<li>For more information about asynchronous daemons, see [[Daemon class#Asynchronous and Independent daemons\|"Asynchronous and Independent daemons"]].
	</ul>		</ul>

JAL2: /* Usage notes */

2012-05-22T20:55:26Z

Usage notes

← Older revision		Revision as of 20:55, 22 May 2012
Line 53:		Line 53:
	</p>		</p>
	<p>Note that this will buy nothing if the requests are CPU-intensive and the request is not running with <code>AMPSUBS>0</code> (requires <var class="product">MP/204</var>). Note also that if the daemons hold or require record locks that might conflict with each other, such a split will not work. Finally, since <var>RunAsynchronously</var> is not allowed for a transactional daemon, such a split is not feasible for transactional daemons.</p>		<p>Note that this will buy nothing if the requests are CPU-intensive and the request is not running with <code>AMPSUBS>0</code> (requires <var class="product">MP/204</var>). Note also that if the daemons hold or require record locks that might conflict with each other, such a split will not work. Finally, since <var>RunAsynchronously</var> is not allowed for a transactional daemon, such a split is not feasible for transactional daemons.</p>

			<li>For more information about asynchronous daemons, see [[Daemon class#Asynchronous and Independent daemons\|"Asynchronous and Independent daemons"]]</ul>
	</ul>		</ul>

JAL2: /* Syntax terms */

2012-05-22T19:03:54Z

Syntax terms

← Older revision		Revision as of 19:03, 22 May 2012
Line 10:		Line 10:
	<tr><th>commands</th>		<tr><th>commands</th>
	<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the daemon.</td></tr>		<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the daemon.</td></tr>
	<tr><th>~~object~~</th>		<tr><th><var>Input</var></th>
	<td>An object passed to the <var class="term">daemon</var> object. This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is passed by deep copy and not by reference, so <var class="term">object</var> must be deep copyable, as described in [[Copying objects\|"Copying objects"]].		<td>An object passed to the <var class="term">daemon</var> object. This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is passed by deep copy and not by reference, so <var class="term">object</var> must be deep copyable, as described in [[Copying objects\|"Copying objects"]].
	<p>		<p>

JAL2: /* Syntax terms */

2012-05-22T19:02:16Z

Syntax terms

← Older revision		Revision as of 19:02, 22 May 2012
Line 10:		Line 10:
	<tr><th>commands</th>		<tr><th>commands</th>
	<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the daemon.</td></tr>		<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the daemon.</td></tr>
	<tr><th>~~inputObj~~</th>		<tr><th>object</th>
	<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is ~~either:~~		<td>An object passed to the <var class="term">daemon</var> object. This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is passed by deep copy and not by reference, so <var class="term">object</var> must be deep copyable, as described in [[Copying objects\|"Copying objects"]].
	~~<ul>~~		<p>
	~~<li>An object~~ passed ~~to the~~ <var class="term">~~daemon~~</var> ~~thread. This object~~ must be deep copyable, as described in: [[Copying objects\|"Copying objects"]].		The passed object can be retrieved by the daemon thread using the <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>. </p></td></tr>
	~~<li>A Boolean value. If a Null object~~
	<~~/ul~~>
	The passed object can be retrieved by the daemon thread using the <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.</td></tr>
	</table>		</table>

JAL2 at 23:21, 21 May 2012

2012-05-21T23:21:44Z

← Older revision		Revision as of 23:21, 21 May 2012
Line 38:		Line 38:
	<li><var>WaitAsynchronous</var> is used to retrieve any output from the commands run via <var>RunAsynchronously</var>. This includes the terminal output and any output or info object.		<li><var>WaitAsynchronous</var> is used to retrieve any output from the commands run via <var>RunAsynchronously</var>. This includes the terminal output and any output or info object.

	<li>As described in: [[Daemon class#Working with Daemon objects\|"Working with Daemon objects"]], the <var>RunAsynchronously</var> <var>~~String~~</var> argument can pass multiple commands to the <var>daemon</var>.		<li>As described in: [[Daemon class#Working with Daemon objects\|"Working with Daemon objects"]], the <var>RunAsynchronously</var> <var class="term">commands</var> argument can pass multiple commands to the <var class="term">daemon</var> object.

	<li>~~See [[Daemon class\|"Daemon class"]] for more information about passing commands and objects to a daemon — the~~ passing of objects and commands to daemons is identical whether the method is <var>Run</var> or <var>RunAsynchronously</var>.		<li>The passing of objects and commands to daemons is identical whether the method is <var>Run</var> or <var>RunAsynchronously</var> — see [[Daemon class#Working with Daemon objects\|"Working with Daemon objects"]] for more information about passing commands and objects to a <var>Daemon</var>.

	<li>If the <var>daemon</var> object associated with an asynchronously running <var>~~daemon~~</var> is discarded, either explicitly or implicitly; the <var>~~daemon~~</var> thread is bumped by the parent thread. An implicit discard can happen at request end (for non-global daemon objects) or at user logout.		<li>If the <var class="term">daemon</var> object associated with an asynchronously running <var>Daemon</var> is discarded, either explicitly or implicitly, the <var>Daemon</var> thread is bumped by the parent thread. An implicit discard can happen at request end (for non-global daemon objects) or at user logout.

	<li>The inputs and outputs from the combination of <var>RunAsynchronously</var> and <var>WaitAsynchronous</var> are identical to the inputs and outputs from <var>Run</var>. As such, it should be a relatively simple task to split a <var>Run</var> into a <var>RunAsynchronously</var> and <var>WaitAsynchronous</var>, allowing the daemon processing to be performed in parallel with parent thread processing or the processing on another daemon thread.		<li>The inputs and outputs from the combination of <var>RunAsynchronously</var> and <var>WaitAsynchronous</var> are identical to the inputs and outputs from <var>Run</var>. As such, it should be a relatively simple task to split a <var>Run</var> into a <var>RunAsynchronously</var> and <var>WaitAsynchronous</var>, allowing the daemon processing to be performed in parallel with parent thread processing or the processing on another daemon thread.

JAL2: /* Usage notes */

2012-05-21T23:13:08Z

Usage notes

← Older revision		Revision as of 23:13, 21 May 2012
Line 29:		Line 29:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Issuing <var>RunAsynchronously</var> against a transactional ~~<var>~~daemon~~</var>~~ results in request cancellation.		<li>Issuing <var>RunAsynchronously</var> against a [[Daemon class#Transactional daemons\|transactional daemon]] results in request cancellation.
	<li>If the <var>daemon</var> thread and its ~~<var>~~daemons~~</var>~~ hold record locks that conflict with the parent thread's family (excluding the <var>daemon</var> thread and its ~~<var>~~daemons~~</var>~~), <var>RunAsynchronously</var> results in request cancellation.		<li>If the <var class="term">daemon</var> thread and its daemons hold record locks that conflict with the parent thread's family (excluding the <var class="term">daemon</var> thread and its daemons), <var>RunAsynchronously</var> results in request cancellation.

	<li>Once started via <var>RunAsynchronously</var>, the <var>daemon</var> thread is considered to be running asynchronously until a <var>[[WaitAsynchronous (Daemon function)\|WaitAsynchronous]]</var> is issued against the <var>daemon</var> object. This is the case, even if the <var>daemon</var> thread has completed processing all of the input commands.		<li>Once started via <var>RunAsynchronously</var>, the <var class="term">daemon</var> thread is considered to be running asynchronously until a <var>[[WaitAsynchronous (Daemon function)\|WaitAsynchronous]]</var> is issued against the <var class="term">daemon</var> object. This is the case, even if the <var class="term">daemon</var> thread has completed processing all of the input commands.

	<li>While the <var>daemon</var> thread is running asynchronously, any methods that require interaction with ~~the <var>daemon</var> thread~~ cause request cancellation. These methods include <var>[[Run_(Daemon_function)\|Run]]</var>, <var>RunAsynchronously</var>, <var>[[RunIndependently_(Daemon_subroutine)\|RunIndependently]]</var>, <var>[[Open_(Daemon_subroutine)\|Open]]</var>, and <var>[[LastCommandErrorCount_(Daemon_property)\|LastCommandErrorCount]]</var>.		<li>While the <var class="term">daemon</var> thread is running asynchronously, any methods that require interaction with it cause request cancellation. These methods include <var>[[Run_(Daemon_function)\|Run]]</var>, <var>RunAsynchronously</var>, <var>[[RunIndependently_(Daemon_subroutine)\|RunIndependently]]</var>, <var>[[Open_(Daemon_subroutine)\|Open]]</var>, and <var>[[LastCommandErrorCount_(Daemon_property)\|LastCommandErrorCount]]</var>.

	<li><var>WaitAsynchronous</var> is used to retrieve any output from the commands run via <var>RunAsynchronously</var>. This includes the terminal output and any output or info object.		<li><var>WaitAsynchronous</var> is used to retrieve any output from the commands run via <var>RunAsynchronously</var>. This includes the terminal output and any output or info object.

	<li>As described in: [[Daemon class#Working with ~~Daemonobjects~~\|"Working with Daemon objects"]], <var>RunAsynchronously</var>'s <var>String</var> argument can pass multiple commands to the <var>daemon</var>.		<li>As described in: [[Daemon class#Working with Daemon objects\|"Working with Daemon objects"]], the <var>RunAsynchronously</var> <var>String</var> argument can pass multiple commands to the <var>daemon</var>.

	<li>See [[Daemon class\|"Daemon class"]] for more information about passing commands and objects to a daemon — the passing of objects and commands to daemons is identical whether the method is <var>Run</var> or <var>RunAsynchronously</var>.		<li>See [[Daemon class\|"Daemon class"]] for more information about passing commands and objects to a daemon — the passing of objects and commands to daemons is identical whether the method is <var>Run</var> or <var>RunAsynchronously</var>.

JAL2: /* Syntax terms */

2012-05-18T00:07:27Z

Syntax terms

← Older revision		Revision as of 00:07, 18 May 2012
Line 11:		Line 11:
	<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the daemon.</td></tr>		<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the daemon.</td></tr>
	<tr><th>inputObj</th>		<tr><th>inputObj</th>
	<td>~~The~~ object passed to the <var class="term">daemon</var> ~~object~~. This ~~optional argument is passed by deep copy and not by reference, so <var class="term">inputObj</var>~~ must be deep copyable, as described in: [[Copying objects\|"Copying objects"]]. The passed object can be retrieved by the daemon thread using the <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.</td></tr>		<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is either:
			<ul>
			<li>An object passed to the <var class="term">daemon</var> thread. This object must be deep copyable, as described in: [[Copying objects\|"Copying objects"]].
			<li>A Boolean value. If a Null object
			</ul>
			The passed object can be retrieved by the daemon thread using the <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.</td></tr>
	</table>		</table>

JAL2: /* Exceptions */

2012-05-17T23:39:54Z

Exceptions

← Older revision		Revision as of 23:39, 17 May 2012
Line 19:		Line 19:
	<dl>		<dl>
	<dt><var>[[DaemonLost_class\|DaemonLost]]</var>		<dt><var>[[DaemonLost_class\|DaemonLost]]</var>
	<dd>If <var>daemon</var> is lost (probably restarted), a <var>DaemonLost</var> exception is thrown. Since <var>RunAsynchronously</var> does not wait for the <var>daemon</var> thread to do anything, a <var>DaemonLost</var> exception indicates that the daemon thread was lost <b><i>before</i></b> <var>RunAsynchronously</var> was invoked.		<dd>If <var class="term">daemon</var> is lost (probably restarted), a <var>DaemonLost</var> exception is thrown. Since <var>RunAsynchronously</var> does not wait for the <var>daemon</var> thread to do anything, a <var>DaemonLost</var> exception indicates that the daemon thread was lost <b><i>before</i></b> <var>RunAsynchronously</var> was invoked.
	</dl>		</dl>

JAL2: /* Exceptions */

2012-05-17T23:39:06Z

Exceptions

← Older revision		Revision as of 23:39, 17 May 2012
Line 19:		Line 19:
	<dl>		<dl>
	<dt><var>[[DaemonLost_class\|DaemonLost]]</var>		<dt><var>[[DaemonLost_class\|DaemonLost]]</var>
	<dd>If <var>daemon</var> is lost (probably restarted), a <var>DaemonLost</var> exception is thrown. Since <var>RunAsynchronously</var> does not wait for the <var>daemon</var> thread to do anything, a <var>DaemonLost</var> exception indicates that the daemon thread was lost <b><i>before</i></b> <var>RunAsynchronously</var> was invoked~~. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later~~.		<dd>If <var>daemon</var> is lost (probably restarted), a <var>DaemonLost</var> exception is thrown. Since <var>RunAsynchronously</var> does not wait for the <var>daemon</var> thread to do anything, a <var>DaemonLost</var> exception indicates that the daemon thread was lost <b><i>before</i></b> <var>RunAsynchronously</var> was invoked.
	</dl>		</dl>

JAL2: /* Syntax terms */

2012-05-17T23:38:16Z

Syntax terms

← Older revision		Revision as of 23:38, 17 May 2012
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>daemon</th>		<tr><th>daemon</th>
	<td>A previously defined <var>[[Daemon ~~class\|Daemon]]~~</var> object. </td></tr>		<td>A previously defined <var>Daemon</var> object. </td></tr>
	<tr><th>commands</th>		<tr><th>commands</th>
	<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the ~~<var>~~daemon~~</var>~~.</td></tr>		<td>A string or <var>[[Stringlist class\|Stringlist]]</var> that is the command or the set of commands executed by the daemon.</td></tr>
	<tr><th>inputObj</th>		<tr><th>inputObj</th>
	<td>The object passed to <var>daemon</var> object. This optional argument is passed by deep copy and not by reference, so <var class="term">inputObj</var> must be deep copyable, as described in: [[Copying objects\|"Copying objects"]]. The passed object can be retrieved by the daemon thread using the <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.</td></tr>		<td>The object passed to the <var class="term">daemon</var> object. This optional argument is passed by deep copy and not by reference, so <var class="term">inputObj</var> must be deep copyable, as described in: [[Copying objects\|"Copying objects"]]. The passed object can be retrieved by the daemon thread using the <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.</td></tr>
	</table>		</table>