From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- docs/libnm-util/html/NMSettingGsm.html | 342 +++++++++++++++++++++++++++++---- 1 file changed, 308 insertions(+), 34 deletions(-) (limited to 'docs/libnm-util/html/NMSettingGsm.html') diff --git a/docs/libnm-util/html/NMSettingGsm.html b/docs/libnm-util/html/NMSettingGsm.html index 4a2d7925..439dea0d 100644 --- a/docs/libnm-util/html/NMSettingGsm.html +++ b/docs/libnm-util/html/NMSettingGsm.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ Up Home libnm-util Reference Manual -Next +Next Top @@ -35,13 +35,16 @@

NMSettingGsm

-

NMSettingGsm

+

NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties

Synopsis

-
#define             NM_SETTING_GSM_SETTING_NAME
+
+#include <nm-setting-gsm.h>
+
+#define             NM_SETTING_GSM_SETTING_NAME
 enum                NMSettingGsmError;
 #define             NM_TYPE_SETTING_GSM_ERROR
 #define             NM_SETTING_GSM_ERROR
@@ -107,6 +110,9 @@ const char *        
 
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.
@@ -121,16 +127,40 @@ const char *

enum NMSettingGsmError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_GSM_ERROR_UNKNOWN = 0,
 	NM_SETTING_GSM_ERROR_INVALID_PROPERTY,
 	NM_SETTING_GSM_ERROR_MISSING_PROPERTY,
 	NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING
 } NMSettingGsmError;
 

-

-

+

++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


NM_SETTING_GSM_ERROR_UNKNOWN
unknown or unclassified error
+
NM_SETTING_GSM_ERROR_INVALID_PROPERTY
the property was invalid
+
NM_SETTING_GSM_ERROR_MISSING_PROPERTY
the property was missing and is
+required
+
NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING
the required NMSettingSerial
+is missing in the connection
+
@@ -153,7 +183,15 @@ const char *

nm_setting_gsm_error_quark ()

GQuark              nm_setting_gsm_error_quark          (void);

+Registers an error quark for NMSettingGsm if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingGsm errors.
@@ -255,7 +293,43 @@ const char * NMSettingGsmNetworkType values indicate the allowed access technologies +the device may use when connecting to this network.

+
++ + + + + + + + + + + + + + + + + + + + + + +

NM_SETTING_GSM_NETWORK_TYPE_ANY

any access technology may be used +

NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA

only 3G-type (UMTS and HSPA) +technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE

only 2G-type (GPRS and EDGE) +technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA

3G-type technologies are +preferred but 2G-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE

2G-type technologies are +preferred but 3G-type technologies may be used as a fallback +
@@ -275,10 +349,93 @@ const char * NMSettingGsmNetworkBand values indicate the allowed frequency bands +the device may use when connecting to this network.

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_SETTING_GSM_BAND_UNKNOWN

unknown or no band specified +

NM_SETTING_GSM_BAND_ANY

any band is allowed +

NM_SETTING_GSM_BAND_EGSM

900 MHz original GSM band +

NM_SETTING_GSM_BAND_DCS

1800 MHz DCS band +

NM_SETTING_GSM_BAND_PCS

US 1900 MHz PCS band +

NM_SETTING_GSM_BAND_G850

US 850 MHz Cellular band +

NM_SETTING_GSM_BAND_U2100

WCDMA 3GPP UMTS 2100 MHz (Class I) +

NM_SETTING_GSM_BAND_U1800

WCDMA 3GPP UMTS 1800 MHz (Class III) +

NM_SETTING_GSM_BAND_U17IV

WCDMA 3GPP AWS 1700/2100 MHz (Class IV) +

NM_SETTING_GSM_BAND_U800

WCDMA 3GPP UMTS 800 MHz (Class VI) +

NM_SETTING_GSM_BAND_U850

WCDMA 3GPP UMTS 850 MHz (Class V) +

NM_SETTING_GSM_BAND_U900

WCDMA 3GPP UMTS 900 MHz (Class VIII) +

NM_SETTING_GSM_BAND_U17IX

WCDMA 3GPP UMTS 1700 MHz (Class IX) +

NM_SETTING_GSM_BAND_U1900

WCDMA 3GPP UMTS 1900 MHz (Class II) +

NM_SETTING_GSM_BAND_U2600

WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) +
@@ -315,70 +472,186 @@ const char *

nm_setting_gsm_new ()

NMSetting *         nm_setting_gsm_new                  (void);

+Creates a new NMSettingGsm object with default values.

+
++ + + + +

Returns :

the new empty NMSettingGsm object

nm_setting_gsm_get_number ()

const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "number" property of the setting

nm_setting_gsm_get_username ()

const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "username" property of the setting

nm_setting_gsm_get_password ()

const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "password" property of the setting

nm_setting_gsm_get_apn ()

const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "apn" property of the setting

nm_setting_gsm_get_network_id ()

const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "network-id" property of the setting

nm_setting_gsm_get_network_type ()

int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "network-type" property of the setting

nm_setting_gsm_get_allowed_bands ()

guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "allowed-bands" property of the setting

nm_setting_gsm_get_pin ()

const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "pin" property of the setting

nm_setting_gsm_get_home_only ()

gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "home-only" property of the setting
@@ -428,7 +701,8 @@ const char * "allowed-bands" guint : Read / Write / Construct

Bitfield of allowed frequency bands. Note that not all devices allow -frequency band control. +frequency band control. Permitted values are those specified by +NMSettingGsmNetworkBand.

Allowed values: <= 1

Default value: 1

@@ -477,9 +751,9 @@ roaming control of the device is not otherwise possible. 
  "network-type"             gint                  : Read / Write / Construct

Network preference to force the device to only use specific network -technologies. The permitted values are: -1: any, 0: 3G only, -1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G. Note that not all -devices allow network preference control. +technologies. Permitted values are those specified by +NMSettingGsmNetworkType. Note that not all devices allow network +preference control.

Allowed values: [G_MAXULONG,3]

Default value: -1

@@ -490,9 +764,9 @@ devices allow network preference control. 
  "number"                   gchar*                : Read / Write

Number to dial when establishing a PPP data session with the GSM-based -mobile broadband network. In most cases, leave the number blank and a -number selecting the APN specified in the 'apn' property will be used -automatically when required. +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.

Default value: NULL

@@ -533,7 +807,7 @@ the device.

The "pin-flags" property

  "pin-flags"                guint                 : Read / Write

-Flags indicating how to handle "pin":. +Flags indicating how to handle "pin".

Allowed values: <= 7

Default value: 0

-- cgit 1.3.0-6-gf8a5