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 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 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 /**
  34  * Sent by the client to the service,
  35  * when the client wants the service to join a consensus session.
  36  */
  37 struct GNUNET_CONSENSUS_JoinMessage
  38 {
  39   /**
  40    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_JOIN
  41    */
  42   struct GNUNET_MessageHeader header;
  43
  44   uint32_t num_peers GNUNET_PACKED;
  45
  46   struct GNUNET_HashCode session_id;
  47
  48   /* GNUNET_PeerIdentity[num_peers] */
  49 };
  50
  51
  52 struct GNUNET_CONSENSUS_ConcludeMessage
  53 {
  54   /**
  55    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE
  56    */
  57   struct GNUNET_MessageHeader header;
  58
  59   // uint32_t reserved GNUNET_PACKED; // FIXME...
  60
  61   /**
  62    * Timeout for conclude
  63    */
  64   struct GNUNET_TIME_RelativeNBO timeout;
  65 };
  66
  67
  68 /**
  69  * Message with an element
  70  */
  71 struct GNUNET_CONSENSUS_ElementMessage
  72 {
  73
  74   /**
  75    * Type:
  76    * Either GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT
  77    * or GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT_ELEMENT
  78    */
  79   struct GNUNET_MessageHeader header;
  80
  81   /**
  82    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_NEW_ELEMENT
  83    */
  84   uint16_t element_type GNUNET_PACKED; /* FIXME: alignment? => uint32_t */
  85
  86   /* rest: element data */
  87 };
  88
  89 struct GNUNET_CONSENSUS_AckMessage
  90 {
  91   /**
  92    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_ACK
  93    */
  94   struct GNUNET_MessageHeader header;
  95
  96   /**
  97    * Do we want to keep and propagate the element?
  98    */
  99   uint8_t keep; /* FIXME: alignment!? => (u)int32_t */
 100
 101   /* FIXME: add message hash? */
 102 };
 103
 104 GNUNET_NETWORK_STRUCT_END
 105
 106 #endif