src/fs/gnunet-service-fs_pe.c

   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.c
  23  * @brief API to manage query plan
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-fs_pe.h"
  28
  29
  30 /**
  31  * Create a new query plan entry.
  32  *
  33  * @param cp peer with the entry
  34  * @param pr request with the entry
  35  * @param weight determines position of the entry in the cp queue,
  36  *        lower weights are earlier in the queue
  37  */
  38 void
  39 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
  40                struct GSF_PendingRequest *pr,
  41                double weight)
  42 {
  43  // FIXME
  44 }
  45
  46
  47 /**
  48  * Notify the plan about a peer being no longer available;
  49  * destroy all entries associated with this peer.
  50  *
  51  * @param cp connected peer
  52  */
  53 void
  54 GSF_plan_notify_peer_disconnect_ (struct GSF_ConnectedPeer *cp)
  55 {
  56  // FIXME
  57 }
  58
  59
  60 /**
  61  * Notify the plan about a request being done;
  62  * destroy all entries associated with this request.
  63  *
  64  * @param pr request that is done
  65  */
  66 void
  67 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
  68 {
  69  // FIXME
  70 }
  71
  72
  73 /**
  74  * Get the lowest-weight entry for the respective peer
  75  * from the plan.  Removes the entry from the plan's queue.
  76  *
  77  * @param cp connected peer to query for the next request
  78  * @return NULL if the queue for this peer is empty
  79  */
  80 struct GSF_PendingRequest *
  81 GSF_plan_get_ (struct GSF_ConnectedPeer *cp)
  82 {
  83   return NULL; // FIXME
  84 }
  85
  86
  87 /**
  88  * Get the size of the request queue for the given peer.
  89  *
  90  * @param cp connected peer to query
  91  * @return number of entries in this peer's request queue
  92  */
  93 unsigned int
  94 GSF_plan_size_ (struct GSF_ConnectedPeer *cp)
  95 {
  96   return 0; // FIXME
  97 }
  98
  99
 100
 101 /* end of gnunet-service-fs_pe.h */