aclrtSynchronizeEvent

Applicable Products

Product	Supported
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	√
Atlas inference products	√
Atlas training products	√

Function

This API is enhanced based on aclrtSynchronizeEvent and allows you to set permanent waiting or a specific timeout period. If a specific timeout period is set, the application automatically exits upon timeout when an exception occurs.

This is an encapsulated API that applies only to C++ programs. It internally calls the C API aclrtSynchronizeEventWithTimeout.

Prototype

aclError aclrtSynchronizeEvent(aclrtEvent event, int32_t timeout)

Parameters

Parameter	Input/Output	Description
event	Input	Event to wait on. For details about the type definition, see aclrtEvent.
timeout	Input	API timeout interval. The value can be: -1: permanent waiting > 0: specific timeout interval, in milliseconds

Parameter

Input/Output

Description

event

Input

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

timeout

Input

API timeout interval.

The value can be:

-1: permanent waiting
> 0: specific timeout interval, in milliseconds

Returns

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

Parent topic: C++ Extension APIs