alarm.h

Go to the documentation of this file.

/*
** Copyright (C) 2004 Russell Leighton
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __AWALARM__
#define __AWALARM__

#define AW_DEFAULT_ALARM_CYCLE_TIME ( AW_TIMESTAMP_PER_SEC / 10 )


typedef enum {
  AW_ALARM_RUN_TYPE,                
  AW_ALARM_INTERRUPT_TYPE           
} aw_alarm_type_t;

typedef enum {
  AW_ALARM_OK,                 
  AW_ALARM_REMOVE,             
  AW_ALARM_NCODES              
} aw_alarm_code_t;


typedef enum {
  AW_SCHED_NONE,               
  AW_SCHED_PULSE,              
  AW_SCHED_CALENDAR,           
} aw_alarm_sched_code_t;


typedef enum {
  AW_SCHED_RUNONCE = 0x1,     
} aw_alarm_sched_flag_t;

typedef struct {

  /* offset */
  aw_timestamp_t
   phase;

  /* how often (normal cycle) */
  aw_timestamp_t
   period;

} aw_alarm_sched_pulse_t;

typedef struct {

 /* these are treated as bit vectors */
 u_int64_t
  min;                /*< minute, bits 0-59 */
 u_int32_t
  hour,               /*< hour, bits 0-23 */
  mday,               /*< day of month, bits 1-31 */
  mon,                /*< month, bits 0-11 , 0 is January */
  wday;               /*< day of week, 0-6, 0 is Sunday */

} aw_alarm_sched_cal_t;

typedef struct {

  aw_alarm_sched_code_t
   method_type;

  aw_alarm_sched_flag_t
   flags;

  /* how we control cycling... */
  union {
    
    aw_alarm_sched_pulse_t           /* simple cycle */
      pulse;

    aw_alarm_sched_cal_t             /* via calendar */
      calendar;

  } method;


  /* this calendar schedule (if enabled, which means .min != 0) 
     specifies the times NOT to run...used for things like
     maintenance windows, for example: run every 5min
     except from midnight to 3am on Sundays */
  aw_alarm_sched_cal_t             
   notch;

} aw_alarm_sched_t;


typedef struct {

  /* start time of next alarm */
  aw_timestamp_t
   next_alarm_time;

  /* the run schedule */
  aw_alarm_sched_t
    sched;

} aw_alarm_state_t;

typedef struct {

  aw_event_sig_t
   interrupt;                  /* alarm went off */

} aw_alarm_events_t;


typedef struct aw_alarm_s {

  /* run time list */
  struct aw_alarm_s
   *next,*prev;

  /* what kind */
  aw_alarm_type_t
   type;

  /* cache allocator used to create this */
  aw_cache_allocator_t 
   *factory;

  /* holds state related info */
  aw_alarm_state_t
   state;

  /* events generated */
  aw_alarm_events_t
   events;

} aw_alarm_t ;


int32_t aw_set_sched_calendar(aw_alarm_sched_cal_t *cal, const byte_t *crontab, FILE *message_stream);

#endif

Aware 0.11.1 Copyright (C) 1998-2005 Russell Leighton (russ@elegant-software.com)