vlp-15 Set version to 3.1. Replaced hardcoded strings with generated ones.
[vlp.git] / doc / html / machine.html
1 <HTML>
2 <HEAD>
3 </HEAD>
4 <BODY>
5 <B> Class MACHINE </B><BR>
6 <BR>
7 Class <B> Machine </B> is the set of functions designed to 
8 give informations about Virtual LOGLAN Machine. 
9 <UL>
10 <LI> unit <B>LocalNode</B>:function:integer<BR>
11 Returns the ID  of local Virtual Processor.
12 <LI> unit <B>NodesNum</B>:function:integer<BR>
13 Returns the number of Virtual Processors actually available
14 in the Machine.<BR>
15 Warning! The local VLP is not counted, so function returns
16 0 if there are no other Processors.
17 <LI> unit <B>NodeExists</B>:function(<I>node</I>:integer):boolean<BR>
18 Returns TRUE if the Virtual Processor with the ID equal to the
19 <I>node</I> is connected to the Machine.
20 <LI> unit <B>MachineInfo</B>:function:NodeInfo<BR>
21 This function returns full information about all connected Virtual
22 Processors. Information is given as a list of <I>NodeInfo</I>
23 structures.<BR>
24 The <I>NodeInfo</I> structure is defined in the class Machine
25 as follow:
26 <PRE>
27 unit NodeInfo:class;
28 var num:integer,        (* an ID of a Virtual Processor *)
29     addr:arrayof char   (* IP address of a VLP *)
30     next:NodeInfo       (* next structure on the list *)
31 end NodeInfo;
32 </PRE>
33 </UL>
34 <HR>
35 <A HREF="index.html">Return to Index</A>
36 </BODY>
37 </HTML>