src/network_interface.h

   1 /*
   2  *  network_interface.h
   3  *
   4  *  Copyright(C) 2007,2008 Ixonos Plc
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  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., 59 Temple Place, Boston, MA 02111.
  19  */
  20
  21 /*
  22  * Written by
  23  *   Jukka Honkela
  24  *   Yi Zheng
  25  *   Matti Katila
  26  *   Vesa Pikki
  27  *   Heikki Paajanen
  28  */
  29
  30
  31 #ifndef NETWORK_INTERFACE
  32 #define NETWORK_INTERFACE
  33
  34 typedef struct _NetworkInterface NetworkInterface;
  35
  36
  37 typedef struct _NetworkProvider {
  38         gint index;
  39         gchar *status;
  40         gchar *name;
  41         gchar *nickname;
  42 } NetworkProvider;
  43
  44 /**
  45 * @brief Network interface
  46 */
  47 struct _NetworkInterface {
  48         gpointer priv;
  49
  50         /**
  51         * @brief Provider's name
  52         */
  53         GString *provider_name;
  54
  55         /**
  56         * @brief Provider status
  57         */
  58         GString *status;
  59
  60
  61
  62         //TODO remove these/modify them to comply with freesmartphone's xml/modify freesmartphone's xml
  63         void (*set_operator) (NetworkInterface *network,
  64                               gpointer ipc_data,
  65                               const char* operator,
  66                               gboolean locked);
  67         void (*query_current_operator) (NetworkInterface *network,
  68                                         gpointer ipc_data);
  69         void (*query_signal_strength) (NetworkInterface *network,
  70                                        gpointer ipc_data);
  71
  72         /**
  73         * @brief Registers to network
  74         *
  75         * @param modem pointer to modem struct
  76         * @param ipc_data ipc data
  77         */
  78         void (*register_network) (NetworkInterface *network,
  79                                   gpointer ipc_data);
  80
  81         /**
  82         * @brief Unregisters from network
  83         *
  84         * @param modem pointer to modem struct
  85         * @param ipc_data ipc data
  86         */
  87         void (*unregister) (NetworkInterface *network,
  88                             gpointer ipc_data);
  89
  90         /**
  91         * @brief Gets network status
  92         *
  93         * @param modem pointer to modem struct
  94         * @param ipc_data ipc data
  95         */
  96         void (*get_status) (NetworkInterface *network,
  97                             gpointer ipc_data);
  98
  99         /**
 100         * @brief Lists providers
 101         *
 102         * @param modem pointer to modem struct
 103         * @param ipc_data ipc data
 104         */
 105         void (*list_providers) (NetworkInterface *network,
 106                                 gpointer ipc_data);
 107
 108         /**
 109         * @brief Registers with provider
 110         *
 111         * @param modem pointer to modem struct
 112         * @param ipc_data ipc data
 113         * @param index provider's index
 114         */
 115         void (*register_with_provider) (NetworkInterface *network,
 116                                         gpointer ipc_data,
 117                                         int index);
 118
 119
 120         /**
 121         * @brief Get country code
 122         *
 123         * @param modem pointer to modem struct
 124         * @param ipc_data ipc data
 125         * @param index provider's index
 126         */
 127         void (*get_country_code) (NetworkInterface *network,
 128                                   gpointer ipc_data);
 129
 130
 131
 132
 133
 134 };
 135
 136 typedef struct _NetworkIPCInterface NetworkIPCInterface;
 137
 138 struct _NetworkIPCInterface {
 139
 140         gpointer priv;
 141
 142
 143         /*********************Replies to methods*****************/
 144
 145         /**
 146         * @brief Reply to "register_network" method call
 147         *
 148         * @param modem pointer to modem struct
 149         * @param ipc_data ipc data
 150         */
 151         void (*register_network_reply) (NetworkIPCInterface *network_ipc,
 152                                         gpointer ipc_data);
 153
 154         /**
 155         * @brief Reply to "unregister" method call
 156         *
 157         * @param modem pointer to modem struct
 158         * @param ipc_data ipc data
 159         */
 160         void (*unregister_reply) (NetworkIPCInterface *network_ipc,
 161                                   gpointer ipc_data);
 162
 163         /**
 164         * @brief Reply to "get_status" method call
 165         *
 166         * @param modem pointer to modem struct
 167         * @param ipc_data ipc data
 168         * @param provider_name
 169         * @param status
 170         * @param strength
 171         */
 172         void (*get_status_reply) (NetworkIPCInterface *network_ipc,
 173                                   gpointer ipc_data,
 174                                   GHashTable *status);
 175
 176         /**
 177         * @brief Reply to "list_providers" method call
 178         *
 179         * @param modem pointer to modem struct
 180         * @param ipc_data ipc data
 181         * @param providers list of network providers
 182         */
 183         void (*list_providers_reply) (NetworkIPCInterface *network_ipc,
 184                                       gpointer ipc_data,
 185                                       GArray *providers);
 186
 187         /**
 188         * @brief Reply to "register_with_provider" method call
 189         *
 190         * @param modem pointer to modem struct
 191         * @param ipc_data ipc data
 192         */
 193         void (*register_with_provider_reply) (NetworkIPCInterface *network_ipc,
 194                                               gpointer ipc_data);
 195
 196
 197         /**
 198         * @brief Reply to "get_country_code" method call
 199         *
 200         * @param modem pointer to modem struct
 201         * @param ipc_data ipc data
 202         */
 203         void (*get_country_code_reply) (NetworkIPCInterface *network_ipc,
 204                                         gpointer ipc_data,
 205                                         const gchar *dial_code);
 206
 207
 208
 209
 210
 211         /*********************Method errors**********************************/
 212
 213         /**
 214         * @brief Error reply to "register_network" method call
 215         *
 216         * @param modem pointer to modem struct
 217         * @param ipc_data ipc data
 218         */
 219         void (*register_network_error) (NetworkIPCInterface *network_ipc,
 220                                         gpointer ipc_data,
 221                                         GError *error);
 222
 223         /**
 224         * @brief Error reply to "unregister" method call
 225         *
 226         * @param modem pointer to modem struct
 227         * @param ipc_data ipc data
 228         */
 229         void (*unregister_error) (NetworkIPCInterface *network_ipc,
 230                                   gpointer ipc_data,
 231                                   GError *error);
 232
 233         /**
 234         * @brief Error reply to "get_status" method call
 235         *
 236         * @param modem pointer to modem struct
 237         * @param ipc_data ipc data
 238         */
 239         void (*get_status_error) (NetworkIPCInterface *network_ipc,
 240                                   gpointer ipc_data,
 241                                   GError *error);
 242
 243         /**
 244         * @brief Error reply to "list_providers" method call
 245         *
 246         * @param modem pointer to modem struct
 247         * @param ipc_data ipc data
 248         */
 249         void (*list_providers_error) (NetworkIPCInterface *network_ipc,
 250                                       gpointer ipc_data,
 251                                       GError *error);
 252
 253         /**
 254         * @brief Error reply to "register_with_provider" method call
 255         *
 256         * @param modem pointer to modem struct
 257         * @param ipc_data ipc data
 258         */
 259         void (*register_with_provider_error) (NetworkIPCInterface *network_ipc,
 260                                               gpointer ipc_data,
 261                                               GError *error);
 262
 263         /**
 264         * @brief Error reply to "get_country_code" method call
 265         *
 266         * @param modem pointer to modem struct
 267         * @param ipc_data ipc data
 268         */
 269         void (*get_country_code_error) (NetworkIPCInterface *network_ipc,
 270                                         gpointer ipc_data,
 271                                         GError *error);
 272
 273
 274
 275
 276         /*********************Signals**********************************/
 277         /**
 278         * @brief Status signal
 279         *
 280         * @param modem pointer to modem struct
 281         * @param provider_name
 282         * @param status
 283         * @param strength signal strength
 284         */
 285         void (*status) (NetworkIPCInterface *network_ipc,
 286                         GHashTable *status);
 287
 288         /**
 289         * @brief Subscriber numbers
 290         *
 291         * @param modem pointer to modem struct
 292         * @param number
 293         */
 294         void (*subscriber_numbers) (NetworkIPCInterface *network_ipc,
 295                                     const char **number);
 296
 297
 298 };
 299
 300 #endif
 301
 302
 303