diff options
Diffstat (limited to 'Source/charon/encoding/parser.h')
-rw-r--r-- | Source/charon/encoding/parser.h | 95 |
1 files changed, 0 insertions, 95 deletions
diff --git a/Source/charon/encoding/parser.h b/Source/charon/encoding/parser.h deleted file mode 100644 index 216fac9b7..000000000 --- a/Source/charon/encoding/parser.h +++ /dev/null @@ -1,95 +0,0 @@ -/** - * @file parser.h - * - * @brief Interface of parser_t. - * - */ - -/* - * Copyright (C) 2005 Jan Hutter, Martin Willi - * Hochschule fuer Technik Rapperswil - * - * This program is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License as published by the - * Free Software Foundation; either version 2 of the License, or (at your - * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY - * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - * for more details. - */ - -#ifndef PARSER_H_ -#define PARSER_H_ - -#include <types.h> -#include <encoding/payloads/encodings.h> -#include <encoding/payloads/payload.h> - - -typedef struct parser_t parser_t; - -/** - * @brief A parser_t class to parse IKEv2 payloads. - * - * A parser is used for parsing one chunk of data. Multiple - * payloads can be parsed out of the chunk using parse_payload. - * The parser remains the state until destroyed. - * - * @b Constructors: - * - parser_create() - * - * @ingroup encoding - */ -struct parser_t { - - /** - * @brief Parses the next payload. - * - * @warning Caller is responsible for freeing allocated payload. - * - * Rules for parsing are described in the payload definition. - * - * @param this parser_t bject - * @param payload_type payload type to parse - * @param[out] payload pointer where parsed payload was allocated - * @return - * - SUCCESSFUL if succeeded, - * - PARSE_ERROR if corrupted/invalid data found - */ - status_t (*parse_payload) (parser_t *this, payload_type_t payload_type, payload_t **payload); - - /** - * Gets the remaining byte count which is not currently parsed. - * - * @param parser parser_t object - */ - int (*get_remaining_byte_count) (parser_t *this); - - /** - * @brief Resets the current parser context. - * - * @param parser parser_t object - */ - void (*reset_context) (parser_t *this); - - /** - * @brief Destroys a parser_t object. - * - * @param parser parser_t object - */ - void (*destroy) (parser_t *this); -}; - -/** - * @brief Constructor to create a parser_t object. - * - * @param data chunk of data to parse with this parser_t object - * @return parser_t object - * - * @ingroup encoding - */ -parser_t *parser_create(chunk_t data); - -#endif /*PARSER_H_*/ |