schedule.h

Go to the documentation of this file.
00001 /*
00002  * SpanDSP - a series of DSP components for telephony
00003  *
00004  * schedule.h
00005  *
00006  * Written by Steve Underwood <steveu@coppice.org>
00007  *
00008  * Copyright (C) 2004 Steve Underwood
00009  *
00010  * All rights reserved.
00011  *
00012  * This program is free software; you can redistribute it and/or modify
00013  * it under the terms of the GNU Lesser General Public License version 2.1,
00014  * as published by the Free Software Foundation.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Lesser General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU Lesser General Public
00022  * License along with this program; if not, write to the Free Software
00023  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00024  *
00025  * $Id: schedule.h,v 1.17 2008/11/30 05:43:37 steveu Exp $
00026  */
00027 
00028 /*! \file */
00029 
00030 /*! \page schedule_page Scheduling
00031 \section schedule_page_sec_1 What does it do?
00032 ???.
00033 
00034 \section schedule_page_sec_2 How does it work?
00035 ???.
00036 */
00037 
00038 #if !defined(_SPANDSP_SCHEDULE_H_)
00039 #define _SPANDSP_SCHEDULE_H_
00040 
00041 /*! A scheduled event entry. */
00042 typedef struct span_sched_s span_sched_t;
00043 
00044 /*! A scheduled event queue. */
00045 typedef struct span_sched_state_s span_sched_state_t;
00046 
00047 typedef void (*span_sched_callback_func_t)(span_sched_state_t *s, void *user_data);
00048 
00049 #if defined(__cplusplus)
00050 extern "C"
00051 {
00052 #endif
00053 
00054 uint64_t span_schedule_next(span_sched_state_t *s);
00055 uint64_t span_schedule_time(span_sched_state_t *s);
00056 
00057 int span_schedule_event(span_sched_state_t *s, int us, span_sched_callback_func_t function, void *user_data);
00058 void span_schedule_update(span_sched_state_t *s, int us);
00059 void span_schedule_del(span_sched_state_t *s, int id);
00060 
00061 span_sched_state_t *span_schedule_init(span_sched_state_t *s);
00062 int span_schedule_release(span_sched_state_t *s);
00063 
00064 #if defined(__cplusplus)
00065 }
00066 #endif
00067 
00068 #endif
00069 /*- End of file ------------------------------------------------------------*/

Generated on Thu Feb 12 14:16:07 2009 for spandsp by  doxygen 1.5.5