Annotation of embedaddon/strongswan/src/libstrongswan/collections/dictionary.h, revision 1.1.1.1
1.1 misho 1: /*
2: * Copyright (C) 2014 Tobias Brunner
3: * HSR Hochschule fuer Technik Rapperswil
4: *
5: * This program is free software; you can redistribute it and/or modify it
6: * under the terms of the GNU General Public License as published by the
7: * Free Software Foundation; either version 2 of the License, or (at your
8: * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9: *
10: * This program is distributed in the hope that it will be useful, but
11: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13: * for more details.
14: */
15:
16: /**
17: * @defgroup dictionary dictionary
18: * @{ @ingroup collections
19: */
20:
21: #ifndef DICTIONARY_H_
22: #define DICTIONARY_H_
23:
24: #include <collections/enumerator.h>
25:
26: typedef struct dictionary_t dictionary_t;
27:
28: /**
29: * Interface for read-only dictionaries.
30: */
31: struct dictionary_t {
32:
33: /**
34: * Create an enumerator over the key/value pairs in the dictionary.
35: *
36: * @return enumerator over (const void *key, void *value)
37: */
38: enumerator_t *(*create_enumerator)(dictionary_t *this);
39:
40: /**
41: * Returns the value with the given key, if the dictionary contains such an
42: * entry, otherwise NULL is returned.
43: *
44: * @param key the key of the requested value
45: * @return the value, NULL if not found
46: */
47: void *(*get)(dictionary_t *this, const void *key);
48:
49: /**
50: * Destroys a dictionary object.
51: */
52: void (*destroy)(dictionary_t *this);
53: };
54:
55: #endif /** DICTIONARY_H_ @}*/
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>