Warning: Can't synchronize with repository "(default)" (No changeset 96d22ec3fa3ef6de3ea8dc0d7d398adc9aa071cf in the repository). Look in the Trac log for more information.

source: Dbus API specifications/html/org.freesmartphone.GSM.PDP.html @ c46e113

Revision c46e113, 4.9 KB checked in by Michael 'Mickey' Lauer <mickey@…>, 5 years ago (diff)
  • add missing 'Incoming' signal for org.freesmartphone.Phone.Call
  • remove german Umlaute
  • add warning in autogenerated docs, regenerate everything
  • Property mode set to 100644
Line 
1
2<!-- Warning: This file has been autogenerated by tools/makedoc.py. Manual edits will be overwritten. -->
3<html>
4    <head>
5        <title>freesmartphone.org GSM Packet Data Protocol Interface</title>
6        <link rel="stylesheet" type="text/css" href="http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/style.css;hb=HEAD" />
7    </head>
8    <body>
9    <div class="topbox">freesmartphone.org Framework DBus Interface Specification</div>
10
11
12<h1>org.freesmartphone.GSM.PDP</h1><h2>Description</h2>
13<p>The Packet Data Protocol interface is used to set up  binary data connections that allow you to transfer  data over the TCP/IP protocol family routed  via IP-based 2.5/3G provider networks.</p>
14<h2>Namespace</h2>
15<p><tt>org.freesmartphone.GSM.PDP</tt></p>
16<h2>Methods</h2><ul>
17<li><a href="#ListGprsClasses">ListGprsClasses</a></li>
18<li><a href="#GetCurrentGprsClass">GetCurrentGprsClass</a></li>
19<li><a href="#SetCurrentGprsClass">SetCurrentGprsClass</a></li>
20<li><a href="#ActivateContext">ActivateContext</a></li>
21<li><a href="#DeactivateContext">DeactivateContext</a></li>
22<li><a href="#GetContextStatus">GetContextStatus</a></li>
23</ul>
24<h2>Signals</h2><ul>
25<li><a href="#ContextStatus">ContextStatus</a></li>
26</ul>
27<h2>Errors</h2><ul>
28<li><a href="#NotFound">NotFound</a></li>
29</ul>
30<h1>Methods</h1><h3><a name="ListGprsClasses">ListGprsClasses</a> ( ) &rarr; as</h3>
31<p><i>Description:</i> List available GPRS device classes.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS=?, see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Returns</h4><i>as: classes</i><p>The available GPRS device classes.</p>
32<h3><a name="GetCurrentGprsClass">GetCurrentGprsClass</a> ( ) &rarr; s</h3>
33<p><i>Description:</i> Retrieves the current GPRS device class mode.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS?, see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Returns</h4><i>s: device_class</i><p>The GPRS device class mode.</p>
34<h3><a name="SetCurrentGprsClass">SetCurrentGprsClass</a> ( s )</h3>
35<p><i>Description:</i> Sets the current GPRS device class mode.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS=(device_class), see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Parameters</h4><i>s: device_class</i><p>The GPRS device class mode.</p>
36<h3><a name="ActivateContext">ActivateContext</a> ( sss ) &rarr; i</h3>
37<p><i>Description:</i> Request a PDP context activation to an IP-based network service provider and launch a ppp session.</p><p><div class="rationale"><p>This command might change your network default route.</p></div></p><h4>Parameters</h4><i>s: apn</i><p>The access point name to connect to.</p><i>s: username</i><p>The user name to authenticate with.</p><i>s: password</i><p>The password to authenticate with.</p><h4>Returns</h4><i>i: index</i><p>An index to identify context status changes.</p>
38<h3><a name="DeactivateContext">DeactivateContext</a> ( i )</h3>
39<p><i>Description:</i> Cancel an ongoing ppp session and request a PDP context deactivation.</p><p><div class="rationale"><p>This command might change your network default route.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The context to deactivate.</p>
40<h3><a name="GetContextStatus">GetContextStatus</a> ( i ) &rarr; s</h3>
41<p><i>Description:</i> Retrieve the current PDP context status.</p><h4>Parameters</h4><i>i: index</i><p>The context to inquire.</p><h4>Returns</h4><i>s: status</i><p>The context status. See 'ContextStatus' for valid values.</p>
42<h1>Signals</h1><h3><h3><a name="ContextStatus">ContextStatus</a> ( isa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a pdp context in the system.</p><h4>Parameters</h4><i>i: id</i><p>The index of the context that changed its status or properties.</p><i>s: status</i><p>The new status of the context. Expected values are:  <ul>  <li>"incoming" = The context is incoming (but not yet accepted),</li>  <li>"outgoing" = The context is outgoing (but not yet established),</li>  <li>"active" = The context is active (you have a new default route),</li>  <li>"held" = The context is being held (interrupted by a voice call) [OPTIONAL],</li>  <li>"released" = The context is being released.</li>  </ul>  Further information can be part of the properties.</p><i>a{sv}: properties</i><p>An array of property values. Note that properties are optional.  Expected tuples are:  <ul>  <li>( "reason", string ) = The reason for the status change,</li>  [li( "apn", string ) = The number of the access point.</li>  </ul></p></h3>
43<h1>Errors</h1><h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the specified PDP context is not present.</p>
44
45    <hr/>
46    <small>
47    | Specified 2008 by the <a href="http://www.freesmartphone.org">Freesmartphone.org</a> team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org
48    </small>
49    <hr/>
50    </body>
51</html>
52
Note: See TracBrowser for help on using the repository browser.