www.beck-ipc.com

@CHIP-RTOS C Library V2.06 - TCP/IP API


IPsec_Status

Read out the status of the IP security function within the system's TCP/IP stack.

int IPsec_Status(int *error_code) ;

Parameters

error_code

Optional output parameter is the error code reported when IP Security initialization was not successful.   Set this parameter to NULL if not interested.

Return Value

Enumerator:

    IPSEC_OFF (0) - Not started yet.
    IPSEC_FAILED (1) - Startup failed, perhaps insufficient memory.
    IPSEC_AWAITING_DHCP (2) - Awaiting Ethernet IP address for IKE.
    IPSEC_READY (3) - Ready for operation.

Comments

The optional error code value returned to error_code will be non-zero if the reported state is IPSEC_FAILED.   In state IPSEC_AWAITING_DHCP the error code will be 235, "Operation would block".

See Also

RTOS API

This library function invokes a RTOS software interrupt.   Refer to the RTOS API function IPSEC_VECTORS for more details.

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3
    n/an/an/aV1.07

Supported by @CHIP-RTOS C Library since version

    CLIB
    V2.06

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document