H5VLconnector.h File Reference

#include "H5public.h"
#include "H5Apublic.h"
#include "H5ESpublic.h"
#include "H5Fpublic.h"
#include "H5Ipublic.h"
#include "H5Lpublic.h"
#include "H5Opublic.h"
#include "H5Rpublic.h"
#include "H5VLpublic.h"

Go to the source code of this file.

Data Structures
struct	H5VL_loc_by_name
struct	H5VL_loc_by_idx
struct	H5VL_loc_by_token
struct	H5VL_loc_params_t
struct	H5VL_file_cont_info_t
struct	H5VL_info_class_t
struct	H5VL_wrap_class_t
struct	H5VL_attr_class_t
struct	H5VL_dataset_class_t
struct	H5VL_datatype_class_t
struct	H5VL_file_class_t
struct	H5VL_group_class_t
struct	H5VL_link_class_t
struct	H5VL_object_class_t
struct	H5VL_introspect_class_t
struct	H5VL_request_class_t
struct	H5VL_blob_class_t
struct	H5VL_token_class_t
struct	H5VL_class_t

Macros
#define	H5VL_CAP_FLAG_NONE   0 /* No special connector capabilities */
#define	H5VL_CAP_FLAG_THREADSAFE   0x01 /* Connector is threadsafe */
#define	H5VL_CONTAINER_INFO_VERSION   0x01 /* Container info struct version */
#define	H5VL_MAX_BLOB_ID_SIZE   (16) /* Allow for 128-bits blob IDs */

Typedefs
typedef enum H5VL_subclass_t	H5VL_subclass_t
typedef enum H5VL_attr_get_t	H5VL_attr_get_t
typedef enum H5VL_attr_specific_t	H5VL_attr_specific_t
typedef int	H5VL_attr_optional_t
typedef enum H5VL_dataset_get_t	H5VL_dataset_get_t
typedef enum H5VL_dataset_specific_t	H5VL_dataset_specific_t
typedef int	H5VL_dataset_optional_t
typedef enum H5VL_datatype_get_t	H5VL_datatype_get_t
typedef enum H5VL_datatype_specific_t	H5VL_datatype_specific_t
typedef int	H5VL_datatype_optional_t
typedef enum H5VL_file_get_t	H5VL_file_get_t
typedef enum H5VL_file_specific_t	H5VL_file_specific_t
typedef int	H5VL_file_optional_t
typedef enum H5VL_group_get_t	H5VL_group_get_t
typedef enum H5VL_group_specific_t	H5VL_group_specific_t
typedef int	H5VL_group_optional_t
typedef enum H5VL_link_create_type_t	H5VL_link_create_type_t
typedef enum H5VL_link_get_t	H5VL_link_get_t
typedef enum H5VL_link_specific_t	H5VL_link_specific_t
typedef int	H5VL_link_optional_t
typedef enum H5VL_object_get_t	H5VL_object_get_t
typedef enum H5VL_object_specific_t	H5VL_object_specific_t
typedef int	H5VL_object_optional_t
typedef enum H5VL_request_specific_t	H5VL_request_specific_t
typedef int	H5VL_request_optional_t
typedef enum H5VL_blob_specific_t	H5VL_blob_specific_t
typedef int	H5VL_blob_optional_t
typedef enum H5VL_loc_type_t	H5VL_loc_type_t
typedef struct H5VL_loc_by_name	H5VL_loc_by_name_t
typedef struct H5VL_loc_by_idx	H5VL_loc_by_idx_t
typedef struct H5VL_loc_by_token	H5VL_loc_by_token_t
typedef struct H5VL_loc_params_t	H5VL_loc_params_t
typedef struct H5VL_file_cont_info_t	H5VL_file_cont_info_t
typedef struct H5VL_info_class_t	H5VL_info_class_t
typedef struct H5VL_wrap_class_t	H5VL_wrap_class_t
typedef struct H5VL_attr_class_t	H5VL_attr_class_t
typedef struct H5VL_dataset_class_t	H5VL_dataset_class_t
typedef struct H5VL_datatype_class_t	H5VL_datatype_class_t
typedef struct H5VL_file_class_t	H5VL_file_class_t
typedef struct H5VL_group_class_t	H5VL_group_class_t
typedef struct H5VL_link_class_t	H5VL_link_class_t
typedef struct H5VL_object_class_t	H5VL_object_class_t
typedef herr_t(*	H5VL_request_notify_t) (void *ctx, H5ES_status_t status)
typedef enum H5VL_get_conn_lvl_t	H5VL_get_conn_lvl_t
typedef struct H5VL_introspect_class_t	H5VL_introspect_class_t
typedef struct H5VL_request_class_t	H5VL_request_class_t
typedef struct H5VL_blob_class_t	H5VL_blob_class_t
typedef struct H5VL_token_class_t	H5VL_token_class_t
typedef struct H5VL_class_t	H5VL_class_t

Enumerations
enum	H5VL_subclass_t {   H5VL_SUBCLS_NONE, H5VL_SUBCLS_INFO, H5VL_SUBCLS_WRAP, H5VL_SUBCLS_ATTR,   H5VL_SUBCLS_DATASET, H5VL_SUBCLS_DATATYPE, H5VL_SUBCLS_FILE, H5VL_SUBCLS_GROUP,   H5VL_SUBCLS_LINK, H5VL_SUBCLS_OBJECT, H5VL_SUBCLS_REQUEST, H5VL_SUBCLS_BLOB,   H5VL_SUBCLS_TOKEN }
enum	H5VL_attr_get_t {   H5VL_ATTR_GET_ACPL, H5VL_ATTR_GET_INFO, H5VL_ATTR_GET_NAME, H5VL_ATTR_GET_SPACE,   H5VL_ATTR_GET_STORAGE_SIZE, H5VL_ATTR_GET_TYPE }
enum	H5VL_attr_specific_t { H5VL_ATTR_DELETE, H5VL_ATTR_EXISTS, H5VL_ATTR_ITER, H5VL_ATTR_RENAME }
enum	H5VL_dataset_get_t {   H5VL_DATASET_GET_DAPL, H5VL_DATASET_GET_DCPL, H5VL_DATASET_GET_SPACE, H5VL_DATASET_GET_SPACE_STATUS,   H5VL_DATASET_GET_STORAGE_SIZE, H5VL_DATASET_GET_TYPE }
enum	H5VL_dataset_specific_t { H5VL_DATASET_SET_EXTENT, H5VL_DATASET_FLUSH, H5VL_DATASET_REFRESH }
enum	H5VL_datatype_get_t { H5VL_DATATYPE_GET_BINARY, H5VL_DATATYPE_GET_TCPL }
enum	H5VL_datatype_specific_t { H5VL_DATATYPE_FLUSH, H5VL_DATATYPE_REFRESH }
enum	H5VL_file_get_t {   H5VL_FILE_GET_CONT_INFO, H5VL_FILE_GET_FAPL, H5VL_FILE_GET_FCPL, H5VL_FILE_GET_FILENO,   H5VL_FILE_GET_INTENT, H5VL_FILE_GET_NAME, H5VL_FILE_GET_OBJ_COUNT, H5VL_FILE_GET_OBJ_IDS }
enum	H5VL_file_specific_t {   H5VL_FILE_FLUSH, H5VL_FILE_REOPEN, H5VL_FILE_MOUNT, H5VL_FILE_UNMOUNT,   H5VL_FILE_IS_ACCESSIBLE, H5VL_FILE_DELETE, H5VL_FILE_IS_EQUAL }
enum	H5VL_group_get_t { H5VL_GROUP_GET_GCPL, H5VL_GROUP_GET_INFO }
enum	H5VL_group_specific_t { H5VL_GROUP_FLUSH, H5VL_GROUP_REFRESH }
enum	H5VL_link_create_type_t { H5VL_LINK_CREATE_HARD, H5VL_LINK_CREATE_SOFT, H5VL_LINK_CREATE_UD }
enum	H5VL_link_get_t { H5VL_LINK_GET_INFO, H5VL_LINK_GET_NAME, H5VL_LINK_GET_VAL }
enum	H5VL_link_specific_t { H5VL_LINK_DELETE, H5VL_LINK_EXISTS, H5VL_LINK_ITER }
enum	H5VL_object_get_t { H5VL_OBJECT_GET_FILE, H5VL_OBJECT_GET_NAME, H5VL_OBJECT_GET_TYPE, H5VL_OBJECT_GET_INFO }
enum	H5VL_object_specific_t {   H5VL_OBJECT_CHANGE_REF_COUNT, H5VL_OBJECT_EXISTS, H5VL_OBJECT_LOOKUP, H5VL_OBJECT_VISIT,   H5VL_OBJECT_FLUSH, H5VL_OBJECT_REFRESH }
enum	H5VL_request_specific_t { H5VL_REQUEST_WAITANY, H5VL_REQUEST_WAITSOME, H5VL_REQUEST_WAITALL }
enum	H5VL_blob_specific_t { H5VL_BLOB_DELETE, H5VL_BLOB_GETSIZE, H5VL_BLOB_ISNULL, H5VL_BLOB_SETNULL }
enum	H5VL_loc_type_t { H5VL_OBJECT_BY_SELF, H5VL_OBJECT_BY_NAME, H5VL_OBJECT_BY_IDX, H5VL_OBJECT_BY_TOKEN }
enum	H5VL_get_conn_lvl_t { H5VL_GET_CONN_LVL_CURR, H5VL_GET_CONN_LVL_TERM }

Functions
H5_DLL hid_t	H5VLregister_connector (const H5VL_class_t *cls, hid_t vipl_id)
H5_DLL void *	H5VLobject (hid_t obj_id)
H5_DLL hid_t	H5VLget_file_type (void *file_obj, hid_t connector_id, hid_t dtype_id)
H5_DLL hid_t	H5VLpeek_connector_id_by_name (const char *name)
H5_DLL hid_t	H5VLpeek_connector_id_by_value (H5VL_class_value_t value)

Macro Definition Documentation

H5VL_CAP_FLAG_NONE

#define H5VL_CAP_FLAG_NONE   0 /* No special connector capabilities */

H5VL_CAP_FLAG_THREADSAFE

#define H5VL_CAP_FLAG_THREADSAFE   0x01 /* Connector is threadsafe */

H5VL_CONTAINER_INFO_VERSION

#define H5VL_CONTAINER_INFO_VERSION   0x01 /* Container info struct version */

H5VL_MAX_BLOB_ID_SIZE

#define H5VL_MAX_BLOB_ID_SIZE   (16) /* Allow for 128-bits blob IDs */

Typedef Documentation

H5VL_attr_class_t

typedef struct H5VL_attr_class_t H5VL_attr_class_t

H5VL_attr_get_t

typedef enum H5VL_attr_get_t H5VL_attr_get_t

H5VL_attr_optional_t

typedef int H5VL_attr_optional_t

H5VL_attr_specific_t

typedef enum H5VL_attr_specific_t H5VL_attr_specific_t

H5VL_blob_class_t

typedef struct H5VL_blob_class_t H5VL_blob_class_t

H5VL_blob_optional_t

typedef int H5VL_blob_optional_t

H5VL_blob_specific_t

typedef enum H5VL_blob_specific_t H5VL_blob_specific_t

H5VL_class_t

typedef struct H5VL_class_t H5VL_class_t

H5VL_dataset_class_t

typedef struct H5VL_dataset_class_t H5VL_dataset_class_t

H5VL_dataset_get_t

typedef enum H5VL_dataset_get_t H5VL_dataset_get_t

H5VL_dataset_optional_t

typedef int H5VL_dataset_optional_t

H5VL_dataset_specific_t

typedef enum H5VL_dataset_specific_t H5VL_dataset_specific_t

H5VL_datatype_class_t

typedef struct H5VL_datatype_class_t H5VL_datatype_class_t

H5VL_datatype_get_t

typedef enum H5VL_datatype_get_t H5VL_datatype_get_t

H5VL_datatype_optional_t

typedef int H5VL_datatype_optional_t

H5VL_datatype_specific_t

typedef enum H5VL_datatype_specific_t H5VL_datatype_specific_t

H5VL_file_class_t

typedef struct H5VL_file_class_t H5VL_file_class_t

H5VL_file_cont_info_t

typedef struct H5VL_file_cont_info_t H5VL_file_cont_info_t

H5VL_file_get_t

typedef enum H5VL_file_get_t H5VL_file_get_t

H5VL_file_optional_t

typedef int H5VL_file_optional_t

H5VL_file_specific_t

typedef enum H5VL_file_specific_t H5VL_file_specific_t

H5VL_get_conn_lvl_t

typedef enum H5VL_get_conn_lvl_t H5VL_get_conn_lvl_t

H5VL_group_class_t

typedef struct H5VL_group_class_t H5VL_group_class_t

H5VL_group_get_t

typedef enum H5VL_group_get_t H5VL_group_get_t

H5VL_group_optional_t

typedef int H5VL_group_optional_t

H5VL_group_specific_t

typedef enum H5VL_group_specific_t H5VL_group_specific_t

H5VL_info_class_t

typedef struct H5VL_info_class_t H5VL_info_class_t

H5VL_introspect_class_t

typedef struct H5VL_introspect_class_t H5VL_introspect_class_t

H5VL_link_class_t

typedef struct H5VL_link_class_t H5VL_link_class_t

H5VL_link_create_type_t

typedef enum H5VL_link_create_type_t H5VL_link_create_type_t

H5VL_link_get_t

typedef enum H5VL_link_get_t H5VL_link_get_t

H5VL_link_optional_t

typedef int H5VL_link_optional_t

H5VL_link_specific_t

typedef enum H5VL_link_specific_t H5VL_link_specific_t

H5VL_loc_by_idx_t

typedef struct H5VL_loc_by_idx H5VL_loc_by_idx_t

H5VL_loc_by_name_t

typedef struct H5VL_loc_by_name H5VL_loc_by_name_t

H5VL_loc_by_token_t

typedef struct H5VL_loc_by_token H5VL_loc_by_token_t

H5VL_loc_params_t

typedef struct H5VL_loc_params_t H5VL_loc_params_t

H5VL_loc_type_t

typedef enum H5VL_loc_type_t H5VL_loc_type_t

H5VL_object_class_t

typedef struct H5VL_object_class_t H5VL_object_class_t

H5VL_object_get_t

typedef enum H5VL_object_get_t H5VL_object_get_t

H5VL_object_optional_t

typedef int H5VL_object_optional_t

H5VL_object_specific_t

typedef enum H5VL_object_specific_t H5VL_object_specific_t

H5VL_request_class_t

typedef struct H5VL_request_class_t H5VL_request_class_t

H5VL_request_notify_t

typedef herr_t(* H5VL_request_notify_t) (void *ctx, H5ES_status_t status)

H5VL_request_optional_t

typedef int H5VL_request_optional_t

H5VL_request_specific_t

typedef enum H5VL_request_specific_t H5VL_request_specific_t

H5VL_subclass_t

typedef enum H5VL_subclass_t H5VL_subclass_t

H5VL_token_class_t

typedef struct H5VL_token_class_t H5VL_token_class_t

H5VL_wrap_class_t

typedef struct H5VL_wrap_class_t H5VL_wrap_class_t

Enumeration Type Documentation

H5VL_attr_get_t

enum H5VL_attr_get_t

Enumerator
H5VL_ATTR_GET_ACPL
H5VL_ATTR_GET_INFO
H5VL_ATTR_GET_NAME
H5VL_ATTR_GET_SPACE
H5VL_ATTR_GET_STORAGE_SIZE
H5VL_ATTR_GET_TYPE

H5VL_attr_specific_t

enum H5VL_attr_specific_t

Enumerator
H5VL_ATTR_DELETE
H5VL_ATTR_EXISTS
H5VL_ATTR_ITER
H5VL_ATTR_RENAME

H5VL_blob_specific_t

enum H5VL_blob_specific_t

Enumerator
H5VL_BLOB_DELETE
H5VL_BLOB_GETSIZE
H5VL_BLOB_ISNULL
H5VL_BLOB_SETNULL

H5VL_dataset_get_t

enum H5VL_dataset_get_t

Enumerator
H5VL_DATASET_GET_DAPL
H5VL_DATASET_GET_DCPL
H5VL_DATASET_GET_SPACE
H5VL_DATASET_GET_SPACE_STATUS
H5VL_DATASET_GET_STORAGE_SIZE
H5VL_DATASET_GET_TYPE

H5VL_dataset_specific_t

enum H5VL_dataset_specific_t

Enumerator
H5VL_DATASET_SET_EXTENT
H5VL_DATASET_FLUSH
H5VL_DATASET_REFRESH

H5VL_datatype_get_t

enum H5VL_datatype_get_t

Enumerator
H5VL_DATATYPE_GET_BINARY
H5VL_DATATYPE_GET_TCPL

H5VL_datatype_specific_t

enum H5VL_datatype_specific_t

Enumerator
H5VL_DATATYPE_FLUSH
H5VL_DATATYPE_REFRESH

H5VL_file_get_t

enum H5VL_file_get_t

Enumerator
H5VL_FILE_GET_CONT_INFO
H5VL_FILE_GET_FAPL
H5VL_FILE_GET_FCPL
H5VL_FILE_GET_FILENO
H5VL_FILE_GET_INTENT
H5VL_FILE_GET_NAME
H5VL_FILE_GET_OBJ_COUNT
H5VL_FILE_GET_OBJ_IDS

H5VL_file_specific_t

enum H5VL_file_specific_t

Enumerator
H5VL_FILE_FLUSH
H5VL_FILE_REOPEN
H5VL_FILE_MOUNT
H5VL_FILE_UNMOUNT
H5VL_FILE_IS_ACCESSIBLE
H5VL_FILE_DELETE
H5VL_FILE_IS_EQUAL

H5VL_get_conn_lvl_t

enum H5VL_get_conn_lvl_t

Enumerator
H5VL_GET_CONN_LVL_CURR
H5VL_GET_CONN_LVL_TERM

H5VL_group_get_t

enum H5VL_group_get_t

Enumerator
H5VL_GROUP_GET_GCPL
H5VL_GROUP_GET_INFO

H5VL_group_specific_t

enum H5VL_group_specific_t

Enumerator
H5VL_GROUP_FLUSH
H5VL_GROUP_REFRESH

H5VL_link_create_type_t

enum H5VL_link_create_type_t

Enumerator
H5VL_LINK_CREATE_HARD
H5VL_LINK_CREATE_SOFT
H5VL_LINK_CREATE_UD

H5VL_link_get_t

enum H5VL_link_get_t

Enumerator
H5VL_LINK_GET_INFO
H5VL_LINK_GET_NAME
H5VL_LINK_GET_VAL

H5VL_link_specific_t

enum H5VL_link_specific_t

Enumerator
H5VL_LINK_DELETE
H5VL_LINK_EXISTS
H5VL_LINK_ITER

H5VL_loc_type_t

enum H5VL_loc_type_t

Enumerator
H5VL_OBJECT_BY_SELF
H5VL_OBJECT_BY_NAME
H5VL_OBJECT_BY_IDX
H5VL_OBJECT_BY_TOKEN

H5VL_object_get_t

enum H5VL_object_get_t

Enumerator
H5VL_OBJECT_GET_FILE
H5VL_OBJECT_GET_NAME
H5VL_OBJECT_GET_TYPE
H5VL_OBJECT_GET_INFO

H5VL_object_specific_t

enum H5VL_object_specific_t

Enumerator
H5VL_OBJECT_CHANGE_REF_COUNT
H5VL_OBJECT_EXISTS
H5VL_OBJECT_LOOKUP
H5VL_OBJECT_VISIT
H5VL_OBJECT_FLUSH
H5VL_OBJECT_REFRESH

H5VL_request_specific_t

enum H5VL_request_specific_t

Enumerator
H5VL_REQUEST_WAITANY
H5VL_REQUEST_WAITSOME
H5VL_REQUEST_WAITALL

H5VL_subclass_t

enum H5VL_subclass_t

Enumerator
H5VL_SUBCLS_NONE
H5VL_SUBCLS_INFO
H5VL_SUBCLS_WRAP
H5VL_SUBCLS_ATTR
H5VL_SUBCLS_DATASET
H5VL_SUBCLS_DATATYPE
H5VL_SUBCLS_FILE
H5VL_SUBCLS_GROUP
H5VL_SUBCLS_LINK
H5VL_SUBCLS_OBJECT
H5VL_SUBCLS_REQUEST
H5VL_SUBCLS_BLOB
H5VL_SUBCLS_TOKEN

Function Documentation

H5VLget_file_type()

H5_DLL hid_t H5VLget_file_type	(	void *	file_obj,
		hid_t	connector_id,
		hid_t	dtype_id
	)

H5VLobject()

H5_DLL void* H5VLobject

(

hid_t

obj_id

)

H5VLpeek_connector_id_by_name()

H5_DLL hid_t H5VLpeek_connector_id_by_name

(

const char *

name

)

H5VLpeek_connector_id_by_value()

H5_DLL hid_t H5VLpeek_connector_id_by_value

(

H5VL_class_value_t

value

)

H5VLregister_connector()

H5_DLL hid_t H5VLregister_connector	(	const H5VL_class_t *	cls,
		hid_t	vipl_id
	)