Merge branch 'master' of gnunet.org:gnunet
[oweals/gnunet.git] / 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   /**
40    * Type: GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_JOIN
41    */
42   struct GNUNET_MessageHeader header;
43
44   /**
45    * Number of peers (at the end of this message) that want to
46    * participate in the consensus.
47    */
48   uint32_t num_peers GNUNET_PACKED;
49
50   /**
51    * Session id of the consensus.
52    */
53   struct GNUNET_HashCode session_id;
54
55   /**
56    * Start time for the consensus.
57    */
58   struct GNUNET_TIME_AbsoluteNBO start;
59
60   /**
61    * Deadline for conclude.
62    */
63   struct GNUNET_TIME_AbsoluteNBO deadline;
64
65   /* GNUNET_PeerIdentity[num_peers] */
66 };
67
68
69 /**
70  * Message with an element
71  */
72 struct GNUNET_CONSENSUS_ElementMessage
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
90 GNUNET_NETWORK_STRUCT_END
91
92 #endif