aboutsummaryrefslogtreecommitdiff
path: root/include/gnunet_chat_lib.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/gnunet_chat_lib.h')
-rw-r--r--include/gnunet_chat_lib.h126
1 files changed, 63 insertions, 63 deletions
diff --git a/include/gnunet_chat_lib.h b/include/gnunet_chat_lib.h
index e061429..d5de43a 100644
--- a/include/gnunet_chat_lib.h
+++ b/include/gnunet_chat_lib.h
@@ -119,9 +119,9 @@ struct GNUNET_CHAT_Invitation;
119 * Method called whenever an issue occurs regarding a certain chat context 119 * Method called whenever an issue occurs regarding a certain chat context
120 * of a specific chat handle. 120 * of a specific chat handle.
121 * 121 *
122 * @param[in/out] cls Closure from #GNUNET_CHAT_start 122 * @param[in,out] cls Closure from #GNUNET_CHAT_start
123 * @param[in/out] handle Chat handle 123 * @param[in,out] handle Chat handle
124 * @param[in/out] context Chat context 124 * @param[in,out] context Chat context
125 * @param[in] reason Reason indicating the issue 125 * @param[in] reason Reason indicating the issue
126 */ 126 */
127typedef void 127typedef void
@@ -131,9 +131,9 @@ typedef void
131/** 131/**
132 * Iterator over chat contacts of a specific chat handle. 132 * Iterator over chat contacts of a specific chat handle.
133 * 133 *
134 * @param[in/out] cls Closure from #GNUNET_CHAT_iterate_contacts 134 * @param[in,out] cls Closure from #GNUNET_CHAT_iterate_contacts
135 * @param[in/out] handle Chat handle 135 * @param[in,out] handle Chat handle
136 * @param[in/out] contact Chat contact 136 * @param[in,out] contact Chat contact
137 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 137 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
138 */ 138 */
139typedef int 139typedef int
@@ -143,9 +143,9 @@ typedef int
143/** 143/**
144 * Iterator over chat groups of a specific chat handle. 144 * Iterator over chat groups of a specific chat handle.
145 * 145 *
146 * @param[in/out] cls Closure from #GNUNET_CHAT_iterate_groups 146 * @param[in,out] cls Closure from #GNUNET_CHAT_iterate_groups
147 * @param[in/out] handle Chat handle 147 * @param[in,out] handle Chat handle
148 * @param[in/out] group Chat group 148 * @param[in,out] group Chat group
149 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 149 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
150 */ 150 */
151typedef int 151typedef int
@@ -155,9 +155,9 @@ typedef int
155/** 155/**
156 * Iterator over chat contacts in a specific chat group. 156 * Iterator over chat contacts in a specific chat group.
157 * 157 *
158 * @param[in/out] cls Closure from #GNUNET_CHAT_group_iterate_contacts 158 * @param[in,out] cls Closure from #GNUNET_CHAT_group_iterate_contacts
159 * @param[in/out] group Chat group 159 * @param[in,out] group Chat group
160 * @param[in/out] contact Chat contact 160 * @param[in,out] contact Chat contact
161 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 161 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
162 */ 162 */
163typedef int 163typedef int
@@ -167,8 +167,8 @@ typedef int
167/** 167/**
168 * Iterator over chat messages in a specific chat context. 168 * Iterator over chat messages in a specific chat context.
169 * 169 *
170 * @param[in/out] cls Closure from #GNUNET_CHAT_context_iterate_messages 170 * @param[in,out] cls Closure from #GNUNET_CHAT_context_iterate_messages
171 * @param[in/out] context Chat context 171 * @param[in,out] context Chat context
172 * @param[in] message Chat message 172 * @param[in] message Chat message
173 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 173 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
174 */ 174 */
@@ -179,9 +179,9 @@ typedef int
179/** 179/**
180 * Iterator over chat files in a specific chat context. 180 * Iterator over chat files in a specific chat context.
181 * 181 *
182 * @param[in/out] cls Closure from #GNUNET_CHAT_context_iterate_files 182 * @param[in,out] cls Closure from #GNUNET_CHAT_context_iterate_files
183 * @param[in/out] context Chat context 183 * @param[in,out] context Chat context
184 * @param[in/out] file Chat file 184 * @param[in,out] file Chat file
185 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 185 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
186 */ 186 */
187typedef int 187typedef int
@@ -192,7 +192,7 @@ typedef int
192 * Iterator over chat contacts in a chat to check whether they received a 192 * Iterator over chat contacts in a chat to check whether they received a
193 * specific message or not. 193 * specific message or not.
194 * 194 *
195 * @param[in/out] cls Closure from #GNUNET_CHAT_message_get_read_receipt 195 * @param[in,out] cls Closure from #GNUNET_CHAT_message_get_read_receipt
196 * @param[in] message Chat message 196 * @param[in] message Chat message
197 * @param[in] contact Chat contact 197 * @param[in] contact Chat contact
198 * @param[in] read_receipt #GNUNET_YES if the message was received by the contact, 198 * @param[in] read_receipt #GNUNET_YES if the message was received by the contact,
@@ -207,7 +207,7 @@ typedef int
207/** 207/**
208 * Method called during an upload of a specific file in a chat to share it. 208 * Method called during an upload of a specific file in a chat to share it.
209 * 209 *
210 * @param[in/out] cls Closure from #GNUNET_CHAT_context_send_file 210 * @param[in,out] cls Closure from #GNUNET_CHAT_context_send_file
211 * @param[in] file Chat file 211 * @param[in] file Chat file
212 * @param[in] completed Amount of the file being uploaded (in bytes) 212 * @param[in] completed Amount of the file being uploaded (in bytes)
213 * @param[in] size Full size of the uploading file (in bytes) 213 * @param[in] size Full size of the uploading file (in bytes)
@@ -219,7 +219,7 @@ typedef void
219/** 219/**
220 * Method called during a download of a specific file in a chat which was shared. 220 * Method called during a download of a specific file in a chat which was shared.
221 * 221 *
222 * @param[in/out] cls Closure from #GNUNET_CHAT_file_start_download 222 * @param[in,out] cls Closure from #GNUNET_CHAT_file_start_download
223 * @param[in] file Chat file 223 * @param[in] file Chat file
224 * @param[in] completed Amount of the file being downloaded (in bytes) 224 * @param[in] completed Amount of the file being downloaded (in bytes)
225 * @param[in] size Full size of the downloading file (in bytes) 225 * @param[in] size Full size of the downloading file (in bytes)
@@ -232,8 +232,8 @@ typedef void
232 * Method called during an unindexing of a specific file in a chat which was 232 * Method called during an unindexing of a specific file in a chat which was
233 * uploaded before. 233 * uploaded before.
234 * 234 *
235 * @param[in/out] cls Closure from #GNUNET_CHAT_file_unindex 235 * @param[in,out] cls Closure from #GNUNET_CHAT_file_unindex
236 * @param[in/out] file Chat file 236 * @param[in,out] file Chat file
237 * @param[in] completed Amount of the file being unindexed (in bytes) 237 * @param[in] completed Amount of the file being unindexed (in bytes)
238 * @param[in] size Full size of the unindexing file (in bytes) 238 * @param[in] size Full size of the unindexing file (in bytes)
239 */ 239 */
@@ -252,9 +252,9 @@ typedef void
252 * @param[in] directory Application directory path (optional) 252 * @param[in] directory Application directory path (optional)
253 * @param[in] name User name (optional) 253 * @param[in] name User name (optional)
254 * @param[in] warn_cb Callback for warnings (optional) 254 * @param[in] warn_cb Callback for warnings (optional)
255 * @param[in/out] warn_cls Closure for warnings (optional) 255 * @param[in,out] warn_cls Closure for warnings (optional)
256 * @param[in] msg_cb Callback for message events (optional) 256 * @param[in] msg_cb Callback for message events (optional)
257 * @param[in/out] msg_cls Closure for message events (optional) 257 * @param[in,out] msg_cls Closure for message events (optional)
258 * @return Chat handle 258 * @return Chat handle
259 */ 259 */
260struct GNUNET_CHAT_Handle* 260struct GNUNET_CHAT_Handle*
@@ -268,7 +268,7 @@ GNUNET_CHAT_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
268 * Stops a chat handle closing all its remaining resources and frees the 268 * Stops a chat handle closing all its remaining resources and frees the
269 * regarding memory. 269 * regarding memory.
270 * 270 *
271 * @param[in/out] handle Chat handle 271 * @param[in,out] handle Chat handle
272 */ 272 */
273void 273void
274GNUNET_CHAT_stop (struct GNUNET_CHAT_Handle *handle); 274GNUNET_CHAT_stop (struct GNUNET_CHAT_Handle *handle);
@@ -280,7 +280,7 @@ GNUNET_CHAT_stop (struct GNUNET_CHAT_Handle *handle);
280 * Updating the chat handle should only be used if necessary because the usage 280 * Updating the chat handle should only be used if necessary because the usage
281 * can require renewed exchanging of GNS entries. 281 * can require renewed exchanging of GNS entries.
282 * 282 *
283 * @param[in/out] handle Chat handle 283 * @param[in,out] handle Chat handle
284 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 284 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
285 */ 285 */
286int 286int
@@ -289,7 +289,7 @@ GNUNET_CHAT_update (struct GNUNET_CHAT_Handle *handle);
289/** 289/**
290 * Updates the name of a chat handle for related communication. 290 * Updates the name of a chat handle for related communication.
291 * 291 *
292 * @param[in/out] handle Chat handle 292 * @param[in,out] handle Chat handle
293 * @param[in] name New name or NULL 293 * @param[in] name New name or NULL
294 * @return #GNUNET_YES on success, #GNUNET_NO on failure and #GNUNET_SYSERR if <i>handle</i> is NULL 294 * @return #GNUNET_YES on success, #GNUNET_NO on failure and #GNUNET_SYSERR if <i>handle</i> is NULL
295 */ 295 */
@@ -320,9 +320,9 @@ GNUNET_CHAT_get_key (const struct GNUNET_CHAT_Handle *handle);
320 * Iterates through the contacts of a given chat <i>handle</i> with a selected 320 * Iterates through the contacts of a given chat <i>handle</i> with a selected
321 * callback and custom closure. 321 * callback and custom closure.
322 * 322 *
323 * @param[in/out] handle Chat handle 323 * @param[in,out] handle Chat handle
324 * @param[in] callback Callback for contact iteration (optional) 324 * @param[in] callback Callback for contact iteration (optional)
325 * @param[in/out] cls Closure for contact iteration (optional) 325 * @param[in,out] cls Closure for contact iteration (optional)
326 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 326 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
327 */ 327 */
328int 328int
@@ -339,7 +339,7 @@ GNUNET_CHAT_iterate_contacts (struct GNUNET_CHAT_Handle *handle,
339 * group will be private using a randomly generated key and others can only 339 * group will be private using a randomly generated key and others can only
340 * join the chat via a private invitation. 340 * join the chat via a private invitation.
341 * 341 *
342 * @param[in/out] handle Chat handle 342 * @param[in,out] handle Chat handle
343 * @return New group chat 343 * @return New group chat
344 */ 344 */
345struct GNUNET_CHAT_Group * 345struct GNUNET_CHAT_Group *
@@ -350,9 +350,9 @@ GNUNET_CHAT_group_create (struct GNUNET_CHAT_Handle *handle,
350 * Iterates through the groups of a given chat <i>handle</i> with a selected 350 * Iterates through the groups of a given chat <i>handle</i> with a selected
351 * callback and custom closure. 351 * callback and custom closure.
352 * 352 *
353 * @param[in/out] handle Chat handle 353 * @param[in,out] handle Chat handle
354 * @param[in] callback Callback for group iteration (optional) 354 * @param[in] callback Callback for group iteration (optional)
355 * @param[in/out] cls Closure for group iteration (optional) 355 * @param[in,out] cls Closure for group iteration (optional)
356 * @return Amount of groups iterated or #GNUNET_SYSERR on failure 356 * @return Amount of groups iterated or #GNUNET_SYSERR on failure
357 */ 357 */
358int 358int
@@ -364,7 +364,7 @@ GNUNET_CHAT_iterate_groups (struct GNUNET_CHAT_Handle *handle,
364 * Leaves the private chat with a specific <i>contact</i> and frees the 364 * Leaves the private chat with a specific <i>contact</i> and frees the
365 * regarding memory of the contact if there remains no common chat with it. 365 * regarding memory of the contact if there remains no common chat with it.
366 * 366 *
367 * @param[in/out] contact Cntact 367 * @param[in,out] contact Cntact
368 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 368 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
369 */ 369 */
370int 370int
@@ -374,7 +374,7 @@ GNUNET_CHAT_contact_delete (struct GNUNET_CHAT_Contact *contact);
374 * Overrides the name of a given <i>contact</i> with a custom nick <i>name</i> 374 * Overrides the name of a given <i>contact</i> with a custom nick <i>name</i>
375 * which will be only used locally. 375 * which will be only used locally.
376 * 376 *
377 * @param[in/out] contact Contact 377 * @param[in,out] contact Contact
378 * @param[in] name Custom nick name 378 * @param[in] name Custom nick name
379 */ 379 */
380void 380void
@@ -404,7 +404,7 @@ GNUNET_CHAT_contact_get_key (const struct GNUNET_CHAT_Contact *contact);
404/** 404/**
405 * Returns the chat context for a private chat with a given <i>contact</i>. 405 * Returns the chat context for a private chat with a given <i>contact</i>.
406 * 406 *
407 * @param[in/out] contact Contact 407 * @param[in,out] contact Contact
408 * @return Chat context 408 * @return Chat context
409 */ 409 */
410struct GNUNET_CHAT_Context* 410struct GNUNET_CHAT_Context*
@@ -414,7 +414,7 @@ GNUNET_CHAT_contact_get_context (struct GNUNET_CHAT_Contact *contact);
414 * Sets a custom <i>user pointer</i> to a given <i>contact</i> so it can be 414 * Sets a custom <i>user pointer</i> to a given <i>contact</i> so it can be
415 * accessed in contact related callbacks. 415 * accessed in contact related callbacks.
416 * 416 *
417 * @param[in/out] contact Contact 417 * @param[in,out] contact Contact
418 * @param[in] user_pointer Custom user pointer 418 * @param[in] user_pointer Custom user pointer
419 */ 419 */
420void 420void
@@ -435,7 +435,7 @@ GNUNET_CHAT_contact_get_user_pointer (const struct GNUNET_CHAT_Contact *contact)
435 * Leaves a specific <i>group</i> chat and frees its memory if it is not shared 435 * Leaves a specific <i>group</i> chat and frees its memory if it is not shared
436 * with other groups or contacts. 436 * with other groups or contacts.
437 * 437 *
438 * @param[in/out] group Group 438 * @param[in,out] group Group
439 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 439 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
440 */ 440 */
441int 441int
@@ -445,7 +445,7 @@ GNUNET_CHAT_group_leave (struct GNUNET_CHAT_Group *group);
445 * Sets the name of a given <i>group</i> to a custom nick <i>name</i> 445 * Sets the name of a given <i>group</i> to a custom nick <i>name</i>
446 * which will be only used locally. 446 * which will be only used locally.
447 * 447 *
448 * @param[in/out] group Group 448 * @param[in,out] group Group
449 * @param[in] name Custom nick name 449 * @param[in] name Custom nick name
450 */ 450 */
451void 451void
@@ -465,7 +465,7 @@ GNUNET_CHAT_group_get_name (const struct GNUNET_CHAT_Group *group);
465 * Sets a custom <i>user pointer</i> to a given <i>group</i> so it can be 465 * Sets a custom <i>user pointer</i> to a given <i>group</i> so it can be
466 * accessed in group related callbacks. 466 * accessed in group related callbacks.
467 * 467 *
468 * @param[in/out] group Group 468 * @param[in,out] group Group
469 * @param[in] user_pointer Custom user pointer 469 * @param[in] user_pointer Custom user pointer
470 */ 470 */
471void 471void
@@ -486,8 +486,8 @@ GNUNET_CHAT_group_get_user_pointer (const struct GNUNET_CHAT_Group *group);
486 * Invites a specific <i>contact</i> to a given <i>group</i> via a privately 486 * Invites a specific <i>contact</i> to a given <i>group</i> via a privately
487 * sent invitation. 487 * sent invitation.
488 * 488 *
489 * @param[in/out] group Group 489 * @param[in,out] group Group
490 * @param[in/out] contact Contact 490 * @param[in,out] contact Contact
491 */ 491 */
492void 492void
493GNUNET_CHAT_group_invite_contact (struct GNUNET_CHAT_Group *group, 493GNUNET_CHAT_group_invite_contact (struct GNUNET_CHAT_Group *group,
@@ -497,9 +497,9 @@ GNUNET_CHAT_group_invite_contact (struct GNUNET_CHAT_Group *group,
497 * Iterates through the contacts of a given <i>group</i> with a selected 497 * Iterates through the contacts of a given <i>group</i> with a selected
498 * callback and custom closure. 498 * callback and custom closure.
499 * 499 *
500 * @param[in/out] group Group 500 * @param[in,out] group Group
501 * @param[in] callback Callback for contact iteration (optional) 501 * @param[in] callback Callback for contact iteration (optional)
502 * @param[in/out] cls Closure for contact iteration (optional) 502 * @param[in,out] cls Closure for contact iteration (optional)
503 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 503 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
504 */ 504 */
505int 505int
@@ -510,7 +510,7 @@ GNUNET_CHAT_group_iterate_contacts (struct GNUNET_CHAT_Group *group,
510/** 510/**
511 * Returns the chat context for a chat with a given <i>group</i>. 511 * Returns the chat context for a chat with a given <i>group</i>.
512 * 512 *
513 * @param[in/out] group Group 513 * @param[in,out] group Group
514 * @return Chat context 514 * @return Chat context
515 */ 515 */
516struct GNUNET_CHAT_Context* 516struct GNUNET_CHAT_Context*
@@ -520,7 +520,7 @@ GNUNET_CHAT_group_get_context (struct GNUNET_CHAT_Group *group);
520 * Sets a custom <i>user pointer</i> to a given chat <i>context</i> so it can 520 * Sets a custom <i>user pointer</i> to a given chat <i>context</i> so it can
521 * be accessed in chat context related callbacks. 521 * be accessed in chat context related callbacks.
522 * 522 *
523 * @param[in/out] context Chat context 523 * @param[in,out] context Chat context
524 * @param[in] user_pointer Custom user pointer 524 * @param[in] user_pointer Custom user pointer
525 */ 525 */
526void 526void
@@ -540,7 +540,7 @@ GNUNET_CHAT_context_get_user_pointer (const struct GNUNET_CHAT_Context *context)
540/** 540/**
541 * Sends a selected <i>text</i> into a given chat <i>context</i>. 541 * Sends a selected <i>text</i> into a given chat <i>context</i>.
542 * 542 *
543 * @param[in/out] context Chat context 543 * @param[in,out] context Chat context
544 * @param[in] text Text 544 * @param[in] text Text
545 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 545 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
546 */ 546 */
@@ -553,10 +553,10 @@ GNUNET_CHAT_context_send_text (struct GNUNET_CHAT_Context *context,
553 * and shares the regarding information to download and decrypt it in a given 553 * and shares the regarding information to download and decrypt it in a given
554 * chat <i>context</i>. 554 * chat <i>context</i>.
555 * 555 *
556 * @param[in/out] context Chat context 556 * @param[in,out] context Chat context
557 * @param[in] path Local file path 557 * @param[in] path Local file path
558 * @param[in] callback Callback for file uploading (optional) 558 * @param[in] callback Callback for file uploading (optional)
559 * @param[in/out] cls Closure for file uploading (optional) 559 * @param[in,out] cls Closure for file uploading (optional)
560 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 560 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
561 */ 561 */
562int 562int
@@ -569,7 +569,7 @@ GNUNET_CHAT_context_send_file (struct GNUNET_CHAT_Context *context,
569 * Shares the information to download and decrypt a specific <i>file</i> from 569 * Shares the information to download and decrypt a specific <i>file</i> from
570 * another chat in a given chat <i>context</i>. 570 * another chat in a given chat <i>context</i>.
571 * 571 *
572 * @param[in/out] context Chat context 572 * @param[in,out] context Chat context
573 * @param[in] file File handle 573 * @param[in] file File handle
574 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 574 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
575 */ 575 */
@@ -581,9 +581,9 @@ GNUNET_CHAT_context_share_file (struct GNUNET_CHAT_Context *context,
581 * Iterates through the contacts of a given chat <i>context</i> with a selected 581 * Iterates through the contacts of a given chat <i>context</i> with a selected
582 * callback and custom closure. 582 * callback and custom closure.
583 * 583 *
584 * @param[in/out] context Chat context 584 * @param[in,out] context Chat context
585 * @param[in] callback Callback for contact iteration (optional) 585 * @param[in] callback Callback for contact iteration (optional)
586 * @param[in/out] cls Closure for contact iteration (optional) 586 * @param[in,out] cls Closure for contact iteration (optional)
587 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 587 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
588 */ 588 */
589int 589int
@@ -595,9 +595,9 @@ GNUNET_CHAT_context_iterate_messages (struct GNUNET_CHAT_Context *context,
595 * Iterates through the files of a given chat <i>context</i> with a selected 595 * Iterates through the files of a given chat <i>context</i> with a selected
596 * callback and custom closure. 596 * callback and custom closure.
597 * 597 *
598 * @param[in/out] context Chat context 598 * @param[in,out] context Chat context
599 * @param[in] callback Callback for file iteration (optional) 599 * @param[in] callback Callback for file iteration (optional)
600 * @param[in/out] cls Closure for file iteration (optional) 600 * @param[in,out] cls Closure for file iteration (optional)
601 * @return Amount of files iterated or #GNUNET_SYSERR on failure 601 * @return Amount of files iterated or #GNUNET_SYSERR on failure
602 */ 602 */
603int 603int
@@ -660,7 +660,7 @@ GNUNET_CHAT_message_is_private (const struct GNUNET_CHAT_Message *message);
660 * 660 *
661 * @param[in] message Message 661 * @param[in] message Message
662 * @param[in] callback Callback for contact iteration (optional) 662 * @param[in] callback Callback for contact iteration (optional)
663 * @param[in/out] cls Closure for contact iteration (optional) 663 * @param[in,out] cls Closure for contact iteration (optional)
664 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 664 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
665 */ 665 */
666int 666int
@@ -742,7 +742,7 @@ GNUNET_CHAT_file_is_local (const struct GNUNET_CHAT_File *file);
742 * Sets a custom <i>user pointer</i> to a given <i>file</i> handle so it can 742 * Sets a custom <i>user pointer</i> to a given <i>file</i> handle so it can
743 * be accessed in file related callbacks. 743 * be accessed in file related callbacks.
744 * 744 *
745 * @param[in/out] file File handle 745 * @param[in,out] file File handle
746 * @param[in] user_pointer Custom user pointer 746 * @param[in] user_pointer Custom user pointer
747 */ 747 */
748void 748void
@@ -763,9 +763,9 @@ GNUNET_CHAT_file_get_user_pointer (const struct GNUNET_CHAT_File *file);
763 * Starts downloading a file from a given <i>file</i> handle and sets up a 763 * Starts downloading a file from a given <i>file</i> handle and sets up a
764 * selected callback and custom closure for its progress. 764 * selected callback and custom closure for its progress.
765 * 765 *
766 * @param[in/out] file File handle 766 * @param[in,out] file File handle
767 * @param[in] callback Callback for file downloading (optional) 767 * @param[in] callback Callback for file downloading (optional)
768 * @param[in/out] cls Closure for file downloading (optional) 768 * @param[in,out] cls Closure for file downloading (optional)
769 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 769 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
770 */ 770 */
771int 771int
@@ -776,7 +776,7 @@ GNUNET_CHAT_file_start_download (struct GNUNET_CHAT_File *file,
776/** 776/**
777 * Pause downloading a file from a given <i>file</i> handle. 777 * Pause downloading a file from a given <i>file</i> handle.
778 * 778 *
779 * @param[in/out] file File handle 779 * @param[in,out] file File handle
780 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 780 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
781 */ 781 */
782int 782int
@@ -785,7 +785,7 @@ GNUNET_CHAT_file_pause_download (struct GNUNET_CHAT_File *file);
785/** 785/**
786 * Resume downloading a file from a given <i>file</i> handle. 786 * Resume downloading a file from a given <i>file</i> handle.
787 * 787 *
788 * @param[in/out] file File handle 788 * @param[in,out] file File handle
789 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 789 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
790 */ 790 */
791int 791int
@@ -794,7 +794,7 @@ GNUNET_CHAT_file_resume_download (struct GNUNET_CHAT_File *file);
794/** 794/**
795 * Stops downloading a file from a given <i>file</i> handle. 795 * Stops downloading a file from a given <i>file</i> handle.
796 * 796 *
797 * @param[in/out] file File handle 797 * @param[in,out] file File handle
798 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 798 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
799 */ 799 */
800int 800int
@@ -804,9 +804,9 @@ GNUNET_CHAT_file_stop_download (struct GNUNET_CHAT_File *file);
804 * Unindexes an uploaded file from a given <i>file</i> handle with a selected 804 * Unindexes an uploaded file from a given <i>file</i> handle with a selected
805 * callback and a custom closure. 805 * callback and a custom closure.
806 * 806 *
807 * @param[in/out] file File handle 807 * @param[in,out] file File handle
808 * @param[in] callback Callback for file unindexing (optional) 808 * @param[in] callback Callback for file unindexing (optional)
809 * @param[in/out] cls Closure for file unindexing (optional) 809 * @param[in,out] cls Closure for file unindexing (optional)
810 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 810 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
811 */ 811 */
812int 812int
@@ -817,7 +817,7 @@ GNUNET_CHAT_file_unindex (struct GNUNET_CHAT_File *file,
817/** 817/**
818 * Accepts a given chat <i>invitation</i> to enter another chat. 818 * Accepts a given chat <i>invitation</i> to enter another chat.
819 * 819 *
820 * @param[in/out] invitation Chat invitation 820 * @param[in,out] invitation Chat invitation
821 */ 821 */
822void 822void
823GNUNET_CHAT_invitation_accept (struct GNUNET_CHAT_Invitation *invitation); 823GNUNET_CHAT_invitation_accept (struct GNUNET_CHAT_Invitation *invitation);