include/stc-manager.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __STC_MANAGER_H__
  18 #define __STC_MANAGER_H__
  19
  20 #include "stc-error.h"
  21 #include "stc-manager-util.h"
  22
  23 #define NET_RELEASE_AGENT "/usr/bin/net-cls-release"
  24 #define NET_CLS_SUBSYS "net_cls"
  25
  26 #define STC_BACKGROUND_APP_SUFFIX "_BACKGROUND"
  27
  28 typedef enum {
  29         STC_CANCEL = 0,    /**< cancel */
  30         STC_CONTINUE = 1,  /**< continue */
  31 } stc_cb_ret_e;
  32
  33 /**
  34  * @brief Monitored application types
  35  */
  36 typedef enum {
  37         STC_APP_TYPE_NONE,
  38         STC_APP_TYPE_READY,
  39         STC_APP_TYPE_GUI,
  40         STC_APP_TYPE_SERVICE,
  41         STC_APP_TYPE_GROUP,
  42         STC_APP_TYPE_WATCH,
  43         STC_APP_TYPE_WIDGET,
  44         STC_APP_TYPE_MAX,
  45 } stc_app_type_e;
  46
  47 /**
  48  * @brief State of the statisticsed process
  49  */
  50 typedef enum {
  51         STC_APP_STATE_UNKNOWN = 0,
  52         STC_APP_STATE_FOREGROUND = 1 << 1,  /** < foreground state */
  53         STC_APP_STATE_BACKGROUND = 1 << 2,  /** < background state */
  54         STC_APP_STATE_LAST_ELEM = 1 << 3
  55 } stc_app_state_e;
  56
  57 /**
  58  * @brief Network restriction states
  59  */
  60 typedef enum {
  61         STC_RESTRICTION_UNKNOWN,
  62         STC_RESTRICTION_ACTIVATED,  /** < restriction has been activated */
  63         STC_RESTRICTION_REMOVED,    /** < restriction has been removed */
  64         STC_RESTRICTION_EXCLUDED,   /** < restriction has been excluded */
  65         STC_RESTRICTION_LAST_ELEM
  66 } stc_restriction_state_e;
  67
  68 /**
  69  * @brief Network interface types
  70  */
  71 typedef enum {
  72         STC_IFACE_UNKNOWN,    /**< undefined iface */
  73         STC_IFACE_DATACALL,   /**< mobile data */
  74         STC_IFACE_WIFI,       /**< wifi data */
  75         STC_IFACE_WIRED,      /**< wired interface */
  76         STC_IFACE_BLUETOOTH,  /**< bluetooth interface */
  77         STC_IFACE_ALL,        /**< enumerate all network interface types */
  78         STC_IFACE_LAST_ELEM
  79 } stc_iface_type_e;
  80
  81 /**
  82  * @brief Network roaming type
  83  */
  84 typedef enum {
  85         STC_ROAMING_UNKNOWN,   /**< can't define roaming - roaming unknown */
  86         STC_ROAMING_ENABLE,    /**< in roaming */
  87         STC_ROAMING_DISABLE,   /**< not in roaming */
  88         STC_ROAMING_LAST_ELEM,
  89 } stc_roaming_type_e;
  90
  91 /**
  92  * @brief Hardware network protocol types
  93  */
  94 typedef enum {
  95         STC_PROTOCOL_NONE,                /**< Network unknown */
  96         STC_PROTOCOL_DATACALL_NOSVC,      /**< Network no service */
  97         STC_PROTOCOL_DATACALL_EMERGENCY,  /**< Network emergency */
  98         STC_PROTOCOL_DATACALL_SEARCH,     /**< Network search 1900 */
  99         STC_PROTOCOL_DATACALL_2G,         /**< Network 2G */
 100         STC_PROTOCOL_DATACALL_2_5G,       /**< Network 2.5G */
 101         STC_PROTOCOL_DATACALL_2_5G_EDGE,  /**< Network EDGE */
 102         STC_PROTOCOL_DATACALL_3G,         /**< Network UMTS */
 103         STC_PROTOCOL_DATACALL_HSDPA,      /**< Network HSDPA */
 104         STC_PROTOCOL_DATACALL_LTE,        /**< Network LTE */
 105         STC_PROTOCOL_MAX_ELEM
 106 } stc_hw_net_protocol_type_e;
 107
 108 /**
 109  * @desc Description of the boolean option for enabling/disabling
 110  *     network interfaces and enabling/disabling some behaviar
 111  */
 112 typedef enum {
 113         STC_DB_OPTION_UNDEF,
 114         STC_DB_OPTION_ENABLE,
 115         STC_DB_OPTION_DISABLE
 116 } stc_option_state_e;
 117
 118 /**
 119  * @desc Set of the options.
 120  * version - contains structure version
 121  * wifi - enable/disable wifi, STC_DB_OPTION_UNDEF to leave option as is
 122  * datacall - enable/disable datacall, STC_DB_OPTION_UNDEF to leave option as is
 123  * datausage_timer - set period of the updating data from the kernel,
 124  *     0 to leave option as is
 125  * datacall_logging - enable/disable datacall_logging,
 126  *     STC_DB_OPTION_UNDEF to leave option as is
 127  */
 128 typedef struct {
 129         unsigned char version;
 130         stc_option_state_e wifi;
 131         stc_option_state_e datacall;
 132         time_t datausage_timer;
 133         stc_option_state_e datacall_logging;
 134 } stc_options_s;
 135
 136 /**
 137  * @brief datausage in bytes
 138  */
 139 typedef struct {
 140         int64_t in_bytes;  /**< incoming bytes */
 141         int64_t out_bytes;  /**< outgoing bytes */
 142 } stc_data_counter_s;
 143
 144 typedef struct {
 145         GMainLoop *main_loop;
 146
 147         gpointer statistics_obj;
 148         gpointer restriction_obj;
 149
 150         GDBusObjectManagerServer *obj_mgr;
 151         GDBusConnection *connection;
 152         guint gdbus_owner_id;
 153
 154         void *system; /* stc_system_s */
 155         struct counter_arg *carg;
 156 } stc_s;
 157
 158 stc_s *stc_get_manager(void);
 159
 160 #endif /* __STC_MANAGER__ */