aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/scheduler.h
blob: 36ba1dbd441c4d0674c8337f6e33b7849b71373e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/**
 * @file scheduler.h
 * 
 * @brief implements the scheduler, looks for jobs in event-queue
 * 
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

#ifndef SCHEDULER_H_
#define SCHEDULER_H_

#include "types.h"

/**
 * @brief The scheduler, looks for timed events in event-queue and adds them
 * to the job-queue.
 * 
 * Starts a thread which does the work, since event-queue is blocking
 */
typedef struct scheduler_s scheduler_t;

struct scheduler_s { 	

	/**
	 * @brief Destroys a scheduler object
	 * 
	 * @param scheduler scheduler object
	 * @return SUCCESSFUL if succeeded, FAILED otherwise
	 */
	status_t (*destroy) (scheduler_t *scheduler);
};


scheduler_t * scheduler_create();

#endif /*SCHEDULER_H_*/