diff options
Diffstat (limited to 'src/include/gnunet_mq_lib.h')
-rw-r--r-- | src/include/gnunet_mq_lib.h | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h index fd28f3de6..17d8e8e56 100644 --- a/src/include/gnunet_mq_lib.h +++ b/src/include/gnunet_mq_lib.h | |||
@@ -143,22 +143,22 @@ struct GNUNET_MQ_Envelope; | |||
143 | 143 | ||
144 | /** | 144 | /** |
145 | * Error codes for the queue. | 145 | * Error codes for the queue. |
146 | */ | 146 | */ |
147 | enum GNUNET_MQ_Error | 147 | enum GNUNET_MQ_Error |
148 | { | 148 | { |
149 | /** | 149 | /** |
150 | * FIXME: document! | 150 | * FIXME: document! |
151 | */ | 151 | */ |
152 | GNUNET_MQ_ERROR_READ = 1, | 152 | GNUNET_MQ_ERROR_READ = 1, |
153 | 153 | ||
154 | /** | 154 | /** |
155 | * FIXME: document! | 155 | * FIXME: document! |
156 | */ | 156 | */ |
157 | GNUNET_MQ_ERROR_WRITE = 2, | 157 | GNUNET_MQ_ERROR_WRITE = 2, |
158 | 158 | ||
159 | /** | 159 | /** |
160 | * FIXME: document! | 160 | * FIXME: document! |
161 | */ | 161 | */ |
162 | GNUNET_MQ_ERROR_TIMEOUT = 4 | 162 | GNUNET_MQ_ERROR_TIMEOUT = 4 |
163 | }; | 163 | }; |
164 | 164 | ||
@@ -193,7 +193,7 @@ typedef void | |||
193 | * destruction of a message queue. | 193 | * destruction of a message queue. |
194 | * Implementations must not free @a mq, but should | 194 | * Implementations must not free @a mq, but should |
195 | * take care of @a impl_state. | 195 | * take care of @a impl_state. |
196 | * | 196 | * |
197 | * @param mq the message queue to destroy | 197 | * @param mq the message queue to destroy |
198 | * @param impl_state state of the implementation | 198 | * @param impl_state state of the implementation |
199 | */ | 199 | */ |
@@ -203,7 +203,7 @@ typedef void | |||
203 | 203 | ||
204 | /** | 204 | /** |
205 | * Implementation function that cancels the currently sent message. | 205 | * Implementation function that cancels the currently sent message. |
206 | * | 206 | * |
207 | * @param mq message queue | 207 | * @param mq message queue |
208 | * @param impl_state state specific to the implementation | 208 | * @param impl_state state specific to the implementation |
209 | */ | 209 | */ |
@@ -239,7 +239,7 @@ typedef void | |||
239 | struct GNUNET_MQ_MessageHandler | 239 | struct GNUNET_MQ_MessageHandler |
240 | { | 240 | { |
241 | /** | 241 | /** |
242 | * Callback, called every time a new message of | 242 | * Callback, called every time a new message of |
243 | * the specified type has been receied. | 243 | * the specified type has been receied. |
244 | */ | 244 | */ |
245 | GNUNET_MQ_MessageCallback cb; | 245 | GNUNET_MQ_MessageCallback cb; |
@@ -262,7 +262,7 @@ struct GNUNET_MQ_MessageHandler | |||
262 | 262 | ||
263 | /** | 263 | /** |
264 | * Create a new envelope. | 264 | * Create a new envelope. |
265 | * | 265 | * |
266 | * @param mhp message header to store the allocated message header in, can be NULL | 266 | * @param mhp message header to store the allocated message header in, can be NULL |
267 | * @param size size of the message to allocate | 267 | * @param size size of the message to allocate |
268 | * @param type type of the message, will be set in the allocated message | 268 | * @param type type of the message, will be set in the allocated message |
@@ -286,12 +286,12 @@ GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *mqm); | |||
286 | /** | 286 | /** |
287 | * Send a message with the give message queue. | 287 | * Send a message with the give message queue. |
288 | * May only be called once per message. | 288 | * May only be called once per message. |
289 | * | 289 | * |
290 | * @param mq message queue | 290 | * @param mq message queue |
291 | * @param ev the envelope with the message to send. | 291 | * @param ev the envelope with the message to send. |
292 | */ | 292 | */ |
293 | void | 293 | void |
294 | GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq, | 294 | GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq, |
295 | struct GNUNET_MQ_Envelope *ev); | 295 | struct GNUNET_MQ_Envelope *ev); |
296 | 296 | ||
297 | 297 | ||
@@ -385,7 +385,7 @@ GNUNET_MQ_queue_for_callbacks (GNUNET_MQ_SendImpl send, | |||
385 | const struct GNUNET_MQ_MessageHandler *handlers, | 385 | const struct GNUNET_MQ_MessageHandler *handlers, |
386 | GNUNET_MQ_ErrorHandler error_handler, | 386 | GNUNET_MQ_ErrorHandler error_handler, |
387 | void *cls); | 387 | void *cls); |
388 | 388 | ||
389 | 389 | ||
390 | 390 | ||
391 | /** | 391 | /** |