diff options
author | Gabor X Toth <*@tg-x.net> | 2015-07-18 00:03:00 +0000 |
---|---|---|
committer | Gabor X Toth <*@tg-x.net> | 2015-07-18 00:03:00 +0000 |
commit | 2275976cf61565bde4f17e8c2c0bc0d359541ac4 (patch) | |
tree | e1e921aade10b820b739b95dcad878c5b0fa870a /src/psycstore | |
parent | 5781ff7e1a968262eb19fcb456a3cf6320575e75 (diff) | |
download | gnunet-2275976cf61565bde4f17e8c2c0bc0d359541ac4.tar.gz gnunet-2275976cf61565bde4f17e8c2c0bc0d359541ac4.zip |
psycstore: doc formatting
Diffstat (limited to 'src/psycstore')
-rw-r--r-- | src/psycstore/psycstore_api.c | 124 |
1 files changed, 82 insertions, 42 deletions
diff --git a/src/psycstore/psycstore_api.c b/src/psycstore/psycstore_api.c index 6c90ae569..f5210ac76 100644 --- a/src/psycstore/psycstore_api.c +++ b/src/psycstore/psycstore_api.c | |||
@@ -1180,10 +1180,14 @@ GNUNET_PSYCSTORE_message_get_fragment (struct GNUNET_PSYCSTORE_Handle *h, | |||
1180 | * The current value of counters are needed when a channel master is restarted, | 1180 | * The current value of counters are needed when a channel master is restarted, |
1181 | * so that it can continue incrementing the counters from their last value. | 1181 | * so that it can continue incrementing the counters from their last value. |
1182 | * | 1182 | * |
1183 | * @param h Handle for the PSYCstore. | 1183 | * @param h |
1184 | * @param channel_key Public key that identifies the channel. | 1184 | * Handle for the PSYCstore. |
1185 | * @param ccb Callback to call with the result. | 1185 | * @param channel_key |
1186 | * @param ccb_cls Closure for the @a ccb callback. | 1186 | * Public key that identifies the channel. |
1187 | * @param ccb | ||
1188 | * Callback to call with the result. | ||
1189 | * @param ccb_cls | ||
1190 | * Closure for the @a ccb callback. | ||
1187 | * | 1191 | * |
1188 | * @return Handle that can be used to cancel the operation. | 1192 | * @return Handle that can be used to cancel the operation. |
1189 | */ | 1193 | */ |
@@ -1222,14 +1226,22 @@ GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
1222 | * An error is returned if there are missing messages containing state | 1226 | * An error is returned if there are missing messages containing state |
1223 | * operations before the current one. | 1227 | * operations before the current one. |
1224 | * | 1228 | * |
1225 | * @param h Handle for the PSYCstore. | 1229 | * @param h |
1226 | * @param channel_key The channel we are interested in. | 1230 | * Handle for the PSYCstore. |
1227 | * @param message_id ID of the message that contains the @a modifiers. | 1231 | * @param channel_key |
1228 | * @param state_delta Value of the _state_delta PSYC header variable of the message. | 1232 | * The channel we are interested in. |
1229 | * @param modifier_count Number of elements in the @a modifiers array. | 1233 | * @param message_id |
1230 | * @param modifiers List of modifiers to apply. | 1234 | * ID of the message that contains the @a modifiers. |
1231 | * @param rcb Callback to call with the result of the operation. | 1235 | * @param state_delta |
1232 | * @param rcb_cls Closure for the @a rcb callback. | 1236 | * Value of the _state_delta PSYC header variable of the message. |
1237 | * @param modifier_count | ||
1238 | * Number of elements in the @a modifiers array. | ||
1239 | * @param modifiers | ||
1240 | * List of modifiers to apply. | ||
1241 | * @param rcb | ||
1242 | * Callback to call with the result of the operation. | ||
1243 | * @param rcb_cls | ||
1244 | * Closure for the @a rcb callback. | ||
1233 | * | 1245 | * |
1234 | * @return Handle that can be used to cancel the operation. | 1246 | * @return Handle that can be used to cancel the operation. |
1235 | */ | 1247 | */ |
@@ -1292,13 +1304,20 @@ GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h, | |||
1292 | /** | 1304 | /** |
1293 | * Store synchronized state. | 1305 | * Store synchronized state. |
1294 | * | 1306 | * |
1295 | * @param h Handle for the PSYCstore. | 1307 | * @param h |
1296 | * @param channel_key The channel we are interested in. | 1308 | * Handle for the PSYCstore. |
1297 | * @param message_id ID of the message that contains the state_hash PSYC header variable. | 1309 | * @param channel_key |
1298 | * @param modifier_count Number of elements in the @a modifiers array. | 1310 | * The channel we are interested in. |
1299 | * @param modifiers Full state to store. | 1311 | * @param message_id |
1300 | * @param rcb Callback to call with the result of the operation. | 1312 | * ID of the message that contains the state_hash PSYC header variable. |
1301 | * @param rcb_cls Closure for the callback. | 1313 | * @param modifier_count |
1314 | * Number of elements in the @a modifiers array. | ||
1315 | * @param modifiers | ||
1316 | * Full state to store. | ||
1317 | * @param rcb | ||
1318 | * Callback to call with the result of the operation. | ||
1319 | * @param rcb_cls | ||
1320 | * Closure for the callback. | ||
1302 | * | 1321 | * |
1303 | * @return Handle that can be used to cancel the operation. | 1322 | * @return Handle that can be used to cancel the operation. |
1304 | */ | 1323 | */ |
@@ -1357,10 +1376,14 @@ GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h, | |||
1357 | * | 1376 | * |
1358 | * Delete all state variables stored for the given channel. | 1377 | * Delete all state variables stored for the given channel. |
1359 | * | 1378 | * |
1360 | * @param h Handle for the PSYCstore. | 1379 | * @param h |
1361 | * @param channel_key The channel we are interested in. | 1380 | * Handle for the PSYCstore. |
1362 | * @param rcb Callback to call with the result of the operation. | 1381 | * @param channel_key |
1363 | * @param rcb_cls Closure for the callback. | 1382 | * The channel we are interested in. |
1383 | * @param rcb | ||
1384 | * Callback to call with the result of the operation. | ||
1385 | * @param rcb_cls | ||
1386 | * Closure for the callback. | ||
1364 | * | 1387 | * |
1365 | * @return Handle that can be used to cancel the operation. | 1388 | * @return Handle that can be used to cancel the operation. |
1366 | */ | 1389 | */ |
@@ -1398,13 +1421,18 @@ GNUNET_PSYCSTORE_state_reset (struct GNUNET_PSYCSTORE_Handle *h, | |||
1398 | /** | 1421 | /** |
1399 | * Update signed values of state variables in the state store. | 1422 | * Update signed values of state variables in the state store. |
1400 | * | 1423 | * |
1401 | * @param h Handle for the PSYCstore. | 1424 | * @param h |
1402 | * @param channel_key The channel we are interested in. | 1425 | * Handle for the PSYCstore. |
1403 | * @param message_id Message ID that contained the state @a hash. | 1426 | * @param channel_key |
1404 | * @param hash Hash of the serialized full state. | 1427 | * The channel we are interested in. |
1405 | * @param rcb Callback to call with the result of the operation. | 1428 | * @param message_id |
1406 | * @param rcb_cls Closure for the callback. | 1429 | * Message ID that contained the state @a hash. |
1407 | * | 1430 | * @param hash |
1431 | * Hash of the serialized full state. | ||
1432 | * @param rcb | ||
1433 | * Callback to call with the result of the operation. | ||
1434 | * @param rcb_cls | ||
1435 | * Closure for the callback. | ||
1408 | */ | 1436 | */ |
1409 | struct GNUNET_PSYCSTORE_OperationHandle * | 1437 | struct GNUNET_PSYCSTORE_OperationHandle * |
1410 | GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h, | 1438 | GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h, |
@@ -1441,12 +1469,18 @@ GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h, | |||
1441 | /** | 1469 | /** |
1442 | * Retrieve the best matching state variable. | 1470 | * Retrieve the best matching state variable. |
1443 | * | 1471 | * |
1444 | * @param h Handle for the PSYCstore. | 1472 | * @param h |
1445 | * @param channel_key The channel we are interested in. | 1473 | * Handle for the PSYCstore. |
1446 | * @param name Name of variable to match, the returned variable might be less specific. | 1474 | * @param channel_key |
1447 | * @param scb Callback to return the matching state variable. | 1475 | * The channel we are interested in. |
1448 | * @param rcb Callback to call with the result of the operation. | 1476 | * @param name |
1449 | * @param cls Closure for the callbacks. | 1477 | * Name of variable to match, the returned variable might be less specific. |
1478 | * @param scb | ||
1479 | * Callback to return the matching state variable. | ||
1480 | * @param rcb | ||
1481 | * Callback to call with the result of the operation. | ||
1482 | * @param cls | ||
1483 | * Closure for the callbacks. | ||
1450 | * | 1484 | * |
1451 | * @return Handle that can be used to cancel the operation. | 1485 | * @return Handle that can be used to cancel the operation. |
1452 | */ | 1486 | */ |
@@ -1488,12 +1522,18 @@ GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
1488 | /** | 1522 | /** |
1489 | * Retrieve all state variables for a channel with the given prefix. | 1523 | * Retrieve all state variables for a channel with the given prefix. |
1490 | * | 1524 | * |
1491 | * @param h Handle for the PSYCstore. | 1525 | * @param h |
1492 | * @param channel_key The channel we are interested in. | 1526 | * Handle for the PSYCstore. |
1493 | * @param name_prefix Prefix of state variable names to match. | 1527 | * @param channel_key |
1494 | * @param scb Callback to return matching state variables. | 1528 | * The channel we are interested in. |
1495 | * @param rcb Callback to call with the result of the operation. | 1529 | * @param name_prefix |
1496 | * @param cls Closure for the callbacks. | 1530 | * Prefix of state variable names to match. |
1531 | * @param scb | ||
1532 | * Callback to return matching state variables. | ||
1533 | * @param rcb | ||
1534 | * Callback to call with the result of the operation. | ||
1535 | * @param cls | ||
1536 | * Closure for the callbacks. | ||
1497 | * | 1537 | * |
1498 | * @return Handle that can be used to cancel the operation. | 1538 | * @return Handle that can be used to cancel the operation. |
1499 | */ | 1539 | */ |