diff options
author | Nathan S. Evans <evans@in.tum.de> | 2010-03-29 13:31:01 +0000 |
---|---|---|
committer | Nathan S. Evans <evans@in.tum.de> | 2010-03-29 13:31:01 +0000 |
commit | 61e1304a8d3b3322c0b22c89ace77a4695a6feae (patch) | |
tree | c6687391de5d16ff48c12b18d53b3da7475a152c /src/include/gnunet_dht_service.h | |
parent | 6e4e4da0ac8850db8499a4456573a50ed8346e0e (diff) | |
download | gnunet-61e1304a8d3b3322c0b22c89ace77a4695a6feae.tar.gz gnunet-61e1304a8d3b3322c0b22c89ace77a4695a6feae.zip |
doxygen additions
Diffstat (limited to 'src/include/gnunet_dht_service.h')
-rw-r--r-- | src/include/gnunet_dht_service.h | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index 097062164..09a891842 100644 --- a/src/include/gnunet_dht_service.h +++ b/src/include/gnunet_dht_service.h | |||
@@ -53,8 +53,8 @@ typedef void (*GNUNET_DHT_MessageCallback)(void *cls, | |||
53 | /** | 53 | /** |
54 | * Initialize the connection with the DHT service. | 54 | * Initialize the connection with the DHT service. |
55 | * | 55 | * |
56 | * @param cfg configuration to use | ||
57 | * @param sched scheduler to use | 56 | * @param sched scheduler to use |
57 | * @param cfg configuration to use | ||
58 | * @param ht_len size of the internal hash table to use for | 58 | * @param ht_len size of the internal hash table to use for |
59 | * processing multiple GET/FIND requests in parallel | 59 | * processing multiple GET/FIND requests in parallel |
60 | * @return NULL on error | 60 | * @return NULL on error |
@@ -68,10 +68,10 @@ GNUNET_DHT_connect (struct GNUNET_SCHEDULER_Handle *sched, | |||
68 | /** | 68 | /** |
69 | * Shutdown connection with the DHT service. | 69 | * Shutdown connection with the DHT service. |
70 | * | 70 | * |
71 | * @param h connection to shut down | 71 | * @param handle connection to shut down |
72 | */ | 72 | */ |
73 | void | 73 | void |
74 | GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *h); | 74 | GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *handle); |
75 | 75 | ||
76 | 76 | ||
77 | /** | 77 | /** |
@@ -79,12 +79,12 @@ GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *h); | |||
79 | * a binding of 'key' to 'value'. The peer does not have to be part | 79 | * a binding of 'key' to 'value'. The peer does not have to be part |
80 | * of the table (if so, we will attempt to locate a peer that is!) | 80 | * of the table (if so, we will attempt to locate a peer that is!) |
81 | * | 81 | * |
82 | * @param h handle to DHT service | 82 | * @param handle handle to DHT service |
83 | * @param key the key to store under | 83 | * @param key the key to store under |
84 | * @param type type of the value | 84 | * @param type type of the value |
85 | * @param size number of bytes in data; must be less than 64k | 85 | * @param size number of bytes in data; must be less than 64k |
86 | * @param data the data to store | 86 | * @param data the data to store |
87 | * @param exp desired expiration time for the value | 87 | * @param exp desired expiration time for the data |
88 | * @param timeout when to abort with an error if we fail to get | 88 | * @param timeout when to abort with an error if we fail to get |
89 | * a confirmation for the PUT from the local DHT service | 89 | * a confirmation for the PUT from the local DHT service |
90 | * @param cont continuation to call when done; | 90 | * @param cont continuation to call when done; |
@@ -94,14 +94,14 @@ GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *h); | |||
94 | */ | 94 | */ |
95 | void | 95 | void |
96 | GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, | 96 | GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, |
97 | const GNUNET_HashCode * key, | 97 | const GNUNET_HashCode * key, |
98 | uint32_t type, | 98 | uint32_t type, |
99 | uint32_t size, | 99 | uint32_t size, |
100 | const char *data, | 100 | const char *data, |
101 | struct GNUNET_TIME_Absolute exp, | 101 | struct GNUNET_TIME_Absolute exp, |
102 | struct GNUNET_TIME_Relative timeout, | 102 | struct GNUNET_TIME_Relative timeout, |
103 | GNUNET_SCHEDULER_Task cont, | 103 | GNUNET_SCHEDULER_Task cont, |
104 | void *cont_cls); | 104 | void *cont_cls); |
105 | 105 | ||
106 | 106 | ||
107 | /** | 107 | /** |
@@ -133,7 +133,7 @@ typedef void (*GNUNET_DHT_GetIterator)(void *cls, | |||
133 | /** | 133 | /** |
134 | * Perform an asynchronous GET operation on the DHT identified. | 134 | * Perform an asynchronous GET operation on the DHT identified. |
135 | * | 135 | * |
136 | * @param h handle to the DHT service | 136 | * @param handle handle to the DHT service |
137 | * @param timeout timeout for this request to be sent to the | 137 | * @param timeout timeout for this request to be sent to the |
138 | * service | 138 | * service |
139 | * @param type expected type of the response object | 139 | * @param type expected type of the response object |
@@ -146,7 +146,7 @@ typedef void (*GNUNET_DHT_GetIterator)(void *cls, | |||
146 | * @return handle to stop the async get, NULL on error | 146 | * @return handle to stop the async get, NULL on error |
147 | */ | 147 | */ |
148 | struct GNUNET_DHT_RouteHandle * | 148 | struct GNUNET_DHT_RouteHandle * |
149 | GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *h, | 149 | GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *handle, |
150 | struct GNUNET_TIME_Relative timeout, | 150 | struct GNUNET_TIME_Relative timeout, |
151 | uint32_t type, | 151 | uint32_t type, |
152 | const GNUNET_HashCode * key, | 152 | const GNUNET_HashCode * key, |
@@ -216,10 +216,12 @@ struct GNUNET_DHT_RouteHandle; | |||
216 | * given DHT or not hit exactly). | 216 | * given DHT or not hit exactly). |
217 | * @param options options for routing | 217 | * @param options options for routing |
218 | * @param enc send the encapsulated message to a peer close to the key | 218 | * @param enc send the encapsulated message to a peer close to the key |
219 | * @param timeout when to abort with an error if we fail to get | ||
220 | * a confirmation for the request (when necessary) or how long | ||
221 | * to wait for tramission to the service | ||
219 | * @param iter function to call on each result, NULL if no replies are expected | 222 | * @param iter function to call on each result, NULL if no replies are expected |
220 | * @param iter_cls closure for iter | 223 | * @param iter_cls closure for iter |
221 | * @param timeout when to abort with an error if we fail to get | 224 | |
222 | * a confirmation for the PUT from the local DHT service | ||
223 | * @param cont continuation to call when done, GNUNET_SYSERR if failed | 225 | * @param cont continuation to call when done, GNUNET_SYSERR if failed |
224 | * GNUNET_OK otherwise | 226 | * GNUNET_OK otherwise |
225 | * @param cont_cls closure for cont | 227 | * @param cont_cls closure for cont |