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