implemented os_info_t class
[strongswan.git] / src / libimcv / os_info / os_info.h
1 /*
2 * Copyright (C) 2012 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 os_info os_info
18 * @{ @ingroup libimcv
19 */
20
21 #ifndef OS_INFO_H_
22 #define OS_INFO_H_
23
24 typedef struct os_info_t os_info_t;
25
26 #include <library.h>
27
28 /**
29 * Interface for the Operating System (OS) information module
30 */
31 struct os_info_t {
32
33 /**
34 * Get the OS product name or distribution
35 *
36 * @return OS name
37 */
38 chunk_t (*get_name)(os_info_t *this);
39
40 /**
41 * Get the OS version or release
42 *
43 * @return OS version
44 */
45 chunk_t (*get_version)(os_info_t *this);
46
47 /**
48 * Enumerates over all installed packages
49 *
50 * @return return package enumerator
51 */
52 enumerator_t* (*create_package_enumerator)(os_info_t *this);
53
54 /**
55 * Destroys an os_info_t object.
56 */
57 void (*destroy)(os_info_t *this);
58 };
59
60 /**
61 * Create an os_info_t object
62 */
63 os_info_t* os_info_create(void);
64
65 #endif /** OS_INFO_H_ @}*/