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