aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_multicast_service.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-07-09 20:12:33 +0000
committerChristian Grothoff <christian@grothoff.org>2013-07-09 20:12:33 +0000
commitfb13d50b0c9dafb126bf7f9a03f93953afd0a0c3 (patch)
tree8e151fc03d0145864dc624dd414a0097e24d9647 /src/include/gnunet_multicast_service.h
parent5427359ae439d524509e3221dedf48941f213dab (diff)
downloadgnunet-fb13d50b0c9dafb126bf7f9a03f93953afd0a0c3.tar.gz
gnunet-fb13d50b0c9dafb126bf7f9a03f93953afd0a0c3.zip
rename 'leave' to 'part' as 'part' is the better opposite of 'join'
Diffstat (limited to 'src/include/gnunet_multicast_service.h')
-rw-r--r--src/include/gnunet_multicast_service.h24
1 files changed, 14 insertions, 10 deletions
diff --git a/src/include/gnunet_multicast_service.h b/src/include/gnunet_multicast_service.h
index 3119b0b3c..76a6bcf32 100644
--- a/src/include/gnunet_multicast_service.h
+++ b/src/include/gnunet_multicast_service.h
@@ -247,7 +247,7 @@ typedef void (*GNUNET_MULTICAST_JoinCallback)(void *cls,
247 247
248 248
249/** 249/**
250 * Method called whenever another peer wants to leave the multicast group. 250 * Method called whenever another peer wants to part the multicast group.
251 * 251 *
252 * A leave request must be always be honoured. 252 * A leave request must be always be honoured.
253 * 253 *
@@ -256,10 +256,10 @@ typedef void (*GNUNET_MULTICAST_JoinCallback)(void *cls,
256 * @param msg Application-dependent leave message from the leaving user. 256 * @param msg Application-dependent leave message from the leaving user.
257 * @param jh Join handle to pass to GNUNET_MULTICAST_join_decison(). 257 * @param jh Join handle to pass to GNUNET_MULTICAST_join_decison().
258 */ 258 */
259typedef void (*GNUNET_MULTICAST_LeaveCallback)(void *cls, 259typedef void (*GNUNET_MULTICAST_PartCallback)(void *cls,
260 const struct GNUNET_PeerIdentity *peer, 260 const struct GNUNET_PeerIdentity *peer,
261 const struct GNUNET_MessageHeader *msg, 261 const struct GNUNET_MessageHeader *msg,
262 struct GNUNET_MULTICAST_JoinHandle *jh); 262 struct GNUNET_MULTICAST_JoinHandle *jh);
263 263
264 264
265/** 265/**
@@ -408,6 +408,8 @@ struct GNUNET_MULTICAST_PingHandle;
408 * 408 *
409 * @param rh Handle that was given for the ping. 409 * @param rh Handle that was given for the ping.
410 * @param message_id Latest message ID seen by this peer for this group. 410 * @param message_id Latest message ID seen by this peer for this group.
411 *
412 * @deprecated needed???
411 */ 413 */
412void 414void
413GNUNET_MULTICAST_pong (struct GNUNET_MULTICAST_ReplayHandle *rh, 415GNUNET_MULTICAST_pong (struct GNUNET_MULTICAST_ReplayHandle *rh,
@@ -428,6 +430,8 @@ GNUNET_MULTICAST_pong (struct GNUNET_MULTICAST_ReplayHandle *rh,
428 * @param peer Identity of the peer who sent the ping. 430 * @param peer Identity of the peer who sent the ping.
429 * @param latest_message_id Latest message ID seen by the requesting member. 431 * @param latest_message_id Latest message ID seen by the requesting member.
430 * @param rh Handle to pass back to GNUNET_MULTICAST_pong() or GNUNET_MULTICAST_replay(). 432 * @param rh Handle to pass back to GNUNET_MULTICAST_pong() or GNUNET_MULTICAST_replay().
433 *
434 * @deprecated needed???
431 */ 435 */
432typedef void (*GNUNET_MULTICAST_PingCallback)(void *cls, 436typedef void (*GNUNET_MULTICAST_PingCallback)(void *cls,
433 const struct GNUNET_PeerIdentity *peer, 437 const struct GNUNET_PeerIdentity *peer,
@@ -456,9 +460,9 @@ typedef void (*GNUNET_MULTICAST_PingCallback)(void *cls,
456 * @param join_policy What is the membership policy of the group? 460 * @param join_policy What is the membership policy of the group?
457 * @param replay_cb Function that can be called to replay a message. 461 * @param replay_cb Function that can be called to replay a message.
458 * @param test_cb Function multicast can use to test group membership. 462 * @param test_cb Function multicast can use to test group membership.
459 * @param ping_cb Function called to answer a ping. 463 * @param ping_cb Function called to answer a ping. -- Gabor: remove this one!? deprecated?
460 * @param join_cb Function called to approve / disapprove joining of a peer. 464 * @param join_cb Function called to approve / disapprove joining of a peer.
461 * @param leave_cb Function called when a member wants to leave the group. 465 * @param part_cb Function called when a member wants to part the group.
462 * @param request_cb Function called with messages from group members. 466 * @param request_cb Function called with messages from group members.
463 * @return Handle for the origin, NULL on error. 467 * @return Handle for the origin, NULL on error.
464 */ 468 */
@@ -471,7 +475,7 @@ GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
471 GNUNET_MULITCAST_MembershipTestCallback test_cb, 475 GNUNET_MULITCAST_MembershipTestCallback test_cb,
472 GNUNET_MULITCAST_PingCallback ping_cb, 476 GNUNET_MULITCAST_PingCallback ping_cb,
473 GNUNET_MULTICAST_JoinCallback join_cb, 477 GNUNET_MULTICAST_JoinCallback join_cb,
474 GNUNET_MULTICAST_LeaveCallback leave_cb, 478 GNUNET_MULTICAST_PartCallback part_cb,
475 GNUNET_MULTICAST_RequestCallback request_cb); 479 GNUNET_MULTICAST_RequestCallback request_cb);
476 480
477 481
@@ -600,12 +604,12 @@ GNUNET_MULTICAST_member_request_replay_cancel (struct GNUNET_MULTICAST_ReplayReq
600 604
601 605
602/** 606/**
603 * Leave a multicast group. 607 * Part a multicast group.
604 * 608 *
605 * @param member Membership handle. 609 * @param member Membership handle.
606 */ 610 */
607void 611void
608GNUNET_MULTICAST_member_leave (struct GNUNET_MULTICAST_Member *member); 612GNUNET_MULTICAST_member_part (struct GNUNET_MULTICAST_Member *member);
609 613
610 614
611/** 615/**