src/icmp/IcmpConfig.h

   1 /*
   2  * $Id$
   3  *
   4  * DEBUG: section 3     Configuration Settings
   5  * AUTHOR: Amos Jeffries
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from the
  11  *  Internet community.  Development is led by Duane Wessels of the
  12  *  National Laboratory for Applied Network Research and funded by the
  13  *  National Science Foundation.  Squid is Copyrighted (C) 1998 by
  14  *  the Regents of the University of California.  Please see the
  15  *  COPYRIGHT file for full details.  Squid incorporates software
  16  *  developed and/or copyrighted by other sources.  Please see the
  17  *  CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  *  This code is copyright (C) 2007 by Treehouse Networks Ltd
  34  *  of New Zealand. It is published and Lisenced as an extension of
  35  *  squid under the same conditions as the main squid application.
  36  */
  37 #ifndef ICMPCONFIG_H
  38 #define ICMPCONFIG_H
  39
  40 #include "config.h"
  41
  42 #if HAVE_STDLIB_H
  43 #include <stdlib.h>
  44 #endif
  45
  46 /**
  47  * Squid pinger Configuration settings
  48  *
  49  \par
  50  * This structure is included as a child field of the global Config
  51  * such that if ICMP is built it can be accessed as Config.pinger.*
  52  */
  53 class IcmpConfig
  54 {
  55
  56 public:
  57
  58     /** \todo These methods should really be defined in an ICMPConfig.cc file
  59      * alongside any custom parsing routines needed for this component.
  60      * First though, the whole global Config dependancy tree needs fixing */
  61     IcmpConfig() : program(NULL), enable(0) {};
  62     ~IcmpConfig() { if (program) delete program; program = NULL; };
  63
  64     /* variables */
  65
  66     /** pinger helper application path */
  67     char *program;
  68
  69     /** Whether the pinger helper is enabled for use or not */
  70     /** \todo make this much more memory efficient for a boolean */
  71     int enable;
  72 };
  73
  74 #endif /* ICMPCONFIG_H */