libUPnP  1.6.26
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 "ithread.h"
41 #include "LinkedList.h"
42 #include "ThreadPool.h"
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 #define INVALID_EVENT_ID (-10 & 1<<29)
49 
51 typedef enum timeoutType {
56 } TimeoutType;
57 
67 typedef struct TIMERTHREAD
68 {
69  ithread_mutex_t mutex;
70  ithread_cond_t condition;
71  int lastEventId;
72  LinkedList eventQ;
73  int shutdown;
74  FreeList freeEvents;
75  ThreadPool *tp;
76 } TimerThread;
77 
83 typedef struct TIMEREVENT
84 {
85  ThreadPoolJob job;
87  time_t eventTime;
89  Duration persistent;
90  int id;
91 } TimerEvent;
92 
99 int TimerThreadInit(
101  TimerThread *timer,
104  ThreadPool *tp);
105 
114  TimerThread* timer,
117  time_t time,
120  TimeoutType type,
122  ThreadPoolJob *job,
124  Duration duration,
126  int *id);
127 
137  TimerThread *timer,
139  int id,
141  ThreadPoolJob *out);
142 
154  TimerThread *timer);
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 #endif /* TIMER_THREAD_H */
161 
Definition: TimerThread.h:55
Definition: TimerThread.h:67
int TimerThreadInit(TimerThread *timer, ThreadPool *tp)
Initializes and starts timer thread.
Definition: TimerThread.c:189
A thread pool similar to the thread pool in the UPnP SDK.
Definition: ThreadPool.h:212
time_t eventTime
Definition: TimerThread.h:87
Definition: FreeList.h:61
int TimerThreadShutdown(TimerThread *timer)
Shutdown the timer thread.
Definition: TimerThread.c:352
timeoutType
Definition: TimerThread.h:51
Duration persistent
Definition: TimerThread.h:89
enum timeoutType TimeoutType
Definition: TimerThread.h:83
Definition: ThreadPool.h:163
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:245
int TimerThreadRemove(TimerThread *timer, int id, ThreadPoolJob *out)
Removes an event from the timer Q.
Definition: TimerThread.c:314
struct TIMERTHREAD TimerThread
Definition: TimerThread.h:53
Definition: LinkedList.h:83
struct TIMEREVENT TimerEvent