Rate This Document
Findability
Accuracy
Completeness
Readability

BioNotifyUpgradePrepare

Function Definition

Notifies the system of upgrade preparations. After this interface is invoked, the BoostIO read/write cache service is stopped, and the cached data is gradually evicted to the back-end storage. Subsequent front-end I/Os are directly written to the back-end storage.

Implementation

CResult BioNotifyUpgradePrepare(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.