2 This file is part of GNUnet.
3 (C) 2011 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.
22 * @file fs/gnunet-service-fs_cp.h
23 * @brief API to handle 'connected peers'
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_FS_CP_H
27 #define GNUNET_SERVICE_FS_CP_H
29 #include "gnunet-service-fs.h"
33 * Performance data kept for a peer.
35 struct GSF_PeerPerformanceData
39 * Transport performance data.
41 struct GNUNET_TRANSPORT_ATS_Information *atsi;
44 * List of the last clients for which this peer successfully
47 struct GSF_LocalClient *last_client_replies[CS2P_SUCCESS_LIST_SIZE];
50 * List of the last PIDs for which
51 * this peer successfully answered a query;
52 * We use 0 to indicate no successful reply.
54 GNUNET_PEER_Id last_p2p_replies[P2P_SUCCESS_LIST_SIZE];
57 * Average delay between sending the peer a request and
58 * getting a reply (only calculated over the requests for
59 * which we actually got a reply). Calculated
60 * as a moving average: new_delay = ((n-1)*last_delay+curr_delay) / n
62 struct GNUNET_TIME_Relative avg_reply_delay;
65 * Point in time until which this peer does not want us to migrate content
68 struct GNUNET_TIME_Absolute migration_blocked_until;
71 * Transmission times for the last MAX_QUEUE_PER_PEER
72 * requests for this peer. Used as a ring buffer, current
73 * offset is stored in 'last_request_times_off'. If the
74 * oldest entry is more recent than the 'avg_delay', we should
75 * not send any more requests right now.
77 struct GNUNET_TIME_Absolute last_request_times[MAX_QUEUE_PER_PEER];
80 * How long does it typically take for us to transmit a message
81 * to this peer? (delay between the request being issued and
82 * the callback being invoked).
84 struct GNUNET_LOAD_Value *transmission_delay;
87 * Average priority of successful replies. Calculated
88 * as a moving average: new_avg = ((n-1)*last_avg+curr_prio) / n
93 * Trust rating for this peer
98 * Number of pending queries (replies are not counted)
100 unsigned int pending_queries;
103 * Number of pending replies (queries are not counted)
105 unsigned int pending_replies;
111 * Signature of function called on a connected peer.
114 * @param peer identity of the peer
115 * @param cp handle to the connected peer record
116 * @param perf peer performance data
118 typedef void (*GSF_ConnectedPeerIterator)(void *cls,
119 const struct GNUNET_PeerIdentity *peer,
120 struct GSF_ConnectedPeer *cp,
121 const struct GSF_PeerPerformanceData *ppd);
125 * Function called to get a message for transmission.
128 * @param buf_size number of bytes available in buf
129 * @param buf where to copy the message, NULL on error (peer disconnect)
130 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
132 typedef size_t (*GSF_GetMessageCallback)(void *cls,
138 * Signature of function called on a reservation success or failure.
141 * @param cp handle to the connected peer record
142 * @param success GNUNET_YES on success, GNUNET_NO on failure
144 typedef void (*GSF_PeerReserveCallback)(void *cls,
145 struct GSF_ConnectedPeer *cp,
150 * Handle to cancel a transmission request.
152 struct GSF_PeerTransmitHandle;
156 * A peer connected to us. Setup the connected peer
159 * @param peer identity of peer that connected
160 * @param atsi performance data for the connection
161 * @return handle to connected peer entry
163 struct GSF_ConnectedPeer *
164 GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
165 const struct GNUNET_TRANSPORT_ATS_Information *atsi);
169 * Transmit a message to the given peer as soon as possible.
170 * If the peer disconnects before the transmission can happen,
171 * the callback is invoked with a 'NULL' buffer.
173 * @param peer target peer
174 * @param is_query is this a query (GNUNET_YES) or content (GNUNET_NO)
175 * @param priority how important is this request?
176 * @param timeout when does this request timeout (call gmc with error)
177 * @param size number of bytes we would like to send to the peer
178 * @param gmc function to call to get the message
179 * @param gmc_cls closure for gmc
180 * @return handle to cancel request
182 struct GSF_PeerTransmitHandle *
183 GSF_peer_transmit_ (struct GSF_ConnectedPeer *peer,
186 struct GNUNET_TIME_Relative timeout,
188 GSF_GetMessageCallback gmc,
193 * Cancel an earlier request for transmission.
195 * @param pth request to cancel
198 GSF_peer_transmit_cancel_ (struct GSF_PeerTransmitHandle *pth);
202 * Report on receiving a reply; update the performance record of the given peer.
204 * @param cp responding peer (will be updated)
205 * @param request_time time at which the original query was transmitted
206 * @param request_priority priority of the original request
209 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
210 struct GNUNET_TIME_Absolute request_time,
211 uint32_t request_priority);
215 * Report on receiving a reply in response to an initiating client.
216 * Remember that this peer is good for this client.
218 * @param cp responding peer (will be updated)
219 * @param initiator_client local client on responsible for query
222 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
223 const struct GSF_LocalClient *initiator_client);
227 * Report on receiving a reply in response to an initiating peer.
228 * Remember that this peer is good for this initiating peer.
230 * @param cp responding peer (will be updated)
231 * @param initiator_peer other peer responsible for query
234 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
235 const struct GSF_ConnectedPeer *initiator_peer);
239 * Method called whenever a given peer has a status change.
242 * @param peer peer identity this notification is about
243 * @param bandwidth_in available amount of inbound bandwidth
244 * @param bandwidth_out available amount of outbound bandwidth
245 * @param timeout absolute time when this peer will time out
246 * unless we see some further activity from it
247 * @param atsi status information
250 GSF_peer_status_handler_ (void *cls,
251 const struct GNUNET_PeerIdentity *peer,
252 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
253 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
254 struct GNUNET_TIME_Absolute timeout,
255 const struct GNUNET_TRANSPORT_ATS_Information *atsi);
259 * Handle P2P "MIGRATION_STOP" message.
261 * @param cls closure, always NULL
262 * @param other the other peer involved (sender or receiver, NULL
263 * for loopback messages where we are both sender and receiver)
264 * @param message the actual message
265 * @param atsi performance information
266 * @return GNUNET_OK to keep the connection open,
267 * GNUNET_SYSERR to close it (signal serious error)
270 GSF_handle_p2p_migration_stop_ (void *cls,
271 const struct GNUNET_PeerIdentity *other,
272 const struct GNUNET_MessageHeader *message,
273 const struct GNUNET_TRANSPORT_ATS_Information *atsi);
277 * Handle P2P "QUERY" message. Only responsible for creating the
278 * request entry itself and setting up reply callback and cancellation
279 * on peer disconnect. Does NOT execute the actual request strategy
280 * (planning) or local database operations.
282 * @param other the other peer involved (sender or receiver, NULL
283 * for loopback messages where we are both sender and receiver)
284 * @param message the actual message
285 * @return pending request handle, NULL on error
287 struct GSF_PendingRequest *
288 GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
289 const struct GNUNET_MessageHeader *message);
293 * Return the performance data record for the given peer
295 * @param cp peer to query
296 * @return performance data record for the peer
298 struct GSF_PeerPerformanceData *
299 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp);
303 * Ask a peer to stop migrating data to us until the given point
306 * @param cp peer to ask
307 * @param block_time until when to block
310 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
311 struct GNUNET_TIME_Relative block_time);
315 * A peer disconnected from us. Tear down the connected peer
319 * @param peer identity of peer that connected
322 GSF_peer_disconnect_handler_ (void *cls,
323 const struct GNUNET_PeerIdentity *peer);
327 * Notification that a local client disconnected. Clean up all of our
328 * references to the given handle.
330 * @param lc handle to the local client (henceforth invalid)
333 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc);
337 * Notify core about a preference we have for the given peer
338 * (to allocate more resources towards it). The change will
339 * be communicated the next time we reserve bandwidth with
340 * core (not instantly).
342 * @param cp peer to reserve bandwidth from
343 * @param pref preference change
346 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
351 * Obtain the identity of a connected peer.
353 * @param cp peer to reserve bandwidth from
354 * @param id identity to set (written to)
357 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
358 struct GNUNET_PeerIdentity *id);
362 * Iterate over all connected peers.
364 * @param it function to call for each peer
365 * @param it_cls closure for it
368 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
373 * Initialize peer management subsystem.
375 * @param cfg configuration to use
378 GSF_connected_peer_init_ (struct GNUNET_CONFIGURATION_Handle *cfg);
382 * Shutdown peer management subsystem.
385 GSF_connected_peer_done_ (void);
389 /* end of gnunet-service-fs_cp.h */