VxWorks Reference Manual : Libraries

pppShow

NAME

pppShow - Point-to-Point Protocol show routines

ROUTINES

pppInfoShow( ) - display PPP link status information
pppInfoGet( ) - get PPP link status information
pppstatShow( ) - display PPP link statistics
pppstatGet( ) - get PPP link statistics
pppSecretShow( ) - display the PPP authentication secrets table

DESCRIPTION

This library provides routines to show Point-to-Point Protocol (PPP) link status information and statistics. Also provided are routines that programmatically access this same information.

This library is automatically linked into the VxWorks system image when the configuration macro INCLUDE_PPP is defined.

INCLUDE FILES

pppLib.h

SEE ALSO

pppShow, pppLib, VxWorks Programmer's Guide: Network

---

Libraries : Routines

pppInfoShow( )

NAME

pppInfoShow( ) - display PPP link status information

SYNOPSIS

void pppInfoShow (void)

DESCRIPTION

This routine displays status information pertaining to each initialized Point-to-Point Protocol (PPP) link, regardless of the link state. State and option information is gathered for the Link Control Protocol (LCP), Internet Protocol Control Protocol (IPCP), Password Authentication Protocol (PAP), and Challenge-Handshake Authentication Protocol (CHAP).

RETURNS

N/A

SEE ALSO

pppShow, pppLib

---

Libraries : Routines

pppInfoGet( )

NAME

pppInfoGet( ) - get PPP link status information

SYNOPSIS

STATUS pppInfoGet
    (
    int        unit, /* PPP interface unit number to examine */
    PPP_INFO * pInfo /* PPP_INFO structure to be filled */
    )

DESCRIPTION

This routine gets status information pertaining to the specified Point-to-Point Protocol (PPP) link, regardless of the link state. State and option information is gathered for the Link Control Protocol (LCP), Internet Protocol Control Protocol (IPCP), Password Authentication Protocol (PAP), and Challenge-Handshake Authentication Protocol (CHAP).

The PPP link information is returned through a PPP_INFO structure, which is defined in h/netinet/ppp/pppShow.h.

RETURNS

OK, or ERROR if unit is an invalid PPP unit number.

SEE ALSO

pppShow, pppLib

---

Libraries : Routines

pppstatShow( )

NAME

pppstatShow( ) - display PPP link statistics

SYNOPSIS

void pppstatShow (void)

DESCRIPTION

This routine displays statistics for each initialized Point-to-Point Protocol (PPP) link. Detailed are the numbers of bytes and packets received and sent through each PPP interface.

RETURNS

N/A

SEE ALSO

pppShow, pppLib

---

Libraries : Routines

pppstatGet( )

NAME

pppstatGet( ) - get PPP link statistics

SYNOPSIS

STATUS pppstatGet
    (
    int        unit, /* PPP interface unit number to examine */
    PPP_STAT * pStat /* PPP_STAT structure to be filled */
    )

DESCRIPTION

This routine gets statistics for the specified Point-to-Point Protocol (PPP) link. Detailed are the numbers of bytes and packets received and sent through the PPP interface.

The PPP link statistics are returned through a PPP_STAT structure, which is defined in h/netinet/ppp/pppShow.h.

RETURNS

OK, or ERROR if unit is an invalid PPP unit number.

SEE ALSO

pppShow, pppLib

---

Libraries : Routines

pppSecretShow( )

NAME

pppSecretShow( ) - display the PPP authentication secrets table

SYNOPSIS

void pppSecretShow (void)

DESCRIPTION

This routine displays the Point-to-Point Protocol (PPP) authentication secrets table. The information in the secrets table may be used by the Password Authentication Protocol (PAP) and Challenge-Handshake Authentication Protocol (CHAP) user authentication protocols.

RETURNS

N/A

SEE ALSO

pppShow, pppLib, pppSecretAdd( ), pppSecretDelete( )