include/service.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2010  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 <connman/types.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /**
  32  * SECTION:service
  33  * @title: Service premitives
  34  * @short_description: Functions for handling services
  35  */
  36
  37 enum connman_service_type {
  38         CONNMAN_SERVICE_TYPE_UNKNOWN   = 0,
  39         CONNMAN_SERVICE_TYPE_SYSTEM    = 1,
  40         CONNMAN_SERVICE_TYPE_ETHERNET  = 2,
  41         CONNMAN_SERVICE_TYPE_WIFI      = 3,
  42         CONNMAN_SERVICE_TYPE_WIMAX     = 4,
  43         CONNMAN_SERVICE_TYPE_BLUETOOTH = 5,
  44         CONNMAN_SERVICE_TYPE_CELLULAR  = 6,
  45         CONNMAN_SERVICE_TYPE_GPS       = 7,
  46         CONNMAN_SERVICE_TYPE_VPN       = 8,
  47         CONNMAN_SERVICE_TYPE_GADGET    = 9,
  48 };
  49
  50 enum connman_service_security {
  51         CONNMAN_SERVICE_SECURITY_UNKNOWN = 0,
  52         CONNMAN_SERVICE_SECURITY_NONE    = 1,
  53         CONNMAN_SERVICE_SECURITY_WEP     = 2,
  54         CONNMAN_SERVICE_SECURITY_PSK     = 3,
  55         CONNMAN_SERVICE_SECURITY_8021X   = 4,
  56         CONNMAN_SERVICE_SECURITY_WPA     = 8,
  57         CONNMAN_SERVICE_SECURITY_RSN     = 9,
  58 };
  59
  60 enum connman_service_state {
  61         CONNMAN_SERVICE_STATE_UNKNOWN       = 0,
  62         CONNMAN_SERVICE_STATE_IDLE          = 1,
  63         CONNMAN_SERVICE_STATE_ASSOCIATION   = 2,
  64         CONNMAN_SERVICE_STATE_CONFIGURATION = 3,
  65         CONNMAN_SERVICE_STATE_READY         = 4,
  66         CONNMAN_SERVICE_STATE_ONLINE        = 5,
  67         CONNMAN_SERVICE_STATE_DISCONNECT    = 6,
  68         CONNMAN_SERVICE_STATE_FAILURE       = 7,
  69 };
  70
  71 enum connman_service_error {
  72         CONNMAN_SERVICE_ERROR_UNKNOWN        = 0,
  73         CONNMAN_SERVICE_ERROR_OUT_OF_RANGE   = 1,
  74         CONNMAN_SERVICE_ERROR_PIN_MISSING    = 2,
  75         CONNMAN_SERVICE_ERROR_DHCP_FAILED    = 3,
  76         CONNMAN_SERVICE_ERROR_CONNECT_FAILED = 4,
  77         CONNMAN_SERVICE_ERROR_LOGIN_FAILED  = 5,
  78         CONNMAN_SERVICE_ERROR_AUTH_FAILED    = 6,
  79         CONNMAN_SERVICE_ERROR_INVALID_KEY    = 7,
  80 };
  81
  82 enum connman_service_proxy_method {
  83         CONNMAN_SERVICE_PROXY_METHOD_UNKNOWN     = 0,
  84         CONNMAN_SERVICE_PROXY_METHOD_DIRECT      = 1,
  85         CONNMAN_SERVICE_PROXY_METHOD_MANUAL      = 2,
  86         CONNMAN_SERVICE_PROXY_METHOD_AUTO        = 3,
  87 };
  88
  89 struct connman_service;
  90
  91 struct connman_service *connman_service_create(void);
  92 struct connman_service *connman_service_ref(struct connman_service *service);
  93 void connman_service_unref(struct connman_service *service);
  94
  95 enum connman_service_type connman_service_get_type(struct connman_service *service);
  96 char *connman_service_get_interface(struct connman_service *service);
  97
  98 const char *connman_service_get_domainname(struct connman_service *service);
  99 char **connman_service_get_nameservers(struct connman_service *service);
 100 void connman_service_set_proxy_method(struct connman_service *service, enum connman_service_proxy_method method);
 101 enum connman_service_proxy_method connman_service_get_proxy_method(struct connman_service *service);
 102 char **connman_service_get_proxy_servers(struct connman_service *service);
 103 char **connman_service_get_proxy_excludes(struct connman_service *service);
 104 const char *connman_service_get_proxy_url(struct connman_service *service);
 105 const char *connman_service_get_proxy_autoconfig(struct connman_service *service);
 106
 107 #if defined TIZEN_EXT
 108 /*
 109  * Description: TIZEN implements system global connection management.
 110  *              It's only for PDP (cellular) bearer. Wi-Fi is managed by ConnMan automatically.
 111  *              Reference count can help to manage open/close connection requests by each application.
 112  */
 113
 114 /*
 115  * Increase reference count of user-initiated packet data network connection
 116  */
 117 void connman_service_user_initiated_pdn_connection_ref(struct connman_service *service);
 118
 119 /*
 120  * Decrease reference count of user initiated packet data network connection and return TRUE if counter is zero.
 121  */
 122 connman_bool_t connman_service_user_initiated_pdn_connection_unref_and_test(struct connman_service *service);
 123
 124 /*
 125  * Test reference count of user initiated packet data network connection and return TRUE if counter is zero.
 126  * No impact to reference count
 127  */
 128 connman_bool_t connman_service_is_no_ref_user_initiated_pdn_connection(struct connman_service *service);
 129 #endif
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif /* __CONNMAN_SERVICE_H */