aclrtSynchronizeEventWithTimeout

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 until all tasks captured in an event are completed. (For more details, see aclrtRecordEvent.) This API is enhanced based on aclrtSynchronizeEvent and allows you to set permanent waiting or configure a specific timeout interval. If a timeout interval is configured, the app automatically exits based on the timeout interval when an exception occurs.

Prototype

aclError aclrtSynchronizeEventWithTimeout(aclrtEvent event, int32_t timeout)

Parameters

Parameter	Input/Output	Description
event	Input	Event to wait on. For the type definition, see aclrtEvent.
timeout	Input	API timeout interval. The options are as follows: -1: waits forever, which functions equivalently as aclrtSynchronizeEvent. > 0: specific timeout interval, in milliseconds.

Parameter

Input/Output

Description

event

Input

Event to wait on. For the type definition, see aclrtEvent.

timeout

Input

API timeout interval.

The options are as follows:

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

Returns

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

Parent topic: Event Management