doxygen additions
[oweals/gnunet.git] / src / peerinfo / peerinfo.h
1 /*
2      This file is part of GNUnet.
3      (C) 2009 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  * @file peerinfo/peerinfo.h
23  * @brief common internal definitions for peerinfo service
24  * @author Christian Grothoff
25  */
26 #include "gnunet_crypto_lib.h"
27 #include "gnunet_time_lib.h"
28 #include "gnunet_peerinfo_service.h"
29
30 #define DEBUG_PEERINFO GNUNET_NO
31
32 /**
33  * Add the given peer to the list.  This message
34  * is always followed by a verified HELLO message.
35  */
36 struct PeerAddMessage
37 {
38
39   /**
40    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_ADD
41    */
42   struct GNUNET_MessageHeader header;
43
44   /**
45    * Always zero.
46    */
47   uint32_t reserved GNUNET_PACKED;
48
49   /**
50    * For which peer do we provide a HELLO message here?
51    */
52   struct GNUNET_PeerIdentity peer;
53
54 };
55
56
57 /**
58  * Message requesting a listing of all known peers,
59  * possibly modified by the specified trust value
60  * and restricted to the specified peer identity.
61  */
62 struct ListPeerMessage
63 {
64
65   /**
66    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_GET
67    */
68   struct GNUNET_MessageHeader header;
69
70   /**
71    * How much to change the trust in each returned peer,
72    * in network byte order.
73    */
74   int32_t trust_change GNUNET_PACKED;
75
76   /**
77    * Restrict to peers with this identity (optional
78    * field, check header.size!).
79    */
80   struct GNUNET_PeerIdentity peer;
81
82 };
83
84
85 /**
86  * Message requesting a listing of all known peers,
87  * possibly modified by the specified trust value
88  * and restricted to the specified peer identity.
89  */
90 struct ListAllPeersMessage
91 {
92
93   /**
94    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_GET
95    */
96   struct GNUNET_MessageHeader header;
97
98   /**
99    * How much to change the trust in each returned peer,
100    * in network byte order.
101    */
102   int32_t trust_change GNUNET_PACKED;
103
104 };
105
106
107 /**
108  * Message used to inform the client about
109  * a particular peer; this message is optionally followed
110  * by a HELLO message for the respective peer (if available).
111  * Check the header.size field to see if a HELLO is
112  * present.
113  */
114 struct InfoMessage
115 {
116
117   /**
118    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_INFO
119    */
120   struct GNUNET_MessageHeader header;
121
122   /**
123    * Amount of trust we now have in the peer,
124    * in network byte order.
125    */
126   uint32_t trust GNUNET_PACKED;
127
128   /**
129    * About which peer are we talking here?
130    */
131   struct GNUNET_PeerIdentity peer;
132
133 };
134
135
136 /* end of peerinfo.h */