mdl_discover_req_t Struct Reference

Injected dependencies and inputs for one discovery run. More...

#include <mdl_discover.h>

Collaboration diagram for mdl_discover_req_t:

Data Fields
mdl_session_t *	session
	Initialised session (net + UA + robots).
mdl_governor_t *	gov
	Initialised per-host politeness governor.
const mdl_site_t *	site
	Descriptor holding the discovery keys.
mdl_discover_mode_t	mode
	Search or browse.
const char *	term
	Raw search term; ignored/NULL for browse.
uint32_t	timeout_ms
	Per-request time budget, milliseconds.
char *	page_buf
	Results-page fetch scratch (borrowed).
size_t	page_cap
	Capacity of page_buf in bytes.
mdl_hit_list_t *	hits
	Receives the parsed hits (borrowed).
ra8_io_stream_t *	output
	Borrowed normal-output byte sink.
ra8_io_stream_t *	diagnostic
	Borrowed diagnostic byte sink.
ra8_err_t *	io_error
	Caller-owned first sink failure latch.

Detailed Description

Injected dependencies and inputs for one discovery run.

Bundled so mdl_discover_run takes one options pointer rather than a long positional list. The session and governor are built and owned by the caller; the scratch buffer and hit list are borrowed for the run.

Invariant

page_buf/page_cap describe a writable buffer; page_cap > 0.

See also

mdl_discover_run()

Since

0.1.0

Definition at line 53 of file mdl_discover.h.

Field Documentation

diagnostic

ra8_io_stream_t* mdl_discover_req_t::diagnostic

Borrowed diagnostic byte sink.

Definition at line 64 of file mdl_discover.h.

Referenced by internal_discover_url(), internal_present_and_pick(), internal_print_markup_changed(), internal_print_zero(), internal_select_hit(), and mdl_discover_run().

gov

mdl_governor_t* mdl_discover_req_t::gov

Initialised per-host politeness governor.

Definition at line 55 of file mdl_discover.h.

Referenced by internal_discover_fetch(), and mdl_discover_run().

hits

mdl_hit_list_t* mdl_discover_req_t::hits

Receives the parsed hits (borrowed).

Definition at line 62 of file mdl_discover.h.

Referenced by internal_present_and_pick(), internal_print_hits(), internal_print_zero(), and mdl_discover_run().

io_error

ra8_err_t* mdl_discover_req_t::io_error

Caller-owned first sink failure latch.

Definition at line 65 of file mdl_discover.h.

Referenced by internal_discover_text3(), internal_discover_url(), internal_present_and_pick(), internal_print_header(), internal_print_hits(), internal_print_zero(), internal_select_hit(), and mdl_discover_run().

mode

mdl_discover_mode_t mdl_discover_req_t::mode

Search or browse.

Definition at line 57 of file mdl_discover.h.

Referenced by internal_discover_url(), internal_present_and_pick(), internal_print_header(), internal_print_zero(), and mdl_discover_run().

output

ra8_io_stream_t* mdl_discover_req_t::output

Borrowed normal-output byte sink.

Definition at line 63 of file mdl_discover.h.

Referenced by internal_present_and_pick(), internal_print_header(), internal_print_hits(), internal_select_hit(), and mdl_discover_run().

page_buf

char* mdl_discover_req_t::page_buf

Results-page fetch scratch (borrowed).

Definition at line 60 of file mdl_discover.h.

Referenced by internal_discover_fetch(), and mdl_discover_run().

page_cap

size_t mdl_discover_req_t::page_cap

Capacity of page_buf in bytes.

Definition at line 61 of file mdl_discover.h.

Referenced by internal_discover_fetch().

session

mdl_session_t* mdl_discover_req_t::session

Initialised session (net + UA + robots).

Definition at line 54 of file mdl_discover.h.

Referenced by internal_discover_fetch(), and mdl_discover_run().

site

const mdl_site_t* mdl_discover_req_t::site

Descriptor holding the discovery keys.

Definition at line 56 of file mdl_discover.h.

Referenced by internal_discover_fetch(), internal_discover_url(), internal_print_header(), internal_print_markup_changed(), internal_print_zero(), and mdl_discover_run().

term

const char* mdl_discover_req_t::term

Raw search term; ignored/NULL for browse.

Definition at line 58 of file mdl_discover.h.

Referenced by internal_discover_url(), internal_print_header(), and internal_print_zero().

timeout_ms

uint32_t mdl_discover_req_t::timeout_ms

Per-request time budget, milliseconds.

Definition at line 59 of file mdl_discover.h.

Referenced by internal_discover_fetch().

---

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

• apps/shared_libs/mdl/inc/mdl_discover.h