include/provider.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2013  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_PROVIDER_H
  23 #define __CONNMAN_PROVIDER_H
  24
  25 #include <stdbool.h>
  26
  27 #include <glib.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /**
  34  * SECTION:provider
  35  * @title: Provider premitives
  36  * @short_description: Functions for handling providers
  37  */
  38
  39 enum connman_provider_type {
  40         CONNMAN_PROVIDER_TYPE_UNKNOWN = 0,
  41         CONNMAN_PROVIDER_TYPE_VPN     = 1,
  42 };
  43
  44 enum connman_provider_state {
  45         CONNMAN_PROVIDER_STATE_UNKNOWN       = 0,
  46         CONNMAN_PROVIDER_STATE_IDLE          = 1,
  47         CONNMAN_PROVIDER_STATE_CONNECT       = 2,
  48         CONNMAN_PROVIDER_STATE_READY         = 3,
  49         CONNMAN_PROVIDER_STATE_DISCONNECT    = 4,
  50         CONNMAN_PROVIDER_STATE_FAILURE       = 5,
  51 };
  52
  53 enum connman_provider_error {
  54         CONNMAN_PROVIDER_ERROR_UNKNOWN          = 0,
  55         CONNMAN_PROVIDER_ERROR_CONNECT_FAILED   = 1,
  56         CONNMAN_PROVIDER_ERROR_LOGIN_FAILED     = 2,
  57         CONNMAN_PROVIDER_ERROR_AUTH_FAILED      = 3,
  58 };
  59
  60 enum connman_provider_route_type {
  61         CONNMAN_PROVIDER_ROUTE_UNKNOWN = 0,
  62         CONNMAN_PROVIDER_ROUTE_ALL = 0,
  63         CONNMAN_PROVIDER_ROUTE_USER = 1,
  64         CONNMAN_PROVIDER_ROUTE_SERVER = 2,
  65 };
  66
  67 struct connman_provider;
  68 struct connman_ipaddress;
  69
  70 #define connman_provider_ref(provider) \
  71         connman_provider_ref_debug(provider, __FILE__, __LINE__, __func__)
  72
  73 #define connman_provider_unref(provider) \
  74         connman_provider_unref_debug(provider, __FILE__, __LINE__, __func__)
  75
  76 struct connman_provider *
  77 connman_provider_ref_debug(struct connman_provider *provider,
  78                         const char *file, int line, const char *caller);
  79 void connman_provider_unref_debug(struct connman_provider *provider,
  80                         const char *file, int line, const char *caller);
  81
  82 int connman_provider_disconnect(struct connman_provider *provider);
  83 int connman_provider_remove(struct connman_provider *provider);
  84
  85 int connman_provider_set_string(struct connman_provider *provider,
  86                                         const char *key, const char *value);
  87 const char *connman_provider_get_string(struct connman_provider *provider,
  88                                                         const char *key);
  89
  90 int connman_provider_set_state(struct connman_provider *provider,
  91                                         enum connman_provider_state state);
  92
  93 int connman_provider_indicate_error(struct connman_provider *provider,
  94                                         enum connman_provider_error error);
  95
  96 void connman_provider_set_index(struct connman_provider *provider, int index);
  97 int connman_provider_get_index(struct connman_provider *provider);
  98
  99 void connman_provider_set_data(struct connman_provider *provider, void *data);
 100 void *connman_provider_get_data(struct connman_provider *provider);
 101 int connman_provider_set_ipaddress(struct connman_provider *provider,
 102                                         struct connman_ipaddress *ipaddress);
 103 int connman_provider_set_pac(struct connman_provider *provider,
 104                                 const char *pac);
 105 int connman_provider_create_service(struct connman_provider *provider);
 106 int connman_provider_set_immutable(struct connman_provider *provider,
 107                                                 bool immutable);
 108 struct connman_provider *connman_provider_get(const char *identifier);
 109 void connman_provider_put(struct connman_provider *provider);
 110 int connman_provider_set_domain(struct connman_provider *provider,
 111                                 const char *domain);
 112 int connman_provider_set_nameservers(struct connman_provider *provider,
 113                                         char * const *nameservers);
 114 void connman_provider_set_autoconnect(struct connman_provider *provider,
 115                                                                 bool flag);
 116
 117 const char *connman_provider_get_driver_name(struct connman_provider *provider);
 118 const char *connman_provider_get_save_group(struct connman_provider *provider);
 119 typedef void (* connection_ready_cb) (DBusMessage *msg, int error_code,
 120                                         void *user_data);
 121
 122 struct connman_provider_driver {
 123         const char *name;
 124         enum connman_provider_type type;
 125         int (*probe) (struct connman_provider *provider);
 126         int (*remove) (struct connman_provider *provider);
 127         int (*connect) (struct connman_provider *provider,
 128                         const char *dbus_sender);
 129         int (*disconnect) (struct connman_provider *provider);
 130         int (*save) (struct connman_provider *provider, GKeyFile *keyfile);
 131         int (*set_property) (struct connman_provider *provider,
 132                                 const char *key, const char *value);
 133         const char * (*get_property) (struct connman_provider *provider,
 134                                 const char *key);
 135         int (*create) (DBusMessage *msg, connection_ready_cb callback);
 136         int (*set_routes) (struct connman_provider *provider,
 137                                 enum connman_provider_route_type type);
 138         bool (*check_routes) (struct connman_provider *provider);
 139 };
 140
 141 int connman_provider_driver_register(struct connman_provider_driver *driver);
 142 void connman_provider_driver_unregister(struct connman_provider_driver *driver);
 143 void connman_provider_set_driver(struct connman_provider *provider,
 144                                 struct connman_provider_driver *driver);
 145
 146 #ifdef __cplusplus
 147 }
 148 #endif
 149
 150 #endif /* __CONNMAN_PROVIDER_H */