2 This file is part of GNUnet
3 (C) 2009, 2010 Christian Grothoff (and other contributing authors)
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.
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.
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.
21 * @file include/gnunet_peerinfo_service.h
22 * @brief Code to maintain the list of currently known hosts
23 * (in memory structure of data/hosts) and their trust ratings
24 * (in memory structure of data/trust)
25 * @author Christian Grothoff
28 #ifndef GNUNET_PEERINFO_SERVICE_H
29 #define GNUNET_PEERINFO_SERVICE_H
31 #include "gnunet_common.h"
32 #include "gnunet_configuration_lib.h"
33 #include "gnunet_crypto_lib.h"
34 #include "gnunet_hello_lib.h"
39 #if 0 /* keep Emacsens' auto-indent happy */
46 * Handle to the peerinfo service.
48 struct GNUNET_PEERINFO_Handle;
52 * Connect to the peerinfo service.
54 * @param cfg configuration to use
55 * @param sched scheduler to use
56 * @return NULL on error (configuration related, actual connection
57 * etablishment may happen asynchronously).
59 struct GNUNET_PEERINFO_Handle *
60 GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
61 struct GNUNET_SCHEDULER_Handle *sched);
65 * Disconnect from the peerinfo service. Note that all iterators must
66 * have completed or have been cancelled by the time this function is
67 * called (otherwise, calling this function is a serious error).
68 * Furthermore, if 'GNUNET_PEERINFO_add_peer' operations are still
69 * pending, they will be cancelled silently on disconnect.
71 * @param h handle to disconnect
74 GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h);
78 * Add a host to the persistent list. This method operates in
79 * semi-reliable mode: if the transmission is not completed by
80 * the time 'GNUNET_PEERINFO_disconnect' is called, it will be
81 * aborted. Furthermore, if a second HELLO is added for the
82 * same peer before the first one was transmitted, PEERINFO may
83 * merge the two HELLOs prior to transmission to the service.
85 * @param h handle to the peerinfo service
86 * @param peer identity of the peer
87 * @param hello the verified (!) HELLO message
90 GNUNET_PEERINFO_add_peer_new (struct GNUNET_PEERINFO_Handle *h,
91 const struct GNUNET_PeerIdentity *peer,
92 const struct GNUNET_HELLO_Message *hello);
97 * Add a host to the persistent list.
99 * @param cfg configuration to use
100 * @param sched scheduler to use
101 * @param peer identity of the peer
102 * @param hello the verified (!) HELLO message
105 GNUNET_PEERINFO_add_peer (const struct GNUNET_CONFIGURATION_Handle *cfg,
106 struct GNUNET_SCHEDULER_Handle *sched,
107 const struct GNUNET_PeerIdentity *peer,
108 const struct GNUNET_HELLO_Message *hello);
111 * Type of an iterator over the hosts. Note that each
112 * host will be called with each available protocol.
115 * @param peer id of the peer, NULL for last call
116 * @param hello hello message for the peer (can be NULL)
117 * @param trust amount of trust we have in the peer
120 (*GNUNET_PEERINFO_Processor) (void *cls,
121 const struct GNUNET_PeerIdentity * peer,
122 const struct GNUNET_HELLO_Message * hello,
127 * Handle for cancellation of iteration over peers.
129 struct GNUNET_PEERINFO_IteratorContext;
133 * Call a method for each known matching host and change
134 * its trust value. The method will be invoked once for
135 * each host and then finally once with a NULL pointer. After
136 * that final invocation, the iterator context must no longer
139 * Note that the last call can be triggered by timeout or by simply
140 * being done; however, the trust argument will be set to zero if we
141 * are done, 1 if we timed out and 2 for fatal error.
143 * @param cfg configuration to use
144 * @param sched scheduler to use
145 * @param peer restrict iteration to this peer only (can be NULL)
146 * @param trust_delta how much to change the trust in all matching peers
147 * @param timeout how long to wait until timing out
148 * @param callback the method to call for each peer
149 * @param callback_cls closure for callback
150 * @return NULL on error (in this case, 'callback' is never called!),
151 * otherwise an iterator context
153 struct GNUNET_PEERINFO_IteratorContext *
154 GNUNET_PEERINFO_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
155 struct GNUNET_SCHEDULER_Handle *sched,
156 const struct GNUNET_PeerIdentity *peer,
158 struct GNUNET_TIME_Relative timeout,
159 GNUNET_PEERINFO_Processor callback,
165 * Call a method for each known matching host and change its trust
166 * value. The callback method will be invoked once for each matching
167 * host and then finally once with a NULL pointer. After that final
168 * invocation, the iterator context must no longer be used.
170 * Note that the last call can be triggered by timeout or by simply
171 * being done; however, the trust argument will be set to zero if we
172 * are done, 1 if we timed out and 2 for fatal error.
174 * Instead of calling this function with 'peer == NULL' and 'trust ==
175 * 0', it is often better to use 'GNUNET_PEERINFO_notify'.
177 * @param h handle to the peerinfo service
178 * @param peer restrict iteration to this peer only (can be NULL)
179 * @param trust_delta how much to change the trust in all matching peers
180 * @param timeout how long to wait until timing out
181 * @param callback the method to call for each peer
182 * @param callback_cls closure for callback
183 * @return NULL on error (in this case, 'callback' is never called!),
184 * otherwise an iterator context
186 struct GNUNET_PEERINFO_IteratorContext *
187 GNUNET_PEERINFO_iterate_new (struct GNUNET_PEERINFO_Handle *h,
188 const struct GNUNET_PeerIdentity *peer,
190 struct GNUNET_TIME_Relative timeout,
191 GNUNET_PEERINFO_Processor callback,
197 * Cancel an iteration over peer information.
199 * @param ic context of the iterator to cancel
202 GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic);
206 * Handle for notifications about changes to the set of known peers.
208 struct GNUNET_PEERINFO_NotifyContext;
212 * Call a method whenever our known information about peers
213 * changes. Initially calls the given function for all known
214 * peers and then only signals changes. Note that it is
215 * possible (i.e. on disconnects) that the callback is called
216 * twice with the same peer information.
218 * @param cfg configuration to use
219 * @param sched scheduler to use
220 * @param callback the method to call for each peer
221 * @param callback_cls closure for callback
222 * @return NULL on error
224 struct GNUNET_PEERINFO_NotifyContext *
225 GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
226 struct GNUNET_SCHEDULER_Handle *sched,
227 GNUNET_PEERINFO_Processor callback,
232 * Stop notifying about changes.
234 * @param nc context to stop notifying
237 GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc);
240 #if 0 /* keep Emacsens' auto-indent happy */
248 /* end of gnunet_peerinfo_service.h */