tabs

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

diff --git a/frsh_implementation_specific.h b/frsh_implementation_specific.h
index 96978219f234e3d1099b1e15394d3cb9ab229fb8..9af328d3d0f0b343cd32a2bfde8dc3b0817bf9c1 100644 (file)
--- a/frsh_implementation_specific.h
+++ b/frsh_implementation_specific.h
@@ -76,6 +76,8 @@
 
 #define FRSH_IMPLEMENTATION_SPECIFIC_MODULE_SUPPORTED     1
 
+FRSH_CPP_BEGIN_DECLS
+
 /**
  * @file frsh_implementation_specific.h
  *
@@ -84,16 +86,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,41 +109,41 @@
  * 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
  * parameter. This value is stored in a temporary variable and it is
  * used the next time the service thread data is updated with the
- * frsh_set_service_thread_data() function.
+ * frsh_service_thread_set_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,11 +152,11 @@ 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.
- * 
+ *
  * There is a limitation in the current version of the
  * MaRTE implementation that causes the information of a terminated
  * thread to continue to be stored in the frsh scheduler, and the thread
@@ -164,12 +169,25 @@ int frsh_get_service_thread_preemption_level
  * application scheduler, after cleaning up the thread management
  * data, it is unbound and the scheduling policy changed to fixed
  * priority before calling the posix pthread_exit() function.
+ *
+ * NOTE:  This function, together with the internal function
+ *        frsh_internal_remove_thread()  has been removed from FRSH
+ *        because it shouldn't be necessary.
+ *
+ *        If there are some problems with MaRTE in thread termination
+ *        it should be fixed in the OS and not here.
+ *
+ * The function does not do anything special that is not done in the
+ * terminate callback of the FRSH scheduler.
+ *
+ * If you want to be curious about what the function did, look at the
+ * SVN repository (revision 273) or one of the past branches.
  **/
 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,20 +197,21 @@ 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);
 
 /*@}*/
 
+FRSH_CPP_END_DECLS
 
 #endif // _FRSH_IMPLEMENTATION_SPECIFIC_H_