Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
shell_telnet.h File Reference

Go to the source code of this file.

Data Structures

struct  shell_telnet_line_buf
 Line buffer structure. More...
 
struct  shell_telnet
 TELNET-based shell transport. More...
 

Macros

#define SHELL_TELNET_POLLFD_COUNT   3
 
#define SHELL_TELNET_MAX_CMD_SIZE   3
 
#define SHELL_TELNET_DEFINE(_name)
 

Functions

const struct shellshell_backend_telnet_get_ptr (void)
 This function provides pointer to shell telnet backend instance.
 

Variables

const struct shell_transport_api shell_telnet_transport_api
 

Macro Definition Documentation

◆ SHELL_TELNET_DEFINE

#define SHELL_TELNET_DEFINE ( _name)
Value:
static struct shell_telnet _name##_shell_telnet; \
struct shell_transport _name = { \
.ctx = (struct shell_telnet *)&_name##_shell_telnet \
}
const struct shell_transport_api shell_telnet_transport_api
TELNET-based shell transport.
Definition shell_telnet.h:32
Definition shell.h:724

◆ SHELL_TELNET_MAX_CMD_SIZE

#define SHELL_TELNET_MAX_CMD_SIZE   3

◆ SHELL_TELNET_POLLFD_COUNT

#define SHELL_TELNET_POLLFD_COUNT   3

Function Documentation

◆ shell_backend_telnet_get_ptr()

const struct shell * shell_backend_telnet_get_ptr ( void )

This function provides pointer to shell telnet backend instance.

Function returns pointer to the shell telnet instance. This instance can be next used with shell_execute_cmd function in order to test commands behavior.

Returns
Pointer to the shell instance.

Variable Documentation

◆ shell_telnet_transport_api

const struct shell_transport_api shell_telnet_transport_api
extern