Handle for controlling a search. More...
#include </home/buildbot/bb-worker/worker/gnunet_firefly/build/src/service/fs/fs_api.h>
Data Fields | |
struct GNUNET_FS_Handle * | h |
Handle to the global FS context. More... | |
struct TopLevelActivity * | top |
Our top-level activity entry (if we are top-level, otherwise NULL). More... | |
struct GNUNET_FS_Uri * | uri |
List of keywords that we're looking for. More... | |
struct GNUNET_FS_SearchResult * | psearch_result |
For update-searches, link to the search result that triggered the update search; otherwise NULL. More... | |
struct GNUNET_MQ_Handle * | mq |
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_MultiHashMap * | master_result_map |
Map that contains a struct GNUNET_FS_SearchResult for each result that was found in the search. More... | |
struct SearchRequestEntry * | requests |
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_Task * | task |
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... | |
struct GNUNET_FS_Handle* GNUNET_FS_SearchContext::h |
Handle to the global FS context.
Definition at line 1515 of file fs_api.h.
Referenced by deserialize_search(), deserialize_search_result(), destroy_storecontext(), do_reconnect(), free_search_context(), GNUNET_FS_search_continue(), GNUNET_FS_search_pause(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_stop(), GNUNET_FS_search_sync_(), GNUNET_PEERSTORE_store(), notify_client_chk_result(), notify_client_chk_update(), process_ksk_result(), process_sks_result(), search_result_stop(), search_result_suspend(), search_start(), signal_result_resume(), and signal_search_resume().
struct TopLevelActivity* GNUNET_FS_SearchContext::top |
Our top-level activity entry (if we are top-level, otherwise NULL).
Definition at line 1520 of file fs_api.h.
Referenced by deserialize_search_file(), GNUNET_FS_search_signal_suspend_(), and GNUNET_FS_search_stop().
struct GNUNET_FS_Uri* GNUNET_FS_SearchContext::uri |
List of keywords that we're looking for.
Definition at line 1525 of file fs_api.h.
Referenced by decrypt_block_with_keyword(), deserialize_search(), deserialize_search_result(), free_search_context(), GNUNET_FS_search_make_status_(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_start_searching_(), GNUNET_FS_search_stop(), GNUNET_FS_search_sync_(), handle_result(), process_ksk_result(), process_sblock(), process_sks_result(), schedule_transmit_search_request(), search_start(), and update_sre_result_maps().
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 1531 of file fs_api.h.
Referenced by deserialize_search(), deserialize_search_result(), free_search_context(), GNUNET_FS_search_make_status_(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_stop(), GNUNET_FS_search_sync_(), and search_start().
struct GNUNET_MQ_Handle* GNUNET_FS_SearchContext::mq |
Connection to the FS service.
Definition at line 1536 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(), schedule_transmit_search_request(), search_mq_error_handler(), signal_search_resume(), and try_reconnect().
void* GNUNET_FS_SearchContext::client_info |
Pointer we keep for the client.
Definition at line 1541 of file fs_api.h.
Referenced by GNUNET_FS_search_continue(), GNUNET_FS_search_make_status_(), GNUNET_FS_search_pause(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_stop(), search_start(), and signal_search_resume().
char* GNUNET_FS_SearchContext::serialization |
Name of the file on disk we use for persistence.
Definition at line 1546 of file fs_api.h.
Referenced by deserialize_search(), deserialize_search_result(), free_search_context(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_stop(), and GNUNET_FS_search_sync_().
char* GNUNET_FS_SearchContext::emsg |
Error message (non-NULL if this operation failed).
Definition at line 1551 of file fs_api.h.
Referenced by deserialize_search(), deserialize_search_result(), free_search_context(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_stop(), GNUNET_FS_search_sync_(), and signal_search_resume().
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 1559 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().
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 1565 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().
struct GNUNET_TIME_Absolute GNUNET_FS_SearchContext::start_time |
When did we start?
Definition at line 1570 of file fs_api.h.
Referenced by deserialize_search(), GNUNET_FS_search_make_status_(), GNUNET_FS_search_sync_(), and search_start().
struct GNUNET_TIME_Relative GNUNET_FS_SearchContext::reconnect_backoff |
How long to wait before we try to reconnect to FS service?
Definition at line 1575 of file fs_api.h.
Referenced by try_reconnect().
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 1583 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().
uint32_t GNUNET_FS_SearchContext::anonymity |
Anonymity level for the search.
Definition at line 1588 of file fs_api.h.
Referenced by deserialize_search(), GNUNET_FS_search_make_status_(), GNUNET_FS_search_sync_(), process_ksk_result(), process_sks_result(), schedule_transmit_search_request(), and search_start().
uint32_t GNUNET_FS_SearchContext::mandatory_count |
Number of mandatory keywords in this query.
Definition at line 1593 of file fs_api.h.
Referenced by GNUNET_FS_search_start_searching_(), and process_ksk_result().
enum GNUNET_FS_SearchOptions GNUNET_FS_SearchContext::options |
Options for the search.
Definition at line 1598 of file fs_api.h.
Referenced by httpdomain.httpdomain.HTTPResource::add_target_and_index(), httpdomain.autohttp.flask_base.AutoflaskBase::blueprints(), deserialize_search(), httpdomain.autohttp.bottle.AutobottleDirective::endpoints(), httpdomain.autohttp.flask_base.AutoflaskBase::endpoints(), httpdomain.autohttp.tornado.AutoTornadoDirective::endpoints(), GNUNET_FS_search_sync_(), GNUNET_PEERSTORE_store(), httpdomain.autohttp.bottle.AutobottleDirective::make_rst(), httpdomain.autohttp.tornado.AutoTornadoDirective::make_rst(), httpdomain.autohttp.flask_base.AutoflaskBase::make_rst(), httpdomain.autohttp.flask_base.AutoflaskBase::modules(), httpdomain.autohttp.flask_base.AutoflaskBase::order(), process_sks_result(), typescriptdomain.TypeScriptDefinition::run(), schedule_transmit_search_request(), search_start(), httpdomain.autohttp.flask_base.AutoflaskBase::undoc_blueprints(), httpdomain.autohttp.bottle.AutobottleDirective::undoc_endpoints(), httpdomain.autohttp.flask_base.AutoflaskBase::undoc_endpoints(), httpdomain.autohttp.tornado.AutoTornadoDirective::undoc_endpoints(), and httpdomain.autohttp.flask_base.AutoflaskBase::undoc_modules().