From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm-util/html/NMSettingAdsl.html | 825 +++++++++++++++++++------------- 1 file changed, 483 insertions(+), 342 deletions(-) (limited to 'docs/libnm-util/html/NMSettingAdsl.html') diff --git a/docs/libnm-util/html/NMSettingAdsl.html b/docs/libnm-util/html/NMSettingAdsl.html index ab37325d..3b2aef23 100644 --- a/docs/libnm-util/html/NMSettingAdsl.html +++ b/docs/libnm-util/html/NMSettingAdsl.html @@ -2,34 +2,28 @@ -NMSettingAdsl +libnm-util Reference Manual: NMSettingAdsl - + - - - - - - - - - - + + + + + + +
@@ -37,74 +31,438 @@

NMSettingAdsl

NMSettingAdsl — Describes ADSL-based properties

- +
-
-

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

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 *encapsulationRead / Write
+gchar *passwordRead / Write
guintpassword-flagsRead / Write
+gchar *protocolRead / Write
+gchar *usernameRead / Write
guintvciRead / Write
guintvpiRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_ADSL_SETTING_NAME
enumNMSettingAdslError
#defineNM_SETTING_ADSL_ERROR
#defineNM_SETTING_ADSL_USERNAME
#defineNM_SETTING_ADSL_PASSWORD
#defineNM_SETTING_ADSL_PASSWORD_FLAGS
#defineNM_SETTING_ADSL_PROTOCOL
#defineNM_SETTING_ADSL_ENCAPSULATION
#defineNM_SETTING_ADSL_VPI
#defineNM_SETTING_ADSL_VCI
#defineNM_SETTING_ADSL_PROTOCOL_PPPOA
#defineNM_SETTING_ADSL_PROTOCOL_PPPOE
#defineNM_SETTING_ADSL_PROTOCOL_IPOATM
#defineNM_SETTING_ADSL_ENCAPSULATION_VCMUX
#defineNM_SETTING_ADSL_ENCAPSULATION_LLC

Object Hierarchy

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

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
+
Includes

+
#include <nm-setting-adsl.h>

Description

-

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

+

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

-

Details

+

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"
@@ -114,38 +472,42 @@ properties of ADSL connections.
-

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

enum NMSettingAdslError

+
+

Members

+
--+++ - - + + - - + + - - + +

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

@@ -156,24 +518,6 @@ 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"
@@ -268,267 +612,64 @@ Registers an error quark for -

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*                : Read / Write
-

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

+

The “encapsulation” property

+
  “encapsulation”            gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "password" property

-
  "password"                 gchar*                : Read / Write
-

-Password used to authenticate with the ADSL service. -

+

The “password” property

+
  “password”                 gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "password-flags" property

-
  "password-flags"           guint                 : Read / Write
-

-Flags indicating how to handle the "password" property. -

+

The “password-flags” property

+
  “password-flags”           guint
+

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "protocol" property

-
  "protocol"                 gchar*                : Read / Write
-

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

+

The “protocol” property

+
  “protocol”                 gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "username" property

-
  "username"                 gchar*                : Read / Write
-

-Username used to authenticate with the ADSL service. -

+

The “username” property

+
  “username”                 gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "vci" property

-
  "vci"                      guint                 : Read / Write
-

-VCI of ADSL connection -

+

The “vci” property

+
  “vci”                      guint
+

+

Flags: Read / Write

Allowed values: <= 65536

Default value: 0

-

The "vpi" property

-
  "vpi"                      guint                 : Read / Write
-

-VPI of ADSL connection -

+

The “vpi” property

+
  “vpi”                      guint
+

+

Flags: Read / Write

Allowed values: <= 65536

Default value: 0

@@ -536,6 +677,6 @@ VPI of ADSL connection
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21
\ No newline at end of file -- cgit 1.3.0-6-gf8a5