summaryrefslogtreecommitdiff
path: root/src/charon/processing/scheduler.h
diff options
context:
space:
mode:
authorRene Mayrhofer <rene@mayrhofer.eu.org>2008-07-09 21:02:41 +0000
committerRene Mayrhofer <rene@mayrhofer.eu.org>2008-07-09 21:02:41 +0000
commitdb67c87db3c9089ea8d2e14f617bf3d9e2af261f (patch)
tree665c0caea83d34c11c1517c4c57137bb58cba6fb /src/charon/processing/scheduler.h
parent1c088a8b6237ec67f63c23f97a0f2dc4e99af869 (diff)
downloadvyos-strongswan-db67c87db3c9089ea8d2e14f617bf3d9e2af261f.tar.gz
vyos-strongswan-db67c87db3c9089ea8d2e14f617bf3d9e2af261f.zip
[svn-upgrade] Integrating new upstream version, strongswan (4.2.4)
Diffstat (limited to 'src/charon/processing/scheduler.h')
-rw-r--r--src/charon/processing/scheduler.h38
1 files changed, 13 insertions, 25 deletions
diff --git a/src/charon/processing/scheduler.h b/src/charon/processing/scheduler.h
index 7bde6e638..edc17a02b 100644
--- a/src/charon/processing/scheduler.h
+++ b/src/charon/processing/scheduler.h
@@ -1,10 +1,3 @@
-/**
- * @file scheduler.h
- *
- * @brief Interface of scheduler_t.
- *
- */
-
/*
* Copyright (C) 2005-2007 Martin Willi
* Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,13 @@
* 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.
+ *
+ * $Id: scheduler.h 3589 2008-03-13 14:14:44Z martin $
+ */
+
+/**
+ * @defgroup scheduler scheduler
+ * @{ @ingroup processing
*/
#ifndef SCHEDULER_H_
@@ -30,52 +30,40 @@ typedef struct scheduler_t scheduler_t;
#include <processing/jobs/job.h>
/**
- * @brief The scheduler queues and executes timed events.
+ * The scheduler queues and executes timed events.
*
* The scheduler stores timed events and passes them to the processor.
- *
- * @b Constructors:
- * - scheduler_create()
- *
- * @ingroup processing
*/
struct scheduler_t {
/**
- * @brief Adds a event to the queue, using a relative time offset.
+ * Adds a event to the queue, using a relative time offset.
*
* Schedules a job for execution using a relative time offset.
*
- * @param this calling object
* @param job job to schedule
* @param time relative to to schedule job (in ms)
*/
void (*schedule_job) (scheduler_t *this, job_t *job, u_int32_t time);
/**
- * @brief Returns number of jobs scheduled.
+ * Returns number of jobs scheduled.
*
- * @param this calling object
* @return number of scheduled jobs
*/
u_int (*get_job_load) (scheduler_t *this);
/**
- * @brief Destroys a scheduler object.
- *
- * @param this calling object
+ * Destroys a scheduler object.
*/
void (*destroy) (scheduler_t *this);
};
/**
- * @brief Create a scheduler.
+ * Create a scheduler.
*
* @return scheduler_t object
- *
- * @ingroup processing
*/
scheduler_t *scheduler_create(void);
-#endif /*SCHEDULER_H_*/
-
+#endif /*SCHEDULER_H_ @} */