Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5ES_WAIT

Waits for operations in event set to complete

Procedure:

H5ES_WAIT (es_id, timeout, num_in_progress, op_failed)

Signature:

herr_t H5ESwait( hid_t es_id, uint64_t timeout, size_t *num_in_progress, hbool_t *op_failed)

 

Parameters:
hid_t es_id    IN: Identifier of an event set

uint64_t timeout

IN: Total time in nanoseconds to wait for all operations in the event set to complete

size_t *num_in_progress

OUT: The number of operations still in progress

hbool_t *op_failed

OUT: Indicator if an operation in the event set failed

Description:

H5ES_WAIT waits for operations in an event set es_id to wait with timeout.

Timeout value is in nanoseconds, and is for the H5ESwait call and not for each individual operation in the event set. For example, if "10" is passed as a timeout value and the event set waited 4 nanoseconds for the first operation to complete, the remaining operations would be allowed to wait for at most 6 nanoseconds more, i.e., the timeout value used across all operations in the event set until it reaches 0, then any remaining operations are only checked for completion, not waited on.

This call will stop waiting on operations and will return immediately if an operation fails. If a failure occurs, the value returned for the number of operations in progress may be inaccurate.

 

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:
See Also:
 

History:
Release    Change
1.13.0C function introduced in this release.

--- Last Modified: December 20, 2020 | 11:34 PM