--- libaitcli/inc/aitcli.h 2013/08/12 09:50:28 1.7 +++ libaitcli/inc/aitcli.h 2013/11/20 16:26:51 1.9 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitcli.h,v 1.7 2013/08/12 09:50:28 misho Exp $ +* $Id: aitcli.h,v 1.9 2013/11/20 16:26:51 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -379,7 +379,7 @@ int cli_telnet_Answer(unsigned char *caps, int nCaps, * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands * * @cli_buffer = CLI buffer - * @idx = Selected command ID + * @idx = Config level * @args = Parsed arguments array * return: RETCODE_OK ok */ @@ -403,7 +403,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 +418,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 +428,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 +533,35 @@ 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); #endif