libUPnP  1.8.0
TimerThread.h
Go to the documentation of this file.
1 /*******************************************************************************
2  *
3  * Copyright (c) 2000-2003 Intel Corporation
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * * Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  * * Neither name of Intel Corporation nor the names of its contributors
15  * may be used to endorse or promote products derived from this software
16  * without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  ******************************************************************************/
31 
32 
33 #ifndef TIMERTHREAD_H
34 #define TIMERTHREAD_H
35 
36 
42 #include "FreeList.h"
43 #include "ithread.h"
44 #include "LinkedList.h"
45 #include "ThreadPool.h"
46 
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 
53 #define INVALID_EVENT_ID (-10 & 1<<29)
54 
55 
56 /* Timeout Types */
57 /* absolute means in seconds from Jan 1, 1970 */
58 /* relative means in seconds from current time */
59 typedef enum timeoutType {ABS_SEC,REL_SEC} TimeoutType;
60 
61 
71 typedef struct TIMERTHREAD
72 {
73  ithread_mutex_t mutex;
74  ithread_cond_t condition;
75  int lastEventId;
76  LinkedList eventQ;
77  int shutdown;
78  FreeList freeEvents;
79  ThreadPool *tp;
80 } TimerThread;
81 
82 
88 typedef struct TIMEREVENT
89 {
90  ThreadPoolJob job;
92  time_t eventTime;
94  Duration persistent;
95  int id;
96 } TimerEvent;
97 
98 
105 int TimerThreadInit(
107  TimerThread *timer,
110  ThreadPool *tp);
111 
112 
121  TimerThread* timer,
124  time_t time,
127  TimeoutType type,
129  ThreadPoolJob *job,
131  Duration duration,
133  int *id);
134 
135 
145  TimerThread *timer,
147  int id,
149  ThreadPoolJob *out);
150 
151 
163  TimerThread *timer);
164 
165 
166 #ifdef __cplusplus
167 }
168 #endif
169 
170 #endif /* TIMER_THREAD_H */
171 
Definition: TimerThread.h:71
int TimerThreadInit(TimerThread *timer, ThreadPool *tp)
Initializes and starts timer thread.
Definition: TimerThread.c:195
A thread pool similar to the thread pool in the UPnP SDK.
Definition: ThreadPool.h:266
time_t eventTime
Definition: TimerThread.h:92
Definition: FreeList.h:73
int TimerThreadShutdown(TimerThread *timer)
Shutdown the timer thread.
Definition: TimerThread.c:373
Duration persistent
Definition: TimerThread.h:94
Definition: TimerThread.h:88
Definition: ThreadPool.h:210
int TimerThreadSchedule(TimerThread *timer, time_t time, TimeoutType type, ThreadPoolJob *job, Duration duration, int *id)
Schedules an event to run at a specified time.
Definition: TimerThread.c:253
int TimerThreadRemove(TimerThread *timer, int id, ThreadPoolJob *out)
Removes an event from the timer Q.
Definition: TimerThread.c:334
struct TIMERTHREAD TimerThread
Definition: LinkedList.h:111
struct TIMEREVENT TimerEvent