2 This file is part of GNUnet.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file rps/gnunet-service-rps_peers.h
23 * @brief utilities for managing (information about) peers
24 * @author Julius Bünger
26 #include "gnunet_util_lib.h"
28 #include "gnunet_cadet_service.h"
32 * Different flags indicating the status of another peer.
37 * If we are waiting for a reply from that peer (sent a pull request).
39 Peers_PULL_REPLY_PENDING = 0x01,
41 /* IN_OTHER_GOSSIP_LIST = 0x02, unneeded? */
42 /* IN_OWN_SAMPLER_LIST = 0x04, unneeded? */
43 /* IN_OWN_GOSSIP_LIST = 0x08, unneeded? */
46 * We set this bit when we know the peer is online.
51 * We set this bit when we are going to destroy the channel to this peer.
52 * When cleanup_channel is called, we know that we wanted to destroy it.
53 * Otherwise the channel to the other peer was destroyed.
55 Peers_TO_DESTROY = 0x40,
59 * Keep track of the status of a channel.
61 * This is needed in order to know what to do with a channel when it's
64 enum Peers_ChannelFlags
67 * We destroyed the channel because the other peer established a second one.
69 Peers_CHANNEL_ESTABLISHED_TWICE = 0x1,
72 * The channel was removed because it was not needed any more. This should be
73 * the sending channel.
75 Peers_CHANNEL_CLEAN = 0x2,
79 * @brief The role of a channel. Sending or receiving.
81 enum Peers_ChannelRole
84 * Channel is used for sending
86 Peers_CHANNEL_ROLE_SENDING = 0x01,
89 * Channel is used for receiving
91 Peers_CHANNEL_ROLE_RECEIVING = 0x02,
95 * @brief Functions of this type can be used to be stored at a peer for later execution.
98 * @param peer peer to execute function on
100 typedef void (* PeerOp) (void *cls, const struct GNUNET_PeerIdentity *peer);
103 * @brief Iterator over valid peers.
106 * @param peer current public peer id
107 * @return #GNUNET_YES if we should continue to
112 (*PeersIterator) (void *cls,
113 const struct GNUNET_PeerIdentity *peer);
116 * @brief Initialise storage of peers
118 * @param fn_valid_peers filename of the file used to store valid peer ids
119 * @param cadet_h cadet handle
120 * @param own_id own peer identity
123 Peers_initialise (char* fn_valid_peers,
124 struct GNUNET_CADET_Handle *cadet_h,
125 const struct GNUNET_PeerIdentity *own_id);
128 * @brief Delete storage of peers that was created with #Peers_initialise ()
135 * @brief Get all currently known, valid peer ids.
137 * @param it function to call on each peer id
138 * @param it_cls extra argument to @a it
139 * @return the number of key value pairs processed,
140 * #GNUNET_SYSERR if it aborted iteration
143 Peers_get_valid_peers (PeersIterator iterator,
147 * @brief Add peer to known peers.
149 * This function is called on new peer_ids from 'external' sources
150 * (client seed, cadet get_peers(), ...)
152 * @param peer the new #GNUNET_PeerIdentity
154 * @return #GNUNET_YES if peer was inserted
155 * #GNUNET_NO otherwise (if peer was already known or
156 * peer was #own_identity)
159 Peers_insert_peer (const struct GNUNET_PeerIdentity *peer);
162 * @brief Try connecting to a peer to see whether it is online
164 * If not known yet, insert into known peers
166 * @param peer the peer whose liveliness is to be checked
167 * @return #GNUNET_YES if peer had to be inserted
168 * #GNUNET_NO otherwise (if peer was already known or
169 * peer was #own_identity)
172 Peers_issue_peer_liveliness_check (const struct GNUNET_PeerIdentity *peer);
175 * @brief Check if peer is removable.
178 * - a recv channel exists
179 * - there are pending messages
180 * - there is no pending pull reply
182 * @param peer the peer in question
183 * @return #GNUNET_YES if peer is removable
184 * #GNUNET_NO if peer is NOT removable
185 * #GNUNET_SYSERR if peer is not known
188 Peers_check_removable (const struct GNUNET_PeerIdentity *peer);
193 * @param peer the peer to clean
194 * @return #GNUNET_YES if peer was removed
195 * #GNUNET_NO otherwise
198 Peers_remove_peer (const struct GNUNET_PeerIdentity *peer);
201 * @brief set flags on a given peer.
203 * @param peer the peer to set flags on
204 * @param flags the flags
207 Peers_set_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
210 * @brief unset flags on a given peer.
212 * @param peer the peer to unset flags on
213 * @param flags the flags
216 Peers_unset_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
219 * @brief Check whether flags on a peer are set.
221 * @param peer the peer to check the flag of
222 * @param flags the flags to check
224 * @return #GNUNET_YES if all given flags are set
225 * ##GNUNET_NO otherwise
228 Peers_check_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
232 * @brief set flags on a given channel.
234 * @param channel the channel to set flags on
235 * @param flags the flags
238 Peers_set_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
241 * @brief unset flags on a given channel.
243 * @param channel the channel to unset flags on
244 * @param flags the flags
247 Peers_unset_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
250 * @brief Check whether flags on a channel are set.
252 * @param channel the channel to check the flag of
253 * @param flags the flags to check
255 * @return #GNUNET_YES if all given flags are set
256 * #GNUNET_NO otherwise
259 Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
262 * @brief Check whether we have information about the given peer.
264 * FIXME probably deprecated. Make this the new _online.
266 * @param peer peer in question
268 * @return #GNUNET_YES if peer is known
269 * #GNUNET_NO if peer is not knwon
272 Peers_check_peer_known (const struct GNUNET_PeerIdentity *peer);
275 * @brief Check whether @a peer is actually a peer.
277 * A valid peer is a peer that we know exists eg. we were connected to once.
279 * @param peer peer in question
281 * @return #GNUNET_YES if peer is valid
282 * #GNUNET_NO if peer is not valid
285 Peers_check_peer_valid (const struct GNUNET_PeerIdentity *peer);
288 * @brief Indicate that we want to send to the other peer
290 * This establishes a sending channel
292 * @param peer the peer to establish channel to
295 Peers_indicate_sending_intention (const struct GNUNET_PeerIdentity *peer);
298 * @brief Check whether other peer has the intention to send/opened channel
301 * @param peer the peer in question
303 * @return #GNUNET_YES if peer has the intention to send
304 * #GNUNET_NO otherwise
307 Peers_check_peer_send_intention (const struct GNUNET_PeerIdentity *peer);
310 * Handle the channel a peer opens to us.
312 * @param cls The closure
313 * @param channel The channel the peer wants to establish
314 * @param initiator The peer's peer ID
315 * @param port The port the channel is being established over
316 * @param options Further options
318 * @return initial channel context for the channel
319 * (can be NULL -- that's not an error)
322 Peers_handle_inbound_channel (void *cls,
323 struct GNUNET_CADET_Channel *channel,
324 const struct GNUNET_PeerIdentity *initiator,
325 const struct GNUNET_HashCode *port,
326 enum GNUNET_CADET_ChannelOption options);
329 * @brief Check whether a sending channel towards the given peer exists
331 * @param peer the peer to check for
333 * @return #GNUNET_YES if a sending channel towards that peer exists
334 * #GNUNET_NO otherwise
337 Peers_check_sending_channel_exists (const struct GNUNET_PeerIdentity *peer);
340 * @brief check whether the given channel is the sending channel of the given
343 * @param peer the peer in question
344 * @param channel the channel to check for
345 * @param role either #Peers_CHANNEL_ROLE_SENDING, or
346 * #Peers_CHANNEL_ROLE_RECEIVING
348 * @return #GNUNET_YES if the given chennel is the sending channel of the peer
349 * #GNUNET_NO otherwise
352 Peers_check_channel_role (const struct GNUNET_PeerIdentity *peer,
353 const struct GNUNET_CADET_Channel *channel,
354 enum Peers_ChannelRole role);
357 * @brief Destroy the send channel of a peer e.g. stop indicating a sending
358 * intention to another peer
360 * If there is also no channel to receive messages from that peer, remove it
363 * @peer the peer identity of the peer whose sending channel to destroy
364 * @return #GNUNET_YES if channel was destroyed
365 * #GNUNET_NO otherwise
368 Peers_destroy_sending_channel (const struct GNUNET_PeerIdentity *peer);
371 * This is called when a channel is destroyed.
373 * Removes peer completely from our knowledge if the send_channel was destroyed
374 * Otherwise simply delete the recv_channel
376 * @param cls The closure
377 * @param channel The channel being closed
378 * @param channel_ctx The context associated with this channel
381 Peers_cleanup_destroyed_channel (void *cls,
382 const struct GNUNET_CADET_Channel *channel,
386 * @brief Send a message to another peer.
388 * Keeps track about pending messages so they can be properly removed when the
391 * @param peer receeiver of the message
392 * @param ev envelope of the message
393 * @param type type of the message
396 Peers_send_message (const struct GNUNET_PeerIdentity *peer,
397 struct GNUNET_MQ_Envelope *ev,
401 * @brief Schedule a operation on given peer
403 * Avoids scheduling an operation twice.
405 * @param peer the peer we want to schedule the operation for once it gets live
407 * @return #GNUNET_YES if the operation was scheduled
408 * #GNUNET_NO otherwise
411 Peers_schedule_operation (const struct GNUNET_PeerIdentity *peer,
412 const PeerOp peer_op);
414 /* end of gnunet-service-rps_peers.h */