include/service.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2014  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef __CONNMAN_SERVICE_H
  23 #define __CONNMAN_SERVICE_H
  24
  25 #include <stdbool.h>
  26
  27 #if defined TIZEN_EXT
  28 #include <glib.h>
  29 #endif
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /**
  36  * SECTION:service
  37  * @title: Service premitives
  38  * @short_description: Functions for handling services
  39  */
  40
  41 enum connman_service_type {
  42         CONNMAN_SERVICE_TYPE_UNKNOWN   = 0,
  43         CONNMAN_SERVICE_TYPE_SYSTEM    = 1,
  44         CONNMAN_SERVICE_TYPE_ETHERNET  = 2,
  45         CONNMAN_SERVICE_TYPE_WIFI      = 3,
  46         CONNMAN_SERVICE_TYPE_BLUETOOTH = 4,
  47         CONNMAN_SERVICE_TYPE_CELLULAR  = 5,
  48         CONNMAN_SERVICE_TYPE_GPS       = 6,
  49         CONNMAN_SERVICE_TYPE_VPN       = 7,
  50         CONNMAN_SERVICE_TYPE_GADGET    = 8,
  51         CONNMAN_SERVICE_TYPE_P2P       = 9,
  52 #if defined TIZEN_EXT_WIFI_MESH
  53         CONNMAN_SERVICE_TYPE_MESH      = 10,
  54 #endif
  55 };
  56 #if defined TIZEN_EXT_WIFI_MESH
  57 #define MAX_CONNMAN_SERVICE_TYPES        11
  58 #else
  59 #define MAX_CONNMAN_SERVICE_TYPES        10
  60 #endif
  61
  62
  63 enum connman_service_security {
  64         CONNMAN_SERVICE_SECURITY_UNKNOWN = 0,
  65         CONNMAN_SERVICE_SECURITY_NONE    = 1,
  66         CONNMAN_SERVICE_SECURITY_WEP     = 2,
  67         CONNMAN_SERVICE_SECURITY_PSK     = 3,
  68         CONNMAN_SERVICE_SECURITY_8021X   = 4,
  69         CONNMAN_SERVICE_SECURITY_WPA     = 8,
  70         CONNMAN_SERVICE_SECURITY_RSN     = 9,
  71 #if defined TIZEN_EXT
  72         CONNMAN_SERVICE_SECURITY_SAE     = 10,
  73         CONNMAN_SERVICE_SECURITY_OWE     = 11,
  74         CONNMAN_SERVICE_SECURITY_DPP     = 12,
  75 #endif
  76 };
  77
  78 enum connman_service_state {
  79         CONNMAN_SERVICE_STATE_UNKNOWN       = 0,
  80         CONNMAN_SERVICE_STATE_IDLE          = 1,
  81         CONNMAN_SERVICE_STATE_ASSOCIATION   = 2,
  82         CONNMAN_SERVICE_STATE_CONFIGURATION = 3,
  83         CONNMAN_SERVICE_STATE_READY         = 4,
  84         CONNMAN_SERVICE_STATE_ONLINE        = 5,
  85         CONNMAN_SERVICE_STATE_DISCONNECT    = 6,
  86         CONNMAN_SERVICE_STATE_FAILURE       = 7,
  87 };
  88
  89 enum connman_service_error {
  90         CONNMAN_SERVICE_ERROR_UNKNOWN        = 0,
  91         CONNMAN_SERVICE_ERROR_OUT_OF_RANGE   = 1,
  92         CONNMAN_SERVICE_ERROR_PIN_MISSING    = 2,
  93         CONNMAN_SERVICE_ERROR_DHCP_FAILED    = 3,
  94         CONNMAN_SERVICE_ERROR_CONNECT_FAILED = 4,
  95         CONNMAN_SERVICE_ERROR_LOGIN_FAILED  = 5,
  96         CONNMAN_SERVICE_ERROR_AUTH_FAILED    = 6,
  97         CONNMAN_SERVICE_ERROR_INVALID_KEY    = 7,
  98         CONNMAN_SERVICE_ERROR_BLOCKED        = 8,
  99 };
 100
 101 enum connman_service_proxy_method {
 102         CONNMAN_SERVICE_PROXY_METHOD_UNKNOWN     = 0,
 103         CONNMAN_SERVICE_PROXY_METHOD_DIRECT      = 1,
 104         CONNMAN_SERVICE_PROXY_METHOD_MANUAL      = 2,
 105         CONNMAN_SERVICE_PROXY_METHOD_AUTO        = 3,
 106 };
 107
 108 enum connman_service_connect_reason {
 109         CONNMAN_SERVICE_CONNECT_REASON_NONE     = 0,
 110         CONNMAN_SERVICE_CONNECT_REASON_AUTO     = 1,
 111         CONNMAN_SERVICE_CONNECT_REASON_USER     = 2,
 112         CONNMAN_SERVICE_CONNECT_REASON_SESSION  = 3,
 113 };
 114
 115 struct connman_service;
 116 struct connman_network;
 117
 118 struct connman_service *connman_service_create(void);
 119
 120 #define connman_service_ref(service) \
 121         connman_service_ref_debug(service, __FILE__, __LINE__, __func__)
 122
 123 #define connman_service_unref(service) \
 124         connman_service_unref_debug(service, __FILE__, __LINE__, __func__)
 125
 126 struct connman_service *
 127 connman_service_ref_debug(struct connman_service *service,
 128                         const char *file, int line, const char *caller);
 129 void connman_service_unref_debug(struct connman_service *service,
 130                         const char *file, int line, const char *caller);
 131
 132 enum connman_service_type connman_service_get_type(struct connman_service *service);
 133 enum connman_service_state connman_service_get_state(struct connman_service *service);
 134 char *connman_service_get_interface(struct connman_service *service);
 135
 136 const char *connman_service_get_identifier(struct connman_service *service);
 137 const char *connman_service_get_domainname(struct connman_service *service);
 138 const char *connman_service_get_dbuspath(struct connman_service *service);
 139 char **connman_service_get_nameservers(struct connman_service *service);
 140 char **connman_service_get_timeservers_config(struct connman_service *service);
 141 char **connman_service_get_timeservers(struct connman_service *service);
 142 void connman_service_set_proxy_method(struct connman_service *service, enum connman_service_proxy_method method);
 143 enum connman_service_proxy_method connman_service_get_proxy_method(struct connman_service *service);
 144 char **connman_service_get_proxy_servers(struct connman_service *service);
 145 char **connman_service_get_proxy_excludes(struct connman_service *service);
 146 const char *connman_service_get_proxy_url(struct connman_service *service);
 147 const char *connman_service_get_proxy_autoconfig(struct connman_service *service);
 148 bool connman_service_get_favorite(struct connman_service *service);
 149 bool connman_service_get_autoconnect(struct connman_service *service);
 150
 151 /* Return non-zero value to terminate the loop, zero to continue */
 152 typedef int (* connman_service_iterate_cb) (struct connman_service *service,
 153                                                         void *user_data);
 154 int connman_service_iterate_services(connman_service_iterate_cb cb,
 155                                                         void *user_data);
 156
 157 struct connman_service *connman_service_get_default(void);
 158 struct connman_service *connman_service_lookup_from_network(struct connman_network *network);
 159 struct connman_service *connman_service_lookup_from_identifier(const char* identifier);
 160
 161 void connman_service_create_ip4config(struct connman_service *service,
 162                                                                 int index);
 163 void connman_service_create_ip6config(struct connman_service *service,
 164                                                                 int index);
 165
 166 #if defined TIZEN_EXT
 167 /*
 168  * Description: TIZEN implements system global connection management.
 169  *              It's only for PDP (cellular) bearer. Wi-Fi is managed by ConnMan automatically.
 170  *              Reference count can help to manage open/close connection requests by each application.
 171  */
 172
 173 /*
 174  * Increase reference count of user-initiated packet data network connection
 175  */
 176 void connman_service_user_pdn_connection_ref(struct connman_service *service);
 177
 178 /*
 179  * Decrease reference count of user initiated packet data network connection
 180  * and return TRUE if counter is zero.
 181  */
 182 gboolean connman_service_user_pdn_connection_unref_and_test(
 183                                         struct connman_service *service);
 184
 185 /*
 186  * Test reference count of user initiated packet data network connection
 187  * and return TRUE if counter is zero. No impact to reference count
 188  */
 189 gboolean connman_service_is_no_ref_user_pdn_connection(
 190                                         struct connman_service *service);
 191
 192 struct connman_service *connman_service_get_default_connection(void);
 193
 194 /*
 195  * Description: telephony plug-in requires manual PROXY setting
 196  */
 197 int connman_service_set_proxy(struct connman_service *service,
 198                                         const char *proxy, gboolean active);
 199
 200 void connman_service_set_disconnection_requested(struct connman_service *service,
 201                                                  bool disconnection_requested);
 202 #endif
 203
 204 #ifdef __cplusplus
 205 }
 206 #endif
 207
 208 #endif /* __CONNMAN_SERVICE_H */