src/rps/gnunet-service-rps_view.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C)
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @file rps/gnunet-service-rps_view.h
  21  * @brief wrapper around the "local view"
  22  * @author Julius Bünger
  23  */
  24 #include "gnunet_util_lib.h"
  25 #include <inttypes.h>
  26
  27
  28 /**
  29  * Create an empty view.
  30  *
  31  * @param len the maximum length for the view
  32  */
  33 void
  34 View_create (unsigned int len);
  35
  36 /**
  37  * Change length of view
  38  *
  39  * If size is decreased, peers with higher indices are removed.
  40  *
  41  * @param len the (maximum) length for the view
  42  */
  43 void
  44 View_change_len (unsigned int len);
  45
  46 /**
  47  * Get the view as an array
  48  *
  49  * @return the view in array representation
  50  */
  51 const struct GNUNET_PeerIdentity *
  52 View_get_as_array ();
  53
  54 /**
  55  * Get the size of the view
  56  *
  57  * @return current number of actually contained peers
  58  */
  59 unsigned int
  60 View_size ();
  61
  62 /**
  63  * Insert peer into the view
  64  *
  65  * @param peer the peer to insert
  66  *
  67  * @return GNUNET_OK if peer was actually inserted
  68  *         GNUNET_NO if peer was not inserted
  69  */
  70 int
  71 View_put (const struct GNUNET_PeerIdentity *peer);
  72
  73 /**
  74  * Check whether view contains a peer
  75  *
  76  * @param peer the peer to check for
  77  *
  78  * @return GNUNET_OK if view contains peer
  79  *         GNUNET_NO otherwise
  80  */
  81 int
  82 View_contains_peer (const struct GNUNET_PeerIdentity *peer);
  83
  84 /**
  85  * Remove peer from view
  86  *
  87  * @param peer the peer to remove
  88  *
  89  * @return GNUNET_OK if view contained peer and removed it successfully
  90  *         GNUNET_NO if view does not contain peer
  91  */
  92 int
  93 View_remove_peer (const struct GNUNET_PeerIdentity *peer);
  94
  95 /**
  96  * Get a peer by index
  97  *
  98  * @param index the index of the peer to get
  99  *
 100  * @return peer to the corresponding index.
 101  *         NULL if this index is not known
 102  */
 103 const struct GNUNET_PeerIdentity *
 104 View_get_peer_by_index (uint32_t index);
 105
 106 /**
 107  * Clear the custom peer map
 108  *
 109  * @param c_peer_map the custom peer map to look in
 110  *
 111  * @return size of the map
 112  */
 113 void
 114 View_clear ();
 115
 116 /**
 117  * Destroy peermap.
 118  *
 119  * @param c_peer_map the map to destroy
 120  */
 121 void
 122 View_destroy ();
 123
 124 /* end of gnunet-service-rps_view.h */