diff options
| author | Martin Willi <martin@strongswan.org> | 2006-05-10 08:02:49 +0000 |
|---|---|---|
| committer | Martin Willi <martin@strongswan.org> | 2006-05-10 08:02:49 +0000 |
| commit | b8577029d1d37b798907f0418ddb1445e13c3c44 (patch) | |
| tree | 6bc5eaa1db913fdf6b6541a177607a7aa79f4dfc /src/charon/threads/scheduler.h | |
| parent | 95806de938a287ca71b28fa07016c9785130c1da (diff) | |
| download | strongswan-b8577029d1d37b798907f0418ddb1445e13c3c44.tar.bz2 strongswan-b8577029d1d37b798907f0418ddb1445e13c3c44.tar.xz | |
Diffstat (limited to 'src/charon/threads/scheduler.h')
| -rw-r--r-- | src/charon/threads/scheduler.h | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/src/charon/threads/scheduler.h b/src/charon/threads/scheduler.h new file mode 100644 index 000000000..04d639d1b --- /dev/null +++ b/src/charon/threads/scheduler.h @@ -0,0 +1,67 @@ +/** + * @file scheduler.h + * + * @brief Interface of scheduler_t. + * + */ + +/* + * 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> + +typedef struct scheduler_t scheduler_t; + +/** + * @brief The scheduler thread is responsible for timed events. + * + * The scheduler thread takes out jobs from the event-queue and adds them + * to the job-queue. + * + * Starts a thread which does the work, since event-queue is blocking. + * + * @b Constructors: + * - scheduler_create() + * + * @ingroup threads + */ +struct scheduler_t { + + /** + * @brief Destroys a scheduler object. + * + * @param scheduler calling object + */ + void (*destroy) (scheduler_t *scheduler); +}; + +/** + * @brief Create a scheduler with its associated thread. + * + * The thread will start to get jobs form the event queue + * and adds them to the job queue. + * + * @return + * - scheduler_t object + * - NULL if thread could not be started + * + * @ingroup threads + */ +scheduler_t * scheduler_create(void); + +#endif /*SCHEDULER_H_*/ |