Serial HDLC Client and Server Support
C-15
Point to Point Protocol
Username
Pointer to client account username
Password
Pointer to client account password
Return Value
If it succeeds, the function returns a handle to a PPPoE client instance. Else,
it returns NULL.
Description
This function is called to create a new serial HDLC client instance on the physi-
cal serial interface specified by the index Dev.
-
pppFlags – The flags determine what type of connection instance to
create, and what type of options to support in the connection instance. In
the pppFlags parameter, the following flags must be set:
PPPFLG_CLIENT Create PPP client connection instance
In addition, any of the following flag can also be set:
PPPFLG_OPT_USE_MSE
Use MS extensions as client
PPPFLG_SIOPT_SENDCMAP
Send an async character map
(strongly recommended)
PPPFLG_SIOPT_RECVCMAP
Accept an async character map
(strongly recommended)
-
cmap – This is the desired value of the async character control map that
is sent to the peer to allow frame compression by skipping the escape cod-
ing of characters when it is not required. The mask contains set bit for each
character (0 to 31) that must be escaped when sent by the peer. If the
PPPFLG_SIOPT_SENDCMAP option is not set, it is assumed that all 32
characters must be sent via the escape sequence.
-
Username – This is a pointer to a NULL terminated string containing the
username to use in PAP or CHAP authentication. The maximum string
length is defined by PPPNAMELEN.
-
Password – This is a pointer to a NULL terminated string containing the
password to use in PAP or CHAP authentication. The maximum string
length is defined by PPPNAMELEN.
When successful, this function returns a handle to a new serial HDLC instance
The current status of the connection can be queried at any time by calling
hdlcGetStatus().