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 typedef enum os_fwd_status_t os_fwd_status_t;
  26
  27 #include <library.h>
  28
  29 /**
  30  * Defines the IPv4 forwarding status
  31  */
  32 enum os_fwd_status_t {
  33         OS_FWD_DISABLED =       0,
  34         OS_FWD_ENABLED =        1,
  35         OS_FWD_UNKNOWN =        2
  36 };
  37
  38 extern enum_name_t *os_fwd_status_names;
  39
  40 /**
  41  * Interface for the Operating System (OS) information module
  42  */
  43 struct os_info_t {
  44
  45         /**
  46          * Get the OS product name or distribution
  47          *
  48          * @return                                      OS name
  49          */
  50         chunk_t (*get_name)(os_info_t *this);
  51
  52         /**
  53          * Get the OS version or release
  54          *
  55          * @return                                      OS version
  56          */
  57         chunk_t (*get_version)(os_info_t *this);
  58
  59         /**
  60          * Get the OS IPv4 forwarding status
  61          *
  62          * @return                                      IP forwarding status
  63          */
  64         os_fwd_status_t (*get_fwd_status)(os_info_t *this);
  65
  66         /**
  67          * Enumerates over all installed packages
  68          *
  69          * @return                              return package enumerator
  70          */
  71         enumerator_t* (*create_package_enumerator)(os_info_t *this);
  72
  73         /**
  74          * Destroys an os_info_t object.
  75          */
  76         void (*destroy)(os_info_t *this);
  77 };
  78
  79 /**
  80  * Create an os_info_t object
  81  */
  82 os_info_t* os_info_create(void);
  83
  84 #endif /** OS_INFO_H_ @}*/