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 sched scheduler to use
55 * @param cfg configuration 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 (struct GNUNET_SCHEDULER_Handle *sched,
61 const struct GNUNET_CONFIGURATION_Handle *cfg);
66 * Disconnect from the peerinfo service. Note that all iterators must
67 * have completed or have been cancelled by the time this function is
68 * called (otherwise, calling this function is a serious error).
69 * Furthermore, if 'GNUNET_PEERINFO_add_peer' operations are still
70 * pending, they will be cancelled silently on disconnect.
72 * @param h handle to disconnect
75 GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h);
79 * Add a host to the persistent list. This method operates in
80 * semi-reliable mode: if the transmission is not completed by
81 * the time 'GNUNET_PEERINFO_disconnect' is called, it will be
82 * aborted. Furthermore, if a second HELLO is added for the
83 * same peer before the first one was transmitted, PEERINFO may
84 * merge the two HELLOs prior to transmission to the service.
86 * @param h handle to the peerinfo service
87 * @param hello the verified (!) HELLO message
90 GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
91 const struct GNUNET_HELLO_Message *hello);
95 * Type of an iterator over the hosts. Note that each
96 * host will be called with each available protocol.
99 * @param peer id of the peer, NULL for last call
100 * @param hello hello message for the peer (can be NULL)
101 * @param trust amount of trust we have in the peer
104 (*GNUNET_PEERINFO_Processor) (void *cls,
105 const struct GNUNET_PeerIdentity * peer,
106 const struct GNUNET_HELLO_Message * hello,
111 * Handle for cancellation of iteration over peers.
113 struct GNUNET_PEERINFO_IteratorContext;
117 * Call a method for each known matching host and change its trust
118 * value. The callback method will be invoked once for each matching
119 * host and then finally once with a NULL pointer. After that final
120 * invocation, the iterator context must no longer be used.
122 * Note that the last call can be triggered by timeout or by simply
123 * being done; however, the trust argument will be set to zero if we
124 * are done, 1 if we timed out and 2 for fatal error.
126 * Instead of calling this function with 'peer == NULL' and 'trust ==
127 * 0', it is often better to use 'GNUNET_PEERINFO_notify'.
129 * @param h handle to the peerinfo service
130 * @param peer restrict iteration to this peer only (can be NULL)
131 * @param trust_delta how much to change the trust in all matching peers
132 * @param timeout how long to wait until timing out
133 * @param callback the method to call for each peer
134 * @param callback_cls closure for callback
135 * @return NULL on error (in this case, 'callback' is never called!),
136 * otherwise an iterator context
138 struct GNUNET_PEERINFO_IteratorContext *
139 GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
140 const struct GNUNET_PeerIdentity *peer,
142 struct GNUNET_TIME_Relative timeout,
143 GNUNET_PEERINFO_Processor callback,
149 * Cancel an iteration over peer information.
151 * @param ic context of the iterator to cancel
154 GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic);
159 * Handle for notifications about changes to the set of known peers.
161 struct GNUNET_PEERINFO_NotifyContext;
165 * Call a method whenever our known information about peers
166 * changes. Initially calls the given function for all known
167 * peers and then only signals changes. Note that it is
168 * possible (i.e. on disconnects) that the callback is called
169 * twice with the same peer information.
171 * @param cfg configuration to use
172 * @param sched scheduler to use
173 * @param callback the method to call for each peer
174 * @param callback_cls closure for callback
175 * @return NULL on error
177 struct GNUNET_PEERINFO_NotifyContext *
178 GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
179 struct GNUNET_SCHEDULER_Handle *sched,
180 GNUNET_PEERINFO_Processor callback,
185 * Stop notifying about changes.
187 * @param nc context to stop notifying
190 GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc);
193 #if 0 /* keep Emacsens' auto-indent happy */
201 /* end of gnunet_peerinfo_service.h */