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/html/NMSettingPppoe.html | 472 ++++++++++++++++++++---------------- 1 file changed, 268 insertions(+), 204 deletions(-) (limited to 'docs/libnm/html/NMSettingPppoe.html') diff --git a/docs/libnm/html/NMSettingPppoe.html b/docs/libnm/html/NMSettingPppoe.html index 583028d3..daa5f943 100644 --- a/docs/libnm/html/NMSettingPppoe.html +++ b/docs/libnm/html/NMSettingPppoe.html @@ -2,34 +2,28 @@ -NMSettingPppoe +libnm Reference Manual: NMSettingPppoe - + - - - - - - - - - - + + + + + + +
@@ -37,52 +31,255 @@

NMSettingPppoe

NMSettingPppoe — Describes PPPoE connection properties

- +
-
-

Synopsis

-
#define             NM_SETTING_PPPOE_SETTING_NAME
-#define             NM_SETTING_PPPOE_SERVICE
-#define             NM_SETTING_PPPOE_USERNAME
-#define             NM_SETTING_PPPOE_PASSWORD
-#define             NM_SETTING_PPPOE_PASSWORD_FLAGS
-struct              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);
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMSetting
-         +----NMSettingPppoe
-
+

Functions

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

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

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






+gchar *passwordRead / Write
NMSettingSecretFlagspassword-flagsRead / Write

+gchar *serviceRead / Write

+gchar *usernameRead / Write

+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_PPPOE_SETTING_NAME
#defineNM_SETTING_PPPOE_SERVICE
#defineNM_SETTING_PPPOE_USERNAME
#defineNM_SETTING_PPPOE_PASSWORD
#defineNM_SETTING_PPPOE_PASSWORD_FLAGS
+
+
+

Object Hierarchy

+
    GObject
+    ╰── NMSetting
+        ╰── NMSettingPppoe

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_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"
@@ -122,176 +319,43 @@ to provide IP transport, for example cable or DSL modems.
-
-
-

struct NMSettingPppoe

-
struct NMSettingPppoe;
-

-

-
-
-
-

NMSettingPppoeClass

-
typedef struct {
-	NMSettingClass parent;
-} 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 *
+

+

Flags: Read / Write

Default value: NULL

-

The "password-flags" property

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

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

+

The “password-flags” property

+
  “password-flags”           NMSettingSecretFlags
+

+

Flags: Read / Write

-

The "service" property

-
  "service"                  gchar*                : Read / Write
-

-If specified, instruct PPPoE to only initiate sessions with access -concentrators that provide the specified service. 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 *
+

+

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

+

Flags: Read / Write

Default value: NULL

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