Removed strayed code fragment
[strongswan.git] / src / charon / 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 * Length of a delete payload without the SPI in bytes.
33 */
34 #define DELETE_PAYLOAD_HEADER_LENGTH 8
35
36 /**
37 * Class representing an IKEv2 DELETE payload.
38 *
39 * The DELETE payload format is described in RFC section 3.11.
40 */
41 struct delete_payload_t {
42 /**
43 * The payload_t interface.
44 */
45 payload_t payload_interface;
46
47 /**
48 * Get the protocol ID.
49 *
50 * @return protocol ID
51 */
52 protocol_id_t (*get_protocol_id) (delete_payload_t *this);
53
54 /**
55 * Add an SPI to the list of deleted SAs.
56 *
57 * @param spi spi to add
58 */
59 void (*add_spi) (delete_payload_t *this, u_int32_t spi);
60
61 /**
62 * Get an iterator over the SPIs.
63 *
64 * The iterate() function returns a pointer to a u_int32_t SPI.
65 *
66 * @return iterator over SPIs
67 */
68 iterator_t *(*create_spi_iterator) (delete_payload_t *this);
69
70 /**
71 * Destroys an delete_payload_t object.
72 */
73 void (*destroy) (delete_payload_t *this);
74 };
75
76 /**
77 * Creates an empty delete_payload_t object.
78 *
79 * @param protocol_id protocol, such as AH|ESP
80 * @return delete_payload_t object
81 */
82 delete_payload_t *delete_payload_create(protocol_id_t protocol_id);
83
84 #endif /** DELETE_PAYLOAD_H_ @}*/