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_pe.h
23 * @brief API to manage query plan
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_FS_PE_H
27 #define GNUNET_SERVICE_FS_PE_H
29 #include "gnunet-service-fs.h"
33 * Create a new query plan entry.
35 * @param cp peer with the entry
36 * @param pr request with the entry
37 * @param weight determines position of the entry in the cp queue,
38 * lower weights are earlier in the queue
41 GSF_plan_add_ (const struct GSF_ConnectedPeer *cp,
42 struct GSF_PendingRequest *pr,
43 GNUNET_CONTAINER_HeapCostType weight);
47 * Notify the plan about a peer being no longer available;
48 * destroy all entries associated with this peer.
50 * @param cp connected peer
53 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp);
57 * Notify the plan about a request being done;
58 * destroy all entries associated with this request.
60 * @param pr request that is done
63 GSF_plan_notify_request_done_ (const struct GSF_PendingRequest *pr);
67 * Get the lowest-weight entry for the respective peer
68 * from the plan. Removes the entry from the plan's queue.
70 * @param cp connected peer to query for the next request
71 * @return NULL if the queue for this peer is empty
73 struct GSF_PendingRequest *
74 GSF_plan_get_ (const struct GSF_ConnectedPeer *cp);
78 * Get the size of the request queue for the given peer.
80 * @param cp connected peer to query
81 * @return number of entries in this peer's request queue
84 GSF_plan_size_ (const struct GSF_ConnectedPeer *cp);
88 * Initialize plan subsystem.
95 * Shutdown plan subsystem.
102 /* end of gnunet-service-fs_pe.h */