Added a comment description of frsh_thread_join_in_the_background. No

other code change.

git-svn-id: http://www.frescor.org/private/svn/frescor/frsh/trunk/include@1729 35b4ef3e-fd22-0410-ab77-dab3279adceb

diff --git a/frsh_core.h b/frsh_core.h
index 0ad8b2af3f0b13f95af2551b58c9a77acb9bfa8b..2757a1ea317578c42d8dc58f4f724e4a38c1a1a1 100644 (file)
--- a/frsh_core.h
+++ b/frsh_core.h
@@ -848,6 +848,31 @@ int frsh_thread_create_in_background
      frsh_vres_id_t *vres_id);
 
 
+
+/**
+ * frsh_thread_join_in_background()
+ *
+ * This function is aimed for external threads to join FRSH in the
+ * least disturbing possible mode.
+ *
+ * Upon calling this function by a thread which has been created
+ * natively in the OS, it joins the framework and gets inmediately
+ * bound to an on-the-fly generated background contract.
+ *
+ * In order to gain a higher priority then it can renegotiate a
+ * contract for its vres with the needed parameters.
+ *
+ * @param[in] resource_id:   Resource (CPU) in which the vres will
+ *                           be associated.
+ *
+ * @param[in] resource_type: Resource type (should be CPU) for the
+ *                           contract.
+ *
+ * @param[in] label:         Label to be added to the contract.
+ *
+ * @param[out] vres_id:      Resulting vres_id from the on-the-fly
+ *                           generated background contract.
+ **/
 int frsh_thread_join_in_background(frsh_resource_id_t resource_id,
                                    frsh_resource_type_t resource_type,
                                    const char *label,