joey shelton / LED_Demo

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by Maxim nexpaq

Embed: (wiki syntax)

« Back to documentation index

_FlashJournal_Ops_t Struct Reference

_FlashJournal_Ops_t Struct Reference

This is the set of operations offered by the flash-journal abstraction. More...

#include <flash_journal.h>

Data Fields

int32_t(* initialize )(FlashJournal_t *journal, ARM_DRIVER_STORAGE *mtd, const FlashJournal_Ops_t *ops, FlashJournal_Callback_t callback)
 Initialize the flash journal.
FlashJournal_Status_t(* getInfo )(FlashJournal_t *journal, FlashJournal_Info_t *info)
 fetch journal metadata.
int32_t(* read )(FlashJournal_t *journal, void *buffer, size_t size)
 Read from the most recently logged blob.
int32_t(* log )(FlashJournal_t *journal, const void *blob, size_t size)
 Start logging a new blob or append to the one currently being logged.
int32_t(* commit )(FlashJournal_t *journal)
 commit a blob accumulated through a non-empty sequence of previously successful log() operations.
int32_t(* reset )(FlashJournal_t *journal)
 Reset the journal.

Detailed Description

This is the set of operations offered by the flash-journal abstraction.

A set of implementations for these operations defines a logging strategy.

Definition at line 120 of file flash_journal.h.


Field Documentation

int32_t(* commit)(FlashJournal_t *journal)

commit a blob accumulated through a non-empty sequence of previously successful log() operations.

Refer to FlashJournal_commit.

Definition at line 145 of file flash_journal.h.

FlashJournal_Status_t(* getInfo)(FlashJournal_t *journal, FlashJournal_Info_t *info)

fetch journal metadata.

Refer to FlashJournal_getInfo.

Definition at line 129 of file flash_journal.h.

int32_t(* initialize)(FlashJournal_t *journal, ARM_DRIVER_STORAGE *mtd, const FlashJournal_Ops_t *ops, FlashJournal_Callback_t callback)

Initialize the flash journal.

Refer to FlashJournal_initialize.

Definition at line 124 of file flash_journal.h.

int32_t(* log)(FlashJournal_t *journal, const void *blob, size_t size)

Start logging a new blob or append to the one currently being logged.

Refer to FlashJournal_log.

Definition at line 139 of file flash_journal.h.

int32_t(* read)(FlashJournal_t *journal, void *buffer, size_t size)

Read from the most recently logged blob.

Refer to FlashJournal_read.

Definition at line 134 of file flash_journal.h.

int32_t(* reset)(FlashJournal_t *journal)

Reset the journal.

This has the effect of erasing all valid blobs. Refer to FlashJournal_reset.

Definition at line 151 of file flash_journal.h.