@CHIP-RTOS C Library - TCP/IP API

PPP_Server_Suspend

Suspend the PPP server task.

int PPP_Server_Suspend (int timeoutsecs, int *error );

Parameters

timeoutsecs

Time-out in seconds.

error

Output parameter:  Failure code, 0 on success.

Return Value

0 = success
Non-zero = Failure (see error output parameter)

Comments

This API function closes an active (if there is one) connection and blocks any activity of the PPP server. The PPP server can be (re)activated by PPP_Server_Activate.
Note that the time-out value in timeoutsecs depends on your time-out entries for the modem commands specified in chip.ini.   If this call returns with -1, the most likely reason is that the modem commands are not finished after specified time-out.
After execution of this command the serial port and/or the connected modem can be used for othere purposes.

See Also

PPP_Server_Activate        PPP_Server_GetStatus        

RTOS API

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

Related Topics

Chip.ini entry: PPPSERVER HANGUPTIMEOUTx time-out in seconds for wait on answer from modem

Supported since or modified in @CHIP-RTOS version

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