follow strongswan coding rules
[strongswan.git] / src / libpts / pts / pts_database.h
1 /*
2 * Copyright (C) 2011 Andreas Steffen
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 pts_database pts_database
18 * @{ @ingroup pts
19 */
20
21 #ifndef PTS_DATABASE_H_
22 #define PTS_DATABASE_H_
23
24 typedef struct pts_database_t pts_database_t;
25
26 #include "pts_meas_algo.h"
27 #include <library.h>
28
29 /**
30 * Class implementing the PTS File Measurement database
31 *
32 */
33 struct pts_database_t {
34
35 /**
36 * Get files/directories to be measured by PTS
37 *
38 * @param product software product (os, vpn client, etc.)
39 * @return enumerator over all matching files/directories
40 */
41 enumerator_t* (*create_file_enumerator)(pts_database_t *this,
42 char *product);
43
44 /**
45 * Get files/directories to request metadata of
46 *
47 * @param product software product (os, vpn client, etc.)
48 * @return enumerator over all matching files/directories
49 */
50 enumerator_t* (*create_file_meta_enumerator)(pts_database_t *this,
51 char *product);
52
53 /**
54 * Get stored measurement hash for single file or directory entries
55 *
56 * @param product software product (os, vpn client, etc.)
57 * @param algo hash algorithm used for measurement
58 * @param id primary key of measured file/directory
59 * @param is_dir TRUE if directory was measured
60 * @return enumerator over all matching measurement hashes
61 */
62 enumerator_t* (*create_hash_enumerator)(pts_database_t *this, char *product,
63 pts_meas_algorithms_t algo,
64 int id, bool is_dir);
65
66 /**
67 * Destroys a pts_database_t object.
68 */
69 void (*destroy)(pts_database_t *this);
70
71 };
72
73 /**
74 * Creates an pts_database_t object
75 *
76 * @param uri database uri
77 */
78 pts_database_t* pts_database_create(char *uri);
79
80 #endif /** PTS_DATABASE_H_ @}*/