From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm/html/NMSettingPppoe.html | 297 ++++++++++++++++++++++++++++++++++++ 1 file changed, 297 insertions(+) create mode 100644 docs/libnm/html/NMSettingPppoe.html (limited to 'docs/libnm/html/NMSettingPppoe.html') diff --git a/docs/libnm/html/NMSettingPppoe.html b/docs/libnm/html/NMSettingPppoe.html new file mode 100644 index 00000000..583028d3 --- /dev/null +++ b/docs/libnm/html/NMSettingPppoe.html @@ -0,0 +1,297 @@ + + + + +NMSettingPppoe + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

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

Properties

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

Description

+

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

+
+
+

Details

+
+

NM_SETTING_PPPOE_SETTING_NAME

+
#define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_SERVICE

+
#define NM_SETTING_PPPOE_SERVICE        "service"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_USERNAME

+
#define NM_SETTING_PPPOE_USERNAME       "username"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_PASSWORD

+
#define NM_SETTING_PPPOE_PASSWORD       "password"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_PASSWORD_FLAGS

+
#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags"
+
+

+

+
+
+
+

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

+

Default value: NULL

+
+
+
+

The "password-flags" property

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

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

+
+
+
+

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

+

Default value: NULL

+
+
+
+

The "username" property

+
  "username"                 gchar*                : Read / Write
+

+Username used to authenticate with the PPPoE service. +

+

Default value: NULL

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