aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/parser.h
diff options
context:
space:
mode:
authorMartin Willi <martin@strongswan.org>2005-11-09 13:37:55 +0000
committerMartin Willi <martin@strongswan.org>2005-11-09 13:37:55 +0000
commitae4abe3546ad5338878f5d3a2996e12172e6fa8e (patch)
treefad245db1a721dc21553483e61d57d8fb47bc549 /Source/charon/parser.h
parent762ce218e726f081d8779701977df6d0fc00ce35 (diff)
downloadstrongswan-ae4abe3546ad5338878f5d3a2996e12172e6fa8e.tar.bz2
strongswan-ae4abe3546ad5338878f5d3a2996e12172e6fa8e.tar.xz
- added
- nothing implemented
Diffstat (limited to 'Source/charon/parser.h')
-rw-r--r--Source/charon/parser.h65
1 files changed, 65 insertions, 0 deletions
diff --git a/Source/charon/parser.h b/Source/charon/parser.h
new file mode 100644
index 000000000..f47e8c97c
--- /dev/null
+++ b/Source/charon/parser.h
@@ -0,0 +1,65 @@
+/**
+ * @file parser.h
+ *
+ * @brief Generic parser class used to parse IKEv2-Header and Payload
+ *
+ */
+
+/*
+ * 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 "encodings.h"
+
+
+
+/**
+ * @brief A parser_t-object which parses payloads of specific type
+ */
+typedef struct parser_s parser_t;
+
+struct parser_s {
+
+ /**
+ * @brief Generates a specific payload from given data struct
+ *
+ * Remember: Header and substructures are also seen as payloads
+ *
+ * @param generator generator object
+ * @return SUCCESSFUL if succeeded,
+ * NOT_SUPPORTED if payload_type is not supported
+ * OUT_OF_RES if out of ressources
+ */
+ status_t (*parse_payload) (parser_t *this, payload_type_t payload_type, chunk_t *data, void *data_struct);
+
+ /**
+ * @brief Destroys a generator object
+ *
+ * @param generator generator object
+ * @return SUCCESSFUL if succeeded, FAILED otherwise
+ */
+ status_t (*destroy) (parser_t *this);
+};
+
+/**
+ * Constructor to create a parser
+ *
+ */
+parser_t *parser_create(payload_info_t ** payload_infos);
+
+#endif /*PARSER_H_*/