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 General Public License version 2, as
00014  * 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 General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU General Public License
00022  * 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.12 2007/04/08 08:16:18 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 typedef struct span_sched_state_s span_sched_state_t;
00042 
00043 typedef void (*span_sched_callback_func_t)(span_sched_state_t *s, void *user_data);
00044 
00045 typedef struct
00046 {
00047     uint64_t when;
00048     span_sched_callback_func_t callback;
00049     void *user_data;
00050 } span_sched_t;
00051 
00052 struct span_sched_state_s
00053 {
00054     uint64_t ticker;
00055     int allocated;
00056     int max_to_date;
00057     span_sched_t *sched;
00058     logging_state_t logging;
00059 };
00060 
00061 #if defined(__cplusplus)
00062 extern "C"
00063 {
00064 #endif
00065 
00066 uint64_t span_schedule_next(span_sched_state_t *s);
00067 uint64_t span_schedule_time(span_sched_state_t *s);
00068 
00069 int span_schedule_event(span_sched_state_t *s, int ms, void (*function)(span_sched_state_t *s, void *data), void *user_data);
00070 void span_schedule_update(span_sched_state_t *s, int samples);
00071 void span_schedule_del(span_sched_state_t *s, int id);
00072 
00073 span_sched_state_t *span_schedule_init(span_sched_state_t *s);
00074 int span_schedule_release(span_sched_state_t *s);
00075 
00076 #if defined(__cplusplus)
00077 }
00078 #endif
00079 
00080 #endif
00081 /*- End of file ------------------------------------------------------------*/

Generated on Tue Jul 24 11:29:28 2007 for libspandsp by  doxygen 1.5.2