@CHIP-RTOS C Library - TCP/IP API

Dev_PPP_Register_Chap

Register a PPP CHAP authentication callback function.

int Dev_PPP_Register_Chap(DevUserIfaceHandle DevHandlePtr,
                             const void far * AuthCallbackFunction,
                             int *error);

Parameters

DevHandlePtr

Device handle

AuthCallbackFunction

Pointer to the authentication callback function.

error

Output parameter:  Failure code, 0 on success.

Return Value

0: success
-1: failed

Comments

The prototype of the user provided function is defined as:

char huge * myCHAPAuthenticate(char *username) ;

which returns the password (secret) corresponding to this user.   If the user name is invalid, this function must return a NULL pointer.

See Also

Dev_PPP_Register_Pap        Dev_PPP_Set_Option        Dev_PPP_Get_Peer_IP
Dev_PPP_Get_Peer_DNSIP        Dev_PPP_Get_Peer_IPv6        

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

On SC1x3/SC2x (RTOS version >=1.13, CLIB version >=2.10) there's also a version of this function which uses dynamic linking instead of a software interrupt, which reduces the function's overhead and thus speeds up your application. This function's name is Dev_PPP_Register_Chap_Dyn. You should however not use this function directly. Instead you should add the define TCPIP_DYN_LINK_DEV to your program before including the CLIB's header file(s):

#define TCPIP_DYN_LINK_DEV
#include <clib.h>

This will map the original function's name to the dynamic linking version. This way you can also easily switch existing programs to dynamic linking.

Related Topics

TCP/IP Device Driver overview

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.11	V1.01	V1.01	V0.90	V1.00