include/gammu-wap.h

   1 /**
   2  * \file gammu-wap.h
   3  * \author Michal Čihař
   4  *
   5  * WAP data and functions.
   6  */
   7 #ifndef __gammu_wap_h
   8 #define __gammu_wap_h
   9
  10 /**
  11  * \defgroup WAP WAP
  12  * WAP bookmars and settings manipulations.
  13  */
  14
  15 #include <gammu-types.h>
  16 #include <gammu-error.h>
  17 #include <gammu-statemachine.h>
  18
  19 #include <stdlib.h>             /* Needed for size_t declaration */
  20
  21 /**
  22  * WAP bookmark data.
  23  *
  24  * \ingroup WAP
  25  */
  26 typedef struct {
  27         /**
  28          * Location where it is stored.
  29          */
  30         int Location;
  31         /**
  32          * Bookmark URL.
  33          */
  34         unsigned char Address[(255 + 1) * 2];
  35         /**
  36          * Bookmark title.
  37          */
  38         unsigned char Title[(50 + 1) * 2];
  39 } GSM_WAPBookmark;
  40
  41 /* --------------------------- WAP or MMS settings ------------------------- */
  42
  43 /**
  44  * Connection speed configuration.
  45  *
  46  * \ingroup WAP
  47  */
  48 typedef enum {
  49         WAPSETTINGS_SPEED_9600,
  50         WAPSETTINGS_SPEED_14400,
  51         WAPSETTINGS_SPEED_AUTO
  52 } WAPSettings_Speed;
  53
  54 /**
  55  * Connection bearer configuration.
  56  *
  57  * \ingroup WAP
  58  */
  59 typedef enum {
  60         WAPSETTINGS_BEARER_SMS = 1,
  61         WAPSETTINGS_BEARER_DATA,
  62         WAPSETTINGS_BEARER_USSD,
  63         WAPSETTINGS_BEARER_GPRS
  64 } WAPSettings_Bearer;
  65
  66 /**
  67  * WAP setting.
  68  *
  69  * \ingroup WAP
  70  */
  71 typedef struct {
  72         /**
  73          * Settings name.
  74          */
  75         char Title[(20 + 1) * 2];
  76         /**
  77          * Home page.
  78          */
  79         char HomePage[(100 + 1) * 2];
  80         /**
  81          * Bearer of WAP connection.
  82          */
  83         WAPSettings_Bearer Bearer;
  84         /**
  85          * Secure connection?
  86          */
  87         gboolean IsSecurity;
  88         /**
  89          * Is this connectin continuous?
  90          */
  91         gboolean IsContinuous;
  92
  93         /**
  94          * Whether is ISDN for data bearer
  95          */
  96         gboolean IsISDNCall;
  97         /**
  98          * Whether is normal auth for data bearer
  99          */
 100         gboolean IsNormalAuthentication;
 101
 102         /**
 103          * Server for sms bearer.
 104          */
 105         char Server[(21 + 1) * 2];
 106
 107         /**
 108          * Service for sms or ussd bearer.
 109          */
 110         char Service[(20 + 1) * 2];
 111         /**
 112          * Whether is IP, for sms or ussd bearer.
 113          */
 114         gboolean IsIP;
 115
 116         /**
 117          * Code for ussd bearer.
 118          */
 119         char Code[(10 + 1) * 2];
 120
 121         /**
 122          * IP address for data or gprs.
 123          */
 124         char IPAddress[(20 + 1) * 2];
 125         /**
 126          * Login for data or gprs.
 127          */
 128         gboolean ManualLogin;
 129         /**
 130          * Dial up number for data or gprs.
 131          */
 132         char DialUp[(20 + 1) * 2];
 133         /**
 134          * User name for data or gprs.
 135          *
 136          * \todo Is length okay?
 137          */
 138         char User[(50 + 1) * 2];
 139         /**
 140          * User password for data or gprs.
 141          *
 142          * \todo Is length okay?
 143          */
 144         char Password[(50 + 1) * 2];
 145         /**
 146          * Speed settings for data or gprs.
 147          */
 148         WAPSettings_Speed Speed;
 149 } GSM_WAPSettings;
 150
 151 /**
 152  * Set of WAP settings.
 153  *
 154  * \ingroup WAP
 155  */
 156 typedef struct {
 157         /**
 158          * Location.
 159          */
 160         int Location;
 161         /**
 162          * Number of elements in Settings.
 163          */
 164         unsigned char Number;
 165         /**
 166          * Real WAP settings.
 167          */
 168         GSM_WAPSettings Settings[4];
 169         /**
 170          * Whether this configuration is active.
 171          */
 172         gboolean Active;
 173         /**
 174          * Whether this configuration is read only.
 175          */
 176         gboolean ReadOnly;
 177         /**
 178          * Proxy server.
 179          */
 180         char Proxy[(100 + 1) * 2];
 181         /**
 182          * Proxy port.
 183          */
 184         int ProxyPort;
 185         /**
 186          * Second proxy server.
 187          */
 188         char Proxy2[(100 + 1) * 2];
 189         /**
 190          * Second proxy port.
 191          */
 192         int Proxy2Port;
 193         /**
 194          * Bearer of current connection.
 195          */
 196         WAPSettings_Bearer ActiveBearer;
 197 } GSM_MultiWAPSettings;
 198
 199 /**
 200  * Encodes URL to VBKM file.
 201  *
 202  * \param Buffer Storage for text.
 203  * \param Length Pointer to storage, will be updated.
 204  * \param bookmark Bookmark to encode.
 205  *
 206  * \return Error code.
 207  *
 208  * \ingroup WAP
 209  */
 210 GSM_Error GSM_EncodeURLFile(unsigned char *Buffer, size_t * Length,
 211                             GSM_WAPBookmark * bookmark);
 212
 213 /**
 214  * Reads WAP bookmark.
 215  *
 216  * \param s State machine pointer.
 217  * \param bookmark Bookmark storage, need to contain location.
 218  *
 219  * \return Error code
 220  *
 221  * \ingroup WAP
 222  */
 223 GSM_Error GSM_GetWAPBookmark(GSM_StateMachine * s, GSM_WAPBookmark * bookmark);
 224
 225 /**
 226  * Sets WAP bookmark.
 227  *
 228  * \param s State machine pointer.
 229  * \param bookmark Bookmark data.
 230  *
 231  * \return Error code
 232  *
 233  * \ingroup WAP
 234  */
 235 GSM_Error GSM_SetWAPBookmark(GSM_StateMachine * s, GSM_WAPBookmark * bookmark);
 236
 237 /**
 238  * Deletes WAP bookmark.
 239  *
 240  * \param s State machine pointer.
 241  * \param bookmark Bookmark data, need to contain location.
 242  *
 243  * \return Error code
 244  *
 245  * \ingroup WAP
 246  */
 247 GSM_Error GSM_DeleteWAPBookmark(GSM_StateMachine * s,
 248                                 GSM_WAPBookmark * bookmark);
 249
 250 /**
 251  * Acquires WAP settings.
 252  *
 253  * \param s State machine pointer.
 254  * \param settings Settings storage.
 255  *
 256  * \return Error code
 257  *
 258  * \ingroup WAP
 259  */
 260 GSM_Error GSM_GetWAPSettings(GSM_StateMachine * s,
 261                              GSM_MultiWAPSettings * settings);
 262
 263 /**
 264  * Changes WAP settings.
 265  *
 266  * \param s State machine pointer.
 267  * \param settings Settings data.
 268  *
 269  * \return Error code
 270  *
 271  * \ingroup WAP
 272  */
 273 GSM_Error GSM_SetWAPSettings(GSM_StateMachine * s,
 274                              GSM_MultiWAPSettings * settings);
 275 #endif
 276
 277 /* Editor configuration
 278  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 279  */