9503ff0e604f63c616a388edc5a84d813770bc54
[strongswan.git] / src / charon / sa / tasks / child_delete.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 * $Id$
16 */
17
18 /**
19 * @defgroup child_delete child_delete
20 * @{ @ingroup tasks
21 */
22
23 #ifndef CHILD_DELETE_H_
24 #define CHILD_DELETE_H_
25
26 typedef struct child_delete_t child_delete_t;
27
28 #include <library.h>
29 #include <sa/ike_sa.h>
30 #include <sa/tasks/task.h>
31 #include <sa/child_sa.h>
32
33 /**
34 * Task of type child_delete, delete a CHILD_SA.
35 */
36 struct child_delete_t {
37
38 /**
39 * Implements the task_t interface
40 */
41 task_t task;
42
43 /**
44 * Get the CHILD_SA to delete by this task.
45 *
46 * @return child_sa
47 */
48 child_sa_t* (*get_child) (child_delete_t *this);
49 };
50
51 /**
52 * Create a new child_delete task.
53 *
54 * @param ike_sa IKE_SA this task works for
55 * @param protocol protocol of CHILD_SA to delete, PROTO_NONE as responder
56 * @param spi inbound SPI of CHILD_SA to delete
57 * @return child_delete task to handle by the task_manager
58 */
59 child_delete_t *child_delete_create(ike_sa_t *ike_sa, protocol_id_t protocol,
60 u_int32_t spi);
61
62 #endif /* CHILD_DELETE_H_ @} */