org.freesmartphone.Network/org.freesmartphone.Network.xml.in

   1 <?xml version="1.0"?>
   2 <node name="/" xmlns:fso="http://www.freesmartphone.org/schemas/DBusSpecExtension" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd" doc:id="freesmartphone-network-interface">
   3
   4 <doc:doc>
   5   <doc:summary>freesmartphone.org Network Interface</doc:summary>
   6   <doc:version>0.3.0</doc:version>
   7   <doc:maintainer>Michael 'Mickey' Lauer</doc:maintainer>
   8   <doc:status>unstable</doc:status>
   9 </doc:doc>
  10
  11 <interface name="org.freesmartphone.Network">
  12
  13   <doc:doc>
  14     <doc:para>
  15       The Network interface provides access to high level networking functions.
  16       Please see org.moblin.connman and org.bluez for low level networking functions.
  17     </doc:para>
  18   </doc:doc>
  19
  20   <method name="StartConnectionSharingWithInterface">
  21     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  22     <doc:doc>
  23       <doc:description>
  24         Start sharing the internet connection of this device with any clients
  25         connected to the specified network interface via DHCP.
  26       </doc:description>
  27       <doc:inote>
  28         Might launch a dhcp server process and adjust IP tables.
  29       </doc:inote>
  30     </doc:doc>
  31     <arg type="s" name="interface" direction="in">
  32       <doc:doc>
  33         <doc:summary>The network interface to start sharing the connectivity with.</doc:summary>
  34       </doc:doc>
  35     </arg>
  36     <fso:throws type="org.freesmartphone" />
  37   </method>
  38
  39   <method name="StopConnectionSharingWithInterface">
  40     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  41     <doc:doc>
  42       <doc:description>
  43         Stop sharing the internet connection of this device with any clients
  44         connected to the specified network interface via DHCP.
  45       </doc:description>
  46       <doc:inote>
  47         Might stop a dhcp server process and adjust IP tables.
  48       </doc:inote>
  49     </doc:doc>
  50     <arg type="s" name="interface" direction="in">
  51       <doc:doc>
  52         <doc:summary>The network interface to stop sharing the connectivity with.</doc:summary>
  53       </doc:doc>
  54     </arg>
  55     <fso:throws type="org.freesmartphone" />
  56   </method>
  57
  58   <method name="OfferDefaultRoute">
  59     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  60     <doc:doc>
  61       <doc:description>
  62         Offer a default route to the internet.
  63       </doc:description>
  64       <doc:inote>
  65         NOTE that this method is for TESTING purposes only. Eventually connman will be used for that.
  66       </doc:inote>
  67     </doc:doc>
  68     <arg type="s" name="technology" direction="in">
  69       <doc:doc>
  70         <doc:summary>The technology offering the default route.</doc:summary>
  71       </doc:doc>
  72     </arg>
  73     <arg type="s" name="interface" direction="in">
  74       <doc:doc>
  75         <doc:summary>The network interface offering the default route.</doc:summary>
  76       </doc:doc>
  77     </arg>
  78     <arg type="s" name="ipv4address" direction="in">
  79       <doc:doc>
  80         <doc:summary>The network address to configure the interface with.</doc:summary>
  81       </doc:doc>
  82     </arg>
  83     <arg type="s" name="ipv4mask" direction="in">
  84       <doc:doc>
  85         <doc:summary>The network mask to configure the interface with.</doc:summary>
  86       </doc:doc>
  87     </arg>
  88     <arg type="s" name="ipv4gateway" direction="in">
  89       <doc:doc>
  90         <doc:summary>The network gateway address for the default route.</doc:summary>
  91       </doc:doc>
  92     </arg>
  93     <arg type="s" name="dns1" direction="in">
  94       <doc:doc>
  95         <doc:summary>The first DNS address.</doc:summary>
  96       </doc:doc>
  97     </arg>
  98     <arg type="s" name="dns2" direction="in">
  99       <doc:doc>
 100         <doc:summary>The second DNS address.</doc:summary>
 101       </doc:doc>
 102     </arg>
 103     <fso:throws type="org.freesmartphone" />
 104   </method>
 105
 106 </interface>
 107
 108 </node>