Changes in names of spare capacity functions. Change in message_get_tx_time (tx_time...

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

diff --git a/doc/api_fna_html.tar.gz b/doc/api_fna_html.tar.gz
index ee9ad550bce7b677f49327024d697b237dc9252f..c64a03b37ad3819f656750b2cdd9d094527063c2 100644 (file)
Binary files a/doc/api_fna_html.tar.gz and b/doc/api_fna_html.tar.gz differ

diff --git a/doc/fna-refman.pdf b/doc/fna-refman.pdf
index 45f3a41433f4a28d42d8ba7e212c9aa858fd70c3..2720b0fd46b906c1ae6c7560f5e281f298c7f8bc 100644 (file)
Binary files a/doc/fna-refman.pdf and b/doc/fna-refman.pdf differ

diff --git a/include/fna.h b/include/fna.h
index 0c80ce9b18ba117406898a5d00732a6387ea0404..a1096959d24f6dd1b2a5fb6f0ee54c9342b6e881 100644 (file)
--- a/include/fna.h
+++ b/include/fna.h
@@ -450,7 +450,7 @@ int fna_vres_get_budget_and_period
  **/
 
 /**
- * fna_spare_get_capacity()
+ * fna_resource_get_capacity()
  *
  * This operation gets the spare capacity currently assigned to a importance
  * level. If we divide this value by UINT32_MAX we will get the network
@@ -473,13 +473,13 @@ int fna_vres_get_budget_and_period
  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
  *
  **/
-int fna_spare_get_capacity
+int fna_resource_get_capacity
       (const frsh_resource_id_t resource_id,
        const int importance,
        uint32_t *capacity);
 
 /**
- * fna_spare_get_total_weight()
+ * fna_resource_get_total_weight()
  *
  * This function gets the sum of the weight parameters for all vres in a
  * network of an importance level.
@@ -497,13 +497,13 @@ int fna_spare_get_capacity
  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
  *
  **/
-int fna_spare_get_total_weight
+int fna_resource_get_total_weight
       (const frsh_resource_id_t resource_id,
        const int importance,
        int *total_weight);
 
 /**
- * fna_spare_release_capacity()
+ * fna_vres_decrease_capacity()
  *
  * This function allows to ask for less budget and period than what we
  * received. The request must be compatible with the rest of contract
@@ -527,7 +527,7 @@ int fna_spare_get_total_weight
  *      contract \n
  *
  **/
-int fna_spare_release_capacity
+int fna_vres_decrease_capacity
       (const frsh_resource_id_t resource_id,
        const fna_vres_id_t vres,
        const struct timespec new_budget,
@@ -782,17 +782,18 @@ int fna_receive_endpoint_get_status
 /**
  * fna_message_get_tx_time()
  *
- * This operation gives the worst case transmission time that it takes to
+ * This operation gives the physical transmission time that it takes to
  * send a message of the nbytes size through the network designated by
- * resource_id, including any network overheads (fragmentation in packets,
+ * resource_id, not including any network overheads (fragmentation in packets,
  * headers, retransmissions,...).
  *
  * It is be used by the application to calculate the minimum and
  * maximum budgets used in the preparation of network contracts.
+ * (Note that in the negotiation overheads must be taken into account)
  *
  * @param[in] resource_id The network we want the tx time from.
  * @param[in] nbytes Number of bytes of the message
- * @param[out] tx_time The transmission time for nbytes (including overheads)
+ * @param[out] tx_time The transmission time for nbytes (without overheads)
  *
  * @return
  *   FNA_NO_ERROR: in this case it also means contract accepted \n