common/dist/zlib/examples/gzlog.h

   1 /*      $NetBSD: gzlog.h,v 1.1.1.1 2006/01/14 20:11:09 christos Exp $   */
   2
   3 /* gzlog.h
   4   Copyright (C) 2004 Mark Adler, all rights reserved
   5   version 1.0, 26 Nov 2004
   6
   7   This software is provided 'as-is', without any express or implied
   8   warranty.  In no event will the author be held liable for any damages
   9   arising from the use of this software.
  10
  11   Permission is granted to anyone to use this software for any purpose,
  12   including commercial applications, and to alter it and redistribute it
  13   freely, subject to the following restrictions:
  14
  15   1. The origin of this software must not be misrepresented; you must not
  16      claim that you wrote the original software. If you use this software
  17      in a product, an acknowledgment in the product documentation would be
  18      appreciated but is not required.
  19   2. Altered source versions must be plainly marked as such, and must not be
  20      misrepresented as being the original software.
  21   3. This notice may not be removed or altered from any source distribution.
  22
  23   Mark Adler    madler@alumni.caltech.edu
  24  */
  25
  26 /*
  27    The gzlog object allows writing short messages to a gzipped log file,
  28    opening the log file locked for small bursts, and then closing it.  The log
  29    object works by appending stored data to the gzip file until 1 MB has been
  30    accumulated.  At that time, the stored data is compressed, and replaces the
  31    uncompressed data in the file.  The log file is truncated to its new size at
  32    that time.  After closing, the log file is always valid gzip file that can
  33    decompressed to recover what was written.
  34
  35    A gzip header "extra" field contains two file offsets for appending.  The
  36    first points to just after the last compressed data.  The second points to
  37    the last stored block in the deflate stream, which is empty.  All of the
  38    data between those pointers is uncompressed.
  39  */
  40
  41 /* Open a gzlog object, creating the log file if it does not exist.  Return
  42    NULL on error.  Note that gzlog_open() could take a long time to return if
  43    there is difficulty in locking the file. */
  44 void *gzlog_open(char *path);
  45
  46 /* Write to a gzlog object.  Return non-zero on error.  This function will
  47    simply write data to the file uncompressed.  Compression of the data
  48    will not occur until gzlog_close() is called.  It is expected that
  49    gzlog_write() is used for a short message, and then gzlog_close() is
  50    called.  If a large amount of data is to be written, then the application
  51    should write no more than 1 MB at a time with gzlog_write() before
  52    calling gzlog_close() and then gzlog_open() again. */
  53 int gzlog_write(void *log, char *data, size_t len);
  54
  55 /* Close a gzlog object.  Return non-zero on error.  The log file is locked
  56    until this function is called.  This function will compress stored data
  57    at the end of the gzip file if at least 1 MB has been accumulated.  Note
  58    that the file will not be a valid gzip file until this function completes.
  59  */
  60 int gzlog_close(void *log);