gzlog.h
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:3k
源码类别:

通讯编程

开发平台:

Visual C++

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