gnunet-service-fs_pr.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009, 2010, 2011 GNUnet e.V.

     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.

     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.

     SPDX-License-Identifier: AGPL3.0-or-later
 */

#ifndef GNUNET_SERVICE_FS_PR_H
#define GNUNET_SERVICE_FS_PR_H

#include "gnunet-service-fs.h"


enum GSF_PendingRequestOptions
{
  GSF_PRO_DEFAULTS = 0,

  GSF_PRO_LOCAL_ONLY = 1,

  GSF_PRO_FORWARD_ONLY = 2,

  GSF_PRO_REQUEST_NEVER_EXPIRES = 4,

  GSF_PRO_BLOOMFILTER_FULL_REFRESH = 8,

  GSF_PRO_PRIORITY_UNLIMITED = 16,

  GSF_PRO_LOCAL_REQUEST =
    (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED
     | GSF_PRO_REQUEST_NEVER_EXPIRES)
};


struct GSF_PendingRequestData
{
  struct GNUNET_HashCode query;

  const struct GNUNET_PeerIdentity *target;

  struct GSF_PendingRequestPlanBijection *pr_head;

  struct GSF_PendingRequestPlanBijection *pr_tail;

  struct GNUNET_TIME_Absolute ttl;

  struct GNUNET_TIME_Absolute start_time;

  uint32_t anonymity_level;

  uint32_t priority;

  uint32_t original_priority;

  uint32_t num_transmissions;

  uint32_t respect_offered;

  enum GSF_PendingRequestOptions options;

  enum GNUNET_BLOCK_Type type;

  unsigned int results_found;

  int has_started;
};


typedef void
(*GSF_PendingRequestReplyHandler) (void *cls,
                                   enum GNUNET_BLOCK_EvaluationResult eval,
                                   struct GSF_PendingRequest *pr,
                                   uint32_t reply_anonymity_level,
                                   struct GNUNET_TIME_Absolute expiration,
                                   struct GNUNET_TIME_Absolute
                                   last_transmission,
                                   enum GNUNET_BLOCK_Type type,
                                   const void *data,
                                   size_t data_len);


struct GSF_PendingRequest *
GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
                             enum GNUNET_BLOCK_Type type,
                             const struct GNUNET_HashCode *query,
                             const struct GNUNET_PeerIdentity *target,
                             const char *bf_data,
                             size_t bf_size,
                             uint32_t mingle,
                             uint32_t anonymity_level,
                             uint32_t priority,
                             int32_t ttl,
                             GNUNET_PEER_Id sender_pid,
                             GNUNET_PEER_Id origin_pid,
                             const struct GNUNET_HashCode *replies_seen,
                             unsigned int replies_seen_count,
                             GSF_PendingRequestReplyHandler rh,
                             void *rh_cls);


void
GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
                             const struct GNUNET_HashCode *replies_seen,
                             unsigned int replies_seen_count);


struct GSF_PendingRequestData *
GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr);


int
GSF_pending_request_test_active_ (struct GSF_PendingRequest *pr);


int
GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
                                    struct GSF_PendingRequest *prb);


struct GNUNET_MQ_Envelope *
GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr);


void
GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr,
                             int full_cleanup);


typedef int
(*GSF_PendingRequestIterator) (void *cls,
                               const struct GNUNET_HashCode *key,
                               struct GSF_PendingRequest *pr);


void
GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
                               void *cls);


void
handle_p2p_put (void *cls,
                const struct PutMessage *put);


void
GSF_dht_lookup_ (struct GSF_PendingRequest *pr);


void
GSF_cadet_lookup_ (struct GSF_PendingRequest *pr);


typedef void
(*GSF_LocalLookupContinuation) (void *cls,
                                struct GSF_PendingRequest *pr,
                                enum GNUNET_BLOCK_EvaluationResult result);


void
GSF_local_lookup_ (struct GSF_PendingRequest *pr,
                   GSF_LocalLookupContinuation cont,
                   void *cont_cls);


int
GSF_pending_request_test_target_ (struct GSF_PendingRequest *pr,
                                  const struct GNUNET_PeerIdentity *target);


void
GSF_pending_request_init_ (void);


void
GSF_pending_request_done_ (void);


#endif
/* end of gnunet-service-fs_pr.h */