freesmartphone.org GSM Packet Data Protocol Interface
Description
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 provider networks.
Namespace
org.freesmartphone.GSM.PDP
Methods
- SetCredentials
- GetCredentials
- ActivateContext
- DeactivateContext
- GetContextStatus
- InternalStatusUpdate
Signals
Properties
Errors
None
Methods
SetCredentials ( sss )
Description: Set the credentials for PDP context activation.
Parameters:*
s: apn The access point name to connect to.
s: username The user name to identify as.
s: password The password to identify as.
GetCredentials ( ) → sss
Description: Get the credentials for PDP context activation.
Returns:
s: apn The access point name to connect to.
s: username The user name to identify as.
s: password The password to identify as.
ActivateContext ( )
Description: Request a PDP context activation to an IP-based network service provider.
Implementation Note
Invocation of this command can change your network default route.
DeactivateContext ( )
Description: Cancel an ongoing ppp session and request a PDP context deactivation.
Implementation Note
This command might change your network default route.
GetContextStatus ( ) → sa{sv}
Description: Retrieve the current PDP context status.
Returns:
s: status The context status. See ContextStatus for a list of valid values.
a{sv}: properties The context status properties. See ContextStatus for details.
InternalStatusUpdate ( sa{sv} )
Description: This method is for internal use only.
Parameters:*
s: status Internal use only.
a{sv}: properties Internal use only.
Signals
ContextStatus ( sa{sv} )
Description: Sent whenever there is any status or property change on a pdp context in the system.
Parameters:
s: status The new status of the context. Expected values are:
- “incoming” = The context is incoming (but not yet accepted),
- “outgoing” = The context is outgoing (but not yet established),
- “active” = The context is active and has offered a route,
- “held” = The context has been interrupted,
- “released” = The context is released.
- “suspended” = The context is suspended due out of network coverage or another internal reason (for example network does not support simultaneous packet and voice data)
a{sv}: properties An array of property values. Note that properties are optional. Expected tuples are:
- ( “reason”, string ) = The reason for the status change,
- ( “apn”, string ) = The number of the access point.
Properties
RoamingAllowed - b : Read/Write
Description:
Specify wether an active PDP context is allowed while modem is roaming.
If set to false and network registration state indicates that the modem is roaming PDP context will automatically deactivated and no further activation will be possible until modem is not roaming anymore.