libnm-util Reference Manual: NMSettingAdsl

@@ -31,438 +37,74 @@

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

Synopsis

+#include <nm-setting-adsl.h>
+
+#define             NM_SETTING_ADSL_SETTING_NAME
+enum                NMSettingAdslError;
+#define             NM_SETTING_ADSL_ERROR
+GQuark              nm_setting_adsl_error_quark         (void);
+#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

    GEnum
-    ╰── NMSettingAdslError
-    GObject
-    ╰── NMSetting
-        ╰── NMSettingAdsl
++  GEnum
+   +----NMSettingAdslError
+
++  GObject
+   +----NMSetting
+         +----NMSettingAdsl

Includes

#include <nm-setting-adsl.h>
+Properties
++  "encapsulation"            gchar*                : Read / Write
+  "password"                 gchar*                : Read / Write
+  "password-flags"           guint                 : 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.

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”

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

Types and Values

Details

NM_SETTING_ADSL_SETTING_NAME

#define NM_SETTING_ADSL_SETTING_NAME "adsl"
@@ -472,42 +114,38 @@ nm_setting_adsl_get_password_flags (
 
 
-enum NMSettingAdslError
-
-Members
-
+enum NMSettingAdslError
+typedef enum {
+	NM_SETTING_ADSL_ERROR_UNKNOWN = 0,              /*< nick=UnknownError >*/
+	NM_SETTING_ADSL_ERROR_INVALID_PROPERTY,         /*< nick=InvalidProperty >*/
+	NM_SETTING_ADSL_ERROR_MISSING_PROPERTY          /*< nick=MissingProperty >*/
+} NMSettingAdslError;
+
+
---++
-
-
+
-
-
-
+
-
-
-
+
-
 





 
 
 NM_SETTING_ADSL_ERROR_UNKNOWN 
-unknown or unclassified error
+ NM_SETTING_ADSL_ERROR_UNKNOWN unknown or unclassified error
  
 
 NM_SETTING_ADSL_ERROR_INVALID_PROPERTY 
-the property was invalid
+ 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_MISSING_PROPERTY the property was missing and is
+required
  
 
 
 
 
-
 
 
 NM_SETTING_ADSL_ERROR
@@ -518,6 +156,24 @@ required
 
 
 
+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_USERNAME
 #define NM_SETTING_ADSL_USERNAME            "username"
 
@@ -612,64 +268,267 @@ required
 
 
 
+
+
+NMSettingAdsl
+typedef struct _NMSettingAdsl NMSettingAdsl;
+
+
+
+
+
+NMSettingAdslClass
+typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} 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 * -Encapsulation of ADSL connection. -Flags: Read / Write +The "encapsulation" property + "encapsulation" gchar* : Read / Write + +Encapsulation of ADSL connection. Can be "vcmux" or "llc". + Default value: NULL -The “password” property - “password” gchar * -Password used to authenticate with the pppoa service. -Flags: Read / Write +The "password" property + "password" gchar* : Read / Write + +Password used to authenticate with the ADSL service. + Default value: NULL -The “password-flags” property - “password-flags” guint -Flags indicating how to handle the ADSL password. -Flags: Read / Write +The "password-flags" property + "password-flags" guint : Read / Write + +Flags indicating how to handle the "password" property. + Allowed values: <= 7 Default value: 0 -The “protocol” property - “protocol” gchar * -ADSL connection protocol. -Flags: Read / Write +The "protocol" property + "protocol" gchar* : Read / Write + +ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". + Default value: NULL -The “username” property - “username” gchar * -Username used to authenticate with the pppoa service. -Flags: Read / Write +The "username" property + "username" gchar* : Read / Write + +Username used to authenticate with the ADSL service. + Default value: NULL -The “vci” property - “vci” guint -VCI of ADSL connection. -Flags: Read / Write +The "vci" property + "vci" guint : Read / Write + +VCI of ADSL connection + Allowed values: <= 65536 Default value: 0 -The “vpi” property - “vpi” guint -VPI of ADSL connection. -Flags: Read / Write +The "vpi" property + "vpi" guint : Read / Write + +VPI of ADSL connection + Allowed values: <= 65536 Default value: 0 @@ -677,6 +536,6 @@ required - Generated by GTK-Doc V1.20 + Generated by GTK-Doc V1.19

\ No newline at end of file -- cgit 1.3.0-6-gf8a5

			libnm-util Reference Manual
+Top + \| + Description + \| + Object Hierarchy + \| + Properties +

NM_SETTING_ADSL_ERROR_UNKNOWN	- unknown or unclassified error +	`NM_SETTING_ADSL_ERROR_UNKNOWN`	unknown or unclassified error
NM_SETTING_ADSL_ERROR_INVALID_PROPERTY	- the property was invalid +	`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_MISSING_PROPERTY`	the property was missing and is +required

`setting` :	the NMSettingAdsl +
Returns :	the "username" property of the setting