--- libaitcli/inc/aitcli.h 2013/10/08 09:51:02 1.7.4.1 +++ libaitcli/inc/aitcli.h 2013/11/22 14:25:37 1.9.4.1 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitcli.h,v 1.7.4.1 2013/10/08 09:51:02 misho Exp $ +* $Id: aitcli.h,v 1.9.4.1 2013/11/22 14:25:37 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -226,6 +226,7 @@ typedef SLIST_HEAD(slCommandHead, tagCommand) commands /* Main structure, Buffer for CLI work with thread models ;-) special designed by M.Punov */ typedef struct { + int line_kill; char line_mode; char *line_prompt; @@ -403,7 +404,7 @@ int cli_BindKey(bindkey_t * __restrict key, linebuffer * * @cli_buffer = CLI buffer * @csCmd = Command name - * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... + * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels * @funcCmd = Callback function when user call command * @csInfo = Inline information for command * @csHelp = Help line when call help @@ -418,7 +419,7 @@ cli_addCommand(linebuffer_t * __restrict cli_buffer, c * * @cli_buffer = CLI buffer * @csCmd = Command name - * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... + * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels * return: RETCODE_ERR error, RETCODE_OK ok */ int @@ -428,7 +429,7 @@ cli_delCommand(linebuffer_t * __restrict cli_buffer, c * * @cli_buffer = CLI buffer * @csCmd = Command name - * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... + * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels * @funcCmd = Callback function when user call command * @csInfo = Inline information for command * @csHelp = Help line when call help @@ -533,29 +534,36 @@ int cliInitLine(linebuffer_t * __restrict cli_buffer); * cliReadLine() - Read line from opened CLI session * * @cli_buffer = CLI buffer + * @timeout = Session timeout (-1 infinit) + * @cmd_name = If timeout reached, we should call with this cmd_name (default name is "exit") * return: NULL if error or !=NULL readed line, must be e_free after use! */ -char *cliReadLine(linebuffer_t * __restrict cli_buffer); +char *cliReadLine(linebuffer_t * __restrict cli_buffer, int timeout, const char *cmd_name); /* * cliLoop() - CLI main loop * * @cli_buffer = CLI buffer * @csHistFile = History file name + * @timeout = Session timeout (-1 infinit) + * @cmd_name = If timeout reached, we should call with this cmd_name (default name is "exit") * return: RETCODE_ERR error, RETCODE_OK ok */ -int cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile); +int cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, + int timeout, const char *cmd_name); /* * cliNetLoop() - CLI network main loop binded to socket * * @cli_buffer = CLI buffer * @csHistFile = History file name * @sock = client socket - * @term = stdin termios - * @win = window size of tty + * @timeout = Session timeout (-1 infinit) + * @cmd_name = If timeout reached, we should call with this cmd_name (default name is "exit") * return: RETCODE_ERR error, RETCODE_OK ok */ -int cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, int sock); +int cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, + int sock, int timeout, const char *cmd_name); +#define cliKillLoop(_x) (assert((_x)), (_x)->line_kill = 1) #endif