Fortran Event Set (H5ES) Interface

Detailed Description

See also

Event Set Interface (H5ES), C-API

The HDF5 Event Set, User Guide

Functions/Subroutines
subroutine	h5escreate_f (es_id, hdferr)
	Creates an event set.
subroutine	h5esget_count_f (es_id, count, hdferr)
	Retrieves number of events in an event set.
subroutine	h5esget_op_counter_f (es_id, counter, hdferr)
	Retrieves the next operation counter to be assigned in an event set.
subroutine	h5eswait_f (es_id, timeout, num_in_progress, err_occurred, hdferr)
	Waits for operations in event set to complete.
subroutine	h5escancel_f (es_id, num_not_canceled, err_occurred, hdferr)
	Attempt to cancel operations in an event set.
subroutine	h5esget_err_status_f (es_id, err_occurred, hdferr)
	Checks for failed operations.
subroutine	h5esget_err_count_f (es_id, num_errs, hdferr)
	Retrieves the number of failed operations.
subroutine	h5esclose_f (es_id, hdferr)
	Terminates access to an event set.

Variables
integer(hid_t)	h5es_none_f
	H5ES_NONE.
integer	h5es_status_in_progress_f
	H5ES_STATUS_IN_PROGRESS.
integer	h5es_status_succeed_f
	H5ES_STATUS_SUCCEED.
integer	h5es_status_canceled_f
	H5ES_STATUS_CANCELED.
integer	h5es_status_fail_f
	H5ES_STATUS_FAIL.
integer(c_int64_t)	h5es_wait_forever_f
	H5ES_WAIT_FOREVER.
integer(c_int64_t)	h5es_wait_none_f
	H5ES_WAIT_NONE.

Function/Subroutine Documentation

h5escancel_f()

subroutine h5escancel_f	(	integer(hid_t), intent(in)	es_id,
		integer(size_t), intent(out)	num_not_canceled,
		logical, intent(out)	err_occurred,
		integer, intent(out)	hdferr
	)

Attempt to cancel operations in an event set.

Parameters

es_id	Event set identifier
num_not_canceled	The number of events not canceled
err_occurred	Status indicating if error is present in the event set
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5EScancel()

h5esclose_f()

subroutine h5esclose_f	(	integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr
	)

Terminates access to an event set.

Parameters

es_id	Event set identifier
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5ESclose()

h5escreate_f()

subroutine h5escreate_f	(	integer(hid_t), intent(out)	es_id,
		integer, intent(out)	hdferr
	)

Creates an event set.

Parameters

es_id	Event set identifier
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5EScreate()

h5esget_count_f()

subroutine h5esget_count_f	(	integer(hid_t), intent(in)	es_id,
		integer(size_t), intent(out)	count,
		integer, intent(out)	hdferr
	)

Retrieves number of events in an event set.

Parameters

es_id	Event set identifier
count	The number of events in the event set
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5ESget_count()

h5esget_err_count_f()

subroutine h5esget_err_count_f	(	integer(hid_t), intent(in)	es_id,
		integer(size_t), intent(out)	num_errs,
		integer, intent(out)	hdferr
	)

Retrieves the number of failed operations.

Parameters

es_id	Event set identifier
num_errs	Number of errors
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5ESget_err_count()

h5esget_err_status_f()

subroutine h5esget_err_status_f	(	integer(hid_t), intent(in)	es_id,
		logical, intent(out)	err_occurred,
		integer, intent(out)	hdferr
	)

Checks for failed operations.

Parameters

es_id	Event set identifier
err_occurred	Status indicating if error is present in the event set
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5ESget_err_status()

h5esget_op_counter_f()

subroutine h5esget_op_counter_f	(	integer(hid_t), intent(in)	es_id,
		integer(c_int64_t), intent(out)	counter,
		integer, intent(out)	hdferr
	)

Retrieves the next operation counter to be assigned in an event set.

Parameters

es_id	Event set identifier
counter	The number of events in the event set
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5ESget_op_counter()

h5eswait_f()

subroutine h5eswait_f	(	integer(hid_t), intent(in)	es_id,
		integer(c_int64_t), intent(in)	timeout,
		integer(size_t), intent(out)	num_in_progress,
		logical, intent(out)	err_occurred,
		integer, intent(out)	hdferr
	)

Waits for operations in event set to complete.

Parameters

es_id	Event set identifier
timeout	The number of events in the event set
num_in_progress	The number of operations still in progress
err_occurred	Flag if an operation in the event set failed
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5ESwait()

Variable Documentation

h5es_none_f

integer(hid_t) h5es_none_f

H5ES_NONE.

h5es_status_canceled_f

integer h5es_status_canceled_f

H5ES_STATUS_CANCELED.

h5es_status_fail_f

integer h5es_status_fail_f

H5ES_STATUS_FAIL.

h5es_status_in_progress_f

integer h5es_status_in_progress_f

H5ES_STATUS_IN_PROGRESS.

h5es_status_succeed_f

integer h5es_status_succeed_f

H5ES_STATUS_SUCCEED.

h5es_wait_forever_f

integer(c_int64_t) h5es_wait_forever_f

H5ES_WAIT_FOREVER.

h5es_wait_none_f

integer(c_int64_t) h5es_wait_none_f

H5ES_WAIT_NONE.