HixlCSClientConnect
Function Description
Initiates synchronous connection establishment with the server (blocking call until success or timeout).
Prototype
HixlStatus HixlCSClientConnect(HixlClientHandle client_handle, uint32_t timeout_ms);
Parameters
Parameter |
Input/Output |
Description |
|---|---|---|
client_handle |
Input |
Client handle. |
timeout_ms |
Input |
Connection timeout interval, in milliseconds. |
Returns
- HIXL_SUCCESS: Connection success.
- HIXL_PARAM_INVALID: Incorrect parameter.
- HIXL_TIMEOUT: The connection times out.
- Other values: Failure.
Constraints
- Before calling this API to establish a link with the server, ensure that all local memories have been registered.
- Before calling this API to establish a link with the server, ensure that the server is in the listening state.
- After calling this API to establish a link, call the HixlCSClientGetRemoteMem API to ensure that the remote memory description is exchanged to the local end.
Parent topic: API Description