UserStatistics (Daemon function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 10: Line 10:
{{Template:Daemon:UserStatistics syntax}}
{{Template:Daemon:UserStatistics syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt>%ustat  
<tr><th>%ustat</th>
<dd>A UserStatistics object variable to contain the returned statistics.  
<td>A UserStatistics object variable to contain the returned statistics. </td></tr>
<dt>%daem  
<tr><th>%daem</th>
<dd>A previously defined Daemon object.  
<td>A previously defined Daemon object.</td></tr>
</dl>
</table>


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

Revision as of 04:37, 7 February 2011

Statistics for the thread associated with this Daemon (Daemon class)


UserStatistics is a member of the Daemon class

This method returns the Model 204 User statistics for the thread associated with the daemon object. It is useful for metering a daemon or for determining table usage by a compilation done on the daemon thread.

The method takes no arguments and returns a UserStatistics object. For information about the user statistics that are returned and how to extract data from the returned object see UserStatistics class.

Syntax

%userStatistics = daemon:UserStatistics Throws DaemonLost

Syntax terms

%ustat A UserStatistics object variable to contain the returned statistics.
%daem A previously defined Daemon object.

Usage notes

  • The UserStatistics method is available as of Sirius Mods Version 7.3.
  • The daemon cannot be running asynchronously when this method is invoked.

Examples

The following statements return the %daemon thread User statistics to the %myDaemonStats object, then print the non-zero statistics contained therein:

%myDaemonStats = %daemon:userStatistics
Print 'stats are: ' %myDaemonStats

See also