- began to clean code documentation
[strongswan.git] / Source / charon / threads / scheduler.h
1 /**
2 * @file scheduler.h
3 *
4 * @brief implements the scheduler, looks for jobs in event-queue
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef SCHEDULER_H_
24 #define SCHEDULER_H_
25
26 #include <types.h>
27
28 typedef struct scheduler_t scheduler_t;
29
30 /**
31 * @brief The scheduler, looks for timed events in event-queue and adds them
32 * to the job-queue.
33 *
34 * Starts a thread which does the work, since event-queue is blocking
35 */
36 struct scheduler_t {
37
38 /**
39 * @brief Destroys a scheduler object
40 *
41 * @param scheduler scheduler object
42 * @return SUCCESSFUL if succeeded, FAILED otherwise
43 */
44 status_t (*destroy) (scheduler_t *scheduler);
45 };
46
47
48 scheduler_t * scheduler_create();
49
50 #endif /*SCHEDULER_H_*/