H5ESpublic.h File Reference

#include "H5public.h"
#include "H5Ipublic.h"

Data Structures
struct	H5ES_op_info_t
struct	H5ES_err_info_t

Macros
#define	H5ES_NONE   0
#define	H5ES_WAIT_FOREVER   (UINT64_MAX)
#define	H5ES_WAIT_NONE   (0)

Typedefs
typedef int(*	H5ES_event_insert_func_t) (const H5ES_op_info_t *op_info, void *ctx)
typedef int(*	H5ES_event_complete_func_t) (const H5ES_op_info_t *op_info, H5ES_status_t status, hid_t err_stack, void *ctx)

Enumerations
enum	H5ES_status_t { H5ES_STATUS_IN_PROGRESS , H5ES_STATUS_SUCCEED , H5ES_STATUS_CANCELED , H5ES_STATUS_FAIL }

Functions
hid_t	H5EScreate (void)
	Creates an event set.
herr_t	H5ESwait (hid_t es_id, uint64_t timeout, size_t *num_in_progress, hbool_t *err_occurred)
	Waits for operations in event set to complete.
herr_t	H5EScancel (hid_t es_id, size_t *num_not_canceled, hbool_t *err_occurred)
	Attempt to cancel operations in an event set.
herr_t	H5ESget_count (hid_t es_id, size_t *count)
	Retrieves number of events in an event set.
herr_t	H5ESget_op_counter (hid_t es_id, uint64_t *counter)
	Retrieves the accumulative operation counter for an event set.
herr_t	H5ESget_err_status (hid_t es_id, hbool_t *err_occurred)
	Checks for failed operations.
herr_t	H5ESget_err_count (hid_t es_id, size_t *num_errs)
	Retrieves the number of failed operations.
herr_t	H5ESget_err_info (hid_t es_id, size_t num_err_info, H5ES_err_info_t err_info[], size_t *err_cleared)
	Retrieves information about failed operations.
herr_t	H5ESfree_err_info (size_t num_err_info, H5ES_err_info_t err_info[])
	Convenience routine to free an array of H5ES_err_info_t structs.
herr_t	H5ESregister_insert_func (hid_t es_id, H5ES_event_insert_func_t func, void *ctx)
	Registers a callback to invoke when a new operation is inserted into an event set.
herr_t	H5ESregister_complete_func (hid_t es_id, H5ES_event_complete_func_t func, void *ctx)
	Registers a callback to invoke when an operation completes within an event set.
herr_t	H5ESclose (hid_t es_id)
	Terminates access to an event set.

Macro Definition Documentation

H5ES_NONE

#define H5ES_NONE   0

Default value for "no event set" / synchronous execution. Used in place of a hid_t identifier.

H5ES_WAIT_FOREVER

#define H5ES_WAIT_FOREVER   (UINT64_MAX)

Wait until all operations complete

H5ES_WAIT_NONE

#define H5ES_WAIT_NONE   (0)

Don't wait for operations to complete, just check their status. (This allows H5ESwait to behave like a 'test' operation)

Typedef Documentation

H5ES_event_complete_func_t

typedef int(* H5ES_event_complete_func_t) (const H5ES_op_info_t *op_info, H5ES_status_t status, hid_t err_stack, void *ctx)

Callback for H5ESregister_complete_func()

H5ES_event_insert_func_t

typedef int(* H5ES_event_insert_func_t) (const H5ES_op_info_t *op_info, void *ctx)

Callback for H5ESregister_insert_func()

Enumeration Type Documentation

H5ES_status_t

enum H5ES_status_t

Asynchronous operation status

Enumerator
H5ES_STATUS_IN_PROGRESS	Operation(s) have not yet completed
H5ES_STATUS_SUCCEED	Operation(s) have completed, successfully
H5ES_STATUS_CANCELED	Operation(s) has been canceled
H5ES_STATUS_FAIL	An operation has completed, but failed