Function: synchronize_event_with_timeout

aclError aclrtSynchronizeEventWithTimeout(aclrtEvent event, int32_t timeout)

ret = acl.rt.synchronize_event_with_timeout(event, timeout)

Blocks the current thread until all tasks captured by the event are complete. For details, see the event capture details in acl.rt.record_event.

This API is enhanced based on acl.rt.synchronize_event. You can set permanent waiting or a specific timeout period. If a specific timeout period is configured, the application automatically exits when an exception occurs.

event: int, event object pointer address to be waited for.

timeout: int, API timeout interval.

The options are as follows:

• -1: waits permanently, which functions equivalently as acl.rt.synchronize_event.
• > 0: specific timeout interval, in ms.

ret: int, error code.

• 0 indicates success.
• Other values indicate failure.

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

For the API call example, see Event Synchronization.