org.freesmartphone.GSM/org.freesmartphone.GSM.MUX.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-gsm-mux-interface">
   3
   4 <doc:doc>
   5   <doc:summary>freesmartphone.org GSM MUX Interface</doc:summary>
   6   <doc:version>1.1.0</doc:version>
   7 </doc:doc>
   8 <interface name="org.freesmartphone.GSM.MUX">
   9
  10   <doc:doc>
  11     <doc:para>
  12       The MUX interface is used to manage and control virtual serial channels
  13       (implemented through pseudo TTYs) which are multiplexed to one serial
  14       line as described in 3GPP TS 07.10.
  15     </doc:para>
  16   </doc:doc>
  17
  18     <method name="OpenSession">
  19       <annotation name="org.freedesktop.DBus.GLib.Async" value="true"/>
  20       <doc:doc>
  21         <doc:description>Initiate a new multiplexing session.</doc:description>
  22         <doc:inote>The device needs to support the +CMUX command.</doc:inote>
  23       </doc:doc>
  24       <arg name="advanced" type="b" direction="in">
  25         <doc:doc>
  26           <doc:summary>True, to use 07.10 Advanced Mode multiplexing, False to use 07.10 Basic Mode multiplexing.</doc:summary>
  27         </doc:doc>
  28       </arg>
  29       <arg name="framesize" type="i" direction="in">
  30         <doc:doc>
  31           <doc:summary>The maximum framesize for 07.10 multiplexing frames.</doc:summary>
  32         </doc:doc>
  33       </arg>
  34       <arg name="portname" type="s" direction="in">
  35         <doc:doc>
  36           <doc:summary>The port name to use.</doc:summary>
  37         </doc:doc>
  38       </arg>
  39       <arg name="portspeed" type="i" direction="in">
  40         <doc:doc>
  41           <doc:summary>The port speed to use.</doc:summary>
  42         </doc:doc>
  43       </arg>
  44       <fso:throws type="org.freesmartphone.GSM" />
  45       <fso:throws type="org.freesmartphone" />
  46     </method>
  47
  48     <method name="CloseSession">
  49       <annotation name="org.freedesktop.DBus.GLib.Async" value="true"/>
  50       <doc:doc>
  51         <doc:description>Closes a multiplexing session.</doc:description>
  52         <doc:inote>The device will be left in AT command mode.</doc:inote>
  53       </doc:doc>
  54       <fso:throws type="org.freesmartphone.GSM" />
  55       <fso:throws type="org.freesmartphone" />
  56     </method>
  57
  58     <method name="AllocChannel">
  59       <annotation name="org.freedesktop.DBus.GLib.Async" value="true"/>
  60       <doc:doc>
  61         <doc:description>
  62           Allocate a new virtual channel. Raises org.freesmartphone.GSM.MUX.NoChannel,
  63           if the requested channel can not be allocated. Raises org.freesmartphone.GSM.MUX.ChannelTaken,
  64           if the requested channel is already allocated.
  65         </doc:description>
  66       </doc:doc>
  67       <arg name="origin" type="s" direction="in">
  68         <doc:doc>
  69           <doc:summary>A handle for channel user identification.</doc:summary>
  70         </doc:doc>
  71       </arg>
  72       <arg name="channel" type="i" direction="in">
  73         <doc:doc>
  74           <doc:summary>The requested channel. Submit 0 to request the next free channel.</doc:summary>
  75         </doc:doc>
  76       </arg>
  77       <arg name="path" type="s" direction="out">
  78         <doc:doc>
  79           <doc:summary>The pseudo tty connected to the virtual channel.</doc:summary>
  80         </doc:doc>
  81       </arg>
  82       <arg name="allocated_channel" type="i" direction="out">
  83         <doc:doc>
  84           <doc:summary>The channel number that has been allocated.</doc:summary>
  85         </doc:doc>
  86       </arg>
  87       <fso:throws type="org.freesmartphone.GSM" />
  88       <fso:throws type="org.freesmartphone" />
  89     </method>
  90
  91     <method name="ReleaseChannel">
  92       <annotation name="org.freedesktop.DBus.GLib.Async" value="true"/>
  93       <doc:doc>
  94         <doc:description>
  95           Release all channels requested by a specified user.
  96         </doc:description>
  97       </doc:doc>
  98       <arg name="origin" type="s" direction="in">
  99         <doc:doc>
 100           <doc:summary>A handle for channel user identification.</doc:summary>
 101         </doc:doc>
 102       </arg>
 103       <fso:throws type="org.freesmartphone.GSM" />
 104       <fso:throws type="org.freesmartphone" />
 105     </method>
 106
 107     <method name="SetStatus">
 108       <annotation name="org.freedesktop.DBus.GLib.Async" value="true"/>
 109       <doc:doc>
 110         <doc:description>
 111           Modify the v24 status of a virtual channel.
 112         </doc:description>
 113       </doc:doc>
 114       <arg name="channel" type="i" direction="in">
 115         <doc:doc>
 116           <doc:summary>The virtual channel you want to change the outgoing status for.</doc:summary>
 117         </doc:doc>
 118       </arg>
 119       <arg name="status" type="s" direction="in">
 120         <doc:doc>
 121           <doc:summary>
 122             The new v.24 status. See org.freesmartphone.GSM.MUX.Status for the format.
 123           </doc:summary>
 124         </doc:doc>
 125       </arg>
 126       <fso:throws type="org.freesmartphone.GSM" />
 127       <fso:throws type="org.freesmartphone" />
 128     </method>
 129
 130     <signal name="Status">
 131       <doc:doc>
 132         <doc:description>
 133           Sent whenever there is v.24 incoming status change on a virtual channel.
 134         </doc:description>
 135       </doc:doc>
 136       <arg type="s" name="status">
 137         <doc:doc>
 138           <doc:summary>
 139             The new v.24 status, which is a string combined of elements that make up the status. Valid elements are:
 140             [ul]
 141               [li]...[/li]
 142               [li]...[/li]
 143             [/ul]
 144           </doc:summary>
 145         </doc:doc>
 146       </arg>
 147     </signal>
 148
 149   </interface>
 150
 151 </node>
 152