diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-09-07 20:11:56 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-09-07 20:11:56 +0000 |
commit | 294d9ff5696c57f64f9e42109f387d28afbebb03 (patch) | |
tree | f466fff481cd13cdc9e9cfa9c7ea00d92cceaf5b /src/include/gnunet_fs_service.h | |
parent | cddc39a68ea310659449377c6ce12d0e0c38a739 (diff) | |
download | gnunet-294d9ff5696c57f64f9e42109f387d28afbebb03.tar.gz gnunet-294d9ff5696c57f64f9e42109f387d28afbebb03.zip |
-doxygen improvements
Diffstat (limited to 'src/include/gnunet_fs_service.h')
-rw-r--r-- | src/include/gnunet_fs_service.h | 191 |
1 files changed, 96 insertions, 95 deletions
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h index d60044732..407c5d296 100644 --- a/src/include/gnunet_fs_service.h +++ b/src/include/gnunet_fs_service.h | |||
@@ -813,7 +813,7 @@ struct GNUNET_FS_ProgressInfo | |||
813 | 813 | ||
814 | /** | 814 | /** |
815 | * These values are only valid for | 815 | * These values are only valid for |
816 | * GNUNET_FS_STATUS_PUBLISH_PROGRESS events. | 816 | * #GNUNET_FS_STATUS_PUBLISH_PROGRESS events. |
817 | */ | 817 | */ |
818 | struct | 818 | struct |
819 | { | 819 | { |
@@ -843,7 +843,7 @@ struct GNUNET_FS_ProgressInfo | |||
843 | 843 | ||
844 | /** | 844 | /** |
845 | * These values are only valid for | 845 | * These values are only valid for |
846 | * GNUNET_FS_STATUS_PUBLISH_RESUME events. | 846 | * #GNUNET_FS_STATUS_PUBLISH_RESUME events. |
847 | */ | 847 | */ |
848 | struct | 848 | struct |
849 | { | 849 | { |
@@ -862,7 +862,7 @@ struct GNUNET_FS_ProgressInfo | |||
862 | 862 | ||
863 | /** | 863 | /** |
864 | * These values are only valid for | 864 | * These values are only valid for |
865 | * GNUNET_FS_STATUS_PUBLISH_COMPLETED events. | 865 | * #GNUNET_FS_STATUS_PUBLISH_COMPLETED events. |
866 | */ | 866 | */ |
867 | struct | 867 | struct |
868 | { | 868 | { |
@@ -876,7 +876,7 @@ struct GNUNET_FS_ProgressInfo | |||
876 | 876 | ||
877 | /** | 877 | /** |
878 | * These values are only valid for | 878 | * These values are only valid for |
879 | * GNUNET_FS_STATUS_PUBLISH_ERROR events. | 879 | * #GNUNET_FS_STATUS_PUBLISH_ERROR events. |
880 | */ | 880 | */ |
881 | struct | 881 | struct |
882 | { | 882 | { |
@@ -977,7 +977,7 @@ struct GNUNET_FS_ProgressInfo | |||
977 | 977 | ||
978 | /** | 978 | /** |
979 | * These values are only valid for | 979 | * These values are only valid for |
980 | * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events. | 980 | * #GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events. |
981 | */ | 981 | */ |
982 | struct | 982 | struct |
983 | { | 983 | { |
@@ -1002,7 +1002,7 @@ struct GNUNET_FS_ProgressInfo | |||
1002 | 1002 | ||
1003 | /** | 1003 | /** |
1004 | * How much time passed between us asking for this block and | 1004 | * How much time passed between us asking for this block and |
1005 | * actually getting it? GNUNET_TIME_UNIT_FOREVER_REL if unknown. | 1005 | * actually getting it? #GNUNET_TIME_UNIT_FOREVER_REL if unknown. |
1006 | */ | 1006 | */ |
1007 | struct GNUNET_TIME_Relative block_download_duration; | 1007 | struct GNUNET_TIME_Relative block_download_duration; |
1008 | 1008 | ||
@@ -1032,7 +1032,7 @@ struct GNUNET_FS_ProgressInfo | |||
1032 | 1032 | ||
1033 | /** | 1033 | /** |
1034 | * These values are only valid for | 1034 | * These values are only valid for |
1035 | * GNUNET_FS_STATUS_DOWNLOAD_START events. | 1035 | * #GNUNET_FS_STATUS_DOWNLOAD_START events. |
1036 | */ | 1036 | */ |
1037 | struct | 1037 | struct |
1038 | { | 1038 | { |
@@ -1046,7 +1046,7 @@ struct GNUNET_FS_ProgressInfo | |||
1046 | 1046 | ||
1047 | /** | 1047 | /** |
1048 | * These values are only valid for | 1048 | * These values are only valid for |
1049 | * GNUNET_FS_STATUS_DOWNLOAD_RESUME events. | 1049 | * #GNUNET_FS_STATUS_DOWNLOAD_RESUME events. |
1050 | */ | 1050 | */ |
1051 | struct | 1051 | struct |
1052 | { | 1052 | { |
@@ -1065,7 +1065,7 @@ struct GNUNET_FS_ProgressInfo | |||
1065 | 1065 | ||
1066 | /** | 1066 | /** |
1067 | * These values are only valid for | 1067 | * These values are only valid for |
1068 | * GNUNET_FS_STATUS_DOWNLOAD_ERROR events. | 1068 | * #GNUNET_FS_STATUS_DOWNLOAD_ERROR events. |
1069 | */ | 1069 | */ |
1070 | struct | 1070 | struct |
1071 | { | 1071 | { |
@@ -1139,7 +1139,7 @@ struct GNUNET_FS_ProgressInfo | |||
1139 | 1139 | ||
1140 | /** | 1140 | /** |
1141 | * These values are only valid for | 1141 | * These values are only valid for |
1142 | * GNUNET_FS_STATUS_SEARCH_RESULT events. | 1142 | * #GNUNET_FS_STATUS_SEARCH_RESULT events. |
1143 | */ | 1143 | */ |
1144 | struct | 1144 | struct |
1145 | { | 1145 | { |
@@ -1169,7 +1169,7 @@ struct GNUNET_FS_ProgressInfo | |||
1169 | 1169 | ||
1170 | /** | 1170 | /** |
1171 | * These values are only valid for | 1171 | * These values are only valid for |
1172 | * GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events. | 1172 | * #GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events. |
1173 | */ | 1173 | */ |
1174 | struct | 1174 | struct |
1175 | { | 1175 | { |
@@ -1212,7 +1212,7 @@ struct GNUNET_FS_ProgressInfo | |||
1212 | 1212 | ||
1213 | /** | 1213 | /** |
1214 | * These values are only valid for | 1214 | * These values are only valid for |
1215 | * GNUNET_FS_STATUS_SEARCH_UPDATE events. | 1215 | * #GNUNET_FS_STATUS_SEARCH_UPDATE events. |
1216 | */ | 1216 | */ |
1217 | struct | 1217 | struct |
1218 | { | 1218 | { |
@@ -1261,10 +1261,10 @@ struct GNUNET_FS_ProgressInfo | |||
1261 | 1261 | ||
1262 | /** | 1262 | /** |
1263 | * These values are only valid for | 1263 | * These values are only valid for |
1264 | * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events. | 1264 | * #GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events. |
1265 | * These events are automatically triggered for | 1265 | * These events are automatically triggered for |
1266 | * each search result before the | 1266 | * each search result before the |
1267 | * GNUNET_FS_STATUS_SEARCH_SUSPEND event. This | 1267 | * #GNUNET_FS_STATUS_SEARCH_SUSPEND event. This |
1268 | * happens primarily to give the client a chance | 1268 | * happens primarily to give the client a chance |
1269 | * to clean up the "cctx" (if needed). | 1269 | * to clean up the "cctx" (if needed). |
1270 | */ | 1270 | */ |
@@ -1291,10 +1291,10 @@ struct GNUNET_FS_ProgressInfo | |||
1291 | 1291 | ||
1292 | /** | 1292 | /** |
1293 | * These values are only valid for | 1293 | * These values are only valid for |
1294 | * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events. | 1294 | * #GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events. |
1295 | * These events are automatically triggered for | 1295 | * These events are automatically triggered for |
1296 | * each search result before the | 1296 | * each search result before the |
1297 | * GNUNET_FS_STATUS_SEARCH_STOPPED event. This | 1297 | * #GNUNET_FS_STATUS_SEARCH_STOPPED event. This |
1298 | * happens primarily to give the client a chance | 1298 | * happens primarily to give the client a chance |
1299 | * to clean up the "cctx" (if needed). | 1299 | * to clean up the "cctx" (if needed). |
1300 | */ | 1300 | */ |
@@ -1321,7 +1321,7 @@ struct GNUNET_FS_ProgressInfo | |||
1321 | 1321 | ||
1322 | /** | 1322 | /** |
1323 | * These values are only valid for | 1323 | * These values are only valid for |
1324 | * GNUNET_FS_STATUS_SEARCH_RESUME events. | 1324 | * #GNUNET_FS_STATUS_SEARCH_RESUME events. |
1325 | */ | 1325 | */ |
1326 | struct | 1326 | struct |
1327 | { | 1327 | { |
@@ -1340,7 +1340,7 @@ struct GNUNET_FS_ProgressInfo | |||
1340 | 1340 | ||
1341 | /** | 1341 | /** |
1342 | * These values are only valid for | 1342 | * These values are only valid for |
1343 | * GNUNET_FS_STATUS_SEARCH_ERROR events. | 1343 | * #GNUNET_FS_STATUS_SEARCH_ERROR events. |
1344 | */ | 1344 | */ |
1345 | struct | 1345 | struct |
1346 | { | 1346 | { |
@@ -1353,7 +1353,7 @@ struct GNUNET_FS_ProgressInfo | |||
1353 | } error; | 1353 | } error; |
1354 | 1354 | ||
1355 | /** | 1355 | /** |
1356 | * Values for all "GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE" events. | 1356 | * Values for #GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE events. |
1357 | */ | 1357 | */ |
1358 | struct | 1358 | struct |
1359 | { | 1359 | { |
@@ -1438,7 +1438,7 @@ struct GNUNET_FS_ProgressInfo | |||
1438 | 1438 | ||
1439 | /** | 1439 | /** |
1440 | * These values are only valid for | 1440 | * These values are only valid for |
1441 | * GNUNET_FS_STATUS_UNINDEX_PROGRESS events. | 1441 | * #GNUNET_FS_STATUS_UNINDEX_PROGRESS events. |
1442 | */ | 1442 | */ |
1443 | struct | 1443 | struct |
1444 | { | 1444 | { |
@@ -1468,7 +1468,7 @@ struct GNUNET_FS_ProgressInfo | |||
1468 | 1468 | ||
1469 | /** | 1469 | /** |
1470 | * These values are only valid for | 1470 | * These values are only valid for |
1471 | * GNUNET_FS_STATUS_UNINDEX_RESUME events. | 1471 | * #GNUNET_FS_STATUS_UNINDEX_RESUME events. |
1472 | */ | 1472 | */ |
1473 | struct | 1473 | struct |
1474 | { | 1474 | { |
@@ -1482,7 +1482,7 @@ struct GNUNET_FS_ProgressInfo | |||
1482 | 1482 | ||
1483 | /** | 1483 | /** |
1484 | * These values are only valid for | 1484 | * These values are only valid for |
1485 | * GNUNET_FS_STATUS_UNINDEX_ERROR events. | 1485 | * #GNUNET_FS_STATUS_UNINDEX_ERROR events. |
1486 | */ | 1486 | */ |
1487 | struct | 1487 | struct |
1488 | { | 1488 | { |
@@ -1525,7 +1525,7 @@ struct GNUNET_FS_ProgressInfo | |||
1525 | * for this operation; should be set to NULL for | 1525 | * for this operation; should be set to NULL for |
1526 | * SUSPEND and STOPPED events). The value returned | 1526 | * SUSPEND and STOPPED events). The value returned |
1527 | * will be passed to future callbacks in the respective | 1527 | * will be passed to future callbacks in the respective |
1528 | * field in the GNUNET_FS_ProgressInfo struct. | 1528 | * field in the `struct GNUNET_FS_ProgressInfo`. |
1529 | */ | 1529 | */ |
1530 | typedef void *(*GNUNET_FS_ProgressCallback) (void *cls, | 1530 | typedef void *(*GNUNET_FS_ProgressCallback) (void *cls, |
1531 | const struct GNUNET_FS_ProgressInfo *info); | 1531 | const struct GNUNET_FS_ProgressInfo *info); |
@@ -1536,22 +1536,22 @@ typedef void *(*GNUNET_FS_ProgressCallback) (void *cls, | |||
1536 | */ | 1536 | */ |
1537 | enum GNUNET_FS_Flags | 1537 | enum GNUNET_FS_Flags |
1538 | { | 1538 | { |
1539 | /** | 1539 | /** |
1540 | * No special flags set. | 1540 | * No special flags set. |
1541 | */ | 1541 | */ |
1542 | GNUNET_FS_FLAGS_NONE = 0, | 1542 | GNUNET_FS_FLAGS_NONE = 0, |
1543 | 1543 | ||
1544 | /** | 1544 | /** |
1545 | * Is persistence of operations desired? | 1545 | * Is persistence of operations desired? |
1546 | * (will create SUSPEND/RESUME events). | 1546 | * (will create SUSPEND/RESUME events). |
1547 | */ | 1547 | */ |
1548 | GNUNET_FS_FLAGS_PERSISTENCE = 1, | 1548 | GNUNET_FS_FLAGS_PERSISTENCE = 1, |
1549 | 1549 | ||
1550 | /** | 1550 | /** |
1551 | * Should we automatically trigger probes for search results | 1551 | * Should we automatically trigger probes for search results |
1552 | * to determine availability? | 1552 | * to determine availability? |
1553 | * (will create GNUNET_FS_STATUS_SEARCH_UPDATE events). | 1553 | * (will create #GNUNET_FS_STATUS_SEARCH_UPDATE events). |
1554 | */ | 1554 | */ |
1555 | GNUNET_FS_FLAGS_DO_PROBES = 2 | 1555 | GNUNET_FS_FLAGS_DO_PROBES = 2 |
1556 | }; | 1556 | }; |
1557 | 1557 | ||
@@ -1668,9 +1668,9 @@ struct GNUNET_FS_Handle; | |||
1668 | * @param cfg configuration to use | 1668 | * @param cfg configuration to use |
1669 | * @param client_name unique identifier for this client | 1669 | * @param client_name unique identifier for this client |
1670 | * @param upcb function to call to notify about FS actions | 1670 | * @param upcb function to call to notify about FS actions |
1671 | * @param upcb_cls closure for upcb | 1671 | * @param upcb_cls closure for @a upcb |
1672 | * @param flags specific attributes for fs-operations | 1672 | * @param flags specific attributes for fs-operations |
1673 | * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END | 1673 | * @param ... list of optional options, terminated with #GNUNET_FS_OPTIONS_END |
1674 | * @return NULL on error | 1674 | * @return NULL on error |
1675 | */ | 1675 | */ |
1676 | struct GNUNET_FS_Handle * | 1676 | struct GNUNET_FS_Handle * |
@@ -1898,7 +1898,7 @@ GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h, | |||
1898 | * Test if a given entry represents a directory. | 1898 | * Test if a given entry represents a directory. |
1899 | * | 1899 | * |
1900 | * @param ent check if this FI represents a directory | 1900 | * @param ent check if this FI represents a directory |
1901 | * @return GNUNET_YES if so, GNUNET_NO if not | 1901 | * @return #GNUNET_YES if so, #GNUNET_NO if not |
1902 | */ | 1902 | */ |
1903 | int | 1903 | int |
1904 | GNUNET_FS_file_information_is_directory (const struct GNUNET_FS_FileInformation | 1904 | GNUNET_FS_file_information_is_directory (const struct GNUNET_FS_FileInformation |
@@ -1908,13 +1908,13 @@ GNUNET_FS_file_information_is_directory (const struct GNUNET_FS_FileInformation | |||
1908 | /** | 1908 | /** |
1909 | * Add an entry to a directory in a publish-structure. Clients | 1909 | * Add an entry to a directory in a publish-structure. Clients |
1910 | * should never modify publish structures that were passed to | 1910 | * should never modify publish structures that were passed to |
1911 | * "GNUNET_FS_publish_start" already. | 1911 | * #GNUNET_FS_publish_start already. |
1912 | * | 1912 | * |
1913 | * @param dir the directory | 1913 | * @param dir the directory |
1914 | * @param ent the entry to add; the entry must not have been | 1914 | * @param ent the entry to add; the entry must not have been |
1915 | * added to any other directory at this point and | 1915 | * added to any other directory at this point and |
1916 | * must not include "dir" in its structure | 1916 | * must not include @a dir in its structure |
1917 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 1917 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
1918 | */ | 1918 | */ |
1919 | int | 1919 | int |
1920 | GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir, | 1920 | GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir, |
@@ -1924,16 +1924,16 @@ GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir, | |||
1924 | /** | 1924 | /** |
1925 | * Inspect a file or directory in a publish-structure. Clients | 1925 | * Inspect a file or directory in a publish-structure. Clients |
1926 | * should never modify publish structures that were passed to | 1926 | * should never modify publish structures that were passed to |
1927 | * "GNUNET_FS_publish_start" already. When called on a directory, | 1927 | * #GNUNET_FS_publish_start already. When called on a directory, |
1928 | * this function will FIRST call "proc" with information about | 1928 | * this function will FIRST call @a proc with information about |
1929 | * the directory itself and then for each of the files in the | 1929 | * the directory itself and then for each of the files in the |
1930 | * directory (but not for files in subdirectories). When called | 1930 | * directory (but not for files in subdirectories). When called |
1931 | * on a file, "proc" will be called exactly once (with information | 1931 | * on a file, @a proc will be called exactly once (with information |
1932 | * about the specific file). | 1932 | * about the specific file). |
1933 | * | 1933 | * |
1934 | * @param dir the directory | 1934 | * @param dir the directory |
1935 | * @param proc function to call on each entry | 1935 | * @param proc function to call on each entry |
1936 | * @param proc_cls closure for proc | 1936 | * @param proc_cls closure for @a proc |
1937 | */ | 1937 | */ |
1938 | void | 1938 | void |
1939 | GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir, | 1939 | GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir, |
@@ -1943,13 +1943,13 @@ GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir, | |||
1943 | 1943 | ||
1944 | /** | 1944 | /** |
1945 | * Destroy publish-structure. Clients should never destroy publish | 1945 | * Destroy publish-structure. Clients should never destroy publish |
1946 | * structures that were passed to "GNUNET_FS_publish_start" already. | 1946 | * structures that were passed to #GNUNET_FS_publish_start already. |
1947 | * | 1947 | * |
1948 | * @param fi structure to destroy | 1948 | * @param fi structure to destroy |
1949 | * @param cleaner function to call on each entry in the structure | 1949 | * @param cleaner function to call on each entry in the structure |
1950 | * (useful to clean up client_info); can be NULL; return | 1950 | * (useful to clean up client_info); can be NULL; return |
1951 | * values are ignored | 1951 | * values are ignored |
1952 | * @param cleaner_cls closure for cleaner | 1952 | * @param cleaner_cls closure for @a cleaner |
1953 | */ | 1953 | */ |
1954 | void | 1954 | void |
1955 | GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi, | 1955 | GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi, |
@@ -1963,15 +1963,15 @@ GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi, | |||
1963 | */ | 1963 | */ |
1964 | enum GNUNET_FS_PublishOptions | 1964 | enum GNUNET_FS_PublishOptions |
1965 | { | 1965 | { |
1966 | /** | 1966 | /** |
1967 | * No options (use defaults for everything). | 1967 | * No options (use defaults for everything). |
1968 | */ | 1968 | */ |
1969 | GNUNET_FS_PUBLISH_OPTION_NONE = 0, | 1969 | GNUNET_FS_PUBLISH_OPTION_NONE = 0, |
1970 | 1970 | ||
1971 | /** | 1971 | /** |
1972 | * Simulate publishing. With this option, no data will be stored | 1972 | * Simulate publishing. With this option, no data will be stored |
1973 | * in the datastore. Useful for computing URIs from files. | 1973 | * in the datastore. Useful for computing URIs from files. |
1974 | */ | 1974 | */ |
1975 | GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1 | 1975 | GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1 |
1976 | }; | 1976 | }; |
1977 | 1977 | ||
@@ -2039,8 +2039,8 @@ struct GNUNET_FS_PublishKskContext; | |||
2039 | * @param bo block options | 2039 | * @param bo block options |
2040 | * @param options publication options | 2040 | * @param options publication options |
2041 | * @param cont continuation | 2041 | * @param cont continuation |
2042 | * @param cont_cls closure for cont | 2042 | * @param cont_cls closure for @a cont |
2043 | * @return NULL on error ('cont' will still be called) | 2043 | * @return NULL on error (@a cont will still be called) |
2044 | */ | 2044 | */ |
2045 | struct GNUNET_FS_PublishKskContext * | 2045 | struct GNUNET_FS_PublishKskContext * |
2046 | GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h, | 2046 | GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h, |
@@ -2079,13 +2079,14 @@ struct GNUNET_FS_PublishSksContext; | |||
2079 | * @param bo block options | 2079 | * @param bo block options |
2080 | * @param options publication options | 2080 | * @param options publication options |
2081 | * @param cont continuation | 2081 | * @param cont continuation |
2082 | * @param cont_cls closure for cont | 2082 | * @param cont_cls closure for @a cont |
2083 | * @return NULL on error ('cont' will still be called) | 2083 | * @return NULL on error (@a cont will still be called) |
2084 | */ | 2084 | */ |
2085 | struct GNUNET_FS_PublishSksContext * | 2085 | struct GNUNET_FS_PublishSksContext * |
2086 | GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h, | 2086 | GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h, |
2087 | const struct GNUNET_CRYPTO_EccPrivateKey *ns, | 2087 | const struct GNUNET_CRYPTO_EccPrivateKey *ns, |
2088 | const char *identifier, const char *update, | 2088 | const char *identifier, |
2089 | const char *update, | ||
2089 | const struct GNUNET_CONTAINER_MetaData *meta, | 2090 | const struct GNUNET_CONTAINER_MetaData *meta, |
2090 | const struct GNUNET_FS_Uri *uri, | 2091 | const struct GNUNET_FS_Uri *uri, |
2091 | const struct GNUNET_FS_BlockOptions *bo, | 2092 | const struct GNUNET_FS_BlockOptions *bo, |
@@ -2103,12 +2104,12 @@ GNUNET_FS_publish_sks_cancel (struct GNUNET_FS_PublishSksContext *psc); | |||
2103 | 2104 | ||
2104 | 2105 | ||
2105 | /** | 2106 | /** |
2106 | * Type of a function called by "GNUNET_FS_get_indexed_files". | 2107 | * Type of a function called by #GNUNET_FS_get_indexed_files. |
2107 | * | 2108 | * |
2108 | * @param cls closure | 2109 | * @param cls closure |
2109 | * @param filename the name of the file, NULL for end of list | 2110 | * @param filename the name of the file, NULL for end of list |
2110 | * @param file_id hash of the contents of the indexed file | 2111 | * @param file_id hash of the contents of the indexed file |
2111 | * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort | 2112 | * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort |
2112 | */ | 2113 | */ |
2113 | typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls, const char *filename, | 2114 | typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls, const char *filename, |
2114 | const struct GNUNET_HashCode * file_id); | 2115 | const struct GNUNET_HashCode * file_id); |
@@ -2125,7 +2126,7 @@ struct GNUNET_FS_GetIndexedContext; | |||
2125 | * | 2126 | * |
2126 | * @param h handle to the file sharing subsystem | 2127 | * @param h handle to the file sharing subsystem |
2127 | * @param iterator function to call on each indexed file | 2128 | * @param iterator function to call on each indexed file |
2128 | * @param iterator_cls closure for iterator | 2129 | * @param iterator_cls closure for @a iterator |
2129 | * @return NULL on error ('iter' is not called) | 2130 | * @return NULL on error ('iter' is not called) |
2130 | */ | 2131 | */ |
2131 | struct GNUNET_FS_GetIndexedContext * | 2132 | struct GNUNET_FS_GetIndexedContext * |
@@ -2152,7 +2153,8 @@ GNUNET_FS_get_indexed_files_cancel (struct GNUNET_FS_GetIndexedContext *gic); | |||
2152 | * @return NULL on error, otherwise handle | 2153 | * @return NULL on error, otherwise handle |
2153 | */ | 2154 | */ |
2154 | struct GNUNET_FS_UnindexContext * | 2155 | struct GNUNET_FS_UnindexContext * |
2155 | GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h, const char *filename, | 2156 | GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h, |
2157 | const char *filename, | ||
2156 | void *cctx); | 2158 | void *cctx); |
2157 | 2159 | ||
2158 | 2160 | ||
@@ -2174,12 +2176,11 @@ GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc); | |||
2174 | * @param last_meta metadata associated with last_uri | 2176 | * @param last_meta metadata associated with last_uri |
2175 | * @param next_id identifier that should be used for updates | 2177 | * @param next_id identifier that should be used for updates |
2176 | */ | 2178 | */ |
2177 | typedef void (*GNUNET_FS_IdentifierProcessor) (void *cls, const char *last_id, | 2179 | typedef void (*GNUNET_FS_IdentifierProcessor) (void *cls, |
2178 | const struct GNUNET_FS_Uri * | 2180 | const char *last_id, |
2179 | last_uri, | 2181 | const struct GNUNET_FS_Uri *last_uri, |
2180 | const struct | 2182 | const struct GNUNET_CONTAINER_MetaData *last_meta, |
2181 | GNUNET_CONTAINER_MetaData * | 2183 | const char *next_id); |
2182 | last_meta, const char *next_id); | ||
2183 | 2184 | ||
2184 | 2185 | ||
2185 | /** | 2186 | /** |
@@ -2188,20 +2189,20 @@ typedef void (*GNUNET_FS_IdentifierProcessor) (void *cls, const char *last_id, | |||
2188 | * has a name. Each node can have any number of URI/meta-data entries | 2189 | * has a name. Each node can have any number of URI/meta-data entries |
2189 | * which can each be linked to other nodes. Cycles are possible. | 2190 | * which can each be linked to other nodes. Cycles are possible. |
2190 | * | 2191 | * |
2191 | * Calling this function with "next_id" NULL will cause the library to | 2192 | * Calling this function with @a next_id NULL will cause the library to |
2192 | * call "ip" with a root for each strongly connected component of the | 2193 | * call @a ip with a root for each strongly connected component of the |
2193 | * graph (a root being a node from which all other nodes in the Scc | 2194 | * graph (a root being a node from which all other nodes in the Scc |
2194 | * are reachable). | 2195 | * are reachable). |
2195 | * | 2196 | * |
2196 | * Calling this function with "next_id" being the name of a node will | 2197 | * Calling this function with @a next_id being the name of a node will |
2197 | * cause the library to call "ip" with all children of the node. Note | 2198 | * cause the library to call @a ip with all children of the node. Note |
2198 | * that cycles within an SCC are possible (including self-loops). | 2199 | * that cycles within an SCC are possible (including self-loops). |
2199 | * | 2200 | * |
2200 | * @param h fs handle to use | 2201 | * @param h fs handle to use |
2201 | * @param ns namespace to inspect for updateable content | 2202 | * @param ns namespace to inspect for updateable content |
2202 | * @param next_id ID to look for; use NULL to look for SCC roots | 2203 | * @param next_id ID to look for; use NULL to look for SCC roots |
2203 | * @param ip function to call on each updateable identifier | 2204 | * @param ip function to call on each updateable identifier |
2204 | * @param ip_cls closure for ip | 2205 | * @param ip_cls closure for @a ip |
2205 | */ | 2206 | */ |
2206 | void | 2207 | void |
2207 | GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Handle *h, | 2208 | GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Handle *h, |
@@ -2293,7 +2294,7 @@ GNUNET_FS_probe (struct GNUNET_FS_Handle *h, | |||
2293 | 2294 | ||
2294 | /** | 2295 | /** |
2295 | * Stop probe activity. Must ONLY be used on values | 2296 | * Stop probe activity. Must ONLY be used on values |
2296 | * returned from 'GNUNET_FS_probe'. | 2297 | * returned from #GNUNET_FS_probe. |
2297 | * | 2298 | * |
2298 | * @param sr search result to stop probing for (freed) | 2299 | * @param sr search result to stop probing for (freed) |
2299 | * @return the value of the 'client_info' pointer | 2300 | * @return the value of the 'client_info' pointer |
@@ -2348,7 +2349,7 @@ enum GNUNET_FS_DownloadOptions | |||
2348 | * download is still using the blocking of the underlying FS | 2349 | * download is still using the blocking of the underlying FS |
2349 | * encoding. As a result, the download may *write* outside of the | 2350 | * encoding. As a result, the download may *write* outside of the |
2350 | * given boundaries (if offset and length do not match the 32k FS | 2351 | * given boundaries (if offset and length do not match the 32k FS |
2351 | * block boundaries). <p> | 2352 | * block boundaries). |
2352 | * | 2353 | * |
2353 | * The given range can be used to focus a download towards a | 2354 | * The given range can be used to focus a download towards a |
2354 | * particular portion of the file (optimization), not to strictly | 2355 | * particular portion of the file (optimization), not to strictly |
@@ -2394,7 +2395,7 @@ GNUNET_FS_download_start (struct GNUNET_FS_Handle *h, | |||
2394 | * download is still using the blocking of the underlying FS | 2395 | * download is still using the blocking of the underlying FS |
2395 | * encoding. As a result, the download may *write* outside of the | 2396 | * encoding. As a result, the download may *write* outside of the |
2396 | * given boundaries (if offset and length do not match the 32k FS | 2397 | * given boundaries (if offset and length do not match the 32k FS |
2397 | * block boundaries). <p> | 2398 | * block boundaries). |
2398 | * | 2399 | * |
2399 | * The given range can be used to focus a download towards a | 2400 | * The given range can be used to focus a download towards a |
2400 | * particular portion of the file (optimization), not to strictly | 2401 | * particular portion of the file (optimization), not to strictly |
@@ -2448,8 +2449,8 @@ GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc, int do_delete); | |||
2448 | * Does the meta-data claim that this is a directory? | 2449 | * Does the meta-data claim that this is a directory? |
2449 | * Checks if the mime-type is that of a GNUnet directory. | 2450 | * Checks if the mime-type is that of a GNUnet directory. |
2450 | * | 2451 | * |
2451 | * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if | 2452 | * @return #GNUNET_YES if it is, #GNUNET_NO if it is not, #GNUNET_SYSERR if |
2452 | * we have no mime-type information (treat as 'GNUNET_NO') | 2453 | * we have no mime-type information (treat as #GNUNET_NO) |
2453 | */ | 2454 | */ |
2454 | int | 2455 | int |
2455 | GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData | 2456 | GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData |
@@ -2473,8 +2474,7 @@ GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md); | |||
2473 | * @return NULL if meta data is useless for suggesting a filename | 2474 | * @return NULL if meta data is useless for suggesting a filename |
2474 | */ | 2475 | */ |
2475 | char * | 2476 | char * |
2476 | GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData | 2477 | GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md); |
2477 | *md); | ||
2478 | 2478 | ||
2479 | 2479 | ||
2480 | /** | 2480 | /** |
@@ -2516,10 +2516,10 @@ typedef void (*GNUNET_FS_DirectoryEntryProcessor) (void *cls, | |||
2516 | * @param data pointer to the beginning of the directory | 2516 | * @param data pointer to the beginning of the directory |
2517 | * @param offset offset of data in the directory | 2517 | * @param offset offset of data in the directory |
2518 | * @param dep function to call on each entry | 2518 | * @param dep function to call on each entry |
2519 | * @param dep_cls closure for dep | 2519 | * @param dep_cls closure for @a dep |
2520 | * @return GNUNET_OK if this could be a block in a directory, | 2520 | * @return #GNUNET_OK if this could be a block in a directory, |
2521 | * GNUNET_NO if this could be part of a directory (but not 100% OK) | 2521 | * #GNUNET_NO if this could be part of a directory (but not 100% OK) |
2522 | * GNUNET_SYSERR if 'data' does not represent a directory | 2522 | * #GNUNET_SYSERR if 'data' does not represent a directory |
2523 | */ | 2523 | */ |
2524 | int | 2524 | int |
2525 | GNUNET_FS_directory_list_contents (size_t size, const void *data, | 2525 | GNUNET_FS_directory_list_contents (size_t size, const void *data, |
@@ -2533,6 +2533,7 @@ GNUNET_FS_directory_list_contents (size_t size, const void *data, | |||
2533 | */ | 2533 | */ |
2534 | struct GNUNET_FS_DirectoryBuilder; | 2534 | struct GNUNET_FS_DirectoryBuilder; |
2535 | 2535 | ||
2536 | |||
2536 | /** | 2537 | /** |
2537 | * Create a directory builder. | 2538 | * Create a directory builder. |
2538 | * | 2539 | * |
@@ -2568,7 +2569,7 @@ GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld, | |||
2568 | * @param bld directory to finish | 2569 | * @param bld directory to finish |
2569 | * @param rsize set to the number of bytes needed | 2570 | * @param rsize set to the number of bytes needed |
2570 | * @param rdata set to the encoded directory | 2571 | * @param rdata set to the encoded directory |
2571 | * @return GNUNET_OK on success | 2572 | * @return #GNUNET_OK on success |
2572 | */ | 2573 | */ |
2573 | int | 2574 | int |
2574 | GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld, | 2575 | GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld, |
@@ -2624,9 +2625,9 @@ enum GNUNET_FS_DirScannerProgressUpdateReason | |||
2624 | * | 2625 | * |
2625 | * @param cls closure | 2626 | * @param cls closure |
2626 | * @param filename which file we are making progress on | 2627 | * @param filename which file we are making progress on |
2627 | * @param is_directory GNUNET_YES if this is a directory, | 2628 | * @param is_directory #GNUNET_YES if this is a directory, |
2628 | * GNUNET_NO if this is a file | 2629 | * #GNUNET_NO if this is a file |
2629 | * GNUNET_SYSERR if it is neither (or unknown) | 2630 | * #GNUNET_SYSERR if it is neither (or unknown) |
2630 | * @param reason kind of progress we are making | 2631 | * @param reason kind of progress we are making |
2631 | */ | 2632 | */ |
2632 | typedef void (*GNUNET_FS_DirScannerProgressCallback) (void *cls, | 2633 | typedef void (*GNUNET_FS_DirScannerProgressCallback) (void *cls, |
@@ -2689,7 +2690,7 @@ struct GNUNET_FS_ShareTreeItem | |||
2689 | char *short_filename; | 2690 | char *short_filename; |
2690 | 2691 | ||
2691 | /** | 2692 | /** |
2692 | * GNUNET_YES if this is a directory | 2693 | * #GNUNET_YES if this is a directory |
2693 | */ | 2694 | */ |
2694 | int is_directory; | 2695 | int is_directory; |
2695 | 2696 | ||
@@ -2706,10 +2707,10 @@ struct GNUNET_FS_DirScanner; | |||
2706 | * Start a directory scanner. | 2707 | * Start a directory scanner. |
2707 | * | 2708 | * |
2708 | * @param filename name of the directory to scan | 2709 | * @param filename name of the directory to scan |
2709 | * @param disable_extractor GNUNET_YES to not to run libextractor on files (only build a tree) | 2710 | * @param disable_extractor #GNUNET_YES to not to run libextractor on files (only build a tree) |
2710 | * @param ex if not NULL, must be a list of extra plugins for extractor | 2711 | * @param ex if not NULL, must be a list of extra plugins for extractor |
2711 | * @param cb the callback to call when there are scanning progress messages | 2712 | * @param cb the callback to call when there are scanning progress messages |
2712 | * @param cb_cls closure for 'cb' | 2713 | * @param cb_cls closure for @a cb |
2713 | * @return directory scanner object to be used for controlling the scanner | 2714 | * @return directory scanner object to be used for controlling the scanner |
2714 | */ | 2715 | */ |
2715 | struct GNUNET_FS_DirScanner * | 2716 | struct GNUNET_FS_DirScanner * |
@@ -2721,7 +2722,7 @@ GNUNET_FS_directory_scan_start (const char *filename, | |||
2721 | 2722 | ||
2722 | 2723 | ||
2723 | /** | 2724 | /** |
2724 | * Abort the scan. Must not be called from within the progress_callback | 2725 | * Abort the scan. Must not be called from within the progress_callback |
2725 | * function. | 2726 | * function. |
2726 | * | 2727 | * |
2727 | * @param ds directory scanner structure | 2728 | * @param ds directory scanner structure |
@@ -2732,7 +2733,7 @@ GNUNET_FS_directory_scan_abort (struct GNUNET_FS_DirScanner *ds); | |||
2732 | 2733 | ||
2733 | /** | 2734 | /** |
2734 | * Obtain the result of the scan after the scan has signalled | 2735 | * Obtain the result of the scan after the scan has signalled |
2735 | * completion. Must not be called prior to completion. The 'ds' is | 2736 | * completion. Must not be called prior to completion. The @a ds is |
2736 | * freed as part of this call. | 2737 | * freed as part of this call. |
2737 | * | 2738 | * |
2738 | * @param ds directory scanner structure | 2739 | * @param ds directory scanner structure |