shell_server.h
Go to the documentation of this file.
198 ShellServerCommandLineCallback commandLineCallback; ///<Command line processing callback function
249 ShellServerCommandLineCallback commandLineCallback; ///<Command line processing callback function
254 SshChannelEventDesc eventDesc[SHELL_SERVER_MAX_SESSIONS]; ///<The events the application is interested in
char_t escSeq[SHELL_SERVER_MAX_ESC_SEQ_LEN+1]
Multibyte escape sequence.
Definition: shell_server.h:233
error_t shellServerWriteStream(ShellServerSession *session, const void *data, size_t length, size_t *written, uint_t flags)
Write to stdout stream.
Definition: shell_server.c:302
ShellServerCloseCallback closeCallback
Session closing callback function.
Definition: shell_server.h:199
error_t shellServerInit(ShellServerContext *context, const ShellServerSettings *settings)
Initialize shell server context.
Definition: shell_server.c:86
error_t shellServerSetTimeout(ShellServerSession *session, systime_t timeout)
Set timeout for read/write operations.
Definition: shell_server.c:271
void shellServerGetDefaultSettings(ShellServerSettings *settings)
Initialize settings with default values.
Definition: shell_server.c:50
error_t shellServerSaveHistory(ShellServerSession *session, char_t *history, size_t size, size_t *length)
Save command history.
Definition: shell_server.c:394
error_t shellServerRestoreHistory(ShellServerSession *session, const char_t *history, size_t length)
Restore command history.
Definition: shell_server.c:443
error_t shellServerSetBanner(ShellServerSession *session, const char_t *banner)
Set welcome banner.
Definition: shell_server.c:208
ShellServerCommandLineCallback commandLineCallback
Command line processing callback function.
Definition: shell_server.h:198
error_t shellServerSetPrompt(ShellServerSession *session, const char_t *prompt)
Set shell prompt.
Definition: shell_server.c:243
ShellAccessStatus(* ShellServerCheckUserCallback)(ShellServerSession *session, const char_t *user)
User verification callback function.
Definition: shell_server.h:167
error_t(* ShellServerCommandLineCallback)(ShellServerSession *session, char_t *commandLine)
Command line processing callback function.
Definition: shell_server.h:175
ShellServerCheckUserCallback checkUserCallback
User verification callback function.
Definition: shell_server.h:248
SshChannelEventDesc eventDesc[SHELL_SERVER_MAX_SESSIONS]
The events the application is interested in.
Definition: shell_server.h:254
void(* ShellServerCloseCallback)(ShellServerSession *session, const char_t *user)
Session closing callback function.
Definition: shell_server.h:183
error_t shellServerReadStream(ShellServerSession *session, void *data, size_t size, size_t *received, uint_t flags)
Read from stdin stream.
Definition: shell_server.c:334
error_t shellServerSetExitStatus(ShellServerSession *session, int32_t exitStatus)
Set exit status.
Definition: shell_server.c:363
SSH server.
error_t shellServerStart(ShellServerContext *context)
Start shell server.
Definition: shell_server.c:157
ShellServerCloseCallback closeCallback
Session closing callback function.
Definition: shell_server.h:250
ShellServerCheckUserCallback checkUserCallback
User verification callback function.
Definition: shell_server.h:197
ShellServerCommandLineCallback commandLineCallback
Command line processing callback function.
Definition: shell_server.h:249
error_t shellServerClearHistory(ShellServerSession *session)
Clear command history.
Definition: shell_server.c:498
char_t buffer[SHELL_SERVER_BUFFER_SIZE]
Memory buffer for input/output operations.
Definition: shell_server.h:218
