updated Doxyfile
[strongswan.git] / src / charon / processing / jobs / acquire_job.h
1 /*
2 * Copyright (C) 2006 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * $Id$
16 */
17
18 /**
19 * @defgroup acquire_job acquire_job
20 * @{ @ingroup jobs
21 */
22
23 #ifndef ACQUIRE_JOB_H_
24 #define ACQUIRE_JOB_H_
25
26 typedef struct acquire_job_t acquire_job_t;
27
28 #include <library.h>
29 #include <config/traffic_selector.h>
30 #include <processing/jobs/job.h>
31
32 /**
33 * Class representing an ACQUIRE Job.
34 *
35 * This job initiates a CHILD SA on kernel request.
36 */
37 struct acquire_job_t {
38 /**
39 * The job_t interface.
40 */
41 job_t job_interface;
42 };
43
44 /**
45 * Creates a job of type ACQUIRE.
46 *
47 * We use the reqid to find the routed CHILD_SA.
48 *
49 * @param reqid reqid of the CHILD_SA to acquire
50 * @param src_ts source traffic selector
51 * @param dst_ts destination traffic selector
52 * @return acquire_job_t object
53 */
54 acquire_job_t *acquire_job_create(u_int32_t reqid,
55 traffic_selector_t *src_ts,
56 traffic_selector_t *dst_ts);
57
58 #endif /** REKEY_CHILD_SA_JOB_H_ @}*/