telnet.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 ML!PA Consulting GmbH
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
44 #ifndef NET_TELNET_H
45 #define NET_TELNET_H
46 
47 #include "net/sock/tcp.h"
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
56 #ifndef CONFIG_TELNET_PORT
57 #define CONFIG_TELNET_PORT (23)
58 #endif
59 
65 int telnet_server_start(void);
66 
75 ssize_t telnet_server_write(const void* buffer, size_t len);
76 
85 int telnet_server_read(void* buffer, size_t count);
86 
93 void telnet_server_disconnect(void);
94 
102 void telnet_cb_pre_connected(sock_tcp_t *sock);
103 
111 void telnet_cb_connected(sock_tcp_t *sock);
112 
116 void telnet_cb_disconneced(void);
117 
118 #ifdef __cplusplus
119 }
120 #endif
121 
122 #endif /* NET_TELNET_H */
telnet_cb_pre_connected
void telnet_cb_pre_connected(sock_tcp_t *sock)
Callback function that gets called when a telnet client connects but before stdio is redirected.
telnet_server_read
int telnet_server_read(void *buffer, size_t count)
Read data from the telnet client, will block until data is available.
telnet_server_disconnect
void telnet_server_disconnect(void)
Request to disconnect the current client.
telnet_cb_connected
void telnet_cb_connected(sock_tcp_t *sock)
Callback function that gets called when a telnet client connects after stdio is redirected.
telnet_server_start
int telnet_server_start(void)
Start the Telnet server thread.
telnet_server_write
ssize_t telnet_server_write(const void *buffer, size_t len)
Write data to the telnet client.
telnet_cb_disconneced
void telnet_cb_disconneced(void)
Callback function that gets called after a telnet client disconnected.
tcp.h
TCP sock definitions.
sock_tcp
TCP sock type.
Definition: sock_types.h:101