alarm.h

Go to the documentation of this file.

/***************************************************************************
 *  $Id: event.h 156 2008-06-28 10:05:26Z merdmann $
 *
 *  Thu Nov 29 20:55:57 2007
 *  Copyright  2007 Michael Erdmann
 *  Email: michael.erdmann@snafu.de
 ****************************************************************************/

/*
 *  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 _ALARM_H
#define _ALARM_H

#define ALARMCALLBACK(x)  void x(AlarmType AlarmID)

typedef unsigned TickType;

/* This data type points to the data type TickType.*/
typedef TickType *TickRefType;

typedef struct {
        TickType maxallowedvalue;       /* Maximum possible allowed count value in ticks */
        TickType ticksperbase;          /* Number of ticks required to reach a counter-specific unit*/
        TickType mincycle;                      /* Smallest allowed value for the cycle-parameter */
} AlarmBaseType;

typedef AlarmBaseType* AlarmBaseRefType;

typedef struct {
        unsigned value;
        unsigned ticks;

        AlarmBaseType *base;
} t_counter;

/* internal presentation of an alarm */
typedef struct {
        BOOL            active;
        unsigned        expire;
        unsigned        cycle;
        t_counter       *counter;
} t_alarm;


typedef t_alarm* AlarmType;     /* This data type represents an alarm object. */

StatusType GetAlarmBase ( AlarmType AlarmId, AlarmBaseRefType info );

StatusType GetAlarm ( AlarmType AlarmID, TickRefType Info);

StatusType SetRelAlarm ( AlarmType AlarmID, TickType increment, TickType cycle );

StatusType SetAbsAlarm ( AlarmType AlarmID, TickType start, TickType cycle );

StatusType CancelAlarm ( AlarmType AlarmID );


#endif

---