HixlCSClientBatchGetSync

Function Description

Synchronously reads multiple groups of data from the server to the local end in batches. Before the entire batch transmission is complete, times out, or fails, the current thread is blocked and CompleteHandle is not returned.

Prototype

HixlStatus HixlCSClientBatchGetSync(HixlClientHandle client_handle,
                                    uint32_t list_num,
                                    const HixlOneSideOpDesc *desc_list,
                                    uint32_t timeout_ms);

Parameters

Parameter	Input/Output	Description
client_handle	Input	Client handle, which cannot be NULL.
list_num	Input	Number of subtasks, which must be greater than 0. If the value is 0, HIXL_PARAM_INVALID is returned.
desc_list	Input	HixlOneSideOpDesc array whose length is list_num. This parameter cannot be NULL when list_num is greater than 0. The data direction is local_buf (source) → remote_buf (destination).
timeout_ms	Input	Total timeout interval of the entire batch of tasks, in milliseconds. If the operation times out, HIXL_TIMEOUT is returned.

Returns

HIXL_SUCCESS: The data transmission is complete for the entire batch of tasks.
HIXL_PARAM_INVALID: Invalid parameter (for example, list_num == 0, desc_list is invalid, or client_handle is NULL).
HIXL_TIMEOUT: The data transmission is not complete for the entire batch of tasks within timeout_ms.
Other values: Transmission or internal error (see the log and HixlStatus code).

Constraints

Before calling this API, ensure that a connection to the server has been established, and the addresses in desc_list must have been registered.
A single link does not support concurrency.

Parent topic: API Description