aclrtSynchronizeEventWithTimeout

Description

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.

Restrictions

The Atlas 200/300/500 Inference Product does not support the configuration of a specific timeout interval and only supports configuration of permanent waiting.

Prototype

aclError aclrtSynchronizeEventWithTimeout(aclrtEvent event, int32_t timeout)

Parameters

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

Parameter

Input/Output

Description

event

Input

Event to wait on.

timeout

Input

API timeout interval.

The options are as follows:

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

Returns

The value 0 indicates success, and other values indicate failure. For details, see aclError.

Parent topic: Event Management