bfile.h

Go to the documentation of this file.

/* This file is part of the Zebra server.
   Copyright (C) Index Data
 
Zebra is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
 
Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
*/
 
#ifndef BFILE_H
#define BFILE_H
 
#include <yaz/yconfig.h>
#include <idzebra/util.h>
 
YAZ_BEGIN_CDECL
 
typedef struct BFiles_struct *BFiles;
 
typedef struct BFile_struct *BFile;
 
BFiles bfs_create (const char *spec, const char *base);
 
void bfs_destroy (BFiles bfiles);
 
YAZ_EXPORT
void bf_close(BFile bf);
 
YAZ_EXPORT
int bf_close2(BFile bf);
 
YAZ_EXPORT
BFile bf_open(BFiles bfs, const char *name, int block_size, int wflag);
 
 
YAZ_EXPORT
int bf_read(BFile bf, zint no, int offset, int nbytes, void *buf);
 
YAZ_EXPORT
int bf_read2(BFile bf, zint no, int offset, int nbytes, void *buf)
    ZEBRA_GCC_ATTR((warn_unused_result));
 
 
YAZ_EXPORT
int bf_write(BFile bf, zint no, int offset, int nbytes, const void *buf);
 
 
YAZ_EXPORT
int bf_write2(BFile bf, zint no, int offset, int nbytes, const void *buf)
    ZEBRA_GCC_ATTR((warn_unused_result));
 
YAZ_EXPORT
ZEBRA_RES bf_cache (BFiles bfs, const char *spec);
 
YAZ_EXPORT
int bf_commitExists (BFiles bfs);
 
YAZ_EXPORT
int bf_commitExec (BFiles bfs) ZEBRA_GCC_ATTR((warn_unused_result));
 
YAZ_EXPORT
void bf_commitClean (BFiles bfs, const char *spec);
 
YAZ_EXPORT
void bf_reset (BFiles bfs);
 
/* \brief gets statistics about directory in register area
   \param bfs block files
   \param no directory number (0=first, 1=second,...)
   \param directory holds directory name (if found)
   \param used_bytes used file bytes in directory (if found)
   \param max_bytes max usage of bytes (if found)
   \retval 1 no is within range and directory, used, max are set.
   \retval 0 no is out of range and directory, used, max are unset
 
   We are using double, because off_t may have a different size
   on same platform depending on whether 64-bit is enabled or not.
   Note that if a register area has unlimited size, that is represented
   as max_bytes = -1.
 
*/
YAZ_EXPORT
int bfs_register_directory_stat(BFiles bfs, int no, const char **directory,
                                double *used_bytes, double *max_bytes);
 
/* \brief gets statistics about directory in shadow area
   \param bfs block files
   \param no directory number (0=first, 1=second,...)
   \param directory holds directory name (if found)
   \param used_bytes used file bytes in directory (if found)
   \param max_bytes max usage of bytes (if found)
   \retval 1 no is within range and directory, used, max are set.
   \retval 0 no is out of range and directory, used, max are unset
 
   We are using double, because off_t may have a different size
   on same platform depending on whether 64-bit is enabled or not.
   Note that if a shadow area has unlimited size, that is represented
   as max_bytes = -1.
*/
YAZ_EXPORT
int bfs_shadow_directory_stat(BFiles bfs, int no, const char **directory,
                              double *used_bytes, double *max_bytes);
 
YAZ_END_CDECL
 
#endif
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */