Logger multidomain backend helpers

Logger multidomain backend helpers. More...

Data Structures
struct	log_multidomain_log_msg
	Content of the logging message. More...
struct	log_multidomain_domain_cnt
	Content of the domain count message. More...
struct	log_multidomain_source_cnt
	Content of the source count message. More...
struct	log_multidomain_domain_name
	Content of the domain name message. More...
struct	log_multidomain_source_name
	Content of the source name message. More...
struct	log_multidomain_levels
	Content of the message for getting logging levels. More...
struct	log_multidomain_set_runtime_level
	Content of the message for setting logging level. More...
struct	log_multidomain_dropped
	Content of the message for getting amount of dropped messages. More...
union	log_multidomain_msg_data
	Union with all message types. More...
struct	log_multidomain_msg
	Message. More...
struct	log_multidomain_link_transport_api
	Structure with link transport API. More...
union	log_multidomain_link_dst
	Union for holding data returned by associated remote backend. More...
struct	log_multidomain_link
	Remote link structure. More...
struct	log_multidomain_backend_transport_api
	Backend transport API. More...
struct	log_multidomain_backend
	Remote backend structure. More...

Functions
void	log_multidomain_link_on_recv_cb (struct log_multidomain_link *link, const void *data, size_t len)
	Function to be called when data is received from remote.
void	log_multidomain_link_on_error (struct log_multidomain_link *link, int err)
	Function called on error reported by transport layer.
void	log_multidomain_link_on_started (struct log_multidomain_link *link, int err)
	Function called when connection with remote is established.
void	log_multidomain_backend_on_recv_cb (struct log_multidomain_backend *backend, const void *data, size_t len)
	Function to be called when data is received from remote.
void	log_multidomain_backend_on_error (struct log_multidomain_backend *backend, int err)
	Function called on error reported by transport layer.
void	log_multidomain_backend_on_started (struct log_multidomain_backend *backend, int err)
	Function called when connection with remote is established.

Variables
struct log_link_api	log_multidomain_link_api
	Remote link API.
const struct log_backend_api	log_multidomain_backend_api
	Remote backend API.

Detailed Description

Logger multidomain backend helpers.

This module aims to provide baseline for links and backends and simplify the implementation. It is not core part of logging in similar way as log_output module is just a helper for log message formatting. Links and backends can be implemented without this helper.

Function Documentation

log_multidomain_backend_on_error()

void log_multidomain_backend_on_error	(	struct log_multidomain_backend *	backend,
		int	err
	)

#include <include/zephyr/logging/log_multidomain_helper.h>

Function called on error reported by transport layer.

Parameters

backend	Backend instance.
err	Error code.

log_multidomain_backend_on_recv_cb()

void log_multidomain_backend_on_recv_cb	(	struct log_multidomain_backend *	backend,
		const void *	data,
		size_t	len
	)

#include <include/zephyr/logging/log_multidomain_helper.h>

Function to be called when data is received from remote.

Parameters

backend	Backend instance.
data	Data.
len	Data length.

log_multidomain_backend_on_started()

void log_multidomain_backend_on_started	(	struct log_multidomain_backend *	backend,
		int	err
	)

#include <include/zephyr/logging/log_multidomain_helper.h>

Function called when connection with remote is established.

Parameters

backend	Backend instance.
err	Error code.

log_multidomain_link_on_error()

void log_multidomain_link_on_error	(	struct log_multidomain_link *	link,
		int	err
	)

#include <include/zephyr/logging/log_multidomain_helper.h>

Function called on error reported by transport layer.

Parameters

link	Link instance.
err	Error code.

log_multidomain_link_on_recv_cb()

void log_multidomain_link_on_recv_cb	(	struct log_multidomain_link *	link,
		const void *	data,
		size_t	len
	)

#include <include/zephyr/logging/log_multidomain_helper.h>

Function to be called when data is received from remote.

Parameters

link	Link instance.
data	Data.
len	Data length.

log_multidomain_link_on_started()

void log_multidomain_link_on_started	(	struct log_multidomain_link *	link,
		int	err
	)

#include <include/zephyr/logging/log_multidomain_helper.h>

Function called when connection with remote is established.

Parameters

link	Link instance.
err	Error code.

Variable Documentation

log_multidomain_backend_api

const struct log_backend_api log_multidomain_backend_api

extern

#include <include/zephyr/logging/log_multidomain_helper.h>

Remote backend API.

log_multidomain_link_api

struct log_link_api log_multidomain_link_api

extern

#include <include/zephyr/logging/log_multidomain_helper.h>

Remote link API.