cli_s Struct Reference

The MiniCLI control block definition. More...

#include <cli.h>

Data Fields
uint8_t	state
	Defines the login status. More...
cmd_t *	cmd
	A pointer to the CLI commands. More...
char	echo
	Determines if user input should be printed on the screen or not. More...
getchar_fptr_t	get
	A function pointer to get a characeter from input source. More...
putchar_fptr_t	put
	A function pointer to write a characeter to output sink. More...
knock_fptr_t	knock
	An authentication function pointer. More...
char *	tok [CLI_MAX_TOKENS]
	The tokenized input command. More...
cli_history_t	history
	The command history record. More...

Detailed Description

The MiniCLI control block definition.

The strcut cli_s and its aliased type cli_t is defined to aggregate the parameters for MiniCLI to work correctly.

Field Documentation

cmd_t* cmd

A pointer to the CLI commands.

char echo

Determines if user input should be printed on the screen or not.

getchar_fptr_t get

A function pointer to get a characeter from input source.

cli_history_t history

The command history record.

knock_fptr_t knock

An authentication function pointer.

putchar_fptr_t put

A function pointer to write a characeter to output sink.

uint8_t state

Defines the login status.

0, if not logged in and 1, otherwise.

char* tok[CLI_MAX_TOKENS]

The tokenized input command.

Note that there is a limit of 20 tokens.

---

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

• middleware/MTK/minicli/inc/cli.h