tabs

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

diff --git a/frsh_implementation_specific.h b/frsh_implementation_specific.h
index 309c961e278bad01df3d1ef6c369984ce49c29a1..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
  *
@@ -130,7 +132,7 @@ int frsh_contract_get_preemption_level
  * 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_service_thread_set_preemption_level
       (frsh_preemption_level_t         preemption_level);
@@ -150,11 +152,11 @@ int frsh_service_thread_get_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
@@ -167,6 +169,19 @@ int frsh_service_thread_get_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);
 
@@ -197,5 +212,6 @@ int frsh_sharedobj_get_preemption_level(frsh_sharedobj_handle_t  obj_handle,
 
 /*@}*/
 
+FRSH_CPP_END_DECLS
 
 #endif // _FRSH_IMPLEMENTATION_SPECIFIC_H_