]> rtime.felk.cvut.cz Git - frescor/fosa.git/blobdiff - include/fosa_types.h
Renaming FOSA ADS function to use _ to separate words.
[frescor/fosa.git] / include / fosa_types.h
index 3b8a31e81e3c22428e696beebe2b430ddb6c8d0d..442f88ff7c8ebd9599b9adad912a446c0d7ce53f 100644 (file)
@@ -138,44 +138,53 @@ typedef int fosa_ads_urgency_t;
  * contains pointers to the primitive operations that are invoked by
  * the system when a scheduling event occurs:
  *
- * - The init() primitive operation is invoked by the system just after
+ * - The \b init() primitive operation is invoked by the system just after
  *   the scheduler has been created using fosa_ads_scheduler_create().
  *
- * - The new_thread() primitive operation is invoked by the system when
+ * - The \b new_thread() primitive operation is invoked by the system when
  *   a thread has requested attachment to this scheduler; this can be a
  *   newly created thread (via fosa_thread_create()), or an existing thread
  *   that was not running under ads scheduler (via
- *   fosa_ads_setappscheduled()).  The thread can be rejected by the
- *   scheduler adding a reject-thread action to the actions parameter
- *   using fosa_ads_actions_addreject(). If no reject-thread
- *   action is added, the thread is accepted. Newly created threads
- *   shall be activated by the system after the execution of the
- *   new_thread() primitive operation. The urgency of an accepted thread
- *   (either newly created or existing) shall be set to a value of zero,
- *   unless an activate-thread action with a different value of urgency
- *   is added via fosa_ads_actions_addactivate(). If a request to
- *   attach a thread to this scheduler was made via
- *   fosa_ads_setappscheduled(), at the finalization of the new_thread()
+ *   fosa_ads_set_appscheduled()).\n \n 
+ *   .
+ *   The thread can be rejected by the scheduler adding a
+ *   reject-thread action to the actions parameter using
+ *   fosa_ads_actions_add_reject(). If no reject-thread  action is
+ *   added, the thread is accepted.\n \n
+ *   .
+ *   Newly created threads shall be activated by the system after the
+ *   execution of the new_thread() primitive operation. The urgency of
+ *   an accepted thread (either newly created or existing) shall be set
+ *   to a value of zero, unless an activate-thread action with a
+ *   different value of urgency is added via
+ *   fosa_ads_actions_add_activate().\n \n
+ *   .
+ *   If a request to attach a thread to this scheduler was made via
+ *   fosa_ads_set_appscheduled(), at the finalization of the new_thread()
  *   primitive operation if the newly attached thread is blocked by the
- *   system (not by the scheduler itself via a \92¡Èsuspend\92¡É scheduling
+ *   system (not by the scheduler itself via a suspend scheduling
  *   action), a thread-block event shall be generated for the scheduler
  *   immediately and, consequently, the thread_block() primitive
  *   operation shall be invoked by the system.
  *
- * - The thread_terminate() primitive operation is invoked by the system
+ * - The \b thread_terminate() primitive operation is invoked by the system
  *   when a thread attached to this scheduler is terminating (via an
  *   explicit or implicit thread termination, or cancellation, or when
  *   it is no longer sceduled by the ads scheduler (via
- *   fosa_ads_setappscheduled()). Before the thread_terminate()
- *   primitive operation is invoked by the system, all the
- *   thread-notification events programmed for that thread are
- *   cancelled. In the case of a thread that is terminating the
+ *   fosa_ads_setappscheduled()). \n\n
+ *   .
+ *   Before the thread_terminate() primitive operation is invoked by
+ *   the system, all the thread-notification events programmed for that
+ *   thread are cancelled. \n\n
+ *   .
+ *   In the case of a thread that is terminating, the
  *   thread_terminate() primitive operation is executed before the
  *   execution of the cleanup handlers and of the thread-specific data
  *   destructor functions. In that way, the thread parameter corresponds
  *   to a valid thread Id and the thread-specific data is valid and can
- *   be accessed from the thread_terminate() primitive operation. Also
- *   for terminating threads, after the thread_terminate() primitive
+ *   be accessed from the thread_terminate() primitive operation. \n\n
+ *   .
+ *   Also for terminating threads, after the thread_terminate() primitive
  *   operation finishes, the system shall lower the urgency of the
  *   thread identified by thread to a value of zero, and shall deattach
  *   it from the ads scheduler.  Then, the thread shall execute the
@@ -185,47 +194,50 @@ typedef int fosa_ads_urgency_t;
  *   identified by parameter thread during the execution of the
  *   thread_terminate() primitive operation.
  *
- * - The thread_ready() primitive operation is invoked by the system
+ * - The \b thread_ready() primitive operation is invoked by the system
  *   when a thread attached to this scheduler that was blocked has
  *   become unblocked by the system.
  *
- * - The thread_block() primitive operation is invoked by the system
+ * - The \b thread_block() primitive operation is invoked by the system
  *   when a thread attached to this scheduler has blocked.
  *
- * - The change_sched_param_thread() primitive operation is invoked by
+ * - The \b change_sched_param_thread() primitive operation is invoked by
  *   the system when the scheduling parameters of a thread attached to
  *   this scheduler have been changed, but the thread continues to run
- *   under this scheduler. The change includes either the regular sched-
- *   uling parameters (fosa_thread_set_prio() or the application-defined
- *   scheduling parameters, via fosa_ads_setappschedparam().
+ *   under this scheduler. The change includes either the regular
+ *   scheduling parameters (fosa_thread_set_prio() or the application-
+ *   defined scheduling parameters, via fosa_ads_set_appsched_param(). 
  *
- * - The explicit_call_with_data() primitive operation is invoked by the
+ * - The \b explicit_call_with_data() primitive operation is invoked by the
  *   system when a thread (identified by the thread parameter) has
  *   explicitly invoked the scheduler with a message containing
  *   scheduling information, and possibly requesting a reply message,
  *   via fosa_ads_invoke_withdata().
  *
- * - The notification_for_thread() primitive operation is invoked by the
+ * - The \b notification_for_thread() primitive operation is invoked by the
  *   system when the time for a thread-notification previously programed
- *   by the scheduler via fosa_ads_actions_addthreadnotification()
+ *   by the scheduler via fosa_ads_actions_add_thread_notification()
  *   is reached. Parameter clock identifies the clock for which the
  *   thread-notification was programmed.
  *
- * - The timeout() primitive operation is invoked by the system when a
+ * - The \b timeout() primitive operation is invoked by the system when a
  *   timeout requested by the scheduler (via
- *   fosa_ads_actions_addtimeout()) has expired.
+ *   fosa_ads_actions_add_timeout()) has expired. 
  *
- * - The signal() primitive operation is invoked by the system when a
+ * - The \b signal() primitive operation is invoked by the system when a
  *   signal belonging to the set of signals for which the scheduler is
- *   waiting (via fosa_ads_sethandledsignalset()) has been
- *   generated. The signal number and its associated information (if
- *   any) are passed in the arguments signal and siginfo. The signal is
- *   consumed with the invocation of this primitive operation, which
- *   implies that it will not cause the execution of any signal handler,
- *   nor it may be accepted by any thread waiting for this signal
- *   number.
+ *   waiting (via fosa_ads_set_handled_signal_set()) has been
+ *   generated. \n\n
+ *   .
+ *   The signal number and its associated information (if any) are
+ *   passed in the arguments signal and siginfo.\n\n
+ *   .
+ *   The signal is consumed with the invocation of this primitive
+ *   operation, which implies that it will not cause the execution of
+ *   any signal handler, nor it may be accepted by any thread waiting
+ *   for this signal number.  
  *
- * - The appsched_error() primitive operation is invoked by the system
+ * - The \b appsched_error() primitive operation is invoked by the system
  *   when an error in the scheduling actions list specified in a
  *   previous primitive operation is detected. The cause of the error is
  *   notified in the parameter cause. The defined causes of error are