Removed strayed code fragment
[strongswan.git] / src / charon / sa / tasks / child_rekey.h
1 /*
2 * Copyright (C) 2007 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 child_rekey child_rekey
18 * @{ @ingroup tasks
19 */
20
21 #ifndef CHILD_REKEY_H_
22 #define CHILD_REKEY_H_
23
24 typedef struct child_rekey_t child_rekey_t;
25
26 #include <library.h>
27 #include <sa/ike_sa.h>
28 #include <sa/child_sa.h>
29 #include <sa/tasks/task.h>
30
31 /**
32 * Task of type CHILD_REKEY, rekey an established CHILD_SA.
33 */
34 struct child_rekey_t {
35
36 /**
37 * Implements the task_t interface
38 */
39 task_t task;
40
41 /**
42 * Register a rekeying task which collides with this one
43 *
44 * If two peers initiate rekeying at the same time, the collision must
45 * be handled gracefully. The task manager is aware of what exchanges
46 * are going on and notifies the outgoing task by passing the incoming.
47 *
48 * @param other incoming task
49 */
50 void (*collide)(child_rekey_t* this, task_t *other);
51 };
52
53 /**
54 * Create a new CHILD_REKEY task.
55 *
56 * @param ike_sa IKE_SA this task works for
57 * @param protocol protocol of CHILD_SA to rekey, PROTO_NONE as responder
58 * @param spi inbound SPI of CHILD_SA to rekey
59 * @return child_rekey task to handle by the task_manager
60 */
61 child_rekey_t *child_rekey_create(ike_sa_t *ike_sa, protocol_id_t protocol,
62 u_int32_t spi);
63
64 #endif /** CHILD_REKEY_H_ @}*/