libUPnP  1.14.19
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 #ifndef TIMERTHREAD_H
33 #define TIMERTHREAD_H
34 
39 #include "FreeList.h"
40 #include "LinkedList.h"
41 #include "ThreadPool.h"
42 #include "ithread.h"
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 #define INVALID_EVENT_ID (-10 & 1 << 29)
49 
51 typedef enum timeoutType
52 {
56  REL_SEC
58 
68 typedef struct TIMERTHREAD
69 {
70  ithread_mutex_t mutex;
71  ithread_cond_t condition;
72  int lastEventId;
73  LinkedList eventQ;
74  int shutdown;
75  FreeList freeEvents;
76  ThreadPool *tp;
78 
84 typedef struct TIMEREVENT
85 {
86  ThreadPoolJob job;
88  time_t eventTime;
90  Duration persistent;
91  int id;
93 
100 int TimerThreadInit(
102  TimerThread *timer,
105  ThreadPool *tp);
106 
115  TimerThread *timer,
118  time_t time,
121  TimeoutType type,
123  ThreadPoolJob *job,
125  Duration duration,
127  int *id);
128 
138  TimerThread *timer,
140  int id,
142  ThreadPoolJob *out);
143 
155  TimerThread *timer);
156 
157 #ifdef __cplusplus
158 }
159 #endif
160 
161 #endif /* TIMER_THREAD_H */
enum timeoutType TimeoutType
int TimerThreadShutdown(TimerThread *timer)
Shutdown the timer thread.
Definition: TimerThread.c:355
struct TIMEREVENT TimerEvent
struct TIMERTHREAD TimerThread
int TimerThreadInit(TimerThread *timer, ThreadPool *tp)
Initializes and starts timer thread.
Definition: TimerThread.c:197
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
timeoutType
Definition: TimerThread.h:52
@ ABS_SEC
Definition: TimerThread.h:54
@ REL_SEC
Definition: TimerThread.h:56
int TimerThreadRemove(TimerThread *timer, int id, ThreadPoolJob *out)
Removes an event from the timer Q.
Definition: TimerThread.c:321
Definition: FreeList.h:62
Definition: LinkedList.h:84
Definition: ThreadPool.h:168
A thread pool similar to the thread pool in the UPnP SDK.
Definition: ThreadPool.h:217
Definition: TimerThread.h:85
Duration persistent
Definition: TimerThread.h:90
time_t eventTime
Definition: TimerThread.h:88
Definition: TimerThread.h:69