NMSettingAdsl

NMSettingAdsl — Describes ADSL-based properties

Synopsis

#define             NM_SETTING_ADSL_SETTING_NAME
#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
                    NMSettingAdsl;
                    NMSettingAdslClass;
NMSetting *         nm_setting_adsl_new                 (void);
const char *        nm_setting_adsl_get_username        (NMSettingAdsl *setting);
const char *        nm_setting_adsl_get_password        (NMSettingAdsl *setting);
const char *        nm_setting_adsl_get_protocol        (NMSettingAdsl *setting);
const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);
guint32             nm_setting_adsl_get_vpi             (NMSettingAdsl *setting);
guint32             nm_setting_adsl_get_vci             (NMSettingAdsl *setting);
NMSettingSecretFlags nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);

Object Hierarchy

  GObject
   +----NMSetting
         +----NMSettingAdsl

Properties

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

Description

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

Details

NM_SETTING_ADSL_SETTING_NAME

#define NM_SETTING_ADSL_SETTING_NAME "adsl"


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"


NMSettingAdsl

typedef struct _NMSettingAdsl NMSettingAdsl;

NMSettingAdslClass

typedef struct {
	NMSettingClass parent;
} NMSettingAdslClass;


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

setting :

the NMSettingAdsl

Returns :

the "username" property of the setting

nm_setting_adsl_get_password ()

const char *        nm_setting_adsl_get_password        (NMSettingAdsl *setting);

setting :

the NMSettingAdsl

Returns :

the "password" property of the setting

nm_setting_adsl_get_protocol ()

const char *        nm_setting_adsl_get_protocol        (NMSettingAdsl *setting);

setting :

the NMSettingAdsl

Returns :

the "protocol" property of the setting

nm_setting_adsl_get_encapsulation ()

const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);

setting :

the NMSettingAdsl

Returns :

the "encapsulation" property of the setting

nm_setting_adsl_get_vpi ()

guint32             nm_setting_adsl_get_vpi             (NMSettingAdsl *setting);

setting :

the NMSettingAdsl

Returns :

the "vpi" property of the setting

nm_setting_adsl_get_vci ()

guint32             nm_setting_adsl_get_vci             (NMSettingAdsl *setting);

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

setting :

the NMSettingAdsl

Returns :

the NMSettingSecretFlags pertaining to the "password"

Property Details

The "encapsulation" property

  "encapsulation"            gchar*                : Read / Write

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

Default value: NULL


The "password" property

  "password"                 gchar*                : Read / Write

Password used to authenticate with the ADSL service.

Default value: NULL


The "password-flags" property

  "password-flags"           NMSettingSecretFlags  : Read / Write

Flags indicating how to handle the "password" property.


The "protocol" property

  "protocol"                 gchar*                : Read / Write

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

Default value: NULL


The "username" property

  "username"                 gchar*                : Read / Write

Username used to authenticate with the ADSL service.

Default value: NULL


The "vci" property

  "vci"                      guint                 : Read / Write

VCI of ADSL connection

Allowed values: <= 65536

Default value: 0


The "vpi" property

  "vpi"                      guint                 : Read / Write

VPI of ADSL connection

Allowed values: <= 65536

Default value: 0