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 3, 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).
24 * @author Christian Grothoff
27 #ifndef GNUNET_PEERINFO_SERVICE_H
28 #define GNUNET_PEERINFO_SERVICE_H
30 #include "gnunet_common.h"
31 #include "gnunet_configuration_lib.h"
32 #include "gnunet_crypto_lib.h"
33 #include "gnunet_hello_lib.h"
38 #if 0 /* keep Emacsens' auto-indent happy */
45 * Handle to the peerinfo service.
47 struct GNUNET_PEERINFO_Handle;
51 * Connect to the peerinfo service.
53 * @param cfg configuration to use
54 * @return NULL on error (configuration related, actual connection
55 * etablishment may happen asynchronously).
57 struct GNUNET_PEERINFO_Handle *
58 GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
63 * Disconnect from the peerinfo service. Note that all iterators must
64 * have completed or have been cancelled by the time this function is
65 * called (otherwise, calling this function is a serious error).
66 * Furthermore, if 'GNUNET_PEERINFO_add_peer' operations are still
67 * pending, they will be cancelled silently on disconnect.
69 * @param h handle to disconnect
72 GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h);
76 * Add a host to the persistent list. This method operates in
77 * semi-reliable mode: if the transmission is not completed by
78 * the time 'GNUNET_PEERINFO_disconnect' is called, it will be
79 * aborted. Furthermore, if a second HELLO is added for the
80 * same peer before the first one was transmitted, PEERINFO may
81 * merge the two HELLOs prior to transmission to the service.
83 * @param h handle to the peerinfo service
84 * @param hello the verified (!) HELLO message
87 GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
88 const struct GNUNET_HELLO_Message *hello);
92 * Type of an iterator over the hosts. Note that each
93 * host will be called with each available protocol.
96 * @param peer id of the peer, NULL for last call
97 * @param hello hello message for the peer (can be NULL)
98 * @param error message
100 typedef void (*GNUNET_PEERINFO_Processor) (void *cls,
101 const struct GNUNET_PeerIdentity *
103 const struct GNUNET_HELLO_Message *
104 hello, const char *err_msg);
108 * Handle for cancellation of iteration over peers.
110 struct GNUNET_PEERINFO_IteratorContext;
114 * Call a method for each known matching host to get its HELLO.
115 * The callback method will be invoked once for each matching
116 * host and then finally once with a NULL pointer. After that final
117 * invocation, the iterator context must no longer be used.
119 * Instead of calling this function with 'peer == NULL'
120 * it is often better to use 'GNUNET_PEERINFO_notify'.
122 * @param h handle to the peerinfo service
123 * @param peer restrict iteration to this peer only (can be NULL)
124 * @param timeout how long to wait until timing out
125 * @param callback the method to call for each peer
126 * @param callback_cls closure for callback
127 * @return NULL on error (in this case, 'callback' is never called!),
128 * otherwise an iterator context
130 struct GNUNET_PEERINFO_IteratorContext *
131 GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
132 const struct GNUNET_PeerIdentity *peer,
133 struct GNUNET_TIME_Relative timeout,
134 GNUNET_PEERINFO_Processor callback,
140 * Cancel an iteration over peer information.
142 * @param ic context of the iterator to cancel
145 GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic);
150 * Handle for notifications about changes to the set of known peers.
152 struct GNUNET_PEERINFO_NotifyContext;
156 * Call a method whenever our known information about peers
157 * changes. Initially calls the given function for all known
158 * peers and then only signals changes. Note that it is
159 * possible (i.e. on disconnects) that the callback is called
160 * twice with the same peer information.
162 * @param cfg configuration to use
163 * @param callback the method to call for each peer
164 * @param callback_cls closure for callback
165 * @return NULL on error
167 struct GNUNET_PEERINFO_NotifyContext *
168 GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
169 GNUNET_PEERINFO_Processor callback, void *callback_cls);
173 * Stop notifying about changes.
175 * @param nc context to stop notifying
178 GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc);
181 #if 0 /* keep Emacsens' auto-indent happy */
189 /* end of gnunet_peerinfo_service.h */