From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-util/html/NMSettingPPPOE.html | 584 +++++++++++++++++-------------- 1 file changed, 327 insertions(+), 257 deletions(-) (limited to 'docs/libnm-util/html/NMSettingPPPOE.html') diff --git a/docs/libnm-util/html/NMSettingPPPOE.html b/docs/libnm-util/html/NMSettingPPPOE.html index fd91a0ad..426fe9c5 100644 --- a/docs/libnm-util/html/NMSettingPPPOE.html +++ b/docs/libnm-util/html/NMSettingPPPOE.html @@ -2,34 +2,28 @@ -NMSettingPPPOE +libnm-util Reference Manual: NMSettingPPPOE - + - - - - - - - - - - + + + + + + +
@@ -37,62 +31,290 @@

NMSettingPPPOE

NMSettingPPPOE — Describes PPPoE connection properties

- +
-
-

Synopsis

-
-#include <nm-setting-pppoe.h>
-
-#define             NM_SETTING_PPPOE_SETTING_NAME
-enum                NMSettingPPPOEError;
-#define             NM_SETTING_PPPOE_ERROR
-GQuark              nm_setting_pppoe_error_quark        (void);
-#define             NM_SETTING_PPPOE_SERVICE
-#define             NM_SETTING_PPPOE_USERNAME
-#define             NM_SETTING_PPPOE_PASSWORD
-#define             NM_SETTING_PPPOE_PASSWORD_FLAGS
-                    NMSettingPPPOE;
-                    NMSettingPPPOEClass;
-NMSetting *         nm_setting_pppoe_new                (void);
-const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
-const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);
-const char *        nm_setting_pppoe_get_password       (NMSettingPPPOE *setting);
-NMSettingSecretFlags nm_setting_pppoe_get_password_flags
-                                                        (NMSettingPPPOE *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_pppoe_error_quark () +
+NMSetting * + +nm_setting_pppoe_new () +
const char * + +nm_setting_pppoe_get_service () +
const char * + +nm_setting_pppoe_get_username () +
const char * + +nm_setting_pppoe_get_password () +
+NMSettingSecretFlags + +nm_setting_pppoe_get_password_flags () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
+gchar *passwordRead / Write
guintpassword-flagsRead / Write
+gchar *serviceRead / Write
+gchar *usernameRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_PPPOE_SETTING_NAME
enumNMSettingPPPOEError
#defineNM_SETTING_PPPOE_ERROR
#defineNM_SETTING_PPPOE_SERVICE
#defineNM_SETTING_PPPOE_USERNAME
#defineNM_SETTING_PPPOE_PASSWORD
#defineNM_SETTING_PPPOE_PASSWORD_FLAGS

Object Hierarchy

-
-  GEnum
-   +----NMSettingPPPOEError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingPPPOE
+
    GEnum
+    ╰── NMSettingPPPOEError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingPPPOE
-

Properties

-
-  "password"                 gchar*                : Read / Write
-  "password-flags"           guint                 : Read / Write
-  "service"                  gchar*                : Read / Write
-  "username"                 gchar*                : Read / Write
+
Includes

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

Description

-

-The NMSettingPPPOE object is a NMSetting subclass that describes +

The NMSettingPPPOE object is a NMSetting subclass that describes properties necessary for connection to networks that require PPPoE connections -to provide IP transport, for example cable or DSL modems. -

+to provide IP transport, for example cable or DSL modems.

+
+
+

Functions

+
+

nm_setting_pppoe_error_quark ()

+
GQuark
+nm_setting_pppoe_error_quark (void);
+

Registers an error quark for NMSettingPPPOE if necessary.

+
+

Returns

+

the error quark used for NMSettingPPPOE errors.

+

+
+
+
+
+

nm_setting_pppoe_new ()

+
NMSetting *
+nm_setting_pppoe_new (void);
+

Creates a new NMSettingPPPOE object with default values.

+
+

Returns

+

the new empty NMSettingPPPOE object.

+

[transfer full]

+
+
+
+
+

nm_setting_pppoe_get_service ()

+
const char *
+nm_setting_pppoe_get_service (NMSettingPPPOE *setting);
+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingPPPOE

 
+
+
+

Returns

+

the “service” property of the setting

+

+
+
+
+
+

nm_setting_pppoe_get_username ()

+
const char *
+nm_setting_pppoe_get_username (NMSettingPPPOE *setting);
+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingPPPOE

 
+
+
+

Returns

+

the “username” property of the setting

+

+
+
+
+
+

nm_setting_pppoe_get_password ()

+
const char *
+nm_setting_pppoe_get_password (NMSettingPPPOE *setting);
+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingPPPOE

 
+
+
+

Returns

+

the “password” property of the setting

+

+
+
+
+
+

nm_setting_pppoe_get_password_flags ()

+
NMSettingSecretFlags
+nm_setting_pppoe_get_password_flags (NMSettingPPPOE *setting);
+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingPPPOE

 
+
+
+

Returns

+

the NMSettingSecretFlags pertaining to the “password”

+

+
+
-

Details

+

Types and Values

NM_SETTING_PPPOE_SETTING_NAME

#define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
@@ -102,45 +324,50 @@ to provide IP transport, for example cable or DSL modems.
-

enum NMSettingPPPOEError

-
typedef enum {
-	NM_SETTING_PPPOE_ERROR_UNKNOWN = 0,        /*< nick=UnknownError >*/
-	NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY,   /*< nick=InvalidProperty >*/
-	NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY,   /*< nick=MissingProperty >*/
-	NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING /*< nick=MissingPPPSetting >*/
-} NMSettingPPPOEError;
-
-
+

enum NMSettingPPPOEError

+
+

Members

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

NM_SETTING_PPPOE_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_PPPOE_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING

the connection -did not contain a required PPP setting for PPP related options +

NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING

 +

the connection +did not contain a required PPP setting for PPP related options

 
+

NM_SETTING_PPPOE_ERROR

@@ -151,24 +378,6 @@ did not contain a required PPP setting for PPP related options
-

nm_setting_pppoe_error_quark ()

-
GQuark              nm_setting_pppoe_error_quark        (void);
-

-Registers an error quark for NMSettingPPPOE if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingPPPOE errors.
-
-
-

NM_SETTING_PPPOE_SERVICE

#define NM_SETTING_PPPOE_SERVICE        "service"
@@ -199,184 +408,45 @@ Registers an error quark for -

NMSettingPPPOE

-
typedef struct _NMSettingPPPOE NMSettingPPPOE;
-

-

-
-
-
-

NMSettingPPPOEClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingPPPOEClass;
-
-

-

-
-
-
-

nm_setting_pppoe_new ()

-
NMSetting *         nm_setting_pppoe_new                (void);
-

-Creates a new NMSettingPPPOE object with default values. -

-
---- - - - - -

Returns :

the new empty NMSettingPPPOE object. [transfer full] -
-
-
-
-

nm_setting_pppoe_get_service ()

-
const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingPPPOE -

Returns :

the "service" property of the setting
-
-
-
-

nm_setting_pppoe_get_username ()

-
const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingPPPOE -

Returns :

the "username" property of the setting
-
-
-
-

nm_setting_pppoe_get_password ()

-
const char *        nm_setting_pppoe_get_password       (NMSettingPPPOE *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingPPPOE -

Returns :

the "password" property of the setting
-
-
-
-

nm_setting_pppoe_get_password_flags ()

-
NMSettingSecretFlags nm_setting_pppoe_get_password_flags
-                                                        (NMSettingPPPOE *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingPPPOE -

Returns :

the NMSettingSecretFlags pertaining to the "password" -
-

Property Details

-

The "password" property

-
  "password"                 gchar*                : Read / Write
-

-Password used to authenticate with the PPPoE service. -

+

The “password” property

+
  “password”                 gchar *
+

Password used to authenticate with the PPPoE service.

+

Flags: Read / Write

Default value: NULL

-

The "password-flags" property

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

-Flags indicating how to handle "password":. -

+

The “password-flags” property

+
  “password-flags”           guint
+

Flags indicating how to handle the PPPoE password.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "service" property

-
  "service"                  gchar*                : Read / Write
-

-If specified, instruct PPPoE to only initiate sessions with access -concentrators that provide the specified serivce. For most providers, -this should be left blank. It is only required if there are multiple -access concentrators or a specific service is known to be required. -

+

The “service” property

+
  “service”                  gchar *
+

If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.

+

Flags: Read / Write

Default value: NULL

-

The "username" property

-
  "username"                 gchar*                : Read / Write
-

-Username used to authenticate with the PPPoE service. -

+

The “username” property

+
  “username”                 gchar *
+

Username used to authenticate with the PPPoE service.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file -- cgit 1.3.0-6-gf8a5