summaryrefslogtreecommitdiff
path: root/src/charon/processing/jobs/job.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/jobs/job.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/jobs/job.h')
-rw-r--r--src/charon/processing/jobs/job.h33
1 files changed, 11 insertions, 22 deletions
diff --git a/src/charon/processing/jobs/job.h b/src/charon/processing/jobs/job.h
index 1826c53b4..61f639936 100644
--- a/src/charon/processing/jobs/job.h
+++ b/src/charon/processing/jobs/job.h
@@ -1,10 +1,3 @@
-/**
- * @file job.h
- *
- * @brief Interface job_t.
- *
- */
-
/*
* Copyright (C) 2005-2006 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: job.h 3589 2008-03-13 14:14:44Z martin $
+ */
+
+/**
+ * @defgroup job job
+ * @{ @ingroup jobs
*/
#ifndef JOB_H_
@@ -28,38 +28,27 @@ typedef struct job_t job_t;
#include <library.h>
-
/**
- * @brief Job-Interface as it is stored in the job queue.
- *
- * @b Constructors:
- * - None, use specific implementation of the interface.
- *
- * @ingroup jobs
+ * Job-Interface as it is stored in the job queue.
*/
struct job_t {
/**
- * @brief Execute a job.
+ * Execute a job.
*
* The processing facility executes a job using this method. Jobs are
* one-shot, they destroy themself after execution, so don't use a job
* once it has been executed.
- *
- * @param this calling object
*/
void (*execute) (job_t *this);
/**
- * @brief Destroy a job.
+ * Destroy a job.
*
* Is only called whenever a job was not executed (e.g. due daemon shutdown).
* After execution, jobs destroy themself.
- *
- * @param job_t calling object
*/
void (*destroy) (job_t *job);
};
-#endif /* JOB_H_ */
-
+#endif /* JOB_H_ @} */