HixlCSClientCreate

Function Description

Creates a client instance and initializes local resources.

Prototype

HixlStatus HixlCSClientCreate(const HixlClientDesc *client_desc,
                              const HixlClientConfig *config,
                              HixlClientHandle *client_handle);

Parameters

Parameter

Input/Output

Description

client_desc

Input

Client description, including the server IP address/port and endpoint.

config

Input

Client configuration, which is reserved and not used currently.

client_handle

Output

Created client handle.

Returns

  • HIXL_SUCCESS: Success.
  • HIXL_PARAM_INVALID: Incorrect parameter.
  • Other values: Failure.

Constraints

  • If the endpoint of the local device is used, call aclrtSetDevice before calling this API.
  • If the API call fails, client_handle may be invalid.