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
#define             NM_SETTING_GSM_DEVICE_ID
#define             NM_SETTING_GSM_SIM_ID
#define             NM_SETTING_GSM_SIM_OPERATOR_ID
                    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);
const char *        nm_setting_gsm_get_device_id        (NMSettingGsm *setting);
const char *        nm_setting_gsm_get_sim_id           (NMSettingGsm *setting);
const char *        nm_setting_gsm_get_sim_operator_id  (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

Properties

  "apn"                      gchar*                : Read / Write
  "device-id"                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
  "sim-id"                   gchar*                : Read / Write
  "sim-operator-id"          gchar*                : Read / Write
  "username"                 gchar*                : Read / Write

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.

Details

NM_SETTING_GSM_SETTING_NAME

#define NM_SETTING_GSM_SETTING_NAME "gsm"


NM_SETTING_GSM_NUMBER

#define NM_SETTING_GSM_NUMBER          "number"


NM_SETTING_GSM_USERNAME

#define NM_SETTING_GSM_USERNAME        "username"


NM_SETTING_GSM_PASSWORD

#define NM_SETTING_GSM_PASSWORD        "password"


NM_SETTING_GSM_PASSWORD_FLAGS

#define NM_SETTING_GSM_PASSWORD_FLAGS  "password-flags"


NM_SETTING_GSM_APN

#define NM_SETTING_GSM_APN             "apn"


NM_SETTING_GSM_NETWORK_ID

#define NM_SETTING_GSM_NETWORK_ID      "network-id"


NM_SETTING_GSM_PIN

#define NM_SETTING_GSM_PIN             "pin"


NM_SETTING_GSM_PIN_FLAGS

#define NM_SETTING_GSM_PIN_FLAGS       "pin-flags"


NM_SETTING_GSM_HOME_ONLY

#define NM_SETTING_GSM_HOME_ONLY       "home-only"


NM_SETTING_GSM_DEVICE_ID

#define NM_SETTING_GSM_DEVICE_ID       "device-id"


NM_SETTING_GSM_SIM_ID

#define NM_SETTING_GSM_SIM_ID          "sim-id"


NM_SETTING_GSM_SIM_OPERATOR_ID

#define NM_SETTING_GSM_SIM_OPERATOR_ID "sim-operator-id"


NMSettingGsm

typedef struct _NMSettingGsm 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_device_id ()

const char *        nm_setting_gsm_get_device_id        (NMSettingGsm *setting);

setting :

the NMSettingGsm

Returns :

the "device-id" property of the setting

Since 1.2


nm_setting_gsm_get_sim_id ()

const char *        nm_setting_gsm_get_sim_id           (NMSettingGsm *setting);

setting :

the NMSettingGsm

Returns :

the "sim-id" property of the setting

Since 1.2


nm_setting_gsm_get_sim_operator_id ()

const char *        nm_setting_gsm_get_sim_operator_id  (NMSettingGsm *setting);

setting :

the NMSettingGsm

Returns :

the "sim-operator-id" property of the setting

Since 1.2


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.

Default value: NULL


The "device-id" property

  "device-id"                gchar*                : Read / Write

The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.

Default value: NULL

Since 1.2


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.

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.

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.

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.

Default value: NULL


The "password-flags" property

  "password-flags"           NMSettingSecretFlags  : Read / Write

Flags indicating how to handle the "password" property.


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.

Default value: NULL


The "pin-flags" property

  "pin-flags"                NMSettingSecretFlags  : Read / Write

Flags indicating how to handle the "pin" property.


The "sim-id" property

  "sim-id"                   gchar*                : Read / Write

The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.

Default value: NULL

Since 1.2


The "sim-operator-id" property

  "sim-operator-id"          gchar*                : Read / Write

A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioined by the given operator.

Default value: NULL

Since 1.2


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.

Default value: NULL