H5WBprivate.h

00001 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00002  * Copyright by The HDF Group.                                               *
00003  * Copyright by the Board of Trustees of the University of Illinois.         *
00004  * All rights reserved.                                                      *
00005  *                                                                           *
00006  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
00007  * terms governing use, modification, and redistribution, is contained in    *
00008  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
00009  * of the source code distribution tree; Copyright.html can be found at the  *
00010  * root level of an installed copy of the electronic HDF5 document set and   *
00011  * is linked from the top-level documents page.  It can also be found at     *
00012  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
00013  * access to either file, you may request a copy from help@hdfgroup.org.     *
00014  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00015 
00016 /*-------------------------------------------------------------------------
00017  *
00018  * Created:             H5WBprivate.h
00019  *                      Jun 26 2007
00020  *                      Quincey Koziol <koziol@hdfgroup.org>
00021  *
00022  * Purpose:             Private header for library accessible wrapped buffer routines.
00023  *
00024  *-------------------------------------------------------------------------
00025  */
00026 
00027 #ifndef _H5WBprivate_H
00028 #define _H5WBprivate_H
00029 
00030 /* Include package's public header */
00031 /* #include "H5WBpublic.h" */
00032 
00033 /* Private headers needed by this file */
00034 
00035 /**************************/
00036 /* Library Private Macros */
00037 /**************************/
00038 
00039 
00040 /****************************/
00041 /* Library Private Typedefs */
00042 /****************************/
00043 
00044 /* Wrapped buffer info (forward decl - defined in H5WB.c) */
00045 typedef struct H5WB_t H5WB_t;
00046 
00047 
00048 /*****************************/
00049 /* Library-private Variables */
00050 /*****************************/
00051 
00052 
00053 /***************************************/
00054 /* Library-private Function Prototypes */
00055 /***************************************/
00056 
00057 /* General routines for wrapped buffer operations */
00058 H5_DLL H5WB_t *H5WB_wrap(void *buf, size_t buf_size);
00059 H5_DLL void *H5WB_actual(H5WB_t *wb, size_t need);
00060 H5_DLL void *H5WB_actual_clear(H5WB_t *wb, size_t need);
00061 H5_DLL herr_t H5WB_unwrap(H5WB_t *wb);
00062 
00063 #endif /* _H5WBprivate_H */
00064