New (Daemon constructor): Difference between revisions
Jump to navigation
Jump to search
m (→Exceptions) |
m (misc cleanup) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Daemon:New subtitle}} | {{Template:Daemon:New subtitle}} | ||
==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 | <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| | <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. | |||
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> | |||
<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> | |||
<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 < | <ul> | ||
<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 <var>False</var>, the default, the daemon is non-transactional. </li> | |||
</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. 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> | ||
==Exceptions== | ==Exceptions== | ||
This subroutine can throw the following exception:< | This subroutine can throw the following exception: | ||
< | <table class="syntaxTable"> | ||
< | <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. </td></tr> | |||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>As described in [[Object variables#Using New or other Constructors| | <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 | ||
%daemon = %daemon:new | %daemon = %daemon:new | ||
</p> | </p></li> | ||
<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 < | |||
<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 < | <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> | |||
<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}} | ||
Latest revision as of 16:02, 24 February 2015
Create a new Daemon (Daemon class)
Syntax
%daemon = [%(Daemon):]New[( [CopyGlobals= boolean], [Transactional= boolean], - [OpenAll= boolean])] Throws MaxDaemExceeded, NoFreeDaemons, DaemonLost
Syntax terms
| %daemon | A Daemon object. |
|---|---|
| [%(Daemon):] | The optional class name in parentheses denotes a Constructor. See Usage notes, below, for more information about invoking a Daemon Constructor. |
| CopyGlobals | An optional, name required parameter whose value is a Boolean enumeration.
The default is
|
| Transactional | An optional, name required, parameter whose value is a Boolean enumeration.
|
| OpenAll | An optional, name required, parameter whose value is a Boolean enumeration. If set to True, 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.
This parameter is new as of Sirius Mods Version 8.1. |
Exceptions
This subroutine can throw the following exception:
| NoFreeDaemons | If there are no daemon threads available to service the object, a NoFreeDaemons exception is thrown. |
|---|
Usage notes
- As described in Using New or other Constructors, New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%daemon = new %daemon = %(Daemon):new %daemon = %daemon:new
- New 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.
- The number of daemons allowed per master thread is limited by the MAXDAEM system parameter, whose default value is 1.
- If you specify
CopyGlobals=True, 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. - Even files opened as part of the subsystem being run by the master thread are opened on a daemon thread when
OpenAll=Trueis specified. - Opening a lot of files via
OpenAll=Trueis more efficient than opening the files individually with the Open method. - If LFTBL on the daemon thread is not enough to allow opening all the groups to be opened by
OpenAll=True, the daemon thread issues an error message and logs off, and the New method fails. - 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.