Rate This Document
Findability
Accuracy
Completeness
Readability

BioCheckUpgradeReady

Function Definition

Checks whether the upgrade is ready. If a success message is returned after this interface is invoked, offline upgrade is allowed. Otherwise, wait for a while and invoke this interface again.

Implementation

CResult BioCheckUpgradeReady(uint64_t tenantId)

Parameters

Table 1 Parameters

Parameter

Data Type

Input/Output

Description

tenantId

uint64_t

Input

Tenant ID.

Return Values

Table 2 Return values

Return Value

Description

RET_CACHE_OK

The operation is successful.

RET_CACHE_NOT_FOUND

The cache instance is not found.

RET_CACHE_NOT_READY

The BoostIO service is not ready.

RET_CACHE_NEED_RETRY

A retry is required.

RET_CACHE_ERROR

The operation failed.