src/consensus/consensus.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012 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 2, 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 consensus/consensus.h
  24  * @brief
  25  */
  26 #ifndef CONSENSUS_H
  27 #define CONSENSUS_H
  28
  29 #include "gnunet_common.h"
  30
  31 GNUNET_NETWORK_STRUCT_BEGIN
  32
  33 struct GNUNET_CONSENSUS_JoinMessage
  34 {
  35   /**
  36    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_JOIN
  37    */
  38   struct GNUNET_MessageHeader header;
  39
  40   uint32_t num_peers GNUNET_PACKED;
  41
  42   struct GNUNET_HashCode session_id;
  43
  44   /* GNUNET_PeerIdentity[num_peers] */
  45 };
  46
  47
  48 struct GNUNET_CONSENSUS_ConcludeMessage
  49 {
  50   /**
  51    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE
  52    */
  53   struct GNUNET_MessageHeader header;
  54
  55
  56   /**
  57    * Minimum group size required for a consensus group.
  58    */
  59   uint32_t min_group_size GNUNET_PACKED;
  60
  61   /**
  62    * Timeout for conclude
  63    */
  64   struct GNUNET_TIME_RelativeNBO timeout;
  65 };
  66
  67
  68 struct GNUNET_CONSENSUS_ConcludeDoneMessage
  69 {
  70   /**
  71    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE_DONE
  72    */
  73   struct GNUNET_MessageHeader header;
  74
  75   uint32_t group_id GNUNET_PACKED;
  76
  77   uint32_t num_elements GNUNET_PACKED;
  78
  79   uint32_t num_peers GNUNET_PACKED;
  80
  81   /** PeerIdentity[num_peers] */
  82 };
  83
  84
  85 /**
  86  * Message with an element
  87  */
  88 struct GNUNET_CONSENSUS_ElementMessage
  89 {
  90
  91   /**
  92    * Type:
  93    * Either GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT
  94    * or GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT_ELEMENT
  95    */
  96   struct GNUNET_MessageHeader header;
  97
  98   /**
  99    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_NEW_ELEMENT
 100    */
 101   uint16_t element_type GNUNET_PACKED; /* FIXME: alignment? */
 102
 103   /* rest: element data */
 104 };
 105
 106 struct GNUNET_CONSENSUS_AckMessage
 107 {
 108   /**
 109    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_ACK
 110    */
 111   struct GNUNET_MessageHeader header;
 112
 113   /**
 114    * Do we want to keep and propagate the element?
 115    */
 116   uint8_t keep; /* FIXME: alignment!? */
 117
 118   /* FIXME: add message hash? */
 119 };
 120
 121 GNUNET_NETWORK_STRUCT_END
 122
 123 #endif