1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2025-present Eclipse ThreadX Contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** TELNET Server Protocol (TELNET Server) */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* APPLICATION INTERFACE DEFINITION RELEASE */
/* */
/* nxd_telnet_server.h PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file defines the NetX Duo TELNET Protocol (TELNET) component, */
/* including all data types and external references. */
/* It is assumed that nx_api.h and nx_port.h have already been */
/* included. */
/* */
/**************************************************************************/
#ifndef NXD_TELNET_SERVER_H
#define NXD_TELNET_SERVER_H
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
#include "nx_api.h"
/* Define the Server TELNET ID. */
#define NX_TELNET_SERVER_ID 0x54454C4EUL
/* Defined, option negotiation is disabled.
#define NX_TELNET_SERVER_OPTION_DISABLE
*/
#ifndef NX_TELNET_SERVER_OPTION_DISABLE
/* If NX_TELNET_SERVER_OPTION_DISABLE is not defined, and Telnet Server
needs a packet pool, this option lets the application create the packet
pool instead of the Telnet Server.
#define NX_TELNET_SERVER_USER_CREATE_PACKET_POOL
*/
#endif /* NX_TELNET_SERVER_OPTION_DISABLE */
/* Define the maximum number of clients the TELNET Server can accommodate. */
#ifndef NX_TELNET_MAX_CLIENTS
#define NX_TELNET_MAX_CLIENTS 4
#endif
/* Define TELNET TCP socket create options. */
#ifndef NX_TELNET_TOS
#define NX_TELNET_TOS NX_IP_NORMAL
#endif
#ifndef NX_TELNET_FRAGMENT_OPTION
#define NX_TELNET_FRAGMENT_OPTION NX_DONT_FRAGMENT
#endif
#ifndef NX_TELNET_SERVER_WINDOW_SIZE
#define NX_TELNET_SERVER_WINDOW_SIZE 2048
#endif
#ifndef NX_TELNET_TIME_TO_LIVE
#define NX_TELNET_TIME_TO_LIVE 0x80
#endif
#ifndef NX_TELNET_SERVER_TIMEOUT
#define NX_TELNET_SERVER_TIMEOUT (10 * NX_IP_PERIODIC_RATE)
#endif
#ifndef NX_TELNET_SERVER_PRIORITY
#define NX_TELNET_SERVER_PRIORITY 16
#endif
#ifndef NX_TELNET_ACTIVITY_TIMEOUT
#define NX_TELNET_ACTIVITY_TIMEOUT 600 /* Seconds allowed with no activity */
#endif
#ifndef NX_TELNET_TIMEOUT_PERIOD
#define NX_TELNET_TIMEOUT_PERIOD 60 /* Number of seconds to check */
#endif
/* Define TELNET commands that are optionally included in the TELNET data. The application is responsible for
recognizing and responding to the commands in accordance with the specification. The TELNET option command
requires three bytes, as follows:
IAC, COMMAND, OPTION ID
*/
/* Define byte indicating TELNET command follows. */
#define NX_TELNET_IAC 255 /* TELNET Command byte - two consecutive -> 255 data */
/* Define TELNET Negotiation Commands - Immediately follows IAC. */
#define NX_TELNET_WILL 251 /* TELNET WILL - Sender wants to enable the option */
#define NX_TELNET_WONT 252 /* TELNET WONT - Sender wants to disable the option */
#define NX_TELNET_DO 253 /* TELNET DO - Sender wants receiver to enable option */
#define NX_TELNET_DONT 254 /* TELNET DONT - Sender wants receiver to disable option*/
/* Define the Telnet Server packet payload. */
#ifndef NX_TELNET_SERVER_PACKET_PAYLOAD
#define NX_TELNET_SERVER_PACKET_PAYLOAD 300
#endif
/* Define the size of the Telnet Server packet pool. This will allow room for about
5-6 packets of 300 byte payload. */
#ifndef NX_TELNET_SERVER_PACKET_POOL_SIZE
#define NX_TELNET_SERVER_PACKET_POOL_SIZE 2048
#endif
#ifndef NX_TELNET_SERVER_OPTION_DISABLE
/* Define TELNET Option IDs. */
#define NX_TELNET_ECHO 1 /* TELNET ECHO Option */
#define NX_TELNET_SGA 3 /* TELNET SGA Option */
#endif /* NX_TELNET_SERVER_OPTION_DISABLE */
/* Define Server thread events. */
#define NX_TELNET_SERVER_CONNECT 0x01 /* TELNET connection is present */
#define NX_TELNET_SERVER_DISCONNECT 0x02 /* TELNET disconnection is present */
#define NX_TELNET_SERVER_DATA 0x04 /* TELNET receive data is present */
#define NX_TELNET_SERVER_ACTIVITY_TIMEOUT 0x08 /* TELNET activity timeout check */
#define NX_TELNET_STOP_EVENT 0x10 /* TELNET stop service */
#define NX_TELNET_ANY_EVENT 0xFF /* Any TELNET event */
/* Define return code constants. */
#define NX_TELNET_ERROR 0xF0 /* TELNET internal error */
#define NX_TELNET_TIMEOUT 0xF1 /* TELNET timeout occurred */
#define NX_TELNET_FAILED 0xF2 /* TELNET error */
#define NX_TELNET_NOT_CONNECTED 0xF3 /* TELNET not connected error */
#define NX_TELNET_NOT_DISCONNECTED 0xF4 /* TELNET not disconnected error */
#define NX_TELNET_INVALID_PARAMETER 0xF5 /* Invalid non pointer input to Telnet function */
#define NX_TELNET_NO_PACKET_POOL 0xF6 /* Telnet server packet pool not set */
/* Define the TELNET Server TCP port numbers. */
#ifndef NX_TELNET_SERVER_PORT
#define NX_TELNET_SERVER_PORT 23 /* Default Port for TELNET server */
#endif
/* Define the per client request structure for the TELNET Server data structure. */
typedef struct NX_TELNET_CLIENT_REQUEST_STRUCT
{
UINT nx_telnet_client_request_connection; /* Logical connection number */
ULONG nx_telnet_client_request_activity_timeout; /* Timeout for client activity */
ULONG nx_telnet_client_request_total_bytes; /* Total bytes read or written */
NX_TCP_SOCKET nx_telnet_client_request_socket; /* Client request socket */
#ifndef NX_TELNET_SERVER_OPTION_DISABLE
USHORT nx_telnet_client_agree_server_will_echo_success; /* True if server will echo negotiation success */
USHORT nx_telnet_client_agree_server_will_SGA_success; /* True if server will SGA negotiation success */
#endif /* NX_TELNET_SERVER_OPTION_DISABLE */
} NX_TELNET_CLIENT_REQUEST;
/* Define the TELNET Server data structure. */
typedef struct NX_TELNET_SERVER_STRUCT
{
ULONG nx_telnet_server_id; /* TELNET Server ID */
CHAR *nx_telnet_server_name; /* Name of this TELNET server */
NX_IP *nx_telnet_server_ip_ptr; /* Pointer to associated IP structure */
ULONG nx_telnet_server_connection_requests; /* Number of connection requests */
ULONG nx_telnet_server_disconnection_requests; /* Number of disconnection requests */
ULONG nx_telnet_server_total_bytes_sent; /* Number of total bytes sent */
ULONG nx_telnet_server_total_bytes_received; /* Number of total bytes received */
ULONG nx_telnet_server_relisten_errors; /* Number of relisten errors */
ULONG nx_telnet_server_activity_timeouts; /* Number of activity timeouts */
ULONG nx_telnet_server_open_connections; /* Number of currently open connections */
#ifndef NX_TELNET_SERVER_OPTION_DISABLE
#ifndef NX_TELNET_SERVER_USER_CREATE_PACKET_POOL
UCHAR nx_telnet_server_pool_area[NX_TELNET_SERVER_PACKET_POOL_SIZE];
NX_PACKET_POOL nx_telnet_server_packet_pool; /* Server TCP packet pool
for telnet option messages */
#endif /* NX_TELNET_SERVER_USER_CREATE_PACKET_POOL */
NX_PACKET_POOL *nx_telnet_server_packet_pool_ptr; /* Pointer to packet pool */
#endif /* NX_TELNET_SERVER_OPTION_DISABLE */
NX_TELNET_CLIENT_REQUEST /* TELNET client request array */
nx_telnet_server_client_list[NX_TELNET_MAX_CLIENTS];
TX_EVENT_FLAGS_GROUP
nx_telnet_server_event_flags; /* TELNET server thread events */
TX_TIMER nx_telnet_server_timer; /* TELNET server activity timeout timer */
TX_THREAD nx_telnet_server_thread; /* TELNET server thread */
void (*nx_telnet_new_connection)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection);
void (*nx_telnet_receive_data)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection, NX_PACKET *packet_ptr);
void (*nx_telnet_connection_end)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection);
void (*nx_telnet_set_echo)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection, UINT echo_flag);
} NX_TELNET_SERVER;
#ifndef NX_TELNET_SOURCE_CODE
/* Application caller is present, perform API mapping. */
/* Determine if error checking is desired. If so, map API functions
to the appropriate error checking front-ends. Otherwise, map API
functions to the core functions that actually perform the work.
Note: error checking is enabled by default. */
#ifdef NX_DISABLE_ERROR_CHECKING
/* Services without error checking. */
#define nx_telnet_server_create _nx_telnet_server_create
#define nx_telnet_server_delete _nx_telnet_server_delete
#define nx_telnet_server_disconnect _nx_telnet_server_disconnect
#define nx_telnet_server_packet_send _nx_telnet_server_packet_send
#ifdef NX_TELNET_SERVER_USER_CREATE_PACKET_POOL
#define nx_telnet_server_packet_pool_set _nx_telnet_server_packet_pool_set
#endif /* NX_TELNET_SERVER_USER_CREATE_PACKET_POOL */
#define nx_telnet_server_start _nx_telnet_server_start
#define nx_telnet_server_stop _nx_telnet_server_stop
#define nx_telnet_server_get_open_connection_count _nx_telnet_server_get_open_connection_count
#else
/* Services with error checking. */
#define nx_telnet_server_create _nxe_telnet_server_create
#define nx_telnet_server_delete _nxe_telnet_server_delete
#define nx_telnet_server_disconnect _nxe_telnet_server_disconnect
#define nx_telnet_server_packet_send _nxe_telnet_server_packet_send
#ifdef NX_TELNET_SERVER_USER_CREATE_PACKET_POOL
#define nx_telnet_server_packet_pool_set _nxe_telnet_server_packet_pool_set
#endif /* NX_TELNET_SERVER_USER_CREATE_PACKET_POOL */
#define nx_telnet_server_start _nxe_telnet_server_start
#define nx_telnet_server_stop _nxe_telnet_server_stop
#define nx_telnet_server_get_open_connection_count _nxe_telnet_server_get_open_connection_count
#endif
/* Define the prototypes accessible to the application software. */
UINT nx_telnet_server_create(NX_TELNET_SERVER *server_ptr, CHAR *server_name, NX_IP *ip_ptr, VOID *stack_ptr, ULONG stack_size,
void (*new_connection)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection),
void (*receive_data)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection, NX_PACKET *packet_ptr),
void (*connection_end)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection));
UINT nx_telnet_server_delete(NX_TELNET_SERVER *server_ptr);
UINT nx_telnet_server_disconnect(NX_TELNET_SERVER *server_ptr, UINT logical_connection);
UINT nx_telnet_server_packet_send(NX_TELNET_SERVER *server_ptr, UINT logical_connection, NX_PACKET *packet_ptr, ULONG wait_option);
#ifdef NX_TELNET_SERVER_USER_CREATE_PACKET_POOL
UINT nx_telnet_server_packet_pool_set(NX_TELNET_SERVER *server_ptr, NX_PACKET_POOL *pool_ptr);
#endif /* NX_TELNET_SERVER_USER_CREATE_PACKET_POOL */
UINT nx_telnet_server_start(NX_TELNET_SERVER *server_ptr);
UINT nx_telnet_server_stop(NX_TELNET_SERVER *server_ptr);
UINT nx_telnet_server_get_open_connection_count(NX_TELNET_SERVER *server_ptr, UINT *current_connections);
#else
/* TELNET source code is being compiled, do not perform any API mapping. */
UINT _nxe_telnet_server_create(NX_TELNET_SERVER *server_ptr, CHAR *server_name, NX_IP *ip_ptr, VOID *stack_ptr, ULONG stack_size,
void (*new_connection)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection),
void (*receive_data)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection, NX_PACKET *packet_ptr),
void (*connection_end)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection));
UINT _nx_telnet_server_create(NX_TELNET_SERVER *server_ptr, CHAR *server_name, NX_IP *ip_ptr, VOID *stack_ptr, ULONG stack_size,
void (*new_connection)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection),
void (*receive_data)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection, NX_PACKET *packet_ptr),
void (*connection_end)(struct NX_TELNET_SERVER_STRUCT *telnet_server_ptr, UINT logical_connection));
UINT _nxe_telnet_server_delete(NX_TELNET_SERVER *server_ptr);
UINT _nx_telnet_server_delete(NX_TELNET_SERVER *server_ptr);
UINT _nxe_telnet_server_disconnect(NX_TELNET_SERVER *server_ptr, UINT logical_connection);
UINT _nx_telnet_server_disconnect(NX_TELNET_SERVER *server_ptr, UINT logical_connection);
UINT _nxe_telnet_server_packet_send(NX_TELNET_SERVER *server_ptr, UINT logical_connection, NX_PACKET *packet_ptr, ULONG wait_option);
UINT _nx_telnet_server_packet_send(NX_TELNET_SERVER *server_ptr, UINT logical_connection, NX_PACKET *packet_ptr, ULONG wait_option);
#ifdef NX_TELNET_SERVER_USER_CREATE_PACKET_POOL
UINT _nxe_telnet_server_packet_pool_set(NX_TELNET_SERVER *server_ptr, NX_PACKET_POOL *pool_ptr);
UINT _nx_telnet_server_packet_pool_set(NX_TELNET_SERVER *server_ptr, NX_PACKET_POOL *pool_ptr);
#endif /* NX_TELNET_SERVER_USER_CREATE_PACKET_POOL */
UINT _nxe_telnet_server_start(NX_TELNET_SERVER *server_ptr);
UINT _nx_telnet_server_start(NX_TELNET_SERVER *server_ptr);
UINT _nxe_telnet_server_stop(NX_TELNET_SERVER *server_ptr);
UINT _nx_telnet_server_stop(NX_TELNET_SERVER *server_ptr);
UINT _nxe_telnet_server_get_open_connection_count(NX_TELNET_SERVER *server_ptr, UINT *current_connections);
UINT _nx_telnet_server_get_open_connection_count(NX_TELNET_SERVER *server_ptr, UINT *current_connections);
/* Define internal TELNET functions. */
VOID _nx_telnet_server_thread_entry(ULONG telnet_server);
VOID _nx_telnet_server_connect_process(NX_TELNET_SERVER *server_ptr);
VOID _nx_telnet_server_connection_present(NX_TCP_SOCKET *socket_ptr, UINT port);
VOID _nx_telnet_server_disconnect_present(NX_TCP_SOCKET *socket_ptr);
VOID _nx_telnet_server_disconnect_process(NX_TELNET_SERVER *server_ptr);
VOID _nx_telnet_server_data_present(NX_TCP_SOCKET *socket_ptr);
VOID _nx_telnet_server_data_process(NX_TELNET_SERVER *server_ptr);
VOID _nx_telnet_server_timeout(ULONG telnet_server_address);
VOID _nx_telnet_server_timeout_processing(NX_TELNET_SERVER *server_ptr);
#ifndef NX_TELNET_SERVER_OPTION_DISABLE
UINT _nx_telnet_server_send_option_requests(NX_TELNET_SERVER *server_ptr, NX_TELNET_CLIENT_REQUEST *client_req_ptr);
VOID _nx_telnet_server_process_option(NX_TELNET_SERVER *server_ptr, NX_PACKET *packet_ptr, UINT *offset, NX_TELNET_CLIENT_REQUEST *client_request_ptr);
VOID _nx_telnet_server_create_option_packet(UCHAR option_message_type, UCHAR option_id, UCHAR *stream);
#endif /* NX_TELNET_SERVER_OPTION_DISABLE */
#endif
/* Determine if a C++ compiler is being used. If so, complete the standard
C conditional started above. */
#ifdef __cplusplus
}
#endif
#endif /* NXD_TELNET_SERVER_H */
|
