From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm/html/NMSettingGsm.html | 872 ++++++++++++++++++++++---------------- 1 file changed, 503 insertions(+), 369 deletions(-) (limited to 'docs/libnm/html/NMSettingGsm.html') diff --git a/docs/libnm/html/NMSettingGsm.html b/docs/libnm/html/NMSettingGsm.html index f3bd95cd..2da1fa2e 100644 --- a/docs/libnm/html/NMSettingGsm.html +++ b/docs/libnm/html/NMSettingGsm.html @@ -2,34 +2,28 @@ -NMSettingGsm +libnm Reference Manual: NMSettingGsm - + - - - - - - - - - - + + + + + + +
@@ -37,66 +31,470 @@

NMSettingGsm

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

- +
-
-

Synopsis

-
#define             NM_SETTING_GSM_SETTING_NAME
-#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
-struct              NMSettingGsm;
-                    NMSettingGsmClass;
-NMSetting *         nm_setting_gsm_new                  (void);
-const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
-gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
-NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMSetting
-         +----NMSettingGsm
-
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+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 () +

Properties

-
-  "apn"                      gchar*                : Read / Write
-  "home-only"                gboolean              : Read / Write
-  "network-id"               gchar*                : Read / Write
-  "number"                   gchar*                : Read / Write
-  "password"                 gchar*                : Read / Write
-  "password-flags"           NMSettingSecretFlags  : Read / Write
-  "pin"                      gchar*                : Read / Write
-  "pin-flags"                NMSettingSecretFlags  : Read / Write
-  "username"                 gchar*                : Read / Write
+

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






+gchar *apnRead / Write
gbooleanhome-onlyRead / Write

+gchar *network-idRead / Write

+gchar *numberRead / Write

+gchar *passwordRead / Write
NMSettingSecretFlagspassword-flagsRead / Write

+gchar *pinRead / Write
NMSettingSecretFlagspin-flagsRead / Write

+gchar *usernameRead / Write

+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_GSM_SETTING_NAME
#defineNM_SETTING_GSM_NUMBER
#defineNM_SETTING_GSM_USERNAME
#defineNM_SETTING_GSM_PASSWORD
#defineNM_SETTING_GSM_PASSWORD_FLAGS
#defineNM_SETTING_GSM_APN
#defineNM_SETTING_GSM_NETWORK_ID
#defineNM_SETTING_GSM_PIN
#defineNM_SETTING_GSM_PIN_FLAGS
#defineNM_SETTING_GSM_HOME_ONLY
+
+
+

Object Hierarchy

+
    GObject
+    ╰── NMSetting
+        ╰── NMSettingGsm

Description

-

-The NMSettingGsm object is a NMSetting subclass that describes +

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. -

+networks, including those using GPRS/EDGE and UMTS/HSPA technology.

-

Details

+

Functions

+
+

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);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “number” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_username ()

+
const char *
+nm_setting_gsm_get_username (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “username” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_password ()

+
const char *
+nm_setting_gsm_get_password (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “password” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_apn ()

+
const char *
+nm_setting_gsm_get_apn (NMSettingGsm *setting);
+
+

Parameters

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

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);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “network-id” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_pin ()

+
const char *
+nm_setting_gsm_get_pin (NMSettingGsm *setting);
+
+

Parameters

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

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);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “home-only” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_pin_flags ()

+
NMSettingSecretFlags
+nm_setting_gsm_get_pin_flags (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the NMSettingSecretFlags pertaining to the “pin”

+

+
+
+
+
+

nm_setting_gsm_get_password_flags ()

+
NMSettingSecretFlags
+nm_setting_gsm_get_password_flags (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the NMSettingSecretFlags pertaining to the “password”

+

+
+
+
+
+

Types and Values

NM_SETTING_GSM_SETTING_NAME

#define NM_SETTING_GSM_SETTING_NAME "gsm"
@@ -176,346 +574,82 @@ networks, including those using GPRS/EDGE and UMTS/HSPA technology.
-
-
-

struct NMSettingGsm

-
struct NMSettingGsm;
-

-

-
-
-
-

NMSettingGsmClass

-
typedef struct {
-	NMSettingClass parent;
-} NMSettingGsmClass;
-
-

-

-
-
-
-

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_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
-
-
-
-

nm_setting_gsm_get_pin_flags ()

-
NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingGsm -

Returns :

the NMSettingSecretFlags pertaining to the "pin" -
-
-
-
-

nm_setting_gsm_get_password_flags ()

-
NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingGsm -

Returns :

the NMSettingSecretFlags pertaining to the "password" -
-

Property Details

-

The "apn" property

-
  "apn"                      gchar*                : Read / Write
-

-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. -

+

The “apn” property

+
  “apn”                      gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "home-only" property

-
  "home-only"                gboolean              : Read / Write
-

-When TRUE, only connections to the home network will be allowed. -Connections to roaming networks will not be made. -

+

The “home-only” property

+
  “home-only”                gboolean
+

+

Flags: Read / Write

Default value: FALSE

-

The "network-id" property

-
  "network-id"               gchar*                : Read / Write
-

-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. -

+

The “network-id” property

+
  “network-id”               gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "number" property

-
  "number"                   gchar*                : Read / Write
-

-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. -

+

The “number” property

+
  “number”                   gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "password" property

-
  "password"                 gchar*                : Read / Write
-

-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. -

+

The “password” property

+
  “password”                 gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "password-flags" property

-
  "password-flags"           NMSettingSecretFlags  : Read / Write
-

-Flags indicating how to handle the "password" property. -

+

The “password-flags” property

+
  “password-flags”           NMSettingSecretFlags
+

+

Flags: Read / Write

-

The "pin" property

-
  "pin"                      gchar*                : Read / Write
-

-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. -

+

The “pin” property

+
  “pin”                      gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "pin-flags" property

-
  "pin-flags"                NMSettingSecretFlags  : Read / Write
-

-Flags indicating how to handle the "pin" property. -

+

The “pin-flags” property

+
  “pin-flags”                NMSettingSecretFlags
+

+

Flags: Read / Write

-

The "username" property

-
  "username"                 gchar*                : Read / Write
-

-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. -

+

The “username” property

+
  “username”                 gchar *
+

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21 \ No newline at end of file -- cgit 1.3.0-6-gf8a5