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      SPDX-License-Identifier: AGPL3.0-or-later
  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    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_JOIN
  40    */
  41   struct GNUNET_MessageHeader header;
  42
  43   /**
  44    * Number of peers (at the end of this message) that want to
  45    * participate in the consensus.
  46    */
  47   uint32_t num_peers GNUNET_PACKED;
  48
  49   /**
  50    * Session id of the consensus.
  51    */
  52   struct GNUNET_HashCode session_id;
  53
  54   /**
  55    * Start time for the consensus.
  56    */
  57   struct GNUNET_TIME_AbsoluteNBO start;
  58
  59   /**
  60    * Deadline for conclude.
  61    */
  62   struct GNUNET_TIME_AbsoluteNBO deadline;
  63
  64   /* GNUNET_PeerIdentity[num_peers] */
  65 };
  66
  67
  68 /**
  69  * Message with an element
  70  */
  71 struct GNUNET_CONSENSUS_ElementMessage {
  72   /**
  73    * Type:
  74    * Either GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT
  75    * or GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT_ELEMENT
  76    */
  77   struct GNUNET_MessageHeader header;
  78
  79   /**
  80    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_NEW_ELEMENT
  81    */
  82   uint16_t element_type GNUNET_PACKED; /* FIXME: alignment? => uint32_t */
  83
  84   /* rest: element data */
  85 };
  86
  87
  88 GNUNET_NETWORK_STRUCT_END
  89
  90 #endif