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   /**
  60    * Padding, must be zero.
  61    */
  62   uint32_t reserved GNUNET_PACKED;
  63
  64   /**
  65    * Deadline for conclude
  66    */
  67   struct GNUNET_TIME_AbsoluteNBO deadline;
  68 };
  69
  70
  71 /**
  72  * Message with an element
  73  */
  74 struct GNUNET_CONSENSUS_ElementMessage
  75 {
  76
  77   /**
  78    * Type:
  79    * Either GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT
  80    * or GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT_ELEMENT
  81    */
  82   struct GNUNET_MessageHeader header;
  83
  84   /**
  85    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_NEW_ELEMENT
  86    */
  87   uint16_t element_type GNUNET_PACKED; /* FIXME: alignment? => uint32_t */
  88
  89   /* rest: element data */
  90 };
  91
  92 struct GNUNET_CONSENSUS_AckMessage
  93 {
  94   /**
  95    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_ACK
  96    */
  97   struct GNUNET_MessageHeader header;
  98
  99   /**
 100    * Do we want to keep and propagate the element?
 101    */
 102   uint8_t keep; /* FIXME: alignment!? => (u)int32_t */
 103
 104   /* FIXME: add message hash? */
 105 };
 106
 107 GNUNET_NETWORK_STRUCT_END
 108
 109 #endif