Command Line Interface

Functions
void	ltrx_cli_command_loop (struct input_stream *is, struct output_stream *os, const bool *isRunning, bool echoIsOn)
	Enters the command line loop.

Detailed Description

The Command Line Interface (CLI) implements the "Command Line" Line Protocol. When this protocol is chosen by a Line, it prompts for and accepts commands on the Line.

Commands are organized into levels. They provide comprehensive capability to view device status, to inspect and change device configuration, and perform actions on the device.

Function Documentation

ltrx_cli_command_loop()

void ltrx_cli_command_loop	(	struct input_stream *	is,
		struct output_stream *	os,
		const bool *	isRunning,
		bool	echoIsOn )

Enters the command line loop.

This routine implements the full Command Line Interface.

It returns either if it parses an "exit" command from the top level, or if another thread sets the isRunning flag to false.

Parameters

	is	[in,out] Input stream accepting command characters.
	os	[in,out] Output stream for responses and optional echo of input.
[in]	isRunning	Points to flag checked by loop; set it false to exit early.
[in]	echoIsOn	Selects echo on or off.