diff options
Diffstat (limited to 'src/fs/fs.c')
-rw-r--r-- | src/fs/fs.c | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/src/fs/fs.c b/src/fs/fs.c index fc1388a04..93971075a 100644 --- a/src/fs/fs.c +++ b/src/fs/fs.c | |||
@@ -213,7 +213,7 @@ GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf, | |||
213 | 213 | ||
214 | /** | 214 | /** |
215 | * Destroy a top-level activity entry. | 215 | * Destroy a top-level activity entry. |
216 | * | 216 | * |
217 | * @param h global fs handle | 217 | * @param h global fs handle |
218 | * @param top top level activity entry | 218 | * @param top top level activity entry |
219 | */ | 219 | */ |
@@ -250,7 +250,7 @@ struct FileInfo | |||
250 | * @param offset offset to read from; it is possible | 250 | * @param offset offset to read from; it is possible |
251 | * that the caller might need to go backwards | 251 | * that the caller might need to go backwards |
252 | * a bit at times | 252 | * a bit at times |
253 | * @param max maximum number of bytes that should be | 253 | * @param max maximum number of bytes that should be |
254 | * copied to buf; readers are not allowed | 254 | * copied to buf; readers are not allowed |
255 | * to provide less data unless there is an error; | 255 | * to provide less data unless there is an error; |
256 | * a value of "0" will be used at the end to allow | 256 | * a value of "0" will be used at the end to allow |
@@ -333,7 +333,7 @@ GNUNET_FS_make_file_reader_context_ (const char *filename) | |||
333 | * @param offset offset to read from; it is possible | 333 | * @param offset offset to read from; it is possible |
334 | * that the caller might need to go backwards | 334 | * that the caller might need to go backwards |
335 | * a bit at times | 335 | * a bit at times |
336 | * @param max maximum number of bytes that should be | 336 | * @param max maximum number of bytes that should be |
337 | * copied to buf; readers are not allowed | 337 | * copied to buf; readers are not allowed |
338 | * to provide less data unless there is an error; | 338 | * to provide less data unless there is an error; |
339 | * a value of "0" will be used at the end to allow | 339 | * a value of "0" will be used at the end to allow |
@@ -363,7 +363,7 @@ GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf, | |||
363 | * (for serialization/deserialization). | 363 | * (for serialization/deserialization). |
364 | * | 364 | * |
365 | * @param h master context | 365 | * @param h master context |
366 | * @param ext component of the path | 366 | * @param ext component of the path |
367 | * @param ent entity identifier (or emtpy string for the directory) | 367 | * @param ent entity identifier (or emtpy string for the directory) |
368 | * @return NULL on error | 368 | * @return NULL on error |
369 | */ | 369 | */ |
@@ -394,7 +394,7 @@ get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext, | |||
394 | * parent operation. | 394 | * parent operation. |
395 | * | 395 | * |
396 | * @param h master context | 396 | * @param h master context |
397 | * @param ext component of the path | 397 | * @param ext component of the path |
398 | * @param uni name of the parent operation | 398 | * @param uni name of the parent operation |
399 | * @param ent entity identifier (or emtpy string for the directory) | 399 | * @param ent entity identifier (or emtpy string for the directory) |
400 | * @return NULL on error | 400 | * @return NULL on error |
@@ -424,7 +424,7 @@ get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext, | |||
424 | * Return a read handle for deserialization. | 424 | * Return a read handle for deserialization. |
425 | * | 425 | * |
426 | * @param h master context | 426 | * @param h master context |
427 | * @param ext component of the path | 427 | * @param ext component of the path |
428 | * @param ent entity identifier (or emtpy string for the directory) | 428 | * @param ent entity identifier (or emtpy string for the directory) |
429 | * @return NULL on error | 429 | * @return NULL on error |
430 | */ | 430 | */ |
@@ -447,7 +447,7 @@ get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent) | |||
447 | * Return a write handle for serialization. | 447 | * Return a write handle for serialization. |
448 | * | 448 | * |
449 | * @param h master context | 449 | * @param h master context |
450 | * @param ext component of the path | 450 | * @param ext component of the path |
451 | * @param ent entity identifier (or emtpy string for the directory) | 451 | * @param ent entity identifier (or emtpy string for the directory) |
452 | * @return NULL on error | 452 | * @return NULL on error |
453 | */ | 453 | */ |
@@ -474,7 +474,7 @@ get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent) | |||
474 | * Return a write handle for serialization. | 474 | * Return a write handle for serialization. |
475 | * | 475 | * |
476 | * @param h master context | 476 | * @param h master context |
477 | * @param ext component of the path | 477 | * @param ext component of the path |
478 | * @param uni name of parent | 478 | * @param uni name of parent |
479 | * @param ent entity identifier (or emtpy string for the directory) | 479 | * @param ent entity identifier (or emtpy string for the directory) |
480 | * @return NULL on error | 480 | * @return NULL on error |
@@ -499,8 +499,8 @@ get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext, | |||
499 | * Remove serialization/deserialization file from disk. | 499 | * Remove serialization/deserialization file from disk. |
500 | * | 500 | * |
501 | * @param h master context | 501 | * @param h master context |
502 | * @param ext component of the path | 502 | * @param ext component of the path |
503 | * @param ent entity identifier | 503 | * @param ent entity identifier |
504 | */ | 504 | */ |
505 | void | 505 | void |
506 | GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext, | 506 | GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext, |
@@ -527,9 +527,9 @@ GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext, | |||
527 | * Remove serialization/deserialization file from disk. | 527 | * Remove serialization/deserialization file from disk. |
528 | * | 528 | * |
529 | * @param h master context | 529 | * @param h master context |
530 | * @param ext component of the path | 530 | * @param ext component of the path |
531 | * @param uni parent name | 531 | * @param uni parent name |
532 | * @param ent entity identifier | 532 | * @param ent entity identifier |
533 | */ | 533 | */ |
534 | static void | 534 | static void |
535 | remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext, | 535 | remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext, |
@@ -556,8 +556,8 @@ remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext, | |||
556 | * Remove serialization/deserialization directory from disk. | 556 | * Remove serialization/deserialization directory from disk. |
557 | * | 557 | * |
558 | * @param h master context | 558 | * @param h master context |
559 | * @param ext component of the path | 559 | * @param ext component of the path |
560 | * @param uni unique name of parent | 560 | * @param uni unique name of parent |
561 | */ | 561 | */ |
562 | void | 562 | void |
563 | GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext, | 563 | GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext, |
@@ -891,7 +891,7 @@ deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename) | |||
891 | * Given a serialization name (full absolute path), return the | 891 | * Given a serialization name (full absolute path), return the |
892 | * basename of the file (without the path), which must only | 892 | * basename of the file (without the path), which must only |
893 | * consist of the 6 random characters. | 893 | * consist of the 6 random characters. |
894 | * | 894 | * |
895 | * @param fullname name to extract the basename from | 895 | * @param fullname name to extract the basename from |
896 | * @return copy of the basename, NULL on error | 896 | * @return copy of the basename, NULL on error |
897 | */ | 897 | */ |
@@ -926,7 +926,7 @@ get_serialization_short_name (const char *fullname) | |||
926 | * is enabled and returns NULL if not. | 926 | * is enabled and returns NULL if not. |
927 | * | 927 | * |
928 | * @param h master context | 928 | * @param h master context |
929 | * @param ext component of the path | 929 | * @param ext component of the path |
930 | * @return NULL on errror | 930 | * @return NULL on errror |
931 | */ | 931 | */ |
932 | static char * | 932 | static char * |
@@ -961,7 +961,7 @@ make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext) | |||
961 | * is enabled and returns NULL if not. | 961 | * is enabled and returns NULL if not. |
962 | * | 962 | * |
963 | * @param h master context | 963 | * @param h master context |
964 | * @param ext component of the path | 964 | * @param ext component of the path |
965 | * @param uni name of parent | 965 | * @param uni name of parent |
966 | * @return NULL on errror | 966 | * @return NULL on errror |
967 | */ | 967 | */ |
@@ -1396,7 +1396,7 @@ cleanup: | |||
1396 | * on disk. Note that all internal FS-operations that change | 1396 | * on disk. Note that all internal FS-operations that change |
1397 | * publishing structs should already call "sync" internally, | 1397 | * publishing structs should already call "sync" internally, |
1398 | * so this function is likely not useful for clients. | 1398 | * so this function is likely not useful for clients. |
1399 | * | 1399 | * |
1400 | * @param pc the struct to sync | 1400 | * @param pc the struct to sync |
1401 | */ | 1401 | */ |
1402 | void | 1402 | void |
@@ -1463,7 +1463,7 @@ cleanup: | |||
1463 | * on disk. Note that all internal FS-operations that change | 1463 | * on disk. Note that all internal FS-operations that change |
1464 | * publishing structs should already call "sync" internally, | 1464 | * publishing structs should already call "sync" internally, |
1465 | * so this function is likely not useful for clients. | 1465 | * so this function is likely not useful for clients. |
1466 | * | 1466 | * |
1467 | * @param uc the struct to sync | 1467 | * @param uc the struct to sync |
1468 | */ | 1468 | */ |
1469 | void | 1469 | void |
@@ -1516,7 +1516,7 @@ cleanup: | |||
1516 | 1516 | ||
1517 | /** | 1517 | /** |
1518 | * Serialize a download request. | 1518 | * Serialize a download request. |
1519 | * | 1519 | * |
1520 | * @param wh the 'struct GNUNET_BIO_WriteHandle*' | 1520 | * @param wh the 'struct GNUNET_BIO_WriteHandle*' |
1521 | * @param dr the 'struct DownloadRequest' | 1521 | * @param dr the 'struct DownloadRequest' |
1522 | * @return GNUNET_YES on success, GNUNET_NO on error | 1522 | * @return GNUNET_YES on success, GNUNET_NO on error |
@@ -1545,7 +1545,7 @@ write_download_request (struct GNUNET_BIO_WriteHandle *wh, | |||
1545 | 1545 | ||
1546 | /** | 1546 | /** |
1547 | * Read a download request tree. | 1547 | * Read a download request tree. |
1548 | * | 1548 | * |
1549 | * @param rh stream to read from | 1549 | * @param rh stream to read from |
1550 | * @return value the 'struct DownloadRequest', NULL on error | 1550 | * @return value the 'struct DownloadRequest', NULL on error |
1551 | */ | 1551 | */ |
@@ -1646,7 +1646,7 @@ get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc, | |||
1646 | * on disk. Note that all internal FS-operations that change | 1646 | * on disk. Note that all internal FS-operations that change |
1647 | * publishing structs should already call "sync" internally, | 1647 | * publishing structs should already call "sync" internally, |
1648 | * so this function is likely not useful for clients. | 1648 | * so this function is likely not useful for clients. |
1649 | * | 1649 | * |
1650 | * @param dc the struct to sync | 1650 | * @param dc the struct to sync |
1651 | */ | 1651 | */ |
1652 | void | 1652 | void |
@@ -1748,7 +1748,7 @@ cleanup: | |||
1748 | * on disk. Note that all internal FS-operations that change | 1748 | * on disk. Note that all internal FS-operations that change |
1749 | * publishing structs should already call "sync" internally, | 1749 | * publishing structs should already call "sync" internally, |
1750 | * so this function is likely not useful for clients. | 1750 | * so this function is likely not useful for clients. |
1751 | * | 1751 | * |
1752 | * @param sr the struct to sync | 1752 | * @param sr the struct to sync |
1753 | */ | 1753 | */ |
1754 | void | 1754 | void |
@@ -1825,7 +1825,7 @@ cleanup: | |||
1825 | * on disk. Note that all internal FS-operations that change | 1825 | * on disk. Note that all internal FS-operations that change |
1826 | * publishing structs should already call "sync" internally, | 1826 | * publishing structs should already call "sync" internally, |
1827 | * so this function is likely not useful for clients. | 1827 | * so this function is likely not useful for clients. |
1828 | * | 1828 | * |
1829 | * @param sc the struct to sync | 1829 | * @param sc the struct to sync |
1830 | */ | 1830 | */ |
1831 | void | 1831 | void |
@@ -2022,7 +2022,7 @@ deserialize_download (struct GNUNET_FS_Handle *h, | |||
2022 | 2022 | ||
2023 | 2023 | ||
2024 | /** | 2024 | /** |
2025 | * Deserialize a search. | 2025 | * Deserialize a search. |
2026 | * | 2026 | * |
2027 | * @param h overall context | 2027 | * @param h overall context |
2028 | * @param rh file to deserialize from | 2028 | * @param rh file to deserialize from |
@@ -2165,7 +2165,7 @@ cleanup: | |||
2165 | * resume the download (put it in the queue). Does this | 2165 | * resume the download (put it in the queue). Does this |
2166 | * recursively for the top-level download and all child | 2166 | * recursively for the top-level download and all child |
2167 | * downloads. | 2167 | * downloads. |
2168 | * | 2168 | * |
2169 | * @param dc download to resume | 2169 | * @param dc download to resume |
2170 | */ | 2170 | */ |
2171 | static void | 2171 | static void |
@@ -2511,7 +2511,7 @@ signal_search_resume (struct GNUNET_FS_SearchContext *sc) | |||
2511 | 2511 | ||
2512 | 2512 | ||
2513 | /** | 2513 | /** |
2514 | * Deserialize a search. | 2514 | * Deserialize a search. |
2515 | * | 2515 | * |
2516 | * @param h overall context | 2516 | * @param h overall context |
2517 | * @param rh file to deserialize from | 2517 | * @param rh file to deserialize from |
@@ -2700,7 +2700,7 @@ deserialization_master (const char *master_path, GNUNET_FileNameCallback proc, | |||
2700 | * Setup a connection to the file-sharing service. | 2700 | * Setup a connection to the file-sharing service. |
2701 | * | 2701 | * |
2702 | * @param cfg configuration to use | 2702 | * @param cfg configuration to use |
2703 | * @param client_name unique identifier for this client | 2703 | * @param client_name unique identifier for this client |
2704 | * @param upcb function to call to notify about FS actions | 2704 | * @param upcb function to call to notify about FS actions |
2705 | * @param upcb_cls closure for upcb | 2705 | * @param upcb_cls closure for upcb |
2706 | * @param flags specific attributes for fs-operations | 2706 | * @param flags specific attributes for fs-operations |