src/event.h

   1 /*
   2  * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 #ifndef SQUID_EVENT_H
  10 #define SQUID_EVENT_H
  11
  12 #include "AsyncEngine.h"
  13 #include "mem/forward.h"
  14
  15 class StoreEntry;
  16
  17 /* event scheduling facilities - run a callback after a given time period. */
  18
  19 typedef void EVH(void *);
  20
  21 void eventAdd(const char *name, EVH * func, void *arg, double when, int, bool cbdata=true);
  22 void eventAddIsh(const char *name, EVH * func, void *arg, double delta_ish, int);
  23 void eventDelete(EVH * func, void *arg);
  24 void eventInit(void);
  25 void eventFreeMemory(void);
  26 int eventFind(EVH *, void *);
  27
  28 class ev_entry
  29 {
  30     MEMPROXY_CLASS(ev_entry);
  31
  32 public:
  33     ev_entry(char const * name, EVH * func, void *arg, double when, int weight, bool cbdata=true);
  34     ~ev_entry();
  35     const char *name;
  36     EVH *func;
  37     void *arg;
  38     double when;
  39
  40     int weight;
  41     bool cbdata;
  42
  43     ev_entry *next;
  44 };
  45
  46 // manages time-based events
  47 class EventScheduler : public AsyncEngine
  48 {
  49
  50 public:
  51     EventScheduler();
  52     ~EventScheduler();
  53     /* cancel a scheduled but not dispatched event */
  54     void cancel(EVH * func, void * arg);
  55     /* clean up the used memory in the scheduler */
  56     void clean();
  57     /* either EVENT_IDLE or milliseconds remaining until the next event */
  58     int timeRemaining() const;
  59     /* cache manager output for the event queue */
  60     void dump(StoreEntry *);
  61     /* find a scheduled event */
  62     bool find(EVH * func, void * arg);
  63     /* schedule a callback function to run in when seconds */
  64     void schedule(const char *name, EVH * func, void *arg, double when, int weight, bool cbdata=true);
  65     int checkEvents(int timeout);
  66     static EventScheduler *GetInstance();
  67
  68 private:
  69     static EventScheduler _instance;
  70     ev_entry * tasks;
  71 };
  72
  73 #endif /* SQUID_EVENT_H */
  74