Rtos API example

Embed: (wiki syntax)

« Back to documentation index

FlashJournal_t Struct Reference

FlashJournal_t Struct Reference

An opaque handle constituting the Flash Journal. More...

#include <flash_journal.h>


Detailed Description

An opaque handle constituting the Flash Journal.

This structure is intentionally opaque to avoid exposing data internal to an implementation strategy; this prevents accesses through any means other than through the defined API.

Having a known size for the handle allows the caller to remain malloc-free.

Note:
: There should be static asserts in the code to verify our assumption that the real FlashJournal handle fits within FLASH_JOURNAL_HANDLE_MAX_SIZE bytes.
: there is a risk of overallocation in case an implementation doesn't need FLASH_JOURNAL_HANDLE_MAX_SIZE bytes, but the impact should be small.

Definition at line 205 of file flash_journal.h.