include/muxevent.h

Go to the documentation of this file.

/*
 * $Id: muxevent.h,v 1.1 2005/06/22 22:09:45 murrayma Exp $
 *
 * Author: Markus Stenberg <fingon@iki.fi>
 *
 *  Copyright (c) 1996 Markus Stenberg
 *       All rights reserved
 *
 * Created: Tue Aug 27 19:02:00 1996 fingon
 * Last modified: Sat Jun  6 22:20:36 1998 fingon
 *
 */

#ifndef MUXEVENT_H
#define MUXEVENT_H

/* EVENT_DEBUG adds some useful debugging information to the structure
   / allows more diverse set of error messages to be shown. However,
   for a run-time version it's practically useless. */

/* #undef EVENT_DEBUG */

#define FLAG_FREE_DATA      1   /* Free the 1st data segment after execution */
#define FLAG_FREE_DATA2     2   /* Free the 2nd data segment after execution */
#define FLAG_ZOMBIE         4   /* Exists there just because we're too
                                   lazy to search for it everywhere - dud */

/* ZOMBIE events aren't moved during reschedule, they instead die then.
   Killing them outside event_run is kinda unhealthy, therefore we set things
   just ZOMBIE and delete if it's convenient for us. */

/* Main idea: Events are arranged as follows:
   - next 1-60sec (depending on present timing) each their own
     linked list
   - next hour with each min in the own linked list
   - next 60 hours with each hour in the own linked list
   - the rest in one huge 'stack', ordered according to time
     */

/* typedef unsigned char byte; */

typedef struct my_event_type {
    char flags;
    void (*function) (struct my_event_type *);
    void *data;
    void *data2;
    int tick;                   /* The tick this baby was first scheduled to go off */
    char type;
    struct my_event_type *next;
    struct my_event_type *next_in_main;
    struct my_event_type *prev_in_main;
    struct my_event_type *prev_in_type;
    struct my_event_type *next_in_type;
} MUXEVENT;

/* Some external things _do_ use this one */
extern int muxevent_tick;

#include "p.event.h"

/* Simplified event adding is more or less irrelevant, most programs
   tend to make their own macros for it. This is an example,
   though. */
#define muxevent_add_simple_arg(time,func,data) muxevent_add(time,0,0,func,data, NULL)
#define muxevent_add_simple_noarg(time,func) muxevent_add(time,0,0,func,NULL, NULL)

/* Macros for handling simple lists 
   Where it applies: a = main list, b = thing to be added, c = prev
   field, d = next field (c = next field in case of single-linked
   model */

#define REMOVE_FROM_LIST(a,c,b) if (a == b ) a = b->c; else { MUXEVENT *t; \
for (t=a;t->c != b;t=t->c); t->c = b->c; }
#define REMOVE_FROM_BIDIR_LIST(a,c,d,b) if (b->c) b->c->d = b->d; \
 if (b->d) b->d->c = b->c; if (a==b) { a=b->d; if (a) a->c=NULL; }

#define ADD_TO_LIST_HEAD(a,c,b) b->c = a ; a = b
#define ADD_TO_BIDIR_LIST_HEAD(a,c,d,b) b->d=a ; if (a) a->c = b ; a=b ; \
                                        b->c=NULL


/* The standard debugging macro.. Should be more or less useless
 because this is mostly used in daemon type of programs.  */

#ifdef DEBUG
#define debug(a...) printf(##a)
#else
#define debug(a...)
#endif

void muxevent_add(int time, int flags, int type, void (*func) (MUXEVENT *),
    void *data, void *data2);
void muxevent_gothru_type_data(int type, void *data, void (*func) (MUXEVENT *));
void event_gothru_type(int type, void (*func) (MUXEVENT *));



/* Did I mention cproto is braindead? */

#endif                          /* MUXEVENT_H */

---