collections: Add interface for read-only dictionaries
authorTobias Brunner <tobias@strongswan.org>
Fri, 16 May 2014 09:53:08 +0000 (11:53 +0200)
committerTobias Brunner <tobias@strongswan.org>
Thu, 19 Jun 2014 12:00:48 +0000 (14:00 +0200)
src/libstrongswan/Makefile.am
src/libstrongswan/collections/dictionary.h [new file with mode: 0644]

index d3bd84e..3fb57de 100644 (file)
@@ -59,7 +59,7 @@ nobase_strongswan_include_HEADERS = \
 library.h \
 asn1/asn1.h asn1/asn1_parser.h asn1/oid.h bio/bio_reader.h bio/bio_writer.h \
 collections/blocking_queue.h collections/enumerator.h collections/hashtable.h \
-collections/linked_list.h collections/array.h \
+collections/linked_list.h collections/array.h collections/dictionary.h \
 crypto/crypters/crypter.h crypto/hashers/hasher.h crypto/mac.h \
 crypto/proposal/proposal_keywords.h crypto/proposal/proposal_keywords_static.h \
 crypto/prfs/prf.h crypto/prfs/mac_prf.h crypto/rngs/rng.h crypto/nonce_gen.h \
diff --git a/src/libstrongswan/collections/dictionary.h b/src/libstrongswan/collections/dictionary.h
new file mode 100644 (file)
index 0000000..679e41d
--- /dev/null
@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2014 Tobias Brunner
+ * 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.
+ */
+
+/**
+ * @defgroup dictionary dictionary
+ * @{ @ingroup collections
+ */
+
+#ifndef DICTIONARY_H_
+#define DICTIONARY_H_
+
+#include <collections/enumerator.h>
+
+typedef struct dictionary_t dictionary_t;
+
+/**
+ * Interface for read-only dictionaries.
+ */
+struct dictionary_t {
+
+       /**
+        * Create an enumerator over the key/value pairs in the dictionary.
+        *
+        * @return                      enumerator over (const void *key, void *value)
+        */
+       enumerator_t *(*create_enumerator)(dictionary_t *this);
+
+       /**
+        * Returns the value with the given key, if the dictionary contains such an
+        * entry, otherwise NULL is returned.
+        *
+        * @param key           the key of the requested value
+        * @return                      the value, NULL if not found
+        */
+       void *(*get)(dictionary_t *this, const void *key);
+
+       /**
+        * Destroys a dictionary object.
+        */
+       void (*destroy)(dictionary_t *this);
+};
+
+#endif /** DICTIONARY_H_ @}*/