HIXL Error Codes

Error codes are defined as follows. The type is uint32_t.

// status codes
constexpr Status SUCCESS = 0U;
constexpr Status PARAM_INVALID = 103900U;
constexpr Status TIMEOUT = 103901U;
constexpr Status NOT_CONNECTED = 103902U;
constexpr Status ALREADY_CONNECTED = 103903U;
constexpr Status NOTIFY_FAILED = 103904U;
constexpr Status UNSUPPORTED = 103905U;
constexpr Status FAILED = 503900U;
constexpr Status RESOURCE_EXHAUSTED = 203900U;

The meanings of error codes are as follows.

Enumerated Value	Description	Recoverable (Yes/No)	Solution
SUCCESS	Success	None	N/A.
PARAM_INVALID	Incorrect parameter	Yes	Locate the fault based on logs.
TIMEOUT	Processing timeout	No	Capture the exception and try again.
NOT_CONNECTED	No link established	Yes	Verify the link status at the upper layer.
ALREADY_CONNECTED	Link already established	Yes	Verify the link status at the upper layer.
NOTIFY_FAILED	Notification failed	No	Reserved error code, which is not returned currently.
UNSUPPORTED	Unsupported parameter or API	Yes	Reserved error code, which is not returned currently.
FAILED	Common failure	No	Preserve the environment, collect host/device logs, and back them up.
RESOURCE_EXHAUSTED	Resources exhausted, only stream resources left	Yes	Try again after the resources are released.

For details about the transparently transmitted aclError, see Runtime API Reference.

Parent topic: HIXL