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   struct GNUNET_HashCode session_id;
  41
  42   uint16_t num_peers;
  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    * Timeout for conclude
  57    */
  58   struct GNUNET_TIME_RelativeNBO timeout;
  59
  60   /**
  61    * Minimum group size required for a consensus group.
  62    */
  63   uint32_t min_group_size;
  64 };
  65
  66
  67 struct GNUNET_CONSENSUS_ConcludeDoneMessage
  68 {
  69   /**
  70    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE_DONE
  71    */
  72   struct GNUNET_MessageHeader header;
  73
  74   uint32_t group_id;
  75
  76   uint32_t num_elements;
  77
  78   uint16_t num_peers;
  79
  80   /** PeerIdentity[num_peers] */
  81 };
  82
  83
  84 /**
  85  * Message with an element
  86  */
  87 struct GNUNET_CONSENSUS_ElementMessage
  88 {
  89
  90   /**
  91    * Type:
  92    * Either GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT
  93    * or GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT_ELEMENT
  94    */
  95   struct GNUNET_MessageHeader header;
  96
  97   /**
  98    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_NEW_ELEMENT
  99    */
 100   uint16_t element_type;
 101
 102   /* rest: element data */
 103 };
 104
 105 struct GNUNET_CONSENSUS_AckMessage
 106 {
 107   /**
 108    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_ACK
 109    */
 110   struct GNUNET_MessageHeader header;
 111
 112   /**
 113    * Do we want to keep and propagate the element?
 114    */
 115   uint8_t keep;
 116
 117   /* FIXME: add message hash? */
 118 };
 119
 120 GNUNET_NETWORK_STRUCT_END
 121
 122 #endif