updated Doxyfile
[strongswan.git] / src / charon / processing / jobs / initiate_mediation_job.h
1 /*
2 * Copyright (C) 2007-2008 Tobias Brunner
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 initiate_mediation_job initiate_mediation_job
20 * @{ @ingroup jobs
21 */
22
23 #ifndef INITIATE_MEDIATION_JOB_H_
24 #define INITIATE_MEDIATION_JOB_H_
25
26 typedef struct initiate_mediation_job_t initiate_mediation_job_t;
27
28 #include <processing/jobs/job.h>
29 #include <sa/ike_sa_id.h>
30
31 /**
32 * Class representing a INITIATE_MEDIATION Job.
33 *
34 * This job will initiate a mediation on behalf of a mediated connection.
35 * If required the mediation connection is established.
36 */
37 struct initiate_mediation_job_t {
38 /**
39 * implements job_t interface
40 */
41 job_t job_interface;
42 };
43
44 /**
45 * Creates a job of type INITIATE_MEDIATION.
46 *
47 * @param ike_sa_id identification of the ike_sa as ike_sa_id_t object (gets cloned)
48 * @return job object
49 */
50 initiate_mediation_job_t *initiate_mediation_job_create(ike_sa_id_t *ike_sa_id);
51
52 /**
53 * Creates a special job of type INITIATE_MEDIATION that reinitiates a
54 * specific connection.
55 *
56 * @param mediation_sa_id identification of the mediation sa (gets cloned)
57 * @param mediated_sa_id identification of the mediated sa (gets cloned)
58 * @return job object
59 */
60 initiate_mediation_job_t *reinitiate_mediation_job_create(ike_sa_id_t *mediation_sa_id,
61 ike_sa_id_t *mediated_sa_id);
62
63 #endif /** INITIATE_MEDIATION_JOB_H_ @}*/