Subversion Repositories shark

Rev

Rev 993 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

/**
   \mainpage FSF reference

   @author Giuseppe Lipari
   @author Michael Gonzalez Harbour
   @authos Alan Burns
   @author Gehrard Fohler

   This reference manual contains the description of the API provided
   by the FSF library.

   \section intro Introduction to FSF

   The First Scheduling Framework (FSF) is the result of a joint
   effort from four european research groups to propose an API for
   flexible real-time scheduling in Real Time operating systems.

   \section lib Objectives

   (from the FIRST documentation...) Links to the public documents.

   \section what What it provides

   description of the services and modules

   \section modu The modules

   

 */


/**
   \defgroup coremodule Core module

   This module includes the basic functions and services that are
   provided by any FSF implementation. This module includes basic type
   definitions, and functions to

   - create a contract and initialize it
   - set/get the basic parameters of a contract
   - negotiate a service contract, obtaining a server id
   - create and bind threads to servers
   - create/destroy a synchronization object
   - manage bounded workloads
*/


/**
   \defgroup sparemodule Spare capacity sharing module

   This modules include functions for sharing the spare capacity in
   the system between the servers. It allows to mainly to specify
   additional contract parameters to allow the sharing of the spare
   capacity.

   The features provided by this module are different from the
   services provided by the Dynamic reclamation module. This module
   influences the negotiation procedure very much (see the \ref
   core_negotiate module).

   @todo [PEPPE: TB continued]
     
 */


/**
   \defgroup hiermodule Hierarchical scheduling module

   This module includes functions to schedule more than one thread in
   each server. Each server must be assigned a local scheduler which
   is responsible for scheduling the threads in the server.

   @todo [PEPPE: TB continued]
 */


/**
   \defgroup shobjmodule Shared Objects module

   This module include functions to manage shared objects between
   threads.


   @todo [PEPPE: TB continued]
   
 */