ebafe04fbf895675cfb2f35c19a6c5d29fa815fa
[strongswan.git] / src / libcharon / encoding / payloads / delete_payload.h
1 /*
2 * Copyright (C) 2005-2006 Martin Willi
3 * Copyright (C) 2005 Jan Hutter
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 */
16
17 /**
18 * @defgroup delete_payload delete_payload
19 * @{ @ingroup payloads
20 */
21
22 #ifndef DELETE_PAYLOAD_H_
23 #define DELETE_PAYLOAD_H_
24
25 typedef struct delete_payload_t delete_payload_t;
26
27 #include <library.h>
28 #include <encoding/payloads/payload.h>
29 #include <encoding/payloads/proposal_substructure.h>
30
31 /**
32 * Class representing an IKEv2 DELETE payload.
33 *
34 * The DELETE payload format is described in RFC section 3.11.
35 */
36 struct delete_payload_t {
37
38 /**
39 * The payload_t interface.
40 */
41 payload_t payload_interface;
42
43 /**
44 * Get the protocol ID.
45 *
46 * @return protocol ID
47 */
48 protocol_id_t (*get_protocol_id) (delete_payload_t *this);
49
50 /**
51 * Add an SPI to the list of deleted SAs.
52 *
53 * @param spi spi to add
54 */
55 void (*add_spi) (delete_payload_t *this, u_int32_t spi);
56
57 /**
58 * Get an enumerator over the SPIs in network order.
59 *
60 * @return enumerator over SPIs, u_int32_t
61 */
62 enumerator_t *(*create_spi_enumerator) (delete_payload_t *this);
63
64 /**
65 * Destroys an delete_payload_t object.
66 */
67 void (*destroy) (delete_payload_t *this);
68 };
69
70 /**
71 * Creates an empty delete_payload_t object.
72 *
73 * @param protocol_id protocol, such as AH|ESP
74 * @return delete_payload_t object
75 */
76 delete_payload_t *delete_payload_create(protocol_id_t protocol_id);
77
78 #endif /** DELETE_PAYLOAD_H_ @}*/