Network Component  Version 7.11.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetTeln: Telnet Server

Events generated by the Network - Telnet Server functions. More...

Functions

__STATIC_INLINE void EvrNetTeln_InitServer (uint32_t num_sessions, uint16_t port, uint16_t idle_tout)
 Event on Telnet server initialize (Op) More...
 
__STATIC_INLINE void EvrNetTeln_GetSocketFailed (uint8_t session)
 Event on Telnet server failed to allocate TCP socket (Error) More...
 
__STATIC_INLINE void EvrNetTeln_SetUsername (const char *username, uint32_t length)
 Event on Telnet server netTELNETs_SetUsername (API) More...
 
__STATIC_INLINE void EvrNetTeln_SetPassword (const char *password, uint32_t length)
 Event on Telnet server netTELNETs_SetPassword (API) More...
 
__STATIC_INLINE void EvrNetTeln_StartService (uint16_t port)
 Event on Telnet server start service (Op) More...
 
__STATIC_INLINE void EvrNetTeln_StopService (void)
 Event on Telnet server stop service (Op) More...
 
__STATIC_INLINE void EvrNetTeln_CloseSession (uint8_t session)
 Event on Telnet server session close (Op) More...
 
__STATIC_INLINE void EvrNetTeln_ProcessData (uint8_t session, uint32_t length)
 Event on Telnet server process client data (Op) More...
 
__STATIC_INLINE void EvrNetTeln_ProcessCommand (const char *command, uint32_t length)
 Event on Telnet server process client command (Op) More...
 
__STATIC_INLINE void EvrNetTeln_EchoBackspace (uint8_t session)
 Event on Telnet server echo backspace (Op) More...
 
__STATIC_INLINE void EvrNetTeln_CommandHistory (const char *command, uint32_t length)
 Event on Telnet server process command history (Op) More...
 
__STATIC_INLINE void EvrNetTeln_EchoCharacters (uint8_t *line_buffer, uint32_t num_char)
 Event on Telnet server echo the characters from command line buffer (Op) More...
 
__STATIC_INLINE void EvrNetTeln_LineBufferUsage (uint8_t session, uint32_t num_char)
 Event on Telnet server display command line buffer usage (Op) More...
 
__STATIC_INLINE void EvrNetTeln_SendAuthorizationRequest (uint8_t session)
 Event on Telnet server send authorization request to the client (Op) More...
 
__STATIC_INLINE void EvrNetTeln_SendInitialHeader (uint8_t session)
 Event on Telnet server send initial telnet header to the client (Op) More...
 
__STATIC_INLINE void EvrNetTeln_LoginTimeoutExpired (uint8_t session)
 Event on Telnet server login timeout expired (Op) More...
 
__STATIC_INLINE void EvrNetTeln_ShowPassword (const char *password, uint32_t length)
 Event on Telnet server display password of the client (Op) More...
 
__STATIC_INLINE void EvrNetTeln_AuthenticationFailed (uint8_t session)
 Event on Telnet server user authentication failed, invalid credentials (Error) More...
 
__STATIC_INLINE void EvrNetTeln_UserLoginSuccess (uint8_t session)
 Event on Telnet server user login successful (Op) More...
 
__STATIC_INLINE void EvrNetTeln_ShowUsername (const char *username, uint32_t length)
 Event on Telnet server display username of the client (Op) More...
 
__STATIC_INLINE void EvrNetTeln_NegotiateStart (uint8_t session)
 Event on Telnet server option negotiation start (Op) More...
 
__STATIC_INLINE void EvrNetTeln_NegotiateFailed (uint8_t session)
 Event on Telnet server option negotiation failed (Error) More...
 
__STATIC_INLINE void EvrNetTeln_UserAccessDeniedIp4 (const void *net_addr)
 Event on Telnet server user denied access for IPv4 client (Error) More...
 
__STATIC_INLINE void EvrNetTeln_UserAccessDeniedIp6 (const void *net_addr)
 Event on Telnet server user denied access for IPv6 client (Error) More...
 
__STATIC_INLINE void EvrNetTeln_SessionOpen (uint8_t session)
 Event on Telnet server session open (Op) More...
 
__STATIC_INLINE void EvrNetTeln_SocketAborted (uint8_t session)
 Event on Telnet server socket aborted (Op) More...
 
__STATIC_INLINE void EvrNetTeln_SocketClosed (uint8_t session)
 Event on Telnet server socket closed (Op) More...
 
__STATIC_INLINE void EvrNetTeln_ReceiveFrame (uint8_t session, uint32_t length)
 Event on Telnet server receive frame (Op) More...
 
__STATIC_INLINE void EvrNetTeln_NegotiateSuccess (uint8_t session)
 Event on Telnet server option negotiation success (Op) More...
 
__STATIC_INLINE void EvrNetTeln_UninitServer (void)
 Event on Telnet server de-initialize (Op) More...
 

Description

Events generated by the Network - Telnet Server functions.

Function Documentation

__STATIC_INLINE void EvrNetTeln_AuthenticationFailed ( uint8_t  session)

Event on Telnet server user authentication failed, invalid credentials (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_CloseSession ( uint8_t  session)

Event on Telnet server session close (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_CommandHistory ( const char *  command,
uint32_t  length 
)

Event on Telnet server process command history (Op)

Parameters
commandcommand from the command history
lengthlength of the command string
__STATIC_INLINE void EvrNetTeln_EchoBackspace ( uint8_t  session)

Event on Telnet server echo backspace (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_EchoCharacters ( uint8_t *  line_buffer,
uint32_t  num_char 
)

Event on Telnet server echo the characters from command line buffer (Op)

Parameters
line_buffercommand line buffer
num_charnumber of characters to echo
__STATIC_INLINE void EvrNetTeln_GetSocketFailed ( uint8_t  session)

Event on Telnet server failed to allocate TCP socket (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_InitServer ( uint32_t  num_sessions,
uint16_t  port,
uint16_t  idle_tout 
)

Event on Telnet server initialize (Op)

Parameters
num_sessionsnumber of available Telnet sessions
portlistening port number
idle_toutidle timeout in seconds (0= permanent connection)
__STATIC_INLINE void EvrNetTeln_LineBufferUsage ( uint8_t  session,
uint32_t  num_char 
)

Event on Telnet server display command line buffer usage (Op)

Parameters
sessionsession number
num_charnumber of characters in command line buffer
__STATIC_INLINE void EvrNetTeln_LoginTimeoutExpired ( uint8_t  session)

Event on Telnet server login timeout expired (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_NegotiateFailed ( uint8_t  session)

Event on Telnet server option negotiation failed (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_NegotiateStart ( uint8_t  session)

Event on Telnet server option negotiation start (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_NegotiateSuccess ( uint8_t  session)

Event on Telnet server option negotiation success (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_ProcessCommand ( const char *  command,
uint32_t  length 
)

Event on Telnet server process client command (Op)

Parameters
commanduser entered command to process
lengthlength of the command string
__STATIC_INLINE void EvrNetTeln_ProcessData ( uint8_t  session,
uint32_t  length 
)

Event on Telnet server process client data (Op)

Parameters
sessionsession number
lengthlength of client data to process
__STATIC_INLINE void EvrNetTeln_ReceiveFrame ( uint8_t  session,
uint32_t  length 
)

Event on Telnet server receive frame (Op)

Parameters
sessionsession number
lengthframe length in bytes
__STATIC_INLINE void EvrNetTeln_SendAuthorizationRequest ( uint8_t  session)

Event on Telnet server send authorization request to the client (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_SendInitialHeader ( uint8_t  session)

Event on Telnet server send initial telnet header to the client (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_SessionOpen ( uint8_t  session)

Event on Telnet server session open (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_SetPassword ( const char *  password,
uint32_t  length 
)

Event on Telnet server netTELNETs_SetPassword (API)

Parameters
passwordnew password
lengthlength of the password string
__STATIC_INLINE void EvrNetTeln_SetUsername ( const char *  username,
uint32_t  length 
)

Event on Telnet server netTELNETs_SetUsername (API)

Parameters
usernamenew username
lengthlength of the username string
__STATIC_INLINE void EvrNetTeln_ShowPassword ( const char *  password,
uint32_t  length 
)

Event on Telnet server display password of the client (Op)

Parameters
passwordpassword entered by the client
lengthlength of the password string
__STATIC_INLINE void EvrNetTeln_ShowUsername ( const char *  username,
uint32_t  length 
)

Event on Telnet server display username of the client (Op)

Parameters
usernameusername entered by the client
lengthlength of the username string
__STATIC_INLINE void EvrNetTeln_SocketAborted ( uint8_t  session)

Event on Telnet server socket aborted (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_SocketClosed ( uint8_t  session)

Event on Telnet server socket closed (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetTeln_StartService ( uint16_t  port)

Event on Telnet server start service (Op)

Parameters
portlistening port number
__STATIC_INLINE void EvrNetTeln_StopService ( void  )

Event on Telnet server stop service (Op)

__STATIC_INLINE void EvrNetTeln_UninitServer ( void  )

Event on Telnet server de-initialize (Op)

__STATIC_INLINE void EvrNetTeln_UserAccessDeniedIp4 ( const void *  net_addr)

Event on Telnet server user denied access for IPv4 client (Error)

Parameters
net_addrpointer to NET_ADDR4 address structure (8 bytes)
Remarks
Sends reduced size of net address structure with IPv4 address only.
__STATIC_INLINE void EvrNetTeln_UserAccessDeniedIp6 ( const void *  net_addr)

Event on Telnet server user denied access for IPv6 client (Error)

Parameters
net_addrpointer to NET_ADDR address structure (20 bytes)
Remarks
Sends full size of net address structure with IPv6 address only.
__STATIC_INLINE void EvrNetTeln_UserLoginSuccess ( uint8_t  session)

Event on Telnet server user login successful (Op)

Parameters
sessionsession number