Moving charon to libcharon.
[strongswan.git] / src / libcharon / processing / jobs / rekey_child_sa_job.h
1 /*
2 * Copyright (C) 2006 Martin Willi
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
16 /**
17 * @defgroup rekey_child_sa_job rekey_child_sa_job
18 * @{ @ingroup jobs
19 */
20
21 #ifndef REKEY_CHILD_SA_JOB_H_
22 #define REKEY_CHILD_SA_JOB_H_
23
24 typedef struct rekey_child_sa_job_t rekey_child_sa_job_t;
25
26 #include <library.h>
27 #include <sa/ike_sa_id.h>
28 #include <processing/jobs/job.h>
29 #include <config/proposal.h>
30
31 /**
32 * Class representing an REKEY_CHILD_SA Job.
33 *
34 * This job initiates the rekeying of a CHILD SA.
35 */
36 struct rekey_child_sa_job_t {
37 /**
38 * The job_t interface.
39 */
40 job_t job_interface;
41 };
42
43 /**
44 * Creates a job of type REKEY_CHILD_SA.
45 *
46 * The CHILD_SA is identified by its protocol (AH/ESP) and its
47 * inbound SPI.
48 *
49 * @param reqid reqid of the CHILD_SA to rekey
50 * @param protocol protocol of the CHILD_SA
51 * @param spi security parameter index of the CHILD_SA
52 * @return rekey_child_sa_job_t object
53 */
54 rekey_child_sa_job_t *rekey_child_sa_job_create(u_int32_t reqid,
55 protocol_id_t protocol,
56 u_int32_t spi);
57 #endif /** REKEY_CHILD_SA_JOB_H_ @}*/