Information we store for each search result. More...

#include </home/buildbot/bb-worker/worker/gnunet_firefly/build/src/service/fs/fs_api.h>

Collaboration diagram for GNUNET_FS_SearchResult:

Data Fields
struct GNUNET_FS_Handle *	h
	File-sharing context this result belongs to. More...

struct GNUNET_FS_SearchResult *	next
	Kept in a DLL while probing. More...

struct GNUNET_FS_SearchResult *	prev
	Kept in a DLL while probing. More...

struct GNUNET_FS_SearchContext *	sc
	Search context this result belongs to; can be NULL for probes that come from a directory result. More...

struct GNUNET_FS_Uri *	uri
	URI to which this search result refers to. More...

struct GNUNET_FS_MetaData *	meta
	Metadata for the search result. More...

void *	client_info
	Client info for this search result. More...

struct GNUNET_FS_DownloadContext *	probe_ctx
	ID of a job that is currently probing this results' availability (NULL if we are not currently probing). More...

struct GNUNET_FS_DownloadContext *	download
	ID of an associated download based on this search result (or NULL for none). More...

struct GNUNET_FS_SearchContext *	update_search
	If this search result triggered an update search, this field links to the update search. More...

char *	serialization
	Name under which this search result is stored on disk. More...

uint8_t *	keyword_bitmap
	Bitmap that specifies precisely which keywords have been matched already. More...

struct GNUNET_HashCode	key
	Key for the search result based on the URI. More...

struct GNUNET_SCHEDULER_Task *	probe_cancel_task
	ID of the task that will clean up the probe_ctx should it not complete on time (and that will need to be cancelled if we clean up the search result before then). More...

struct GNUNET_TIME_Absolute	probe_active_time
	When did the current probe become active? More...

struct GNUNET_TIME_Relative	remaining_probe_time
	How much longer should we run the current probe before giving up? More...

uint32_t	anonymity
	Anonymity level to use for probes using this search result. More...

uint32_t	mandatory_missing
	Number of mandatory keywords for which we have NOT yet found the search result; when this value hits zero, the search result is given to the callback. More...

uint32_t	optional_support
	Number of optional keywords under which this result was also found. More...

uint32_t	availability_success
	Number of availability tests that have succeeded for this result. More...

uint32_t	availability_trials
	Number of availability trials that we have performed for this search result. More...

Detailed Description

Information we store for each search result.

Definition at line 498 of file fs_api.h.

Field Documentation

◆ h

struct GNUNET_FS_Handle* GNUNET_FS_SearchResult::h

File-sharing context this result belongs to.

Definition at line 503 of file fs_api.h.

Referenced by deserialize_search_result(), GNUNET_FS_probe(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_start_probe_(), GNUNET_FS_stop_probe_ping_task_(), process_ksk_result(), process_sks_result(), search_result_stop(), signal_probe_result(), and start_probe_ping_task().

◆ next

struct GNUNET_FS_SearchResult* GNUNET_FS_SearchResult::next

Kept in a DLL while probing.

Definition at line 508 of file fs_api.h.

◆ prev

struct GNUNET_FS_SearchResult* GNUNET_FS_SearchResult::prev

Kept in a DLL while probing.

Definition at line 513 of file fs_api.h.

◆ sc

struct GNUNET_FS_SearchContext* GNUNET_FS_SearchResult::sc

Search context this result belongs to; can be NULL for probes that come from a directory result.

Definition at line 519 of file fs_api.h.

Referenced by deserialize_search_result(), GNUNET_FS_probe_stop(), GNUNET_FS_search_result_sync_(), process_ksk_result(), process_sks_result(), and signal_probe_result().

◆ uri

struct GNUNET_FS_Uri* GNUNET_FS_SearchResult::uri

URI to which this search result refers to.

Definition at line 524 of file fs_api.h.

Referenced by deserialize_search_result(), free_result(), get_result_present(), GNUNET_FS_download_start_from_search(), GNUNET_FS_probe(), GNUNET_FS_probe_stop(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_start_probe_(), notify_client_chk_result(), notify_client_chk_update(), process_ksk_result(), process_sks_result(), search_result_free(), search_result_stop(), search_result_suspend(), signal_probe_result(), signal_result_resume(), and test_result_present().

◆ meta

struct GNUNET_FS_MetaData* GNUNET_FS_SearchResult::meta

Metadata for the search result.

Definition at line 529 of file fs_api.h.

Referenced by deserialize_search_result(), free_result(), GNUNET_FS_download_start_from_search(), GNUNET_FS_probe(), GNUNET_FS_probe_stop(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_start_probe_(), notify_client_chk_result(), notify_client_chk_update(), process_ksk_result(), process_sks_result(), search_result_free(), search_result_stop(), search_result_suspend(), signal_probe_result(), and signal_result_resume().

◆ client_info

void* GNUNET_FS_SearchResult::client_info

Client info for this search result.

Definition at line 534 of file fs_api.h.

Referenced by GNUNET_FS_download_make_status_(), GNUNET_FS_probe(), GNUNET_FS_probe_stop(), GNUNET_FS_search_make_status_(), notify_client_chk_result(), notify_client_chk_update(), process_ksk_result(), process_sks_result(), search_result_free(), search_result_stop(), search_result_suspend(), signal_probe_result(), and signal_result_resume().

◆ probe_ctx

struct GNUNET_FS_DownloadContext* GNUNET_FS_SearchResult::probe_ctx

ID of a job that is currently probing this results' availability (NULL if we are not currently probing).

Definition at line 540 of file fs_api.h.

Referenced by GNUNET_FS_download_start_from_search(), GNUNET_FS_search_start_probe_(), GNUNET_FS_search_stop_probe_(), probe_failure_handler(), probe_success_handler(), search_result_free(), and search_result_freeze_probes().

◆ download

struct GNUNET_FS_DownloadContext* GNUNET_FS_SearchResult::download

ID of an associated download based on this search result (or NULL for none).

Definition at line 546 of file fs_api.h.

Referenced by deserialize_download(), deserialize_search_result(), GNUNET_FS_download_signal_suspend_(), GNUNET_FS_download_start_from_search(), GNUNET_FS_download_stop(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_start_probe_(), search_result_stop(), search_result_suspend(), and signal_result_resume().

◆ update_search

struct GNUNET_FS_SearchContext* GNUNET_FS_SearchResult::update_search

If this search result triggered an update search, this field links to the update search.

Definition at line 552 of file fs_api.h.

Referenced by deserialize_search(), free_result(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_stop(), search_result_free(), search_result_freeze_probes(), search_result_resume_probes(), search_result_suspend(), search_start(), and signal_result_resume().

◆ serialization

char* GNUNET_FS_SearchResult::serialization

Name under which this search result is stored on disk.

Definition at line 557 of file fs_api.h.

Referenced by deserialize_search_result(), GNUNET_FS_search_result_sync_(), search_result_free(), and search_result_suspend().

◆ keyword_bitmap

uint8_t* GNUNET_FS_SearchResult::keyword_bitmap

Bitmap that specifies precisely which keywords have been matched already.

Definition at line 562 of file fs_api.h.

Referenced by build_result_set(), deserialize_search_result(), find_result_set(), GNUNET_FS_search_result_sync_(), process_ksk_result(), search_result_free(), search_result_suspend(), and update_sre_result_maps().

◆ key

struct GNUNET_HashCode GNUNET_FS_SearchResult::key

Key for the search result based on the URI.

Definition at line 567 of file fs_api.h.

Referenced by gnunet-chk.Chk::__init__(), gnunet-chk.AESKey::__init__(), deserialize_search_result(), GNUNET_FS_search_result_sync_(), process_ksk_result(), process_sks_result(), update_sre_result_maps(), and gnunet-chk.Chk::uri().

◆ probe_cancel_task

struct GNUNET_SCHEDULER_Task* GNUNET_FS_SearchResult::probe_cancel_task

ID of the task that will clean up the probe_ctx should it not complete on time (and that will need to be cancelled if we clean up the search result before then).

Definition at line 574 of file fs_api.h.

Referenced by GNUNET_FS_search_probe_progress_(), GNUNET_FS_search_stop_probe_(), probe_failure_handler(), probe_success_handler(), search_result_free(), and search_result_freeze_probes().

◆ probe_active_time

struct GNUNET_TIME_Absolute GNUNET_FS_SearchResult::probe_active_time

When did the current probe become active?

Definition at line 579 of file fs_api.h.

Referenced by GNUNET_FS_search_probe_progress_(), notify_client_chk_update(), and signal_probe_result().

◆ remaining_probe_time

struct GNUNET_TIME_Relative GNUNET_FS_SearchResult::remaining_probe_time

How much longer should we run the current probe before giving up?

Definition at line 584 of file fs_api.h.

Referenced by GNUNET_FS_search_probe_progress_(), and GNUNET_FS_search_start_probe_().

◆ anonymity

uint32_t GNUNET_FS_SearchResult::anonymity

Anonymity level to use for probes using this search result.

Definition at line 589 of file fs_api.h.

Referenced by GNUNET_FS_probe(), GNUNET_FS_search_start_probe_(), process_ksk_result(), and process_sks_result().

◆ mandatory_missing

uint32_t GNUNET_FS_SearchResult::mandatory_missing

Number of mandatory keywords for which we have NOT yet found the search result; when this value hits zero, the search result is given to the callback.

Definition at line 596 of file fs_api.h.

Referenced by deserialize_search_result(), GNUNET_FS_search_result_sync_(), process_ksk_result(), process_sks_result(), search_result_stop(), search_result_suspend(), and signal_result_resume().

◆ optional_support

uint32_t GNUNET_FS_SearchResult::optional_support

Number of optional keywords under which this result was also found.

Definition at line 602 of file fs_api.h.

Referenced by deserialize_search_result(), GNUNET_FS_search_result_sync_(), notify_client_chk_result(), notify_client_chk_update(), process_ksk_result(), signal_probe_result(), and signal_result_resume().

◆ availability_success

uint32_t GNUNET_FS_SearchResult::availability_success

Number of availability tests that have succeeded for this result.

Definition at line 607 of file fs_api.h.

Referenced by deserialize_search_result(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_start_probe_(), notify_client_chk_update(), probe_success_handler(), signal_probe_result(), and signal_result_resume().

◆ availability_trials

uint32_t GNUNET_FS_SearchResult::availability_trials

Number of availability trials that we have performed for this search result.

Definition at line 613 of file fs_api.h.

Referenced by deserialize_search_result(), GNUNET_FS_search_result_sync_(), GNUNET_FS_search_start_probe_(), notify_client_chk_update(), probe_failure_handler(), probe_success_handler(), signal_probe_result(), and signal_result_resume().

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

src/service/fs/fs_api.h

Data Fields