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