diff options
author | Christian Grothoff <christian@grothoff.org> | 2011-06-13 19:21:39 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2011-06-13 19:21:39 +0000 |
commit | 18db9a2fc6584fe35b327650534cf0672f4686e7 (patch) | |
tree | 8ad5dcec557b5470dded775edd705bbac0f75a18 /src/datastore | |
parent | 56b9555f0608da28c2e3833f06abfb126b053d76 (diff) | |
download | gnunet-18db9a2fc6584fe35b327650534cf0672f4686e7.tar.gz gnunet-18db9a2fc6584fe35b327650534cf0672f4686e7.zip |
doxygen
Diffstat (limited to 'src/datastore')
-rw-r--r-- | src/datastore/datastore_api.c | 6 | ||||
-rw-r--r-- | src/datastore/gnunet-service-datastore.c | 5 | ||||
-rw-r--r-- | src/datastore/plugin_datastore_mysql.c | 17 | ||||
-rw-r--r-- | src/datastore/plugin_datastore_postgres.c | 21 | ||||
-rw-r--r-- | src/datastore/plugin_datastore_sqlite.c | 2 | ||||
-rw-r--r-- | src/datastore/plugin_datastore_template.c | 4 |
6 files changed, 25 insertions, 30 deletions
diff --git a/src/datastore/datastore_api.c b/src/datastore/datastore_api.c index a3196530e..5126de050 100644 --- a/src/datastore/datastore_api.c +++ b/src/datastore/datastore_api.c | |||
@@ -1405,7 +1405,7 @@ GNUNET_DATASTORE_get_for_replication (struct GNUNET_DATASTORE_Handle *h, | |||
1405 | * Get a single zero-anonymity value from the datastore. | 1405 | * Get a single zero-anonymity value from the datastore. |
1406 | * | 1406 | * |
1407 | * @param h handle to the datastore | 1407 | * @param h handle to the datastore |
1408 | * @param offset offset of the result (mod #num-results); set to | 1408 | * @param offset offset of the result (modulo num-results); set to |
1409 | * a random 64-bit value initially; then increment by | 1409 | * a random 64-bit value initially; then increment by |
1410 | * one each time; detect that all results have been found by uid | 1410 | * one each time; detect that all results have been found by uid |
1411 | * being again the first uid ever returned. | 1411 | * being again the first uid ever returned. |
@@ -1476,7 +1476,7 @@ GNUNET_DATASTORE_get_zero_anonymity (struct GNUNET_DATASTORE_Handle *h, | |||
1476 | * will only be called once. | 1476 | * will only be called once. |
1477 | * | 1477 | * |
1478 | * @param h handle to the datastore | 1478 | * @param h handle to the datastore |
1479 | * @param offset offset of the result (mod #num-results); set to | 1479 | * @param offset offset of the result (modulo num-results); set to |
1480 | * a random 64-bit value initially; then increment by | 1480 | * a random 64-bit value initially; then increment by |
1481 | * one each time; detect that all results have been found by uid | 1481 | * one each time; detect that all results have been found by uid |
1482 | * being again the first uid ever returned. | 1482 | * being again the first uid ever returned. |
@@ -1508,7 +1508,7 @@ GNUNET_DATASTORE_get_key (struct GNUNET_DATASTORE_Handle *h, | |||
1508 | union QueueContext qc; | 1508 | union QueueContext qc; |
1509 | 1509 | ||
1510 | GNUNET_assert (NULL != proc); | 1510 | GNUNET_assert (NULL != proc); |
1511 | #if DEBUG_DATASTORE | 1511 | ##if DEBUG_DATASTORE |
1512 | GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, | 1512 | GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, |
1513 | "Asked to look for data of type %u under key `%s'\n", | 1513 | "Asked to look for data of type %u under key `%s'\n", |
1514 | (unsigned int) type, | 1514 | (unsigned int) type, |
diff --git a/src/datastore/gnunet-service-datastore.c b/src/datastore/gnunet-service-datastore.c index f95f09921..9ae400292 100644 --- a/src/datastore/gnunet-service-datastore.c +++ b/src/datastore/gnunet-service-datastore.c | |||
@@ -290,7 +290,6 @@ delete_expired (void *cls, | |||
290 | * expired items, re-schedule the "delete_expired" task. | 290 | * expired items, re-schedule the "delete_expired" task. |
291 | * | 291 | * |
292 | * @param cls not used | 292 | * @param cls not used |
293 | * @param next_cls closure to pass to the "next" function. | ||
294 | * @param key key for the content | 293 | * @param key key for the content |
295 | * @param size number of bytes in data | 294 | * @param size number of bytes in data |
296 | * @param data content stored | 295 | * @param data content stored |
@@ -383,7 +382,6 @@ delete_expired (void *cls, | |||
383 | * that deletes until we're happy with respect to our quota. | 382 | * that deletes until we're happy with respect to our quota. |
384 | * | 383 | * |
385 | * @param cls closure | 384 | * @param cls closure |
386 | * @param next_cls closure to pass to the "next" function. | ||
387 | * @param key key for the content | 385 | * @param key key for the content |
388 | * @param size number of bytes in data | 386 | * @param size number of bytes in data |
389 | * @param data content stored | 387 | * @param data content stored |
@@ -517,8 +515,6 @@ transmit_callback (void *cls, | |||
517 | * | 515 | * |
518 | * @param client target of the message | 516 | * @param client target of the message |
519 | * @param msg message to transmit, will be freed! | 517 | * @param msg message to transmit, will be freed! |
520 | * @param tc function to call afterwards | ||
521 | * @param tc_cls closure for tc | ||
522 | */ | 518 | */ |
523 | static void | 519 | static void |
524 | transmit (struct GNUNET_SERVER_Client *client, | 520 | transmit (struct GNUNET_SERVER_Client *client, |
@@ -598,7 +594,6 @@ transmit_status (struct GNUNET_SERVER_Client *client, | |||
598 | * to the client. | 594 | * to the client. |
599 | * | 595 | * |
600 | * @param cls closure, pointer to the client (of type GNUNET_SERVER_Client). | 596 | * @param cls closure, pointer to the client (of type GNUNET_SERVER_Client). |
601 | * @param next_cls closure to use to ask for the next item | ||
602 | * @param key key for the content | 597 | * @param key key for the content |
603 | * @param size number of bytes in data | 598 | * @param size number of bytes in data |
604 | * @param data content stored | 599 | * @param data content stored |
diff --git a/src/datastore/plugin_datastore_mysql.c b/src/datastore/plugin_datastore_mysql.c index db547cb30..fb271d8d3 100644 --- a/src/datastore/plugin_datastore_mysql.c +++ b/src/datastore/plugin_datastore_mysql.c | |||
@@ -1071,7 +1071,7 @@ execute_select (struct Plugin *plugin, | |||
1071 | * Get one of the results for a particular key in the datastore. | 1071 | * Get one of the results for a particular key in the datastore. |
1072 | * | 1072 | * |
1073 | * @param cls closure | 1073 | * @param cls closure |
1074 | * @param offset offset of the result (mod #num-results); | 1074 | * @param offset offset of the result (modulo num-results); |
1075 | * specific ordering does not matter for the offset | 1075 | * specific ordering does not matter for the offset |
1076 | * @param key key to match, never NULL | 1076 | * @param key key to match, never NULL |
1077 | * @param vhash hash of the value, maybe NULL (to | 1077 | * @param vhash hash of the value, maybe NULL (to |
@@ -1081,12 +1081,8 @@ execute_select (struct Plugin *plugin, | |||
1081 | * there may be! | 1081 | * there may be! |
1082 | * @param type entries of which type are relevant? | 1082 | * @param type entries of which type are relevant? |
1083 | * Use 0 for any type. | 1083 | * Use 0 for any type. |
1084 | * @param proc function to call on each matching value; however, | 1084 | * @param proc function to call on the matching value, |
1085 | * after the first call to "proc", the plugin must wait | 1085 | * with NULL for if no value matches |
1086 | * until "NextRequest" was called before giving the processor | ||
1087 | * the next item; finally, the "proc" should be called once | ||
1088 | * once with a NULL value at the end ("next_cls" should be NULL | ||
1089 | * for that last call) | ||
1090 | * @param proc_cls closure for proc | 1086 | * @param proc_cls closure for proc |
1091 | */ | 1087 | */ |
1092 | static void | 1088 | static void |
@@ -1234,9 +1230,8 @@ mysql_plugin_get_key (void *cls, | |||
1234 | * @param offset offset of the result | 1230 | * @param offset offset of the result |
1235 | * @param type entries of which type should be considered? | 1231 | * @param type entries of which type should be considered? |
1236 | * Use 0 for any type. | 1232 | * Use 0 for any type. |
1237 | * @param iter function to call on each matching value; | 1233 | * @param proc function to call on a matching value or NULL |
1238 | * will be called once with a NULL value at the end | 1234 | * @param proc_cls closure for iter |
1239 | * @param iter_cls closure for iter | ||
1240 | */ | 1235 | */ |
1241 | static void | 1236 | static void |
1242 | mysql_plugin_get_zero_anonymity (void *cls, | 1237 | mysql_plugin_get_zero_anonymity (void *cls, |
@@ -1351,7 +1346,7 @@ repl_proc (void *cls, | |||
1351 | * | 1346 | * |
1352 | * @param cls closure | 1347 | * @param cls closure |
1353 | * @param proc function to call the value (once only). | 1348 | * @param proc function to call the value (once only). |
1354 | * @param iter_cls closure for proc | 1349 | * @param proc_cls closure for proc |
1355 | */ | 1350 | */ |
1356 | static void | 1351 | static void |
1357 | mysql_plugin_get_replication (void *cls, | 1352 | mysql_plugin_get_replication (void *cls, |
diff --git a/src/datastore/plugin_datastore_postgres.c b/src/datastore/plugin_datastore_postgres.c index 9d60100cf..115259dbf 100644 --- a/src/datastore/plugin_datastore_postgres.c +++ b/src/datastore/plugin_datastore_postgres.c | |||
@@ -529,6 +529,7 @@ postgres_plugin_put (void *cls, | |||
529 | * @param proc function to call the value (once only). | 529 | * @param proc function to call the value (once only). |
530 | * @param proc_cls closure for proc | 530 | * @param proc_cls closure for proc |
531 | * @param res result from exec | 531 | * @param res result from exec |
532 | * @param line line number for error messages | ||
532 | */ | 533 | */ |
533 | static void | 534 | static void |
534 | process_result (struct Plugin *plugin, | 535 | process_result (struct Plugin *plugin, |
@@ -663,6 +664,8 @@ process_result (struct Plugin *plugin, | |||
663 | * in the datastore. | 664 | * in the datastore. |
664 | * | 665 | * |
665 | * @param cls closure | 666 | * @param cls closure |
667 | * @param offset offset of the result (modulo num-results); | ||
668 | * specific ordering does not matter for the offset | ||
666 | * @param key maybe NULL (to match all entries) | 669 | * @param key maybe NULL (to match all entries) |
667 | * @param vhash hash of the value, maybe NULL (to | 670 | * @param vhash hash of the value, maybe NULL (to |
668 | * match all values that have the right key). | 671 | * match all values that have the right key). |
@@ -671,9 +674,9 @@ process_result (struct Plugin *plugin, | |||
671 | * there may be! | 674 | * there may be! |
672 | * @param type entries of which type are relevant? | 675 | * @param type entries of which type are relevant? |
673 | * Use 0 for any type. | 676 | * Use 0 for any type. |
674 | * @param iter function to call on each matching value; | 677 | * @param proc function to call on the matching value; |
675 | * will be called once with a NULL value at the end | 678 | * will be called once with a NULL if no value matches |
676 | * @param iter_cls closure for iter | 679 | * @param proc_cls closure for iter |
677 | */ | 680 | */ |
678 | static void | 681 | static void |
679 | postgres_plugin_get_key (void *cls, | 682 | postgres_plugin_get_key (void *cls, |
@@ -820,9 +823,9 @@ postgres_plugin_get_key (void *cls, | |||
820 | * @param cls our "struct Plugin*" | 823 | * @param cls our "struct Plugin*" |
821 | * @param type entries of which type should be considered? | 824 | * @param type entries of which type should be considered? |
822 | * Use 0 for any type. | 825 | * Use 0 for any type. |
823 | * @param iter function to call on each matching value; | 826 | * @param proc function to call on the matching value; |
824 | * will be called once with a NULL value at the end | 827 | * will be called with a NULL if no value matches |
825 | * @param iter_cls closure for iter | 828 | * @param proc_cls closure for proc |
826 | */ | 829 | */ |
827 | static void | 830 | static void |
828 | postgres_plugin_get_zero_anonymity (void *cls, | 831 | postgres_plugin_get_zero_anonymity (void *cls, |
@@ -951,7 +954,7 @@ repl_proc (void *cls, | |||
951 | * | 954 | * |
952 | * @param cls closure | 955 | * @param cls closure |
953 | * @param proc function to call the value (once only). | 956 | * @param proc function to call the value (once only). |
954 | * @param proc_cls closure for iter | 957 | * @param proc_cls closure for proc |
955 | */ | 958 | */ |
956 | static void | 959 | static void |
957 | postgres_plugin_get_replication (void *cls, | 960 | postgres_plugin_get_replication (void *cls, |
@@ -976,11 +979,11 @@ postgres_plugin_get_replication (void *cls, | |||
976 | 979 | ||
977 | /** | 980 | /** |
978 | * Get a random item for expiration. | 981 | * Get a random item for expiration. |
979 | * Call 'iter' with all values ZERO or NULL if the datastore is empty. | 982 | * Call 'proc' with all values ZERO or NULL if the datastore is empty. |
980 | * | 983 | * |
981 | * @param cls closure | 984 | * @param cls closure |
982 | * @param proc function to call the value (once only). | 985 | * @param proc function to call the value (once only). |
983 | * @param proc_cls closure for iter | 986 | * @param proc_cls closure for proc |
984 | */ | 987 | */ |
985 | static void | 988 | static void |
986 | postgres_plugin_get_expiration (void *cls, | 989 | postgres_plugin_get_expiration (void *cls, |
diff --git a/src/datastore/plugin_datastore_sqlite.c b/src/datastore/plugin_datastore_sqlite.c index 613b6a1a7..6a2a86b61 100644 --- a/src/datastore/plugin_datastore_sqlite.c +++ b/src/datastore/plugin_datastore_sqlite.c | |||
@@ -718,6 +718,8 @@ execute_get (struct Plugin *plugin, | |||
718 | * the given processor for the item. | 718 | * the given processor for the item. |
719 | * | 719 | * |
720 | * @param cls our plugin context | 720 | * @param cls our plugin context |
721 | * @param offset offset of the result (modulo num-results); | ||
722 | * specific ordering does not matter for the offset | ||
721 | * @param type entries of which type should be considered? | 723 | * @param type entries of which type should be considered? |
722 | * Use 0 for any type. | 724 | * Use 0 for any type. |
723 | * @param proc function to call on each matching value; | 725 | * @param proc function to call on each matching value; |
diff --git a/src/datastore/plugin_datastore_template.c b/src/datastore/plugin_datastore_template.c index 6228e8c0c..8975c0a70 100644 --- a/src/datastore/plugin_datastore_template.c +++ b/src/datastore/plugin_datastore_template.c | |||
@@ -92,7 +92,7 @@ template_plugin_put (void *cls, | |||
92 | * Get one of the results for a particular key in the datastore. | 92 | * Get one of the results for a particular key in the datastore. |
93 | * | 93 | * |
94 | * @param cls closure | 94 | * @param cls closure |
95 | * @param offset offset of the result (mod #num-results); | 95 | * @param offset offset of the result (modulo num-results); |
96 | * specific ordering does not matter for the offset | 96 | * specific ordering does not matter for the offset |
97 | * @param key maybe NULL (to match all entries) | 97 | * @param key maybe NULL (to match all entries) |
98 | * @param vhash hash of the value, maybe NULL (to | 98 | * @param vhash hash of the value, maybe NULL (to |
@@ -194,7 +194,7 @@ template_plugin_update (void *cls, | |||
194 | * Call the given processor on an item with zero anonymity. | 194 | * Call the given processor on an item with zero anonymity. |
195 | * | 195 | * |
196 | * @param cls our "struct Plugin*" | 196 | * @param cls our "struct Plugin*" |
197 | * @param offset offset of the result (mod #num-results); | 197 | * @param offset offset of the result (modulo num-results); |
198 | * specific ordering does not matter for the offset | 198 | * specific ordering does not matter for the offset |
199 | * @param type entries of which type should be considered? | 199 | * @param type entries of which type should be considered? |
200 | * Use 0 for any type. | 200 | * Use 0 for any type. |