GetAsyncConnectStatus

Applicable Products

Product	Supported (√/x)
Ascend 950PR/Ascend 950DT	√
Atlas A3 training products/Atlas A3 inference products	√
Atlas A2 training products/Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	x
Atlas inference products	x
Atlas training products	x

Note: For Atlas A2 training products/Atlas A2 inference products, only the Atlas 800I A2 inference server and A200I A2 Box heterogeneous subrack are supported.

Function Description

Obtains the status of the specified asynchronous connection.

Prototype

Status GetAsyncConnectStatus(const AscendString &remote_engine, AsyncConnectStatus &status)

Parameters

Parameter	Input/Output	Description
remote_engine	Input	Unique identifier of the remote HIXL instance.
status	Output	Asynchronous connection status. The enumerated values are as follows: NOT_CONNECT: not connected CONNECT_PENDING: link establishment to be executed CONNECTING: link establishment in progress CONNECTED: link established successfully CONNECT_FAILED: link establishment failed DISCONNECT_PENDING: disconnection to be executed DISCONNECTING: disconnection in progress

Parameter

Input/Output

Description

remote_engine

Input

Unique identifier of the remote HIXL instance.

status

Output

Asynchronous connection status. The enumerated values are as follows:

NOT_CONNECT: not connected
CONNECT_PENDING: link establishment to be executed
CONNECTING: link establishment in progress
CONNECTED: link established successfully
CONNECT_FAILED: link establishment failed
DISCONNECT_PENDING: disconnection to be executed
DISCONNECTING: disconnection in progress

Example

Click GitCode, select the matching version, and obtain the sample from the examples/cpp directory.

Returns

SUCCESS: Success.
Other values: Failure.

Constraints

Before calling this API, call the Initialize API to complete initialization.
The return value of the API only indicates whether the API call is successful. The status of the asynchronous connection establishment/disconnection task is indicated by the output parameter.

Parent topic: HIXL APIs