-rps: rename and doxygen

3 files changed, 27 insertions, 27 deletions

diff --git a/src/rps/gnunet-service-rps.c b/src/rps/gnunet-service-rps.c
index f56627a54..69082adac 100644
--- a/src/rps/gnunet-service-rps.c
+++ b/src/rps/gnunet-service-rps.c
@@ -673,7 +673,7 @@ insert_in_sampler (void *cls,
   if (0 < RPS_sampler_count_id (prot_sampler, peer))
   {
     /* Make sure we 'know' about this peer */
-    (void) Peers_insert_peer_check_liveliness (peer);
+    (void) Peers_check_peer_live (peer);
     /* Establish a channel towards that peer to indicate we are going to send
      * messages to it */
     Peers_indicate_sending_intention (peer);
@@ -691,7 +691,7 @@ static void
 got_peer (const struct GNUNET_PeerIdentity *peer)
 {
   /* If we did not know this peer already, insert it into sampler and view */
-  if (GNUNET_YES == Peers_insert_peer_check_liveliness (peer))
+  if (GNUNET_YES == Peers_check_peer_live (peer))
   {
     Peers_schedule_operation (peer, insert_in_sampler);
     Peers_schedule_operation (peer, insert_in_view);
@@ -1386,7 +1386,7 @@ handle_peer_pull_reply (void *cls,
                                               &peers[i]))
     {
       /* Make sure we 'know' about this peer */
-      (void) Peers_insert_peer_check_liveliness (&peers[i]);
+      (void) Peers_check_peer_live (&peers[i]);
 
       if (GNUNET_YES == Peers_check_peer_valid (&peers[i]))
       {
@@ -1605,7 +1605,7 @@ handle_client_act_malicious (void *cls,
     /* Set the flag of the attacked peer to valid to avoid problems */
     if (GNUNET_NO == Peers_check_peer_known (&attacked_peer))
     {
-      Peers_insert_peer_check_liveliness (&attacked_peer);
+      Peers_check_peer_live (&attacked_peer);
       Peers_issue_peer_liveliness_check (&attacked_peer);
     }
 
@@ -1696,7 +1696,7 @@ do_mal_round (void *cls)
      * Send as many pushes to the attacked peer as possible
      * That is one push per round as it will ignore more.
      */
-    Peers_insert_peer_check_liveliness (&attacked_peer);
+    Peers_check_peer_live (&attacked_peer);
     if (GNUNET_YES == Peers_check_peer_valid (&attacked_peer))
       send_push (&attacked_peer);
   }
@@ -1708,7 +1708,7 @@ do_mal_round (void *cls)
     /* Send PUSH to attacked peers */
     if (GNUNET_YES == Peers_check_peer_known (&attacked_peer))
     {
-      Peers_insert_peer_check_liveliness (&attacked_peer);
+      Peers_check_peer_live (&attacked_peer);
       if (GNUNET_YES == Peers_check_peer_valid (&attacked_peer))
       {
         LOG (GNUNET_ERROR_TYPE_DEBUG,
@@ -1720,7 +1720,7 @@ do_mal_round (void *cls)
         Peers_issue_peer_liveliness_check (&attacked_peer);
     }
     else
-      Peers_insert_peer_check_liveliness (&attacked_peer);
+      Peers_check_peer_live (&attacked_peer);
     Peers_issue_peer_liveliness_check (&attacked_peer);
 
     /* The maximum of pushes we're going to send this round */
diff --git a/src/rps/gnunet-service-rps_peers.c b/src/rps/gnunet-service-rps_peers.c
index 29b08adc8..5179f46dc 100644
--- a/src/rps/gnunet-service-rps_peers.c
+++ b/src/rps/gnunet-service-rps_peers.c
@@ -992,7 +992,8 @@ Peers_get_valid_peers (PeersIterator iterator,
  * @param peer the new #GNUNET_PeerIdentity
  *
  * @return #GNUNET_YES if peer was inserted
- *         #GNUNET_NO  if peer was already known
+ *         #GNUNET_NO  otherwise (if peer was already known or
+ *                     peer was #own_identity)
  */
 int
 Peers_insert_peer (const struct GNUNET_PeerIdentity *peer)
@@ -1008,27 +1009,26 @@ Peers_insert_peer (const struct GNUNET_PeerIdentity *peer)
 
 
 /**
- * @brief Add peer to known peers and check for liveliness.
+ * @brief Try connecting to a peer to see whether it is online
  *
- * This function is called on new peer_ids from 'external' sources
- * (client seed, cadet get_peers(), ...)
- *
- * @param peer the new #GNUNET_PeerIdentity
+ * If not known yet, insert into known peers
  *
- * @return #GNUNET_YES if peer was inserted
- *         #GNUNET_NO  if peer was already known
+ * @param peer the peer whose liveliness is to be checked
+ * @return #GNUNET_YES if peer had to be inserted
+ *         #GNUNET_NO  otherwise (if peer was already known or
+ *                     peer was #own_identity)
  */
 int
-Peers_insert_peer_check_liveliness (const struct GNUNET_PeerIdentity *peer)
+Peers_check_peer_live (const struct GNUNET_PeerIdentity *peer)
 {
   struct PeerContext *peer_ctx;
   int ret;
 
-  ret = Peers_insert_peer (peer);
   if (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity))
   {
-    return ret;
+    return GNUNET_NO;
   }
+  ret = Peers_insert_peer (peer);
   peer_ctx = get_peer_ctx (peer);
   if (GNUNET_NO == Peers_check_peer_valid (peer))
   {
diff --git a/src/rps/gnunet-service-rps_peers.h b/src/rps/gnunet-service-rps_peers.h
index 2a7bae6f4..a6018265c 100644
--- a/src/rps/gnunet-service-rps_peers.h
+++ b/src/rps/gnunet-service-rps_peers.h
@@ -152,24 +152,24 @@ Peers_get_valid_peers (PeersIterator iterator,
  * @param peer the new #GNUNET_PeerIdentity
  *
  * @return #GNUNET_YES if peer was inserted
- *         #GNUNET_NO  if peer was already known
+ *         #GNUNET_NO  otherwise (if peer was already known or
+ *                     peer was #own_identity)
  */
 int
 Peers_insert_peer (const struct GNUNET_PeerIdentity *peer);
 
 /**
- * @brief Add peer to known peers and check for liveliness.
+ * @brief Try connecting to a peer to see whether it is online
  *
- * This function is called on new peer_ids from 'external' sources
- * (client seed, cadet get_peers(), ...)
+ * If not known yet, insert into known peers
  *
- * @param peer the new #GNUNET_PeerIdentity
- *
- * @return #GNUNET_YES if peer was inserted
- *         #GNUNET_NO  if peer was already known
+ * @param peer the peer whose liveliness is to be checked
+ * @return #GNUNET_YES if peer had to be inserted
+ *         #GNUNET_NO  otherwise (if peer was already known or
+ *                     peer was #own_identity)
  */
 int
-Peers_insert_peer_check_liveliness (const struct GNUNET_PeerIdentity *peer);
+Peers_check_peer_live (const struct GNUNET_PeerIdentity *peer);
 
 /**
  * @brief Remove unecessary data