updated Doxyfile
[strongswan.git] / src / charon / processing / jobs / delete_ike_sa_job.h
1 /*
2 * Copyright (C) 2005-2006 Martin Willi
3 * Copyright (C) 2005 Jan Hutter
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 *
16 * $Id$
17 */
18
19 /**
20 * @defgroup delete_child_sa_job delete_child_sa_job
21 * @{ @ingroup jobs
22 */
23
24 #ifndef DELETE_IKE_SA_JOB_H_
25 #define DELETE_IKE_SA_JOB_H_
26
27 typedef struct delete_ike_sa_job_t delete_ike_sa_job_t;
28
29 #include <library.h>
30 #include <sa/ike_sa_id.h>
31 #include <processing/jobs/job.h>
32
33
34 /**
35 * Class representing an DELETE_IKE_SA Job.
36 *
37 * This job is responsible for deleting established or half open IKE_SAs.
38 * A half open IKE_SA is every IKE_SA which hasn't reache the SA_ESTABLISHED
39 * state.
40 */
41 struct delete_ike_sa_job_t {
42
43 /**
44 * The job_t interface.
45 */
46 job_t job_interface;
47 };
48
49 /**
50 * Creates a job of type DELETE_IKE_SA.
51 *
52 * @param ike_sa_id id of the IKE_SA to delete
53 * @param delete_if_established should the IKE_SA be deleted if it is established?
54 * @return created delete_ike_sa_job_t object
55 */
56 delete_ike_sa_job_t *delete_ike_sa_job_create(ike_sa_id_t *ike_sa_id,
57 bool delete_if_established);
58
59 #endif /** DELETE_IKE_SA_JOB_H_ @}*/