2 This file is part of GNUnet
3 Copyright (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);
62 * Disconnect from the peerinfo service. Note that all iterators must
63 * have completed or have been cancelled by the time this function is
64 * called (otherwise, calling this function is a serious error).
65 * Furthermore, if #GNUNET_PEERINFO_add_peer() operations are still
66 * pending, they will be cancelled silently on disconnect.
68 * @param h handle to disconnect
71 GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h);
75 * Continuation called with a status result.
78 * @param emsg error message, NULL on success
81 (*GNUNET_PEERINFO_Continuation)(void *cls,
86 * Opaque handle to cancel 'add' operation.
88 struct GNUNET_PEERINFO_AddContext;
92 * Add a host to the persistent list. This method operates in
93 * semi-reliable mode: if the transmission is not completed by
94 * the time #GNUNET_PEERINFO_disconnect() is called, it will be
95 * aborted. Furthermore, if a second HELLO is added for the
96 * same peer before the first one was transmitted, PEERINFO may
97 * merge the two HELLOs prior to transmission to the service.
99 * @param h handle to the peerinfo service
100 * @param hello the verified (!) HELLO message
101 * @param cont continuation to call when done, NULL is allowed
102 * @param cont_cls closure for @a cont
103 * @return handle to cancel add operation; all pending
104 * 'add' operations will be cancelled automatically
105 * on disconnect, so it is not necessary to keep this
106 * handle (unless @a cont is NULL and at some point
107 * calling @a cont must be prevented)
109 struct GNUNET_PEERINFO_AddContext *
110 GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
111 const struct GNUNET_HELLO_Message *hello,
112 GNUNET_PEERINFO_Continuation cont,
117 * Cancel pending 'add' operation. Must only be called before
118 * either 'cont' or #GNUNET_PEERINFO_disconnect() are invoked.
120 * @param ac handle for the add operation to cancel
123 GNUNET_PEERINFO_add_peer_cancel (struct GNUNET_PEERINFO_AddContext *ac);
127 * Type of an iterator over the hosts. Note that each
128 * host will be called with each available protocol.
131 * @param peer id of the peer, NULL for last call
132 * @param hello hello message for the peer (can be NULL)
133 * @param error message
136 (*GNUNET_PEERINFO_Processor) (void *cls,
137 const struct GNUNET_PeerIdentity *peer,
138 const struct GNUNET_HELLO_Message *hello,
139 const char *err_msg);
143 * Handle for cancellation of iteration over peers.
145 struct GNUNET_PEERINFO_IteratorContext;
149 * Call a method for each known matching host. The callback method
150 * will be invoked once for each matching host and then finally once
151 * with a NULL pointer. After that final invocation, the iterator
152 * context must no longer be used.
154 * Instead of calling this function with `peer == NULL` it is often
155 * better to use #GNUNET_PEERINFO_notify().
157 * @param h handle to the peerinfo service
158 * @param include_friend_only include HELLO messages for friends only
159 * @param peer restrict iteration to this peer only (can be NULL)
160 * @param timeout how long to wait until timing out
161 * @param callback the method to call for each peer
162 * @param callback_cls closure for @a callback
163 * @return iterator context
165 struct GNUNET_PEERINFO_IteratorContext *
166 GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
167 int include_friend_only,
168 const struct GNUNET_PeerIdentity *peer,
169 struct GNUNET_TIME_Relative timeout,
170 GNUNET_PEERINFO_Processor callback, void *callback_cls);
174 * Cancel an iteration over peer information.
176 * @param ic context of the iterator to cancel
179 GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic);
183 * Handle for notifications about changes to the set of known peers.
185 struct GNUNET_PEERINFO_NotifyContext;
189 * Call a method whenever our known information about peers
190 * changes. Initially calls the given function for all known
191 * peers and then only signals changes.
193 * If include_friend_only is set to GNUNET_YES peerinfo will include HELLO
194 * messages which are intended for friend to friend mode and which do not
195 * have to be gossiped. Otherwise these messages are skipped.
197 * @param cfg configuration to use
198 * @param include_friend_only include HELLO messages for friends only
199 * @param callback the method to call for each peer
200 * @param callback_cls closure for @a callback
201 * @return NULL on error
203 struct GNUNET_PEERINFO_NotifyContext *
204 GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
205 int include_friend_only,
206 GNUNET_PEERINFO_Processor callback,
211 * Stop notifying about changes.
213 * @param nc context to stop notifying
216 GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc);
219 #if 0 /* keep Emacsens' auto-indent happy */
227 /* end of gnunet_peerinfo_service.h */