Ferite Documentation

This documentation has been automatically generated from the ferite modules: array, console, date, filesystem, ipc, math, misc, network, posix, reflection, regexp, rmi, serialize, stream, string, sys, test, thread, unix, xml.

Files Generated
Alarm - Provide a means for setting an alarm [date]
Array - Provides a set of functions to manipulate arrays [array]
Class - Instances of this class are used to inspect Ferite classes [reflection]
Console - Provides a simple interface to the stdin, stdout, and stderr streams [console]
Date - Provides a time object with which information can be gathered [date]
Directory - This class provides a means for accessing a directory for reading [filesystem]
Event - A thread safe way of signalling events between threads [thread]
File - This class provides a means for accessing a file for reading or writing [filesystem]
FileSystem - The core container for the filesystem utilities and constants [filesystem]
FreezeThaw - Provides a 'lite' set of function(s) to manipulate frozen variables [misc]
Function - Instances of this class are used to inspect Ferite functions [reflection]
GetOptLong - Gives arguement parsing ability [misc]
IPCObject - Provides an interface to Unix SysV style shared memory [ipc]
MatchObject - This class is what is used to return match information from regular expression object [regexp]
Math - Provides a set of mathematical functions [math]
Math.Complex - Provides methods for manipulating complex numbers [math]
Mutex - A mutex that can be used to lock sections of code [thread]
Namespace - This class wraps a ferite namespace and provides mechanisms to query it's contents [reflection]
Network
Network.Host - Finds information about a network host [network]
Network.Service - Stores information about a network service [network]
Network.TCP - TCP contains the tcp/ip specific functions and classes [network]
Network.TCP.Stream - Provides a tcp stream implementation of the standard stream object [network]
Network.UDP - The UDP namespace provides a set of tools to access udp streams [network]
Network.UDP.Stream - Used for sending and receiving UDP datagrams [network]
Network.Unix - The Unix namespace provides a set of tools to access unix domain socket streams [unix]
Network.Unix.Stream - Provides a Unix domain socket implementation of the Stream object [unix]
Object - Instances of this class are used to inspect Ferite objects [reflection]
Posix
Posix.Pipe - This class provides a means for talking to a forked child process [posix]
Posix.ProcessStream - This class provides a means for reading or writing to another process [posix]
Posix.Rlimit - Allows you to get and set resource limits [posix]
Posix.Rusage - Get the resource usage of this process or all dead child processes [posix]
Posix.SelectResult - Returned by Posix [posix]
Posix.Stat - Provides functions to interrogate the information returned after a Posix [posix]
Posix.Uname - This class provides various system information [posix]
Posix.User - Class to wrap the information about a user [posix]
Regexp - The core class of the regular expression engine [regexp]
RMI - The top-level namespace for the Remote Method Invocation framework [rmi]
RMI.Error - Error return values [rmi]
Serialize - Provies a set of functions to serialize and deserialize objects [serialize]
Stream - This is the core of the stream layer that provides the io operations for ferite scripts [stream]
Stream.StdioStream - Provides a standard io interface to a native OS stream [stream]
Stream.Stream - Provides the mechanism for stream objects - it has a number of methods for use [stream]
Stream.StringStream - Provides a way to access a string as if it were a stream [stream]
String - Provides a set of functions to manipulate strings [string]
Sys - The main system namespace, it provides a abstract system interface [sys]
Sys.env - Provides access to the enviroment the script runs in [sys]
Thread - A thread object allowing for multi-threaded scripts within the ferite environment [thread]
Unix - The main unix namespace, it provides a standard unix system interface [unix]
Unix.SyslogStream - This is Stream returned by Unix [unix]
Variable - This class allows you to wrap a variable and access the accessor mechanism provided by ferite [reflection]
XML - This namespace holds the various XML tools that can be used within ferite [xml]
XML.Element - This class hold an xml element and its sub tree [xml]
XML.SAXParser - Implements a SAXParser [xml]
XML.TreeParser - Implements a TreeParser [xml]

Automatically generated at 12:08PM, Wednesday 25 May 2005 by feritedoc.