Embedded TCP/IP stack: fnet_telnet.h Source File

FNET

previous page next page
fnet_telnet.h
1 /**************************************************************************
2 *
3 * Copyright 2011-2016 by Andrey Butok. FNET Community.
4 * Copyright 2008-2010 by Andrey Butok. Freescale Semiconductor, Inc.
5 *
6 ***************************************************************************
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 *
20 ***************************************************************************
21 *
22 * FNET Telnet Server API.
23 *
24 ***************************************************************************/
25 
26 #ifndef _FNET_TELNET_H_
27 
28 #define _FNET_TELNET_H_
29 
30 #if FNET_CFG_TELNET || defined(__DOXYGEN__)
31 
99 /**************************************************************************/
102 struct fnet_telnet_params
103 {
104  struct fnet_sockaddr address;
108  const struct fnet_shell *shell;
109 };
110 
111 /**************************************************************************/
115 typedef void *fnet_telnet_desc_t;
116 
117 #if defined(__cplusplus)
118 extern "C" {
119 #endif
120 
121 /***************************************************************************/
144 fnet_telnet_desc_t fnet_telnet_init( struct fnet_telnet_params *params);
145 
146 /***************************************************************************/
162 void fnet_telnet_release(fnet_telnet_desc_t desc);
163 
164 /***************************************************************************/
177 void fnet_telnet_close_session(fnet_telnet_desc_t desc);
178 
179 /***************************************************************************/
194 fnet_bool_t fnet_telnet_is_enabled(fnet_telnet_desc_t desc);
195 
196 #if defined(__cplusplus)
197 }
198 #endif
199 
202 #endif /* FNET_CFG_TELNET */
203 
204 #endif /* _FNET_TELNET_H_ */
fnet_telnet_desc_t
void * fnet_telnet_desc_t
Telnet server descriptor.
Definition: fnet_telnet.h:115
fnet_telnet_params::shell
const struct fnet_shell * shell
Root-shell structure.
Definition: fnet_telnet.h:108
fnet_telnet_params
Input parameters for fnet_telnet_init().
Definition: fnet_telnet.h:102
fnet_shell
Shell main control structure.
Definition: fnet_shell.h:220
fnet_telnet_close_session
void fnet_telnet_close_session(fnet_telnet_desc_t desc)
Closes the currently active session of the Telnet Server.
fnet_telnet_init
fnet_telnet_desc_t fnet_telnet_init(struct fnet_telnet_params *params)
Initializes the Telnet Server service.
fnet_telnet_params::address
struct fnet_sockaddr address
Server socket address. If server IP address is set to 0s, the server will listen to all current net...
Definition: fnet_telnet.h:104
fnet_bool_t
fnet_bool_t
Boolean type.
Definition: fnet_stdlib.h:81
fnet_telnet_is_enabled
fnet_bool_t fnet_telnet_is_enabled(fnet_telnet_desc_t desc)
Detects if the Telnet Server service is enabled or disabled.
fnet_telnet_release
void fnet_telnet_release(fnet_telnet_desc_t desc)
Releases the Telnet Server service.
fnet_sockaddr
Socket address structure.
Definition: fnet_socket.h:270
© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net
previous page start next page