shell_backend.h File Reference

Shell backend API. More...

#include <zephyr/types.h>
#include <zephyr/shell/shell.h>
#include <zephyr/sys/iterable_sections.h>

Go to the source code of this file.

Functions
static const struct shell *	shell_backend_get (uint32_t idx)
	Get backend.
static int	shell_backend_count_get (void)
	Get number of backends.
const struct shell *	shell_backend_get_by_name (const char *backend_name)
	Get backend by name.

Detailed Description

Shell backend API.

Function Documentation

shell_backend_count_get()

int shell_backend_count_get ( void )

inlinestatic

Get number of backends.

Returns

Number of backends.

shell_backend_get()

const struct shell * shell_backend_get ( uint32_t idx )

inlinestatic

Get backend.

Parameters

[in]

idx

Pointer to the backend instance.

Returns

Pointer to the backend instance.

shell_backend_get_by_name()

const struct shell * shell_backend_get_by_name

(

const char *

backend_name

)

Get backend by name.

Parameters

[in]

backend_name

Name of the backend as defined by the SHELL_DEFINE.

Returns

Pointer to the backend instance if found, NULL if backend is not found.