schedule.h
Go to the documentation of this file.
/*
* SpanDSP - a series of DSP components for telephony
*
* schedule.h
*
* Written by Steve Underwood <steveu@coppice.org>
*
* Copyright (C) 2004 Steve Underwood
*
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 2.1,
* as published by the Free Software Foundation.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/*! \file */
/*! \page schedule_page Scheduling
\section schedule_page_sec_1 What does it do?
???.
\section schedule_page_sec_2 How does it work?
???.
*/
#if !defined(_SPANDSP_SCHEDULE_H_)
#define _SPANDSP_SCHEDULE_H_
/*! A scheduled event entry. */
typedef struct span_sched_s span_sched_t;
/*! A scheduled event queue. */
typedef struct span_sched_state_s span_sched_state_t;
typedef void (*span_sched_callback_func_t)(span_sched_state_t *s, void *user_data);
#if defined(__cplusplus)
extern "C"
{
#endif
SPAN_DECLARE(uint64_t) span_schedule_next(span_sched_state_t *s);
SPAN_DECLARE(uint64_t) span_schedule_time(span_sched_state_t *s);
SPAN_DECLARE(int) span_schedule_event(span_sched_state_t *s, int us, span_sched_callback_func_t function, void *user_data);
SPAN_DECLARE(void) span_schedule_update(span_sched_state_t *s, int us);
SPAN_DECLARE(void) span_schedule_del(span_sched_state_t *s, int id);
SPAN_DECLARE(span_sched_state_t *) span_schedule_init(span_sched_state_t *s);
SPAN_DECLARE(int) span_schedule_release(span_sched_state_t *s);
SPAN_DECLARE(int) span_schedule_free(span_sched_state_t *s);
#if defined(__cplusplus)
}
#endif
#endif
/*- End of file ------------------------------------------------------------*/
span_sched_t
struct span_sched_s span_sched_t
Definition schedule.h:40
span_sched_state_t
struct span_sched_state_s span_sched_state_t
Definition schedule.h:43
span_sched_s
Definition private/schedule.h:31
span_sched_state_s
Definition private/schedule.h:39