Command Types

Data types used by the command subsystem. More...

Collaboration diagram for Command Types:

Classes
struct	CMD_INFO_ts
	Describes a single command exposed by a client. More...
struct	CMD_CLIENT_INFO_ts
	Describes a subsystem client registering with the command module. More...

Typedefs
typedef ERR_te(*	CMD_HANDLER_tf) (uint32_t argc, char **argv)
	Function pointer type for a command handler.

Detailed Description

Data types used by the command subsystem.

Typedef Documentation

CMD_HANDLER_tf

typedef ERR_te(* CMD_HANDLER_tf) (uint32_t argc, char **argv)

Function pointer type for a command handler.

Each command registered with the subsystem must provide a handler matching this signature. The handler receives the tokenized argument list produced by cmd_execute.

Parameters

[in]	argc	Number of tokens in argv.
[in]	argv	Array of token strings. argv[0] is the client name, argv[1] is the command name, and subsequent entries are command-specific arguments.

Returns

An ERR_te error code indicating success or failure.

Definition at line 63 of file cmd.h.