src/fs/gnunet-service-fs_pe.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @file fs/gnunet-service-fs_pe.h
  21  * @brief API to manage query plan
  22  * @author Christian Grothoff
  23  */
  24 #ifndef GNUNET_SERVICE_FS_PE_H
  25 #define GNUNET_SERVICE_FS_PE_H
  26
  27 #include "gnunet-service-fs.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  */
  36 void
  37 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
  38                struct GSF_PendingRequest *pr);
  39
  40
  41 /**
  42  * Notify the plan about a peer being no longer available;
  43  * destroy all entries associated with this peer.
  44  *
  45  * @param cp connected peer
  46  */
  47 void
  48 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp);
  49
  50
  51 /**
  52  * Notify the plan about a request being done;
  53  * destroy all entries associated with this request.
  54  *
  55  * @param pr request that is done
  56  */
  57 void
  58 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr);
  59
  60 /**
  61  * Get the last transmission attempt time for the request plan list
  62  * referenced by 'rpr_head', that was sent to 'sender'
  63  *
  64  * @param pr_head request plan reference list to check.
  65  * @param sender the peer that we've sent the request to.
  66  * @param result the timestamp to fill.
  67  * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
  68  */
  69 int
  70 GSF_request_plan_reference_get_last_transmission_ (struct GSF_PendingRequestPlanBijection *pr_head,
  71                                                    struct GSF_ConnectedPeer *sender,
  72                                                    struct GNUNET_TIME_Absolute *result);
  73
  74 /**
  75  * Initialize plan subsystem.
  76  */
  77 void
  78 GSF_plan_init (void);
  79
  80
  81 /**
  82  * Shutdown plan subsystem.
  83  */
  84 void
  85 GSF_plan_done (void);
  86
  87
  88 #endif
  89 /* end of gnunet-service-fs_pe.h */