src/rps/gnunet-service-rps_peers.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
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file rps/gnunet-service-rps_peers.h
  23  * @brief utilities for managing (information about) peers
  24  * @author Julius Bünger
  25  */
  26 #include "gnunet_util_lib.h"
  27 #include <inttypes.h>
  28 #include "gnunet_cadet_service.h"
  29
  30
  31 /**
  32  * Different flags indicating the status of another peer.
  33  */
  34 enum Peers_PeerFlags
  35 {
  36   /**
  37    * If we are waiting for a reply from that peer (sent a pull request).
  38    */
  39   Peers_PULL_REPLY_PENDING   = 0x01,
  40
  41   /* IN_OTHER_GOSSIP_LIST = 0x02, unneeded? */
  42   /* IN_OWN_SAMPLER_LIST  = 0x04, unneeded? */
  43   /* IN_OWN_GOSSIP_LIST   = 0x08, unneeded? */
  44
  45   /**
  46    * We set this bit when we know the peer is online.
  47    */
  48   Peers_ONLINE               = 0x20,
  49
  50   /**
  51    * We set this bit when we are going to destroy the channel to this peer.
  52    * When cleanup_channel is called, we know that we wanted to destroy it.
  53    * Otherwise the channel to the other peer was destroyed.
  54    */
  55   Peers_TO_DESTROY           = 0x40,
  56 };
  57
  58 /**
  59  * Keep track of the status of a channel.
  60  *
  61  * This is needed in order to know what to do with a channel when it's
  62  * destroyed.
  63  */
  64 enum Peers_ChannelFlags
  65 {
  66   /**
  67    * We destroyed the channel because the other peer established a second one.
  68    */
  69   Peers_CHANNEL_ESTABLISHED_TWICE = 0x1,
  70
  71   /**
  72    * The channel was removed because it was not needed any more. This should be
  73    * the sending channel.
  74    */
  75   Peers_CHANNEL_CLEAN = 0x2,
  76 };
  77
  78 /**
  79  * @brief The role of a channel. Sending or receiving.
  80  */
  81 enum Peers_ChannelRole
  82 {
  83   /**
  84    * Channel is used for sending
  85    */
  86   Peers_CHANNEL_ROLE_SENDING   = 0x01,
  87
  88   /**
  89    * Channel is used for receiving
  90    */
  91   Peers_CHANNEL_ROLE_RECEIVING = 0x02,
  92 };
  93
  94 /**
  95  * @brief Functions of this type can be used to be stored at a peer for later execution.
  96  *
  97  * @param cls closure
  98  * @param peer peer to execute function on
  99  */
 100 typedef void (* PeerOp) (void *cls, const struct GNUNET_PeerIdentity *peer);
 101
 102 /**
 103  * @brief Initialise storage of peers
 104  *
 105  * @param cadet_h cadet handle
 106  * @param own_id own peer identity
 107  */
 108 void
 109 Peers_initialise (struct GNUNET_CADET_Handle *cadet_h,
 110                   const struct GNUNET_PeerIdentity *own_id);
 111
 112 /**
 113  * @brief Delete storage of peers that was created with #Peers_initialise ()
 114  */
 115 void
 116 Peers_terminate ();
 117
 118 /**
 119  * @brief Add peer to known peers.
 120  *
 121  * This function is called on new peer_ids from 'external' sources
 122  * (client seed, cadet get_peers(), ...)
 123  *
 124  * @param peer the new #GNUNET_PeerIdentity
 125  *
 126  * @return #GNUNET_YES if peer was inserted
 127  *         #GNUNET_NO  if peer was already known
 128  */
 129 int
 130 Peers_insert_peer (const struct GNUNET_PeerIdentity *peer);
 131
 132 /**
 133  * @brief Add peer to known peers and check for liveliness.
 134  *
 135  * This function is called on new peer_ids from 'external' sources
 136  * (client seed, cadet get_peers(), ...)
 137  *
 138  * @param peer the new #GNUNET_PeerIdentity
 139  *
 140  * @return #GNUNET_YES if peer was inserted
 141  *         #GNUNET_NO  if peer was already known
 142  */
 143 int
 144 Peers_insert_peer_check_liveliness (const struct GNUNET_PeerIdentity *peer);
 145
 146 /**
 147  * @brief Remove unecessary data
 148  *
 149  * If the other peer is not intending to send messages, we have messages pending
 150  * to be sent to this peer and we are not waiting for a reply, remove the
 151  * information about it (its #PeerContext).
 152  *
 153  * @param peer the peer to clean
 154  * @return #GNUNET_YES if peer was removed
 155  *         #GNUNET_NO  otherwise
 156  */
 157 int
 158 Peers_clean_peer (const struct GNUNET_PeerIdentity *peer);
 159
 160 /**
 161  * @brief Remove peer
 162  *
 163  * @param peer the peer to clean
 164  * @return #GNUNET_YES if peer was removed
 165  *         #GNUNET_NO  otherwise
 166  */
 167 int
 168 Peers_remove_peer (const struct GNUNET_PeerIdentity *peer);
 169
 170 /**
 171  * @brief set flags on a given peer.
 172  *
 173  * @param peer the peer to set flags on
 174  * @param flags the flags
 175  */
 176 void
 177 Peers_set_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 178
 179 /**
 180  * @brief unset flags on a given peer.
 181  *
 182  * @param peer the peer to unset flags on
 183  * @param flags the flags
 184  */
 185 void
 186 Peers_unset_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 187
 188 /**
 189  * @brief Check whether flags on a peer are set.
 190  *
 191  * @param peer the peer to check the flag of
 192  * @param flags the flags to check
 193  *
 194  * @return #GNUNET_YES if all given flags are set
 195  *         ##GNUNET_NO  otherwise
 196  */
 197 int
 198 Peers_check_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 199
 200
 201 /**
 202  * @brief set flags on a given channel.
 203  *
 204  * @param channel the channel to set flags on
 205  * @param flags the flags
 206  */
 207 void
 208 Peers_set_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 209
 210 /**
 211  * @brief unset flags on a given channel.
 212  *
 213  * @param channel the channel to unset flags on
 214  * @param flags the flags
 215  */
 216 void
 217 Peers_unset_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 218
 219 /**
 220  * @brief Check whether flags on a channel are set.
 221  *
 222  * @param channel the channel to check the flag of
 223  * @param flags the flags to check
 224  *
 225  * @return #GNUNET_YES if all given flags are set
 226  *         #GNUNET_NO  otherwise
 227  */
 228 int
 229 Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 230
 231 /**
 232  * @brief Check whether we have information about the given peer.
 233  *
 234  * FIXME probably deprecated. Make this the new _online.
 235  *
 236  * @param peer peer in question
 237  *
 238  * @return #GNUNET_YES if peer is known
 239  *         #GNUNET_NO  if peer is not knwon
 240  */
 241 int
 242 Peers_check_peer_known (const struct GNUNET_PeerIdentity *peer);
 243
 244 /**
 245  * @brief Check whether @a peer is actually a peer.
 246  *
 247  * A valid peer is a peer that we know exists eg. we were connected to once.
 248  *
 249  * @param peer peer in question
 250  *
 251  * @return #GNUNET_YES if peer is valid
 252  *         #GNUNET_NO  if peer is not valid
 253  */
 254 int
 255 Peers_check_peer_valid (const struct GNUNET_PeerIdentity *peer);
 256
 257 /**
 258  * @brief Indicate that we want to send to the other peer
 259  *
 260  * This establishes a sending channel
 261  *
 262  * @param peer the peer to establish channel to
 263  */
 264 void
 265 Peers_indicate_sending_intention (const struct GNUNET_PeerIdentity *peer);
 266
 267 /**
 268  * @brief Check whether other peer has the intention to send/opened channel
 269  *        towars us
 270  *
 271  * @param peer the peer in question
 272  *
 273  * @return #GNUNET_YES if peer has the intention to send
 274  *         #GNUNET_NO  otherwise
 275  */
 276 int
 277 Peers_check_peer_send_intention (const struct GNUNET_PeerIdentity *peer);
 278
 279 /**
 280  * Handle the channel a peer opens to us.
 281  *
 282  * @param cls The closure
 283  * @param channel The channel the peer wants to establish
 284  * @param initiator The peer's peer ID
 285  * @param port The port the channel is being established over
 286  * @param options Further options
 287  *
 288  * @return initial channel context for the channel
 289  *         (can be NULL -- that's not an error)
 290  */
 291 void *
 292 Peers_handle_inbound_channel (void *cls,
 293                               struct GNUNET_CADET_Channel *channel,
 294                               const struct GNUNET_PeerIdentity *initiator,
 295                               uint32_t port,
 296                               enum GNUNET_CADET_ChannelOption options);
 297
 298 /**
 299  * @brief Check whether a sending channel towards the given peer exists
 300  *
 301  * @param peer the peer to check for
 302  *
 303  * @return #GNUNET_YES if a sending channel towards that peer exists
 304  *         #GNUNET_NO  otherwise
 305  */
 306 int
 307 Peers_check_sending_channel_exists (const struct GNUNET_PeerIdentity *peer);
 308
 309 /**
 310  * @brief check whether the given channel is the sending channel of the given
 311  *        peer
 312  *
 313  * @param peer the peer in question
 314  * @param channel the channel to check for
 315  * @param role either #Peers_CHANNEL_ROLE_SENDING, or
 316  *                    #Peers_CHANNEL_ROLE_RECEIVING
 317  *
 318  * @return #GNUNET_YES if the given chennel is the sending channel of the peer
 319  *         #GNUNET_NO  otherwise
 320  */
 321 int
 322 Peers_check_channel_role (const struct GNUNET_PeerIdentity *peer,
 323                           const struct GNUNET_CADET_Channel *channel,
 324                           enum Peers_ChannelRole role);
 325
 326 /**
 327  * @brief Destroy the send channel of a peer e.g. stop indicating a sending
 328  *        intention to another peer
 329  *
 330  * If there is also no channel to receive messages from that peer, remove it
 331  * from the peermap.
 332  *
 333  * @peer the peer identity of the peer whose sending channel to destroy
 334  * @return #GNUNET_YES if channel was destroyed
 335  *         #GNUNET_NO  otherwise
 336  */
 337 int
 338 Peers_destroy_sending_channel (const struct GNUNET_PeerIdentity *peer);
 339
 340 /**
 341  * This is called when a channel is destroyed.
 342  *
 343  * Removes peer completely from our knowledge if the send_channel was destroyed
 344  * Otherwise simply delete the recv_channel
 345  *
 346  * @param cls The closure
 347  * @param channel The channel being closed
 348  * @param channel_ctx The context associated with this channel
 349  */
 350 void
 351 Peers_cleanup_destroyed_channel (void *cls,
 352                                  const struct GNUNET_CADET_Channel *channel,
 353                                  void *channel_ctx);
 354
 355 /**
 356  * @brief Issue a check whether peer is live
 357  *
 358  * This tries to establish a channel to the given peer. Once the channel is
 359  * established successfully, we know the peer is live.
 360  *
 361  * @param peer the peer to check liveliness
 362  */
 363 void
 364 Peers_issue_peer_liveliness_check (const struct GNUNET_PeerIdentity *peer);
 365
 366 /**
 367  * @brief Send a message to another peer.
 368  *
 369  * Keeps track about pending messages so they can be properly removed when the
 370  * peer is destroyed.
 371  *
 372  * @param peer receeiver of the message
 373  * @param ev envelope of the message
 374  * @param type type of the message
 375  */
 376 void
 377 Peers_send_message (const struct GNUNET_PeerIdentity *peer,
 378                     struct GNUNET_MQ_Envelope *ev,
 379                     const char *type);
 380
 381 /**
 382  * @brief Schedule a operation on given peer
 383  *
 384  * Avoids scheduling an operation twice.
 385  *
 386  * @param peer the peer we want to schedule the operation for once it gets live
 387  *
 388  * @return #GNUNET_YES if the operation was scheduled
 389  *         #GNUNET_NO  otherwise
 390  */
 391 int
 392 Peers_schedule_operation (const struct GNUNET_PeerIdentity *peer,
 393                           const PeerOp peer_op);
 394
 395 /* end of gnunet-service-rps_peers.h */