flags moved

[frescor/frsh-include.git] / frsh_implementation_specific.h

diff --git a/frsh_implementation_specific.h b/frsh_implementation_specific.h
index 96978219f234e3d1099b1e15394d3cb9ab229fb8..43f7d8e7304c13429705f0f0ebe74ff501dc43f1 100644 (file)
--- a/frsh_implementation_specific.h
+++ b/frsh_implementation_specific.h
@@ -84,16 +84,19 @@
 /**
  * @defgroup implementationspec Implementation Specific module
  *
- * The operations defined in this module are of optional use. They
- * only work in the fixed priority implementation, and they may be
- * used to enhance the behavior of the applications running under the
- * frsh scheduler.
+ * The operations defined in this module are of optional use. The
+ * intention is to provide better tunning options taking advantage of
+ * specific characteristics of the underlaying OS.
+ *
+ *
+ * e.g. being able to manually assign priorities assuming that the OS
+ * uses a fixed priority paradigm).
  *
  * @{
  **/
 
 /**
- * frsh_set_contract_preemption_level()
+ * frsh_contract_set_preemption_level()
  *
  * The operation updates the specified contract parameters object by
  * setting its preemption level to the specified input parameter.
@@ -104,24 +107,24 @@
  * and probably wrong.
  *
  **/
-int frsh_set_contract_preemption_level
-  (frsh_contract_parameters_t     *contract,
+int frsh_contract_set_preemption_level
+  (frsh_contract_t     *contract,
    frsh_preemption_level_t         preemption_level);
 
 
 /**
- * frsh_get_contract_preemption_level()
+ * frsh_contract_get_preemption_level()
  *
  * The operation obtains from the specified contract parameters object
  * its preemption level and copies it to the place pointed to by the
  * specified input parameter.
  **/
-int frsh_get_contract_preemption_level
-      (const frsh_contract_parameters_t *contract,
+int frsh_contract_get_preemption_level
+      (const frsh_contract_t *contract,
        frsh_preemption_level_t          *preemption_level);
 
 /**
- * frsh_set_service_thread_preemption_level()
+ * frsh_service_thread_set_preemption_level()
  *
  * This function sets the preemption level of the service thread to
  * the specified value. The initial preemption level is a configurable
@@ -129,16 +132,16 @@ int frsh_get_contract_preemption_level
  * used the next time the service thread data is updated with the
  * frsh_set_service_thread_data() function.
  **/
-int frsh_set_service_thread_preemption_level
+int frsh_service_thread_set_preemption_level
       (frsh_preemption_level_t         preemption_level);
 
 /**
- * frsh_get_service_thread_preemption_level()
+ * frsh_service_thread_get_preemption_level()
  *
  * This function stores the current preemption level of the service
  * thread in the variable pointed to by preemption_level
  **/
-int frsh_get_service_thread_preemption_level
+int frsh_service_thread_get_preemption_level
         (frsh_preemption_level_t        *preemption_level);
 
 
@@ -147,7 +150,7 @@ int frsh_get_service_thread_preemption_level
  *
  * This operation shall terminate the calling thread, make the value
  * value_ptr available to any successful join with the terminating
- * thread, and unbind the thread from its associated server. After
+ * thread, and unbind the thread from its associated vres. After
  * cleaning up the thread management data, it is unbound and the
  * scheduling policy is changed to fixed priority before the posix
  * pthread_exit() function is called.
@@ -169,7 +172,7 @@ void frsh_thread_exit (void *value_ptr);
 
 
 /**
- * frsh_set_shared_obj_preemption_level()
+ * frsh_sharedobj_set_preemption_level()
  *
  * The operation updates the specified shared object by setting its
  * preemption level to the specified input parameter.
@@ -179,17 +182,17 @@ void frsh_thread_exit (void *value_ptr);
  * particularly the acceptance tests correctness are not garantee
  * and probably wrong.
  **/
-int frsh_set_shared_obj_preemption_level(frsh_shared_obj_handle_t  obj_handle,
+int frsh_sharedobj_set_preemption_level(frsh_sharedobj_handle_t  obj_handle,
                                      frsh_preemption_level_t   preemption_level);
 
 /**
- * frsh_get_shared_obj_preemption_level()
+ * frsh_sharedobj_get_preemption_level()
  *
  * The operation obtains from the specified shared object its
  * preemption level and copies it to the place pointed to by the
  * specified input parameter.
  **/
-int frsh_get_shared_obj_preemption_level(frsh_shared_obj_handle_t  obj_handle,
+int frsh_sharedobj_get_preemption_level(frsh_sharedobj_handle_t  obj_handle,
                         frsh_preemption_level_t  *preemption_level);
 
 /*@}*/