Shell client context. More...
#include <shell_client.h>
| Data Fields | |
| ShellClientState | state | 
| Shell client state.  More... | |
| NetInterface * | interface | 
| Underlying network interface.  More... | |
| ShellClientSshInitCallback | sshInitCallback | 
| SSH initialization callback function.  More... | |
| systime_t | timeout | 
| Timeout value.  More... | |
| systime_t | timestamp | 
| Timestamp to manage timeout.  More... | |
| char_t | buffer [SHELL_CLIENT_BUFFER_SIZE] | 
| Memory buffer for input/output operations.  More... | |
| size_t | bufferLen | 
| Length of the buffer, in bytes.  More... | |
| size_t | bufferPos | 
| Current position in the buffer.  More... | |
| uint32_t | exitStatus | 
| Exit status.  More... | |
| SshContext | sshContext | 
| SSH context.  More... | |
| SshConnection | sshConnection | 
| SSH connection.  More... | |
| SshChannel | sshChannel | 
| SSH channel.  More... | |
Detailed Description
Shell client context.
Definition at line 101 of file shell_client.h.
Field Documentation
◆ buffer
| char_t buffer[SHELL_CLIENT_BUFFER_SIZE] | 
Memory buffer for input/output operations.
Definition at line 108 of file shell_client.h.
◆ bufferLen
| size_t bufferLen | 
Length of the buffer, in bytes.
Definition at line 109 of file shell_client.h.
◆ bufferPos
| size_t bufferPos | 
Current position in the buffer.
Definition at line 110 of file shell_client.h.
◆ exitStatus
| uint32_t exitStatus | 
Exit status.
Definition at line 111 of file shell_client.h.
◆ interface
| NetInterface* interface | 
Underlying network interface.
Definition at line 104 of file shell_client.h.
◆ sshChannel
| SshChannel sshChannel | 
SSH channel.
Definition at line 114 of file shell_client.h.
◆ sshConnection
| SshConnection sshConnection | 
SSH connection.
Definition at line 113 of file shell_client.h.
◆ sshContext
| SshContext sshContext | 
SSH context.
Definition at line 112 of file shell_client.h.
◆ sshInitCallback
| ShellClientSshInitCallback sshInitCallback | 
SSH initialization callback function.
Definition at line 105 of file shell_client.h.
◆ state
| ShellClientState state | 
Shell client state.
Definition at line 103 of file shell_client.h.
◆ timeout
| systime_t timeout | 
Timeout value.
Definition at line 106 of file shell_client.h.
◆ timestamp
| systime_t timestamp | 
Timestamp to manage timeout.
Definition at line 107 of file shell_client.h.
The documentation for this struct was generated from the following file:
- cyclone_ssh/shell/shell_client.h
