code of message_t cleaned and added more logs
[strongswan.git] / Source / charon / encoding / parser.h
1 /**
2 * @file parser.h
3 *
4 * @brief Interface of parser_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef PARSER_H_
24 #define PARSER_H_
25
26 #include <types.h>
27 #include <encoding/payloads/encodings.h>
28 #include <encoding/payloads/payload.h>
29
30
31 typedef struct parser_t parser_t;
32
33 /**
34 * A parser_t class to parse IKEv2 payloads.
35 *
36 * A parser is used for parsing one chunk of data. Multiple
37 * payloads can be parsed out of the chunk using parse_payload.
38 * The parser remains the state until destroyed.
39 *
40 * @ingroup encoding
41 */
42 struct parser_t {
43
44 /**
45 * @brief Parses the next payload.
46 *
47 * @warning Caller is responsible for freeing allocated payload.
48 *
49 * Rules for parsing are described in the payload definition.
50 *
51 * @param this parser_t bject
52 * @param payload_type payload type to parse
53 * @param[out] payload pointer where parsed payload was allocated
54 * @return
55 * - SUCCESSFUL if succeeded,
56 * - NOT_SUPPORTED if payload_type is not supported
57 * - PARSE_ERROR if corrupted/invalid data found
58 */
59 status_t (*parse_payload) (parser_t *this, payload_type_t payload_type, payload_t **payload);
60
61 /**
62 * Gets the remaining byte count which is not currently parsed.
63 *
64 * @param parser parser_t object
65 */
66 int (*get_remaining_byte_count) (parser_t *this);
67
68 /**
69 * @brief Resets the current parser context.
70 *
71 * @param parser parser_t object
72 */
73 void (*reset_context) (parser_t *this);
74
75 /**
76 * @brief Destroys a parser_t object.
77 *
78 * @param parser parser_t object
79 */
80 void (*destroy) (parser_t *this);
81 };
82
83 /**
84 * @brief Constructor to create a parser_t object.
85 *
86 * @param data chunk of data to parse with this parser_t object
87 * @return the parser_t object
88 *
89 * @ingroup encoding
90 */
91 parser_t *parser_create(chunk_t data);
92
93 #endif /*PARSER_H_*/