HixlCSClientBatchGetAsync

Function Description

Reads multiple groups of data from the server to the local host asynchronously in batches.

Prototype

HixlStatus HixlCSClientBatchGetAsync(HixlClientHandle client_handle,
                                     uint32_t list_num,
                                     const HixlOneSideOpDesc *desc_list,
                                     CompleteHandle *complete_handle);

Parameters

Parameter

Input/Output

Description

client_handle

Input

Client handle.

list_num

Input

Task array.

desc_list

Input

Pointer to the HixlOneSideOpDesc array. The length is list_num.

complete_handle

Output

Returned completion handle, which is used to asynchronously query the task status. After the query is successful, related resources are automatically released.

Returns

  • HIXL_SUCCESS: The task is submitted successfully (not completed).
  • HIXL_PARAM_INVALID: Incorrect parameter.
  • Other values: Submission failure.

Constraints

A maximum of 4,000 data records can be concurrently transmitted. After a task is delivered, the HixlCSClientQueryCompleteStatus API must be called in a timely manner to query the task status.