Shell session. More...
#include <shell_server.h>
Data Fields | |
| ShellServerSessionState | state |
| Session state. More... | |
| OsEvent | startEvent |
| OsEvent | event |
| OsTaskParameters | taskParams |
| Task parameters. More... | |
| OsTaskId | taskId |
| Task identifier. More... | |
| ShellServerContext * | context |
| Shell server context. More... | |
| SshChannel * | channel |
| Underlying SSH channel. More... | |
| char_t | prompt [SHELL_SERVER_MAX_PROMPT_LEN+1] |
| Shell prompt. More... | |
| size_t | promptLen |
| Length of the shell prompt. More... | |
| char_t | buffer [SHELL_SERVER_BUFFER_SIZE] |
| Memory buffer for input/output operations. More... | |
| size_t | bufferPos |
| Current position in the buffer. More... | |
| size_t | bufferLen |
| Actual length of the buffer, in bytes. More... | |
| char_t | history [SHELL_SERVER_HISTORY_SIZE] |
| Command history buffer. More... | |
| size_t | historyLen |
| Length of the command history buffer, in bytes. More... | |
| size_t | historyPos |
| Current position in the command history buffer. More... | |
| char_t | backspaceCode |
| Backspace key code. More... | |
| char_t | deleteCode |
| Delete key code. More... | |
| uint32_t | termWidth |
| Current terminal width (in characters) More... | |
| uint32_t | termHeight |
| Current terminal height (in rows) More... | |
| uint32_t | newTermWidth |
| New terminal width (in characters) More... | |
| uint32_t | newTermHeight |
| New terminal height (in rows) More... | |
| bool_t | windowResize |
| Window resize event. More... | |
| char_t | escSeq [SHELL_SERVER_MAX_ESC_SEQ_LEN+1] |
| Multibyte escape sequence. More... | |
| size_t | escSeqLen |
| Length of the multibyte escape sequence. More... | |
Detailed Description
Shell session.
Definition at line 197 of file shell_server.h.
Field Documentation
◆ backspaceCode
| char_t backspaceCode |
Backspace key code.
Definition at line 216 of file shell_server.h.
◆ buffer
| char_t buffer[SHELL_SERVER_BUFFER_SIZE] |
Memory buffer for input/output operations.
Definition at line 208 of file shell_server.h.
◆ bufferLen
| size_t bufferLen |
Actual length of the buffer, in bytes.
Definition at line 210 of file shell_server.h.
◆ bufferPos
| size_t bufferPos |
Current position in the buffer.
Definition at line 209 of file shell_server.h.
◆ channel
| SshChannel* channel |
Underlying SSH channel.
Definition at line 205 of file shell_server.h.
◆ context
| ShellServerContext* context |
Shell server context.
Definition at line 204 of file shell_server.h.
◆ deleteCode
| char_t deleteCode |
Delete key code.
Definition at line 217 of file shell_server.h.
◆ escSeq
| char_t escSeq[SHELL_SERVER_MAX_ESC_SEQ_LEN+1] |
Multibyte escape sequence.
Definition at line 223 of file shell_server.h.
◆ escSeqLen
| size_t escSeqLen |
Length of the multibyte escape sequence.
Definition at line 224 of file shell_server.h.
◆ event
| OsEvent event |
Definition at line 201 of file shell_server.h.
◆ history
| char_t history[SHELL_SERVER_HISTORY_SIZE] |
Command history buffer.
Definition at line 212 of file shell_server.h.
◆ historyLen
| size_t historyLen |
Length of the command history buffer, in bytes.
Definition at line 213 of file shell_server.h.
◆ historyPos
| size_t historyPos |
Current position in the command history buffer.
Definition at line 214 of file shell_server.h.
◆ newTermHeight
| uint32_t newTermHeight |
New terminal height (in rows)
Definition at line 221 of file shell_server.h.
◆ newTermWidth
| uint32_t newTermWidth |
New terminal width (in characters)
Definition at line 220 of file shell_server.h.
◆ prompt
| char_t prompt[SHELL_SERVER_MAX_PROMPT_LEN+1] |
Shell prompt.
Definition at line 206 of file shell_server.h.
◆ promptLen
| size_t promptLen |
Length of the shell prompt.
Definition at line 207 of file shell_server.h.
◆ startEvent
| OsEvent startEvent |
Definition at line 200 of file shell_server.h.
◆ state
| ShellServerSessionState state |
Session state.
Definition at line 199 of file shell_server.h.
◆ taskId
| OsTaskId taskId |
Task identifier.
Definition at line 203 of file shell_server.h.
◆ taskParams
| OsTaskParameters taskParams |
Task parameters.
Definition at line 202 of file shell_server.h.
◆ termHeight
| uint32_t termHeight |
Current terminal height (in rows)
Definition at line 219 of file shell_server.h.
◆ termWidth
| uint32_t termWidth |
Current terminal width (in characters)
Definition at line 218 of file shell_server.h.
◆ windowResize
| bool_t windowResize |
Window resize event.
Definition at line 222 of file shell_server.h.
The documentation for this struct was generated from the following file:
- cyclone_ssh/shell/shell_server.h