Removed strayed code fragment
[strongswan.git] / src / charon / encoding / parser.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 parser parser
19 * @{ @ingroup encoding
20 */
21
22 #ifndef PARSER_H_
23 #define PARSER_H_
24
25 typedef struct parser_t parser_t;
26
27 #include <library.h>
28 #include <encoding/payloads/encodings.h>
29 #include <encoding/payloads/payload.h>
30
31 /**
32 * A parser_t class to parse IKEv2 payloads.
33 *
34 * A parser is used for parsing one chunk of data. Multiple
35 * payloads can be parsed out of the chunk using parse_payload.
36 * The parser remains the state until destroyed.
37 */
38 struct parser_t {
39
40 /**
41 * Parses the next payload.
42 *
43 * @warning Caller is responsible for freeing allocated payload.
44 *
45 * Rules for parsing are described in the payload definition.
46 *
47 * @param payload_type payload type to parse
48 * @param payload pointer where parsed payload was allocated
49 * @return
50 * - SUCCESSFUL if succeeded,
51 * - PARSE_ERROR if corrupted/invalid data found
52 */
53 status_t (*parse_payload) (parser_t *this, payload_type_t payload_type, payload_t **payload);
54
55 /**
56 * Gets the remaining byte count which is not currently parsed.
57 */
58 int (*get_remaining_byte_count) (parser_t *this);
59
60 /**
61 * Resets the current parser context.
62 */
63 void (*reset_context) (parser_t *this);
64
65 /**
66 * Destroys a parser_t object.
67 */
68 void (*destroy) (parser_t *this);
69 };
70
71 /**
72 * Constructor to create a parser_t object.
73 *
74 * @param data chunk of data to parse with this parser_t object
75 * @return parser_t object
76 */
77 parser_t *parser_create(chunk_t data);
78
79 #endif /** PARSER_H_ @}*/