ReturnObject and ReturnInfoObject (Daemon subroutines): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax table to syntax template (will need to be redone when syntax template is fixed) tags and edits)
Line 1: Line 1:
{{Template:Daemon:ReturnObject and ReturnInfoObject subtitle}}
{{Template:Daemon:ReturnObject and ReturnInfoObject subtitle}}
 
<var>ReturnObject</var> and <var>ReturnInfoObject</var> specify the output objects to be returned to the master thread. The difference between them is that <var>ReturnObject</var> returns the value of the (unnamed) third argument of the <var>[[Run (Daemon function)|Run]]</var> function, while <var>ReturnInfoObject</var> returns the value of the named <var class="term">Info</var> object of the <var>Run</var> function.  
ReturnObject is a member of the [[Daemon class]]
 
These shared methods specify the output objects to be returned to the master thread. The difference between ReturnObject and ReturnInfoObject is that the former returns the value of the (unnamed) third argument of the [[Run (Daemon function)|Run]] function, while the latter returns the value of the named <tt>Info</tt> object of the Run function.
 
The ReturnInfoObject method was added in ''[[Sirius Mods]]'' Version 6.8.


==Syntax==
==Syntax==
Line 15: Line 10:
<td>The class name in parentheses denotes a shared method. <var>ReturnObject</var> and <var>ReturnInfoObject</var> can also be invoked via a <var>Daemon</var> object variable, which may be null.</td></tr>
<td>The class name in parentheses denotes a shared method. <var>ReturnObject</var> and <var>ReturnInfoObject</var> can also be invoked via a <var>Daemon</var> object variable, which may be null.</td></tr>
<tr><th>%outputObj</th>
<tr><th>%outputObj</th>
<td>The object returned from the daemon method object in the last Run method invocation. '''%outputObj''' must be deep copyable, as described in [[Copying objects]].</td></tr>
<td>The object returned from the daemon method object in the last <var>Run</var> method invocation. <var class="term">%outputObj</var> must be deep copyable, as described in [[Copying objects]].</td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
<ul>
<ul>  
<li><var>ReturnObject</var> and <var>ReturnInfoObject</var> can only be issued on daemon threads.  
<li>ReturnObject and ReturnInfoObject can only be issued on daemon threads.  
<li>You can invoke <var>ReturnObject</var> and/or <var>ReturnInfoObject</var> as many times as you want for a single <var>Run</var> call. Each subsequent invocation replaces the object from the previous invocation of the same method.  
<li>You can invoke ReturnObject and ReturnInfoObject as many times as you want for a single Run call. Each subsequent invocation replaces the object from the previous invocation of the same method.  
<li>You can invoke <var>ReturnObject</var> even if <var>Run</var> has no output parameter, and you can invoke <var>ReturnInfoObject</var> even if <var>Run</var> has no Info parameter.
<li>You can invoke ReturnObject even if Run has no output parameter, and you can invoke ReturninfoObject even if Run has no Info parameter. However, a class mismatch between the ReturnObject argument and the output argument in Run, or between the ReturnInfoObject argument and the Info argument in Run, causes request cancellation in the master thread at the time the daemon finishes and Run is about to return.</ul>
<li>A class mismatch between the <var>ReturnObject</var> argument and the <var>Run</var> output argument; or between the <var>ReturnInfoObject</var> argument and the <var>Run</var> <var class="term">Info</var> argument, causes request cancellation in the master thread at the time the daemon finishes and <var>Run</var> method was about to return.
 
<li><var>ReturnInfoObject</var> was added in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 6.8.
</ul>


==See also==
==See also==
{{Template:Daemon:ReturnObject and ReturnInfoObject footer}}
{{Template:Daemon:ReturnObject and ReturnInfoObject footer}}

Revision as of 02:49, 14 March 2011

Specify objects returned to the master thread (Daemon class)

ReturnObject and ReturnInfoObject specify the output objects to be returned to the master thread. The difference between them is that ReturnObject returns the value of the (unnamed) third argument of the Run function, while ReturnInfoObject returns the value of the named Info object of the Run function.

Syntax

%(Daemon):ReturnObject( outputObj)

%(Daemon):ReturnInfoObject( outputObj)

Syntax terms

%(Daemon) The class name in parentheses denotes a shared method. ReturnObject and ReturnInfoObject can also be invoked via a Daemon object variable, which may be null.
%outputObj The object returned from the daemon method object in the last Run method invocation. %outputObj must be deep copyable, as described in Copying objects.

Usage notes

  • ReturnObject and ReturnInfoObject can only be issued on daemon threads.
  • You can invoke ReturnObject and/or ReturnInfoObject as many times as you want for a single Run call. Each subsequent invocation replaces the object from the previous invocation of the same method.
  • You can invoke ReturnObject even if Run has no output parameter, and you can invoke ReturnInfoObject even if Run has no Info parameter.
  • A class mismatch between the ReturnObject argument and the Run output argument; or between the ReturnInfoObject argument and the Run Info argument, causes request cancellation in the master thread at the time the daemon finishes and Run method was about to return.
  • ReturnInfoObject was added in "Sirius Mods" Version 6.8.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=ReturnObject_and_ReturnInfoObject_(Daemon_subroutines)&oldid=9640"