- docs updated
[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 * @brief Class representing an INITIATE_IKE_SA Job.
32 *
33 * This job is created if an IKE_SA should be iniated. This
34 * happens form a user request, or via the kernel interface.
35 *
36 * @b Constructors:
37 * - initiate_ike_sa_job_create()
38 *
39 * @ingroup jobs
40 */
41 struct initiate_ike_sa_job_t {
42 /**
43 * implements job_t interface
44 */
45 job_t job_interface;
46
47 /**
48 * @brief Returns the currently set configuration name for this job.
49 *
50 * @warning Returned name is not copied.
51 *
52 * @param this calling initiate_ike_sa_job_t object
53 * @return name of the configuration
54 */
55 char *(*get_configuration_name) (initiate_ike_sa_job_t *this);
56
57 /**
58 * @brief Destroys an initiate_ike_sa_job_t object.
59 *
60 * @param this initiate_ike_sa_job_t object to destroy
61 */
62 void (*destroy) (initiate_ike_sa_job_t *this);
63 };
64
65 /**
66 * @brief Creates a job of type INITIATE_IKE_SA.
67 *
68 * @param configuration_name name of the configuration to initiate IKE_SA with
69 * @return initiate_ike_sa_job_t object
70 *
71 * @ingroup jobs
72 */
73 initiate_ike_sa_job_t *initiate_ike_sa_job_create(char *configuration_name);
74
75 #endif /*INITIATE_IKE_SA_JOB_H_*/