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 #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_BLUETOOTH = 4,
  43         CONNMAN_SERVICE_TYPE_CELLULAR  = 5,
  44         CONNMAN_SERVICE_TYPE_GPS       = 6,
  45         CONNMAN_SERVICE_TYPE_VPN       = 7,
  46         CONNMAN_SERVICE_TYPE_GADGET    = 8,
  47         CONNMAN_SERVICE_TYPE_P2P       = 9,
  48 };
  49 #define MAX_CONNMAN_SERVICE_TYPES        10
  50
  51
  52 enum connman_service_security {
  53         CONNMAN_SERVICE_SECURITY_UNKNOWN = 0,
  54         CONNMAN_SERVICE_SECURITY_NONE    = 1,
  55         CONNMAN_SERVICE_SECURITY_WEP     = 2,
  56         CONNMAN_SERVICE_SECURITY_PSK     = 3,
  57         CONNMAN_SERVICE_SECURITY_8021X   = 4,
  58         CONNMAN_SERVICE_SECURITY_WPA     = 8,
  59         CONNMAN_SERVICE_SECURITY_RSN     = 9,
  60 };
  61
  62 enum connman_service_state {
  63         CONNMAN_SERVICE_STATE_UNKNOWN       = 0,
  64         CONNMAN_SERVICE_STATE_IDLE          = 1,
  65         CONNMAN_SERVICE_STATE_ASSOCIATION   = 2,
  66         CONNMAN_SERVICE_STATE_CONFIGURATION = 3,
  67         CONNMAN_SERVICE_STATE_READY         = 4,
  68         CONNMAN_SERVICE_STATE_ONLINE        = 5,
  69         CONNMAN_SERVICE_STATE_DISCONNECT    = 6,
  70         CONNMAN_SERVICE_STATE_FAILURE       = 7,
  71 };
  72
  73 enum connman_service_error {
  74         CONNMAN_SERVICE_ERROR_UNKNOWN        = 0,
  75         CONNMAN_SERVICE_ERROR_OUT_OF_RANGE   = 1,
  76         CONNMAN_SERVICE_ERROR_PIN_MISSING    = 2,
  77         CONNMAN_SERVICE_ERROR_DHCP_FAILED    = 3,
  78         CONNMAN_SERVICE_ERROR_CONNECT_FAILED = 4,
  79         CONNMAN_SERVICE_ERROR_LOGIN_FAILED  = 5,
  80         CONNMAN_SERVICE_ERROR_AUTH_FAILED    = 6,
  81         CONNMAN_SERVICE_ERROR_INVALID_KEY    = 7,
  82         CONNMAN_SERVICE_ERROR_BLOCKED        = 8,
  83 };
  84
  85 enum connman_service_proxy_method {
  86         CONNMAN_SERVICE_PROXY_METHOD_UNKNOWN     = 0,
  87         CONNMAN_SERVICE_PROXY_METHOD_DIRECT      = 1,
  88         CONNMAN_SERVICE_PROXY_METHOD_MANUAL      = 2,
  89         CONNMAN_SERVICE_PROXY_METHOD_AUTO        = 3,
  90 };
  91
  92 enum connman_service_connect_reason {
  93         CONNMAN_SERVICE_CONNECT_REASON_NONE     = 0,
  94         CONNMAN_SERVICE_CONNECT_REASON_AUTO     = 1,
  95         CONNMAN_SERVICE_CONNECT_REASON_USER     = 2,
  96         CONNMAN_SERVICE_CONNECT_REASON_SESSION  = 3,
  97 };
  98
  99 struct connman_service;
 100 struct connman_network;
 101
 102 struct connman_service *connman_service_create(void);
 103
 104 #define connman_service_ref(service) \
 105         connman_service_ref_debug(service, __FILE__, __LINE__, __func__)
 106
 107 #define connman_service_unref(service) \
 108         connman_service_unref_debug(service, __FILE__, __LINE__, __func__)
 109
 110 struct connman_service *
 111 connman_service_ref_debug(struct connman_service *service,
 112                         const char *file, int line, const char *caller);
 113 void connman_service_unref_debug(struct connman_service *service,
 114                         const char *file, int line, const char *caller);
 115
 116 enum connman_service_type connman_service_get_type(struct connman_service *service);
 117 enum connman_service_state connman_service_get_state(struct connman_service *service);
 118 char *connman_service_get_interface(struct connman_service *service);
 119
 120 const char *connman_service_get_identifier(struct connman_service *service);
 121 const char *connman_service_get_domainname(struct connman_service *service);
 122 const char *connman_service_get_dbuspath(struct connman_service *service);
 123 char **connman_service_get_nameservers(struct connman_service *service);
 124 char **connman_service_get_timeservers_config(struct connman_service *service);
 125 char **connman_service_get_timeservers(struct connman_service *service);
 126 void connman_service_set_proxy_method(struct connman_service *service, enum connman_service_proxy_method method);
 127 enum connman_service_proxy_method connman_service_get_proxy_method(struct connman_service *service);
 128 char **connman_service_get_proxy_servers(struct connman_service *service);
 129 char **connman_service_get_proxy_excludes(struct connman_service *service);
 130 const char *connman_service_get_proxy_url(struct connman_service *service);
 131 const char *connman_service_get_proxy_autoconfig(struct connman_service *service);
 132 bool connman_service_get_favorite(struct connman_service *service);
 133 bool connman_service_get_autoconnect(struct connman_service *service);
 134 bool connman_service_set_autoconnect(struct connman_service *service,
 135                                                         bool autoconnect);
 136
 137 /* Return non-zero value to terminate the loop, zero to continue */
 138 typedef int (* connman_service_iterate_cb) (struct connman_service *service,
 139                                                         void *user_data);
 140 int connman_service_iterate_services(connman_service_iterate_cb cb,
 141                                                         void *user_data);
 142
 143 struct connman_service *connman_service_get_default(void);
 144 struct connman_service *connman_service_lookup_from_network(struct connman_network *network);
 145 struct connman_service *connman_service_lookup_from_identifier(const char* identifier);
 146
 147 void connman_service_create_ip4config(struct connman_service *service,
 148                                                                 int index);
 149 void connman_service_create_ip6config(struct connman_service *service,
 150                                                                 int index);
 151
 152 #ifdef __cplusplus
 153 }
 154 #endif
 155
 156 #endif /* __CONNMAN_SERVICE_H */