Struct SettingGsm 

pub struct SettingGsm { /* private fields */ }

GSM-based Mobile Broadband Settings

Properties

apn

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.

If the APN is unset (the default) then it may be detected based on “auto-config” setting. The property can be explicitly set to the empty string to prevent that and use no APN.

Readable | Writeable

auto-config

When true, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.

Readable | Writeable

device-id

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.

Readable | Writeable

home-only

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

Readable | Writeable

initial-eps-bearer-apn

For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.

Readable | Writeable

initial-eps-bearer-configure

For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.

Readable | Writeable

initial-eps-bearer-noauth

For LTE modems, this sets NOAUTH authentication method for the initial EPS bearer that is set up when attaching to the network. If true, do not require the other side to authenticate itself to the client. If false, require authentication from the remote side. In almost all cases, this should be true.

Readable | Writeable

initial-eps-bearer-password

For LTE modems, this sets the password for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.

Readable | Writeable

initial-eps-bearer-password-flags

Flags indicating how to handle the #NMSettingGsm:initial-eps-bearer-password property.

Readable | Writeable

initial-eps-bearer-refuse-chap

For LTE modems, this disables CHAP authentication method for the initial EPS bearer that is set up when attaching to the network.

Readable | Writeable

initial-eps-bearer-refuse-eap

For LTE modems, this disables EAP authentication method for the initial EPS bearer that is set up when attaching to the network.

Readable | Writeable

initial-eps-bearer-refuse-mschap

For LTE modems, this disables MSCHAP authentication method for the initial EPS bearer that is set up when attaching to the network.

Readable | Writeable

initial-eps-bearer-refuse-mschapv2

For LTE modems, this disables MSCHAPV2 authentication method for the initial EPS bearer that is set up when attaching to the network.

Readable | Writeable

initial-eps-bearer-refuse-pap

For LTE modems, this disables PAP authentication method for the initial EPS bearer that is set up when attaching to the network.

Readable | Writeable

initial-eps-bearer-username

For LTE modems, this sets the username for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.

Readable | Writeable

mtu

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

Readable | Writeable

network-id

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.

Readable | Writeable

number

Legacy setting that used to help establishing PPP data sessions for GSM-based modems.

Readable | Writeable

password

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.

Readable | Writeable

password-flags

Flags indicating how to handle the #NMSettingGsm:password property.

Readable | Writeable

pin

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.

Readable | Writeable

pin-flags

Flags indicating how to handle the #NMSettingGsm:pin property.

Readable | Writeable

sim-id

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 #NMSettingGsm:device-id which contains a SIM card matching the given identifier.

Readable | Writeable

sim-operator-id

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 #NMSettingGsm:device-id and #NMSettingGsm:sim-id which contains a SIM card provisioned by the given operator.

Readable | Writeable

username

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.

Readable | Writeable

Setting

name

The setting’s name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example “ppp” or “802-11-wireless” or “802-3-ethernet”.

Readable

Implements

SettingExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl SettingGsm

pub fn new() -> SettingGsm

Creates a new #NMSettingGsm object with default values.

Returns

the new empty #NMSettingGsm object

pub fn builder() -> SettingGsmBuilder

Creates a new builder-pattern struct instance to construct SettingGsm objects.

This method returns an instance of SettingGsmBuilder which can be used to create SettingGsm objects.

pub fn apn(&self) -> GString

Returns

the #NMSettingGsm:apn property of the setting

pub fn device_id(&self) -> GString

Available on crate feature v1_2 only.

Returns

the #NMSettingGsm:device-id property of the setting

pub fn is_home_only(&self) -> bool

Returns

the #NMSettingGsm:home-only property of the setting

pub fn mtu(&self) -> u32

Available on crate feature v1_8 only.

Returns

the #NMSettingGsm:mtu property of the setting

pub fn network_id(&self) -> GString

Returns

the #NMSettingGsm:network-id property of the setting

pub fn number(&self) -> GString

👎Deprecated: Since 1.16

Deprecated since 1.16

User-provided values for this setting are no longer used.

Returns

the #NMSettingGsm:number property of the setting

pub fn password(&self) -> GString

Returns

the #NMSettingGsm:password property of the setting

pub fn password_flags(&self) -> SettingSecretFlags

Returns

the #NMSettingSecretFlags pertaining to the #NMSettingGsm:password

pub fn pin(&self) -> GString

Returns

the #NMSettingGsm:pin property of the setting

pub fn pin_flags(&self) -> SettingSecretFlags

Returns

the #NMSettingSecretFlags pertaining to the #NMSettingGsm:pin

pub fn sim_id(&self) -> GString

Available on crate feature v1_2 only.

Returns

the #NMSettingGsm:sim-id property of the setting

pub fn sim_operator_id(&self) -> GString

Available on crate feature v1_2 only.

Returns

the #NMSettingGsm:sim-operator-id property of the setting

pub fn username(&self) -> GString

Returns

the #NMSettingGsm:username property of the setting

pub fn set_apn(&self, apn: Option<&str>)

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.

If the APN is unset (the default) then it may be detected based on “auto-config” setting. The property can be explicitly set to the empty string to prevent that and use no APN.

pub fn set_device_id(&self, device_id: Option<&str>)

Available on crate feature v1_2 only.

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.

pub fn set_home_only(&self, home_only: bool)

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

pub fn set_mtu(&self, mtu: u32)

Available on crate feature v1_8 only.

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

pub fn set_network_id(&self, network_id: Option<&str>)

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.

pub fn set_number(&self, number: Option<&str>)

👎Deprecated: Since 1.16

Legacy setting that used to help establishing PPP data sessions for GSM-based modems.

Deprecated since 1.16

User-provided values for this setting are no longer used.

pub fn set_password(&self, password: Option<&str>)

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.

pub fn set_password_flags(&self, password_flags: SettingSecretFlags)

Flags indicating how to handle the #NMSettingGsm:password property.

pub fn set_pin(&self, pin: Option<&str>)

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.

pub fn set_pin_flags(&self, pin_flags: SettingSecretFlags)

Flags indicating how to handle the #NMSettingGsm:pin property.

pub fn set_sim_id(&self, sim_id: Option<&str>)

Available on crate feature v1_2 only.

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 #NMSettingGsm:device-id which contains a SIM card matching the given identifier.

pub fn set_sim_operator_id(&self, sim_operator_id: Option<&str>)

Available on crate feature v1_2 only.

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 #NMSettingGsm:device-id and #NMSettingGsm:sim-id which contains a SIM card provisioned by the given operator.

pub fn set_username(&self, username: Option<&str>)

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.

pub fn connect_apn_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_device_id_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_2 only.

pub fn connect_home_only_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_mtu_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_8 only.

pub fn connect_network_id_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_number_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated: Since 1.16

pub fn connect_password_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_password_flags_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_pin_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_pin_flags_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_sim_id_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_2 only.

pub fn connect_sim_operator_id_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_2 only.

pub fn connect_username_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for SettingGsm

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SettingGsm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SettingGsm

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SettingGsm

type ParamSpec = ParamSpecObject

type SetValue = SettingGsm

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, SettingGsm>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingGsm

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SettingGsm

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for SettingGsm

type Parent = Setting

impl<OT: ObjectType> PartialEq<OT> for SettingGsm

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SettingGsm

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SettingGsm

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingGsm

impl IsA<Setting> for SettingGsm