aclrtSynchronizeStreamWithTimeout

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	√
Atlas inference product	√
Atlas training product	√

Function

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

Prototype

aclError aclrtSynchronizeStreamWithTimeout(aclrtStream stream, int32_t timeout)

Parameters

Parameter	Input/Output	Description
stream	Input	Stream that needs to complete all tasks. For the type definition, see aclrtStream.
timeout	Input	API timeout interval. The options are as follows: -1: waits forever, which functions equivalently as aclrtSynchronizeStream. > 0: specific timeout interval, in milliseconds.

Parameter

Input/Output

Description

stream

Input

Stream that needs to complete all tasks. For the type definition, see aclrtStream.

timeout

Input

API timeout interval.

The options are as follows:

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

Returns

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

Parent topic: Stream Management