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      SPDX-License-Identifier: AGPL3.0-or-later
  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  */
  38 void
  39 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
  40                struct GSF_PendingRequest *pr);
  41
  42
  43 /**
  44  * Notify the plan about a peer being no longer available;
  45  * destroy all entries associated with this peer.
  46  *
  47  * @param cp connected peer
  48  */
  49 void
  50 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp);
  51
  52
  53 /**
  54  * Notify the plan about a request being done;
  55  * destroy all entries associated with this request.
  56  *
  57  * @param pr request that is done
  58  */
  59 void
  60 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr);
  61
  62 /**
  63  * Get the last transmission attempt time for the request plan list
  64  * referenced by 'rpr_head', that was sent to 'sender'
  65  *
  66  * @param pr_head request plan reference list to check.
  67  * @param sender the peer that we've sent the request to.
  68  * @param result the timestamp to fill.
  69  * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
  70  */
  71 int
  72 GSF_request_plan_reference_get_last_transmission_ (struct
  73                                                    GSF_PendingRequestPlanBijection
  74                                                    *pr_head,
  75                                                    struct GSF_ConnectedPeer *
  76                                                    sender,
  77                                                    struct GNUNET_TIME_Absolute *
  78                                                    result);
  79
  80 /**
  81  * Initialize plan subsystem.
  82  */
  83 void
  84 GSF_plan_init (void);
  85
  86
  87 /**
  88  * Shutdown plan subsystem.
  89  */
  90 void
  91 GSF_plan_done (void);
  92
  93
  94 #endif
  95 /* end of gnunet-service-fs_pe.h */