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 weight determines position of the entry in the cp queue,
  38  *        lower weights are earlier in the queue
  39  */
  40 void
  41 GSF_plan_add_ (const struct GSF_ConnectedPeer *cp,
  42                struct GSF_PendingRequest *pr);
  43
  44
  45 /**
  46  * Notify the plan about a peer being no longer available;
  47  * destroy all entries associated with this peer.
  48  *
  49  * @param cp connected peer
  50  */
  51 void
  52 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp);
  53
  54
  55 /**
  56  * Notify the plan about a request being done;
  57  * destroy all entries associated with this request.
  58  *
  59  * @param pr request that is done
  60  */
  61 void
  62 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr);
  63
  64
  65 /**
  66  * Initialize plan subsystem.
  67  */
  68 void
  69 GSF_plan_init (void);
  70
  71
  72 /**
  73  * Shutdown plan subsystem.
  74  */
  75 void
  76 GSF_plan_done (void);
  77
  78
  79 #endif
  80 /* end of gnunet-service-fs_pe.h */