src/event.h

   1
   2 /*
   3  * $Id$
   4  *
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33
  34 #ifndef SQUID_EVENT_H
  35 #define SQUID_EVENT_H
  36
  37 #include "squid-old.h"
  38 #include "Array.h"
  39 #include "AsyncEngine.h"
  40
  41 /* forward decls */
  42
  43 class StoreEntry;
  44
  45 /* event scheduling facilities - run a callback after a given time period. */
  46
  47 typedef void EVH(void *);
  48
  49 extern void eventAdd(const char *name, EVH * func, void *arg, double when, int, bool cbdata=true);
  50 SQUIDCEXTERN void eventAddIsh(const char *name, EVH * func, void *arg, double delta_ish, int);
  51 SQUIDCEXTERN void eventDelete(EVH * func, void *arg);
  52 SQUIDCEXTERN void eventInit(void);
  53 SQUIDCEXTERN void eventFreeMemory(void);
  54 SQUIDCEXTERN int eventFind(EVH *, void *);
  55
  56 class ev_entry
  57 {
  58
  59 public:
  60     ev_entry(char const * name, EVH * func, void *arg, double when, int weight, bool cbdata=true);
  61     ~ev_entry();
  62     MEMPROXY_CLASS(ev_entry);
  63     const char *name;
  64     EVH *func;
  65     void *arg;
  66     double when;
  67
  68     int weight;
  69     bool cbdata;
  70
  71     ev_entry *next;
  72 };
  73
  74 MEMPROXY_CLASS_INLINE(ev_entry);
  75
  76 // manages time-based events
  77 class EventScheduler : public AsyncEngine
  78 {
  79
  80 public:
  81     EventScheduler();
  82     ~EventScheduler();
  83     /* cancel a scheduled but not dispatched event */
  84     void cancel(EVH * func, void * arg);
  85     /* clean up the used memory in the scheduler */
  86     void clean();
  87     /* how long until the next event ? */
  88     int checkDelay();
  89     /* cache manager output for the event queue */
  90     void dump(StoreEntry *);
  91     /* find a scheduled event */
  92     bool find(EVH * func, void * arg);
  93     /* schedule a callback function to run in when seconds */
  94     void schedule(const char *name, EVH * func, void *arg, double when, int weight, bool cbdata=true);
  95     int checkEvents(int timeout);
  96     static EventScheduler *GetInstance();
  97
  98 private:
  99     static EventScheduler _instance;
 100     ev_entry * tasks;
 101 };
 102
 103 #endif /* SQUID_EVENT_H */