ra8_vmem_stream_t Struct Reference

Binds one page-cached object to the byte-stream read adapter. More...

#include <ra8_vmem_stream.h>

Collaboration diagram for ra8_vmem_stream_t:

Data Fields
ra8_vmem_t *	vm
	Initialised page cache (fixed pool = RAM budget).
uint32_t	object_id
	Paged object id registered in the cache's source.
uint32_t	frame_bytes
	Cache frame size, cached from vm->cfg at init.
uint64_t	size
	Object length in bytes.

Detailed Description

Binds one page-cached object to the byte-stream read adapter.

Caller-owned; populate with ra8_vmem_stream_init and pass its address as the ctx of ra8_vmem_stream_read. Treat the fields as private.

Invariant

frame_bytes == vm->cfg.frame_bytes and frame_bytes > 0.

Since

0.1.0

Definition at line 59 of file ra8_vmem_stream.h.

Field Documentation

frame_bytes

uint32_t ra8_vmem_stream_t::frame_bytes

Cache frame size, cached from vm->cfg at init.

Definition at line 62 of file ra8_vmem_stream.h.

Referenced by ra8_vmem_stream_init(), and ra8_vmem_stream_read().

object_id

uint32_t ra8_vmem_stream_t::object_id

Paged object id registered in the cache's source.

Definition at line 61 of file ra8_vmem_stream.h.

Referenced by ra8_vmem_stream_init(), and ra8_vmem_stream_read().

size

uint64_t ra8_vmem_stream_t::size

Object length in bytes.

Definition at line 63 of file ra8_vmem_stream.h.

Referenced by internal_stream_open(), ra8_vmem_stream_init(), and ra8_vmem_stream_read().

vm

ra8_vmem_t* ra8_vmem_stream_t::vm

Initialised page cache (fixed pool = RAM budget).

Definition at line 60 of file ra8_vmem_stream.h.

Referenced by ra8_vmem_stream_init(), and ra8_vmem_stream_read().

---

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

• libs/ra8_mem/inc/ra8_vmem_stream.h