| Top |  |
 |
 |
 |
Functions
| GQuark | nm_setting_gsm_error_quark () |
| NMSetting * | nm_setting_gsm_new () |
| const char * | nm_setting_gsm_get_number () |
| const char * | nm_setting_gsm_get_username () |
| const char * | nm_setting_gsm_get_password () |
| const char * | nm_setting_gsm_get_apn () |
| const char * | nm_setting_gsm_get_network_id () |
| const char * | nm_setting_gsm_get_pin () |
| gboolean | nm_setting_gsm_get_home_only () |
| NMSettingSecretFlags | nm_setting_gsm_get_pin_flags () |
| NMSettingSecretFlags | nm_setting_gsm_get_password_flags () |
| int | nm_setting_gsm_get_network_type () |
| guint32 | nm_setting_gsm_get_allowed_bands () |
Properties
| guint | allowed-bands | Read / Write / Construct |
| gchar * | apn | Read / Write |
| gboolean | home-only | Read / Write |
| gchar * | network-id | Read / Write |
| gint | network-type | Read / Write / Construct |
| gchar * | number | Read / Write |
| gchar * | password | Read / Write |
| guint | password-flags | Read / Write |
| gchar * | pin | Read / Write |
| guint | pin-flags | Read / Write |
| gchar * | username | Read / Write |
Types and Values
| #define | NM_SETTING_GSM_SETTING_NAME |
| enum | NMSettingGsmError |
| #define | NM_SETTING_GSM_ERROR |
| #define | NM_SETTING_GSM_NUMBER |
| #define | NM_SETTING_GSM_USERNAME |
| #define | NM_SETTING_GSM_PASSWORD |
| #define | NM_SETTING_GSM_PASSWORD_FLAGS |
| #define | NM_SETTING_GSM_APN |
| #define | NM_SETTING_GSM_NETWORK_ID |
| #define | NM_SETTING_GSM_PIN |
| #define | NM_SETTING_GSM_PIN_FLAGS |
| #define | NM_SETTING_GSM_HOME_ONLY |
| #define | NM_SETTING_GSM_ALLOWED_BANDS |
| #define | NM_SETTING_GSM_NETWORK_TYPE |
| enum | NMSettingGsmNetworkType |
| enum | NMSettingGsmNetworkBand |
| #define | NM_SETTING_GSM_BANDS_MAX |
Object Hierarchy
GEnum ├── NMSettingGsmError ├── NMSettingGsmNetworkBand ╰── NMSettingGsmNetworkType GObject ╰── NMSetting ╰── NMSettingGsm
Description
The NMSettingGsm object is a NMSetting subclass that describes properties that allow connections to 3GPP-based mobile broadband networks, including those using GPRS/EDGE and UMTS/HSPA technology.
Functions
nm_setting_gsm_error_quark ()
GQuark
nm_setting_gsm_error_quark (void);
Registers an error quark for NMSettingGsm if necessary.
nm_setting_gsm_new ()
NMSetting *
nm_setting_gsm_new (void);
Creates a new NMSettingGsm object with default values.
nm_setting_gsm_get_network_id ()
const char *
nm_setting_gsm_get_network_id (NMSettingGsm *setting);
nm_setting_gsm_get_pin_flags ()
NMSettingSecretFlags
nm_setting_gsm_get_pin_flags (NMSettingGsm *setting);
nm_setting_gsm_get_password_flags ()
NMSettingSecretFlags
nm_setting_gsm_get_password_flags (NMSettingGsm *setting);
nm_setting_gsm_get_network_type ()
int
nm_setting_gsm_get_network_type (NMSettingGsm *setting);
nm_setting_gsm_get_network_type has been deprecated since version 0.9.10 and should not be used in newly-written code.
No longer used. Network type setting should be done talking to ModemManager directly.
nm_setting_gsm_get_allowed_bands ()
guint32
nm_setting_gsm_get_allowed_bands (NMSettingGsm *setting);
nm_setting_gsm_get_allowed_bands has been deprecated since version 0.9.10 and should not be used in newly-written code.
No longer used. Bands setting should be done talking to ModemManager directly.
Types and Values
enum NMSettingGsmError
Members
|
unknown or unclassified error |
||
|
the property was invalid |
||
|
the property was missing and is required |
||
|
the required NMSettingSerial is missing in the connection |
enum NMSettingGsmNetworkType
NMSettingGsmNetworkType has been deprecated since version 0.9.10 and should not be used in newly-written code.
No longer used.
NMSettingGsmNetworkType values indicate the allowed access technologies the device may use when connecting to this network.
Members
|
any access technology may be used |
||
|
only 3G-type (UMTS and HSPA) technologies may be used |
||
|
only 2G-type (GPRS and EDGE) technologies may be used |
||
|
3G-type technologies are preferred but 2G-type technologies may be used as a fallback |
||
|
2G-type technologies are preferred but 3G-type technologies may be used as a fallback |
||
|
4G/LTE-type technologies are preferred but 3G/2/-type technologies may be used as a fallback |
||
|
only 4G/LTE type technologies may be used |
enum NMSettingGsmNetworkBand
NMSettingGsmNetworkBand has been deprecated since version 0.9.10 and should not be used in newly-written code.
No longer used.
NMSettingGsmNetworkBand values indicate the allowed frequency bands the device may use when connecting to this network.
Members
|
unknown or no band specified |
||
|
any band is allowed |
||
|
900 MHz original GSM band |
||
|
1800 MHz DCS band |
||
|
US 1900 MHz PCS band |
||
|
US 850 MHz Cellular band |
||
|
WCDMA 3GPP UMTS 2100 MHz (Class I) |
||
|
WCDMA 3GPP UMTS 1800 MHz (Class III) |
||
|
WCDMA 3GPP AWS 1700/2100 MHz (Class IV) |
||
|
WCDMA 3GPP UMTS 800 MHz (Class VI) |
||
|
WCDMA 3GPP UMTS 850 MHz (Class V) |
||
|
WCDMA 3GPP UMTS 900 MHz (Class VIII) |
||
|
WCDMA 3GPP UMTS 1700 MHz (Class IX) |
||
|
WCDMA 3GPP UMTS 1900 MHz (Class II) |
||
|
WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) |
NM_SETTING_GSM_BANDS_MAX
#define NM_SETTING_GSM_BANDS_MAX
NM_SETTING_GSM_BANDS_MAX has been deprecated since version 0.9.10 and should not be used in newly-written code.
No longer used.
NM_SETTING_GSM_BANDS_MAX macro indicate the maximal value that can be used as the allowed frequency bands (“allowed-bands” property).
Property Details
The “allowed-bands” property
“allowed-bands” guint
Bitfield of allowed frequency bands. Note that not all devices allow frequency band control. Permitted values are those specified by NMSettingGsmNetworkBand.
NMSettingGsm:allowed-bands has been deprecated since version 0.9.10 and should not be used in newly-written code.
No longer used. Band setting should be done by talking to ModemManager directly.
Owner: NMSettingGsm
Flags: Read / Write / Construct
Allowed values: <= 16383
Default value: 1
The “apn” property
“apn” gchar *
The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
Owner: NMSettingGsm
Flags: Read / Write
Default value: NULL
The “home-only” property
“home-only” gboolean
When TRUE, only connections to the home network will be allowed.
Connections to roaming networks will not be made.
Owner: NMSettingGsm
Flags: Read / Write
Default value: FALSE
The “network-id” property
“network-id” gchar *
The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.
Owner: NMSettingGsm
Flags: Read / Write
Default value: NULL
The “network-type” property
“network-type” gint
Network preference to force the device to only use specific network
technologies. The permitted values are NM_SETTING_GSM_NETWORK_TYPE_ANY,
NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA,
NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE,
NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA,
NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE,
NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G, and
NM_SETTING_GSM_NETWORK_TYPE_4G. Note that not all devices allow network
preference control.
NMSettingGsm:network-type has been deprecated since version 0.9.10 and should not be used in newly-written code.
No longer used. Network type setting should be done by talking to ModemManager directly.
Owner: NMSettingGsm
Flags: Read / Write / Construct
Allowed values: [-1,5]
Default value: -1
The “number” property
“number” gchar *
Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.
Owner: NMSettingGsm
Flags: Read / Write
Default value: NULL
The “password” property
“password” gchar *
The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.
Owner: NMSettingGsm
Flags: Read / Write
Default value: NULL
The “password-flags” property
“password-flags” guint
Flags indicating how to handle the “password” property.
Owner: NMSettingGsm
Flags: Read / Write
Allowed values: <= 7
Default value: 0
The “pin” property
“pin” gchar *
If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.
Owner: NMSettingGsm
Flags: Read / Write
Default value: NULL
The “pin-flags” property
“pin-flags” guint
Flags indicating how to handle the “pin” property.
Owner: NMSettingGsm
Flags: Read / Write
Allowed values: <= 7
Default value: 0
The “username” property
“username” gchar *
The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.
Owner: NMSettingGsm
Flags: Read / Write
Default value: NULL