src/event.h

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