Welcome to the official documentation of the Universal Server US-Main API

Version: 0.0.20

Authors: Olivier Boudeville (olivier (dot) boudeville (at) esperide (dot) com).

References

See the US-Main official website or its mirror
In terms of dependency, for additional information one may refer to:
- the US-Common official website or its mirror, notably its API documentation
- the (optional) US-Web official website or its mirror, notably its API documentation
- the (optional) Mobile official website or its mirror, notably its API documentation
- the (optional) Seaplus official website or its mirror, notably its API documentation
- the Traces official website or its mirror, notably its API documentation
- the WOOPER official website or its mirror, notably its API documentation
- the Myriad official website or its mirror, notably its API documentation
- to the Erlang official website, notably its API documentation

Overview

The "Universal Server" (US-Main, part of the Universal Server umbrella project), provides various administration-related services.

This website presents the documentation of the API (Application Programming Interface) of US-Main version 0.0.20 (as of Wednesday, April 30, 2025).

US-Main relies on US-Common (for basic elements such as schedulers), on the Traces library (for trace supervision), on the WOOPER layer (for object-oriented constructs) and on the Myriad layer (as a generic Erlang toolbox).

Optionally US-Main may use the Universal Webserver, i.e. US-Web (for web integration), Ceylan-Mobile (for 3G connectivity, notably SMS sending) and Ceylan-Seaplus (as a prerequisite of Ceylan-Mobile for a bridge to the C language).

Note that, currently, code based on WOOPER is not correctly taken into account by edoc: due to some limitations, most of the listed functions lack their documentation, and all methods and also generated code, such as constructors, are invisible to edoc, respectively as it is not aware that they are actually exported in, or added to, the AST. However the full US-Main codebase is intensely documented, refer to this repository for full information.

Generated by EDoc