src/rps/rps.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2012-2013 GNUnet e.V.
   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  * @file rps/rps.h
  22  * @brief example IPC messages between RPS API and GNS service
  23  * @author Julius Bünger
  24  */
  25
  26 #include "gnunet_rps_service.h"
  27
  28 /**
  29  * Mesh port used by RPS.
  30  */
  31 #define GNUNET_RPS_CADET_PORT 31337
  32
  33
  34 GNUNET_NETWORK_STRUCT_BEGIN
  35
  36 /***********************************************************************
  37  * P2P Messages
  38 ***********************************************************************/
  39
  40 /**
  41  * P2P Message to send PeerIDs to other peer.
  42  */
  43 struct GNUNET_RPS_P2P_PullReplyMessage
  44 {
  45   /**
  46    * Header including size and type in NBO
  47    */
  48   struct GNUNET_MessageHeader header;
  49
  50   /**
  51    * Number of PeerIDs sent
  52    */
  53   uint32_t num_peers GNUNET_PACKED;
  54
  55   /* Followed by num_peers * GNUNET_PeerIdentity */
  56 };
  57
  58
  59
  60 /***********************************************************************
  61  * Client-Service Messages
  62 ***********************************************************************/
  63
  64 /**
  65  * Message from client to RPS service to request random peer(s).
  66  */
  67 struct GNUNET_RPS_CS_RequestMessage
  68 {
  69   /**
  70    * Header including size and type in NBO
  71    */
  72   struct GNUNET_MessageHeader header;
  73
  74   /**
  75    * Identifyer of the message.
  76    */
  77   uint32_t id GNUNET_PACKED;
  78
  79   /**
  80    * Number of random peer requested
  81    */
  82   uint32_t num_peers GNUNET_PACKED;
  83 };
  84
  85 /**
  86  * Message from RPS service to client to reply with random peer(s).
  87  */
  88 struct GNUNET_RPS_CS_ReplyMessage
  89 {
  90   /**
  91    * Type is #GNUNET_MESSAGE_TYPE_RPS_CS_REPLY.
  92    */
  93   struct GNUNET_MessageHeader header;
  94
  95   /**
  96    * Identifyer of the message.
  97    */
  98   uint32_t id GNUNET_PACKED;
  99
 100   /**
 101    * Number of random peer replied
 102    */
 103   uint32_t num_peers GNUNET_PACKED;
 104
 105   /* Followed by num_peers * GNUNET_PeerIdentity */
 106 };
 107
 108 /**
 109  * Message from client to RPS service to cancel request.
 110  */
 111 struct GNUNET_RPS_CS_RequestCancelMessage
 112 {
 113   /**
 114    * Header including size and type in NBO
 115    */
 116   struct GNUNET_MessageHeader header;
 117
 118   /**
 119    * Identifyer of the message.
 120    */
 121   uint32_t id GNUNET_PACKED;
 122 };
 123
 124 /**
 125  * Message from client to service with seed of peers.
 126  */
 127 struct GNUNET_RPS_CS_SeedMessage
 128 {
 129   /**
 130    * Header including size and type in NBO
 131    */
 132   struct GNUNET_MessageHeader header;
 133
 134   /**
 135    * Number of peers
 136    */
 137   uint32_t num_peers GNUNET_PACKED;
 138
 139   /* Followed by num_peers * GNUNET_PeerIdentity */
 140 };
 141
 142 #ifdef ENABLE_MALICIOUS
 143 /**
 144  * Message from client to service to turn service malicious.
 145  */
 146 struct GNUNET_RPS_CS_ActMaliciousMessage
 147 {
 148   /**
 149    * Header including size and type in NBO
 150    */
 151   struct GNUNET_MessageHeader header;
 152
 153   /**
 154    * If the type is 2 this is the attacked peer,
 155    * empty otherwise.
 156    */
 157   struct GNUNET_PeerIdentity attacked_peer;
 158
 159   /**
 160    * Type of malicious behaviour.
 161    *
 162    * 0 No malicious bahaviour at all
 163    * 1 Try to maximise representation
 164    * 2 Try to partition the network
 165    */
 166   uint32_t type GNUNET_PACKED;
 167
 168   /**
 169    * Number of peers
 170    */
 171   uint32_t num_peers GNUNET_PACKED;
 172
 173   /* Followed by num_peers * GNUNET_PeerIdentity when the type of malicious
 174      behaviour is 1 */
 175 };
 176 #endif /* ENABLE_MALICIOUS */
 177
 178
 179 /***********************************************************************
 180  * Defines from old gnunet-service-rps_peers.h
 181 ***********************************************************************/
 182
 183 /**
 184  * Different flags indicating the status of another peer.
 185  */
 186 enum Peers_PeerFlags
 187 {
 188   /**
 189    * If we are waiting for a reply from that peer (sent a pull request).
 190    */
 191   Peers_PULL_REPLY_PENDING   = 0x01,
 192
 193   /* IN_OTHER_GOSSIP_LIST = 0x02, unneeded? */
 194   /* IN_OWN_SAMPLER_LIST  = 0x04, unneeded? */
 195   /* IN_OWN_GOSSIP_LIST   = 0x08, unneeded? */
 196
 197   /**
 198    * We set this bit when we know the peer is online.
 199    */
 200   Peers_ONLINE               = 0x20,
 201
 202   /**
 203    * We set this bit when we are going to destroy the channel to this peer.
 204    * When cleanup_channel is called, we know that we wanted to destroy it.
 205    * Otherwise the channel to the other peer was destroyed.
 206    */
 207   Peers_TO_DESTROY           = 0x40,
 208 };
 209
 210 /**
 211  * Keep track of the status of a channel.
 212  *
 213  * This is needed in order to know what to do with a channel when it's
 214  * destroyed.
 215  */
 216 enum Peers_ChannelFlags
 217 {
 218   /**
 219    * We destroyed the channel because the other peer established a second one.
 220    */
 221   Peers_CHANNEL_ESTABLISHED_TWICE = 0x1,
 222
 223   /**
 224    * The channel was removed because it was not needed any more. This should be
 225    * the sending channel.
 226    */
 227   Peers_CHANNEL_CLEAN = 0x2,
 228
 229   /**
 230    * We destroyed the channel because the other peer established a second one.
 231    */
 232   Peers_CHANNEL_DESTROING = 0x4,
 233 };
 234
 235
 236 /**
 237  * @brief The role of a channel. Sending or receiving.
 238  */
 239 enum Peers_ChannelRole
 240 {
 241   /**
 242    * Channel is used for sending
 243    */
 244   Peers_CHANNEL_ROLE_SENDING   = 0x01,
 245
 246   /**
 247    * Channel is used for receiving
 248    */
 249   Peers_CHANNEL_ROLE_RECEIVING = 0x02,
 250 };
 251
 252 /**
 253  * @brief Functions of this type can be used to be stored at a peer for later execution.
 254  *
 255  * @param cls closure
 256  * @param peer peer to execute function on
 257  */
 258 typedef void (* PeerOp) (void *cls, const struct GNUNET_PeerIdentity *peer);
 259
 260 /**
 261  * @brief Iterator over valid peers.
 262  *
 263  * @param cls closure
 264  * @param peer current public peer id
 265  * @return #GNUNET_YES if we should continue to
 266  *         iterate,
 267  *         #GNUNET_NO if not.
 268  */
 269 typedef int
 270 (*PeersIterator) (void *cls,
 271                   const struct GNUNET_PeerIdentity *peer);
 272
 273
 274 GNUNET_NETWORK_STRUCT_END