New (Daemon constructor) - Revision history

JAL: misc cleanup

2015-02-24T16:02:55Z

misc cleanup

← Older revision		Revision as of 16:02, 24 February 2015
Line 10:		Line 10:

	<tr><th><var>[%(Daemon):]</var></th>		<tr><th><var>[%(Daemon):]</var></th>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Daemon</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|Usage notes]], below, for more information about invoking a <var>Daemon</var> <var>Constructor</var>.</td></tr>

	<tr><th><var>CopyGlobals</var></th>		<tr><th><var>CopyGlobals</var></th>
Line 17:		Line 17:
	If set to <code>True</code>:		If set to <code>True</code>:
	<ul>		<ul>
	<li>The GTBL server table is set to the same size on the daemon as it is on the master thread.		<li>The GTBL server table is set to the same size on the daemon as it is on the master thread. </li>
	<li>The <var>GTBLHASH</var> and <var>GTBLPCT</var> parameters on the daemon thread are set to the same values as on the master thread.
	<li>Only unstructured globals (globals created by <var>[[$Setg]]</var> or <var>[[$Getg]]</var>) and permanent global Images in the master thread GTBL are copied to the daemon (global foundsets/lists, global Screens, and any temporary global items are <b><i>not</i></b> copied).		<li>The <var>GTBLHASH</var> and <var>GTBLPCT</var> parameters on the daemon thread are set to the same values as on the master thread. </li>

			<li>Only unstructured globals (globals created by <var>[[$Setg]]</var> or <var>[[$Getg]]</var>) and permanent global Images in the master thread GTBL are copied to the daemon (global foundsets/lists, global Screens, and any temporary global items are <b><i>not</i></b> copied). </li>
	</ul></td></tr>		</ul></td></tr>

Line 25:		Line 27:
	<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration.		<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration.
	<ul>		<ul>
	<li>If set to <~~code~~>True</~~code~~>, the daemon is [[~~Daemon_class~~#~~Transactional_daemons~~\|transactional]], with the master and daemon threads share a single updating transaction.		<li>If set to <var>True</var>, the daemon is [[Daemon class#Transactional daemons\|transactional]], with the master and daemon threads share a single updating transaction. </li>
	<li>If set to <~~code~~>False</~~code~~>, the default, the daemon is non-transactional.		<li>If set to <var>False</var>, the default, the daemon is non-transactional. </li>
	</ul></td></tr>		</ul></td></tr>

	<tr><th><var>OpenAll</var></th>		<tr><th><var>OpenAll</var></th>
	<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1. ~~Any temp groups open on the master thread are recreated on the Daemon thread and then opened.~~</td></tr>		<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. Any temporary groups open on the master thread are also recreated on the Daemon thread and then opened.
			<p>
			This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1. </p></td></tr>
	</table>		</table>

Line 37:		Line 41:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var></th>		<tr><th><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var></th>
	<td>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown~~. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later~~.</td></tr>		<td>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown. </td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As described in [[Object variables#Using New or other Constructors\|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:		<li>As described in [[Object variables#Using New or other Constructors\|Using New or other Constructors]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:
	<p class="code">%daemon = new		<p class="code">%daemon = new

Line 48:		Line 52:

	%daemon = %daemon:new		%daemon = %daemon:new
	</p>		</p></li>

	<li><var>New</var> not only creates a <var>Daemon</var> object in the user tables, but it also finds a free sdaemon thread and dedicates it to the issuing user. If no sdaemon threads are available, the request is cancelled.</li>		<li><var>New</var> not only creates a <var>Daemon</var> object in the user tables, but it also finds a free sdaemon thread and dedicates it to the issuing user. If no sdaemon threads are available, the request is cancelled.</li>

Line 61:		Line 66:
	<li>If LFTBL on the daemon thread is not enough to allow opening all the groups to be opened by <code>OpenAll=True</code>, the daemon thread issues an error message and logs off, and the <var>New</var> method fails.</li>		<li>If LFTBL on the daemon thread is not enough to allow opening all the groups to be opened by <code>OpenAll=True</code>, the daemon thread issues an error message and logs off, and the <var>New</var> method fails.</li>

	<li>		<li>If you want to use the master thread's open temp groups on the daemon thread, using OpenAll keeps you from having to recreate the temp groups on the Daemon thread.</li>
	If you want to use the master thread's open temp groups on the daemon thread, using OpenAll keeps you from having to recreate the temp groups on the Daemon thread.
	</li>

	</ul>		</ul>

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

Gwalter: /* Usage notes */

2015-02-24T15:26:12Z

Usage notes

← Older revision		Revision as of 15:26, 24 February 2015
Line 60:		Line 60:

	<li>If LFTBL on the daemon thread is not enough to allow opening all the groups to be opened by <code>OpenAll=True</code>, the daemon thread issues an error message and logs off, and the <var>New</var> method fails.</li>		<li>If LFTBL on the daemon thread is not enough to allow opening all the groups to be opened by <code>OpenAll=True</code>, the daemon thread issues an error message and logs off, and the <var>New</var> method fails.</li>

			<li>
			If you want to use the master thread's open temp groups on the daemon thread, using OpenAll keeps you from having to recreate the temp groups on the Daemon thread.
			</li>

	</ul>		</ul>

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

Gwalter: /* Syntax terms */

2015-02-24T15:23:29Z

Syntax terms

← Older revision		Revision as of 15:23, 24 February 2015
Line 30:		Line 30:

	<tr><th><var>OpenAll</var></th>		<tr><th><var>OpenAll</var></th>
	<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1.</td></tr>		<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1. Any temp groups open on the master thread are recreated on the Daemon thread and then opened.</td></tr>
	</table>		</table>

JAL2: /* Exceptions */

2012-07-08T20:39:49Z

Exceptions

← Older revision		Revision as of 20:39, 8 July 2012
Line 35:		Line 35:
	==Exceptions==		==Exceptions==
	This subroutine can throw the following exception:		This subroutine can throw the following exception:
	<dl>		<table class="syntaxTable">
	<dt><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var>		<tr><th><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var></th>
	<dd>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later.</dl>		<td>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later.</td></tr>
			</table>

	==Usage notes==		==Usage notes==

JAL2: /* Syntax terms */

2012-07-08T20:11:43Z

Syntax terms

← Older revision		Revision as of 20:11, 8 July 2012
Line 19:		Line 19:
	<li>The GTBL server table is set to the same size on the daemon as it is on the master thread.		<li>The GTBL server table is set to the same size on the daemon as it is on the master thread.
	<li>The <var>GTBLHASH</var> and <var>GTBLPCT</var> parameters on the daemon thread are set to the same values as on the master thread.		<li>The <var>GTBLHASH</var> and <var>GTBLPCT</var> parameters on the daemon thread are set to the same values as on the master thread.
	<li>Only unstructured globals (globals created by <var>[[$Setg]]</var> or <var>[[$Getg]]</var>) and ~~Perm Global~~ Images in the master thread GTBL are copied to the daemon (~~Global Foundsets~~/~~Lists~~, ~~Global~~ Screens, and any ~~Temp Global~~ items are <b><i>not</i></b> copied).		<li>Only unstructured globals (globals created by <var>[[$Setg]]</var> or <var>[[$Getg]]</var>) and permanent global Images in the master thread GTBL are copied to the daemon (global foundsets/lists, global Screens, and any temporary global items are <b><i>not</i></b> copied).
	</ul></td></tr>		</ul></td></tr>

JAL at 02:39, 8 July 2012

2012-07-08T02:39:06Z

← Older revision		Revision as of 02:39, 8 July 2012
Line 1:		Line 1:
	{{Template:Daemon:New subtitle}}		{{Template:Daemon:New subtitle}}
	~~<var>New</var> creates a new <var>[[Daemon class\|Daemon]]</var> object instance. It has two, optional, arguments.~~

	==Syntax==		==Syntax==
	{{Template:Daemon:New syntax}}		{{Template:Daemon:New syntax}}

	===Syntax terms===		===Syntax terms===
	<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 <var>[[Daemon class\|Daemon]]</var> object. </td></tr>

	<tr><th><var>[%(Daemon):]</var></th>		<tr><th><var>[%(Daemon):]</var></th>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Daemon</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Daemon</var> <var>Constructor</var>.</td></tr>

	<tr><th><var>CopyGlobals</var></th>		<tr><th><var>CopyGlobals</var></th>
	<td>An optional, [[Methods#Named parameters\|name required]] parameter whose value is a <var>[[Boolean enumeration]]</var>.		<td>An optional, [[Methods#Named parameters\|name required]] parameter whose value is a <var>[[Boolean enumeration]]</var>.
	The default is <code>False</code>: do not copy the existing global variable information from the master thread; use default GTBL-creation settings for the daemon.		The default is <code>False</code>: do not copy the existing global variable information from the master thread; use default GTBL-creation settings for the daemon.
	If set to <code>True</code>:<ul><li>The GTBL server table is set to the same size on the daemon as it is on the master thread.<li>The GTBLHASH and GTBLPCT parameters on the daemon thread are set to the same values as on the master thread.<li>Only unstructured globals (globals created by $~~setg~~ or $~~getg~~) and Perm Global Images in the master thread GTBL are copied to the daemon (Global Foundsets/Lists, Global Screens, and any Temp Global items are <b><i>not</i></b> copied).</ul></td></tr>		If set to <code>True</code>:
			<ul>
			<li>The GTBL server table is set to the same size on the daemon as it is on the master thread.
			<li>The <var>GTBLHASH</var> and <var>GTBLPCT</var> parameters on the daemon thread are set to the same values as on the master thread.
			<li>Only unstructured globals (globals created by <var>[[$Setg]]</var> or <var>[[$Getg]]</var>) and Perm Global Images in the master thread GTBL are copied to the daemon (Global Foundsets/Lists, Global Screens, and any Temp Global items are <b><i>not</i></b> copied).
			</ul></td></tr>

	<tr><th><var>Transactional</var></th>		<tr><th><var>Transactional</var></th>
	<td>An optional, name required parameter whose value is a <var>Boolean</var> enumeration.		<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration.
	<ul><li>If set to <code>True</code>, the daemon is [[Daemon_class#Transactional_daemons\|transactional]], with the master and daemon threads share a single updating transaction.<li>If set to <code>False</code>, the default, the daemon is non-transactional.</ul></td></tr>		<ul>
			<li>If set to <code>True</code>, the daemon is [[Daemon_class#Transactional_daemons\|transactional]], with the master and daemon threads share a single updating transaction.
			<li>If set to <code>False</code>, the default, the daemon is non-transactional.
			</ul></td></tr>

	<tr><th><var>OpenAll</var></th>		<tr><th><var>OpenAll</var></th>
	<td>An optional, name required parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1.</td></tr>		<td>An optional, name required, parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1.</td></tr>
	</table>		</table>

	==Exceptions==		==Exceptions==
	This subroutine can throw the following exception:<dl>		This subroutine can throw the following exception:
			<dl>
	<dt><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var>		<dt><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var>
	<dd>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later.</dl>		<dd>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later.</dl>
Line 28:		Line 41:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As described in [[Object variables#Using New or other Constructors\|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%daemon = new		<li>As described in [[Object variables#Using New or other Constructors\|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:
			<p class="code">%daemon = new

	%daemon = %(Daemon):new		%daemon = %(Daemon):new
Line 34:		Line 48:
	%daemon = %daemon:new		%daemon = %daemon:new
	</p>		</p>
	<li><var>New</var> not only creates a Daemon object in the user tables, but it also finds a free sdaemon thread and dedicates it to the issuing user. If no sdaemon threads are available, the request is cancelled.</li>		<li><var>New</var> not only creates a <var>Daemon</var> object in the user tables, but it also finds a free sdaemon thread and dedicates it to the issuing user. If no sdaemon threads are available, the request is cancelled.</li>

	<li>The number of daemons allowed per master thread is limited by the <var>[[MAXDAEM parameter\|MAXDAEM]]</var> system parameter, whose default value is 1.</li>		<li>The number of daemons allowed per master thread is limited by the <var>[[MAXDAEM parameter\|MAXDAEM]]</var> system parameter, whose default value is 1.</li>

	<li>If you specify <code>CopyGlobals=True</code>, and if there is insufficient server space (say, if daemons start out with very big tables, except for GTBL, and the master has a very big GTBL), the daemon fails during initialization.</li>		<li>If you specify <code>CopyGlobals=True</code>, and if there is insufficient server space (say, if daemons start out with very big tables, except for GTBL, and the master has a very big GTBL), the daemon fails during initialization.</li>

	<li>Even files opened as part of the subsystem being run by the master thread are opened on a daemon thread when <code>OpenAll=True</code> is specified.</li>		<li>Even files opened as part of the subsystem being run by the master thread are opened on a daemon thread when <code>OpenAll=True</code> is specified.</li>
	<li>Opening a lot of files via <code>OpenAll=True</code> is more efficient than opening the files individually with the <~~code~~>Open</~~code~~> method.</li>
	<li>If LFTBL on the daemon thread is not enough to allow opening all the groups to be opened by <code>OpenAll=True</code>, the daemon thread issues an error message and logs off, and the <~~code~~>New</~~code~~> method fails.</li>		<li>Opening a lot of files via <code>OpenAll=True</code> is more efficient than opening the files individually with the <var>[[Open (Daemon subroutine)\|Open]]</var> method.</li>

			<li>If LFTBL on the daemon thread is not enough to allow opening all the groups to be opened by <code>OpenAll=True</code>, the daemon thread issues an error message and logs off, and the <var>New</var> method fails.</li>
	</ul>		</ul>

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

JAL2: /* Exceptions */

2012-06-14T21:40:56Z

Exceptions

← Older revision		Revision as of 21:40, 14 June 2012
Line 22:		Line 22:

	==Exceptions==		==Exceptions==
	This subroutine can throw the following ~~exceptions~~:<dl>		This subroutine can throw the following exception:<dl>
	<dt><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var>		<dt><var>[[NoFreeDaemons_class\|NoFreeDaemons]]</var>
	<dd>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later.</dl>		<dd>If there are no daemon threads available to service the object, a <var>NoFreeDaemons</var> exception is thrown. This exception will only be thrown in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2 and later.</dl>

JALWiccan: 1 revision

2012-06-10T22:25:48Z

1 revision

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

JALWiccan: 1 revision

2012-06-10T22:25:47Z

1 revision

← Older revision		Revision as of 22:25, 10 June 2012
Line 15:		Line 15:
	If set to <code>True</code>:<ul><li>The GTBL server table is set to the same size on the daemon as it is on the master thread.<li>The GTBLHASH and GTBLPCT parameters on the daemon thread are set to the same values as on the master thread.<li>Only unstructured globals (globals created by $setg or $getg) and Perm Global Images in the master thread GTBL are copied to the daemon (Global Foundsets/Lists, Global Screens, and any Temp Global items are <b><i>not</i></b> copied).</ul></td></tr>		If set to <code>True</code>:<ul><li>The GTBL server table is set to the same size on the daemon as it is on the master thread.<li>The GTBLHASH and GTBLPCT parameters on the daemon thread are set to the same values as on the master thread.<li>Only unstructured globals (globals created by $setg or $getg) and Perm Global Images in the master thread GTBL are copied to the daemon (Global Foundsets/Lists, Global Screens, and any Temp Global items are <b><i>not</i></b> copied).</ul></td></tr>
	<tr><th><var>Transactional</var></th>		<tr><th><var>Transactional</var></th>
	<td>An optional, ~~but~~ name required parameter whose value is a <var>Boolean</var> enumeration.		<td>An optional, name required parameter whose value is a <var>Boolean</var> enumeration.
	<ul><li>If set to <code>True</code>, the daemon is [[Daemon_class#Transactional_daemons\|transactional]], with the master and daemon threads share a single updating transaction.<li>If set to <code>False</code>, the default, the daemon is non-transactional.</ul></td></tr>		<ul><li>If set to <code>True</code>, the daemon is [[Daemon_class#Transactional_daemons\|transactional]], with the master and daemon threads share a single updating transaction.<li>If set to <code>False</code>, the default, the daemon is non-transactional.</ul></td></tr>
	<tr><th><var>OpenAll</var></th>		<tr><th><var>OpenAll</var></th>
	<td>An optional, ~~but~~ name required parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1.</td></tr>		<td>An optional, name required parameter whose value is a <var>Boolean</var> enumeration. If set to <code>True</code>, the daemon thread opens all files and groups that are open on the master thread. The files and groups are opened with the same privileges as on the master thread. This parameter is new as of <var class="product">Sirius Mods</var> Version 8.1.</td></tr>
	</table>		</table>

JALWiccan: 1 revision

2012-06-10T22:21:13Z

1 revision

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