summaryrefslogtreecommitdiffstats
path: root/src/H5EQpublic.h
blob: 12b43284579d524eed80adb8d77ceb8eeba64176 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * This file contains function prototypes for each exported function in the
 * H5EQ module.
 */
#ifndef _H5EQpublic_H
#define _H5EQpublic_H

/* System headers needed by this file */

/* Public headers needed by this file */
#include "H5public.h"
#include "H5Ipublic.h"

/*****************/
/* Public Macros */
/*****************/

/*******************/
/* Public Typedefs */
/*******************/

/* An asynchronous request object */
typedef void * H5_request_t;

/********************/
/* Public Variables */
/********************/

/* Asynchronous operation status */
typedef enum H5_status_t{
    H5AO_PENDING,       /* Operation has not yet completed */
    H5AO_SUCCEEDED,     /* Operation has completed, successfully */
    H5AO_FAILED,        /* Operation has completed, but failed */
    H5AO_CANCELLED      /* Operation has not completed and has been cancelled */
} H5_status_t;

#define H5_REQUEST_NULL NULL
#define H5_EVENT_QUEUE_NULL -1

#ifdef __cplusplus
extern "C" {
#endif

/*********************/
/* Public Prototypes */
/*********************/

/* API wrappers */
H5_DLL hid_t H5EQcreate(hid_t fapl_id);
H5_DLL herr_t H5EQinsert(hid_t event_q, H5_request_t req);
H5_DLL herr_t H5EQpop(hid_t event_q, H5_request_t *req);
H5_DLL herr_t H5EQwait(hid_t event_q, int *num_requests, H5_status_t **status);
H5_DLL herr_t H5EQtest(hid_t event_q, int *num_remaining);
H5_DLL herr_t H5EQclose(hid_t event_q);

/* Asynchronous test & wait operations */
H5_DLL herr_t H5AOcancel(H5_request_t req, H5_status_t *status);
H5_DLL herr_t H5AOtest(H5_request_t req, H5_status_t *status);
H5_DLL herr_t H5AOwait(H5_request_t req, H5_status_t *status);

#ifdef __cplusplus
}
#endif
#endif /* _H5EQpublic_H */