Logger backend API. More...

#include <zephyr/logging/log_backend.h>

Data Fields
void(*	process )(const struct log_backend const backend, union log_msg_generic msg)
	Mandatory: process a single log message (see log_backend_msg_process()).
void(*	dropped )(const struct log_backend *const backend, uint32_t cnt)
	Optional: report number of dropped messages (see log_backend_dropped()).
void(*	panic )(const struct log_backend *const backend)
	Mandatory: switch the backend to panic (blocking) mode.
void(*	init )(const struct log_backend *const backend)
	Optional: initialize the backend (see log_backend_init()).
int(*	is_ready )(const struct log_backend *const backend)
	Optional: poll for backend readiness (see log_backend_is_ready()).
int(*	format_set )(const struct log_backend *const backend, uint32_t log_type)
	Optional: set the output format type (see log_backend_format_set()).
void(*	notify )(const struct log_backend const backend, enum log_backend_evt event, union log_backend_evt_arg arg)
	Optional: handle a backend event (see log_backend_notify()).

Detailed Description

Logger backend API.

Set of operations a backend implements. Mandatory operations must always be provided; optional operations may be left NULL, in which case the log core skips them.

Field Documentation

◆ dropped

void(* log_backend_api::dropped) (const struct log_backend *const backend, uint32_t cnt)

Optional: report number of dropped messages (see log_backend_dropped()).

◆ format_set

int(* log_backend_api::format_set) (const struct log_backend *const backend, uint32_t log_type)

Optional: set the output format type (see log_backend_format_set()).

◆ init

void(* log_backend_api::init) (const struct log_backend *const backend)

Optional: initialize the backend (see log_backend_init()).

◆ is_ready

int(* log_backend_api::is_ready) (const struct log_backend *const backend)

Optional: poll for backend readiness (see log_backend_is_ready()).

◆ notify

void(* log_backend_api::notify) (const struct log_backend *const backend, enum log_backend_evt event, union log_backend_evt_arg *arg)

Optional: handle a backend event (see log_backend_notify()).

◆ panic

void(* log_backend_api::panic) (const struct log_backend *const backend)

Mandatory: switch the backend to panic (blocking) mode.

◆ process

void(* log_backend_api::process) (const struct log_backend *const backend, union log_msg_generic *msg)

Mandatory: process a single log message (see log_backend_msg_process()).

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

zephyr/logging/log_backend.h

Data Fields