DaemonLost class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
m (minor cleanup)
 
Line 3: Line 3:
The <var>DaemonLost</var> exception class indicates that a daemon thread associated with a daemon object was lost, most probably because of a user restart.
The <var>DaemonLost</var> exception class indicates that a daemon thread associated with a daemon object was lost, most probably because of a user restart.
   
   
The <var>[[Run (Daemon function)|Run]]</var> function of the <var>[[Daemon_class|Daemon]]</var> system class is an example of a system method that automatically throws a <var>DaemonLost</var> exception. For more information about catching a thrown exception, see [[Exceptions#Try and Catch|"Try and Catch"]].
The <var>[[Run (Daemon function)|Run]]</var> function of the <var>[[Daemon_class|Daemon]]</var> system class is an example of a system method that automatically throws a <var>DaemonLost</var> exception. For more information about catching a thrown exception, see [[Exceptions#Try and Catch|Try and Catch]].
   
   
The following example shows a <var>Try</var> and <var>Catch</var> of a <var>DaemonLost</var> exception. The daemon request is contrived to produce a user restart to demonstrate <var>DaemonLost</var> exception output.  
The following example shows a <var>Try</var> and <var>Catch</var> of a <var>DaemonLost</var> exception. The daemon request is contrived to produce a user restart to demonstrate <var>DaemonLost</var> exception output.  
Line 81: Line 81:
The methods in the class are described in the subsections that follow. In addition:
The methods in the class are described in the subsections that follow. In addition:
<ul>
<ul>
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
about the conventions followed.  
<li>[[DaemonLost methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
<li>[[DaemonLost methods syntax|"DaemonLost methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
</ul>
</ul>


Line 96: Line 95:


====Syntax terms====
====Syntax terms====
<table class="syntaxTable">
<table>
<tr><th>%sl</th>
<tr><th>%sl</th>
<td>This <var>Stringlist</var> contains a copy of the daemon thread's last output. The <var>Stringlist</var> may be empty, that is, have no items.
<td>This <var>Stringlist</var> contains a copy of the daemon thread's last output. The <var>Stringlist</var> may be empty, that is, have no items.
Line 112: Line 111:
===Syntax===
===Syntax===
{{Template:DaemonLost:New syntax}}
{{Template:DaemonLost:New syntax}}
====Syntax terms====
====Syntax terms====
<table class="syntaxTable">
<table>
 
<tr><th>%daemonLost</th>
<tr><th>%daemonLost</th>
<td>A reference to an instance of a <var>DaemonLost</var> object.
<td>A reference to an instance of a <var>DaemonLost</var> object.

Latest revision as of 22:16, 18 November 2014


The DaemonLost exception class indicates that a daemon thread associated with a daemon object was lost, most probably because of a user restart.

The Run function of the Daemon system class is an example of a system method that automatically throws a DaemonLost exception. For more information about catching a thrown exception, see Try and Catch.

The following example shows a Try and Catch of a DaemonLost exception. The daemon request is contrived to produce a user restart to demonstrate DaemonLost exception output.

begin %dmn is object daemon %sl is object stringlist %daemonLost is object daemonLost %dmn = new %sl = new text to %sl begin print 'Rosebud' end begin end text try %dmn:run(%sl) catch daemonLost to %daemonLost printText Daemon died! Its last words were: %daemonLost:daemonOutput:print end try end

The result of the preceding request shows the daemon output that was stored in the exception:

Daemon died! Its last words were: ROSEBUD

Note: It is necessary to declare the exception object in the main thread of the program, but instantiating it is taken care of by the Daemon class Run method.

A request cancellation does not cause the daemon thread to go away, so it does not produce a DaemonLost exception. Consequently, using the error count on the last command may be an adequate way for your application to check for a request cancellation:

begin %dmn is object daemon %prog is object stringlist %dmn = new %prog = new text to %prog begin assert 1 eq 2 end end text try %dmn:run(%prog) if %dmn:lastCommandErrorCount then print 'Error in daemon!' end if catch daemonLost printText Caught a DaemonLost. end try end

To produce a DaemonLost exception for a user-created method, you would issue a User Language Throw statement from within the method, and you must catch it in the code that called the method. Because this exception is tailored to daemon execution by the system Run method, you are not likely to throw it from a user method, unless you want the method to Catch and then Throw the exception to the code that called the method. For example, your method might contain code like this:

%dLost is object daemonLost try %dmn:run(%whatever) catch daemonLost to %dlost throw %dlost end try

And the code that calls the method might contain:

%daemLost is object daemonLost try %obj:mymethod catch daemonLost to %daemLost printText Daemon lost! %daemLost:daemonOutput:print end try


The DaemonLost methods

The following are the available DaemonLost class methods.

MethodDescription
DaemonOutputStringlist copy of last output stream of lost daemon thread
NewCreate a new DaemonLost object

The methods in the class are described in the subsections that follow. In addition:


DaemonOutput property

Stringlist copy of last output stream of lost daemon thread (DaemonLost class)

This ReadOnly property returns a Stringlist that contains a copy of the output of the last stream the daemon thread was running before it was lost (probably restarted). The contents of this stringlist might be useful in determining why the daemon thread was restarted.

Syntax

%sl = daemonLost:DaemonOutput

Syntax terms

%sl This Stringlist contains a copy of the daemon thread's last output. The Stringlist may be empty, that is, have no items.
daemonLost A reference to an instance of a DaemonLost object.

New constructor

Create a new DaemonLost object (DaemonLost class)

This Constructor generates an instance of a DaemonLost exception. As shown below, the optional argument of the New method is a setting of the DaemonOutput property.

Syntax

%daemonLost = [%(DaemonLost):]New[( [DaemonOutput= stringlist])]

Syntax terms

%daemonLost A reference to an instance of a DaemonLost object.
[%(DaemonLost):] The class name in parentheses denotes a Constructor.
DaemonOutput This optional, but name required, parameter specifies the Stringlist (stringlist) to be assigned to the DaemonLost exception object's DaemonOutput property when a daemon thread is lost.