doc/session-api.txt

   1 Service         unique name
   2 Interface       net.connman.Notification
   3 Object path     freely definable
   4
   5 Methods         void Release()
   6
   7                         This method gets called when the service daemon
   8                         unregisters the session. A counter can use it to do
   9                         cleanup tasks. There is no need to unregister the
  10                         session, because when this method gets called it has
  11                         already been unregistered.
  12
  13                 void Update(dict settings)
  14
  15                         Sends an update of changed settings. Only settings
  16                         that are changed will be included.
  17
  18                         Initially on every session creation this method is
  19                         called once to inform about the current settings.
  20
  21
  22 Service         net.connman
  23 Interface       net.connman.Session
  24 Object path     variable
  25
  26 Methods         void Destroy()
  27
  28                         Close the current session. This is similar to
  29                         DestroySession method on the manager interface. It
  30                         is just provided for convenience depending on how
  31                         the application wants to track the session.
  32
  33                 void Connect()
  34
  35                         If not connected, then attempt to connect this
  36                         session.
  37
  38                         The usage of this method depends a little bit on
  39                         the model of the application. Some application
  40                         should not try to call Connect on any session at
  41                         all. They should just monitor if it becomes online
  42                         or gets back offline.
  43
  44                         Others might require an active connection right now.
  45                         So for example email notification should only check
  46                         for new emails when a connection is available. However
  47                         if the user presses the button for get email or wants
  48                         to send an email it should request to get online with
  49                         this method.
  50
  51                         Depending on the bearer settings the current service
  52                         is used or a new service will be connected.
  53
  54                         This method returns immediately after it has been
  55                         called. The application is informed through the update
  56                         notification about the state of the session.
  57
  58                         It is also not guaranteed that a session stays online
  59                         after this method call. It can be taken offline at any
  60                         time. This might happen because of idle timeouts or
  61                         other reasons.
  62
  63                         It is safe to call this method multiple times. The
  64                         actual usage will be sorted out for the application.
  65
  66                 void Disconnect()
  67
  68                         This method indicates that the current session does
  69                         not need a connection anymore.
  70
  71                         This method returns immediately. The application is
  72                         informed through the update notification about the
  73                         state of the session.
  74
  75                 void Change(string name, variant value)
  76
  77                         Change the value of certain settings. Not all
  78                         settings can be changed. Normally this should not
  79                         be needed or an extra session should be created.
  80                         However in some cases it makes sense to change
  81                         a value and trigger different behavior.
  82
  83                         A change of a setting will cause an update notification
  84                         to be sent. Some changes might cause the session to
  85                         be moved to offline state.
  86
  87 Settings        string  Bearer [readonly]
  88
  89                         This indicates the current bearer that is used
  90                         for this session. Or an empty string if no bearer
  91                         is available.
  92
  93                 boolean Online [readonly]
  94
  95                         This indicates if the connection is online or
  96                         offline.
  97
  98                         This maps to the online service state. And it is
  99                         only valid for the selected bearer configuration.
 100                         Otherwise it will be reported as offline even if
 101                         the global state would be online.
 102
 103                         In addition the Online settings notification might
 104                         not happen right away. Notifications of online state
 105                         can be delayed based on the speed of the bearer. It
 106                         is done to avoid congestion on bearers like 3G etc.
 107
 108                 boolean Priority [readwrite]
 109
 110                         This allows a session to mark itself as priority or
 111                         not. In general application are not allowed to make
 112                         themselves more important than others.
 113
 114                         The priority handling is done internally by usage
 115                         and first come, first serve order. By default this
 116                         settings is of course false.
 117
 118                         Internally there can be different priorities for
 119                         different application, but these are defined by a
 120                         configuration file and not via this interface.
 121
 122                         An application that calls the method to connect
 123                         a session is preferred over other sessions. This
 124                         priority value is more for application that want to
 125                         push themselves up in the asychronization notification
 126                         queue once a bearer becomes online.
 127
 128                         This actual priority order also depends on the
 129                         allowed bearers and other factors. This is setting
 130                         is just a little indicator of one application being
 131                         notified before another one.
 132
 133                         For example a streaming session should set the
 134                         priority value. As soon as realtime data is involved
 135                         then this should be set. An email client should not
 136                         set this value.
 137
 138                 string Name [readonly]
 139
 140                         The Service name to which the system is connected.
 141                         It should only be used for displaying it in the UI
 142                         and not for getting hold on session object.
 143
 144                 array{string} AllowedBearers [readwrite]
 145
 146                         A list of bearers that can be used for this session.
 147                         In general this list should be empty to indicate that
 148                         any bearer is acceptable.
 149
 150                         The order of the entries in AllowedBearers matters.
 151                         The services are sorted in the order of the bearer
 152                         entries in this list.
 153
 154                         Also "*" matches any bearer. This is usefull to prefer
 155                         certain bearers such as Wifi with a fallback to any
 156                         other available bearer.
 157
 158                 dict IPv4 [readonly]
 159
 160                         Current IPv4 configuration. This settings is only
 161                         valid when online is true as well. Otherwise an
 162                         empty dictionary is reported.
 163
 164                 dict IPv6 [readonly]
 165
 166                         Current IPv6 configuration. This setting is only
 167                         valid when online is true as well. Otherwise an
 168                         empty dictionary is reported.
 169
 170                 boolean AvoidHandover [readwrite]
 171
 172                         By default this setting is false. It can be used
 173                         to indicate that a handover is currently not a good
 174                         idea. However no connection is guaranteed. So a
 175                         handover can happen anyway. This is just an indication
 176                         that the application would like to avoid it right now.
 177
 178                         It is a bad idea to always enable this settings and
 179                         actually it will be reset after a while to avoid
 180                         congestion.
 181
 182                         Main use case it is for application that are currently
 183                         doing a specific tasks that it prefers to finish
 184                         before allowing handovers again. An example would
 185                         be synchronization.
 186
 187                         Never the less application needs to be aware that
 188                         handovers can happen at any time even if this is
 189                         set to true.
 190
 191                 boolean StayConnected [readwrite]
 192
 193                         This disables the idle timeout for this session. There
 194                         is no guarantee and this should be used with care.
 195
 196                         If the system is not online yet this value is ignored.
 197
 198                 uint32  PeriodicConnect [readwrite]
 199
 200                         Indicate that a periodic connection attempt every
 201                         n minutes should be made. The minutes value is a
 202                         suggestion when to connection. There is no guarantee
 203                         that it will be made or will succeed.
 204
 205                         A value of 0 disable this feature.
 206
 207                         This feature is interesting for applications that
 208                         wanna check status on a regular interval. And instead
 209                         of the application waking up and trying to connect,
 210                         this can be centralized nicely and multiple wakeups
 211                         avoided in case no connection is available.
 212
 213                         An example application would be an email client that
 214                         wants to check for new emails every 10 minutes.
 215
 216                         On purpose the smallest setting is 1 minute here since
 217                         waking up more often and trying to set up a connection
 218                         seems rather pointless use case.
 219
 220                         If an interval step has passed this can be nicely
 221                         rescheduled when any connection matching the bearer
 222                         settings becomes available becomes available. Using
 223                         this feature it is also easy to avoid congestion.
 224
 225                 uint32  IdleTimeout [readwrite]
 226
 227                         If the system is idle for given period then it should
 228                         go offline.
 229
 230                         If the timeout is 0, this feature is disabled. If
 231                         different values are provided by several session object
 232                         the longest interval is taken as timeout value.
 233
 234                 boolean EmergencyCall [readwrite]
 235
 236                         Boolean representing the emergency mode of the
 237                         modem. The Emergency is true if an emergency call or
 238                         related operation is currently active.
 239
 240                         If the emergency application sets this setting to true
 241                         all other session will be informed about the emergency
 242                         situation with setting it also to true. Only the
 243                         emergency application can set back to false.
 244
 245                         As long the EmergencyCall is true no new session can
 246                         be created.
 247
 248                         Only one application is supposed to write this setting
 249                         and therefore it will be protected by additional
 250                         PolicyKit rule so that only the emergency application
 251                         can write.
 252
 253                         The emergency application is expected to call Connect()
 254                         after setting this setting true. If the emergency
 255                         situation is over the application should call
 256                         Disconnect() and also set the EmergencyCall to false
 257                         afterward.
 258
 259                         Note only services matching the AllowedBearers rule
 260                         will be considered.
 261
 262                 string  RoamingPolicy [readwrite]
 263
 264                         The allowed roaming behavior.
 265
 266                         Valid policies are "national", "international",
 267                         "default", "always" and "forbidden".
 268
 269                         "national" allows roaming within a country.
 270                         "international" allows roaming in a country and
 271                         between countries.
 272
 273                         "default" is used to tell the Session to use
 274                         the global roaming setting.
 275
 276                         "always" will overwrite the default "forbidden"
 277                         value which is useful for emergency application.
 278                         This value will be protected by additional PolicyKit
 279                         rule.
 280
 281                         Default value is "forbidden".
 282
 283                 string  Interface [readonly]
 284
 285                         Interface name used by the service object to connect.
 286                         This name can be used for SO_BINDTODEVICE in the
 287                         application.
 288
 289                 uint32  SessionMarker [readonly]
 290
 291                         The unique session marker can be used to mark all
 292                         traffic from the application with the SO_MARK
 293                         socket option. In combination of the EmergencyCall
 294                         this allows ConnMan to setup the firewall rules
 295                         that only traffic from the emergency application
 296                         are transmitted.