src/rps/rps.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2012-2013 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, 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 push own ID to other peer.
  42  */
  43 struct GNUNET_RPS_P2P_PushMessage
  44 {
  45   /**
  46    * Header including size and type in NBO
  47    */
  48   struct GNUNET_MessageHeader header;
  49
  50   /**
  51    * TODO Proof of work
  52    */
  53   uint64_t placeholder;
  54 };
  55
  56
  57
  58 /***********************************************************************
  59  * Client-Service Messages
  60 ***********************************************************************/
  61
  62 /**
  63  * Message from client to RPS service to request random peer(s).
  64  */
  65 struct GNUNET_RPS_CS_RequestMessage
  66 {
  67   /**
  68    * Header including size and type in NBO
  69    */
  70   struct GNUNET_MessageHeader header;
  71
  72   /**
  73    * Number of random peer requested
  74    */
  75   uint32_t num_peers GNUNET_PACKED;
  76
  77   /**
  78    * Identifyer of the message.
  79    */
  80   uint64_t n GNUNET_PACKED;
  81
  82 };
  83
  84 /**
  85  * Message from RPS service to client to reply with random peer(s).
  86  */
  87 struct GNUNET_RPS_CS_ReplyMessage
  88 {
  89   /**
  90    * Type is #GNUNET_MESSAGE_TYPE_RPS_REPLY.
  91    */
  92   struct GNUNET_MessageHeader header;
  93
  94   /**
  95    * Identifyer of the message.
  96    */
  97   uint64_t n;
  98
  99   /**
 100    * Number of random peer replied
 101    */
 102   uint64_t num_peers GNUNET_PACKED;
 103
 104   /* Followed by num_peers * GNUNET_PeerIdentity */
 105 };
 106
 107 /**
 108  * Message from client to service with seed of peers
 109  */
 110 struct GNUNET_RPS_CS_SeedMessage
 111 {
 112   /**
 113    * Header including size and type in NBO
 114    */
 115   struct GNUNET_MessageHeader header;
 116
 117   /**
 118    * Number of peers
 119    */
 120   uint64_t num_peers;
 121
 122   /* Followed by num_peers * GNUNET_PeerIdentity */
 123 };
 124
 125 GNUNET_NETWORK_STRUCT_END