RA8-local state for one accepted remote artifact job. More...

#include <ra8_c6link_mdl.h>

Data Fields
uint32_t	job_id
	Remote-generated non-zero identifier.
uint32_t	next_sequence
	Exact sequence required from the next response.
uint64_t	next_offset
	Exact byte offset required from the next response.
uint32_t	max_chunk_bytes
	Maximum accepted pull size negotiated at start.
mdl_format_t	format
	Requested format echoed by the C6.
bool	active
	Whether next/cancel is currently valid.

Detailed Description

RA8-local state for one accepted remote artifact job.

Maintains the correlation values the next response must carry. Callers allocate it; the client never allocates or retains caller memory.

Invariant: An active session has a non-zero job_id and max_chunk_bytes.; next_offset and next_sequence advance only after a valid response.
ra8_mdl_session_t session = {};

(void)ra8_c6link_mdl_start(

&link, "https://host/book.rabook", k_mdl_format_rabook, &session);

k_mdl_format_rabook
@ k_mdl_format_rabook
Chunked reader-native book (.rabook).
Definition mdl_format.h:44

ra8_c6link_mdl_start
ra8_err_t ra8_c6link_mdl_start(ra8_c6link_t *link, const char *url, mdl_format_t format, ra8_mdl_session_t *session)
Start retrieval of one selected artifact and receive its job identifier.
Definition ra8_c6link_mdl.c:615

ra8_mdl_session_t
RA8-local state for one accepted remote artifact job.
Definition ra8_c6link_mdl.h:43

See also: ra8_c6link_mdl_start

Since: 0.1.0

Definition at line 43 of file ra8_c6link_mdl.h.

Field Documentation

◆ active

bool ra8_mdl_session_t::active

Whether next/cancel is currently valid.

Definition at line 49 of file ra8_c6link_mdl.h.

Referenced by internal_mdl_accept_chunk(), internal_mdl_take_cancelled(), internal_mdl_transfer_abort(), ra8_c6link_mdl_cancel(), ra8_c6link_mdl_next(), and ra8_c6link_mdl_transfer().

◆ format

mdl_format_t ra8_mdl_session_t::format

Requested format echoed by the C6.

Definition at line 48 of file ra8_c6link_mdl.h.

◆ job_id

uint32_t ra8_mdl_session_t::job_id

Remote-generated non-zero identifier.

Definition at line 44 of file ra8_c6link_mdl.h.

Referenced by internal_mdl_take_cancelled(), internal_mdl_take_chunk(), ra8_c6link_mdl_cancel(), and ra8_c6link_mdl_next().

◆ max_chunk_bytes

uint32_t ra8_mdl_session_t::max_chunk_bytes

Maximum accepted pull size negotiated at start.

Definition at line 47 of file ra8_c6link_mdl.h.

Referenced by ra8_c6link_mdl_next().

◆ next_offset

uint64_t ra8_mdl_session_t::next_offset

Exact byte offset required from the next response.

Definition at line 46 of file ra8_c6link_mdl.h.

Referenced by internal_mdl_accept_chunk(), internal_mdl_take_chunk(), and ra8_c6link_mdl_next().

◆ next_sequence

uint32_t ra8_mdl_session_t::next_sequence

Exact sequence required from the next response.

Definition at line 45 of file ra8_c6link_mdl.h.

Referenced by internal_mdl_accept_chunk(), and internal_mdl_take_chunk().

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

libs/ra8_c6link/inc/ra8_c6link_mdl.h

Data Fields