Rate This Document

Findability

Accuracy

Completeness

Readability

BioInitialize

Function Definition

Initializes the BoostIO read/write cache service. You can select a proper working mode based on the application scenario.

Implementation

CResult BioInitialize(WorkerMode mode, ClientOptionsConfig *optConf)

Parameters

**Table 1** Parameters
Parameter	Data Type	Input/Output	Description
mode	WorkerMode	Input	Working mode. The options are as follows: CONVERGENCE(0): converged mode, which applies to AI scenarios. SEPARATES(1): separated mode, which applies to big data scenarios.
optConf	ClientOptionsConfig*	Input	BoostIO initialization options. For details, see Table 2.

**Table 2** Detailed parameter description
Parameter	Structure Field	Description
ClientOptionsConfig	logType	Log type. STDOUT_TYPE(0): standard stream output. FILE_TYPE(1): log file output. STDERR_TYPE(2): standard error stream output. This field is valid only in separated mode.
	logFilePath	Log file output path. This field is valid only in separated mode. Ensure that the input log path is accessible.
	enable	Security option. 0: disable Other: enable
	certificationPath	Client certificate path. Input a valid path for security enablement.
	caCerPath	CA certificate path. Input a valid path for security enablement.
	caCrlPath	(Optional) Certificate revocation list (CRL) file path.
	privateKeyPath	Path to the private key file of the client certificate. Input a valid path for security enablement.
	privateKeyPassword	Path to the private key password file of the client certificate. Input a valid path for security enablement.
	hseKfsMasterPath	Path to the master root key of the private key password of the client certificate. Input a valid path for security enablement.
	hseKfsStandbyPath	Path to the standby root key of the private key password of the client certificate. Input a valid path for security enablement.

Return Values

**Table 3** Return values
Return Value	Description
RET_CACHE_OK	The operation is successful.
RET_CACHE_ERROR	The operation failed.

Parent topic: API Reference