c2e1d8db1fe56e1c4bb15f6ae237b9ba0d5428c2
[strongswan.git] / Source / charon / queues / jobs / delete_established_ike_sa_job.h
1 /**
2 * @file delete_established_ike_sa_job.h
3 *
4 * @brief Interface of delete_established_ike_sa_job_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef DELETE_ESTABLISHED_IKE_SA_JOB_H_
24 #define DELETE_ESTABLISHED_IKE_SA_JOB_H_
25
26 #include <types.h>
27 #include <sa/ike_sa_id.h>
28 #include <queues/jobs/job.h>
29
30
31 typedef struct delete_established_ike_sa_job_t delete_established_ike_sa_job_t;
32
33 /**
34 * @brief Class representing an DELETE_ESTABLISHED_IKE_SA Job.
35 *
36 * @b Constructors:
37 * - delete_established_ike_sa_job_create()
38 *
39 * @ingroup jobs
40 */
41 struct delete_established_ike_sa_job_t {
42 /**
43 * The job_t interface.
44 */
45 job_t job_interface;
46
47 /**
48 * @brief Returns the currently set ike_sa_id.
49 *
50 * @warning Returned object is not copied.
51 *
52 * @param this calling delete_established_ike_sa_job_t object
53 * @return ike_sa_id_t object
54 */
55 ike_sa_id_t * (*get_ike_sa_id) (delete_established_ike_sa_job_t *this);
56
57 /**
58 * @brief Destroys an delete_established_ike_sa_job_t object (including assigned data).
59 *
60 * @param this delete_established_ike_sa_job_t object to destroy
61 */
62 void (*destroy) (delete_established_ike_sa_job_t *this);
63 };
64
65 /**
66 * @brief Creates a job of type DELETE_ESTABLISHED_IKE_SA.
67 *
68 * @param ike_sa_id id of the IKE_SA to delete
69 * @return created delete_established_ike_sa_job_t object
70 *
71 * @ingroup jobs
72 */
73 delete_established_ike_sa_job_t *delete_established_ike_sa_job_create(ike_sa_id_t *ike_sa_id);
74
75 #endif /*DELETE_ESTABLISHED_IKE_SA_JOB_H_*/