src/consensus/consensus.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @author Florian Dold
  21  * @file consensus/consensus.h
  22  * @brief
  23  */
  24 #ifndef CONSENSUS_H
  25 #define CONSENSUS_H
  26
  27 #include "gnunet_common.h"
  28
  29 GNUNET_NETWORK_STRUCT_BEGIN
  30
  31 /**
  32  * Sent by the client to the service,
  33  * when the client wants the service to join a consensus session.
  34  */
  35 struct GNUNET_CONSENSUS_JoinMessage
  36 {
  37   /**
  38    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_JOIN
  39    */
  40   struct GNUNET_MessageHeader header;
  41
  42   /**
  43    * Number of peers (at the end of this message) that want to
  44    * participate in the consensus.
  45    */
  46   uint32_t num_peers GNUNET_PACKED;
  47
  48   /**
  49    * Session id of the consensus.
  50    */
  51   struct GNUNET_HashCode session_id;
  52
  53   /**
  54    * Start time for the consensus.
  55    */
  56   struct GNUNET_TIME_AbsoluteNBO start;
  57
  58   /**
  59    * Deadline for conclude.
  60    */
  61   struct GNUNET_TIME_AbsoluteNBO deadline;
  62
  63   /* GNUNET_PeerIdentity[num_peers] */
  64 };
  65
  66
  67 /**
  68  * Message with an element
  69  */
  70 struct GNUNET_CONSENSUS_ElementMessage
  71 {
  72
  73   /**
  74    * Type:
  75    * Either GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT
  76    * or GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT_ELEMENT
  77    */
  78   struct GNUNET_MessageHeader header;
  79
  80   /**
  81    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_NEW_ELEMENT
  82    */
  83   uint16_t element_type GNUNET_PACKED; /* FIXME: alignment? => uint32_t */
  84
  85   /* rest: element data */
  86 };
  87
  88
  89 GNUNET_NETWORK_STRUCT_END
  90
  91 #endif