Function: synchronize_device_with_timeout

Description

Blocks app execution until the compute device has completed all preceding requested tasks. This API is enhanced based on synchronize_device and allows users to set the timeout interval. When an app is abnormal, the app automatically exits based on the configured timeout interval. When the app exits due to timeout, ACL_ERROR_RT_STREAM_SYNC_TIMEOUT is returned.

In the multi-device scenario, the device of the current context is waited.

Prototype

  • C Prototype
    1
    aclError aclrtSynchronizeDeviceWithTimeout(int32_t timeout)
    
  • Python Function
    1
    ret = acl.rt.synchronize_device_with_timeout(timeout)
    

Parameters

Parameter

Description

timeout

Int, API timeout interval.

The options are as follows:

  • -1: forever. In this case, this API is equivalent to synchronize_device.
  • > 0: specific timeout interval, in ms.

Return Value

Return Value

Description

ret

Int, error code. 0 on success; else, failure.