libUPnP  1.8.0
TimerThread.h
Go to the documentation of this file.
00001 /*******************************************************************************
00002  *
00003  * Copyright (c) 2000-2003 Intel Corporation 
00004  * All rights reserved. 
00005  *
00006  * Redistribution and use in source and binary forms, with or without 
00007  * modification, are permitted provided that the following conditions are met: 
00008  *
00009  * * Redistributions of source code must retain the above copyright notice, 
00010  * this list of conditions and the following disclaimer. 
00011  * * Redistributions in binary form must reproduce the above copyright notice, 
00012  * this list of conditions and the following disclaimer in the documentation 
00013  * and/or other materials provided with the distribution. 
00014  * * Neither name of Intel Corporation nor the names of its contributors 
00015  * may be used to endorse or promote products derived from this software 
00016  * without specific prior written permission.
00017  * 
00018  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
00019  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
00020  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
00021  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR 
00022  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00023  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
00024  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
00025  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
00026  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00027  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  ******************************************************************************/
00031 
00032 
00033 #ifndef TIMERTHREAD_H
00034 #define TIMERTHREAD_H
00035 
00036 
00042 #include "FreeList.h"
00043 #include "ithread.h"
00044 #include "LinkedList.h"
00045 #include "ThreadPool.h"
00046 
00047 
00048 #ifdef __cplusplus
00049 extern "C" {
00050 #endif
00051 
00052 
00053 #define INVALID_EVENT_ID (-10 & 1<<29)
00054 
00055 
00056 /* Timeout Types */
00057 /* absolute means in seconds from Jan 1, 1970 */
00058 /* relative means in seconds from current time */
00059 typedef enum timeoutType {ABS_SEC,REL_SEC} TimeoutType;
00060 
00061 
00071 typedef struct TIMERTHREAD
00072 {
00073         ithread_mutex_t mutex;
00074         ithread_cond_t condition;
00075         int lastEventId;
00076         LinkedList eventQ;
00077         int shutdown;
00078         FreeList freeEvents;
00079         ThreadPool *tp;
00080 } TimerThread;
00081 
00082 
00088 typedef struct TIMEREVENT
00089 {
00090         ThreadPoolJob job;
00092         time_t eventTime;
00094         Duration persistent;
00095         int id;
00096 } TimerEvent;
00097 
00098 
00105 int TimerThreadInit(
00107         TimerThread *timer,
00110         ThreadPool *tp);
00111 
00112 
00119 int TimerThreadSchedule(
00121         TimerThread* timer,
00124         time_t time, 
00127         TimeoutType type,
00129         ThreadPoolJob *job,
00131         Duration duration,
00133         int *id);
00134 
00135 
00143 int TimerThreadRemove(
00145         TimerThread *timer,
00147         int id,
00149         ThreadPoolJob *out);
00150 
00151 
00161 int TimerThreadShutdown(
00163         TimerThread *timer);
00164 
00165 
00166 #ifdef __cplusplus
00167 }
00168 #endif
00169 
00170 #endif /* TIMER_THREAD_H */
00171