4 * @brief Interface of parser_t.
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
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>.
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
27 #include <encoding/payloads/encodings.h>
28 #include <encoding/payloads/payload.h>
31 typedef struct parser_t parser_t
;
34 * A parser_t class to parse IKEv2 payloads.
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.
45 * @brief Parses the next payload.
47 * @warning Caller is responsible for freeing allocated payload.
49 * Rules for parsing are described in the payload definition.
51 * @param this parser_t bject
52 * @param payload_type payload type to parse
53 * @param[out] payload pointer where parsed payload was allocated
55 * - SUCCESSFUL if succeeded,
56 * - NOT_SUPPORTED if payload_type is not supported
57 * - PARSE_ERROR if corrupted/invalid data found
59 status_t (*parse_payload
) (parser_t
*this, payload_type_t payload_type
, payload_t
**payload
);
62 * Gets the remaining byte count which is not currently parsed.
64 * @param parser parser_t object
66 int (*get_remaining_byte_count
) (parser_t
*this);
69 * @brief Resets the current parser context.
71 * @param parser parser_t object
73 void (*reset_context
) (parser_t
*this);
76 * @brief Destroys a parser_t object.
78 * @param parser parser_t object
80 void (*destroy
) (parser_t
*this);
84 * @brief Constructor to create a parser_t object.
86 * @param data chunk of data to parse with this parser_t object
87 * @return the parser_t object
91 parser_t
*parser_create(chunk_t data
);