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 3 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Contributor(s):
  19  *   Tom Cort <tom.cort@state.vt.us>
  20  */
  21
  22 #ifndef __CLAM_H
  23 #define __CLAM_H
  24
  25 #include <pthread.h>
  26
  27 /**
  28  * A lock used to serialize access to the engine. Serialized access is
  29  * needed to keep clam_refresh() from changing the engine while
  30  * contains_virus() is using it.
  31  * @see clam_refresh()
  32  * @see contains_virus()
  33  */
  34 pthread_mutex_t engine_lock;
  35
  36 /**
  37  * Thread attributes used by the clam_refresh() thread. This is
  38  * a global so that main() can free them when its cleaning up.
  39  * @see main()
  40  * @see clam_refresh()
  41  */
  42 pthread_attr_t ta;
  43
  44 /**
  45  * Thread that reloads virus definitions as needed
  46  */
  47 void clam_refresh();
  48
  49 /**
  50  * Load the virus definition files and prepare the engine.
  51  */
  52 void clam_init();
  53
  54 /**
  55  * Scans a file for virus.
  56  * @return -1 Error || 0 No Virus || +1 Virus Found
  57  */
  58 int contains_virus(char *filename);
  59
  60 /**
  61  * Free resources used by the engine.
  62  */
  63 void clam_exit();
  64
  65 #endif