libUPnP  1.8.4
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 {
53  ABS_SEC,
55  REL_SEC
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 
112 int TimerThreadSchedule(
114  TimerThread* timer,
117  time_t time,
120  TimeoutType type,
122  ThreadPoolJob *job,
124  Duration duration,
126  int *id);
127 
135 int TimerThreadRemove(
137  TimerThread *timer,
139  int id,
141  ThreadPoolJob *out);
142 
152 int TimerThreadShutdown(
154  TimerThread *timer);
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 #endif /* TIMER_THREAD_H */
161 
TIMEREVENT
Definition: TimerThread.h:84
THREADPOOL
A thread pool similar to the thread pool in the UPnP SDK.
Definition: ThreadPool.h:213
TimerThread.h
LINKEDLIST::size
long size
Definition: LinkedList.h:90
ListDelNode
void * ListDelNode(LinkedList *list, ListNode *dnode, int freeItem)
Removes a node from the list. The memory for the node is freed.
Definition: LinkedList.c:177
FreeListDestroy
int FreeListDestroy(FreeList *free_list)
Releases the resources stored with the free list.
Definition: FreeList.c:92
TimerEvent
struct TIMEREVENT TimerEvent
CreateTimerEvent
static TimerEvent * CreateTimerEvent(TimerThread *timer, ThreadPoolJob *job, Duration persistent, time_t eventTime, int id)
Creates a Timer Event. (Dynamically allocated).
Definition: TimerThread.c:160
CalculateEventTime
static int CalculateEventTime(time_t *timeout, TimeoutType type)
Calculates the appropriate timeout in absolute seconds since Jan 1, 1970.
Definition: TimerThread.c:133
timeoutType
timeoutType
Definition: TimerThread.h:51
TIMEREVENT::eventTime
time_t eventTime
Definition: TimerThread.h:87
FreeTimerEvent
static void FreeTimerEvent(TimerThread *timer, TimerEvent *event)
Deallocates a dynamically allocated TimerEvent.
Definition: TimerThread.c:44
TimerThreadShutdown
int TimerThreadShutdown(TimerThread *timer)
Shutdown the timer thread.
Definition: TimerThread.c:352
TPJobSetPriority
int TPJobSetPriority(ThreadPoolJob *job, ThreadPriority priority)
Sets the max threads for the thread pool attributes.
Definition: ThreadPool.c:1083
TimerThreadWorker
static void TimerThreadWorker(void *arg)
Implements timer thread.
Definition: TimerThread.c:60
TimerThreadSchedule
int TimerThreadSchedule(TimerThread *timer, time_t timeout, TimeoutType type, ThreadPoolJob *job, Duration duration, int *id)
Schedules an event to run at a specified time.
Definition: TimerThread.c:245
TimerThreadShutdown
int TimerThreadShutdown(TimerThread *timer)
Shutdown the timer thread.
Definition: TimerThread.c:352
TimerThreadRemove
int TimerThreadRemove(TimerThread *timer, int id, ThreadPoolJob *out)
Removes an event from the timer Q.
Definition: TimerThread.c:314
TIMERTHREAD
Definition: TimerThread.h:68
ThreadPool.h
ListNext
ListNode * ListNext(LinkedList *list, ListNode *node)
Returns the next item in the list.
Definition: LinkedList.c:245
FreeListAlloc
void * FreeListAlloc(FreeList *free_list)
Allocates chunk of set size.
Definition: FreeList.c:51
LISTNODE
Definition: LinkedList.h:61
ListHead
ListNode * ListHead(LinkedList *list)
Returns the head of the list.
Definition: LinkedList.c:219
ListAddTail
ListNode * ListAddTail(LinkedList *list, void *item)
Adds a node to the tail of the list. Node gets added immediately before list.tail.
Definition: LinkedList.c:119
THREADPOOLJOB
Definition: ThreadPool.h:164
ListInit
int ListInit(LinkedList *list, cmp_routine cmp_func, free_function free_func)
Initializes LinkedList. Must be called first and only once for List.
Definition: LinkedList.c:84
TimeoutType
enum timeoutType TimeoutType
ListDestroy
int ListDestroy(LinkedList *list, int freeItem)
Removes all memory associated with list nodes. Does not free LinkedList *list.
Definition: LinkedList.c:200
TPJobInit
int TPJobInit(ThreadPoolJob *job, start_routine func, void *arg)
Initializes thread pool job. Sets the priority to default defined in ThreadPool.h....
Definition: ThreadPool.c:1071
TimerThreadInit
int TimerThreadInit(TimerThread *timer, ThreadPool *tp)
Initializes and starts timer thread.
Definition: TimerThread.c:189
ThreadPoolAddPersistent
int ThreadPoolAddPersistent(ThreadPool *tp, ThreadPoolJob *job, int *jobId)
Adds a persistent job to the thread pool.
Definition: ThreadPool.c:768
TimerThreadRemove
int TimerThreadRemove(TimerThread *timer, int id, ThreadPoolJob *out)
Removes an event from the timer Q.
Definition: TimerThread.c:314
ithread.h
FREELIST
Definition: FreeList.h:62
LINKEDLIST
Definition: LinkedList.h:84
TIMEREVENT::persistent
Duration persistent
Definition: TimerThread.h:89
FreeListInit
int FreeListInit(FreeList *free_list, size_t elementSize, int maxFreeListLength)
Initializes Free List.
Definition: FreeList.c:37
ABS_SEC
@ ABS_SEC
Definition: TimerThread.h:53
ThreadPoolAdd
int ThreadPoolAdd(ThreadPool *tp, ThreadPoolJob *job, int *jobId)
Adds a job to the thread pool. Job will be run as soon as possible.
Definition: ThreadPool.c:816
FreeListFree
int FreeListFree(FreeList *free_list, void *element)
Returns an item to the Free List.
Definition: FreeList.c:71
FreeList.h
ListAddBefore
ListNode * ListAddBefore(LinkedList *list, void *item, ListNode *anode)
Adds a node before the specified node. Node gets added immediately before anode.
Definition: LinkedList.c:153
TimerThreadInit
int TimerThreadInit(TimerThread *timer, ThreadPool *tp)
Initializes and starts timer thread.
Definition: TimerThread.c:189
REL_SEC
@ REL_SEC
Definition: TimerThread.h:55
TimerThread
struct TIMERTHREAD TimerThread
LinkedList.h
TimerThreadSchedule
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
Generated by doxygen 1.8.20