src/set/set_protocol.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 /**
  22  * @author Florian Dold
  23  * @file set/set_protocol.h
  24  * @brief Peer-to-Peer messages for gnunet set
  25  */
  26 #ifndef SET_PROTOCOL_H
  27 #define SET_PROTOCOL_H
  28
  29 #include "platform.h"
  30 #include "gnunet_common.h"
  31
  32
  33 GNUNET_NETWORK_STRUCT_BEGIN
  34
  35 struct OperationRequestMessage
  36 {
  37   /**
  38    * Type: GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
  39    */
  40   struct GNUNET_MessageHeader header;
  41
  42   /**
  43    * Operation to request, values from 'enum GNUNET_SET_OperationType'
  44    */
  45   uint32_t operation GNUNET_PACKED;
  46
  47   /**
  48    * Salt to use for this operation.
  49    */
  50   uint32_t salt;
  51
  52   /**
  53    * For Intersection: my element count
  54    */
  55   uint32_t element_count;
  56
  57   /**
  58    * Application-specific identifier of the request.
  59    */
  60   struct GNUNET_HashCode app_id;
  61
  62   /* rest: optional message */
  63 };
  64
  65 struct IBFMessage
  66 {
  67   /**
  68    * Type: GNUNET_MESSAGE_TYPE_SET_P2P_IBF
  69    */
  70   struct GNUNET_MessageHeader header;
  71
  72   /**
  73    * Order of the whole ibf, where
  74    * num_buckets = 2^order
  75    */
  76   uint8_t order;
  77
  78   /**
  79    * Padding, must be 0.
  80    */
  81   uint8_t reserved;
  82
  83   /**
  84    * Offset of the strata in the rest of the message
  85    */
  86   uint16_t offset GNUNET_PACKED;
  87
  88   /**
  89    * Salt used when hashing elements for this IBF.
  90    */
  91   uint32_t salt;
  92
  93   /* rest: strata */
  94 };
  95
  96 struct BFMessage
  97 {
  98   /**
  99    * Type: GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF
 100    */
 101   struct GNUNET_MessageHeader header;
 102
 103   /**
 104    * mutator used with this bloomfilter.
 105    */
 106   uint32_t sender_element_count GNUNET_PACKED;
 107
 108   /**
 109    * mutator used with this bloomfilter.
 110    */
 111   uint32_t sender_mutator GNUNET_PACKED;
 112
 113   /**
 114    * Length of the bloomfilter data
 115    */
 116   uint32_t bloomfilter_total_length GNUNET_PACKED;
 117
 118   /**
 119    * Length of the appended bloomfilter data block
 120    */
 121   uint32_t bloomfilter_length GNUNET_PACKED;
 122
 123   /**
 124    * Length of the bloomfilter data
 125    */
 126   uint32_t bits_per_element GNUNET_PACKED;
 127
 128   /**
 129    * rest: the sender's bloomfilter
 130    */
 131 };
 132
 133 struct BFPart
 134 {
 135   /**
 136    * Type: GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF
 137    */
 138   struct GNUNET_MessageHeader header;
 139
 140   /**
 141    * Length of the appended bloomfilter data block
 142    */
 143   uint32_t chunk_length GNUNET_PACKED;
 144
 145   /**
 146    * offset in the bloolfilter data block, if multipart message
 147    */
 148   uint32_t chunk_offset GNUNET_PACKED;
 149
 150   /**
 151    * rest: the sender's bloomfilter
 152    */
 153 };
 154
 155 GNUNET_NETWORK_STRUCT_END
 156
 157 #endif