Status Server Requirements
24 May 2002
PDF version of this document
is more suitable for printing.
2. General Description
3. Functional Requirements
3.1 Clients must have the ability to create, update, and retrieve objects.
3.2 Clients must have the ability to remove objects.
3.3 Information within the Status Server must be open and accessible to any connected client within the CFHT network.
3.4 Clients must be able to store String, Boolean, Floating Point, and Integer objects.
3.5 Clients must be able to place a monitor on objects.
3.6 Clients must be able to specify a ``deadband'' range for monitored floating point and integer objects.
3.7 Clients must be able to specify a minimum age for monitored objects.
3.8 Clients must be able to specify the length of time an object can be considered valid.
3.9 Objects must be stored in an organized fashion, much like a file system.
3.10 The Status Server must have have the facilities to support an archive agent (client).
4. Interface Requirements
4.1 Status Server must be accessible via a TCP/IP socket-based networking protocol.
4.2 Status Server must be accessible via a C API.
4.3 Status Server must be accessible via Shell utilities.
5. Performance Requirements
5.1 Individual objects within the Status Server should be updated at a maximum frequency of one hertz.
5.2 The maximum storage size associated with the value of an object within the Status Server should be fixed.
5.3 As a goal, the typical transaction latency should be less than 10 milliseconds.
6. Security Requirements
6.1 Access must be restricted to the CFHT internal network.
7. Disaster Recovery Requirements
7.1 Data must be serialized every 10 minutes for possible recovery in case of a system failure.
8. Remote Diagnostic Requirements
8.1 Must be able to telnet into the Status Server.
8.2 Must have the ability to initiate a trace on all Status Server activity.
9. System Requirements
9.1 Status Server must be designed to run on a UNIX machine within the CFHT network.
9.2 Socket implementation must be compatible with the "Internet Protocol Version 4" (IPv4).
10. Document Change Log
A. Preliminary Status Server Information