Network Developers Kit API 3.61.01.01

telnetif.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2012-2018, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * */
32 /*
33 * ======== telnetif.h ========
34 *
35 */
36
47 #ifndef _TELNETIF_H_
48 #define _TELNETIF_H_
49
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56
57 /* TELNET SERVICE */
58
59 /* Telnet Parameter Structure */
60 typedef struct _ntparam_telnet {
61 int MaxCon;
62 int Port;
66 SOCKET (*Callback)(struct sockaddr *);
67 } NTPARAM_TELNET;
68
91 extern void *TelnetOpen( NTARGS *pNTA, NTPARAM_TELNET *pNTP );
92
105 extern void TelnetClose( void *hTelnet );
106
108 /*
109 * This is typically an internal fxn, so is not documented. However,
110 * IPv6 users do need access to this symbol for reasons described in
111 * the API users guide.
112 *
113 * TODO: this needs to be simpler for IPv6 users.
114 */
115
116 extern int telnetClientProcess( SOCKET s, SOCKET (*cbfn)(struct sockaddr *) );
117
121 #ifdef __cplusplus
122 }
123 #endif /* extern "C" */
124
125 #endif
_ntparam_telnet::Port
int Port
Definition: telnetif.h:62
_ntparam_telnet::MaxCon
int MaxCon
Definition: telnetif.h:61
TelnetClose
void TelnetClose(void *hTelnet)
Destroy an instance of the Telnet Server.
_ntparam_telnet
Definition: telnetif.h:60
SOCKET
void * SOCKET
Definition: socketndk.h:84
sockaddr
Definition: socketndk.h:202
TelnetOpen
void * TelnetOpen(NTARGS *pNTA, NTPARAM_TELNET *pNTP)
Create an instance of the Telnet Server.
_ntparam_telnet::Callback
SOCKET(* Callback)(struct sockaddr *)
Definition: telnetif.h:66
NTPARAM_TELNET
struct _ntparam_telnet NTPARAM_TELNET

© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale