One download session's identity and robots.txt state. More...

#include <mdl_session.h>

Collaboration diagram for mdl_session_t:

Data Fields
mdl_net_iface_t *	net
	Backend used for robots.txt fetches.
const char *	user_agent
	Full UA header (caller-owned).
ra8_io_stream_t *	diagnostic
	Borrowed diagnostic byte sink.
bool	honor_robots
	False disables all robots gating.
mdl_robots_cache_t	cache
	Per-host robots cache.
char	scratch [k_mdl_session_scratch]
	Fetch scratch.

Detailed Description

One download session's identity and robots.txt state.

Large enough to embed the per-host cache and a fetch scratch buffer; declare one at file scope rather than on the stack.

Invariant: user_agent outlives the session.

See also: mdl_session_url_allowed()

Since: 0.1.0

Definition at line 39 of file mdl_session.h.

Field Documentation

◆ cache

mdl_robots_cache_t mdl_session_t::cache

Per-host robots cache.

Definition at line 44 of file mdl_session.h.

Referenced by mdl_session_init(), and mdl_session_url_allowed().

◆ diagnostic

ra8_io_stream_t* mdl_session_t::diagnostic

Borrowed diagnostic byte sink.

Definition at line 42 of file mdl_session.h.

Referenced by internal_report_robots_disallow(), internal_report_robots_unavailable(), mdl_session_init(), and mdl_session_url_allowed().

◆ honor_robots

bool mdl_session_t::honor_robots

False disables all robots gating.

Definition at line 43 of file mdl_session.h.

Referenced by mdl_session_init(), and mdl_session_url_allowed().

◆ net

mdl_net_iface_t* mdl_session_t::net

Backend used for robots.txt fetches.

Definition at line 40 of file mdl_session.h.

Referenced by internal_discover_fetch(), internal_mdl_fetch_governed_get_body(), internal_session_fetch(), mdl_fetch_asset(), mdl_session_init(), and priv_mdl_fetch_cache_get_buf().

◆ scratch

char mdl_session_t::scratch[k_mdl_session_scratch]

Fetch scratch.

Definition at line 45 of file mdl_session.h.

Referenced by mdl_session_url_allowed().

◆ user_agent

const char* mdl_session_t::user_agent

Full UA header (caller-owned).

Definition at line 41 of file mdl_session.h.

Referenced by internal_cover_cached(), internal_cover_stream(), internal_discover_fetch(), internal_download_page_image(), internal_extract_page_images(), internal_fetch_artifact(), internal_mdl_fetch_chapter_html(), internal_mdl_fetch_prepare_page(), internal_session_fetch(), mdl_fetch_asset(), mdl_session_init(), and priv_mdl_app_prepare_chapters().

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

apps/shared_libs/mdl/inc/mdl_session.h

Data Fields