Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Functions
ISSU OpEN API [OPENAPI_ISSU]

Functions

open_error_t openapiISSUClientDeRegister (openapiClientHandle_t *client_handle)
 Deregister for ISSU events and gets last ISSU reset status. More...
 
open_error_t openapiISSUClientReady (openapiClientHandle_t *client_handle)
 OpenAPI app is done with restoring data and ready for HW reconciliation. More...
 
open_error_t openapiISSUClientRegister (openapiClientHandle_t *client_handle, uint32_t *issuWarmRestart)
 Register for ISSU events and gets last ISSU reset status. More...
 
open_error_t openapiISSUClientStateSaved (openapiClientHandle_t *client_handle)
 Indicates that OpenAPI app is done with ISSU saving. More...
 
open_error_t openapiIssuStartGet (openapiClientHandle_t *client_handle, uint32_t *issuStart)
 Indicates whether ISSU save has started. More...
 

Detailed Description

Function Documentation

open_error_t openapiISSUClientDeRegister ( openapiClientHandle_t client_handle)

Deregister for ISSU events and gets last ISSU reset status.

Parameters
[in]client_handleClient handle from registration API.
Return values
OPEN_E_NONEIf de-registration successful
OPEN_E_INTERNALUnexpected error.
OPEN_E_PARAMInvalid parameter.
OPEN_E_ERRORNot supported

OpEN API Version: 1.15

Examples:
issu_example.c.
open_error_t openapiISSUClientReady ( openapiClientHandle_t client_handle)

OpenAPI app is done with restoring data and ready for HW reconciliation.

Parameters
[in]client_handleClient handle from registration API.
Return values
OPEN_E_NONESuccessfully notified about restoring data
OPEN_E_INTERNALUnexpected error.
OPEN_E_PARAMInvalid parameter.
OPEN_E_ERRORNot registered for ISSU Not supported

OpEN API Version: 1.15

Examples:
issu_example.c.
open_error_t openapiISSUClientRegister ( openapiClientHandle_t client_handle,
uint32_t *  issuWarmRestart 
)

Register for ISSU events and gets last ISSU reset status.

Parameters
[in]client_handleClient handle from registration API.
[out]issuWarmRestartWhether last reset was a ISSU reset
Return values
OPEN_E_NONEIf registration successful
OPEN_E_ERRORReached maximum client registration Not supported

OpEN API Version: 1.15

Examples:
issu_example.c.
open_error_t openapiISSUClientStateSaved ( openapiClientHandle_t client_handle)

Indicates that OpenAPI app is done with ISSU saving.

Parameters
[in]client_handleClient handle from registration API.
Return values
OPEN_E_NONESuccessfully notified about data save
OPEN_E_INTERNALUnexpected error.
OPEN_E_PARAMInvalid parameter.
OPEN_E_ERRORNot registered for ISSU Not supported

OpEN API Version: 1.15

Examples:
issu_example.c.
open_error_t openapiIssuStartGet ( openapiClientHandle_t client_handle,
uint32_t *  issuStart 
)

Indicates whether ISSU save has started.

Parameters
[in]client_handleClient handle from registration API.
[in]issuStartIndicates ISSU save started
Return values
OPEN_E_NONESuccessfully fetched ISSU start status
OPEN_E_PARAMInvalid parameter.
OPEN_E_ERRORError.

OpEN API Version: 1.15

Examples:
issu_example.c.