HixlCSClientGetRemoteMem

Function Description

Obtains the information about the memory registered by the server.

Prototype

HixlStatus HixlCSClientGetRemoteMem(HixlClientHandle client_handle,
                                    CommMem **remote_mem_list,
                                    char ***mem_tag_list,
                                    uint32_t *list_num,
                                    uint32_t timeout_ms);

Parameters

Parameter	Input/Output	Description
client_handle	Input	Client handle.
remote_mem_list	Output	Returned CommMem array pointer.
mem_tag_list	Output	Character string array, corresponding to the label of each CommMem.
list_num	Output	Returned list length.
timeout_ms	Input	Request timeout interval, in milliseconds.

Returns

HIXL_SUCCESS: Success.
HIXL_PARAM_INVALID: Incorrect parameter.
Other values: Failure or timeout.

Constraints

The memory lifecycle of the output parameter is managed by the API. If this API is called repeatedly, the memory allocated last time is released. Copy it to the local memory if necessary. For details, see https://gitcode.com/cann/hcomm/blob/master/include/hcomm_res_defs.h.
After calling the HixlCSClientConnect API, call this API to ensure that the remote memory description is exchanged to the local end.

Parent topic: API Description