src/libimcv/plugins/imv_os/imv_os_state.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  *
  18  * @defgroup imv_os_state_t imv_os_state
  19  * @{ @ingroup imv_os_state
  20  */
  21
  22 #ifndef IMV_OS_STATE_H_
  23 #define IMV_OS_STATE_H_
  24
  25 #include "os_info/os_info.h"
  26 #include <imv/imv_state.h>
  27 #include <library.h>
  28
  29 typedef struct imv_os_state_t imv_os_state_t;
  30
  31 /**
  32  * Internal state of an imv_os_t connection instance
  33  */
  34 struct imv_os_state_t {
  35
  36         /**
  37          * imv_state_t interface
  38          */
  39         imv_state_t interface;
  40
  41         /**
  42          * Set OS Product Information
  43          *
  44          * @param type          OS type (enumerated)
  45          * @param name          OS name (string)
  46          * @param version       OS version
  47          */
  48         void (*set_info)(imv_os_state_t *this, os_type_t os_type,
  49                                          chunk_t name, chunk_t version);
  50
  51         /**
  52          * Get OS Product Information
  53          *
  54          * @param type          OS type (enumerated)
  55          * @param name          OS name (string)
  56          * @param version       OS version
  57          * @result                      OS name & version as a concatenated string
  58          */
  59         char* (*get_info)(imv_os_state_t *this, os_type_t *os_type,
  60                                           chunk_t *name, chunk_t *version);
  61
  62         /**
  63          * Set/reset OS Installed Packages request status
  64          *
  65          * @param set           TRUE to set, FALSE to clear
  66          */
  67         void (*set_package_request)(imv_os_state_t *this, bool set);
  68
  69         /**
  70          * Get OS Installed Packages request status
  71          *
  72          * @result                      TRUE if set, FALSE if unset
  73          */
  74         bool (*get_package_request)(imv_os_state_t *this);
  75
  76         /**
  77          * Increase/Decrease the ITA Angel count
  78          *
  79          * @param start                 TRUE increases and FALSE decreases count by one
  80          */
  81         void (*set_angel_count)(imv_os_state_t *this, bool start);
  82
  83         /**
  84          * Get the ITA Angel count
  85          *
  86          * @result                      ITA Angel count
  87          */
  88         int (*get_angel_count)(imv_os_state_t *this);
  89
  90 };
  91
  92 /**
  93  * Create an imv_os_state_t instance
  94  *
  95  * @param id                    connection ID
  96  */
  97 imv_state_t* imv_os_state_create(TNC_ConnectionID id);
  98
  99 #endif /** IMV_OS_STATE_H_ @}*/