diff options
author | Gabor X Toth <*@tg-x.net> | 2013-09-03 23:02:05 +0000 |
---|---|---|
committer | Gabor X Toth <*@tg-x.net> | 2013-09-03 23:02:05 +0000 |
commit | 5d50a7a5b5675551836191bccf60810c64a33776 (patch) | |
tree | 53b749015430b127f1ca1dce4fca23fe947fe4c8 /src/multicast | |
parent | eb9556bf2983ca19a5cbcf7cf460a0b2509b290a (diff) | |
download | gnunet-5d50a7a5b5675551836191bccf60810c64a33776.tar.gz gnunet-5d50a7a5b5675551836191bccf60810c64a33776.zip |
multicast: renamed replay() to replay_response(), doc fixes
Diffstat (limited to 'src/multicast')
-rw-r--r-- | src/multicast/multicast_api.c | 43 |
1 files changed, 18 insertions, 25 deletions
diff --git a/src/multicast/multicast_api.c b/src/multicast/multicast_api.c index 9dceec1a5..b1278eb9a 100644 --- a/src/multicast/multicast_api.c +++ b/src/multicast/multicast_api.c | |||
@@ -222,11 +222,11 @@ struct GNUNET_MULTICAST_ReplayHandle | |||
222 | * @param ec Error code. | 222 | * @param ec Error code. |
223 | */ | 223 | */ |
224 | void | 224 | void |
225 | GNUNET_MULTICAST_replay (struct GNUNET_MULTICAST_ReplayHandle *rh, | 225 | GNUNET_MULTICAST_replay_response (struct GNUNET_MULTICAST_ReplayHandle *rh, |
226 | const struct GNUNET_MessageHeader *msg, | 226 | const struct GNUNET_MessageHeader *msg, |
227 | enum GNUNET_MULTICAST_ReplayErrorCode ec) | 227 | enum GNUNET_MULTICAST_ReplayErrorCode ec) |
228 | { | 228 | { |
229 | }; | 229 | } |
230 | 230 | ||
231 | 231 | ||
232 | /** | 232 | /** |
@@ -237,7 +237,7 @@ GNUNET_MULTICAST_replay (struct GNUNET_MULTICAST_ReplayHandle *rh, | |||
237 | * @param rh Replay session to end. | 237 | * @param rh Replay session to end. |
238 | */ | 238 | */ |
239 | void | 239 | void |
240 | GNUNET_MULTICAST_replay_end (struct GNUNET_MULTICAST_ReplayHandle *rh) | 240 | GNUNET_MULTICAST_replay_response_end (struct GNUNET_MULTICAST_ReplayHandle *rh) |
241 | { | 241 | { |
242 | } | 242 | } |
243 | 243 | ||
@@ -250,9 +250,9 @@ GNUNET_MULTICAST_replay_end (struct GNUNET_MULTICAST_ReplayHandle *rh) | |||
250 | * @param notify_cls Closure for @a notify. | 250 | * @param notify_cls Closure for @a notify. |
251 | */ | 251 | */ |
252 | void | 252 | void |
253 | GNUNET_MULTICAST_replay2 (struct GNUNET_MULTICAST_ReplayHandle *rh, | 253 | GNUNET_MULTICAST_replay_response2 (struct GNUNET_MULTICAST_ReplayHandle *rh, |
254 | GNUNET_MULTICAST_ReplayTransmitNotify notify, | 254 | GNUNET_MULTICAST_ReplayTransmitNotify notify, |
255 | void *notify_cls) | 255 | void *notify_cls) |
256 | { | 256 | { |
257 | } | 257 | } |
258 | 258 | ||
@@ -278,7 +278,8 @@ GNUNET_MULTICAST_replay2 (struct GNUNET_MULTICAST_ReplayHandle *rh, | |||
278 | * when restarting the origin. 0 for a new group. | 278 | * when restarting the origin. 0 for a new group. |
279 | * @param join_cb Function called to approve / disapprove joining of a peer. | 279 | * @param join_cb Function called to approve / disapprove joining of a peer. |
280 | * @param test_cb Function multicast can use to test group membership. | 280 | * @param test_cb Function multicast can use to test group membership. |
281 | * @param replay_cb Function that can be called to replay a message. | 281 | * @param replay_frag_cb Function that can be called to replay a message fragment. |
282 | * @param replay_msg_cb Function that can be called to replay a message. | ||
282 | * @param request_cb Function called with message fragments from group members. | 283 | * @param request_cb Function called with message fragments from group members. |
283 | * @param message_cb Function called with the message fragments sent to the | 284 | * @param message_cb Function called with the message fragments sent to the |
284 | * network by GNUNET_MULTICAST_origin_to_all(). These message fragments | 285 | * network by GNUNET_MULTICAST_origin_to_all(). These message fragments |
@@ -385,15 +386,13 @@ GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *origin) | |||
385 | * @a relay (might, for example, contain a user, bind user | 386 | * @a relay (might, for example, contain a user, bind user |
386 | * identity/pseudonym to peer identity, application-level message to | 387 | * identity/pseudonym to peer identity, application-level message to |
387 | * origin, etc.). | 388 | * origin, etc.). |
388 | * @param max_known_fragment_id Largest known message fragment ID to the replay | ||
389 | * service; all messages with IDs larger than this ID will be replayed if | ||
390 | * possible (lower IDs will be considered known and thus only | ||
391 | * be replayed upon explicit request). | ||
392 | * FIXME: needed? can be optional or moved to a separate function. | ||
393 | * @param join_cb Function called to approve / disapprove joining of a peer. | 389 | * @param join_cb Function called to approve / disapprove joining of a peer. |
394 | * @param test_cb Function multicast can use to test group membership. | 390 | * @param test_cb Function multicast can use to test group membership. |
395 | * @param replay_cb Function that can be called to replay messages | 391 | * @param replay_frag_cb Function that can be called to replay message fragments |
396 | * this peer already knows from this group; NULL if this | 392 | * this peer already knows from this group. NULL if this |
393 | * client is unable to support replay. | ||
394 | * @param replay_msg_cb Function that can be called to replay message fragments | ||
395 | * this peer already knows from this group. NULL if this | ||
397 | * client is unable to support replay. | 396 | * client is unable to support replay. |
398 | * @param message_cb Function to be called for all message fragments we | 397 | * @param message_cb Function to be called for all message fragments we |
399 | * receive from the group, excluding those our @a replay_cb | 398 | * receive from the group, excluding those our @a replay_cb |
@@ -458,16 +457,10 @@ GNUNET_MULTICAST_member_replay_fragment (struct GNUNET_MULTICAST_Member *member, | |||
458 | * needed and not known to the client. | 457 | * needed and not known to the client. |
459 | * | 458 | * |
460 | * @param member Membership handle. | 459 | * @param member Membership handle. |
461 | * @param fragment_id ID of a message fragment that this client would like to | 460 | * @param message_id ID of the message this client would like to see replayed. |
462 | see replayed. | 461 | * @param fragment_offset Offset of the fragment within the message to replay. |
463 | * @param message_id ID of a message that this client would like to see | ||
464 | * replayed. Typically only one of the @a fragment_id and @a message_id | ||
465 | * is given. Specifying a @a message_id would return the last fragment | ||
466 | * of the message, which allows requesting the preceding fragments of the | ||
467 | * message by looking at the @e fragment_delta header field. | ||
468 | * @param flags Additional flags for the replay request. It is used & defined | 462 | * @param flags Additional flags for the replay request. It is used & defined |
469 | * by the replay callback. E.g. the PSYC service would use this to | 463 | * by the replay callback. |
470 | * implement state synchronization. | ||
471 | * @param result_cb Function to be called for the replayed message. | 464 | * @param result_cb Function to be called for the replayed message. |
472 | * @param result_cb_cls Closure for @a message_cb. | 465 | * @param result_cb_cls Closure for @a message_cb. |
473 | * @return Replay request handle, NULL on error. | 466 | * @return Replay request handle, NULL on error. |