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/NMSettingPpp.html | 905 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 905 insertions(+) create mode 100644 docs/libnm/html/NMSettingPpp.html (limited to 'docs/libnm/html/NMSettingPpp.html') diff --git a/docs/libnm/html/NMSettingPpp.html b/docs/libnm/html/NMSettingPpp.html new file mode 100644 index 00000000..d1752861 --- /dev/null +++ b/docs/libnm/html/NMSettingPpp.html @@ -0,0 +1,905 @@ + + + + +NMSettingPpp + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingPpp

+

NMSettingPpp — Describes connection properties for devices/networks +that require PPP to deliver IP capability

+
+
+

Synopsis

+
#define             NM_SETTING_PPP_SETTING_NAME
+#define             NM_SETTING_PPP_NOAUTH
+#define             NM_SETTING_PPP_REFUSE_EAP
+#define             NM_SETTING_PPP_REFUSE_PAP
+#define             NM_SETTING_PPP_REFUSE_CHAP
+#define             NM_SETTING_PPP_REFUSE_MSCHAP
+#define             NM_SETTING_PPP_REFUSE_MSCHAPV2
+#define             NM_SETTING_PPP_NOBSDCOMP
+#define             NM_SETTING_PPP_NODEFLATE
+#define             NM_SETTING_PPP_NO_VJ_COMP
+#define             NM_SETTING_PPP_REQUIRE_MPPE
+#define             NM_SETTING_PPP_REQUIRE_MPPE_128
+#define             NM_SETTING_PPP_MPPE_STATEFUL
+#define             NM_SETTING_PPP_CRTSCTS
+#define             NM_SETTING_PPP_BAUD
+#define             NM_SETTING_PPP_MRU
+#define             NM_SETTING_PPP_MTU
+#define             NM_SETTING_PPP_LCP_ECHO_FAILURE
+#define             NM_SETTING_PPP_LCP_ECHO_INTERVAL
+struct              NMSettingPpp;
+                    NMSettingPppClass;
+NMSetting *         nm_setting_ppp_new                  (void);
+gboolean            nm_setting_ppp_get_noauth           (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_refuse_eap       (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_refuse_pap       (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_refuse_chap      (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_refuse_mschap    (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_refuse_mschapv2  (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_nobsdcomp        (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_nodeflate        (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_no_vj_comp       (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_require_mppe     (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_require_mppe_128 (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_mppe_stateful    (NMSettingPpp *setting);
+gboolean            nm_setting_ppp_get_crtscts          (NMSettingPpp *setting);
+guint32             nm_setting_ppp_get_baud             (NMSettingPpp *setting);
+guint32             nm_setting_ppp_get_mru              (NMSettingPpp *setting);
+guint32             nm_setting_ppp_get_mtu              (NMSettingPpp *setting);
+guint32             nm_setting_ppp_get_lcp_echo_failure (NMSettingPpp *setting);
+guint32             nm_setting_ppp_get_lcp_echo_interval
+                                                        (NMSettingPpp *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingPpp
+
+
+
+

Properties

+
+  "baud"                     guint                 : Read / Write / Construct
+  "crtscts"                  gboolean              : Read / Write / Construct
+  "lcp-echo-failure"         guint                 : Read / Write / Construct
+  "lcp-echo-interval"        guint                 : Read / Write / Construct
+  "mppe-stateful"            gboolean              : Read / Write / Construct
+  "mru"                      guint                 : Read / Write / Construct
+  "mtu"                      guint                 : Read / Write / Construct
+  "no-vj-comp"               gboolean              : Read / Write / Construct
+  "noauth"                   gboolean              : Read / Write / Construct
+  "nobsdcomp"                gboolean              : Read / Write / Construct
+  "nodeflate"                gboolean              : Read / Write / Construct
+  "refuse-chap"              gboolean              : Read / Write / Construct
+  "refuse-eap"               gboolean              : Read / Write / Construct
+  "refuse-mschap"            gboolean              : Read / Write / Construct
+  "refuse-mschapv2"          gboolean              : Read / Write / Construct
+  "refuse-pap"               gboolean              : Read / Write / Construct
+  "require-mppe"             gboolean              : Read / Write / Construct
+  "require-mppe-128"         gboolean              : Read / Write / Construct
+
+
+
+

Description

+

+The NMSettingPpp object is a NMSetting subclass that describes properties +necessary for connection to networks that require PPP transport, like PPPoE +cable and DSL modems and some mobile broadband devices. +

+
+
+

Details

+
+

NM_SETTING_PPP_SETTING_NAME

+
#define NM_SETTING_PPP_SETTING_NAME "ppp"
+
+

+

+
+
+
+

NM_SETTING_PPP_NOAUTH

+
#define NM_SETTING_PPP_NOAUTH            "noauth"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_EAP

+
#define NM_SETTING_PPP_REFUSE_EAP        "refuse-eap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_PAP

+
#define NM_SETTING_PPP_REFUSE_PAP        "refuse-pap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_CHAP

+
#define NM_SETTING_PPP_REFUSE_CHAP       "refuse-chap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_MSCHAP

+
#define NM_SETTING_PPP_REFUSE_MSCHAP     "refuse-mschap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_MSCHAPV2

+
#define NM_SETTING_PPP_REFUSE_MSCHAPV2   "refuse-mschapv2"
+
+

+

+
+
+
+

NM_SETTING_PPP_NOBSDCOMP

+
#define NM_SETTING_PPP_NOBSDCOMP         "nobsdcomp"
+
+

+

+
+
+
+

NM_SETTING_PPP_NODEFLATE

+
#define NM_SETTING_PPP_NODEFLATE         "nodeflate"
+
+

+

+
+
+
+

NM_SETTING_PPP_NO_VJ_COMP

+
#define NM_SETTING_PPP_NO_VJ_COMP        "no-vj-comp"
+
+

+

+
+
+
+

NM_SETTING_PPP_REQUIRE_MPPE

+
#define NM_SETTING_PPP_REQUIRE_MPPE      "require-mppe"
+
+

+

+
+
+
+

NM_SETTING_PPP_REQUIRE_MPPE_128

+
#define NM_SETTING_PPP_REQUIRE_MPPE_128  "require-mppe-128"
+
+

+

+
+
+
+

NM_SETTING_PPP_MPPE_STATEFUL

+
#define NM_SETTING_PPP_MPPE_STATEFUL     "mppe-stateful"
+
+

+

+
+
+
+

NM_SETTING_PPP_CRTSCTS

+
#define NM_SETTING_PPP_CRTSCTS           "crtscts"
+
+

+

+
+
+
+

NM_SETTING_PPP_BAUD

+
#define NM_SETTING_PPP_BAUD              "baud"
+
+

+

+
+
+
+

NM_SETTING_PPP_MRU

+
#define NM_SETTING_PPP_MRU               "mru"
+
+

+

+
+
+
+

NM_SETTING_PPP_MTU

+
#define NM_SETTING_PPP_MTU               "mtu"
+
+

+

+
+
+
+

NM_SETTING_PPP_LCP_ECHO_FAILURE

+
#define NM_SETTING_PPP_LCP_ECHO_FAILURE  "lcp-echo-failure"
+
+

+

+
+
+
+

NM_SETTING_PPP_LCP_ECHO_INTERVAL

+
#define NM_SETTING_PPP_LCP_ECHO_INTERVAL "lcp-echo-interval"
+
+

+

+
+
+
+

struct NMSettingPpp

+
struct NMSettingPpp;
+

+

+
+
+
+

NMSettingPppClass

+
typedef struct {
+	NMSettingClass parent;
+} NMSettingPppClass;
+
+

+

+
+
+
+

nm_setting_ppp_new ()

+
NMSetting *         nm_setting_ppp_new                  (void);
+

+Creates a new NMSettingPpp object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingPpp object. [transfer full] +
+
+
+
+

nm_setting_ppp_get_noauth ()

+
gboolean            nm_setting_ppp_get_noauth           (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "noauth" property of the setting
+
+
+
+

nm_setting_ppp_get_refuse_eap ()

+
gboolean            nm_setting_ppp_get_refuse_eap       (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "refuse-eap" property of the setting
+
+
+
+

nm_setting_ppp_get_refuse_pap ()

+
gboolean            nm_setting_ppp_get_refuse_pap       (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "refuse-pap" property of the setting
+
+
+
+

nm_setting_ppp_get_refuse_chap ()

+
gboolean            nm_setting_ppp_get_refuse_chap      (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "refuse-chap" property of the setting
+
+
+
+

nm_setting_ppp_get_refuse_mschap ()

+
gboolean            nm_setting_ppp_get_refuse_mschap    (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "refuse-mschap" property of the setting
+
+
+
+

nm_setting_ppp_get_refuse_mschapv2 ()

+
gboolean            nm_setting_ppp_get_refuse_mschapv2  (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "refuse-mschapv2" property of the setting
+
+
+
+

nm_setting_ppp_get_nobsdcomp ()

+
gboolean            nm_setting_ppp_get_nobsdcomp        (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "nobsdcomp" property of the setting
+
+
+
+

nm_setting_ppp_get_nodeflate ()

+
gboolean            nm_setting_ppp_get_nodeflate        (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "nodeflate" property of the setting
+
+
+
+

nm_setting_ppp_get_no_vj_comp ()

+
gboolean            nm_setting_ppp_get_no_vj_comp       (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "no-vj-comp" property of the setting
+
+
+
+

nm_setting_ppp_get_require_mppe ()

+
gboolean            nm_setting_ppp_get_require_mppe     (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "require-mppe" property of the setting
+
+
+
+

nm_setting_ppp_get_require_mppe_128 ()

+
gboolean            nm_setting_ppp_get_require_mppe_128 (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "require-mppe-128" property of the setting
+
+
+
+

nm_setting_ppp_get_mppe_stateful ()

+
gboolean            nm_setting_ppp_get_mppe_stateful    (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "mppe-stateful" property of the setting
+
+
+
+

nm_setting_ppp_get_crtscts ()

+
gboolean            nm_setting_ppp_get_crtscts          (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "crtscts" property of the setting
+
+
+
+

nm_setting_ppp_get_baud ()

+
guint32             nm_setting_ppp_get_baud             (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "baud" property of the setting
+
+
+
+

nm_setting_ppp_get_mru ()

+
guint32             nm_setting_ppp_get_mru              (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "mru" property of the setting
+
+
+
+

nm_setting_ppp_get_mtu ()

+
guint32             nm_setting_ppp_get_mtu              (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "mtu" property of the setting
+
+
+
+

nm_setting_ppp_get_lcp_echo_failure ()

+
guint32             nm_setting_ppp_get_lcp_echo_failure (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "lcp-echo-failure" property of the setting
+
+
+
+

nm_setting_ppp_get_lcp_echo_interval ()

+
guint32             nm_setting_ppp_get_lcp_echo_interval
+                                                        (NMSettingPpp *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingPpp +

Returns :

the "lcp-echo-interval" property of the setting
+
+
+
+

Property Details

+
+

The "baud" property

+
  "baud"                     guint                 : Read / Write / Construct
+

+If non-zero, instruct pppd to set the serial port to the specified +baudrate. This value should normally be left as 0 to automatically +choose the speed. +

+

Default value: 0

+
+
+
+

The "crtscts" property

+
  "crtscts"                  gboolean              : Read / Write / Construct
+

+If TRUE, specify that pppd should set the serial port to use hardware +flow control with RTS and CTS signals. This value should normally be set +to FALSE. +

+

Default value: FALSE

+
+
+
+

The "lcp-echo-failure" property

+
  "lcp-echo-failure"         guint                 : Read / Write / Construct
+

+If non-zero, instruct pppd to presume the connection to the peer has +failed if the specified number of LCP echo-requests go unanswered by the +peer. The "lcp-echo-interval" property must also be set to a non-zero +value if this property is used. +

+

Default value: 0

+
+
+
+

The "lcp-echo-interval" property

+
  "lcp-echo-interval"        guint                 : Read / Write / Construct
+

+If non-zero, instruct pppd to send an LCP echo-request frame to the peer +every n seconds (where n is the specified value). Note that some PPP +peers will respond to echo requests and some will not, and it is not +possible to autodetect this. +

+

Default value: 0

+
+
+
+

The "mppe-stateful" property

+
  "mppe-stateful"            gboolean              : Read / Write / Construct
+

+If TRUE, stateful MPPE is used. See pppd documentation for more +information on stateful MPPE. +

+

Default value: FALSE

+
+
+
+

The "mru" property

+
  "mru"                      guint                 : Read / Write / Construct
+

+If non-zero, instruct pppd to request that the peer send packets no +larger than the specified size. If non-zero, the MRU should be between +128 and 16384. +

+

Allowed values: <= 16384

+

Default value: 0

+
+
+
+

The "mtu" property

+
  "mtu"                      guint                 : Read / Write / Construct
+

+If non-zero, instruct pppd to send packets no larger than the specified +size. +

+

Default value: 0

+
+
+
+

The "no-vj-comp" property

+
  "no-vj-comp"               gboolean              : Read / Write / Construct
+

+If TRUE, Van Jacobsen TCP header compression will not be requested. +

+

Default value: FALSE

+
+
+
+

The "noauth" property

+
  "noauth"                   gboolean              : Read / Write / Construct
+

+If TRUE, do not require the other side (usually the PPP server) to +authenticate itself to the client. If FALSE, require authentication +from the remote side. In almost all cases, this should be TRUE. +

+

Default value: TRUE

+
+
+
+

The "nobsdcomp" property

+
  "nobsdcomp"                gboolean              : Read / Write / Construct
+

+If TRUE, BSD compression will not be requested. +

+

Default value: FALSE

+
+
+
+

The "nodeflate" property

+
  "nodeflate"                gboolean              : Read / Write / Construct
+

+If TRUE, "deflate" compression will not be requested. +

+

Default value: FALSE

+
+
+
+

The "refuse-chap" property

+
  "refuse-chap"              gboolean              : Read / Write / Construct
+

+If TRUE, the CHAP authentication method will not be used. +

+

Default value: FALSE

+
+
+
+

The "refuse-eap" property

+
  "refuse-eap"               gboolean              : Read / Write / Construct
+

+If TRUE, the EAP authentication method will not be used. +

+

Default value: FALSE

+
+
+
+

The "refuse-mschap" property

+
  "refuse-mschap"            gboolean              : Read / Write / Construct
+

+If TRUE, the MSCHAP authentication method will not be used. +

+

Default value: FALSE

+
+
+
+

The "refuse-mschapv2" property

+
  "refuse-mschapv2"          gboolean              : Read / Write / Construct
+

+If TRUE, the MSCHAPv2 authentication method will not be used. +

+

Default value: FALSE

+
+
+
+

The "refuse-pap" property

+
  "refuse-pap"               gboolean              : Read / Write / Construct
+

+If TRUE, the PAP authentication method will not be used. +

+

Default value: FALSE

+
+
+
+

The "require-mppe" property

+
  "require-mppe"             gboolean              : Read / Write / Construct
+

+If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for +the PPP session. If either 64-bit or 128-bit MPPE is not available the +session will fail. Note that MPPE is not used on mobile broadband +connections. +

+

Default value: FALSE

+
+
+
+

The "require-mppe-128" property

+
  "require-mppe-128"         gboolean              : Read / Write / Construct
+

+If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be +required for the PPP session, and the "require-mppe" property must also +be set to TRUE. If 128-bit MPPE is not available the session will fail. +

+

Default value: FALSE

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