Disconnect

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

Disconnects a link with the remote HIXL instance.

Prototype

      
           Status Disconnect(const AscendString &remote_engine, int32_t timeout_in_millis = 1000)

Parameters

Parameter	Input/Output	Description
remote_engine	Input	Unique identifier of the remote HIXL instance.
timeout_in_millis	Input	Link disconnection timeout interval, in milliseconds. The default value is 1000.

Example

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

Returns

SUCCESS: Success.
PARAM_INVALID: Incorrect parameter.
NOT_CONNECTED: No link is established with the peer end.
Other values: Failure.

Constraints

Before calling this API, call the Initialize API to complete initialization.
This API and Initialize must run in the same thread. If you need to switch threads to call this API, first call aclrtGetCurrentContext in the thread where Initialize is running to obtain the context. Then, in the new thread, call aclrtSetCurrentContext to set the context.

Parent topic: HIXL APIs