src/thttpd-2.27/mmc.h

   1 /* mmc.h - header file for mmap cache package
   2 **
   3 ** Copyright © 1998,2014 by Jef Poskanzer <jef@mail.acme.com>.
   4 ** All rights reserved.
   5 **
   6 ** Redistribution and use in source and binary forms, with or without
   7 ** modification, are permitted provided that the following conditions
   8 ** are met:
   9 ** 1. Redistributions of source code must retain the above copyright
  10 **    notice, this list of conditions and the following disclaimer.
  11 ** 2. Redistributions in binary form must reproduce the above copyright
  12 **    notice, this list of conditions and the following disclaimer in the
  13 **    documentation and/or other materials provided with the distribution.
  14 **
  15 ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 ** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 ** ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 ** FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 ** OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 ** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 ** LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 ** OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 ** SUCH DAMAGE.
  26 */
  27
  28 #ifndef _MMC_H_
  29 #define _MMC_H_
  30
  31 /* Returns an mmap()ed area for the given file, or (void*) 0 on errors.
  32 ** If you have a stat buffer on the file, pass it in, otherwise pass 0.
  33 ** Same for the current time.
  34 */
  35 void* mmc_map( char* filename, struct stat* sbP, struct timeval* nowP );
  36
  37 /* Done with an mmap()ed area that was returned by mmc_map().
  38 ** If you have a stat buffer on the file, pass it in, otherwise pass 0.
  39 ** Same for the current time.
  40 */
  41 void mmc_unmap( void* addr, struct stat* sbP, struct timeval* nowP );
  42
  43 /* Clean up the mmc package, freeing any unused storage.
  44 ** This should be called periodically, say every five minutes.
  45 ** If you have the current time, pass it in, otherwise pass 0.
  46 */
  47 void mmc_cleanup( struct timeval* nowP );
  48
  49 /* Free all storage, usually in preparation for exitting. */
  50 void mmc_term( void );
  51
  52 /* Generate debugging statistics syslog message. */
  53 void mmc_logstats( long secs );
  54
  55 #endif /* _MMC_H_ */