Code

plugin.c: fix potential null pointer dereference
[collectd.git] / src / utils_fbhash.h
1 /**
2  * collectd - src/utils_fbhash.h
3  * Copyright (C) 2009       Florian octo Forster
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  *   Florian octo Forster <octo at collectd.org>
25  **/
27 #ifndef UTILS_FBHASH_H
28 #define UTILS_FBHASH_H 1
30 /*
31  * File-backed hash
32  *
33  * This module reads a file of the form
34  *   key: value
35  * into a hash, which can then be queried. The file is given to `fbh_create',
36  * the hash is queried using `fbh_get'. If the file is changed during runtime,
37  * it will automatically be re-read.
38  */
40 struct fbhash_s;
41 typedef struct fbhash_s fbhash_t;
43 fbhash_t *fbh_create (const char *file);
44 void fbh_destroy (fbhash_t *h);
46 /* Returns the value as a newly allocated `char *'. It's the caller's
47  * responsibility to free this memory. */
48 char *fbh_get (fbhash_t *h, const char *key);
50 #endif /* UTILS_FBHASH_H */
52 /* vim: set sw=2 sts=2 et fdm=marker : */