GNUnet  0.11.x
Data Fields
GNUNET_FS_Handle Struct Reference

Master context for most FS operations. More...

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

Collaboration diagram for GNUNET_FS_Handle:
[legend]

Data Fields

const struct GNUNET_CONFIGURATION_Handlecfg
 Configuration to use. More...
 
char * client_name
 Name of our client. More...
 
GNUNET_FS_ProgressCallback upcb
 Function to call with updates on our progress. More...
 
void * upcb_cls
 Closure for upcb. More...
 
struct TopLevelActivitytop_head
 Head of DLL of top-level activities. More...
 
struct TopLevelActivitytop_tail
 Tail of DLL of top-level activities. More...
 
struct GNUNET_FS_QueueEntryrunning_head
 Head of DLL of running jobs. More...
 
struct GNUNET_FS_QueueEntryrunning_tail
 Tail of DLL of running jobs. More...
 
struct GNUNET_FS_QueueEntrypending_head
 Head of DLL of pending jobs. More...
 
struct GNUNET_FS_QueueEntrypending_tail
 Tail of DLL of pending jobs. More...
 
struct GNUNET_FS_SearchResultprobes_head
 Head of active probes. More...
 
struct GNUNET_FS_SearchResultprobes_tail
 Tail of active probes. More...
 
struct GNUNET_SCHEDULER_Taskqueue_job
 Task that processes the jobs in the running and pending queues (and moves jobs around as needed). More...
 
struct GNUNET_SCHEDULER_Taskprobe_ping_task
 Task we use to report periodically to the application that certain search probes (from probes_head) are still running. More...
 
struct GNUNET_TIME_Relative avg_block_latency
 Average time we take for a single request to be satisfied. More...
 
unsigned int active_downloads
 How many actual downloads do we have running right now? More...
 
unsigned int active_blocks
 How many blocks do the active downloads have? More...
 
enum GNUNET_FS_Flags flags
 General flags. More...
 
unsigned int max_parallel_downloads
 Maximum number of parallel downloads. More...
 
unsigned int max_parallel_requests
 Maximum number of parallel requests. More...
 

Detailed Description

Master context for most FS operations.

Definition at line 1071 of file fs_api.h.

Field Documentation

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* GNUNET_FS_Handle::cfg

◆ client_name

char* GNUNET_FS_Handle::client_name

Name of our client.

Definition at line 1081 of file fs_api.h.

Referenced by get_serialization_file_name(), get_serialization_file_name_in_dir(), GNUNET_FS_start(), and GNUNET_FS_stop().

◆ upcb

GNUNET_FS_ProgressCallback GNUNET_FS_Handle::upcb

Function to call with updates on our progress.

Definition at line 1086 of file fs_api.h.

Referenced by GNUNET_FS_download_make_status_(), GNUNET_FS_publish_make_status_(), GNUNET_FS_search_make_status_(), GNUNET_FS_start(), and GNUNET_FS_unindex_make_status_().

◆ upcb_cls

void* GNUNET_FS_Handle::upcb_cls

◆ top_head

struct TopLevelActivity* GNUNET_FS_Handle::top_head

Head of DLL of top-level activities.

Definition at line 1096 of file fs_api.h.

Referenced by GNUNET_FS_end_top(), GNUNET_FS_make_top(), and GNUNET_FS_stop().

◆ top_tail

struct TopLevelActivity* GNUNET_FS_Handle::top_tail

Tail of DLL of top-level activities.

Definition at line 1101 of file fs_api.h.

Referenced by GNUNET_FS_end_top(), and GNUNET_FS_make_top().

◆ running_head

struct GNUNET_FS_QueueEntry* GNUNET_FS_Handle::running_head

Head of DLL of running jobs.

Definition at line 1106 of file fs_api.h.

Referenced by process_job_queue(), start_job(), and stop_job().

◆ running_tail

struct GNUNET_FS_QueueEntry* GNUNET_FS_Handle::running_tail

Tail of DLL of running jobs.

Definition at line 1111 of file fs_api.h.

Referenced by start_job(), and stop_job().

◆ pending_head

struct GNUNET_FS_QueueEntry* GNUNET_FS_Handle::pending_head

Head of DLL of pending jobs.

Definition at line 1116 of file fs_api.h.

Referenced by GNUNET_FS_dequeue_(), GNUNET_FS_queue_(), process_job_queue(), start_job(), and stop_job().

◆ pending_tail

struct GNUNET_FS_QueueEntry* GNUNET_FS_Handle::pending_tail

Tail of DLL of pending jobs.

Definition at line 1121 of file fs_api.h.

Referenced by GNUNET_FS_dequeue_(), GNUNET_FS_queue_(), start_job(), and stop_job().

◆ probes_head

struct GNUNET_FS_SearchResult* GNUNET_FS_Handle::probes_head

Head of active probes.

Definition at line 1126 of file fs_api.h.

Referenced by GNUNET_FS_stop_probe_ping_task_(), probe_ping_task_cb(), and start_probe_ping_task().

◆ probes_tail

struct GNUNET_FS_SearchResult* GNUNET_FS_Handle::probes_tail

Tail of active probes.

Definition at line 1131 of file fs_api.h.

Referenced by GNUNET_FS_stop_probe_ping_task_(), and start_probe_ping_task().

◆ queue_job

struct GNUNET_SCHEDULER_Task* GNUNET_FS_Handle::queue_job

Task that processes the jobs in the running and pending queues (and moves jobs around as needed).

Definition at line 1137 of file fs_api.h.

Referenced by GNUNET_FS_dequeue_(), GNUNET_FS_queue_(), GNUNET_FS_stop(), and process_job_queue().

◆ probe_ping_task

struct GNUNET_SCHEDULER_Task* GNUNET_FS_Handle::probe_ping_task

Task we use to report periodically to the application that certain search probes (from probes_head) are still running.

Definition at line 1143 of file fs_api.h.

Referenced by GNUNET_FS_stop_probe_ping_task_(), probe_ping_task_cb(), and start_probe_ping_task().

◆ avg_block_latency

struct GNUNET_TIME_Relative GNUNET_FS_Handle::avg_block_latency

Average time we take for a single request to be satisfied.

FIXME: not yet calcualted properly...

Definition at line 1149 of file fs_api.h.

Referenced by GNUNET_FS_search_start_probe_(), GNUNET_FS_start(), and process_job_queue().

◆ active_downloads

unsigned int GNUNET_FS_Handle::active_downloads

How many actual downloads do we have running right now?

Definition at line 1154 of file fs_api.h.

Referenced by process_job_queue(), start_job(), and stop_job().

◆ active_blocks

unsigned int GNUNET_FS_Handle::active_blocks

How many blocks do the active downloads have?

Definition at line 1159 of file fs_api.h.

Referenced by process_job_queue(), start_job(), and stop_job().

◆ flags

enum GNUNET_FS_Flags GNUNET_FS_Handle::flags

◆ max_parallel_downloads

unsigned int GNUNET_FS_Handle::max_parallel_downloads

Maximum number of parallel downloads.

Definition at line 1169 of file fs_api.h.

Referenced by GNUNET_FS_start(), and process_job_queue().

◆ max_parallel_requests

unsigned int GNUNET_FS_Handle::max_parallel_requests

Maximum number of parallel requests.

Definition at line 1174 of file fs_api.h.

Referenced by GNUNET_FS_start(), and process_job_queue().


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