@CHIP-RTOS C Library - TCP/IP API

PPP_Client_Pause

Pause/resume the PPP client task.

int PPP_Client_Pause (int pause, int *error );

Parameters

pause

1: Pause the PPP client task
0:resume.

error

Output parameter:  Failure code:
-1 Action not allowed due to the current state of the PPP client
-2 PPP client is not running (disabled)
-3 PPP client timeout (should not happen)
0 on success.

Return Value

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

Comments

If this API function is called with parameter pause=1, the PPP client task stops listening for incoming data at its RS232 port. Also it stops sending of data via the serial port.
The RS232 port of the PPP client is now ready to use for other purposes (e.g. for sending a SMS).
The server must be resumed by a call of this function with parameter pause==0.
Please note:
If the PPP client was halted during a running PPP session, the PPP session could be closed by the remote peer.
Open TCP connections via the PPP device are possibly closed by the peers.
The internal idle timeout counters are cleared, if the client task stay at the HALT state.

RTOS API

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

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.30	V1.30

Supported by @CHIP-RTOS C Library since version

CLIB
V2.17