clam.h

   1 /*
   2  * inoclam - Inotify+ClamAV virus scanner
   3  * Copyright (C) 2007 Vermont Department of Taxes
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  * Contributor(s):
  20  *   Tom Cort <tom.cort@state.vt.us>
  21  */
  22
  23 #ifndef __CLAM_H
  24 #define __CLAM_H
  25
  26 #include <pthread.h>
  27
  28 /**
  29  * A lock used to serialize access to the engine. Serialized access is
  30  * needed to keep clam_refresh() from changing the engine while
  31  * contains_virus() is using it.
  32  * @see clam_refresh()
  33  * @see contains_virus()
  34  */
  35 pthread_mutex_t engine_lock;
  36
  37 /**
  38  * Thread attributes used by the clam_refresh() thread. This is
  39  * a global so that main() can free them when its cleaning up.
  40  * @see main()
  41  * @see clam_refresh()
  42  */
  43 pthread_attr_t ta;
  44
  45 /**
  46  * Thread that reloads virus definitions as needed
  47  */
  48 void clam_refresh();
  49
  50 /**
  51  * Load the virus definition files and prepare the engine.
  52  */
  53 void clam_init();
  54
  55 /**
  56  * Scans a file for virus.
  57  * @return -1 Error || 0 No Virus || +1 Virus Found
  58  */
  59 int contains_virus(char *filename);
  60
  61 /**
  62  * Free resources used by the engine.
  63  */
  64 void clam_exit();
  65
  66 #endif