Commit 242eca0a authored by Per Cederqvist's avatar Per Cederqvist
Browse files

(Server Information): Document Static-Server-Info.

(get-boottime-info): New request.
(Measured Properties): Added "confs" and "persons".
parent c0d07dba
......@@ -2021,6 +2021,7 @@ indicate that a certain local text number doesn't exist.
@tindex Info
@tindex Info-Old
@tindex Version-Info
@tindex Static-Server-Info
@example
Info ::=
( version : @lt{INT32};
......@@ -2048,10 +2049,22 @@ indicate that a certain local text number doesn't exist.
server-software : @lt{HOLLERITH};
software-version : @lt{HOLLERITH};
)
@anchor{Static-Server-Info}
Static-Server-Info ::=
( boot-time : @lt{Time};
save-time : @lt{Time};
db-status : @lt{HOLLERITH};
existing-texts : @lt{INT32};
highest-text-no : @lt{Text-No};
existing-confs : @lt{INT32};
existing-persons : @lt{INT32};
highest-conf-no : @lt{Conf-No};
)
@end example
These data types contain information about the LysKOM server. The fields
of @type{Info} and @type{Info-Old} are
of @type{Info} and @type{Info-Old} are:
@table @field
@item version
......@@ -2090,6 +2103,51 @@ Human-readable name of the server software.
Human-readable name of the server software version.
@end table
The @type{Static-Server-Info} contains information about the state of
the server when it started. It contains the following fields:
@table @field
@item boot-time
When did the server start?
@item save-time
When the server starts, it examines the database to see when it was
saved. That information is available here.
@item db-status
The status of the database that the server found on startup. The
value is implementation-defined. lyskomd reports @code{clean} (if the
previous invocation of the server was shut down cleanly) or
@code{backup} (which means that some information may have been lost in
the last restart). Clients should be prepared to find other values
here.
@item existing-texts
Number of texts that existed on startup. (To find out how many texts
exists right now, you can use the @reqdlink{get-stats} call with
@code{what} set to @code{texts}@linkhere{}.)
@item highest-text-no
The highest text number that existed on startup. (To find the highest
text number that exists right now, use the
@reqdlink{find-previous-text-no} call with a very large
argument@linkhere{}.)
@item existing-confs
Number of conferences (including letterboxes) that existed on startup.
(To find out how many conferences exists right now, you can use the
@reqdlink{get-stats} call with @code{what} set to
@code{confs}@linkhere{}.)
@item existing-persons
Number of persons that existed on startup. (To find out how many
persons exists right now, you can use the @reqdlink{get-stats} call
with @code{what} set to @code{persons}@linkhere{}.)
@item highest-conf-no
The highest conference number that existed on startup.
@end table
@node Person Status Types
@section Person Status Types
......@@ -3014,6 +3072,7 @@ their current status.
* set-read-ranges:: r Specify which texts that are read (110)
* get-stats-description:: r Get a list of measured properties (111)
* get-stats:: r Get a measurement (112)
* get-boottime-info:: r Get server startup status information (113)
@end menu
@ifnottex
......@@ -8281,6 +8340,24 @@ The server doesn't measure the value requested by @rarg{what}.
The client isn't allowed to retrieve the requested value.
@end table
@node get-boottime-info
@section get-boottime-info [113] (11) Recommended
@findex get-boottime-info
@example
get-boottime-info [113] ( )
-> ( @lt{Static-Server-Info} );
@end example
Return status information that was current when the server started.
This include the time of the last restart. Clients are encouraged to
cache the return value of this request, as it will never change while
a client is connected.
@subheading Error codes
This call always succeeds
@node Asynchronous Messages
......@@ -9889,6 +9966,12 @@ but that might change in the future.
@item texts
The number of existing texts.
@item confs
The number of existing conferences (including letterboxes).
@item persons
The number of existing persons.
@item send-queue-bytes
@itemx recv-queue-bytes
The number of bytes waiting in the send and receive queues.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment