aclrtSynchronizeStreamWithTimeout

Applicability

Product	Supported
Atlas A3 training products/Atlas A3 inference products	√
Atlas A2 training products/Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	√
Atlas inference products	√
Atlas training products	√

Description

Blocks the current thread on the host until all tasks in the specified stream are complete. This API is enhanced based on the aclrtSynchronizeStream API and allows you to set the timeout interval. When the application is abnormal, the application automatically exits based on the configured timeout interval.

Prototype

aclError aclrtSynchronizeStreamWithTimeout(aclrtStream stream, int32_t timeout)

Parameters

Parameter	Input/Output	Description
stream	Input	Stream.
timeout	Input	API timeout interval. The options are as follows: -1: waits forever, which functions equivalently as aclrtSynchronizeStream. > 0: specific timeout interval, in ms.

Parameter

Input/Output

Description

stream

Input

Stream.

timeout

Input

API timeout interval.

The options are as follows:

-1: waits forever, which functions equivalently as aclrtSynchronizeStream.
> 0: specific timeout interval, in ms.

Returns

0 on success; else, failure. For details, see aclError.

Parent topic: Stream Management