GNUnet  0.11.x
Data Fields
GNUNET_FS_SearchContext Struct Reference

Handle for controlling a search. More...

#include </home/handbook/gnunet/src/fs/fs_api.h>

Collaboration diagram for GNUNET_FS_SearchContext:
[legend]

Data Fields

struct GNUNET_FS_Handleh
 Handle to the global FS context. More...
 
struct TopLevelActivitytop
 Our top-level activity entry (if we are top-level, otherwise NULL). More...
 
struct GNUNET_FS_Uriuri
 List of keywords that we're looking for. More...
 
struct GNUNET_FS_SearchResultpsearch_result
 For update-searches, link to the search result that triggered the update search; otherwise NULL. More...
 
struct GNUNET_MQ_Handlemq
 Connection to the FS service. More...
 
void * client_info
 Pointer we keep for the client. More...
 
char * serialization
 Name of the file on disk we use for persistence. More...
 
char * emsg
 Error message (non-NULL if this operation failed). More...
 
struct GNUNET_CONTAINER_MultiHashMapmaster_result_map
 Map that contains a struct GNUNET_FS_SearchResult for each result that was found in the search. More...
 
struct SearchRequestEntryrequests
 Per-keyword information for a keyword search. More...
 
struct GNUNET_TIME_Absolute start_time
 When did we start? More...
 
struct GNUNET_TIME_Relative reconnect_backoff
 How long to wait before we try to reconnect to FS service? More...
 
struct GNUNET_SCHEDULER_Tasktask
 ID of a task that is using this struct and that must be cancelled when the search is being stopped (if not NULL). More...
 
uint32_t anonymity
 Anonymity level for the search. More...
 
uint32_t mandatory_count
 Number of mandatory keywords in this query. More...
 
enum GNUNET_FS_SearchOptions options
 Options for the search. More...
 

Detailed Description

Handle for controlling a search.

Definition at line 1509 of file fs_api.h.

Field Documentation

◆ h

struct GNUNET_FS_Handle* GNUNET_FS_SearchContext::h

◆ top

struct TopLevelActivity* GNUNET_FS_SearchContext::top

Our top-level activity entry (if we are top-level, otherwise NULL).

Definition at line 1519 of file fs_api.h.

Referenced by deserialize_search_file(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_start(), and GNUNET_FS_search_stop().

◆ uri

struct GNUNET_FS_Uri* GNUNET_FS_SearchContext::uri

◆ psearch_result

struct GNUNET_FS_SearchResult* GNUNET_FS_SearchContext::psearch_result

For update-searches, link to the search result that triggered the update search; otherwise NULL.

Definition at line 1530 of file fs_api.h.

Referenced by deserialize_search(), deserialize_search_result(), deserialize_unindex_file(), free_search_context(), GNUNET_FS_search_make_status_(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_stop(), and GNUNET_FS_search_sync_().

◆ mq

struct GNUNET_MQ_Handle* GNUNET_FS_SearchContext::mq

◆ client_info

void* GNUNET_FS_SearchContext::client_info

◆ serialization

char* GNUNET_FS_SearchContext::serialization

◆ emsg

char* GNUNET_FS_SearchContext::emsg

◆ master_result_map

struct GNUNET_CONTAINER_MultiHashMap* GNUNET_FS_SearchContext::master_result_map

Map that contains a struct GNUNET_FS_SearchResult for each result that was found in the search.

The key for each entry is the XOR of the key and query in the CHK URI (as a unique identifier for the search result).

Definition at line 1558 of file fs_api.h.

Referenced by deserialize_search(), deserialize_search_result(), free_search_context(), GNUNET_FS_search_continue(), GNUNET_FS_search_pause(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_start_searching_(), GNUNET_FS_search_stop(), process_ksk_result(), process_sks_result(), schedule_transmit_search_request(), search_start(), and signal_search_resume().

◆ requests

struct SearchRequestEntry* GNUNET_FS_SearchContext::requests

Per-keyword information for a keyword search.

This array will have exactly as many entries as there were keywords.

Definition at line 1564 of file fs_api.h.

Referenced by decrypt_block_with_keyword(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_start_searching_(), GNUNET_FS_search_stop(), process_kblock(), process_ksk_result(), schedule_transmit_search_request(), and update_sre_result_maps().

◆ start_time

struct GNUNET_TIME_Absolute GNUNET_FS_SearchContext::start_time

When did we start?

Definition at line 1569 of file fs_api.h.

Referenced by deserialize_search(), GNUNET_FS_search_make_status_(), and GNUNET_FS_search_sync_().

◆ reconnect_backoff

struct GNUNET_TIME_Relative GNUNET_FS_SearchContext::reconnect_backoff

How long to wait before we try to reconnect to FS service?

Definition at line 1574 of file fs_api.h.

Referenced by try_reconnect().

◆ task

struct GNUNET_SCHEDULER_Task* GNUNET_FS_SearchContext::task

ID of a task that is using this struct and that must be cancelled when the search is being stopped (if not NULL).

Used for the task that adds some artificial delay when trying to reconnect to the FS service.

Definition at line 1582 of file fs_api.h.

Referenced by do_reconnect(), GNUNET_FS_search_continue(), GNUNET_FS_search_pause(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_start_searching_(), GNUNET_FS_search_stop(), GNUNET_FS_search_sync_(), and try_reconnect().

◆ anonymity

uint32_t GNUNET_FS_SearchContext::anonymity

◆ mandatory_count

uint32_t GNUNET_FS_SearchContext::mandatory_count

Number of mandatory keywords in this query.

Definition at line 1592 of file fs_api.h.

Referenced by GNUNET_FS_search_start_searching_(), and process_ksk_result().

◆ options

enum GNUNET_FS_SearchOptions GNUNET_FS_SearchContext::options

Options for the search.

Definition at line 1597 of file fs_api.h.

Referenced by deserialize_search(), GNUNET_FS_search_sync_(), process_sks_result(), reconnect(), and schedule_transmit_search_request().


The documentation for this struct was generated from the following file: