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
  16 /**
  17  * @file fs/gnunet-service-fs_pe.h
  18  * @brief API to manage query plan
  19  * @author Christian Grothoff
  20  */
  21 #ifndef GNUNET_SERVICE_FS_PE_H
  22 #define GNUNET_SERVICE_FS_PE_H
  23
  24 #include "gnunet-service-fs.h"
  25
  26
  27 /**
  28  * Create a new query plan entry.
  29  *
  30  * @param cp peer with the entry
  31  * @param pr request with the entry
  32  */
  33 void
  34 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
  35                struct GSF_PendingRequest *pr);
  36
  37
  38 /**
  39  * Notify the plan about a peer being no longer available;
  40  * destroy all entries associated with this peer.
  41  *
  42  * @param cp connected peer
  43  */
  44 void
  45 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp);
  46
  47
  48 /**
  49  * Notify the plan about a request being done;
  50  * destroy all entries associated with this request.
  51  *
  52  * @param pr request that is done
  53  */
  54 void
  55 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr);
  56
  57 /**
  58  * Get the last transmission attempt time for the request plan list
  59  * referenced by 'rpr_head', that was sent to 'sender'
  60  *
  61  * @param pr_head request plan reference list to check.
  62  * @param sender the peer that we've sent the request to.
  63  * @param result the timestamp to fill.
  64  * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
  65  */
  66 int
  67 GSF_request_plan_reference_get_last_transmission_ (struct GSF_PendingRequestPlanBijection *pr_head,
  68                                                    struct GSF_ConnectedPeer *sender,
  69                                                    struct GNUNET_TIME_Absolute *result);
  70
  71 /**
  72  * Initialize plan subsystem.
  73  */
  74 void
  75 GSF_plan_init (void);
  76
  77
  78 /**
  79  * Shutdown plan subsystem.
  80  */
  81 void
  82 GSF_plan_done (void);
  83
  84
  85 #endif
  86 /* end of gnunet-service-fs_pe.h */