9f62ece764c9c4584deb193e50e11db8700957d6
[oweals/gnunet.git] / src / fs / gnunet-service-fs_pe.h
1 /*
2      This file is part of GNUnet.
3      (C) 2011 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file fs/gnunet-service-fs_pe.h
23  * @brief API to manage query plan
24  * @author Christian Grothoff
25  */
26 #ifndef GNUNET_SERVICE_FS_PE_H
27 #define GNUNET_SERVICE_FS_PE_H
28
29 #include "gnunet-service-fs.h"
30
31
32 /**
33  * Create a new query plan entry.
34  *
35  * @param cp peer with the entry
36  * @param pr request with the entry
37  * @param position position of the entry in the cp queue
38  * @return handle for the new plan entry
39  */
40 struct GSF_PlanEntry *
41 GSF_plan_entry_create_ (struct GSF_ConnectedPeer *cp,
42                         struct GSF_PendingRequest *pr,
43                         unsigned int position);
44
45
46 /**
47  * Get the first plan entry for the given connected peer.
48  * FIXME...
49  *
50  * @param cp connected peer 
51  * @return NULL if there is no request planned for this peer
52  */
53 struct GSF_PendingRequest *
54 GSF_plan_get_ (struct GSF_ConnectedPeer *cp);
55
56
57
58 #endif
59 /* end of gnunet-service-fs_pe.h */