NMSettingAdsl

NMSettingAdsl — Describes ADSL-based properties

Functions

GQuark nm_setting_adsl_error_quark ()
NMSetting * nm_setting_adsl_new ()
const char * nm_setting_adsl_get_username ()
const char * nm_setting_adsl_get_password ()
const char * nm_setting_adsl_get_protocol ()
const char * nm_setting_adsl_get_encapsulation ()
guint32 nm_setting_adsl_get_vpi ()
guint32 nm_setting_adsl_get_vci ()
NMSettingSecretFlags nm_setting_adsl_get_password_flags ()

Properties

gchar * encapsulation Read / Write
gchar * password Read / Write
guint password-flags Read / Write
gchar * protocol Read / Write
gchar * username Read / Write
guint vci Read / Write
guint vpi Read / Write

Types and Values

#define NM_SETTING_ADSL_SETTING_NAME
enum NMSettingAdslError
#define NM_SETTING_ADSL_ERROR
#define NM_SETTING_ADSL_USERNAME
#define NM_SETTING_ADSL_PASSWORD
#define NM_SETTING_ADSL_PASSWORD_FLAGS
#define NM_SETTING_ADSL_PROTOCOL
#define NM_SETTING_ADSL_ENCAPSULATION
#define NM_SETTING_ADSL_VPI
#define NM_SETTING_ADSL_VCI
#define NM_SETTING_ADSL_PROTOCOL_PPPOA
#define NM_SETTING_ADSL_PROTOCOL_PPPOE
#define NM_SETTING_ADSL_PROTOCOL_IPOATM
#define NM_SETTING_ADSL_ENCAPSULATION_VCMUX
#define NM_SETTING_ADSL_ENCAPSULATION_LLC

Object Hierarchy

    GEnum
    ╰── NMSettingAdslError
    GObject
    ╰── NMSetting
        ╰── NMSettingAdsl

Includes

#include <nm-setting-adsl.h>

Description

The NMSettingAdsl object is a NMSetting subclass that describes properties of ADSL connections.

Functions

nm_setting_adsl_error_quark ()

GQuark
nm_setting_adsl_error_quark (void);

Registers an error quark for NMSettingAdsl if necessary.

Returns

the error quark used for NMSettingAdsl errors.

nm_setting_adsl_new ()

NMSetting *
nm_setting_adsl_new (void);

Creates a new NMSettingAdsl object with default values.

Returns

the new empty NMSettingAdsl object

nm_setting_adsl_get_username ()

const char *
nm_setting_adsl_get_username (NMSettingAdsl *setting);

Parameters

setting

the NMSettingAdsl

  

Returns

the “username” property of the setting

nm_setting_adsl_get_password ()

const char *
nm_setting_adsl_get_password (NMSettingAdsl *setting);

Parameters

setting

the NMSettingAdsl

  

Returns

the “password” property of the setting

nm_setting_adsl_get_protocol ()

const char *
nm_setting_adsl_get_protocol (NMSettingAdsl *setting);

Parameters

setting

the NMSettingAdsl

  

Returns

the “protocol” property of the setting

nm_setting_adsl_get_encapsulation ()

const char *
nm_setting_adsl_get_encapsulation (NMSettingAdsl *setting);

Parameters

setting

the NMSettingAdsl

  

Returns

the “encapsulation” property of the setting

nm_setting_adsl_get_vpi ()

guint32
nm_setting_adsl_get_vpi (NMSettingAdsl *setting);

Parameters

setting

the NMSettingAdsl

  

Returns

the “vpi” property of the setting

nm_setting_adsl_get_vci ()

guint32
nm_setting_adsl_get_vci (NMSettingAdsl *setting);

Parameters

setting

the NMSettingAdsl

  

Returns

the “vci” property of the setting

nm_setting_adsl_get_password_flags ()

NMSettingSecretFlags
nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);

Parameters

setting

the NMSettingAdsl

  

Returns

the NMSettingSecretFlags pertaining to the “password”

Types and Values

NM_SETTING_ADSL_SETTING_NAME

#define NM_SETTING_ADSL_SETTING_NAME "adsl"

enum NMSettingAdslError

Members

NM_SETTING_ADSL_ERROR_UNKNOWN

unknown or unclassified error

  

NM_SETTING_ADSL_ERROR_INVALID_PROPERTY

the property was invalid

  

NM_SETTING_ADSL_ERROR_MISSING_PROPERTY

the property was missing and is required

  

NM_SETTING_ADSL_ERROR

#define NM_SETTING_ADSL_ERROR nm_setting_adsl_error_quark ()

NM_SETTING_ADSL_USERNAME

#define NM_SETTING_ADSL_USERNAME            "username"

NM_SETTING_ADSL_PASSWORD

#define NM_SETTING_ADSL_PASSWORD            "password"

NM_SETTING_ADSL_PASSWORD_FLAGS

#define NM_SETTING_ADSL_PASSWORD_FLAGS      "password-flags"

NM_SETTING_ADSL_PROTOCOL

#define NM_SETTING_ADSL_PROTOCOL            "protocol"

NM_SETTING_ADSL_ENCAPSULATION

#define NM_SETTING_ADSL_ENCAPSULATION       "encapsulation"

NM_SETTING_ADSL_VPI

#define NM_SETTING_ADSL_VPI                 "vpi"

NM_SETTING_ADSL_VCI

#define NM_SETTING_ADSL_VCI                 "vci"

NM_SETTING_ADSL_PROTOCOL_PPPOA

#define NM_SETTING_ADSL_PROTOCOL_PPPOA      "pppoa"

NM_SETTING_ADSL_PROTOCOL_PPPOE

#define NM_SETTING_ADSL_PROTOCOL_PPPOE      "pppoe"

NM_SETTING_ADSL_PROTOCOL_IPOATM

#define NM_SETTING_ADSL_PROTOCOL_IPOATM     "ipoatm"

NM_SETTING_ADSL_ENCAPSULATION_VCMUX

#define NM_SETTING_ADSL_ENCAPSULATION_VCMUX "vcmux"

NM_SETTING_ADSL_ENCAPSULATION_LLC

#define NM_SETTING_ADSL_ENCAPSULATION_LLC   "llc"

Property Details

The “encapsulation” property

  “encapsulation”            gchar *

Encapsulation of ADSL connection. Can be "vcmux" or "llc".

Flags: Read / Write

Default value: NULL

The “password” property

  “password”                 gchar *

Password used to authenticate with the ADSL service.

Flags: Read / Write

Default value: NULL

The “password-flags” property

  “password-flags”           guint

Flags indicating how to handle the “password” property.

Flags: Read / Write

Allowed values: <= 7

Default value: 0

The “protocol” property

  “protocol”                 gchar *

ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".

Flags: Read / Write

Default value: NULL

The “username” property

  “username”                 gchar *

Username used to authenticate with the ADSL service.

Flags: Read / Write

Default value: NULL

The “vci” property

  “vci”                      guint

VCI of ADSL connection

Flags: Read / Write

Allowed values: <= 65536

Default value: 0

The “vpi” property

  “vpi”                      guint

VPI of ADSL connection

Flags: Read / Write

Allowed values: <= 65536

Default value: 0

Generated by GTK-Doc V1.24