Run (Daemon function) - Revision history

DCameron: /* Examples */

2020-09-16T10:08:52Z

Examples

← Older revision		Revision as of 10:08, 16 September 2020
Line 109:		Line 109:
	%pazuzu:run('*LOWER')		%pazuzu:run('*LOWER')
	%pazuzu:open('MYFILE')		%pazuzu:open('MYFILE')
	%pazuzu:run(%subList,,%~~sorted~~)		%pazuzu:run(%subList,,%sSorted)

	for each record in %~~Sorted~~		for each record in %sSorted
	print '*'		print '*'
	pai		pai

JAL: misc cleanup

2016-02-16T19:09:51Z

misc cleanup

← Older revision		Revision as of 19:09, 16 February 2016
Line 17:		Line 17:

	<tr><th><var>Input</var></th>		<tr><th><var>Input</var></th>
	<td>The input object passed to the daemon method object. This optional, [[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"~~]]. The passed object can be retrieved by the daemon thread using <var>[[GetInputObject (Daemon subroutine)\|GetInputObject]]</var>.</td></tr>		<td>The input object passed to the daemon method object. This optional, [[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]]. The passed object can be retrieved by the daemon thread using <var>[[GetInputObject (Daemon subroutine)\|GetInputObject]]</var>.</td></tr>

	<tr><th><var>Output</var></th>		<tr><th><var>Output</var></th>
	<td>The output object returned from the daemon method object. This optional, 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"]]~~. The object set to <var class="term">object</var> is the object passed by the daemon thread using <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var>.		<td>The output object returned from the daemon method object. This optional, name allowed, argument is passed by deep copy and not by reference, so <var class="term">object</var> must be deep copyable. The object set to <var class="term">object</var> is the object passed by the daemon thread using <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var>.
	<p>Because <var class="term">object</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p></td></tr>		<p>Because <var class="term">object</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p></td></tr>

	<tr><th><var>Info</var></th>		<tr><th><var>Info</var></th>
	<td>An optional, [[Methods#Named parameters\|name required]], parameter that indicates a second output object returned from the daemon method object. This optional argument is passed by deep copy and not by reference, so <var>Info</var> must be deep copyable~~, as described in: [[Copying objects\|"Copying objects"]]~~. The object set to <var>Info</var> is the object passed by the daemon thread using <var>[[ReturnInfoObject (Daemon subroutine)\|ReturnInfoObject]]</var>.		<td>An optional, [[Methods#Named parameters\|name required]], parameter that indicates a second output object returned from the daemon method object. This optional argument is passed by deep copy and not by reference, so <var>Info</var> must be deep copyable. The object set to <var>Info</var> is the object passed by the daemon thread using <var>[[ReturnInfoObject (Daemon subroutine)\|ReturnInfoObject]]</var>.
	<p>Because <var>Info</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p>		<p>Because <var>Info</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p>
	<p>For an example of how to use this parameter, see the bottom of [[Run (Daemon function)#Usage notes\|"Usage Notes"]], below.</p></td></tr>		<p>For an example of how to use this parameter, see the bottom of [[Run (Daemon function)#Usage notes\|Usage Notes]], below.</p></td></tr>
	</table>		</table>

Line 33:		Line 33:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th><var>[[DaemonLost class\|DaemonLost]]</var></th>		<tr><th><var>[[DaemonLost class\|DaemonLost]]</var></th>
	<td>If the daemon object is lost (probably restarted), a <var>DaemonLost</var> exception is thrown. ~~This exception will only be thrown in <var class="product">Sirius Mods</var> Version 7.2 and later.~~ </td></tr>		<td>If the daemon object is lost (probably restarted), a <var>DaemonLost</var> exception is thrown. </td></tr>
	</table>		</table>

Line 45:		Line 45:
	<li>If a file you want to open on the daemon is already open on the master thread, the <var>[[Open (Daemon subroutine)\|Open]]</var> method lets you open the file with the same privileges it had on the master thread.		<li>If a file you want to open on the daemon is already open on the master thread, the <var>[[Open (Daemon subroutine)\|Open]]</var> method lets you open the file with the same privileges it had on the master thread.

	<li>As described in [[Daemon class#Working with Daemonobjects\|"Working with Daemon objects"]], <var>Run's</var> <var class="term">commands</var> argument can pass multiple commands to the daemon.		<li>As described in [[Daemon class#Working with Daemonobjects\|Working with Daemon objects]], <var>Run's</var> <var class="term">commands</var> argument can pass multiple commands to the daemon.
	<p>For example, to pass objects of three different classes, as well as float and longstring values to a daemon request, you can create a user class that contains such objects and the appropriate float and longstring values, then pass a "parameter object" of that class, as follows:</p>		<p>For example, to pass objects of three different classes, as well as float and longstring values to a daemon request, you can create a user class that contains such objects and the appropriate float and longstring values, then pass a "parameter object" of that class, as follows:</p>
	<p class="code">class Multivar		<p class="code">class Multivar
Line 75:		Line 75:
	<li>The <code>MYPROC</code> procedure must contain an invocation of <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.		<li>The <code>MYPROC</code> procedure must contain an invocation of <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.
	</ul>		</ul>
	<p>To return updated values to the master thread above, <code>MYPROC</code> must contain an invocation of <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var>, and the <var>Run</var> invocation requires an additional argument (represented in the <var>Run</var> method syntax by the <var>Output</var> argument), compatible with the <var>ReturnObject</var> argument. [[Daemon_class#A_Daemon_example\|"A Daemon example"]] shows the passing of input and output objects between a master and daemon.</p>		<p>To return updated values to the master thread above, <code>MYPROC</code> must contain an invocation of <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var>, and the <var>Run</var> invocation requires an additional argument (represented in the <var>Run</var> method syntax by the <var>Output</var> argument), compatible with the <var>ReturnObject</var> argument. [[Daemon_class#A_Daemon_example\|A Daemon example]] shows the passing of input and output objects between a master and daemon.</p>
	</ul>		</ul>

Goff: Removed info= parameter name from returnInfoObject. Compilation error.

2015-03-11T03:31:43Z

Removed info= parameter name from returnInfoObject. Compilation error.

← Older revision		Revision as of 03:31, 11 March 2015
Line 127:		Line 127:
	<p class="code">%errors is object stringList		<p class="code">%errors is object stringList
	...		...
	%(daemon):returnInfoObject(~~info=~~%errors)		%(daemon):returnInfoObject(%errors)
	</p></ol>		</p></ol>

	==See also==		==See also==
	{{Template:Daemon:Run footer}}		{{Template:Daemon:Run footer}}

JAL2 at 20:44, 8 July 2012

2012-07-08T20:44:39Z

← Older revision		Revision as of 20:44, 8 July 2012
Line 37:		Line 37:

	==Usage notes==		==Usage notes==
	<ul><li><var>Run</var> sets the output object to Null if the daemon command contains no <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var> invocation. Any subsequent master thread references to that object, for example to print it, will cancel the request.		<ul>
			<li><var>Run</var> sets the output object to Null if the daemon command contains no <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var> invocation. Any subsequent master thread references to that object, for example to print it, will cancel the request.

	<li>As any Run method input-object argument, an input "parameter object" is passed by deep copy: the parameter object, all objects contained in that object, all objects contained in those objects, and so on are copied and passed to the sdaemon thread.		<li>As any Run method input-object argument, an input "parameter object" is passed by deep copy: the parameter object, all objects contained in that object, all objects contained in those objects, and so on are copied and passed to the sdaemon thread.
	<p>An example of a category of object that may <b><i>not</i></b> be passed to a daemon is a <var class="product">[[Janus Sockets]]</var> <var>Socket</var> object.</p>		<p>An example of a category of object that may <b><i>not</i></b> be passed to a daemon is a <var class="product">[[Janus Sockets]]</var> <var>[[Socket class\|Socket]]</var> object.</p>

	<li>If a file you want to open on the daemon is already open on the master thread, the <var>[[Open (Daemon subroutine)\|Open]]</var> method lets you open the file with the same privileges it had on the master thread.		<li>If a file you want to open on the daemon is already open on the master thread, the <var>[[Open (Daemon subroutine)\|Open]]</var> method lets you open the file with the same privileges it had on the master thread.

	<li>As described in [[Daemon class#Working with Daemonobjects\|"Working with Daemon objects"]], <var>Run's</var> <var class="term">commands</var> argument can pass multiple commands to the daemon.		<li>As described in [[Daemon class#Working with Daemonobjects\|"Working with Daemon objects"]], <var>Run's</var> <var class="term">commands</var> argument can pass multiple commands to the daemon.
	<p>For example, to pass objects of three different classes, as well as float and longstring values to a daemon request, you can create a user class that contains such objects and the appropriate float and longstring values, then pass a "parameter object" of that class, as follows:</p>		<p>For example, to pass objects of three different classes, as well as float and longstring values to a daemon request, you can create a user class that contains such objects and the appropriate float and longstring values, then pass a "parameter object" of that class, as follows:</p>
Line 67:		Line 71:
	<p>To make use of the variables passed in the <code>%multi</code> input parameter above:</p>		<p>To make use of the variables passed in the <code>%multi</code> input parameter above:</p>
	<ul>		<ul>

	<li>The file containing <code>MYPROC</code> must be open on the daemon from an invocation of <var>Run</var> with a <var class="product">Model 204</var> <var>OPEN</var> command argument or from an invocation of <var>[[Open (Daemon subroutine)\|Open]]</var>.		<li>The file containing <code>MYPROC</code> must be open on the daemon from an invocation of <var>Run</var> with a <var class="product">Model 204</var> <var>OPEN</var> command argument or from an invocation of <var>[[Open (Daemon subroutine)\|Open]]</var>.
	<li>The <code>MYPROC</code> procedure must contain an invocation of <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.		<li>The <code>MYPROC</code> procedure must contain an invocation of <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.

JALWiccan: 1 revision

2012-06-10T22:21:14Z

1 revision

← Older revision	Revision as of 22:21, 10 June 2012
(No difference)

JAL2 at 22:21, 10 June 2012

2012-06-10T22:21:13Z

← Older revision		Revision as of 22:21, 10 June 2012
Line 24:		Line 24:

	<tr><th><var>Info</var></th>		<tr><th><var>Info</var></th>
	<td>An optional, ~~but~~ [[Methods#Named parameters\|name required]], parameter that indicates a second output object returned from the daemon method object. This optional argument is passed by deep copy and not by reference, so <var>Info</var> must be deep copyable, as described in: [[Copying objects\|"Copying objects"]]. The object set to <var>Info</var> is the object passed by the daemon thread using <var>[[ReturnInfoObject (Daemon subroutine)\|ReturnInfoObject]]</var>.		<td>An optional, [[Methods#Named parameters\|name required]], parameter that indicates a second output object returned from the daemon method object. This optional argument is passed by deep copy and not by reference, so <var>Info</var> must be deep copyable, as described in: [[Copying objects\|"Copying objects"]]. The object set to <var>Info</var> is the object passed by the daemon thread using <var>[[ReturnInfoObject (Daemon subroutine)\|ReturnInfoObject]]</var>.
	<p>Because <var>Info</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p>		<p>Because <var>Info</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p>
	<p>For an example of how to use this parameter, see the bottom of [[Run (Daemon function)#Usage notes\|"Usage Notes"]], below.</p></td></tr>		<p>For an example of how to use this parameter, see the bottom of [[Run (Daemon function)#Usage notes\|"Usage Notes"]], below.</p></td></tr>

JAL2 at 21:53, 16 May 2012

2012-05-16T21:53:41Z

← Older revision		Revision as of 21:53, 16 May 2012
Line 70:		Line 70:
	<li>The <code>MYPROC</code> procedure must contain an invocation of <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.		<li>The <code>MYPROC</code> procedure must contain an invocation of <var>[[GetInputObject_(Daemon_subroutine)\|GetInputObject]]</var>.
	</ul>		</ul>
	<p>To return updated values to the master thread above, MYPROC must contain an invocation of <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var>, and <var>Run</var> invocation requires an additional argument (represented in the <var>Run</var> method syntax by <var ~~class="term"~~>~~outputObj~~</var>), compatible with the <var>ReturnObject</var> argument. [[Daemon_class#A_Daemon_example\|"A Daemon example"]] shows the passing of input and output objects between a master and daemon.</p>		<p>To return updated values to the master thread above, <code>MYPROC</code> must contain an invocation of <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var>, and the <var>Run</var> invocation requires an additional argument (represented in the <var>Run</var> method syntax by the <var>Output</var> argument), compatible with the <var>ReturnObject</var> argument. [[Daemon_class#A_Daemon_example\|"A Daemon example"]] shows the passing of input and output objects between a master and daemon.</p>
	</ul>		</ul>

Line 112:		Line 112:
	end		end
	</p>		</p>
	<li>While the optional <var ~~class="term"~~>Info</var> object can be used for any kind of output object, its intent is to separate the "true" output of a daemon request from informational output (return codes, error messages, diagnostics, etc.). In the following example, a <var>Stringlist</var> object (presumably containing error messages) is used as the <var>Info</var> output:		<li>While the optional <var>Info</var> object can be used for any kind of output object, its intent is to separate the "true" output of a daemon request from informational output (return codes, error messages, diagnostics, etc.). In the following example, a <var>Stringlist</var> object (presumably containing error messages) is used as the <var>Info</var> output:
	<p class="code">%errors is object stringList		<p class="code">%errors is object stringList
	%result is object myClass		%result is object myClass

JAL2: /* Usage notes */

2012-05-16T21:07:23Z

Usage notes

← Older revision		Revision as of 21:07, 16 May 2012
Line 39:		Line 39:
	<ul><li><var>Run</var> sets the output object to Null if the daemon command contains no <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var> invocation. Any subsequent master thread references to that object, for example to print it, will cancel the request.		<ul><li><var>Run</var> sets the output object to Null if the daemon command contains no <var>[[ReturnObject (Daemon subroutine)\|ReturnObject]]</var> invocation. Any subsequent master thread references to that object, for example to print it, will cancel the request.
	<li>As any Run method input-object argument, an input "parameter object" is passed by deep copy: the parameter object, all objects contained in that object, all objects contained in those objects, and so on are copied and passed to the sdaemon thread.		<li>As any Run method input-object argument, an input "parameter object" is passed by deep copy: the parameter object, all objects contained in that object, all objects contained in those objects, and so on are copied and passed to the sdaemon thread.
	<p>An example of a category of object that may <b><i>not</i></b> be passed to a daemon is a <var>[[Janus Sockets]]</var> Socket object.</p>		<p>An example of a category of object that may <b><i>not</i></b> be passed to a daemon is a <var class="product">[[Janus Sockets]]</var> <var>Socket</var> object.</p>
	<li>If a file you want to open on the daemon is already open on the master thread, the <var>[[Open (Daemon subroutine)\|Open]]</var> method lets you open the file with the same privileges it had on the master thread.		<li>If a file you want to open on the daemon is already open on the master thread, the <var>[[Open (Daemon subroutine)\|Open]]</var> method lets you open the file with the same privileges it had on the master thread.
	<li>As described in [[Daemon class#Working with Daemonobjects\|"Working with Daemon objects"]], <var>Run's</var> <var class="term">commands</var> argument can pass multiple commands to the daemon.		<li>As described in [[Daemon class#Working with Daemonobjects\|"Working with Daemon objects"]], <var>Run's</var> <var class="term">commands</var> argument can pass multiple commands to the daemon.

JAL2: /* Syntax terms */

2012-05-16T20:51:57Z

Syntax terms

← Older revision		Revision as of 20:51, 16 May 2012
Line 11:		Line 11:

	<tr><th>daemon</th>		<tr><th>daemon</th>
	<td>A <var>[[Daemon ~~class\|Daemon]]~~</var> object expression. </td></tr>		<td>A <var>Daemon</var> object expression. </td></tr>

	<tr><th>commands</th>		<tr><th>commands</th>

JAL2: /* Syntax terms */

2012-05-16T20:48:27Z

Syntax terms

← Older revision		Revision as of 20:48, 16 May 2012
Line 26:		Line 26:
	<td>An optional, but [[Methods#Named parameters\|name required]], parameter that indicates a second output object returned from the daemon method object. This optional argument is passed by deep copy and not by reference, so <var>Info</var> must be deep copyable, as described in: [[Copying objects\|"Copying objects"]]. The object set to <var>Info</var> is the object passed by the daemon thread using <var>[[ReturnInfoObject (Daemon subroutine)\|ReturnInfoObject]]</var>.		<td>An optional, but [[Methods#Named parameters\|name required]], parameter that indicates a second output object returned from the daemon method object. This optional argument is passed by deep copy and not by reference, so <var>Info</var> must be deep copyable, as described in: [[Copying objects\|"Copying objects"]]. The object set to <var>Info</var> is the object passed by the daemon thread using <var>[[ReturnInfoObject (Daemon subroutine)\|ReturnInfoObject]]</var>.
	<p>Because <var>Info</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p>		<p>Because <var>Info</var> is an output variable, it cannot itself be contained inside an object: that is, it must be a local or a common %variable. </p>
	<p>For an example of how to use this parameter, see the bottom of ~~the~~ "Usage Notes," below.</p></td></tr>		<p>For an example of how to use this parameter, see the bottom of [[Run (Daemon function)#Usage notes\|"Usage Notes"]], below.</p></td></tr>
	</table>		</table>