Interface Specification for AdministratorAPI

Overview

AdministratorAPI provides an administrative interface to the KOS kernel.

Type Definitions

The following non-OBJECT types are defined by this interface:

KOSProcessType

An enumeration describing the types of processes tracked by the KOS. One of: kos, kp, extension, kp-starter.

ProcessInfo

A record describing a process tracked by the KOS. The record contains the following slots:

type

The type of the process (KOSProcessType)

name

The process's name (String)

pid

The process's Unix process Id (INTEGER)

kid

For kp and extension type processes, the KPID of the process. For all other process types, value is the empty string. (String).

label

Currently unused, the value is always the empty string. (String).

ProcessList

An alias for SEQUENCE OF ProcessInfo

Visualizer

An alias for ReportingAPI.Visualizer

VisualizerID

An alias for ReportingAPI.VisualizerID

Administrator Objects

The Administrator object represents the administrative interface to the KOS kernel. This object has the following methods:

GetProcessInfo () : ProcessList

Returns information about all processes controlled by the KOS kernel.

RegisterVisualizer (watch : Visualizer) : VisualizerID

Register a new visualizer with the KOS kernel, and returns an indentifier to be used in the UnregisterVisualizer() method. Raises KOS.AuthorizationError if the caller is not authorized to register a visualizer on this particular kernel. Currently authorization is granted based on a list of trusted (or untrusted) fully qualified domain names. Raises KOS.ResourceError if there is an error in determining if the caller is authorized.

ASYNCHRONOUS UnregisterVisualizer (id : VisualizerID)

Withdraws a previously registered visualizer object.

ASYNCHRONOUS Shutdown ()

Gracefully shuts down the KOS kernel.