<br><fontsize=-1>Top-level functions and properties (common to all servers and services)</font>
</h2>
<tableborder=1width=100%>
<captionalign=left><b><tt>global</tt>
<aname=global_methods> methods</a>
</b></caption>
<trbgcolor=gray>
<thalign=leftwidth=100>
<fontcolor="white">Name</font>
<thalign=leftwidth=100>
<fontcolor="white">Returns</font>
<thalign=leftwidth=200>
<fontcolor="white">Usage</font>
<thalign=left>
<fontcolor="white">Description</font>
<trvalign=top><td><b>log</b><td>string<td><tt>log([level,] value [,value])
<td>add a line of text to the server and/or system log, <i>values</i> are typically string constants or variables, <i>level</i> is the debug level/priority (default: <tt>LOG_INFO</tt>)
<td>send a line of text to the console or event log with automatic line termination (CRLF), <i>values</i> are typically string constants or variables (AKA print)
<td>load and execute a JavaScript module (<i>filename</i>), optionally specifying a target <i>scope</i> object (default: <i>this</i>) and a list of arguments to pass to the module (as <i>argv</i>), returns <i>true</i> if the execution was successful
<td>release current thread time-slice, a <i>forced</i> yield will yield to all other pending tasks (lowering CPU utilization), a non-<i>forced</i> yield will yield only to pending tasks of equal or higher priority. <i>forced</i> defaults to <i>true</i>
<trvalign=top><td><b>ctrl</b><td>string<td><tt>ctrl(number or string)
<td>return ASCII control character representing character passed - Example: <tt>ctrl('C') returns ''</tt>
<td>backup the specified <i>filename</i> as <tt>filename.<i>number</i>.extension</tt> where <i>number</i> is the backup number 0 through <i>level</i>-1 (default backup <i>level</i> is 5), if <i>rename</i> is <i>true</i>, the original file is renamed instead of copied (default is <i>false</i>)
<td>returns the amount of available disk space in the specified <i>directory</i> using the specified <i>unit_size</i> in bytes (default: 1), specify a <i>unit_size</i> of <tt>1024</tt> to return the available space in <i>kilobytes</i>.
<trvalign=top><td><b>socket_select</b><td>array<td><tt>socket_select([array of socket objects or descriptors] [,number timeout] [,bool write])
<td>checks an array of socket objects or descriptors for read or write ability (default is <i>read</i>), default timeout value is 0.0 seconds (immediate timeout), returns an array of 0-based index values into the socket array, representing the sockets that were ready for reading or writing
<trvalign=top><td><b>html_encode</b><td>string<td><tt>html_encode(string text [,bool ex_ascii] [,bool white_space] [,bool ansi] [,bool ctrl_a])
<td>return an HTML-encoded text string (using standard HTML character entities), escaping IBM extended-ASCII, white-space characters, ANSI codes, and CTRL-A codes by default
<td>perform a garbage collection operation (freeing memory for unused allocated objects), if <i>forced</i> is <i>true</i> (the default) a garbage collection is always performed, otherwise it is only performed if deemed appropriate by the JavaScript engine
</table>
<br>
<tableborder=1width=100%>
<captionalign=left><b><tt>js</tt>
<aname=js_properties> properties</a>
</b></caption>
<trbgcolor=gray>
<thalign=leftwidth=100>
<fontcolor="white">Name</font>
<thalign=leftwidth=100>
<fontcolor="white">Type</font>
<thalign=left>
<fontcolor="white">Description</font>
<trvalign=top><td><b>version</b><td>string
<td>JavaScript engine version information (AKA system.js_version)
<td>get a single key with optional <i>timeout</i> in milliseconds (defaults to 0, for no wait), see <tt>K_*</tt> in <tt>sbbsdefs.js</tt> for <i>mode</i> bits
<td>Move cursor to a specific screen coordinate (ANSI), arguments can be separate x and y cooridinates or an object with x and y properites (like that returned from <tt>console.getxy()</tt>)
<td>Call internal control key handler for specified control key, returns true if handled
</table>
<br>
<tableborder=1width=100%>
<captionalign=left><b><tt>console</tt>
<aname=console_properties> properties</a>
</b></caption>
<trbgcolor=gray>
<thalign=leftwidth=100>
<fontcolor="white">Name</font>
<thalign=leftwidth=100>
<fontcolor="white">Type</font>
<thalign=left>
<fontcolor="white">Description</font>
<trvalign=top><td><b>screen_columns</b><td>number
<td>number of terminal screen columns (in character cells)
<trvalign=top><td><b>terminal</b><td>string
<td>terminal type description (e.g. 'ANSI')
<trvalign=top><td><b>getstr_offset</b><td>number
<td>cursor position offset for use with <tt>getstr(K_USEOFFSET)</tt>
</table>
<h2><aname=msg_area>msg_area object</a>
<br><fontsize=-1>Message Areas</font>
</h2>
<h2><aname=file_area>file_area object</a>
<br><fontsize=-1>File Transfer Areas</font>
</h2>
<h2><aname=xtrn_area>xtrn_area object</a>
<br><fontsize=-1>External Program Areas</font>
</h2>
<h2><aname=MsgBase>MsgBase class</a>
<br><fontsize=-1>Class used for accessing message bases</font>
</h2>
<p>To create a new MsgBase object: <tt>var msgbase = new MsgBase('<i>code</i>')</tt><br>where <i>code</i> is a sub-board internal code, or <tt>mail</tt> for the e-mail message base</p>
<td>returns a specific message index, <i>null</i> on failure. The index object will contain the following properties:<br><table><tr><td><tt>subject</tt><td>CRC-16 of lowercase message subject<tr><td><tt>to</tt><td>CRC-16 of lowercase recipient's name (or user number if e-mail)<tr><td><tt>from</tt><td>CRC-16 of lowercase sender's name (or user number if e-mail)<tr><td><tt>attr</tt><td>Attribute bitfield<tr><td><tt>time</tt><td>Date/time (in time_t format)<tr><td><tt>number</tt><td>Message number<tr><td><tt>offset</tt><td>Byte-offset into header file</table>
<td>delay between message base open/lock retries (in milliseconds)
</table>
<h2><aname=File>File class</a>
<br><fontsize=-1>Class used for opening, creating, reading, or writing files on the local file system<p>Special features include:</h2><oltype=disc><li>Exclusive-access files (default) or shared files<oltype=circle><li>optional record-locking<li>buffered or non-buffered I/O</ol><li>Support for binary files<oltype=circle><li>native or network byte order (endian)<li>automatic Unix-to-Unix (<i>UUE</i>), yEncode (<i>yEnc</i>) or Base64 encoding/decoding</ol><li>Support for ASCII text files<oltype=circle><li>supports line-based I/O<oltype=square><li>entire file may be read or written as an array of strings<li>individual lines may be read or written one line at a time</ol><li>supports fixed-length records<oltype=square><li>optional end-of-text (<i>etx</i>) character for automatic record padding/termination<li>Synchronet <tt>.dat</tt> files use an <i>etx</i> value of 3 (Ctrl-C)</ol><li>supports <tt>.ini</tt> formated configuration files<li>optional ROT13 encoding/translation</ol><li>Dynamically-calculated industry standard checksums (e.g. CRC-16, CRC-32, MD5)</ol></font>
</h2>
<p>To create a new File object: <tt>var f = new File(filename)</tt></p>
<td>parse all section names from a <tt>.ini</tt> file (format = '<tt>[section]</tt>') and return the section names as an <i>array of strings</i>, optionally, only those section names that begin with the specified <i>prefix</i>
<td>parse a key from a <tt>.ini</tt> file and return its value (format = '<tt>key = value</tt>'). returns the specified <i>default</i> value if the key or value is missing or invalid. will return a <i>bool</i>, <i>number</i>, <i>string</i>, or an <i>array of strings</i> determined by the type of <i>default</i> value specified
<td>parse all sections from a .ini file and return all sections and keys an array of objects with each section's keys as properties of each section object, <i>name_property</i> is the name of the property to create to contain the section's name (default is <tt>"name"</tt>), the optional <i>prefix</i> has the same use as in the <tt>iniGetSections</tt> method, if a <i>prefix</i> is specified, it is removed from each section's name
<td>set to <i>true</i> if binary data is to be written and read in Network Byte Order (big end first)
<trvalign=top><td><b>rot13</b><td>boolean
<td>set to <i>true</i> to enable automatic ROT13 translatation of text
<trvalign=top><td><b>uue</b><td>boolean
<td>set to <i>true</i> to enable automatic Unix-to-Unix encode and decode on <tt>read</tt> and <tt>write</tt> calls
<trvalign=top><td><b>yenc</b><td>boolean
<td>set to <i>true</i> to enable automatic yEnc encode and decode on <tt>read</tt> and <tt>write</tt> calls
<trvalign=top><td><b>base64</b><td>boolean
<td>set to <i>true</i> to enable automatic Base64 encode and decode on <tt>read</tt> and <tt>write</tt> calls
<trvalign=top><td><b>crc16</b><td>number
<td>calculated 16-bit CRC of file contents - <small>READ ONLY</small>
<trvalign=top><td><b>crc32</b><td>number
<td>calculated 32-bit CRC of file contents - <small>READ ONLY</small>
<trvalign=top><td><b>chksum</b><td>number
<td>calculated 32-bit checksum of file contents - <small>READ ONLY</small>
<trvalign=top><td><b>md5_hex</b><td>undefined
<td>calculated 128-bit MD5 digest of file contents as hexadecimal string - <small>READ ONLY</small>
<trvalign=top><td><b>md5_base64</b><td>undefined
<td>calculated 128-bit MD5 digest of file contents as base64-encoded string - <small>READ ONLY</small>
</table>
<h2><aname=Socket>Socket class</a>
<br><fontsize=-1>Class used for TCP/IP socket communications</font>
</h2>
<p>To create a new Socket object: <tt>load('sockdefs.js'); var s = new Socket(<i>type</i>)</tt><br>where <i>type</i> = <tt>SOCK_STREAM</tt> for TCP (default) or <tt>SOCK_DGRAM</tt> for UDP</p>
<td>bind socket to a TCP or UDP <i>port</i> (number or service name), optionally specifying a network interface (via <i>ip_address</i>)
<trvalign=top><td><b>connect</b><td>boolean<td><tt>Socket.connect(host, port [,timeout])
<td>connect to a remote port (number or service name) on the specified host (IP address or host name), default <i>timeout</i> value is <i>10.0</i> (seconds)
<trvalign=top><td><b>sendBin</b><td>boolean<td><tt>Socket.sendBin(number value [,number bytes])
<td>send a binary integer over the socket, default number of bytes is 4 (32-bits)
<trvalign=top><td><b>recvfrom</b><td>object<td><tt>Socket.recvfrom([bool binary] [,maxlen or int_size])
<td>receive data (string or integer) from a socket (typically UDP)<p>returns object with <i>ip_address</i> and <i>port</i> of sender along with <i>data</i><p><i>binary</i> defaults to <i>false</i>, <i>maxlen</i> defaults to 512 chars, <i>int_size</i> defaults to 4 bytes (32-bits)
