plugin_lifecycle.h File Reference

Lifecycle exports a CDC Badge plugin must (and may) provide. More...

#include <stdint.h>

Go to the source code of this file.

Functions
uint16_t	plugin_required_api_major (void)
uint16_t	plugin_required_api_minor (void)
int	plugin_init (void)
int	plugin_deinit (void)
int	plugin_on_enter (void)
int	plugin_on_exit (void)
int	plugin_on_action (uint32_t action_id, uint32_t selected_idx, uint32_t user_data)
int	plugin_on_button (uint32_t button_code)
int	plugin_on_event (uint32_t event_type, uint32_t event_value)
int	plugin_on_tick (uint64_t uptime_ms)
int	plugin_on_cmd (uint32_t len)
int	plugin_on_prerequisite_failed (uint32_t prereq_id, uint32_t error_code)

Detailed Description

Lifecycle exports a CDC Badge plugin must (and may) provide.

A plugin is a WebAssembly module that the badge loads from its plugins partition. The functions below are imported by the host from the WASM module's export table. Functions marked REQUIRED are checked at load time and a missing export causes the plugin to be rejected.

Definition in file plugin_lifecycle.h.

Function Documentation

plugin_deinit()

int plugin_deinit

(

void

)

plugin_init()

int plugin_init

(

void

)

plugin_on_action()

int plugin_on_action	(	uint32_t	action_id,
		uint32_t	selected_idx,
		uint32_t	user_data )

plugin_on_button()

int plugin_on_button

(

uint32_t

button_code

)

plugin_on_cmd()

int plugin_on_cmd

(

uint32_t

len

)

plugin_on_enter()

int plugin_on_enter

(

void

)

plugin_on_event()

int plugin_on_event	(	uint32_t	event_type,
		uint32_t	event_value )

plugin_on_exit()

int plugin_on_exit

(

void

)

plugin_on_prerequisite_failed()

int plugin_on_prerequisite_failed	(	uint32_t	prereq_id,
		uint32_t	error_code )

plugin_on_tick()

int plugin_on_tick

(

uint64_t

uptime_ms

)

plugin_required_api_major()

uint16_t plugin_required_api_major

(

void

)

plugin_required_api_minor()

uint16_t plugin_required_api_minor

(

void

)