ngcbCMD_LIST Class Reference

#include <ngcbCMD.hpp>

Public Member Functions
	ngcbCMD_LIST (ngcbCMD_SRV *server)
	Constructor.
virtual	~ngcbCMD_LIST ()
	Destructor.
int	Add (const char *cmd, ngcb_function_t function, int flags, const char *syntax, const char *help, void *udata, char *erms)
	Create command handler and add it to the command list.
void	Delete (const char *cmd)
	Delete command from the command list.
void	Sort ()
	Sort list alphabetically.
int	Execute (const char *cmd, ngcb_cmd_handle_t *handle, char *reply)
	Execute command.
int	Help (const char *args, char *reply)
	Get help-text.
int	Defined (const char *cmd)
	Check if command is defined.
void	Close ()
	Close command factory - no further commands can be added.
void	Open ()
	Open command factory - further commands can be added.
int	Status ()
	Return Status (0=open, 1=complete)

Detailed Description

Command list

Constructor & Destructor Documentation

ngcbCMD_LIST()

ngcbCMD_LIST::ngcbCMD_LIST ( ngcbCMD_SRV * server )

explicit

Constructor.

~ngcbCMD_LIST()

ngcbCMD_LIST::~ngcbCMD_LIST ( )

virtual

Destructor.

Member Function Documentation

Add()

int ngcbCMD_LIST::Add	(	const char *	cmd,
		ngcb_function_t	function,
		int	flags,
		const char *	syntax,
		const char *	help,
		void *	udata,
		char *	erms )

Create command handler and add it to the command list.

Close()

void ngcbCMD_LIST::Close

(

)

Close command factory - no further commands can be added.

Defined()

int ngcbCMD_LIST::Defined

(

const char *

cmd

)

Check if command is defined.

Delete()

void ngcbCMD_LIST::Delete

(

const char *

cmd

)

Delete command from the command list.

Execute()

int ngcbCMD_LIST::Execute	(	const char *	cmd,
		ngcb_cmd_handle_t *	handle,
		char *	reply )

Execute command.

Help()

int ngcbCMD_LIST::Help	(	const char *	args,
		char *	reply )

Get help-text.

Open()

void ngcbCMD_LIST::Open

(

)

Open command factory - further commands can be added.

Sort()

void ngcbCMD_LIST::Sort

(

)

Sort list alphabetically.

Status()

int ngcbCMD_LIST::Status

(

)

Return Status (0=open, 1=complete)

---

The documentation for this class was generated from the following files:

• core/ngcbCORE/src/include/ngc/core/ngcbCMD.hpp
• core/ngcbCORE/src/ngcbCMD_LIST.cpp