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/Makefile.in | 55 +- docs/libnm-util/html/NMConnection.html | 2982 ++++++----- docs/libnm-util/html/NMSetting.html | 1820 ++++--- docs/libnm-util/html/NMSetting8021x.html | 5411 +++++++++++--------- docs/libnm-util/html/NMSettingAdsl.html | 825 +-- docs/libnm-util/html/NMSettingBluetooth.html | 463 +- docs/libnm-util/html/NMSettingBond.html | 916 ++-- docs/libnm-util/html/NMSettingBridge.html | 824 +-- docs/libnm-util/html/NMSettingBridgePort.html | 508 +- docs/libnm-util/html/NMSettingCdma.html | 584 ++- docs/libnm-util/html/NMSettingConnection.html | 1762 ++++--- docs/libnm-util/html/NMSettingGsm.html | 1369 ++--- docs/libnm-util/html/NMSettingIP4Config.html | 3306 +++++++----- docs/libnm-util/html/NMSettingIP6Config.html | 3315 +++++++----- docs/libnm-util/html/NMSettingInfiniband.html | 507 +- docs/libnm-util/html/NMSettingOlpcMesh.html | 384 +- docs/libnm-util/html/NMSettingPPP.html | 1705 +++--- docs/libnm-util/html/NMSettingPPPOE.html | 584 ++- docs/libnm-util/html/NMSettingSerial.html | 659 +-- docs/libnm-util/html/NMSettingVPN.html | 1072 ++-- docs/libnm-util/html/NMSettingVlan.html | 1179 +++-- docs/libnm-util/html/NMSettingWimax.html | 423 +- docs/libnm-util/html/NMSettingWired.html | 1358 ++--- docs/libnm-util/html/NMSettingWireless.html | 1685 +++--- .../libnm-util/html/NMSettingWirelessSecurity.html | 2388 +++++---- docs/libnm-util/html/annotation-glossary.html | 73 +- docs/libnm-util/html/api-index-full.html | 1697 +++--- docs/libnm-util/html/ch01.html | 18 +- docs/libnm-util/html/home.png | Bin 654 -> 256 bytes docs/libnm-util/html/index.html | 10 +- docs/libnm-util/html/index.sgml | 1079 ++-- docs/libnm-util/html/left-insensitive.png | Bin 0 -> 395 bytes docs/libnm-util/html/left.png | Bin 459 -> 262 bytes docs/libnm-util/html/libnm-util-nm-utils.html | 2374 +++++---- docs/libnm-util/html/libnm-util.devhelp2 | 1667 +++--- docs/libnm-util/html/object-tree.html | 148 +- docs/libnm-util/html/right-insensitive.png | Bin 0 -> 373 bytes docs/libnm-util/html/right.png | Bin 472 -> 261 bytes docs/libnm-util/html/style.css | 247 +- docs/libnm-util/html/up-insensitive.png | Bin 0 -> 374 bytes docs/libnm-util/html/up.png | Bin 406 -> 260 bytes docs/libnm-util/libnm-util-docs.sgml | 2 +- docs/libnm-util/libnm-util-sections.txt | 98 +- docs/libnm-util/tmpl/nm-connection.sgml | 8 - docs/libnm-util/tmpl/nm-setting-8021x.sgml | 177 - docs/libnm-util/tmpl/nm-setting-adsl.sgml | 52 - docs/libnm-util/tmpl/nm-setting-bluetooth.sgml | 27 - docs/libnm-util/tmpl/nm-setting-bond.sgml | 27 - docs/libnm-util/tmpl/nm-setting-bridge-port.sgml | 32 - docs/libnm-util/tmpl/nm-setting-bridge.sgml | 52 - docs/libnm-util/tmpl/nm-setting-cdma.sgml | 37 - docs/libnm-util/tmpl/nm-setting-connection.sgml | 11 - docs/libnm-util/tmpl/nm-setting-gsm.sgml | 72 - docs/libnm-util/tmpl/nm-setting-infiniband.sgml | 32 - docs/libnm-util/tmpl/nm-setting-ip4-config.sgml | 89 - docs/libnm-util/tmpl/nm-setting-ip6-config.sgml | 84 - docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml | 32 - docs/libnm-util/tmpl/nm-setting-ppp.sgml | 107 - docs/libnm-util/tmpl/nm-setting-pppoe.sgml | 37 - docs/libnm-util/tmpl/nm-setting-serial.sgml | 42 - docs/libnm-util/tmpl/nm-setting-vlan.sgml | 47 - docs/libnm-util/tmpl/nm-setting-vpn.sgml | 37 - docs/libnm-util/tmpl/nm-setting-wimax.sgml | 23 - docs/libnm-util/tmpl/nm-setting-wired.sgml | 72 - .../tmpl/nm-setting-wireless-security.sgml | 102 - docs/libnm-util/tmpl/nm-setting-wireless.sgml | 87 - docs/libnm-util/tmpl/nm-setting.sgml | 16 - docs/libnm-util/version.xml | 2 +- 68 files changed, 24254 insertions(+), 20547 deletions(-) create mode 100644 docs/libnm-util/html/left-insensitive.png create mode 100644 docs/libnm-util/html/right-insensitive.png create mode 100644 docs/libnm-util/html/up-insensitive.png (limited to 'docs/libnm-util') diff --git a/docs/libnm-util/Makefile.in b/docs/libnm-util/Makefile.in index 68627afb..ded02ca9 100644 --- a/docs/libnm-util/Makefile.in +++ b/docs/libnm-util/Makefile.in @@ -158,6 +158,7 @@ DEPDIR = @DEPDIR@ DHCLIENT_PATH = @DHCLIENT_PATH@ DHCPCD_PATH = @DHCPCD_PATH@ DLLTOOL = @DLLTOOL@ +DNSMASQ_PATH = @DNSMASQ_PATH@ DSYMUTIL = @DSYMUTIL@ DUMPBIN = @DUMPBIN@ ECHO_C = @ECHO_C@ @@ -180,6 +181,7 @@ GNUTLS_CFLAGS = @GNUTLS_CFLAGS@ GNUTLS_LIBS = @GNUTLS_LIBS@ GREP = @GREP@ GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_CHECK_PATH = @GTKDOC_CHECK_PATH@ GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ GTKDOC_MKPDF = @GTKDOC_MKPDF@ @@ -462,12 +464,12 @@ REPORT_FILES = \ $(DOC_MODULE)-unused.txt CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) \ - libnm-util-sections.txt libnm-util-overrides.txt html/* tmpl/* \ - xml/* -@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = -@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp -@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = -@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp + gtkdoc-check.test libnm-util-sections.txt \ + libnm-util-overrides.txt html/* tmpl/* xml/* +@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = +@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp +@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = +@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp #### setup #### GTK_DOC_V_SETUP = $(GTK_DOC_V_SETUP_$(V)) @@ -588,6 +590,7 @@ distdir: $(DISTFILES) dist-hook check-am: all-am check: check-am +@ENABLE_GTK_DOC_FALSE@all-local: all-am: Makefile all-local installdirs: install: install-am @@ -705,8 +708,15 @@ uninstall-am: uninstall-local uninstall-am uninstall-local -@ENABLE_GTK_DOC_TRUE@all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) -@ENABLE_GTK_DOC_FALSE@all-local: +gtkdoc-check.test: Makefile + $(AM_V_GEN)echo "#!/bin/sh -e" > $@; \ + echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \ + chmod +x $@ + +all-gtk-doc: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) +.PHONY: all-gtk-doc + +@ENABLE_GTK_DOC_TRUE@all-local: all-gtk-doc docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) @@ -717,17 +727,19 @@ setup-build.stamp: files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ if test "x$$files" != "x" ; then \ for file in $$files ; do \ + destdir=`dirname $(abs_builddir)/$$file` ;\ + test -d "$$destdir" || mkdir -p "$$destdir"; \ test -f $(abs_srcdir)/$$file && \ - cp -pu $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \ + cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \ done; \ fi; \ test -d $(abs_srcdir)/tmpl && \ - { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \ + { cp -pR $(abs_srcdir)/tmpl $(abs_builddir)/; \ chmod -R u+w $(abs_builddir)/tmpl; } \ fi $(AM_V_at)touch setup-build.stamp -scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) +scan-build.stamp: setup-build.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(GTK_DOC_V_SCAN)_source_dir='' ; \ for i in $(DOC_SOURCE_DIR) ; do \ _source_dir="$${_source_dir} --source-dir=$$i" ; \ @@ -757,7 +769,7 @@ tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DO $(GTK_DOC_V_TMPL)gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) $(AM_V_at)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ if test -w $(abs_srcdir) ; then \ - cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \ + cp -pR $(abs_builddir)/tmpl $(abs_srcdir)/; \ fi \ fi $(AM_V_at)touch tmpl-build.stamp @@ -769,7 +781,7 @@ $(srcdir)/tmpl/*.sgml: @true sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) - $(GTK_DOC_V_XML)-chmod -R u+w $(srcdir) && _source_dir='' ; \ + -$(GTK_DOC_V_XML)chmod -R u+w $(srcdir) && _source_dir='' ; \ for i in $(DOC_SOURCE_DIR) ; do \ _source_dir="$${_source_dir} --source-dir=$$i" ; \ done ; \ @@ -831,6 +843,9 @@ pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) clean-local: @rm -f *~ *.bak @rm -rf .libs + @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \ + rm -f $(DOC_MODULE).types; \ + fi distclean-local: @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \ @@ -876,12 +891,14 @@ uninstall-local: # # Require gtk-doc when making dist # -@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: docs -@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: -@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" -@ENABLE_GTK_DOC_FALSE@ @false - -dist-hook: dist-check-gtkdoc dist-hook-local +@HAVE_GTK_DOC_TRUE@dist-check-gtkdoc: docs +@HAVE_GTK_DOC_FALSE@dist-check-gtkdoc: +@HAVE_GTK_DOC_FALSE@ @echo "*** gtk-doc is needed to run 'make dist'. ***" +@HAVE_GTK_DOC_FALSE@ @echo "*** gtk-doc was not found when 'configure' ran. ***" +@HAVE_GTK_DOC_FALSE@ @echo "*** please install gtk-doc and rerun 'configure'. ***" +@HAVE_GTK_DOC_FALSE@ @false + +dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local @mkdir $(distdir)/tmpl @mkdir $(distdir)/html @-cp ./tmpl/*.sgml $(distdir)/tmpl diff --git a/docs/libnm-util/html/NMConnection.html b/docs/libnm-util/html/NMConnection.html index 7c3d81b0..d764706a 100644 --- a/docs/libnm-util/html/NMConnection.html +++ b/docs/libnm-util/html/NMConnection.html @@ -2,36 +2,29 @@ -NMConnection +libnm-util Reference Manual: NMConnection - + - - - - - - - - - - + + + + + + +
@@ -39,611 +32,910 @@

NMConnection

NMConnection — Describes a connection to specific network or provider

- +
-
-

Synopsis

-
-#include <nm-connection.h>
-
-enum                NMConnectionError;
-#define             NM_CONNECTION_ERROR
-GQuark              nm_connection_error_quark           (void);
-#define             NM_CONNECTION_PATH
-                    NMConnection;
-                    NMConnectionClass;
-NMConnection *      nm_connection_new                   (void);
-NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
-                                                         GError **error);
-NMConnection *      nm_connection_duplicate             (NMConnection *connection);
-NMSetting *         nm_connection_create_setting        (const char *name);
-void                nm_connection_add_setting           (NMConnection *connection,
-                                                         NMSetting *setting);
-void                nm_connection_remove_setting        (NMConnection *connection,
-                                                         GType setting_type);
-NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);
-NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);
-gboolean            nm_connection_replace_settings      (NMConnection *connection,
-                                                         GHashTable *new_settings,
-                                                         GError **error);
-gboolean            nm_connection_compare               (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags);
-gboolean            nm_connection_diff                  (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags,
-                                                         GHashTable **out_settings);
-gboolean            nm_connection_verify                (NMConnection *connection,
-                                                         GError **error);
-const char *        nm_connection_need_secrets          (NMConnection *connection,
-                                                         GPtrArray **hints);
-void                nm_connection_clear_secrets         (NMConnection *connection);
-void                nm_connection_clear_secrets_with_flags
-                                                        (NMConnection *connection,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
-gboolean            nm_connection_update_secrets        (NMConnection *connection,
-                                                         const char *setting_name,
-                                                         GHashTable *secrets,
-                                                         GError **error);
-void                nm_connection_set_path              (NMConnection *connection,
-                                                         const char *path);
-const char *        nm_connection_get_path              (NMConnection *connection);
-const char *        nm_connection_get_virtual_iface_name
-                                                        (NMConnection *connection);
-gboolean            nm_connection_is_type               (NMConnection *connection,
-                                                         const char *type);
-void                nm_connection_for_each_setting_value
-                                                        (NMConnection *connection,
-                                                         NMSettingValueIterFn func,
-                                                         gpointer user_data);
-GHashTable *        nm_connection_to_hash               (NMConnection *connection,
-                                                         NMSettingHashFlags flags);
-void                nm_connection_dump                  (NMConnection *connection);
-GType               nm_connection_lookup_setting_type   (const char *name);
-GType               nm_connection_lookup_setting_type_by_quark
-                                                        (GQuark error_quark);
-const char *        nm_connection_get_uuid              (NMConnection *connection);
-const char *        nm_connection_get_id                (NMConnection *connection);
-NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);
-NMSettingBluetooth * nm_connection_get_setting_bluetooth
-                                                        (NMConnection *connection);
-NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);
-NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);
-NMSettingBridgePort * nm_connection_get_setting_bridge_port
-                                                        (NMConnection *connection);
-NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);
-NMSettingConnection * nm_connection_get_setting_connection
-                                                        (NMConnection *connection);
-NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);
-NMSettingInfiniband * nm_connection_get_setting_infiniband
-                                                        (NMConnection *connection);
-NMSettingIP4Config * nm_connection_get_setting_ip4_config
-                                                        (NMConnection *connection);
-NMSettingIP6Config * nm_connection_get_setting_ip6_config
-                                                        (NMConnection *connection);
-NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);
-NMSettingPPP *      nm_connection_get_setting_ppp       (NMConnection *connection);
-NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);
-NMSettingSerial *   nm_connection_get_setting_serial    (NMConnection *connection);
-NMSettingVPN *      nm_connection_get_setting_vpn       (NMConnection *connection);
-NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);
-NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
-NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);
-NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);
-NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
-                                                        (NMConnection *connection);
-NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMConnectionError
-
-
-  GObject
-   +----NMConnection
-
-
-
-

Properties

-
-  "path"                     gchar*                : Read / Write / Construct
-
-
-
-

Signals

-
-  "secrets-cleared"                                : Run First
-  "secrets-updated"                                : Run First
-
-
-
-

Description

-

-An NMConnection describes all the settings and configuration values that -are necessary to configure network devices for operation on a specific -network. Connections are the fundamental operating object for -NetworkManager; no device is connected without a NMConnection, or -disconnected without having been connected with a NMConnection. -

-

-Each NMConnection contains a list of NMSetting objects usually referenced -by name (using nm_connection_get_setting_by_name()) or by type (with -nm_connection_get_setting()). The settings describe the actual parameters -with which the network devices are configured, including device-specific -parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters -(addresses, routes, addressing methods, etc). -

-
-

Details

-
-

enum NMConnectionError

-
typedef enum {
-	NM_CONNECTION_ERROR_UNKNOWN = 0,                  /*< nick=UnknownError >*/
-	NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND, /*< nick=ConnectionSettingNotFound >*/
-	NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID,      /*< nick=ConnectionTypeInvalid >*/
-	NM_CONNECTION_ERROR_SETTING_NOT_FOUND             /*< nick=SettingNotFound >*/
-} NMConnectionError;
-
-

-Describes errors that may result from operations involving a NMConnection. -

-
+

Functions

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

NM_CONNECTION_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_connection_error_quark ()

NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND

the NMConnection object - did not contain the required NMSettingConnection object, which must be - present for all connections + +NMConnection * + +nm_connection_new ()

NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID

the 'type' property of the - 'connection' setting did not point to a valid connection base type; ie - it was not a hardware-related setting like NMSettingWired or - NMSettingWireless. + +NMConnection * + +nm_connection_new_from_hash () +
+NMConnection * + +nm_connection_duplicate () +
+NMSetting * + +nm_connection_create_setting () +
+void + +nm_connection_add_setting () +
+void + +nm_connection_remove_setting () +
+NMSetting * + +nm_connection_get_setting () +
+NMSetting * + +nm_connection_get_setting_by_name () +
+gboolean + +nm_connection_replace_settings () +
+gboolean + +nm_connection_compare () +
+gboolean + +nm_connection_diff () +
+gboolean + +nm_connection_verify () +
const char * + +nm_connection_need_secrets () +
+void + +nm_connection_clear_secrets () +
+void + +nm_connection_clear_secrets_with_flags () +
+gboolean + +nm_connection_update_secrets () +
+void + +nm_connection_set_path () +
const char * + +nm_connection_get_path () +
const char * + +nm_connection_get_virtual_iface_name () +
+gboolean + +nm_connection_is_type () +
+void + +nm_connection_for_each_setting_value () +
+GHashTable * + +nm_connection_to_hash () +
+void + +nm_connection_dump () +
+GType + +nm_connection_lookup_setting_type () +
+GType + +nm_connection_lookup_setting_type_by_quark () +
const char * + +nm_connection_get_uuid () +
const char * + +nm_connection_get_id () +
+NMSetting8021x * + +nm_connection_get_setting_802_1x () +
+NMSettingBluetooth * + +nm_connection_get_setting_bluetooth () +
+NMSettingBond * + +nm_connection_get_setting_bond () +
+NMSettingBridge * + +nm_connection_get_setting_bridge () +
+NMSettingBridgePort * + +nm_connection_get_setting_bridge_port () +
+NMSettingCdma * + +nm_connection_get_setting_cdma ()

NM_CONNECTION_ERROR_SETTING_NOT_FOUND

the NMConnection object - did not contain the specified NMSetting object + +NMSettingConnection * + +nm_connection_get_setting_connection () +
+NMSettingGsm * + +nm_connection_get_setting_gsm () +
+NMSettingInfiniband * + +nm_connection_get_setting_infiniband () +
+NMSettingIP4Config * + +nm_connection_get_setting_ip4_config () +
+NMSettingIP6Config * + +nm_connection_get_setting_ip6_config () +
+NMSettingOlpcMesh * + +nm_connection_get_setting_olpc_mesh () +
+NMSettingPPP * + +nm_connection_get_setting_ppp () +
+NMSettingPPPOE * + +nm_connection_get_setting_pppoe () +
+NMSettingSerial * + +nm_connection_get_setting_serial () +
+NMSettingVPN * + +nm_connection_get_setting_vpn () +
+NMSettingWimax * + +nm_connection_get_setting_wimax () +
+NMSettingAdsl * + +nm_connection_get_setting_adsl () +
+NMSettingWired * + +nm_connection_get_setting_wired () +
+NMSettingWireless * + +nm_connection_get_setting_wireless () +
+NMSettingWirelessSecurity * + +nm_connection_get_setting_wireless_security () +
+NMSettingVlan * + +nm_connection_get_setting_vlan ()
-
-
-

NM_CONNECTION_ERROR

-
#define NM_CONNECTION_ERROR nm_connection_error_quark ()
-
-

-

-
-
-
-

nm_connection_error_quark ()

-
GQuark              nm_connection_error_quark           (void);
-

-Registers an error quark for NMConnection if necessary. -

-
+
+

Properties

+
--+++ - - + + +

Returns :

the error quark used for NMConnection errors. +gchar *pathRead / Write / Construct
-
-
-

NM_CONNECTION_PATH

-
#define NM_CONNECTION_PATH "path"
-
-

-

-
-
-
-

NMConnection

-
typedef struct _NMConnection NMConnection;
-

-The NMConnection struct contains only private data. -It should only be accessed through the functions described below. -

-
-
-
-

NMConnectionClass

-
typedef struct {
-	GObjectClass parent;
-
-	/* Signals */
-	void (*secrets_updated) (NMConnection *connection, const char * setting);
-} NMConnectionClass;
-
-

-

-
-
-
-

nm_connection_new ()

-
NMConnection *      nm_connection_new                   (void);
-

-Creates a new NMConnection object with no NMSetting objects. -

-
+
+

Signals

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

Returns :

the new empty NMConnection object
voidsecrets-clearedRun First
voidsecrets-updatedRun First
-
-
-

nm_connection_new_from_hash ()

-
NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
-                                                         GError **error);
-

-Creates a new NMConnection from a hash table describing the connection. See -nm_connection_to_hash() for a description of the expected hash table. -

-
+
+

Types and Values

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

hash :

the GHashTable describing -the connection. [element-type utf8 GLib.HashTable] -enumNMConnectionError

error :

on unsuccessful return, an error#defineNM_CONNECTION_ERROR

Returns :

the new NMConnection object, populated with settings created -from the values in the hash table, or NULL if the connection failed to -validate#defineNM_CONNECTION_PATH
 NMConnection
+
+

Object Hierarchy

+
    GEnum
+    ╰── NMConnectionError
+    GObject
+    ╰── NMConnection
+
+
+
+

Includes

+
#include <nm-connection.h>
+
+
+
+

Description

+

An NMConnection describes all the settings and configuration values that +are necessary to configure network devices for operation on a specific +network. Connections are the fundamental operating object for +NetworkManager; no device is connected without a NMConnection, or +disconnected without having been connected with a NMConnection.

+

Each NMConnection contains a list of NMSetting objects usually referenced +by name (using nm_connection_get_setting_by_name()) or by type (with +nm_connection_get_setting()). The settings describe the actual parameters +with which the network devices are configured, including device-specific +parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters +(addresses, routes, addressing methods, etc).

+
+
+

Functions

+
+

nm_connection_error_quark ()

+
GQuark
+nm_connection_error_quark (void);
+

Registers an error quark for NMConnection if necessary.

+
+

Returns

+

the error quark used for NMConnection errors.

+

+
+
-

nm_connection_duplicate ()

-
NMConnection *      nm_connection_duplicate             (NMConnection *connection);
-

-Duplicates a NMConnection. -

-
+

nm_connection_new ()

+
NMConnection *
+nm_connection_new (void);
+

Creates a new NMConnection object with no NMSetting objects.

+
+

Returns

+

the new empty NMConnection object

+

+
+ +
+
+

nm_connection_new_from_hash ()

+
NMConnection *
+nm_connection_new_from_hash (GHashTable *hash,
+                             GError **error);
+

Creates a new NMConnection from a hash table describing the connection. See +nm_connection_to_hash() for a description of the expected hash table.

+
+

Parameters

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

connection :

the NMConnection to duplicate

hash

the GHashTable describing +the connection.

[element-type utf8 GLib.HashTable]

Returns :

a new NMConnection containing the same settings and properties -as the source NMConnection. [transfer full] -

error

on unsuccessful return, an error

 
+
+

Returns

+

the new NMConnection object, populated with settings created +from the values in the hash table, or NULL if the connection failed to +validate

+

+
+
-

nm_connection_create_setting ()

-
NMSetting *         nm_connection_create_setting        (const char *name);
-

-Create a new NMSetting object of the desired type, given a setting name. -

-
+

nm_connection_duplicate ()

+
NMConnection *
+nm_connection_duplicate (NMConnection *connection);
+

Duplicates a NMConnection.

+
+

Parameters

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

name :

a setting name

Returns :

the new setting object, or NULL if the setting name was unknown. [transfer full] -

connection

the NMConnection to duplicate

 
+
+

Returns

+

a new NMConnection containing the same settings and properties +as the source NMConnection.

+

[transfer full]

+
+
-

nm_connection_add_setting ()

-
void                nm_connection_add_setting           (NMConnection *connection,
-                                                         NMSetting *setting);
-

-Adds a NMSetting to the connection, replacing any previous NMSetting of the +

nm_connection_create_setting ()

+
NMSetting *
+nm_connection_create_setting (const char *name);
+

Create a new NMSetting object of the desired type, given a setting name.

+
+

Parameters

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

name

a setting name

 
+
+
+

Returns

+

the new setting object, or NULL if the setting name was unknown.

+

[transfer full]

+
+
+
+
+

nm_connection_add_setting ()

+
void
+nm_connection_add_setting (NMConnection *connection,
+                           NMSetting *setting);
+

Adds a NMSetting to the connection, replacing any previous NMSetting of the same name which has previously been added to the NMConnection. The connection takes ownership of the NMSetting object and does not increase -the setting object's reference count. -

-
+the setting object's reference count.

+
+

Parameters

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

connection :

a NMConnection -

connection

a NMConnection

 

setting :

the NMSetting to add to the connection object. [transfer full] -

setting

the NMSetting to add to the connection object.

[transfer full]
+
-

nm_connection_remove_setting ()

-
void                nm_connection_remove_setting        (NMConnection *connection,
-                                                         GType setting_type);
-

-Removes the NMSetting with the given GType from the NMConnection. This -operation dereferences the NMSetting object. -

-
+

nm_connection_remove_setting ()

+
void
+nm_connection_remove_setting (NMConnection *connection,
+                              GType setting_type);
+

Removes the NMSetting with the given GType from the NMConnection. This +operation dereferences the NMSetting object.

+
+

Parameters

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

connection :

a NMConnection -

connection

a NMConnection

 

setting_type :

the GType of the setting object to remove

setting_type

the GType of the setting object to remove

 
+
-

nm_connection_get_setting ()

-
NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);
-

-Gets the NMSetting with the given GType, if one has been previously added -to the NMConnection. -

-
+

nm_connection_get_setting ()

+
NMSetting *
+nm_connection_get_setting (NMConnection *connection,
+                           GType setting_type);
+

Gets the NMSetting with the given GType, if one has been previously added +to the NMConnection.

+
+

Parameters

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

connection :

a NMConnection -

connection

a NMConnection

 

setting_type :

the GType of the setting object to return

Returns :

the NMSetting, or NULL if no setting of that type was previously -added to the NMConnection. [transfer none] -

setting_type

the GType of the setting object to return

 
+
+

Returns

+

the NMSetting, or NULL if no setting of that type was previously +added to the NMConnection.

+

[transfer none]

+
+
-

nm_connection_get_setting_by_name ()

-
NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);
-

-Gets the NMSetting with the given name, if one has been previously added -the the NMConnection. -

-
+

nm_connection_get_setting_by_name ()

+
NMSetting *
+nm_connection_get_setting_by_name (NMConnection *connection,
+                                   const char *name);
+

Gets the NMSetting with the given name, if one has been previously added +the the NMConnection.

+
+

Parameters

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

connection :

a NMConnection -

connection

a NMConnection

 

name :

a setting name

Returns :

the NMSetting, or NULL if no setting with that name was previously -added to the NMConnection. [transfer none] -

name

a setting name

 
+
+

Returns

+

the NMSetting, or NULL if no setting with that name was previously +added to the NMConnection.

+

[transfer none]

+
+
-

nm_connection_replace_settings ()

-
gboolean            nm_connection_replace_settings      (NMConnection *connection,
-                                                         GHashTable *new_settings,
-                                                         GError **error);
-
+

nm_connection_replace_settings ()

+
gboolean
+nm_connection_replace_settings (NMConnection *connection,
+                                GHashTable *new_settings,
+                                GError **error);
+
+

Parameters

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

connection :

a NMConnection -

new_settings :

a GHashTable of settings. [element-type utf8 GLib.HashTable] -

connection

a NMConnection

 

error :

location to store error, or NULL -

new_settings

a GHashTable of settings.

[element-type utf8 GLib.HashTable]

Returns :

 -TRUE if the settings were valid and added to the connection, FALSE -if they were not

error

location to store error, or NULL

 
+
+

Returns

+

TRUE if the settings were valid and added to the connection, FALSE +if they were not

+

+
+
-
-

nm_connection_compare ()

-
gboolean            nm_connection_compare               (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags);
-

-Compares two NMConnection objects for similarity, with comparison behavior -modified by a set of flags. See nm_setting_compare() for a description of -each flag's behavior. -

-
+
+

nm_connection_compare ()

+
gboolean
+nm_connection_compare (NMConnection *a,
+                       NMConnection *b,
+                       NMSettingCompareFlags flags);
+

Compares two NMConnection objects for similarity, with comparison behavior +modified by a set of flags. See nm_setting_compare() for a description of +each flag's behavior.

+
+

Parameters

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

a :

a NMConnection -

b :

a second NMConnection to compare with the first

a

a NMConnection

 

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT -

b

a second NMConnection to compare with the first

 

Returns :

 -TRUE if the comparison succeeds, FALSE if it does not

flags

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT

 
+
+

Returns

+

TRUE if the comparison succeeds, FALSE if it does not

+

+
+
-

nm_connection_diff ()

-
gboolean            nm_connection_diff                  (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags,
-                                                         GHashTable **out_settings);
-

-Compares two NMConnection objects for similarity, with comparison behavior -modified by a set of flags. See nm_setting_compare() for a description of +

nm_connection_diff ()

+
gboolean
+nm_connection_diff (NMConnection *a,
+                    NMConnection *b,
+                    NMSettingCompareFlags flags,
+                    GHashTable **out_settings);
+

Compares two NMConnection objects for similarity, with comparison behavior +modified by a set of flags. See nm_setting_compare() for a description of each flag's behavior. If the connections differ, settings and keys within -each setting that differ are added to the returned out_settings hash table. -No values are returned, only key names. -

-
+each setting that differ are added to the returned out_settings + hash table. +No values are returned, only key names.

+
+

Parameters

+
--+++ - - + + + - - + + + - - + + + - - + - - - - +differ mapped to one or more of NMSettingDiffResult as a bitfield.

+

a :

a NMConnection -

a

a NMConnection

 

b :

a second NMConnection to compare with the first

b

a second NMConnection to compare with the first

 

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT -

flags

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT

 

out_settings :

if the +

out_settings

if the connections differ, on return a hash table mapping setting names to second-level GHashTable (utf8 to guint32), which contains the key names that -differ mapped to one or more of NMSettingDiffResult as a bitfield. [element-type utf8 GLib.HashTable] -

Returns :

 -TRUE if the connections contain the same values, FALSE if they do -not[element-type utf8 GLib.HashTable]
+
+

Returns

+

TRUE if the connections contain the same values, FALSE if they do +not

+

+
+
-

nm_connection_verify ()

-
gboolean            nm_connection_verify                (NMConnection *connection,
-                                                         GError **error);
-

-Validates the connection and all its settings. Each setting's properties +

nm_connection_verify ()

+
gboolean
+nm_connection_verify (NMConnection *connection,
+                      GError **error);
+

Validates the connection and all its settings. Each setting's properties have allowed values, and some values are dependent on other values. For example, if a WiFi connection is security enabled, the NMSettingWireless setting object's 'security' property must contain the setting name of the @@ -651,1145 +943,1305 @@ setting object's 'security' property must contain the setting name of the connection for the connection to be valid. As another example, the NMSettingWired object's 'mac-address' property must be a validly formatted MAC address. The returned GError contains information about which -setting and which property failed validation, and how it failed validation. -

-
+setting and which property failed validation, and how it failed validation.

+
+

Parameters

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

connection :

the NMConnection to verify

error :

location to store error, or NULL -

connection

the NMConnection to verify

 

Returns :

 -TRUE if the connection is valid, FALSE if it is not

error

location to store error, or NULL

 
+
+

Returns

+

TRUE if the connection is valid, FALSE if it is not

+

+
+
-

nm_connection_need_secrets ()

-
const char *        nm_connection_need_secrets          (NMConnection *connection,
-                                                         GPtrArray **hints);
-

-Returns the name of the first setting object in the connection which would +

nm_connection_need_secrets ()

+
const char *
+nm_connection_need_secrets (NMConnection *connection,
+                            GPtrArray **hints);
+

Returns the name of the first setting object in the connection which would need secrets to make a successful connection. The returned hints are only intended as a guide to what secrets may be required, because in some circumstances, there is no way to conclusively determine exactly which -secrets are needed. -

-
+secrets are needed.

+
+

Parameters

+
--+++ - - + + + - - + - - - - +elements.

+

connection :

the NMConnection -

connection

the NMConnection

 

hints :

the address of a pointer to a GPtrArray, initialized to NULL, which on +

hints

the address of a pointer to a GPtrArray, initialized to NULL, which on return points to an allocated GPtrArray containing the property names of secrets of the NMSetting which may be required; the caller owns the array and must free the array itself with g_ptr_array_free(), but not free its -elements. [out][element-type utf8][allow-none][transfer container] -

Returns :

the setting name of the NMSetting object which has invalid or -missing secrets[out][element-type utf8][allow-none][transfer container]
+
+

Returns

+

the setting name of the NMSetting object which has invalid or +missing secrets

+

+
+
-

nm_connection_clear_secrets ()

-
void                nm_connection_clear_secrets         (NMConnection *connection);
-

-Clears and frees any secrets that may be stored in the connection, to avoid -keeping secret data in memory when not needed. -

-
+

nm_connection_clear_secrets ()

+
void
+nm_connection_clear_secrets (NMConnection *connection);
+

Clears and frees any secrets that may be stored in the connection, to avoid +keeping secret data in memory when not needed.

+
+

Parameters

+
--+++ - - + + +

connection :

the NMConnection -

connection

the NMConnection

 
+
-

nm_connection_clear_secrets_with_flags ()

-
void                nm_connection_clear_secrets_with_flags
-                                                        (NMConnection *connection,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
-

-Clears and frees secrets determined by func. -

-
+

nm_connection_clear_secrets_with_flags ()

+
void
+nm_connection_clear_secrets_with_flags
+                               (NMConnection *connection,
+                                NMSettingClearSecretsWithFlagsFn func,
+                                gpointer user_data);
+

Clears and frees secrets determined by func +.

+
+

Parameters

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

connection :

the NMConnection -

connection

the NMConnection

 

func :

function to be called to determine whether a -specific secret should be cleared or not. [scope call] -

func

function to be called to determine whether a +specific secret should be cleared or not.

[scope call]

user_data :

caller-supplied data passed to func -

user_data

caller-supplied data passed to func +

 
+
-

nm_connection_update_secrets ()

-
gboolean            nm_connection_update_secrets        (NMConnection *connection,
-                                                         const char *setting_name,
-                                                         GHashTable *secrets,
-                                                         GError **error);
-

-Update the specified setting's secrets, given a hash table of secrets +

nm_connection_update_secrets ()

+
gboolean
+nm_connection_update_secrets (NMConnection *connection,
+                              const char *setting_name,
+                              GHashTable *secrets,
+                              GError **error);
+

Update the specified setting's secrets, given a hash table of secrets intended for that setting (deserialized from D-Bus for example). Will also extract the given setting's secrets hash if given a hash of hashes, as would -be returned from nm_connection_to_hash(). If setting_name is NULL, expects -a fully serialized NMConnection as returned by nm_connection_to_hash() and -will update all secrets from all settings contained in secrets. -

-
+be returned from nm_connection_to_hash(). If setting_name + is NULL, expects +a fully serialized NMConnection as returned by nm_connection_to_hash() and +will update all secrets from all settings contained in secrets +.

+
+

Parameters

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

connection :

the NMConnection -

setting_name :

the setting object name to which the secrets apply

connection

the NMConnection

 

secrets :

a GHashTable mapping -string:GValue of setting property names and secrets of the given setting_name. [element-type utf8 GObject.Value] -

setting_name

the setting object name to which the secrets apply

 

error :

location to store error, or NULL -

secrets

a GHashTable mapping +string:GValue of setting property names and secrets of the given setting_name +.

[element-type utf8 GObject.Value]

Returns :

 -TRUE if the secrets were successfully updated, FALSE if the update -failed (tried to update secrets for a setting that doesn't exist, etc)

error

location to store error, or NULL

 
+
+

Returns

+

TRUE if the secrets were successfully updated, FALSE if the update +failed (tried to update secrets for a setting that doesn't exist, etc)

+

+
+
-

nm_connection_set_path ()

-
void                nm_connection_set_path              (NMConnection *connection,
-                                                         const char *path);
-

-Sets the D-Bus path of the connection. This property is not serialized, and -is only for the reference of the caller. Sets the "path" -property. -

-
+

nm_connection_set_path ()

+
void
+nm_connection_set_path (NMConnection *connection,
+                        const char *path);
+

Sets the D-Bus path of the connection. This property is not serialized, and +is only for the reference of the caller. Sets the “path” +property.

+
+

Parameters

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

connection :

the NMConnection -

connection

the NMConnection

 

path :

the D-Bus path of the connection as given by the settings service -which provides the connection

path

the D-Bus path of the connection as given by the settings service +which provides the connection

 
+
-

nm_connection_get_path ()

-
const char *        nm_connection_get_path              (NMConnection *connection);
-

-Returns the connection's D-Bus path. -

-
+

nm_connection_get_path ()

+
const char *
+nm_connection_get_path (NMConnection *connection);
+

Returns the connection's D-Bus path.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

the D-Bus path of the connection, previously set by a call to -nm_connection_set_path().

connection

the NMConnection

 
+
+

Returns

+

the D-Bus path of the connection, previously set by a call to +nm_connection_set_path().

+

+
+
-

nm_connection_get_virtual_iface_name ()

-
const char *        nm_connection_get_virtual_iface_name
-                                                        (NMConnection *connection);
-

-Returns the name of the virtual kernel interface which the connection +

nm_connection_get_virtual_iface_name ()

+
const char *
+nm_connection_get_virtual_iface_name (NMConnection *connection);
+

Returns the name of the virtual kernel interface which the connection needs to use if specified in the settings. This function abstracts all connection types which require this functionality. For all other -connection types, this function will return NULL. -

-
+connection types, this function will return NULL.

+
+

Parameters

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

connection :

The NMConnection -

Returns :

Name of the kernel interface or NULL -

connection

The NMConnection

 
+
+

Returns

+

Name of the kernel interface or NULL

+

+
+
-

nm_connection_is_type ()

-
gboolean            nm_connection_is_type               (NMConnection *connection,
-                                                         const char *type);
-

-A convenience function to check if the given connection is a particular -type (ie wired, wifi, ppp, etc). Checks the "type" -property of the connection and matches that against type. -

-
+

nm_connection_is_type ()

+
gboolean
+nm_connection_is_type (NMConnection *connection,
+                       const char *type);
+

A convenience function to check if the given connection + is a particular +type (ie wired, wifi, ppp, etc). Checks the “type” +property of the connection and matches that against type +.

+
+

Parameters

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

connection :

the NMConnection -

type :

a setting name to check the connection's type against (like -NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)

connection

the NMConnection

 

Returns :

 -TRUE if the connection is of the given type, FALSE if not

type

a setting name to check the connection's type against (like +NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)

 
+
+

Returns

+

TRUE if the connection is of the given type +, FALSE if not

+

+
+
-

nm_connection_for_each_setting_value ()

-
void                nm_connection_for_each_setting_value
-                                                        (NMConnection *connection,
-                                                         NMSettingValueIterFn func,
-                                                         gpointer user_data);
-

-Iterates over the properties of each NMSetting object in the NMConnection, -calling the supplied user function for each property. -

-
+

nm_connection_for_each_setting_value ()

+
void
+nm_connection_for_each_setting_value (NMConnection *connection,
+                                      NMSettingValueIterFn func,
+                                      gpointer user_data);
+

Iterates over the properties of each NMSetting object in the NMConnection, +calling the supplied user function for each property.

+
+

Parameters

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

connection :

the NMConnection -

connection

the NMConnection

 

func :

user-supplied function called for each setting's property. [scope call] -

func

user-supplied function called for each setting's property.

[scope call]

user_data :

user data passed to func at each invocation

user_data

user data passed to func +at each invocation

 
+
-

nm_connection_to_hash ()

-
GHashTable *        nm_connection_to_hash               (NMConnection *connection,
-                                                         NMSettingHashFlags flags);
-

-Converts the NMConnection into a GHashTable describing the connection, +

nm_connection_to_hash ()

+
GHashTable *
+nm_connection_to_hash (NMConnection *connection,
+                       NMSettingHashFlags flags);
+

Converts the NMConnection into a GHashTable describing the connection, suitable for marshalling over D-Bus or serializing. The hash table mapping is string:GHashTable with each element in the returned hash representing a NMSetting object. The keys are setting object names, and the values are GHashTables mapping string:GValue, each of which represents the -properties of the NMSetting object. -

-
+properties of the NMSetting object.

+
+

Parameters

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

connection :

the NMConnection -

flags :

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL -

connection

the NMConnection

 

Returns :

a new -GHashTable describing the connection, its settings, and each setting's -properties. The caller owns the hash table and must unref the hash table -with g_hash_table_unref() when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable] -

flags

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL

 
+
+

Returns

+

a new +GHashTable describing the connection, its settings, and each setting's +properties. The caller owns the hash table and must unref the hash table +with g_hash_table_unref() when it is no longer needed.

+

[transfer full][element-type utf8 GLib.HashTable]

+
+
-

nm_connection_dump ()

-
void                nm_connection_dump                  (NMConnection *connection);
-

-Print the connection to stdout. For debugging purposes ONLY, should NOT +

nm_connection_dump ()

+
void
+nm_connection_dump (NMConnection *connection);
+

Print the connection to stdout. For debugging purposes ONLY, should NOT be used for serialization of the connection or machine-parsed in any way. The -output format is not guaranteed to be stable and may change at any time. -

-
+output format is not guaranteed to be stable and may change at any time.

+
+

Parameters

+
--+++ - - + + +

connection :

the NMConnection -

connection

the NMConnection

 
+
-

nm_connection_lookup_setting_type ()

-
GType               nm_connection_lookup_setting_type   (const char *name);
-

-Returns the GType of the setting's class for a given setting name. -

-
+

nm_connection_lookup_setting_type ()

+
GType
+nm_connection_lookup_setting_type (const char *name);
+

Returns the GType of the setting's class for a given setting name.

+
+

Parameters

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

name :

a setting name

Returns :

the GType of the setting's class

name

a setting name

 
+
+

Returns

+

the GType of the setting's class

+

+
+
-

nm_connection_lookup_setting_type_by_quark ()

-
GType               nm_connection_lookup_setting_type_by_quark
-                                                        (GQuark error_quark);
-

-Returns the GType of the setting's class for a given setting error quark. -Useful for figuring out which setting a returned error is for. -

-
+

nm_connection_lookup_setting_type_by_quark ()

+
GType
+nm_connection_lookup_setting_type_by_quark
+                               (GQuark error_quark);
+

Returns the GType of the setting's class for a given setting error quark. +Useful for figuring out which setting a returned error is for.

+
+

Parameters

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

error_quark :

a setting error quark

Returns :

the GType of the setting's class

error_quark

a setting error quark

 
+
+

Returns

+

the GType of the setting's class

+

+
+
-

nm_connection_get_uuid ()

-
const char *        nm_connection_get_uuid              (NMConnection *connection);
-

-A shortcut to return the UUID from the connection's NMSettingConnection. -

-
+

nm_connection_get_uuid ()

+
const char *
+nm_connection_get_uuid (NMConnection *connection);
+

A shortcut to return the UUID from the connection's NMSettingConnection.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

the UUID from the connection's 'connection' setting

connection

the NMConnection

 
+
+

Returns

+

the UUID from the connection's 'connection' setting

+

+
+
-

nm_connection_get_id ()

-
const char *        nm_connection_get_id                (NMConnection *connection);
-

-A shortcut to return the ID from the connection's NMSettingConnection. -

-
+

nm_connection_get_id ()

+
const char *
+nm_connection_get_id (NMConnection *connection);
+

A shortcut to return the ID from the connection's NMSettingConnection.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

the ID from the connection's 'connection' setting

connection

the NMConnection

 
+
+

Returns

+

the ID from the connection's 'connection' setting

+

+
+
-

nm_connection_get_setting_802_1x ()

-
NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);
-

-A shortcut to return any NMSetting8021x the connection might contain. -

-
+

nm_connection_get_setting_802_1x ()

+
NMSetting8021x *
+nm_connection_get_setting_802_1x (NMConnection *connection);
+

A shortcut to return any NMSetting8021x the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSetting8021x if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSetting8021x if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_bluetooth ()

-
NMSettingBluetooth * nm_connection_get_setting_bluetooth
-                                                        (NMConnection *connection);
-

-A shortcut to return any NMSettingBluetooth the connection might contain. -

-
+

nm_connection_get_setting_bluetooth ()

+
NMSettingBluetooth *
+nm_connection_get_setting_bluetooth (NMConnection *connection);
+

A shortcut to return any NMSettingBluetooth the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingBluetooth if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingBluetooth if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_bond ()

-
NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);
-

-A shortcut to return any NMSettingBond the connection might contain. -

-
+

nm_connection_get_setting_bond ()

+
NMSettingBond *
+nm_connection_get_setting_bond (NMConnection *connection);
+

A shortcut to return any NMSettingBond the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingBond if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingBond if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_bridge ()

-
NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);
-

-A shortcut to return any NMSettingBridge the connection might contain. -

-
+

nm_connection_get_setting_bridge ()

+
NMSettingBridge *
+nm_connection_get_setting_bridge (NMConnection *connection);
+

A shortcut to return any NMSettingBridge the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingBridge if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+
+

Returns

+

an NMSettingBridge if the connection contains one, otherwise NULL.

+

[transfer none]

+
+ +
+
+

nm_connection_get_setting_bridge_port ()

+
NMSettingBridgePort *
+nm_connection_get_setting_bridge_port (NMConnection *connection);
+

A shortcut to return any NMSettingBridgePort the connection might contain.

+
+

Parameters

+
+++++ + + + + +

connection

the NMConnection

 
+
+

Returns

+

an NMSettingBridgePort if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
+
+
+

nm_connection_get_setting_cdma ()

+
NMSettingCdma *
+nm_connection_get_setting_cdma (NMConnection *connection);
+

A shortcut to return any NMSettingCdma the connection might contain.

+
+

Parameters

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

connection

the NMConnection

 
+
+
+

Returns

+

an NMSettingCdma if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
+
+
+

nm_connection_get_setting_connection ()

+
NMSettingConnection *
+nm_connection_get_setting_connection (NMConnection *connection);
+

A shortcut to return any NMSettingConnection the connection might contain.

+
+

Parameters

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

connection

the NMConnection

 
+
+
+

Returns

+

an NMSettingConnection if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
+
+
+

nm_connection_get_setting_gsm ()

+
NMSettingGsm *
+nm_connection_get_setting_gsm (NMConnection *connection);
+

A shortcut to return any NMSettingGsm the connection might contain.

+
+

Parameters

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

connection

the NMConnection

 
+
+
+

Returns

+

an NMSettingGsm if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_bridge_port ()

-
NMSettingBridgePort * nm_connection_get_setting_bridge_port
-                                                        (NMConnection *connection);
-

-A shortcut to return any NMSettingBridgePort the connection might contain. -

-
+

nm_connection_get_setting_infiniband ()

+
NMSettingInfiniband *
+nm_connection_get_setting_infiniband (NMConnection *connection);
+

A shortcut to return any NMSettingInfiniband the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingBridgePort if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingInfiniband if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_cdma ()

-
NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);
-

-A shortcut to return any NMSettingCdma the connection might contain. -

-
+

nm_connection_get_setting_ip4_config ()

+
NMSettingIP4Config *
+nm_connection_get_setting_ip4_config (NMConnection *connection);
+

A shortcut to return any NMSettingIP4Config the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingIP4Config if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_connection ()

-
NMSettingConnection * nm_connection_get_setting_connection
-                                                        (NMConnection *connection);
-

-A shortcut to return any NMSettingConnection the connection might contain. -

-
+

nm_connection_get_setting_ip6_config ()

+
NMSettingIP6Config *
+nm_connection_get_setting_ip6_config (NMConnection *connection);
+

A shortcut to return any NMSettingIP6Config the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingIP6Config if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_gsm ()

-
NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);
-

-A shortcut to return any NMSettingGsm the connection might contain. -

-
+

nm_connection_get_setting_olpc_mesh ()

+
NMSettingOlpcMesh *
+nm_connection_get_setting_olpc_mesh (NMConnection *connection);
+

A shortcut to return any NMSettingOlpcMesh the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingOlpcMesh if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_infiniband ()

-
NMSettingInfiniband * nm_connection_get_setting_infiniband
-                                                        (NMConnection *connection);
-

-A shortcut to return any NMSettingInfiniband the connection might contain. -

-
+

nm_connection_get_setting_ppp ()

+
NMSettingPPP *
+nm_connection_get_setting_ppp (NMConnection *connection);
+

A shortcut to return any NMSettingPPP the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingInfiniband if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingPPP if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_ip4_config ()

-
NMSettingIP4Config * nm_connection_get_setting_ip4_config
-                                                        (NMConnection *connection);
-

-A shortcut to return any NMSettingIP4Config the connection might contain. -

-
+

nm_connection_get_setting_pppoe ()

+
NMSettingPPPOE *
+nm_connection_get_setting_pppoe (NMConnection *connection);
+

A shortcut to return any NMSettingPPPOE the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingIP4Config if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingPPPOE if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_ip6_config ()

-
NMSettingIP6Config * nm_connection_get_setting_ip6_config
-                                                        (NMConnection *connection);
-

-A shortcut to return any NMSettingIP6Config the connection might contain. -

-
+

nm_connection_get_setting_serial ()

+
NMSettingSerial *
+nm_connection_get_setting_serial (NMConnection *connection);
+

A shortcut to return any NMSettingSerial the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingIP6Config if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingSerial if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_olpc_mesh ()

-
NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);
-

-A shortcut to return any NMSettingOlpcMesh the connection might contain. -

-
+

nm_connection_get_setting_vpn ()

+
NMSettingVPN *
+nm_connection_get_setting_vpn (NMConnection *connection);
+

A shortcut to return any NMSettingVPN the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingOlpcMesh if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingVPN if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_ppp ()

-
NMSettingPPP *      nm_connection_get_setting_ppp       (NMConnection *connection);
-

-A shortcut to return any NMSettingPPP the connection might contain. -

-
+

nm_connection_get_setting_wimax ()

+
NMSettingWimax *
+nm_connection_get_setting_wimax (NMConnection *connection);
+

A shortcut to return any NMSettingWimax the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingPPP if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingWimax if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_pppoe ()

-
NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);
-

-A shortcut to return any NMSettingPPPOE the connection might contain. -

-
+

nm_connection_get_setting_adsl ()

+
NMSettingAdsl *
+nm_connection_get_setting_adsl (NMConnection *connection);
+

A shortcut to return any NMSettingAdsl the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingPPPOE if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingAdsl if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_serial ()

-
NMSettingSerial *   nm_connection_get_setting_serial    (NMConnection *connection);
-

-A shortcut to return any NMSettingSerial the connection might contain. -

-
+

nm_connection_get_setting_wired ()

+
NMSettingWired *
+nm_connection_get_setting_wired (NMConnection *connection);
+

A shortcut to return any NMSettingWired the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingSerial if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingWired if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_vpn ()

-
NMSettingVPN *      nm_connection_get_setting_vpn       (NMConnection *connection);
-

-A shortcut to return any NMSettingVPN the connection might contain. -

-
+

nm_connection_get_setting_wireless ()

+
NMSettingWireless *
+nm_connection_get_setting_wireless (NMConnection *connection);
+

A shortcut to return any NMSettingWireless the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingVPN if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingWireless if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_wimax ()

-
NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);
-

-A shortcut to return any NMSettingWimax the connection might contain. -

-
+

nm_connection_get_setting_wireless_security ()

+
NMSettingWirelessSecurity *
+nm_connection_get_setting_wireless_security
+                               (NMConnection *connection);
+

A shortcut to return any NMSettingWirelessSecurity the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingWimax if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
+
+

Returns

+

an NMSettingWirelessSecurity if the connection contains one, otherwise NULL.

+

[transfer none]

+
+
-

nm_connection_get_setting_adsl ()

-
NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
-

-A shortcut to return any NMSettingAdsl the connection might contain. -

-
+

nm_connection_get_setting_vlan ()

+
NMSettingVlan *
+nm_connection_get_setting_vlan (NMConnection *connection);
+

A shortcut to return any NMSettingVlan the connection might contain.

+
+

Parameters

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

connection :

the NMConnection -

Returns :

an NMSettingAdsl if the connection contains one, otherwise NULL. [transfer none] -

connection

the NMConnection

 
-
+
+

Returns

+

an NMSettingVlan if the connection contains one, otherwise NULL.

+

[transfer none]

+
+ + +
+

Types and Values

-

nm_connection_get_setting_wired ()

-
NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);
-

-A shortcut to return any NMSettingWired the connection might contain. -

-
+

enum NMConnectionError

+

Describes errors that may result from operations involving a NMConnection.

+
+

Members

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

connection :

the NMConnection +

NM_CONNECTION_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

an NMSettingWired if the connection contains one, otherwise NULL. [transfer none] +

NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND

 +

the NMConnection object + did not contain the required NMSettingConnection object, which must be + present for all connections

 
-
-
-
-

nm_connection_get_setting_wireless ()

-
NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);
-

-A shortcut to return any NMSettingWireless the connection might contain. -

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

connection :

the NMConnection +

NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID

 +

the 'type' property of the + 'connection' setting did not point to a valid connection base type; ie + it was not a hardware-related setting like NMSettingWired or + NMSettingWireless.

 

Returns :

an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none] +

NM_CONNECTION_ERROR_SETTING_NOT_FOUND

 +

the NMConnection object + did not contain the specified NMSetting object

 
+
-

nm_connection_get_setting_wireless_security ()

-
NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
-                                                        (NMConnection *connection);
+

NM_CONNECTION_ERROR

+
#define NM_CONNECTION_ERROR nm_connection_error_quark ()
+

-A shortcut to return any NMSettingWirelessSecurity the connection might contain.

-
---- - - - - - - - - - - -

connection :

the NMConnection -

Returns :

an NMSettingWirelessSecurity if the connection contains one, otherwise NULL. [transfer none] -
-

nm_connection_get_setting_vlan ()

-
NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);
+

NM_CONNECTION_PATH

+
#define NM_CONNECTION_PATH "path"
+

-A shortcut to return any NMSettingVlan the connection might contain.

-
---- - - - - - - - - - - -

connection :

the NMConnection -

Returns :

an NMSettingVlan if the connection contains one, otherwise NULL. [transfer none] -
+
+
+
+

NMConnection

+
typedef struct _NMConnection NMConnection;
+

The NMConnection struct contains only private data. +It should only be accessed through the functions described below.

Property Details

-

The "path" property

-
  "path"                     gchar*                : Read / Write / Construct
-

-The connection's D-Bus path, used only by the calling process as a record -of the D-Bus path of the connection as provided by a settings service. -

+

The “path” property

+
  “path”                     gchar *
+

The connection's D-Bus path, used only by the calling process as a record +of the D-Bus path of the connection as provided by a settings service.

+

Flags: Read / Write / Construct

Default value: NULL

Signal Details

-

The "secrets-cleared" signal

-
void                user_function                      (NMConnection *connection,
-                                                        gpointer      user_data)       : Run First
-

-The ::secrets-cleared signal is emitted when the secrets of a connection -are cleared. -

-
+

The “secrets-cleared” signal

+
void
+user_function (NMConnection *connection,
+               gpointer      user_data)
+

The ::secrets-cleared signal is emitted when the secrets of a connection +are cleared.

+
+

Parameters

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

connection :

the object on which the signal is emitted

connection

the object on which the signal is emitted

 

user_data :

user data set when the signal handler was connected.

user_data

user data set when the signal handler was connected.

 
+

Flags: Run First

+
-

The "secrets-updated" signal

-
void                user_function                      (NMConnection *connection,
-                                                        gchar        *setting_name,
-                                                        gpointer      user_data)         : Run First
-

-The ::secrets-updated signal is emitted when the secrets of a setting -have been changed. -

-
+

The “secrets-updated” signal

+
void
+user_function (NMConnection *connection,
+               gchar        *setting_name,
+               gpointer      user_data)
+

The ::secrets-updated signal is emitted when the secrets of a setting +have been changed.

+
+

Parameters

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

connection :

the object on which the signal is emitted

connection

the object on which the signal is emitted

 

setting_name :

the setting name of the NMSetting for which secrets were -updated

setting_name

the setting name of the NMSetting for which secrets were +updated

 

user_data :

user data set when the signal handler was connected.

user_data

user data set when the signal handler was connected.

 
+

Flags: Run First

+
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html index a44ef38f..ae62da3e 100644 --- a/docs/libnm-util/html/NMSetting.html +++ b/docs/libnm-util/html/NMSetting.html @@ -2,34 +2,28 @@ -NMSetting +libnm-util Reference Manual: NMSetting - + - - - - - - - - - - + + + + + + +
@@ -37,215 +31,305 @@

NMSetting

NMSetting — Describes related configuration information

- +
-
-

Synopsis

-
-#include <nm-setting.h>
-
-enum                NMSettingError;
-#define             NM_SETTING_ERROR
-GQuark              nm_setting_error_quark              (void);
-#define             NM_SETTING_PARAM_SERIALIZE
-#define             NM_SETTING_PARAM_REQUIRED
-#define             NM_SETTING_PARAM_SECRET
-#define             NM_SETTING_PARAM_FUZZY_IGNORE
-#define             NM_SETTING_NAME
-enum                NMSettingSecretFlags;
-enum                NMSettingCompareFlags;
-                    NMSetting;
-gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
-                                                         const char *secret,
-                                                         NMSettingSecretFlags flags,
-                                                         gpointer user_data);
-                    NMSettingClass;
-void                (*NMSettingValueIterFn)             (NMSetting *setting,
-                                                         const char *key,
-                                                         const GValue *value,
-                                                         GParamFlags flags,
-                                                         gpointer user_data);
-enum                NMSettingHashFlags;
-GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
-                                                         NMSettingHashFlags flags);
-NMSetting *         nm_setting_new_from_hash            (GType setting_type,
-                                                         GHashTable *hash);
-NMSetting *         nm_setting_duplicate                (NMSetting *setting);
-const char *        nm_setting_get_name                 (NMSetting *setting);
-gboolean            nm_setting_verify                   (NMSetting *setting,
-                                                         GSList *all_settings,
-                                                         GError **error);
-gboolean            nm_setting_compare                  (NMSetting *a,
-                                                         NMSetting *b,
-                                                         NMSettingCompareFlags flags);
-enum                NMSettingDiffResult;
-gboolean            nm_setting_diff                     (NMSetting *a,
-                                                         NMSetting *b,
-                                                         NMSettingCompareFlags flags,
-                                                         gboolean invert_results,
-                                                         GHashTable **results);
-void                nm_setting_enumerate_values         (NMSetting *setting,
-                                                         NMSettingValueIterFn func,
-                                                         gpointer user_data);
-char *              nm_setting_to_string                (NMSetting *setting);
-void                nm_setting_clear_secrets            (NMSetting *setting);
-void                nm_setting_clear_secrets_with_flags (NMSetting *setting,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
-GPtrArray *         nm_setting_need_secrets             (NMSetting *setting);
-gboolean            nm_setting_update_secrets           (NMSetting *setting,
-                                                         GHashTable *secrets,
-                                                         GError **error);
-gboolean            nm_setting_get_secret_flags         (NMSetting *setting,
-                                                         const char *secret_name,
-                                                         NMSettingSecretFlags *out_flags,
-                                                         GError **error);
-gboolean            nm_setting_set_secret_flags         (NMSetting *setting,
-                                                         const char *secret_name,
-                                                         NMSettingSecretFlags flags,
-                                                         GError **error);
-const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingError
-
-
-  GEnum
-   +----NMSettingSecretFlags
-
-
-  GEnum
-   +----NMSettingCompareFlags
-
-
-  GObject
-   +----NMSetting
-         +----NMSetting8021x
-         +----NMSettingAdsl
-         +----NMSettingBluetooth
-         +----NMSettingBond
-         +----NMSettingBridge
-         +----NMSettingBridgePort
-         +----NMSettingConnection
-         +----NMSettingInfiniband
-         +----NMSettingIP4Config
-         +----NMSettingVlan
-         +----NMSettingIP6Config
-         +----NMSettingPPP
-         +----NMSettingPPPOE
-         +----NMSettingSerial
-         +----NMSettingGsm
-         +----NMSettingCdma
-         +----NMSettingOlpcMesh
-         +----NMSettingWimax
-         +----NMSettingWired
-         +----NMSettingWireless
-         +----NMSettingWirelessSecurity
-         +----NMSettingVPN
-
-
-  GEnum
-   +----NMSettingHashFlags
-
-
-  GEnum
-   +----NMSettingDiffResult
-
-
-
-

Properties

-
-  "name"                     gchar*                : Read / Write
-
-
-
-

Description

-

-Each NMSetting contains properties that describe configuration that applies -to a specific network layer (like IPv4 or IPv6 configuration) or device type -(like Ethernet, or WiFi). A collection of individual settings together -make up an NMConnection. Each property is strongly typed and usually has -a number of allowed values. See each NMSetting subclass for a description -of properties and allowed values. -

-
-
-

Details

-
-

enum NMSettingError

-
typedef enum {
-	NM_SETTING_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_ERROR_PROPERTY_NOT_FOUND,    /*< nick=PropertyNotFound >*/
-	NM_SETTING_ERROR_PROPERTY_NOT_SECRET,   /*< nick=PropertyNotSecret >*/
-	NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH /*< nick=PropertyTypeMismatch >*/
-} NMSettingError;
-
-

-Describes errors that may result from operations involving a NMSetting. -

-
+

Functions

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

NM_SETTING_ERROR_UNKNOWN

unknown or unclassified error + +GQuark +nm_setting_error_quark () +
#defineNM_SETTING_PARAM_SERIALIZE
#defineNM_SETTING_PARAM_REQUIRED
#defineNM_SETTING_PARAM_SECRET

NM_SETTING_ERROR_PROPERTY_NOT_FOUND

a property required by the operation - was not found; for example, an attempt to update an invalid secret +#defineNM_SETTING_PARAM_FUZZY_IGNORE
+gboolean + +(*NMSettingClearSecretsWithFlagsFn) ()

NM_SETTING_ERROR_PROPERTY_NOT_SECRET

an operation which requires a secret - was attempted on a non-secret property + +void + +(*NMSettingValueIterFn) ()

NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH

the operation requires a property - of a specific type, or the value couldn't be transformed to the same type - as the property being acted upon + +GHashTable * + +nm_setting_to_hash () +
+NMSetting * + +nm_setting_new_from_hash () +
+NMSetting * + +nm_setting_duplicate () +
const char * + +nm_setting_get_name () +
+gboolean + +nm_setting_verify () +
+gboolean + +nm_setting_compare () +
+gboolean + +nm_setting_diff () +
+void + +nm_setting_enumerate_values () +
+char * + +nm_setting_to_string () +
+void + +nm_setting_clear_secrets () +
+void + +nm_setting_clear_secrets_with_flags () +
+GPtrArray * + +nm_setting_need_secrets () +
+gboolean + +nm_setting_update_secrets () +
+gboolean + +nm_setting_get_secret_flags () +
+gboolean + +nm_setting_set_secret_flags () +
const char * + +nm_setting_get_virtual_iface_name ()
-
-
-

NM_SETTING_ERROR

-
#define NM_SETTING_ERROR nm_setting_error_quark ()
-
-

-

-
-
-
-

nm_setting_error_quark ()

-
GQuark              nm_setting_error_quark              (void);
-

-Registers an error quark for NMSetting if necessary. -

-
+
+

Properties

+
--+++ - - + + +

Returns :

the error quark used for NMSetting errors. +gchar *nameRead / Write
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
enumNMSettingError
#defineNM_SETTING_ERROR
#defineNM_SETTING_NAME
enumNMSettingSecretFlags
enumNMSettingCompareFlags
 NMSetting
enumNMSettingHashFlags
enumNMSettingDiffResult
+
+
+

Object Hierarchy

+
    GEnum
+    ├── NMSettingCompareFlags
+    ├── NMSettingDiffResult
+    ├── NMSettingError
+    ├── NMSettingHashFlags
+    ╰── NMSettingSecretFlags
+    GObject
+    ╰── NMSetting
+        ├── NMSetting8021x
+        ├── NMSettingAdsl
+        ├── NMSettingBluetooth
+        ├── NMSettingBond
+        ├── NMSettingBridge
+        ├── NMSettingBridgePort
+        ├── NMSettingConnection
+        ├── NMSettingInfiniband
+        ├── NMSettingIP4Config
+        ├── NMSettingVlan
+        ├── NMSettingIP6Config
+        ├── NMSettingPPP
+        ├── NMSettingPPPOE
+        ├── NMSettingSerial
+        ├── NMSettingGsm
+        ├── NMSettingCdma
+        ├── NMSettingOlpcMesh
+        ├── NMSettingWimax
+        ├── NMSettingWired
+        ├── NMSettingWireless
+        ├── NMSettingWirelessSecurity
+        ╰── NMSettingVPN
+
+
+
+

Includes

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

Description

+

Each NMSetting contains properties that describe configuration that applies +to a specific network layer (like IPv4 or IPv6 configuration) or device type +(like Ethernet, or WiFi). A collection of individual settings together +make up an NMConnection. Each property is strongly typed and usually has +a number of allowed values. See each NMSetting subclass for a description +of properties and allowed values.

+
+
+

Functions

+
+

nm_setting_error_quark ()

+
GQuark
+nm_setting_error_quark (void);
+

Registers an error quark for NMSetting if necessary.

+
+

Returns

+

the error quark used for NMSetting errors.

+

+
+

NM_SETTING_PARAM_SERIALIZE

@@ -280,920 +364,1012 @@ Registers an error quark for -

NM_SETTING_NAME

-
#define NM_SETTING_NAME "name"
-
-

-

-
-
-
-

enum NMSettingSecretFlags

-
typedef enum {
-	NM_SETTING_SECRET_FLAG_NONE         = 0x00000000,
-	NM_SETTING_SECRET_FLAG_AGENT_OWNED  = 0x00000001,
-	NM_SETTING_SECRET_FLAG_NOT_SAVED    = 0x00000002,
-	NM_SETTING_SECRET_FLAG_NOT_REQUIRED = 0x00000004
-
-	/* NOTE: if adding flags, update nm-setting-private.h as well */
-} NMSettingSecretFlags;
-
-

-These flags indicate specific behavior related to handling of a secret. Each -secret has a corresponding set of these flags which indicate how the secret -is to be stored and/or requested when it is needed. -

-
+

NMSettingClearSecretsWithFlagsFn ()

+
gboolean
+(*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
+                                     const char *secret,
+                                     NMSettingSecretFlags flags,
+                                     gpointer user_data);
+
+

Parameters

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

NM_SETTING_SECRET_FLAG_NONE

the system is responsible for providing and -storing this secret (default) -

setting

The setting for which secrets are being iterated

 

NM_SETTING_SECRET_FLAG_AGENT_OWNED

a user secret agent is responsible -for providing and storing this secret; when it is required agents will be -asked to retrieve it -

secret

The secret's name

 

NM_SETTING_SECRET_FLAG_NOT_SAVED

this secret should not be saved, but -should be requested from the user each time it is needed -

flags

The secret's flags, eg NM_SETTING_SECRET_FLAG_AGENT_OWNED

 

NM_SETTING_SECRET_FLAG_NOT_REQUIRED

in situations where it cannot be -automatically determined that the secret is required (some VPNs and PPP -providers dont require all secrets) this flag indicates that the specific -secret is not required -

user_data

User data passed to nm_connection_clear_secrets_with_flags()

 
+
+

Returns

+

TRUE to clear the secret, FALSE to not clear the secret

+

+
+
-

enum NMSettingCompareFlags

-
typedef enum {
-	NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000,
-	NM_SETTING_COMPARE_FLAG_FUZZY = 0x00000001,
-	NM_SETTING_COMPARE_FLAG_IGNORE_ID = 0x00000002,
-	NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS = 0x00000004,
-	NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS = 0x00000008,
-	NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS = 0x00000010
-} NMSettingCompareFlags;
-
-

-These flags modify the comparison behavior when comparing two settings or -two connections. -

-
+

NMSettingValueIterFn ()

+
void
+(*NMSettingValueIterFn) (NMSetting *setting,
+                         const char *key,
+                         const GValue *value,
+                         GParamFlags flags,
+                         gpointer user_data);
+
+

Parameters

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

NM_SETTING_COMPARE_FLAG_EXACT

match all properties exactly -

setting

The setting for which properties are being iterated, given to +nm_setting_enumerate_values()

 

NM_SETTING_COMPARE_FLAG_FUZZY

match only important attributes, like SSID, - type, security settings, etc. Does not match, for example, connection ID - or UUID. -

key

The value/property name

 

NM_SETTING_COMPARE_FLAG_IGNORE_ID

ignore the connection's ID -

value

The property's value

 

NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS

ignore all secrets -

flags

The property's flags, like NM_SETTING_PARAM_SECRET

 

NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS

ignore secrets for which -the secret's flags indicate the secret is owned by a user secret agent -(ie, the secret's flag includes NM_SETTING_SECRET_FLAG_AGENT_OWNED) -

NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS

ignore secrets for which -the secret's flags indicate the secret should not be saved to persistent -storage (ie, the secret's flag includes NM_SETTING_SECRET_FLAG_NOT_SAVED) -

user_data

User data passed to nm_setting_enumerate_values()

 
-
-
-

NMSetting

-
typedef struct _NMSetting NMSetting;
-

-The NMSetting struct contains only private data. -It should only be accessed through the functions described below. -

-

NMSettingClearSecretsWithFlagsFn ()

-
gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
-                                                         const char *secret,
-                                                         NMSettingSecretFlags flags,
-                                                         gpointer user_data);
-
+

nm_setting_to_hash ()

+
GHashTable *
+nm_setting_to_hash (NMSetting *setting,
+                    NMSettingHashFlags flags);
+

Converts the NMSetting into a GHashTable mapping each setting property +name to a GValue describing that property, suitable for marshalling over +D-Bus or serializing. The mapping is string to GValue.

+
+

Parameters

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

setting :

The setting for which secrets are being iterated

setting

the NMSetting

 

secret :

The secret's name

flags :

The secret's flags, eg NM_SETTING_SECRET_FLAG_AGENT_OWNED -

flags

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL

 
+
+
+

Returns

+

a new GHashTable +describing the setting's properties.

+

[transfer full][element-type utf8 GObject.Value]

+
+
+
+
+

nm_setting_new_from_hash ()

+
NMSetting *
+nm_setting_new_from_hash (GType setting_type,
+                          GHashTable *hash);
+

Creates a new NMSetting object and populates that object with the properties +contained in the hash table, using each hash key as the property to set, +and each hash value as the value to set that property to. Setting properties +are strongly typed, thus the GValue type of the hash value must be correct. +See the documentation on each NMSetting object subclass for the correct +property names and value types.

+
+

Parameters

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

user_data :

User data passed to nm_connection_clear_secrets_with_flags() -

setting_type

the NMSetting type which the hash contains properties for

 

Returns :

 -TRUE to clear the secret, FALSE to not clear the secret

hash

the GHashTable containing a +string to GValue mapping of properties that apply to the setting.

[element-type utf8 GObject.Value]
+
+

Returns

+

a new NMSetting object populated with the properties from the +hash table, or NULL on failure

+

+
+
-

NMSettingClass

-
typedef struct {
-	GObjectClass parent;
-
-	/* Virtual functions */
-	gboolean    (*verify)            (NMSetting  *setting,
-	                                  GSList     *all_settings,
-	                                  GError     **error);
-
-	GPtrArray  *(*need_secrets)      (NMSetting  *setting);
-
-	gboolean    (*update_one_secret) (NMSetting  *setting,
-	                                  const char *key,
-	                                  GValue     *value,
-	                                  GError    **error);
-
-	gboolean    (*get_secret_flags)  (NMSetting  *setting,
-	                                  const char *secret_name,
-	                                  gboolean verify_secret,
-	                                  NMSettingSecretFlags *out_flags,
-	                                  GError **error);
-
-	gboolean    (*set_secret_flags)  (NMSetting  *setting,
-	                                  const char *secret_name,
-	                                  gboolean verify_secret,
-	                                  NMSettingSecretFlags flags,
-	                                  GError **error);
-
-	/* Returns TRUE if the given property contains the same value in both settings */
-	gboolean    (*compare_property)  (NMSetting *setting,
-	                                  NMSetting *other,
-	                                  const GParamSpec *prop_spec,
-	                                  NMSettingCompareFlags flags);
-
-	void        (*clear_secrets_with_flags) (NMSetting *setting,
-	                                         GParamSpec *pspec,
-	                                         NMSettingClearSecretsWithFlagsFn func,
-	                                         gpointer user_data);
-
-	const char *(*get_virtual_iface_name) (NMSetting *setting);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-} NMSettingClass;
-
-

-

+

nm_setting_duplicate ()

+
NMSetting *
+nm_setting_duplicate (NMSetting *setting);
+

Duplicates a NMSetting.

+
+

Parameters

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

setting

the NMSetting to duplicate

 
+
+
+

Returns

+

a new NMSetting containing the same properties and values as the +source NMSetting.

+

[transfer full]

+
+
+
+
+

nm_setting_get_name ()

+
const char *
+nm_setting_get_name (NMSetting *setting);
+

Returns the type name of the NMSetting object

+
+

Parameters

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

setting

the NMSetting

 
+
+
+

Returns

+

a string containing the type name of the NMSetting object, +like 'ppp' or 'wireless' or 'wired'.

+

+
-

NMSettingValueIterFn ()

-
void                (*NMSettingValueIterFn)             (NMSetting *setting,
-                                                         const char *key,
-                                                         const GValue *value,
-                                                         GParamFlags flags,
-                                                         gpointer user_data);
-
+

nm_setting_verify ()

+
gboolean
+nm_setting_verify (NMSetting *setting,
+                   GSList *all_settings,
+                   GError **error);
+

Validates the setting. Each setting's properties have allowed values, and +some are dependent on other values (hence the need for all_settings +). The +returned GError contains information about which property of the setting +failed validation, and in what way that property failed validation.

+
+

Parameters

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

setting :

The setting for which properties are being iterated, given to -nm_setting_enumerate_values() -

setting

the NMSetting to verify

 

key :

The value/property name

all_settings

a GSList of all settings +in the connection from which setting +came.

[element-type NMSetting]

value :

The property's value

flags :

The property's flags, like NM_SETTING_PARAM_SECRET -

user_data :

User data passed to nm_setting_enumerate_values() -

error

location to store error, or NULL

 
+
+

Returns

+

TRUE if the setting is valid, FALSE if it is not

+

+
+
-

enum NMSettingHashFlags

-
typedef enum {
-	NM_SETTING_HASH_FLAG_ALL = 0x00000000,
-	NM_SETTING_HASH_FLAG_NO_SECRETS = 0x00000001,
-	NM_SETTING_HASH_FLAG_ONLY_SECRETS = 0x00000002,
-} NMSettingHashFlags;
-
-

-These flags determine which properties are added to the resulting hash -when calling nm_setting_to_hash(). -

-
+

nm_setting_compare ()

+
gboolean
+nm_setting_compare (NMSetting *a,
+                    NMSetting *b,
+                    NMSettingCompareFlags flags);
+

Compares two NMSetting objects for similarity, with comparison behavior +modified by a set of flags. See the documentation for NMSettingCompareFlags +for a description of each flag's behavior.

+
+

Parameters

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

NM_SETTING_HASH_FLAG_ALL

hash all properties (including secrets) -

a

a NMSetting

 

NM_SETTING_HASH_FLAG_NO_SECRETS

do not include secrets -

b

a second NMSetting to compare with the first

 

NM_SETTING_HASH_FLAG_ONLY_SECRETS

only hash secrets -

flags

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT

 
+
+

Returns

+

TRUE if the comparison succeeds, FALSE if it does not

+

+
+
-

nm_setting_to_hash ()

-
GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
-                                                         NMSettingHashFlags flags);
-

-Converts the NMSetting into a GHashTable mapping each setting property -name to a GValue describing that property, suitable for marshalling over -D-Bus or serializing. The mapping is string to GValue. -

-
+

nm_setting_diff ()

+
gboolean
+nm_setting_diff (NMSetting *a,
+                 NMSetting *b,
+                 NMSettingCompareFlags flags,
+                 gboolean invert_results,
+                 GHashTable **results);
+

Compares two NMSetting objects for similarity, with comparison behavior +modified by a set of flags. See the documentation for NMSettingCompareFlags +for a description of each flag's behavior. If the settings differ, the keys +of each setting that differ from the other are added to results +, mapped to +one or more NMSettingDiffResult values.

+
+

Parameters

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

setting :

the NMSetting -

a

a NMSetting

 

flags :

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL -

b

a second NMSetting to compare with the first

 

Returns :

a new GHashTable -describing the setting's properties. [transfer full][element-type utf8 GObject.Value] -

flags

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT

 

invert_results

this parameter is used internally by libnm-util and should +be set to FALSE. If TRUE inverts the meaning of the NMSettingDiffResult.

 

results

if the +settings differ, on return a hash table mapping the differing keys to one or +more NMSettingDiffResult values OR-ed together. If the settings do not +differ, any hash table passed in is unmodified. If no hash table is passed +in and the settings differ, a new one is created and returned.

[inout][transfer full][element-type utf8 guint32]
+
+

Returns

+

TRUE if the settings contain the same values, FALSE if they do not

+

+
+
-

nm_setting_new_from_hash ()

-
NMSetting *         nm_setting_new_from_hash            (GType setting_type,
-                                                         GHashTable *hash);
-

-Creates a new NMSetting object and populates that object with the properties -contained in the hash table, using each hash key as the property to set, -and each hash value as the value to set that property to. Setting properties -are strongly typed, thus the GValue type of the hash value must be correct. -See the documentation on each NMSetting object subclass for the correct -property names and value types. -

-
+

nm_setting_enumerate_values ()

+
void
+nm_setting_enumerate_values (NMSetting *setting,
+                             NMSettingValueIterFn func,
+                             gpointer user_data);
+

Iterates over each property of the NMSetting object, calling the supplied +user function for each property.

+
+

Parameters

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

setting_type :

the NMSetting type which the hash contains properties for

setting

the NMSetting

 

hash :

the GHashTable containing a -string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value] -

func

user-supplied function called for each property of the setting.

[scope call]

Returns :

a new NMSetting object populated with the properties from the -hash table, or NULL on failure

user_data

user data passed to func +at each invocation

 
+
-

nm_setting_duplicate ()

-
NMSetting *         nm_setting_duplicate                (NMSetting *setting);
-

-Duplicates a NMSetting. -

-
+

nm_setting_to_string ()

+
char *
+nm_setting_to_string (NMSetting *setting);
+

Convert the setting into a string. For debugging purposes ONLY, should NOT +be used for serialization of the setting, or machine-parsed in any way. The +output format is not guaranteed to be stable and may change at any time.

+
+

Parameters

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

setting :

the NMSetting to duplicate

Returns :

a new NMSetting containing the same properties and values as the -source NMSetting. [transfer full] -

setting

the NMSetting

 
+
+

Returns

+

an allocated string containing a textual representation of the +setting's properties and values (including secrets!), which the caller should +free with g_free()

+

+
+
-

nm_setting_get_name ()

-
const char *        nm_setting_get_name                 (NMSetting *setting);
-

-Returns the type name of the NMSetting object -

-
+

nm_setting_clear_secrets ()

+
void
+nm_setting_clear_secrets (NMSetting *setting);
+

Resets and clears any secrets in the setting. Secrets should be added to the +setting only when needed, and cleared immediately after use to prevent +leakage of information.

+
+

Parameters

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

setting :

the NMSetting -

Returns :

a string containing the type name of the NMSetting object, -like 'ppp' or 'wireless' or 'wired'.

setting

the NMSetting

 
+
-

nm_setting_verify ()

-
gboolean            nm_setting_verify                   (NMSetting *setting,
-                                                         GSList *all_settings,
-                                                         GError **error);
-

-Validates the setting. Each setting's properties have allowed values, and -some are dependent on other values (hence the need for all_settings). The -returned GError contains information about which property of the setting -failed validation, and in what way that property failed validation. -

-
+

nm_setting_clear_secrets_with_flags ()

+
void
+nm_setting_clear_secrets_with_flags (NMSetting *setting,
+                                     NMSettingClearSecretsWithFlagsFn func,
+                                     gpointer user_data);
+

Clears and frees secrets determined by func +.

+
+

Parameters

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

setting :

the NMSetting to verify

setting

the NMSetting

 

all_settings :

a GSList of all settings -in the connection from which setting came. [element-type NMSetting] -

error :

location to store error, or NULL -

func

function to be called to determine whether a +specific secret should be cleared or not.

[scope call]

Returns :

 -TRUE if the setting is valid, FALSE if it is not

user_data

caller-supplied data passed to func +

 
+
-

nm_setting_compare ()

-
gboolean            nm_setting_compare                  (NMSetting *a,
-                                                         NMSetting *b,
-                                                         NMSettingCompareFlags flags);
-

-Compares two NMSetting objects for similarity, with comparison behavior -modified by a set of flags. See the documentation for NMSettingCompareFlags -for a description of each flag's behavior. -

-
+

nm_setting_need_secrets ()

+
GPtrArray *
+nm_setting_need_secrets (NMSetting *setting);
+

Returns an array of property names for each secret which may be required +to make a successful connection. The returned hints are only intended as a +guide to what secrets may be required, because in some circumstances, there +is no way to conclusively determine exactly which secrets are needed.

+
+

Parameters

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

a :

a NMSetting -

b :

a second NMSetting to compare with the first

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT -

Returns :

 -TRUE if the comparison succeeds, FALSE if it does not

setting

the NMSetting

 
+
+

Returns

+

a GPtrArray containing +the property names of secrets of the NMSetting which may be required; the +caller owns the array and must free it with g_ptr_array_free(), but must not +free the elements.

+

[transfer container][element-type utf8]

+
+
-

enum NMSettingDiffResult

-
typedef enum {
-	NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000,
-	NM_SETTING_DIFF_RESULT_IN_A =    0x00000001,
-	NM_SETTING_DIFF_RESULT_IN_B =    0x00000002,
-} NMSettingDiffResult;
-
-

-These values indicate the result of a setting difference operation. -

-
+

nm_setting_update_secrets ()

+
gboolean
+nm_setting_update_secrets (NMSetting *setting,
+                           GHashTable *secrets,
+                           GError **error);
+

Update the setting's secrets, given a hash table of secrets intended for that +setting (deserialized from D-Bus for example).

+
+

Parameters

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

NM_SETTING_DIFF_RESULT_UNKNOWN

unknown result -

setting

the NMSetting

 

NM_SETTING_DIFF_RESULT_IN_A

the property is present in setting A -

secrets

a GHashTable mapping +string to GValue of setting property names and secrets.

[element-type utf8 GObject.Value]

NM_SETTING_DIFF_RESULT_IN_B

the property is present in setting B -

error

location to store error, or NULL

 
+
+

Returns

+

TRUE if the secrets were successfully updated, FALSE on failure to +update one or more of the secrets.

+

+
+
-

nm_setting_diff ()

-
gboolean            nm_setting_diff                     (NMSetting *a,
-                                                         NMSetting *b,
-                                                         NMSettingCompareFlags flags,
-                                                         gboolean invert_results,
-                                                         GHashTable **results);
-

-Compares two NMSetting objects for similarity, with comparison behavior -modified by a set of flags. See the documentation for NMSettingCompareFlags -for a description of each flag's behavior. If the settings differ, the keys -of each setting that differ from the other are added to results, mapped to -one or more NMSettingDiffResult values. -

-
+

nm_setting_get_secret_flags ()

+
gboolean
+nm_setting_get_secret_flags (NMSetting *setting,
+                             const char *secret_name,
+                             NMSettingSecretFlags *out_flags,
+                             GError **error);
+

For a given secret, retrieves the NMSettingSecretFlags describing how to +handle that secret.

+
+

Parameters

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

a :

a NMSetting -

setting

the NMSetting

 

b :

a second NMSetting to compare with the first

secret_name

the secret key name to get flags for

 

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT -

out_flags

on success, the NMSettingSecretFlags for the secret

 

invert_results :

this parameter is used internally by libnm-util and should -be set to FALSE. If TRUE inverts the meaning of the NMSettingDiffResult.

results :

if the -settings differ, on return a hash table mapping the differing keys to one or -more NMSettingDiffResult values OR-ed together. If the settings do not -differ, any hash table passed in is unmodified. If no hash table is passed -in and the settings differ, a new one is created and returned. [inout][transfer full][element-type utf8 guint32] -

Returns :

 -TRUE if the settings contain the same values, FALSE if they do not

error

location to store error, or NULL

 
+
+

Returns

+

TRUE on success (if the given secret name was a valid property of +this setting, and if that property is secret), FALSE if not

+

+
+
-

nm_setting_enumerate_values ()

-
void                nm_setting_enumerate_values         (NMSetting *setting,
-                                                         NMSettingValueIterFn func,
-                                                         gpointer user_data);
-

-Iterates over each property of the NMSetting object, calling the supplied -user function for each property. -

-
+

nm_setting_set_secret_flags ()

+
gboolean
+nm_setting_set_secret_flags (NMSetting *setting,
+                             const char *secret_name,
+                             NMSettingSecretFlags flags,
+                             GError **error);
+

For a given secret, retrieves the NMSettingSecretFlags describing how to +handle that secret.

+
+

Parameters

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

setting :

the NMSetting -

func :

user-supplied function called for each property of the setting. [scope call] -

setting

the NMSetting

 

user_data :

user data passed to func at each invocation

secret_name

the secret key name to set flags for

 
-
-
-
-

nm_setting_to_string ()

-
char *              nm_setting_to_string                (NMSetting *setting);
-

-Convert the setting into a string. For debugging purposes ONLY, should NOT -be used for serialization of the setting, or machine-parsed in any way. The -output format is not guaranteed to be stable and may change at any time. -

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

setting :

the NMSetting -

flags

the NMSettingSecretFlags for the secret

 

Returns :

an allocated string containing a textual representation of the -setting's properties and values (including secrets!), which the caller should -free with g_free() -

error

location to store error, or NULL

 
+
+

Returns

+

TRUE on success (if the given secret name was a valid property of +this setting, and if that property is secret), FALSE if not

+

+
+
-

nm_setting_clear_secrets ()

-
void                nm_setting_clear_secrets            (NMSetting *setting);
-

-Resets and clears any secrets in the setting. Secrets should be added to the -setting only when needed, and cleared immediately after use to prevent -leakage of information. -

-
+

nm_setting_get_virtual_iface_name ()

+
const char *
+nm_setting_get_virtual_iface_name (NMSetting *setting);
+

Returns the name of the virtual kernel interface which the connection +needs to use if specified in the settings.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSetting -

setting

the NMSetting

 
-
+
+

Returns

+

Name of the virtual interface or NULL if the setting does not +support this feature

+

+
+ + +
+

Types and Values

-

nm_setting_clear_secrets_with_flags ()

-
void                nm_setting_clear_secrets_with_flags (NMSetting *setting,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
-

-Clears and frees secrets determined by func. -

-
+

enum NMSettingError

+

Describes errors that may result from operations involving a NMSetting.

+
+

Members

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

setting :

the NMSetting +

NM_SETTING_ERROR_UNKNOWN

 +

unknown or unclassified error

 

func :

function to be called to determine whether a -specific secret should be cleared or not. [scope call] +

NM_SETTING_ERROR_PROPERTY_NOT_FOUND

 +

a property required by the operation + was not found; for example, an attempt to update an invalid secret

 

user_data :

caller-supplied data passed to func +

NM_SETTING_ERROR_PROPERTY_NOT_SECRET

 +

an operation which requires a secret + was attempted on a non-secret property

 

NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH

 +

the operation requires a property + of a specific type, or the value couldn't be transformed to the same type + as the property being acted upon

+		 
+
-

nm_setting_need_secrets ()

-
GPtrArray *         nm_setting_need_secrets             (NMSetting *setting);
+

NM_SETTING_ERROR

+
#define NM_SETTING_ERROR nm_setting_error_quark ()
+

-Returns an array of property names for each secret which may be required -to make a successful connection. The returned hints are only intended as a -guide to what secrets may be required, because in some circumstances, there -is no way to conclusively determine exactly which secrets are needed.

-
---- - - - - - - - - - - -

setting :

the NMSetting -

Returns :

a GPtrArray containing -the property names of secrets of the NMSetting which may be required; the -caller owns the array and must free it with g_ptr_array_free(), but must not -free the elements. [transfer container][element-type utf8] -
-

nm_setting_update_secrets ()

-
gboolean            nm_setting_update_secrets           (NMSetting *setting,
-                                                         GHashTable *secrets,
-                                                         GError **error);
+

NM_SETTING_NAME

+
#define NM_SETTING_NAME "name"
+

-Update the setting's secrets, given a hash table of secrets intended for that -setting (deserialized from D-Bus for example).

-
+ +
+
+

enum NMSettingSecretFlags

+

These flags indicate specific behavior related to handling of a secret. Each +secret has a corresponding set of these flags which indicate how the secret +is to be stored and/or requested when it is needed.

+
+

Members

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

setting :

the NMSetting +

NM_SETTING_SECRET_FLAG_NONE

 +

the system is responsible for providing and +storing this secret (default)

 

secrets :

a GHashTable mapping -string to GValue of setting property names and secrets. [element-type utf8 GObject.Value] +

NM_SETTING_SECRET_FLAG_AGENT_OWNED

 +

a user secret agent is responsible +for providing and storing this secret; when it is required agents will be +asked to retrieve it

 

error :

location to store error, or NULL +

NM_SETTING_SECRET_FLAG_NOT_SAVED

 +

this secret should not be saved, but +should be requested from the user each time it is needed

 

Returns :

 -TRUE if the secrets were successfully updated, FALSE on failure to -update one or more of the secrets.

NM_SETTING_SECRET_FLAG_NOT_REQUIRED

 +

in situations where it cannot be +automatically determined that the secret is required (some VPNs and PPP +providers dont require all secrets) this flag indicates that the specific +secret is not required

+		 
+
-

nm_setting_get_secret_flags ()

-
gboolean            nm_setting_get_secret_flags         (NMSetting *setting,
-                                                         const char *secret_name,
-                                                         NMSettingSecretFlags *out_flags,
-                                                         GError **error);
-

-For a given secret, retrieves the NMSettingSecretFlags describing how to -handle that secret. -

-
+

enum NMSettingCompareFlags

+

These flags modify the comparison behavior when comparing two settings or +two connections.

+
+

Members

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

setting :

the NMSetting +

NM_SETTING_COMPARE_FLAG_EXACT

 +

match all properties exactly

 

secret_name :

the secret key name to get flags for

NM_SETTING_COMPARE_FLAG_FUZZY

 +

match only important attributes, like SSID, + type, security settings, etc. Does not match, for example, connection ID + or UUID.

+		 

out_flags :

on success, the NMSettingSecretFlags for the secret

NM_SETTING_COMPARE_FLAG_IGNORE_ID

 +

ignore the connection's ID

+		 

error :

location to store error, or NULL +

NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS

 +

ignore all secrets

 

Returns :

TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not

NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS

 +

ignore secrets for which +the secret's flags indicate the secret is owned by a user secret agent +(ie, the secret's flag includes NM_SETTING_SECRET_FLAG_AGENT_OWNED +)

+		 

NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS

 +

ignore secrets for which +the secret's flags indicate the secret should not be saved to persistent +storage (ie, the secret's flag includes NM_SETTING_SECRET_FLAG_NOT_SAVED +)

+		 
+
-

nm_setting_set_secret_flags ()

-
gboolean            nm_setting_set_secret_flags         (NMSetting *setting,
-                                                         const char *secret_name,
-                                                         NMSettingSecretFlags flags,
-                                                         GError **error);
-

-For a given secret, retrieves the NMSettingSecretFlags describing how to -handle that secret. -

-
+

NMSetting

+
typedef struct _NMSetting NMSetting;
+

The NMSetting struct contains only private data. +It should only be accessed through the functions described below.

+ +
+
+

enum NMSettingHashFlags

+

These flags determine which properties are added to the resulting hash +when calling nm_setting_to_hash().

+
+

Members

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

setting :

the NMSetting +

NM_SETTING_HASH_FLAG_ALL

 +

hash all properties (including secrets)

 

secret_name :

the secret key name to set flags for

flags :

the NMSettingSecretFlags for the secret

error :

location to store error, or NULL +

NM_SETTING_HASH_FLAG_NO_SECRETS

 +

do not include secrets

 

Returns :

TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not

NM_SETTING_HASH_FLAG_ONLY_SECRETS

 +

only hash secrets

+		 
+
-

nm_setting_get_virtual_iface_name ()

-
const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);
-

-Returns the name of the virtual kernel interface which the connection -needs to use if specified in the settings. -

-
+

enum NMSettingDiffResult

+

These values indicate the result of a setting difference operation.

+
+

Members

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

setting :

the NMSetting +

NM_SETTING_DIFF_RESULT_UNKNOWN

 +

unknown result

 

Returns :

Name of the virtual interface or NULL if the setting does not -support this feature

NM_SETTING_DIFF_RESULT_IN_A

 +

the property is present in setting A

+		 

NM_SETTING_DIFF_RESULT_IN_B

 +

the property is present in setting B

+		 
+

Property Details

-

The "name" property

-
  "name"                     gchar*                : Read / Write
-

-The setting's name, which uniquely identifies the setting within the +

The “name” property

+
  “name”                     gchar *
+

The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for -example 'ppp' or 'wireless' or 'wired'. -

+example 'ppp' or 'wireless' or 'wired'.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSetting8021x.html b/docs/libnm-util/html/NMSetting8021x.html index 0078c61b..67162ead 100644 --- a/docs/libnm-util/html/NMSetting8021x.html +++ b/docs/libnm-util/html/NMSetting8021x.html @@ -2,34 +2,28 @@ -NMSetting8021x +libnm-util Reference Manual: NMSetting8021x - + - - - - - - - - - - + + + + + + +
@@ -37,3091 +31,3780 @@

NMSetting8021x

NMSetting8021x — Describes 802.1x-authenticated connection properties

- +
-
-

Synopsis

-
-#include <nm-setting-8021x.h>
-
-enum                NMSetting8021xCKFormat;
-enum                NMSetting8021xCKScheme;
-#define             NM_SETTING_802_1X_SETTING_NAME
-enum                NMSetting8021xError;
-#define             NM_SETTING_802_1X_ERROR
-GQuark              nm_setting_802_1x_error_quark       (void);
-#define             NM_SETTING_802_1X_EAP
-#define             NM_SETTING_802_1X_IDENTITY
-#define             NM_SETTING_802_1X_ANONYMOUS_IDENTITY
-#define             NM_SETTING_802_1X_PAC_FILE
-#define             NM_SETTING_802_1X_CA_CERT
-#define             NM_SETTING_802_1X_CA_PATH
-#define             NM_SETTING_802_1X_SUBJECT_MATCH
-#define             NM_SETTING_802_1X_ALTSUBJECT_MATCHES
-#define             NM_SETTING_802_1X_CLIENT_CERT
-#define             NM_SETTING_802_1X_PHASE1_PEAPVER
-#define             NM_SETTING_802_1X_PHASE1_PEAPLABEL
-#define             NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
-#define             NM_SETTING_802_1X_PHASE2_AUTH
-#define             NM_SETTING_802_1X_PHASE2_AUTHEAP
-#define             NM_SETTING_802_1X_PHASE2_CA_CERT
-#define             NM_SETTING_802_1X_PHASE2_CA_PATH
-#define             NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
-#define             NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES
-#define             NM_SETTING_802_1X_PHASE2_CLIENT_CERT
-#define             NM_SETTING_802_1X_PASSWORD
-#define             NM_SETTING_802_1X_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PASSWORD_RAW
-#define             NM_SETTING_802_1X_PASSWORD_RAW_FLAGS
-#define             NM_SETTING_802_1X_PRIVATE_KEY
-#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
-#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY
-#define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD
-#define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PIN
-#define             NM_SETTING_802_1X_PIN_FLAGS
-#define             NM_SETTING_802_1X_SYSTEM_CA_CERTS
-                    NMSetting8021x;
-                    NMSetting8021xClass;
-NMSetting *         nm_setting_802_1x_new               (void);
-guint32             nm_setting_802_1x_get_num_eap_methods
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_add_eap_method    (NMSetting8021x *setting,
-                                                         const char *eap);
-void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
-                                                         guint32 i);
-void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_anonymous_identity
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_get_system_ca_certs
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_ca_path       (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_ca_path
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
-guint32             nm_setting_802_1x_get_num_altsubject_matches
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_add_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *altsubject_match);
-void                nm_setting_802_1x_remove_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-void                nm_setting_802_1x_clear_altsubject_matches
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
-                                                        (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_client_cert_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_client_cert_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_phase1_peapver
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase1_peaplabel
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase1_fast_provisioning
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_auth   (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_autheap
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_phase2_ca_cert_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_ca_cert_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_phase2_ca_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_phase2_subject_match
-                                                        (NMSetting8021x *setting);
-guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_add_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *phase2_altsubject_match);
-void                nm_setting_802_1x_remove_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-void                nm_setting_802_1x_clear_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
-                                                        (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_phase2_client_cert_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_client_cert_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_phase2_client_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_password_flags
-                                                        (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_pin           (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_pin_flags    (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_private_key_scheme
-                                                        (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_private_key_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_private_key_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_private_key   (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_private_key_password
-                                                        (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_private_key_password_flags
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
-                                                        (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_phase2_private_key_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_private_key_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_phase2_private_key
-                                                        (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_phase2_private_key_password
-                                                        (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
-                                                        (NMSetting8021x *setting);
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSetting8021xCKFormat
-
-
-  GEnum
-   +----NMSetting8021xCKScheme
-
-
-  GEnum
-   +----NMSetting8021xError
-
-
-  GObject
-   +----NMSetting
-         +----NMSetting8021x
-
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_802_1x_error_quark () +
+NMSetting * + +nm_setting_802_1x_new () +
+guint32 + +nm_setting_802_1x_get_num_eap_methods () +
const char * + +nm_setting_802_1x_get_eap_method () +
+gboolean + +nm_setting_802_1x_add_eap_method () +
+void + +nm_setting_802_1x_remove_eap_method () +
+void + +nm_setting_802_1x_clear_eap_methods () +
const char * + +nm_setting_802_1x_get_identity () +
const char * + +nm_setting_802_1x_get_anonymous_identity () +
const char * + +nm_setting_802_1x_get_pac_file () +
+gboolean + +nm_setting_802_1x_get_system_ca_certs () +
const char * + +nm_setting_802_1x_get_ca_path () +
const char * + +nm_setting_802_1x_get_phase2_ca_path () +
+NMSetting8021xCKScheme + +nm_setting_802_1x_get_ca_cert_scheme () +
const GByteArray * + +nm_setting_802_1x_get_ca_cert_blob () +
const char * + +nm_setting_802_1x_get_ca_cert_path () +
+gboolean + +nm_setting_802_1x_set_ca_cert () +
const char * + +nm_setting_802_1x_get_subject_match () +
+guint32 + +nm_setting_802_1x_get_num_altsubject_matches () +
const char * + +nm_setting_802_1x_get_altsubject_match () +
+gboolean + +nm_setting_802_1x_add_altsubject_match () +
+void + +nm_setting_802_1x_remove_altsubject_match () +
+void + +nm_setting_802_1x_clear_altsubject_matches () +
+NMSetting8021xCKScheme + +nm_setting_802_1x_get_client_cert_scheme () +
const GByteArray * + +nm_setting_802_1x_get_client_cert_blob () +
const char * + +nm_setting_802_1x_get_client_cert_path () +
+gboolean + +nm_setting_802_1x_set_client_cert () +
const char * + +nm_setting_802_1x_get_phase1_peapver () +
const char * + +nm_setting_802_1x_get_phase1_peaplabel () +
const char * + +nm_setting_802_1x_get_phase1_fast_provisioning () +
const char * + +nm_setting_802_1x_get_phase2_auth () +
const char * + +nm_setting_802_1x_get_phase2_autheap () +
+NMSetting8021xCKScheme + +nm_setting_802_1x_get_phase2_ca_cert_scheme () +
const GByteArray * + +nm_setting_802_1x_get_phase2_ca_cert_blob () +
const char * + +nm_setting_802_1x_get_phase2_ca_cert_path () +
+gboolean + +nm_setting_802_1x_set_phase2_ca_cert () +
const char * + +nm_setting_802_1x_get_phase2_subject_match () +
+guint32 + +nm_setting_802_1x_get_num_phase2_altsubject_matches () +
const char * + +nm_setting_802_1x_get_phase2_altsubject_match () +
+gboolean + +nm_setting_802_1x_add_phase2_altsubject_match () +
+void + +nm_setting_802_1x_remove_phase2_altsubject_match () +
+void + +nm_setting_802_1x_clear_phase2_altsubject_matches () +
+NMSetting8021xCKScheme + +nm_setting_802_1x_get_phase2_client_cert_scheme () +
const GByteArray * + +nm_setting_802_1x_get_phase2_client_cert_blob () +
const char * + +nm_setting_802_1x_get_phase2_client_cert_path () +
+gboolean + +nm_setting_802_1x_set_phase2_client_cert () +
const char * + +nm_setting_802_1x_get_password () +
+NMSettingSecretFlags + +nm_setting_802_1x_get_password_flags () +
const GByteArray * + +nm_setting_802_1x_get_password_raw () +
+NMSettingSecretFlags + +nm_setting_802_1x_get_password_raw_flags () +
const char * + +nm_setting_802_1x_get_pin () +
+NMSettingSecretFlags + +nm_setting_802_1x_get_pin_flags () +
+NMSetting8021xCKScheme + +nm_setting_802_1x_get_private_key_scheme () +
const GByteArray * + +nm_setting_802_1x_get_private_key_blob () +
const char * + +nm_setting_802_1x_get_private_key_path () +
+gboolean + +nm_setting_802_1x_set_private_key () +
const char * + +nm_setting_802_1x_get_private_key_password () +
+NMSettingSecretFlags + +nm_setting_802_1x_get_private_key_password_flags () +
+NMSetting8021xCKFormat + +nm_setting_802_1x_get_private_key_format () +
+NMSetting8021xCKScheme + +nm_setting_802_1x_get_phase2_private_key_scheme () +
const GByteArray * + +nm_setting_802_1x_get_phase2_private_key_blob () +
const char * + +nm_setting_802_1x_get_phase2_private_key_path () +
+gboolean + +nm_setting_802_1x_set_phase2_private_key () +
const char * + +nm_setting_802_1x_get_phase2_private_key_password () +
+NMSettingSecretFlags + +nm_setting_802_1x_get_phase2_private_key_password_flags () +
+NMSetting8021xCKFormat + +nm_setting_802_1x_get_phase2_private_key_format () +

Properties

-
-  "altsubject-matches"       GSList_gchararray_*   : Read / Write
-  "anonymous-identity"       gchar*                : Read / Write
-  "ca-cert"                  GArray_guchar_*       : Read / Write
-  "ca-path"                  gchar*                : Read / Write
-  "client-cert"              GArray_guchar_*       : Read / Write
-  "eap"                      GSList_gchararray_*   : Read / Write
-  "identity"                 gchar*                : Read / Write
-  "pac-file"                 gchar*                : Read / Write
-  "password"                 gchar*                : Read / Write
-  "password-flags"           guint                 : Read / Write
-  "password-raw"             GArray_guchar_*       : Read / Write
-  "password-raw-flags"       guint                 : Read / Write
-  "phase1-fast-provisioning" gchar*                : Read / Write
-  "phase1-peaplabel"         gchar*                : Read / Write
-  "phase1-peapver"           gchar*                : Read / Write
-  "phase2-altsubject-matches" GSList_gchararray_*   : Read / Write
-  "phase2-auth"              gchar*                : Read / Write
-  "phase2-autheap"           gchar*                : Read / Write
-  "phase2-ca-cert"           GArray_guchar_*       : Read / Write
-  "phase2-ca-path"           gchar*                : Read / Write
-  "phase2-client-cert"       GArray_guchar_*       : Read / Write
-  "phase2-private-key"       GArray_guchar_*       : Read / Write
-  "phase2-private-key-password" gchar*                : Read / Write
-  "phase2-private-key-password-flags" guint                 : Read / Write
-  "phase2-subject-match"     gchar*                : Read / Write
-  "pin"                      gchar*                : Read / Write
-  "pin-flags"                guint                 : Read / Write
-  "private-key"              GArray_guchar_*       : Read / Write
-  "private-key-password"     gchar*                : Read / Write
-  "private-key-password-flags" guint                 : Read / Write
-  "subject-match"            gchar*                : Read / Write
-  "system-ca-certs"          gboolean              : Read / Write / Construct
-
-
-
-

Description

-

-The NMSetting8021x object is a NMSetting subclass that describes -properties necessary for connection to 802.1x-authenticated networks, such as -WPA and WPA2 Enterprise WiFi networks and wired 802.1x networks. 802.1x -connections typically use certificates and/or EAP authentication methods to -securely verify, identify, and authenticate the client to the network itself, -instead of simply relying on a widely shared static key. -

-

-It's a good idea to read up on wpa_supplicant configuration before using this -setting extensively, since most of the options here correspond closely with -the relevant wpa_supplicant configuration options. -

-

-Furthermore, to get a good idea of 802.1x, EAP, TLS, TTLS, etc and their -applications to WiFi and wired networks, you'll want to get copies of the -following books. -

-

- 802.11 Wireless Networks: The Definitive Guide, Second Edition - Author: Matthew Gast - ISBN: 978-0596100520 -

-

- Cisco Wireless LAN Security - Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky - ISBN: 978-1587051548 -

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GSList_gchararray_ *altsubject-matchesRead / Write
+gchar *anonymous-identityRead / Write
+GArray_guchar_ *ca-certRead / Write
+gchar *ca-pathRead / Write
+GArray_guchar_ *client-certRead / Write
+GSList_gchararray_ *eapRead / Write
+gchar *identityRead / Write
+gchar *pac-fileRead / Write
+gchar *passwordRead / Write
guintpassword-flagsRead / Write
+GArray_guchar_ *password-rawRead / Write
guintpassword-raw-flagsRead / Write
+gchar *phase1-fast-provisioningRead / Write
+gchar *phase1-peaplabelRead / Write
+gchar *phase1-peapverRead / Write
+GSList_gchararray_ *phase2-altsubject-matchesRead / Write
+gchar *phase2-authRead / Write
+gchar *phase2-autheapRead / Write
+GArray_guchar_ *phase2-ca-certRead / Write
+gchar *phase2-ca-pathRead / Write
+GArray_guchar_ *phase2-client-certRead / Write
+GArray_guchar_ *phase2-private-keyRead / Write
+gchar *phase2-private-key-passwordRead / Write
guintphase2-private-key-password-flagsRead / Write
+gchar *phase2-subject-matchRead / Write
+gchar *pinRead / Write
guintpin-flagsRead / Write
+GArray_guchar_ *private-keyRead / Write
+gchar *private-key-passwordRead / Write
guintprivate-key-password-flagsRead / Write
+gchar *subject-matchRead / Write
gbooleansystem-ca-certsRead / Write / Construct
-

Details

-
-

enum NMSetting8021xCKFormat

-
typedef enum {
- /*< underscore_name=nm_setting_802_1x_ck_format >*/
-	NM_SETTING_802_1X_CK_FORMAT_UNKNOWN = 0,
-	NM_SETTING_802_1X_CK_FORMAT_X509,
-	NM_SETTING_802_1X_CK_FORMAT_RAW_KEY,
-	NM_SETTING_802_1X_CK_FORMAT_PKCS12
-} NMSetting8021xCKFormat;
-
-

-NMSetting8021xCKFormat values indicate the general type of a certificate -or private key -

-
+

Types and Values

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

NM_SETTING_802_1X_CK_FORMAT_UNKNOWN

unknown file format -enumNMSetting8021xCKFormat
enumNMSetting8021xCKScheme
#defineNM_SETTING_802_1X_SETTING_NAME
enumNMSetting8021xError
#defineNM_SETTING_802_1X_ERROR
#defineNM_SETTING_802_1X_EAP
#defineNM_SETTING_802_1X_IDENTITY
#defineNM_SETTING_802_1X_ANONYMOUS_IDENTITY
#defineNM_SETTING_802_1X_PAC_FILE
#defineNM_SETTING_802_1X_CA_CERT
#defineNM_SETTING_802_1X_CA_PATH
#defineNM_SETTING_802_1X_SUBJECT_MATCH
#defineNM_SETTING_802_1X_ALTSUBJECT_MATCHES
#defineNM_SETTING_802_1X_CLIENT_CERT
#defineNM_SETTING_802_1X_PHASE1_PEAPVER
#defineNM_SETTING_802_1X_PHASE1_PEAPLABEL
#defineNM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
#defineNM_SETTING_802_1X_PHASE2_AUTH
#defineNM_SETTING_802_1X_PHASE2_AUTHEAP

NM_SETTING_802_1X_CK_FORMAT_X509

file contains an X.509 format certificate -#defineNM_SETTING_802_1X_PHASE2_CA_CERT

NM_SETTING_802_1X_CK_FORMAT_RAW_KEY

file contains an old-style OpenSSL PEM -or DER private key -#defineNM_SETTING_802_1X_PHASE2_CA_PATH

NM_SETTING_802_1X_CK_FORMAT_PKCS12

file contains a PKCS12 certificate -and private key -#defineNM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
-
-
-
-

enum NMSetting8021xCKScheme

-
typedef enum {
- /*< underscore_name=nm_setting_802_1x_ck_scheme >*/
-	NM_SETTING_802_1X_CK_SCHEME_UNKNOWN = 0,
-	NM_SETTING_802_1X_CK_SCHEME_BLOB,
-	NM_SETTING_802_1X_CK_SCHEME_PATH
-} NMSetting8021xCKScheme;
-
-

-NMSetting8021xCKScheme values indicate how a certificate or private key is -stored in the setting properties, either as a blob of the item's data, or as -a path to a certificate or private key file on the filesystem -

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

NM_SETTING_802_1X_CK_SCHEME_UNKNOWN

unknown certificate or private key -scheme -#defineNM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

NM_SETTING_802_1X_CK_SCHEME_BLOB

certificate or key is stored as the raw -item data -#defineNM_SETTING_802_1X_PHASE2_CLIENT_CERT

NM_SETTING_802_1X_CK_SCHEME_PATH

certificate or key is stored as a path -to a file containing the certificate or key data -#defineNM_SETTING_802_1X_PASSWORD
-
-
-
-

NM_SETTING_802_1X_SETTING_NAME

-
#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
-
-

-

-
-
-
-

enum NMSetting8021xError

-
typedef enum {
- /*< underscore_name=nm_setting_802_1x_error >*/
-	NM_SETTING_802_1X_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_802_1X_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_802_1X_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
-} NMSetting8021xError;
-
-
---- - - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_SETTING_802_1X_ERROR_UNKNOWN

unknown or unclassified error -#defineNM_SETTING_802_1X_PASSWORD_FLAGS

NM_SETTING_802_1X_ERROR_INVALID_PROPERTY

the property was invalid -#defineNM_SETTING_802_1X_PASSWORD_RAW

NM_SETTING_802_1X_ERROR_MISSING_PROPERTY

the property was missing and is -required -#defineNM_SETTING_802_1X_PASSWORD_RAW_FLAGS
#defineNM_SETTING_802_1X_PRIVATE_KEY
#defineNM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
#defineNM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
#defineNM_SETTING_802_1X_PHASE2_PRIVATE_KEY
#defineNM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD
#defineNM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS
#defineNM_SETTING_802_1X_PIN
#defineNM_SETTING_802_1X_PIN_FLAGS
#defineNM_SETTING_802_1X_SYSTEM_CA_CERTS
-
-
-

NM_SETTING_802_1X_ERROR

-
#define NM_SETTING_802_1X_ERROR nm_setting_802_1x_error_quark ()
-
-

-

-
-
-
-

nm_setting_802_1x_error_quark ()

-
GQuark              nm_setting_802_1x_error_quark       (void);
-

-Registers an error quark for NMSetting8021x if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSetting8021x errors.
-
-
-
-

NM_SETTING_802_1X_EAP

-
#define NM_SETTING_802_1X_EAP "eap"
-
-

-

-
-
-
-

NM_SETTING_802_1X_IDENTITY

-
#define NM_SETTING_802_1X_IDENTITY "identity"
-
-

-

-
-
-
-

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

-
#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
-
-

-

-
-
-
-

NM_SETTING_802_1X_PAC_FILE

-
#define NM_SETTING_802_1X_PAC_FILE "pac-file"
-
-

-

-
-
-
-

NM_SETTING_802_1X_CA_CERT

-
#define NM_SETTING_802_1X_CA_CERT "ca-cert"
-
-

-

-
-
-
-

NM_SETTING_802_1X_CA_PATH

-
#define NM_SETTING_802_1X_CA_PATH "ca-path"
-
-

-

-
-
-
-

NM_SETTING_802_1X_SUBJECT_MATCH

-
#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match"
-
-

-

-
-
-
-

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

-
#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
-
-

-

-
-
-
-

NM_SETTING_802_1X_CLIENT_CERT

-
#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
-
-

-

-
-
-
-

NM_SETTING_802_1X_PHASE1_PEAPVER

-
#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver"
-
-

-

-
-
-
-

NM_SETTING_802_1X_PHASE1_PEAPLABEL

-
#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
-
-

-

-
-
-
-

NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING

-
#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning"
+

+
Object Hierarchy

+
    GEnum
+    ├── NMSetting8021xCKFormat
+    ├── NMSetting8021xCKScheme
+    ╰── NMSetting8021xError
+    GObject
+    ╰── NMSetting
+        ╰── NMSetting8021x
 

-

-

 

-

-

-
NM_SETTING_802_1X_PHASE2_AUTH

-
#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth"
+

+
Includes

+
#include <nm-setting-8021x.h>
 

-

-

 

-

-

-
NM_SETTING_802_1X_PHASE2_AUTHEAP

-
#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap"
-

-

-

+

+
Description

+
The NMSetting8021x object is a NMSetting subclass that describes
+properties necessary for connection to 802.1x-authenticated networks, such as
+WPA and WPA2 Enterprise WiFi networks and wired 802.1x networks.  802.1x
+connections typically use certificates and/or EAP authentication methods to
+securely verify, identify, and authenticate the client to the network itself,
+instead of simply relying on a widely shared static key.

+
It's a good idea to read up on wpa_supplicant configuration before using this
+setting extensively, since most of the options here correspond closely with
+the relevant wpa_supplicant configuration options.

+
Furthermore, to get a good idea of 802.1x, EAP, TLS, TTLS, etc and their
+applications to WiFi and wired networks, you'll want to get copies of the
+following books.

+
 802.11 Wireless Networks: The Definitive Guide, Second Edition
+      Author: Matthew Gast
+      ISBN: 978-0596100520

+
 Cisco Wireless LAN Security
+      Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky
+      ISBN: 978-1587051548

 

-

+

+
Functions

 

-
NM_SETTING_802_1X_PHASE2_CA_CERT

-
#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert"
-

-

-

+
nm_setting_802_1x_error_quark ()

+
GQuark
+nm_setting_802_1x_error_quark (void);

+
Registers an error quark for NMSetting8021x if necessary.

+

+
Returns

+
 the error quark used for NMSetting8021x errors.

+

 

-

-

-
NM_SETTING_802_1X_PHASE2_CA_PATH

-
#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path"
-

-

-

 

 

 

-
NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

-
#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
-

-

-

+
nm_setting_802_1x_new ()

+
NMSetting *
+nm_setting_802_1x_new (void);

+
Creates a new NMSetting8021x object with default values.

+

+
Returns

+
 the new empty NMSetting8021x object

+

 

-

-

-
NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

-
#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
-

-

-

 

 

 

-
NM_SETTING_802_1X_PHASE2_CLIENT_CERT

-
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
-

-

-

+
nm_setting_802_1x_get_num_eap_methods ()

+
guint32
+nm_setting_802_1x_get_num_eap_methods (NMSetting8021x *setting);

+
Returns the number of eap methods allowed for use when connecting to the
+network.  Generally only one EAP method is used.  Use the functions
+nm_setting_802_1x_get_eap_method(), nm_setting_802_1x_add_eap_method(),
+and nm_setting_802_1x_remove_eap_method() for adding, removing, and retrieving
+allowed EAP methods.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

 

-

-

-
NM_SETTING_802_1X_PASSWORD

-
#define NM_SETTING_802_1X_PASSWORD "password"
-

-

-

+

+
Returns

+
 the number of allowed EAP methods

+

 

-

-

-
NM_SETTING_802_1X_PASSWORD_FLAGS

-
#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags"
-

-

-

 

 

 

-
NM_SETTING_802_1X_PASSWORD_RAW

-
#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw"
-

-

-

+
nm_setting_802_1x_get_eap_method ()

+
const char *
+nm_setting_802_1x_get_eap_method (NMSetting8021x *setting,
+                                  guint32 i);

+
Returns the name of the allowed EAP method at index i
+.

+

+
Parameters

+

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





setting
the NMSetting8021x
 
i
the index of the EAP method name to return
 

 

-

-

-
NM_SETTING_802_1X_PASSWORD_RAW_FLAGS

-
#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
-

-

+

+
Returns

+
 the name of the allowed EAP method at index i
 

+

+

 

 

 

-
NM_SETTING_802_1X_PRIVATE_KEY

-
#define NM_SETTING_802_1X_PRIVATE_KEY "private-key"
-

-

-

+
nm_setting_802_1x_add_eap_method ()

+
gboolean
+nm_setting_802_1x_add_eap_method (NMSetting8021x *setting,
+                                  const char *eap);

+
Adds an allowed EAP method.  The setting is not valid until at least one
+EAP method has been added.  See “eap” property for a list of
+allowed EAP methods.

+

+
Parameters

+

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





setting
the NMSetting8021x
 
eap
the name of the EAP method to allow for this connection
 

+

+

+
Returns

+
 TRUE if the EAP method was successfully added, FALSE if it was
+not a valid method or if it was already allowed.

+

+

 

 

 

-
NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

-
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
-

-

-

+
nm_setting_802_1x_remove_eap_method ()

+
void
+nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
+                                     guint32 i);

+
Removes the allowed EAP method at the specified index.

+

+
Parameters

+

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





setting
the NMSetting8021x
 
i
the index of the EAP method to remove
 

+

 

 

 

-
NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

-
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
-

-

-

+
nm_setting_802_1x_clear_eap_methods ()

+
void
+nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);

+
Clears all allowed EAP methods.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

 

 

 

-
NM_SETTING_802_1X_PHASE2_PRIVATE_KEY

-
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
-

-

-

+
nm_setting_802_1x_get_identity ()

+
const char *
+nm_setting_802_1x_get_identity (NMSetting8021x *setting);

+
Returns the identifier used by some EAP methods (like TLS) to
+authenticate the user.  Often this is a username or login name.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the user identifier

+

+

 

 

 

-
NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD

-
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
-

-

-

+
nm_setting_802_1x_get_anonymous_identity ()

+
const char *
+nm_setting_802_1x_get_anonymous_identity
+                               (NMSetting8021x *setting);

+
Returns the anonymous identifier used by some EAP methods (like TTLS) to
+authenticate the user in the outer unencrypted "phase 1" authentication.  The
+inner "phase 2" authentication will use the “identity” in
+a secure form, if applicable for that EAP method.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the anonymous identifier

+

+

 

 

 

-
NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

-
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"
-

-

-

+
nm_setting_802_1x_get_pac_file ()

+
const char *
+nm_setting_802_1x_get_pac_file (NMSetting8021x *setting);

+
Returns the file containing PAC credentials used by EAP-FAST method.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the PAC file

+

+

 

 

 

-
NM_SETTING_802_1X_PIN

-
#define NM_SETTING_802_1X_PIN "pin"
-

-

-

+
nm_setting_802_1x_get_system_ca_certs ()

+
gboolean
+nm_setting_802_1x_get_system_ca_certs (NMSetting8021x *setting);

+
Sets the “system-ca-certs” property. The
+“ca-path” and “phase2-ca-path”
+properties are ignored if the “system-ca-certs” property is
+TRUE, in which case a system-wide CA certificate directory specified at
+compile time (using the --system-ca-path configure option) is used in place
+of these properties.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 TRUE if a system CA certificate path should be used, FALSE if not

+

+

 

 

 

-
NM_SETTING_802_1X_PIN_FLAGS

-
#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
-

-

-

+
nm_setting_802_1x_get_ca_path ()

+
const char *
+nm_setting_802_1x_get_ca_path (NMSetting8021x *setting);

+
Returns the path of the CA certificate directory if previously set.  Systems
+will often have a directory that contains multiple individual CA certificates
+which the supplicant can then add to the verification chain.  This may be
+used in addition to the “ca-cert” property to add more CA
+certificates for verifying the network to client.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the CA certificate directory path

+

+

 

 

 

-
NM_SETTING_802_1X_SYSTEM_CA_CERTS

-
#define NM_SETTING_802_1X_SYSTEM_CA_CERTS "system-ca-certs"
-

-

-

+
nm_setting_802_1x_get_phase2_ca_path ()

+
const char *
+nm_setting_802_1x_get_phase2_ca_path (NMSetting8021x *setting);

+
Returns the path of the "phase 2" CA certificate directory if previously set.
+Systems will often have a directory that contains multiple individual CA
+certificates which the supplicant can then add to the verification chain.
+This may be used in addition to the “phase2-ca-cert” property
+to add more CA certificates for verifying the network to client.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the "phase 2" CA certificate directory path

+

+

 

 

 

-
NMSetting8021x

-
typedef struct _NMSetting8021x NMSetting8021x;

-

-

+
nm_setting_802_1x_get_ca_cert_scheme ()

+
NMSetting8021xCKScheme
+nm_setting_802_1x_get_ca_cert_scheme (NMSetting8021x *setting);

+
Returns the scheme used to store the CA certificate.  If the returned scheme
+is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_ca_cert_blob();
+if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_ca_cert_path().

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 scheme used to store the CA certificate (blob or path)

+

+

 

 

 

-
NMSetting8021xClass

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

-

-

+
nm_setting_802_1x_get_ca_cert_blob ()

+
const GByteArray *
+nm_setting_802_1x_get_ca_cert_blob (NMSetting8021x *setting);

+
Returns the CA certificate blob if the CA certificate is stored using the
+NM_SETTING_802_1X_CK_SCHEME_BLOB scheme.  Not all EAP methods use a
+CA certificate (LEAP for example), and those that can take advantage of the
+CA certificate allow it to be unset.  Note that lack of a CA certificate
+reduces security by allowing man-in-the-middle attacks, because the identity
+of the network cannot be confirmed by the client.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the CA certificate data

+

+

 

 

 

-
nm_setting_802_1x_new ()

-
NMSetting *         nm_setting_802_1x_new               (void);

-

-Creates a new NMSetting8021x object with default values.
-

-

+
nm_setting_802_1x_get_ca_cert_path ()

+
const char *
+nm_setting_802_1x_get_ca_cert_path (NMSetting8021x *setting);

+
Returns the CA certificate path if the CA certificate is stored using the
+NM_SETTING_802_1X_CK_SCHEME_PATH scheme.  Not all EAP methods use a
+CA certificate (LEAP for example), and those that can take advantage of the
+CA certificate allow it to be unset.  Note that lack of a CA certificate
+reduces security by allowing man-in-the-middle attacks, because the identity
+of the network cannot be confirmed by the client.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSetting8021x object
setting
the NMSetting8021x
 
 

 

 

+

+
Returns

+
 path to the CA certificate file

+

+

+

 

 

-
nm_setting_802_1x_get_num_eap_methods ()

-
guint32             nm_setting_802_1x_get_num_eap_methods
-                                                        (NMSetting8021x *setting);

-

-Returns the number of eap methods allowed for use when connecting to the
-network.  Generally only one EAP method is used.  Use the functions
-nm_setting_802_1x_get_eap_method(), nm_setting_802_1x_add_eap_method(),
-and nm_setting_802_1x_remove_eap_method() for adding, removing, and retrieving
-allowed EAP methods.
-

-

+
nm_setting_802_1x_set_ca_cert ()

+
gboolean
+nm_setting_802_1x_set_ca_cert (NMSetting8021x *setting,
+                               const char *cert_path,
+                               NMSetting8021xCKScheme scheme,
+                               NMSetting8021xCKFormat *out_format,
+                               GError **error);

+
Reads a certificate from disk and sets the “ca-cert” property
+with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB
+scheme, or with the path to the certificate file if using the
+NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+

+
Parameters

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

 





 
 
 
setting :
the NMSetting8021x
-
setting
the NMSetting8021x
 
cert_path
when scheme
+is set to either NM_SETTING_802_1X_CK_SCHEME_PATH
+or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the CA certificate
+file (PEM or DER format).  The path must be UTF-8 encoded; use
+g_filename_to_utf8() to convert if needed.  Passing NULL with any scheme
+clears the CA certificate.
 
scheme
desired storage scheme for the certificate
 
 

 
Returns :
the number of allowed EAP methods
out_format
on successful return, the type of the certificate added
 
error
on unsuccessful return, an error
 
 

 
 

 

+

+
Returns

+
 TRUE if the operation succeeded, FALSE if it was unsuccessful

+

+

+

 

 

-
nm_setting_802_1x_get_eap_method ()

-
const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
-                                                         guint32 i);

-

-Returns the name of the allowed EAP method at index i.
-

-

+
nm_setting_802_1x_get_subject_match ()

+
const char *
+nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the “subject-match” property. This is the
+substring to be matched against the subject of the authentication
+server certificate, or NULL no subject verification is to be
+performed.

+

+

+

+

+

+
nm_setting_802_1x_get_num_altsubject_matches ()

+
guint32
+nm_setting_802_1x_get_num_altsubject_matches
+                               (NMSetting8021x *setting);

+
Returns the number of entries in the
+“altsubject-matches” property of this setting.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the number of altsubject-matches entries.

+

+

+

+

+

+
nm_setting_802_1x_get_altsubject_match ()

+
const char *
+nm_setting_802_1x_get_altsubject_match
+                               (NMSetting8021x *setting,
+                                guint32 i);

+
Returns the altSubjectName match at index i
+.

+

+
Parameters

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

 





 
 
 
setting :
the NMSetting8021x
-
i :
the index of the EAP method name to return
setting
the NMSettingConnection
 
 

 
Returns :
the name of the allowed EAP method at index i
-
i
the zero-based index of the array of altSubjectName matches
 
 

 
 

 

+

+
Returns

+
 the altSubjectName match at index i
+

+

+

+

 

 

-
nm_setting_802_1x_add_eap_method ()

-
gboolean            nm_setting_802_1x_add_eap_method    (NMSetting8021x *setting,
-                                                         const char *eap);

-

-Adds an allowed EAP method.  The setting is not valid until at least one
-EAP method has been added.  See "eap" property for a list of
-allowed EAP methods.
-

-

+
nm_setting_802_1x_add_altsubject_match ()

+
gboolean
+nm_setting_802_1x_add_altsubject_match
+                               (NMSetting8021x *setting,
+                                const char *altsubject_match);

+
Adds an allowed alternate subject name match.  Until at least one
+match is added, the altSubjectName of the remote authentication
+server is not verified.

+

+
Parameters

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

 





 
 
 
setting :
the NMSetting8021x
-
eap :
the name of the EAP method to allow for this connection
setting
the NMSetting8021x
 
 

 
Returns :
TRUE if the EAP method was successfully added, FALSE if it was
-not a valid method or if it was already allowed.
altsubject_match
the altSubjectName to allow for this connection
 
 

 
 

 

+

+
Returns

+
 TRUE if the alternative subject name match was
+successfully added, FALSE if it was already allowed.

+

+

+

 

 

-
nm_setting_802_1x_remove_eap_method ()

-
void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
-                                                         guint32 i);

-

-Removes the allowed EAP method at the specified index.
-

-

+
nm_setting_802_1x_remove_altsubject_match ()

+
void
+nm_setting_802_1x_remove_altsubject_match
+                               (NMSetting8021x *setting,
+                                guint32 i);

+
Removes the allowed altSubjectName at the specified index.

+

+
Parameters

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

 





 
 
 
setting :
the NMSetting8021x
-
setting
the NMSetting8021x
 
 

 
i :
the index of the EAP method to remove
i
the index of the altSubjectName match to remove
 
 

 
 

 

+

 

 

-
nm_setting_802_1x_clear_eap_methods ()

-
void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);

-

-Clears all allowed EAP methods.
-

-

+
nm_setting_802_1x_clear_altsubject_matches ()

+
void
+nm_setting_802_1x_clear_altsubject_matches
+                               (NMSetting8021x *setting);

+
Clears all altSubjectName matches.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+

+

+
nm_setting_802_1x_get_client_cert_scheme ()

+
NMSetting8021xCKScheme
+nm_setting_802_1x_get_client_cert_scheme
+                               (NMSetting8021x *setting);

+
Returns the scheme used to store the client certificate.  If the returned scheme
+is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_client_cert_blob();
+if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path().

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 scheme used to store the client certificate (blob or path)

+

+

+

+

+

+
nm_setting_802_1x_get_client_cert_blob ()

+
const GByteArray *
+nm_setting_802_1x_get_client_cert_blob
+                               (NMSetting8021x *setting);

+
Client certificates are used to identify the connecting client to the network
+when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x
+authentication method.

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSetting8021x
 

+

+

+
Returns

+
 the client certificate data

+

+

+

+

+

+
nm_setting_802_1x_get_client_cert_path ()

+
const char *
+nm_setting_802_1x_get_client_cert_path
+                               (NMSetting8021x *setting);

+
Client certificates are used to identify the connecting client to the network
+when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x
+authentication method.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
setting :
the NMSetting8021x
-
setting
the NMSetting8021x
 
 

 

 

+

+
Returns

+
 path to the client certificate file

+

+

+

 

 

-
nm_setting_802_1x_get_identity ()

-
const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);

-

-Returns the identifier used by some EAP methods (like TLS) to
-authenticate the user.  Often this is a username or login name.
-

-

+
nm_setting_802_1x_set_client_cert ()

+
gboolean
+nm_setting_802_1x_set_client_cert (NMSetting8021x *setting,
+                                   const char *cert_path,
+                                   NMSetting8021xCKScheme scheme,
+                                   NMSetting8021xCKFormat *out_format,
+                                   GError **error);

+
Reads a certificate from disk and sets the “client-cert”
+property with the raw certificate data if using the
+NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate
+file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+
Client certificates are used to identify the connecting client to the network
+when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x
+authentication method.

+

+
Parameters

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

 





 
 
 
setting :
the NMSetting8021x
-
setting
the NMSetting8021x
 
cert_path
when scheme
+is set to either NM_SETTING_802_1X_CK_SCHEME_PATH
+or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the client
+certificate file (PEM, DER, or PKCS12 format).  The path must be UTF-8
+encoded; use g_filename_to_utf8() to convert if needed.  Passing NULL with
+any scheme
+clears the client certificate.
 
scheme
desired storage scheme for the certificate
 
 

 
Returns :
the user identifier
out_format
on successful return, the type of the certificate added
 
error
on unsuccessful return, an error
 
 

 
 

 

+

+
Returns

+
 TRUE if the operation succeeded, FALSE if it was unsuccessful

+

+

+

 

 

-
nm_setting_802_1x_get_anonymous_identity ()

-
const char *        nm_setting_802_1x_get_anonymous_identity
-                                                        (NMSetting8021x *setting);

-

-Returns the anonymous identifier used by some EAP methods (like TTLS) to
-authenticate the user in the outer unencrypted "phase 1" authentication.  The
-inner "phase 2" authentication will use the "identity" in
-a secure form, if applicable for that EAP method.
-

-

+
nm_setting_802_1x_get_phase1_peapver ()

+
const char *
+nm_setting_802_1x_get_phase1_peapver (NMSetting8021x *setting);

+

+
Parameters

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

 





 
setting :
the NMSetting8021x
-
Returns :
the anonymous identifier
setting
the NMSetting8021x
 

 

 

+

+
Returns

+
 the "phase 1" PEAP version to be used when authenticating with
+EAP-PEAP as contained in the “phase1-peapver” property.  Valid
+values are NULL (unset), "0" (PEAP version 0), and "1" (PEAP version 1).

+

+

+

 

 

-
nm_setting_802_1x_get_pac_file ()

-
const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);

-

-Returns the file containing PAC credentials used by EAP-FAST method.
-

-

+
nm_setting_802_1x_get_phase1_peaplabel ()

+
const char *
+nm_setting_802_1x_get_phase1_peaplabel
+                               (NMSetting8021x *setting);

+

+
Parameters

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

 





 
setting :
the NMSetting8021x
-
Returns :
the PAC file
setting
the NMSetting8021x
 

 

 

+

+
Returns

+
 whether the "phase 1" PEAP label is new-style or old-style, to be
+used when authenticating with EAP-PEAP, as contained in the
+“phase1-peaplabel” property.  Valid values are NULL (unset),
+"0" (use old-style label), and "1" (use new-style label).  See the
+wpa_supplicant documentation for more details.

+

+

+
-

nm_setting_802_1x_get_system_ca_certs ()

-
gboolean            nm_setting_802_1x_get_system_ca_certs
-                                                        (NMSetting8021x *setting);
-

-Sets the "system-ca-certs" property. The -"ca-path" and "phase2-ca-path" -properties are ignored if the "system-ca-certs" property is -TRUE, in which case a system-wide CA certificate directory specified at -compile time (using the --system-ca-path configure option) is used in place -of these properties. -

-
+

nm_setting_802_1x_get_phase1_fast_provisioning ()

+
const char *
+nm_setting_802_1x_get_phase1_fast_provisioning
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

TRUE if a system CA certificate path should be used, FALSE if not

setting

the NMSetting8021x

 
+
+

Returns

+

whether "phase 1" PEAP fast provisioning should be used, as specified +by the “phase1-fast-provisioning” property. See the +wpa_supplicant documentation for more details.

+

+
+
-

nm_setting_802_1x_get_ca_path ()

-
const char *        nm_setting_802_1x_get_ca_path       (NMSetting8021x *setting);
-

-Returns the path of the CA certificate directory if previously set. Systems -will often have a directory that contains multiple individual CA certificates -which the supplicant can then add to the verification chain. This may be -used in addition to the "ca-cert" property to add more CA -certificates for verifying the network to client. -

-
+

nm_setting_802_1x_get_phase2_auth ()

+
const char *
+nm_setting_802_1x_get_phase2_auth (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the CA certificate directory path

setting

the NMSetting8021x

 
+
+

Returns

+

the "phase 2" non-EAP (ex MD5) allowed authentication method as +specified by the “phase2-auth” property.

+

+
+
-

nm_setting_802_1x_get_phase2_ca_path ()

-
const char *        nm_setting_802_1x_get_phase2_ca_path
-                                                        (NMSetting8021x *setting);
-

-Returns the path of the "phase 2" CA certificate directory if previously set. -Systems will often have a directory that contains multiple individual CA -certificates which the supplicant can then add to the verification chain. -This may be used in addition to the "phase2-ca-cert" property -to add more CA certificates for verifying the network to client. -

-
+

nm_setting_802_1x_get_phase2_autheap ()

+
const char *
+nm_setting_802_1x_get_phase2_autheap (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "phase 2" CA certificate directory path

setting

the NMSetting8021x

 
+
+

Returns

+

the "phase 2" EAP-based (ex TLS) allowed authentication method as +specified by the “phase2-autheap” property.

+

+
+
-

nm_setting_802_1x_get_ca_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
-

-Returns the scheme used to store the CA certificate. If the returned scheme -is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_ca_cert_blob(); -if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_ca_cert_path(). -

-
+

nm_setting_802_1x_get_phase2_ca_cert_scheme ()

+
NMSetting8021xCKScheme
+nm_setting_802_1x_get_phase2_ca_cert_scheme
+                               (NMSetting8021x *setting);
+

Returns the scheme used to store the "phase 2" CA certificate. If the +returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use +nm_setting_802_1x_get_ca_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, +use nm_setting_802_1x_get_ca_cert_path().

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

scheme used to store the CA certificate (blob or path)

setting

the NMSetting8021x

 
+
+

Returns

+

scheme used to store the "phase 2" CA certificate (blob or path)

+

+
+
-

nm_setting_802_1x_get_ca_cert_blob ()

-
const GByteArray *  nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);
-

-Returns the CA certificate blob if the CA certificate is stored using the -NM_SETTING_802_1X_CK_SCHEME_BLOB scheme. Not all EAP methods use a -CA certificate (LEAP for example), and those that can take advantage of the +

nm_setting_802_1x_get_phase2_ca_cert_blob ()

+
const GByteArray *
+nm_setting_802_1x_get_phase2_ca_cert_blob
+                               (NMSetting8021x *setting);
+

Returns the "phase 2" CA certificate blob if the CA certificate is stored +using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme. Not all EAP methods use +a CA certificate (LEAP for example), and those that can take advantage of the CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client. -

-
+of the network cannot be confirmed by the client.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the CA certificate data

setting

the NMSetting8021x

 
+
+

Returns

+

the "phase 2" CA certificate data

+

+
+
-

nm_setting_802_1x_get_ca_cert_path ()

-
const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);
-

-Returns the CA certificate path if the CA certificate is stored using the -NM_SETTING_802_1X_CK_SCHEME_PATH scheme. Not all EAP methods use a -CA certificate (LEAP for example), and those that can take advantage of the +

nm_setting_802_1x_get_phase2_ca_cert_path ()

+
const char *
+nm_setting_802_1x_get_phase2_ca_cert_path
+                               (NMSetting8021x *setting);
+

Returns the "phase 2" CA certificate path if the CA certificate is stored +using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. Not all EAP methods use +a CA certificate (LEAP for example), and those that can take advantage of the CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client. -

-
+of the network cannot be confirmed by the client.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

path to the CA certificate file

setting

the NMSetting8021x

 
+
+

Returns

+

path to the "phase 2" CA certificate file

+

+
+
-

nm_setting_802_1x_set_ca_cert ()

-
gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-

-Reads a certificate from disk and sets the "ca-cert" property -with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB -scheme, or with the path to the certificate file if using the -NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

-
+

nm_setting_802_1x_set_phase2_ca_cert ()

+
gboolean
+nm_setting_802_1x_set_phase2_ca_cert (NMSetting8021x *setting,
+                                      const char *cert_path,
+                                      NMSetting8021xCKScheme scheme,
+                                      NMSetting8021xCKFormat *out_format,
+                                      GError **error);
+

Reads a certificate from disk and sets the “phase2-ca-cert” +property with the raw certificate data if using the +NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate +file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+
+

Parameters

+
--+++ - - + + + - - + +clears the "phase2" CA certificate.

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

setting :

the NMSetting8021x -

setting

the NMSetting8021x

 

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the CA certificate -file (PEM or DER format). The path must be UTF-8 encoded; use +

cert_path

when scheme +is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" CA +certificate file (PEM or DER format). The path must be UTF-8 encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the CA certificate.

 

scheme :

desired storage scheme for the certificate

scheme

desired storage scheme for the certificate

 

out_format :

on successful return, the type of the certificate added

out_format

on successful return, the type of the certificate added

 

error :

on unsuccessful return, an error

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessful

error

on unsuccessful return, an error

 
+
+

Returns

+

TRUE if the operation succeeded, FALSE if it was unsuccessful

+

+
+
-

nm_setting_802_1x_get_subject_match ()

-
const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_phase2_subject_match ()

+
const char *
+nm_setting_802_1x_get_phase2_subject_match
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "subject-match" property. This is the -substring to be matched against the subject of the authentication -server certificate, or NULL no subject verification is to be -performed.

setting

the NMSetting8021x

 
+
+

Returns

+

the “phase2-subject-match” property. This is +the substring to be matched against the subject of the "phase 2" +authentication server certificate, or NULL no subject verification +is to be performed.

+

+
+
-

nm_setting_802_1x_get_num_altsubject_matches ()

-
guint32             nm_setting_802_1x_get_num_altsubject_matches
-                                                        (NMSetting8021x *setting);
-

-Returns the number of entries in the -"altsubject-matches" property of this setting. -

-
+

nm_setting_802_1x_get_num_phase2_altsubject_matches ()

+
guint32
+nm_setting_802_1x_get_num_phase2_altsubject_matches
+                               (NMSetting8021x *setting);
+

Returns the number of entries in the +“phase2-altsubject-matches” property of this setting.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the number of altsubject-matches entries.

setting

the NMSetting8021x

 
+
+

Returns

+

the number of phase2-altsubject-matches entries.

+

+
+
-

nm_setting_802_1x_get_altsubject_match ()

-
const char *        nm_setting_802_1x_get_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-

-Returns the altSubjectName match at index i. -

-
+

nm_setting_802_1x_get_phase2_altsubject_match ()

+
const char *
+nm_setting_802_1x_get_phase2_altsubject_match
+                               (NMSetting8021x *setting,
+                                guint32 i);
+

Returns the "phase 2" altSubjectName match at index i +.

+
+

Parameters

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

setting :

the NMSettingConnection -

i :

the zero-based index of the array of altSubjectName matches

setting

the NMSettingConnection

 

Returns :

the altSubjectName match at index i -

i

the zero-based index of the array of "phase 2" altSubjectName matches

 
+
+

Returns

+

the "phase 2" altSubjectName match at index i +

+

+
+
-

nm_setting_802_1x_add_altsubject_match ()

-
gboolean            nm_setting_802_1x_add_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *altsubject_match);
-

-Adds an allowed alternate subject name match. Until at least one -match is added, the altSubjectName of the remote authentication -server is not verified. -

-
+

nm_setting_802_1x_add_phase2_altsubject_match ()

+
gboolean
+nm_setting_802_1x_add_phase2_altsubject_match
+                               (NMSetting8021x *setting,
+                                const char *phase2_altsubject_match);
+

Adds an allowed alternate subject name match for "phase 2". Until +at least one match is added, the altSubjectName of the "phase 2" +remote authentication server is not verified.

+
+

Parameters

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

setting :

the NMSetting8021x -

altsubject_match :

the altSubjectName to allow for this connection

setting

the NMSetting8021x

 

Returns :

TRUE if the alternative subject name match was -successfully added, FALSE if it was already allowed.

phase2_altsubject_match

the "phase 2" altSubjectName to allow for this +connection

 
+
+

Returns

+

TRUE if the "phase 2" alternative subject name match was +successfully added, FALSE if it was already allowed.

+

+
+
-

nm_setting_802_1x_remove_altsubject_match ()

-
void                nm_setting_802_1x_remove_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-

-Removes the allowed altSubjectName at the specified index. -

-
+

nm_setting_802_1x_remove_phase2_altsubject_match ()

+
void
+nm_setting_802_1x_remove_phase2_altsubject_match
+                               (NMSetting8021x *setting,
+                                guint32 i);
+

Removes the allowed "phase 2" altSubjectName at the specified index.

+
+

Parameters

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

setting :

the NMSetting8021x -

setting

the NMSetting8021x

 

i :

the index of the altSubjectName match to remove

i

the index of the "phase 2" altSubjectName match to remove

 
+
-

nm_setting_802_1x_clear_altsubject_matches ()

-
void                nm_setting_802_1x_clear_altsubject_matches
-                                                        (NMSetting8021x *setting);
-

-Clears all altSubjectName matches. -

-
+

nm_setting_802_1x_clear_phase2_altsubject_matches ()

+
void
+nm_setting_802_1x_clear_phase2_altsubject_matches
+                               (NMSetting8021x *setting);
+

Clears all "phase 2" altSubjectName matches.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSetting8021x -

setting

the NMSetting8021x

 
+
-

nm_setting_802_1x_get_client_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
-                                                        (NMSetting8021x *setting);
-

-Returns the scheme used to store the client certificate. If the returned scheme -is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_client_cert_blob(); -if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path(). -

-
+

nm_setting_802_1x_get_phase2_client_cert_scheme ()

+
NMSetting8021xCKScheme
+nm_setting_802_1x_get_phase2_client_cert_scheme
+                               (NMSetting8021x *setting);
+

Returns the scheme used to store the "phase 2" client certificate. If the +returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use +nm_setting_802_1x_get_client_cert_blob(); if +NM_SETTING_802_1X_CK_SCHEME_PATH, use +nm_setting_802_1x_get_client_cert_path().

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

scheme used to store the client certificate (blob or path)

setting

the NMSetting8021x

 
+
+

Returns

+

scheme used to store the "phase 2" client certificate (blob or path)

+

+
+
-

nm_setting_802_1x_get_client_cert_blob ()

-
const GByteArray *  nm_setting_802_1x_get_client_cert_blob
-                                                        (NMSetting8021x *setting);
-

-Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_phase2_client_cert_blob ()

+
const GByteArray *
+nm_setting_802_1x_get_phase2_client_cert_blob
+                               (NMSetting8021x *setting);
+

Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-
+authentication method.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the client certificate data

setting

the NMSetting8021x

 
+
+

Returns

+

the "phase 2" client certificate data

+

+
+
-

nm_setting_802_1x_get_client_cert_path ()

-
const char *        nm_setting_802_1x_get_client_cert_path
-                                                        (NMSetting8021x *setting);
-

-Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_phase2_client_cert_path ()

+
const char *
+nm_setting_802_1x_get_phase2_client_cert_path
+                               (NMSetting8021x *setting);
+

Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-
+authentication method.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

path to the client certificate file

setting

the NMSetting8021x

 
+
+

Returns

+

path to the "phase 2" client certificate file

+

+
+
-

nm_setting_802_1x_set_client_cert ()

-
gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-

-Reads a certificate from disk and sets the "client-cert" +

nm_setting_802_1x_set_phase2_client_cert ()

+
gboolean
+nm_setting_802_1x_set_phase2_client_cert
+                               (NMSetting8021x *setting,
+                                const char *cert_path,
+                                NMSetting8021xCKScheme scheme,
+                                NMSetting8021xCKFormat *out_format,
+                                GError **error);
+

Reads a certificate from disk and sets the “phase2-client-cert” property with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

-

-Client certificates are used to identify the connecting client to the network +file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+

Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-
+authentication method.

+
+

Parameters

+
--+++ - - + + + - - + - - - - +any scheme +clears the "phase2" client certificate.

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

setting :

the NMSetting8021x -

setting

the NMSetting8021x

 

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the client +

cert_path

when scheme +is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" client certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with -any scheme clears the client certificate.

scheme :

desired storage scheme for the certificate 

out_format :

on successful return, the type of the certificate added

scheme

desired storage scheme for the certificate

 

error :

on unsuccessful return, an error

out_format

on successful return, the type of the certificate added

 

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessful

error

on unsuccessful return, an error

 
+
+

Returns

+

TRUE if the operation succeeded, FALSE if it was unsuccessful

+

+
+
-

nm_setting_802_1x_get_phase1_peapver ()

-
const char *        nm_setting_802_1x_get_phase1_peapver
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_password ()

+
const char *
+nm_setting_802_1x_get_password (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "phase 1" PEAP version to be used when authenticating with -EAP-PEAP as contained in the "phase1-peapver" property. Valid -values are NULL (unset), "0" (PEAP version 0), and "1" (PEAP version 1).

setting

the NMSetting8021x

 
+
+

Returns

+

the password used by the authentication method, if any, as specified +by the “password” property

+

+
+
-

nm_setting_802_1x_get_phase1_peaplabel ()

-
const char *        nm_setting_802_1x_get_phase1_peaplabel
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_password_flags ()

+
NMSettingSecretFlags
+nm_setting_802_1x_get_password_flags (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

whether the "phase 1" PEAP label is new-style or old-style, to be -used when authenticating with EAP-PEAP, as contained in the -"phase1-peaplabel" property. Valid values are NULL (unset), -"0" (use old-style label), and "1" (use new-style label). See the -wpa_supplicant documentation for more details.

setting

the NMSetting8021x

 
+
+

Returns

+

the NMSettingSecretFlags pertaining to the “password”

+

+
+
-

nm_setting_802_1x_get_phase1_fast_provisioning ()

-
const char *        nm_setting_802_1x_get_phase1_fast_provisioning
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_password_raw ()

+
const GByteArray *
+nm_setting_802_1x_get_password_raw (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

whether "phase 1" PEAP fast provisioning should be used, as specified -by the "phase1-fast-provisioning" property. See the -wpa_supplicant documentation for more details.

setting

the NMSetting8021x

 
+
+

Returns

+

the password used by the authentication method as a +UTF-8-encoded array of bytes, as specified by the +“password-raw” property

+

+
+
-

nm_setting_802_1x_get_phase2_auth ()

-
const char *        nm_setting_802_1x_get_phase2_auth   (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_password_raw_flags ()

+
NMSettingSecretFlags
+nm_setting_802_1x_get_password_raw_flags
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "phase 2" non-EAP (ex MD5) allowed authentication method as -specified by the "phase2-auth" property.

setting

the NMSetting8021x

 
+
+

Returns

+

the NMSettingSecretFlags pertaining to the +“password-raw”

+

+
+
-

nm_setting_802_1x_get_phase2_autheap ()

-
const char *        nm_setting_802_1x_get_phase2_autheap
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_pin ()

+
const char *
+nm_setting_802_1x_get_pin (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "phase 2" EAP-based (ex TLS) allowed authentication method as -specified by the "phase2-autheap" property.

setting

the NMSetting8021x

 
+
+

Returns

+

the PIN used by the authentication method, if any, as specified +by the “pin” property

+

+
+
-

nm_setting_802_1x_get_phase2_ca_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
-

-Returns the scheme used to store the "phase 2" CA certificate. If the -returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_ca_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, -use nm_setting_802_1x_get_ca_cert_path(). -

-
+

nm_setting_802_1x_get_pin_flags ()

+
NMSettingSecretFlags
+nm_setting_802_1x_get_pin_flags (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

scheme used to store the "phase 2" CA certificate (blob or path)

setting

the NMSetting8021x

 
+
+

Returns

+

the NMSettingSecretFlags pertaining to the +“pin”

+

+
+
-

nm_setting_802_1x_get_phase2_ca_cert_blob ()

-
const GByteArray *  nm_setting_802_1x_get_phase2_ca_cert_blob
-                                                        (NMSetting8021x *setting);
-

-Returns the "phase 2" CA certificate blob if the CA certificate is stored -using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme. Not all EAP methods use -a CA certificate (LEAP for example), and those that can take advantage of the -CA certificate allow it to be unset. Note that lack of a CA certificate -reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client. -

-
+

nm_setting_802_1x_get_private_key_scheme ()

+
NMSetting8021xCKScheme
+nm_setting_802_1x_get_private_key_scheme
+                               (NMSetting8021x *setting);
+

Returns the scheme used to store the private key. If the returned scheme is +NM_SETTING_802_1X_CK_SCHEME_BLOB, use +nm_setting_802_1x_get_client_cert_blob(); if +NM_SETTING_802_1X_CK_SCHEME_PATH, use +nm_setting_802_1x_get_client_cert_path().

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "phase 2" CA certificate data

setting

the NMSetting8021x

 
+
+

Returns

+

scheme used to store the private key (blob or path)

+

+
+
-

nm_setting_802_1x_get_phase2_ca_cert_path ()

-
const char *        nm_setting_802_1x_get_phase2_ca_cert_path
-                                                        (NMSetting8021x *setting);
-

-Returns the "phase 2" CA certificate path if the CA certificate is stored -using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. Not all EAP methods use -a CA certificate (LEAP for example), and those that can take advantage of the -CA certificate allow it to be unset. Note that lack of a CA certificate -reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client. -

-
+

nm_setting_802_1x_get_private_key_blob ()

+
const GByteArray *
+nm_setting_802_1x_get_private_key_blob
+                               (NMSetting8021x *setting);
+

Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method.

+

WARNING: the private key property is not a "secret" property, and thus +unencrypted private key data may be readable by unprivileged users. Private +keys should always be encrypted with a private key password.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

path to the "phase 2" CA certificate file

setting

the NMSetting8021x

 
+
+

Returns

+

the private key data

+

+
+
-

nm_setting_802_1x_set_phase2_ca_cert ()

-
gboolean            nm_setting_802_1x_set_phase2_ca_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-

-Reads a certificate from disk and sets the "phase2-ca-cert" -property with the raw certificate data if using the -NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

-
+

nm_setting_802_1x_get_private_key_path ()

+
const char *
+nm_setting_802_1x_get_private_key_path
+                               (NMSetting8021x *setting);
+

Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method.

+
+

Parameters

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

setting :

the NMSetting8021x -

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" CA -certificate file (PEM or DER format). The path must be UTF-8 encoded; use -g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the "phase2" CA certificate.

scheme :

desired storage scheme for the certificate

out_format :

on successful return, the type of the certificate added

error :

on unsuccessful return, an error

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessful

setting

the NMSetting8021x

 
+
+

Returns

+

path to the private key file

+

+
+
-

nm_setting_802_1x_get_phase2_subject_match ()

-
const char *        nm_setting_802_1x_get_phase2_subject_match
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_set_private_key ()

+
gboolean
+nm_setting_802_1x_set_private_key (NMSetting8021x *setting,
+                                   const char *key_path,
+                                   const char *password,
+                                   NMSetting8021xCKScheme scheme,
+                                   NMSetting8021xCKFormat *out_format,
+                                   GError **error);
+

Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method.

+

This function reads a private key from disk and sets the +“private-key” property with the private key file data if using +the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the private +key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+

If password + is given, this function attempts to decrypt the private key to +verify that password + is correct, and if it is, updates the +“private-key-password” property with the given password +. If +the decryption is unsuccessful, FALSE is returned, error + is set, and no +internal data is changed. If no password + is given, the private key is +assumed to be valid, no decryption is performed, and the password may be set +at a later time.

+

WARNING: the private key property is not a "secret" property, and thus +unencrypted private key data using the BLOB scheme may be readable by +unprivileged users. Private keys should always be encrypted with a private +key password to prevent unauthorized access to unencrypted private key data.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "phase2-subject-match" property. This is -the substring to be matched against the subject of the "phase 2" -authentication server certificate, or NULL no subject verification -is to be performed.

setting

the NMSetting8021x

 
-
-
-
-

nm_setting_802_1x_get_num_phase2_altsubject_matches ()

-
guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-

-Returns the number of entries in the -"phase2-altsubject-matches" property of this setting. -

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

setting :

the NMSetting8021x -

key_path

when scheme +is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or +NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the private key file +(PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; use +g_filename_to_utf8() to convert if needed. Passing NULL with any scheme +clears the private key.

 

Returns :

the number of phase2-altsubject-matches entries.

password

password used to decrypt the private key, or NULL if the password +is unknown. If the password is given but fails to decrypt the private key, +an error is returned.

 
-
-
-
-

nm_setting_802_1x_get_phase2_altsubject_match ()

-
const char *        nm_setting_802_1x_get_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-

-Returns the "phase 2" altSubjectName match at index i. -

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

setting :

the NMSettingConnection -

scheme

desired storage scheme for the private key

 

i :

the zero-based index of the array of "phase 2" altSubjectName matches

out_format

on successful return, the type of the private key added

 

Returns :

the "phase 2" altSubjectName match at index i -

error

on unsuccessful return, an error

 
+
+

Returns

+

TRUE if the operation succeeded, FALSE if it was unsuccessful

+

+
+
-

nm_setting_802_1x_add_phase2_altsubject_match ()

-
gboolean            nm_setting_802_1x_add_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *phase2_altsubject_match);
-

-Adds an allowed alternate subject name match for "phase 2". Until -at least one match is added, the altSubjectName of the "phase 2" -remote authentication server is not verified. -

-
+

nm_setting_802_1x_get_private_key_password ()

+
const char *
+nm_setting_802_1x_get_private_key_password
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

phase2_altsubject_match :

the "phase 2" altSubjectName to allow for this -connection

Returns :

TRUE if the "phase 2" alternative subject name match was -successfully added, FALSE if it was already allowed.

setting

the NMSetting8021x

 
+
+

Returns

+

the private key password used to decrypt the private key if +previously set with nm_setting_802_1x_set_private_key(), or the +“private-key-password” property.

+

+
+
-

nm_setting_802_1x_remove_phase2_altsubject_match ()

-
void                nm_setting_802_1x_remove_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-

-Removes the allowed "phase 2" altSubjectName at the specified index. -

-
+

nm_setting_802_1x_get_private_key_password_flags ()

+
NMSettingSecretFlags
+nm_setting_802_1x_get_private_key_password_flags
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

i :

the index of the "phase 2" altSubjectName match to remove

setting

the NMSetting8021x

 
+
+

Returns

+

the NMSettingSecretFlags pertaining to the +“private-key-password”

+

+
+
-

nm_setting_802_1x_clear_phase2_altsubject_matches ()

-
void                nm_setting_802_1x_clear_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-

-Clears all "phase 2" altSubjectName matches. -

-
+

nm_setting_802_1x_get_private_key_format ()

+
NMSetting8021xCKFormat
+nm_setting_802_1x_get_private_key_format
+                               (NMSetting8021x *setting);
+
+

Parameters

+
--+++ - - + + +

setting :

the NMSetting8021x -

setting

the NMSetting8021x

 
+
+

Returns

+

the data format of the private key data stored in the +“private-key” property

+

+
+
-

nm_setting_802_1x_get_phase2_client_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
-                                                        (NMSetting8021x *setting);
-

-Returns the scheme used to store the "phase 2" client certificate. If the -returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if +

nm_setting_802_1x_get_phase2_private_key_scheme ()

+
NMSetting8021xCKScheme
+nm_setting_802_1x_get_phase2_private_key_scheme
+                               (NMSetting8021x *setting);
+

Returns the scheme used to store the "phase 2" private key. If the returned +scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use +nm_setting_802_1x_get_client_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path(). -

-
+nm_setting_802_1x_get_client_cert_path().

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

scheme used to store the "phase 2" client certificate (blob or path)

setting

the NMSetting8021x

 
+
+

Returns

+

scheme used to store the "phase 2" private key (blob or path)

+

+
+
-

nm_setting_802_1x_get_phase2_client_cert_blob ()

-
const GByteArray *  nm_setting_802_1x_get_phase2_client_cert_blob
-                                                        (NMSetting8021x *setting);
-

-Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_phase2_private_key_blob ()

+
const GByteArray *
+nm_setting_802_1x_get_phase2_private_key_blob
+                               (NMSetting8021x *setting);
+

Private keys are used to authenticate the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-
+authentication method.

+

WARNING: the phase2 private key property is not a "secret" property, and thus +unencrypted private key data may be readable by unprivileged users. Private +keys should always be encrypted with a private key password.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the "phase 2" client certificate data

setting

the NMSetting8021x

 
+
+

Returns

+

the "phase 2" private key data

+

+
+
-

nm_setting_802_1x_get_phase2_client_cert_path ()

-
const char *        nm_setting_802_1x_get_phase2_client_cert_path
-                                                        (NMSetting8021x *setting);
-

-Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_phase2_private_key_path ()

+
const char *
+nm_setting_802_1x_get_phase2_private_key_path
+                               (NMSetting8021x *setting);
+

Private keys are used to authenticate the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-
+authentication method.

+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

path to the "phase 2" client certificate file

setting

the NMSetting8021x

 
+
+

Returns

+

path to the "phase 2" private key file

+

+
+
-

nm_setting_802_1x_set_phase2_client_cert ()

-
gboolean            nm_setting_802_1x_set_phase2_client_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-

-Reads a certificate from disk and sets the "phase2-client-cert" -property with the raw certificate data if using the -NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

-

-Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_set_phase2_private_key ()

+
gboolean
+nm_setting_802_1x_set_phase2_private_key
+                               (NMSetting8021x *setting,
+                                const char *key_path,
+                                const char *password,
+                                NMSetting8021xCKScheme scheme,
+                                NMSetting8021xCKFormat *out_format,
+                                GError **error);
+

Private keys are used to authenticate the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-
+authentication method.

+

This function reads a private key from disk and sets the +“phase2-private-key” property with the private key file data if +using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the +private key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+

If password + is given, this function attempts to decrypt the private key to +verify that password + is correct, and if it is, updates the +“phase2-private-key-password” property with the given +password +. If the decryption is unsuccessful, FALSE is returned, error + is +set, and no internal data is changed. If no password + is given, the private +key is assumed to be valid, no decryption is performed, and the password may +be set at a later time.

+

WARNING: the "phase2" private key property is not a "secret" property, and +thus unencrypted private key data using the BLOB scheme may be readable by +unprivileged users. Private keys should always be encrypted with a private +key password to prevent unauthorized access to unencrypted private key data.

+
+

Parameters

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

setting :

the NMSetting8021x -

setting

the NMSetting8021x

 

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" client -certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 -encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with -any scheme clears the "phase2" client certificate.

key_path

when scheme +is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or +NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" private +key file (PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; +use g_filename_to_utf8() to convert if needed. Passing NULL with any +scheme +clears the private key.

 

scheme :

desired storage scheme for the certificate

password

password used to decrypt the private key, or NULL if the password +is unknown. If the password is given but fails to decrypt the private key, +an error is returned.

 

out_format :

on successful return, the type of the certificate added

scheme

desired storage scheme for the private key

 

error :

on unsuccessful return, an error

out_format

on successful return, the type of the private key added

 

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessful

error

on unsuccessful return, an error

 
+
+

Returns

+

TRUE if the operation succeeded, FALSE if it was unsuccessful

+

+
+
-

nm_setting_802_1x_get_password ()

-
const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_phase2_private_key_password ()

+
const char *
+nm_setting_802_1x_get_phase2_private_key_password
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the password used by the authentication method, if any, as specified -by the "password" property

setting

the NMSetting8021x

 
+
+

Returns

+

the private key password used to decrypt the private key if +previously set with nm_setting_802_1x_set_phase2_private_key() or the +“phase2-private-key-password” property.

+

+
+
-

nm_setting_802_1x_get_password_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_password_flags
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_phase2_private_key_password_flags ()

+
NMSettingSecretFlags
+nm_setting_802_1x_get_phase2_private_key_password_flags
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the NMSettingSecretFlags pertaining to the "password" -

setting

the NMSetting8021x

 
+
+

Returns

+

the NMSettingSecretFlags pertaining to the +“phase2-private-key-password”

+

+
+
-

nm_setting_802_1x_get_password_raw ()

-
const GByteArray *  nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_phase2_private_key_format ()

+
NMSetting8021xCKFormat
+nm_setting_802_1x_get_phase2_private_key_format
+                               (NMSetting8021x *setting);
+
+

Parameters

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

setting :

the NMSetting8021x -

Returns :

the password used by the authentication method as a -UTF-8-encoded array of bytes, as specified by the -"password-raw" property

setting

the NMSetting8021x

 
-
+
+

Returns

+

the data format of the "phase 2" private key data stored in the +“phase2-private-key” property

+

+
+ + +
+

Types and Values

-

nm_setting_802_1x_get_password_raw_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
-                                                        (NMSetting8021x *setting);
-
+

enum NMSetting8021xCKFormat

+

NMSetting8021xCKFormat values indicate the general type of a certificate +or private key

+
+

Members

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

setting :

the NMSetting8021x +

NM_SETTING_802_1X_CK_FORMAT_UNKNOWN

 +

unknown file format

 

Returns :

the NMSettingSecretFlags pertaining to the -"password-raw" +

NM_SETTING_802_1X_CK_FORMAT_X509

 +

file contains an X.509 format certificate

 
-
-
-
-

nm_setting_802_1x_get_pin ()

-
const char *        nm_setting_802_1x_get_pin           (NMSetting8021x *setting);
-
---- - - - + + - - + + +

setting :

the NMSetting8021x +

NM_SETTING_802_1X_CK_FORMAT_RAW_KEY

 +

file contains an old-style OpenSSL PEM +or DER private key

 

Returns :

the PIN used by the authentication method, if any, as specified -by the "pin" property

NM_SETTING_802_1X_CK_FORMAT_PKCS12

 +

file contains a PKCS12 certificate +and private key

+		 
+
-

nm_setting_802_1x_get_pin_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_pin_flags    (NMSetting8021x *setting);
-
+

enum NMSetting8021xCKScheme

+

NMSetting8021xCKScheme values indicate how a certificate or private key is +stored in the setting properties, either as a blob of the item's data, or as +a path to a certificate or private key file on the filesystem

+
+

Members

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

setting :

the NMSetting8021x +

NM_SETTING_802_1X_CK_SCHEME_UNKNOWN

 +

unknown certificate or private key +scheme

+		 

NM_SETTING_802_1X_CK_SCHEME_BLOB

 +

certificate or key is stored as the raw +item data

 

Returns :

the NMSettingSecretFlags pertaining to the -"pin" +

NM_SETTING_802_1X_CK_SCHEME_PATH

 +

certificate or key is stored as a path +to a file containing the certificate or key data

 
+
-

nm_setting_802_1x_get_private_key_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_private_key_scheme
-                                                        (NMSetting8021x *setting);
+

NM_SETTING_802_1X_SETTING_NAME

+
#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
+

-Returns the scheme used to store the private key. If the returned scheme is -NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if -NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path().

-
+ +
+
+

enum NMSetting8021xError

+
+

Members

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

setting :

the NMSetting8021x +

NM_SETTING_802_1X_ERROR_UNKNOWN

 +

unknown or unclassified error

+		 

NM_SETTING_802_1X_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

Returns :

scheme used to store the private key (blob or path)

NM_SETTING_802_1X_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 
+
-

nm_setting_802_1x_get_private_key_blob ()

-
const GByteArray *  nm_setting_802_1x_get_private_key_blob
-                                                        (NMSetting8021x *setting);
+

NM_SETTING_802_1X_ERROR

+
#define NM_SETTING_802_1X_ERROR nm_setting_802_1x_error_quark ()
+

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

+
+
+
+

NM_SETTING_802_1X_EAP

+
#define NM_SETTING_802_1X_EAP "eap"
+

-WARNING: the private key property is not a "secret" property, and thus -unencrypted private key data may be readable by unprivileged users. Private -keys should always be encrypted with a private key password.

-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the private key data
-

nm_setting_802_1x_get_private_key_path ()

-
const char *        nm_setting_802_1x_get_private_key_path
-                                                        (NMSetting8021x *setting);
+

NM_SETTING_802_1X_IDENTITY

+
#define NM_SETTING_802_1X_IDENTITY "identity"
+

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

path to the private key file
-

nm_setting_802_1x_set_private_key ()

-
gboolean            nm_setting_802_1x_set_private_key   (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
+

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

+
#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PAC_FILE

+
#define NM_SETTING_802_1X_PAC_FILE "pac-file"
+

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

+
+
+
+

NM_SETTING_802_1X_CA_CERT

+
#define NM_SETTING_802_1X_CA_CERT "ca-cert"
+

-This function reads a private key from disk and sets the -"private-key" property with the private key file data if using -the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the private -key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+
+
+
+

NM_SETTING_802_1X_CA_PATH

+
#define NM_SETTING_802_1X_CA_PATH "ca-path"
+

-If password is given, this function attempts to decrypt the private key to -verify that password is correct, and if it is, updates the -"private-key-password" property with the given password. If -the decryption is unsuccessful, FALSE is returned, error is set, and no -internal data is changed. If no password is given, the private key is -assumed to be valid, no decryption is performed, and the password may be set -at a later time.

+
+
+
+

NM_SETTING_802_1X_SUBJECT_MATCH

+
#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match"
+

-WARNING: the private key property is not a "secret" property, and thus -unencrypted private key data using the BLOB scheme may be readable by -unprivileged users. Private keys should always be encrypted with a private -key password to prevent unauthorized access to unencrypted private key data.

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

setting :

the NMSetting8021x -

key_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or -NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the private key file -(PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; use -g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the private key.

password :

password used to decrypt the private key, or NULL if the password -is unknown. If the password is given but fails to decrypt the private key, -an error is returned.

scheme :

desired storage scheme for the private key

out_format :

on successful return, the type of the private key added

error :

on unsuccessful return, an error

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessful
-

nm_setting_802_1x_get_private_key_password ()

-
const char *        nm_setting_802_1x_get_private_key_password
-                                                        (NMSetting8021x *setting);
-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the private key password used to decrypt the private key if -previously set with nm_setting_802_1x_set_private_key(), or the -"private-key-password" property.
+

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

+
#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
+
+

+

-

nm_setting_802_1x_get_private_key_password_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_private_key_password_flags
-                                                        (NMSetting8021x *setting);
-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the NMSettingSecretFlags pertaining to the -"private-key-password" -
+

NM_SETTING_802_1X_CLIENT_CERT

+
#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
+
+

+

-

nm_setting_802_1x_get_private_key_format ()

-
NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
-                                                        (NMSetting8021x *setting);
-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the data format of the private key data stored in the -"private-key" property
+

NM_SETTING_802_1X_PHASE1_PEAPVER

+
#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PHASE1_PEAPLABEL

+
#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING

+
#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PHASE2_AUTH

+
#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PHASE2_AUTHEAP

+
#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap"
+
+

+

-

nm_setting_802_1x_get_phase2_private_key_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
-                                                        (NMSetting8021x *setting);
+

NM_SETTING_802_1X_PHASE2_CA_CERT

+
#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert"
+

-Returns the scheme used to store the "phase 2" private key. If the returned -scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if -NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path().

-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

scheme used to store the "phase 2" private key (blob or path)
-

nm_setting_802_1x_get_phase2_private_key_blob ()

-
const GByteArray *  nm_setting_802_1x_get_phase2_private_key_blob
-                                                        (NMSetting8021x *setting);
+

NM_SETTING_802_1X_PHASE2_CA_PATH

+
#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path"
+

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

+
+
+
+

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

+
#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
+

-WARNING: the phase2 private key property is not a "secret" property, and thus -unencrypted private key data may be readable by unprivileged users. Private -keys should always be encrypted with a private key password.

-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the "phase 2" private key data
-

nm_setting_802_1x_get_phase2_private_key_path ()

-
const char *        nm_setting_802_1x_get_phase2_private_key_path
-                                                        (NMSetting8021x *setting);
+

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

+
#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
+

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

path to the "phase 2" private key file
-

nm_setting_802_1x_set_phase2_private_key ()

-
gboolean            nm_setting_802_1x_set_phase2_private_key
-                                                        (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
+

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

+
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
+

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

+
+
+
+

NM_SETTING_802_1X_PASSWORD

+
#define NM_SETTING_802_1X_PASSWORD "password"
+

-This function reads a private key from disk and sets the -"phase2-private-key" property with the private key file data if -using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the -private key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

+
+
+
+

NM_SETTING_802_1X_PASSWORD_FLAGS

+
#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags"
+

-If password is given, this function attempts to decrypt the private key to -verify that password is correct, and if it is, updates the -"phase2-private-key-password" property with the given -password. If the decryption is unsuccessful, FALSE is returned, error is -set, and no internal data is changed. If no password is given, the private -key is assumed to be valid, no decryption is performed, and the password may -be set at a later time.

+
+
+
+

NM_SETTING_802_1X_PASSWORD_RAW

+
#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw"
+

-WARNING: the "phase2" private key property is not a "secret" property, and -thus unencrypted private key data using the BLOB scheme may be readable by -unprivileged users. Private keys should always be encrypted with a private -key password to prevent unauthorized access to unencrypted private key data.

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

setting :

the NMSetting8021x -

key_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or -NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" private -key file (PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; -use g_filename_to_utf8() to convert if needed. Passing NULL with any -scheme clears the private key.

password :

password used to decrypt the private key, or NULL if the password -is unknown. If the password is given but fails to decrypt the private key, -an error is returned.

scheme :

desired storage scheme for the private key

out_format :

on successful return, the type of the private key added

error :

on unsuccessful return, an error

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessful
-

nm_setting_802_1x_get_phase2_private_key_password ()

-
const char *        nm_setting_802_1x_get_phase2_private_key_password
-                                                        (NMSetting8021x *setting);
-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the private key password used to decrypt the private key if -previously set with nm_setting_802_1x_set_phase2_private_key() or the -"phase2-private-key-password" property.
+

NM_SETTING_802_1X_PASSWORD_RAW_FLAGS

+
#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
+
+

+

-

nm_setting_802_1x_get_phase2_private_key_password_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
-                                                        (NMSetting8021x *setting);
-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the NMSettingSecretFlags pertaining to the -"phase2-private-key-password" -
+

NM_SETTING_802_1X_PRIVATE_KEY

+
#define NM_SETTING_802_1X_PRIVATE_KEY "private-key"
+
+

+

-

nm_setting_802_1x_get_phase2_private_key_format ()

-
NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
-                                                        (NMSetting8021x *setting);
-
---- - - - - - - - - - - -

setting :

the NMSetting8021x -

Returns :

the data format of the "phase 2" private key data stored in the -"phase2-private-key" property
-
+

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

+
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
+
+

+

-
-

Property Details

+
-

The "altsubject-matches" property

-
  "altsubject-matches"       GSList_gchararray_*   : Read / Write
+

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

+
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
+

-List of strings to be matched against the altSubjectName of the -certificate presented by the authentication server. If the list -is empty, no verification of the server certificate's -altSubjectName is performed.

-

The "anonymous-identity" property

-
  "anonymous-identity"       gchar*                : Read / Write
+

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY

+
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
+

-Anonymous identity string for EAP authentication methods. Used as the -unencrypted identity with EAP types that support different tunneled -identity like EAP-TTLS.

-

Default value: NULL

-

The "ca-cert" property

-
  "ca-cert"                  GArray_guchar_*       : Read / Write
+

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD

+
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
+

-Contains the CA certificate if used by the EAP method specified in the -"eap" property. Setting this property directly is -discouraged; use the nm_setting_802_1x_set_ca_cert() function instead.

-

The "ca-path" property

-
  "ca-path"                  gchar*                : Read / Write
+

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

+
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"
+

-UTF-8 encoded path to a directory containing PEM or DER formatted -certificates to be added to the verification chain in addition to the -certificate specified in the "ca-cert" property.

-

Default value: NULL

-

The "client-cert" property

-
  "client-cert"              GArray_guchar_*       : Read / Write
+

NM_SETTING_802_1X_PIN

+
#define NM_SETTING_802_1X_PIN "pin"
+

-Contains the client certificate if used by the EAP method specified in -the "eap" property. Setting this property directly is -discouraged; use the nm_setting_802_1x_set_client_cert() function instead.

-

The "eap" property

-
  "eap"                      GSList_gchararray_*   : Read / Write
+

NM_SETTING_802_1X_PIN_FLAGS

+
#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
+

-The allowed EAP method to be used when authenticating to the network with -802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", and -"fast". Each method requires different configuration using the -properties of this object; refer to wpa_supplicant documentation for the -allowed combinations.

-

The "identity" property

-
  "identity"                 gchar*                : Read / Write
+

NM_SETTING_802_1X_SYSTEM_CA_CERTS

+
#define NM_SETTING_802_1X_SYSTEM_CA_CERTS "system-ca-certs"
+

-Identity string for EAP authentication methods. Often the user's -user or login name.

+
+
+
+

Property Details

+
+

The “altsubject-matches” property

+
  “altsubject-matches”       GSList_gchararray_ *
+

List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.

+

Flags: Read / Write

+
+
+
+

The “anonymous-identity” property

+
  “anonymous-identity”       gchar *
+

Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.

+

Flags: Read / Write

Default value: NULL

-

The "pac-file" property

-
  "pac-file"                 gchar*                : Read / Write
-

-UTF-8 encoded file path containing PAC for EAP-FAST. -

+

The “ca-cert” property

+
  “ca-cert”                  GArray_guchar_ *
+

Contains the CA certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

+

Flags: Read / Write

+
+
+
+

The “ca-path” property

+
  “ca-path”                  gchar *
+

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'ca-cert' property.

+

Flags: Read / Write

Default value: NULL

-

The "password" property

-
  "password"                 gchar*                : Read / Write
-

-Password used for EAP authentication methods. If both -"password" and "password-raw" are -specified, "password" is preferred. -

+

The “client-cert” property

+
  “client-cert”              GArray_guchar_ *
+

Contains the client certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.

+

Flags: Read / Write

+
+
+
+

The “eap” property

+
  “eap”                      GSList_gchararray_ *
+

The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.

+

Flags: Read / Write

+
+
+
+

The “identity” property

+
  “identity”                 gchar *
+

Identity string for EAP authentication methods. Often the user's user or login name.

+

Flags: Read / Write

Default value: NULL

-

The "password-flags" property

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

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

+

The “pac-file” property

+
  “pac-file”                 gchar *
+

UTF-8 encoded file path containing PAC for EAP-FAST.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “password” property

+
  “password”                 gchar *
+

UTF-8 encoded password used for EAP authentication methods.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “password-flags” property

+
  “password-flags”           guint
+

Flags indicating how to handle the 802.1x password.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "password-raw" property

-
  "password-raw"             GArray_guchar_*       : Read / Write
-

-Password used for EAP authentication methods delivered as a -UTF-8-encoded array of bytes. If both "password" -and "password-raw" are specified, -"password" is preferred. -

+

The “password-raw” property

+
  “password-raw”             GArray_guchar_ *
+

Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both 'password' and 'password-raw' are given, 'password' is preferred.

+

Flags: Read / Write

-

The "password-raw-flags" property

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

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

+

The “password-raw-flags” property

+
  “password-raw-flags”       guint
+

Flags indicating how to handle the 802.1x password byte array.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "phase1-fast-provisioning" property

-
  "phase1-fast-provisioning" gchar*                : Read / Write
-

-Enables or disables in-line provisioning of EAP-FAST credentials when -FAST is specified as the EAP method in the "eap" property. -Recognized values are "0" (disabled), "1" (allow unauthenticated -provisioning), "2" (allow authenticated provisioning), and "3" (allow -both authenticated and unauthenticated provisioning). See the -wpa_supplicant documentation for more details. -

+

The “phase1-fast-provisioning” property

+
  “phase1-fast-provisioning” gchar *
+

Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property. Allowed values are '0' (disabled), '1' (allow unauthenticated provisioning), '2' (allow authenticated provisioning), and '3' (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.

+

Flags: Read / Write

Default value: NULL

-

The "phase1-peaplabel" property

-
  "phase1-peaplabel"         gchar*                : Read / Write
-

-Forces use of the new PEAP label during key derivation. Some RADIUS -servers may require forcing the new PEAP label to interoperate with -PEAPv1. Set to "1" to force use of the new PEAP label. See the -wpa_supplicant documentation for more details. -

+

The “phase1-peaplabel” property

+
  “phase1-peaplabel”         gchar *
+

Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to '1' to force use of the new PEAP label. See the wpa_supplicant documentation for more details.

+

Flags: Read / Write

Default value: NULL

-

The "phase1-peapver" property

-
  "phase1-peapver"           gchar*                : Read / Write
-

-Forces which PEAP version is used when PEAP is set as the EAP method in -the "eap" property. When unset, the version reported by -the server will be used. Sometimes when using older RADIUS servers, it -is necessary to force the client to use a particular PEAP version. To do -so, this property may be set to "0" or "1" to force that specific PEAP -version. -

+

The “phase1-peapver” property

+
  “phase1-peapver”           gchar *
+

Forces which PEAP version is used when PEAP is set as the EAP method in 'eap' property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to '0' or '1' to force that specific PEAP version.

+

Flags: Read / Write

Default value: NULL

-

The "phase2-altsubject-matches" property

-
  "phase2-altsubject-matches" GSList_gchararray_*   : Read / Write
-

-List of strings to be matched against the altSubjectName of the -certificate presented by the authentication server during the -inner "phase 2" authentication. If the list is empty, no -verification of the server certificate's altSubjectName is -performed. -

+

The “phase2-altsubject-matches” property

+
  “phase2-altsubject-matches” GSList_gchararray_ *
+

List of strings to be matched against List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner 'phase 2' authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.

+

Flags: Read / Write

-

The "phase2-auth" property

-
  "phase2-auth"              gchar*                : Read / Write
-

-Specifies the allowed "phase 2" inner non-EAP authentication methods when -an EAP method that uses an inner TLS tunnel is specified in the -"eap" property. Recognized non-EAP phase2 methods are -"pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". -Each 'phase 2' inner method requires specific parameters for successful -authentication; see the wpa_supplicant documentation for more details. -

+

The “phase2-auth” property

+
  “phase2-auth”              gchar *
+

Specifies the allowed 'phase 2' inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized non-EAP phase2 methods are 'pap', 'chap', 'mschap', 'mschapv2', 'gtc', 'otp', 'md5', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.

+

Flags: Read / Write

Default value: NULL

-

The "phase2-autheap" property

-
  "phase2-autheap"           gchar*                : Read / Write
-

-Specifies the allowed "phase 2" inner EAP-based authentication methods -when an EAP method that uses an inner TLS tunnel is specified in the -"eap" property. Recognized EAP-based phase2 methods are -"md5", "mschapv2", "otp", "gtc", and "tls". Each 'phase 2' inner method -requires specific parameters for successful authentication; see the -wpa_supplicant documentation for more details. -

+

The “phase2-autheap” property

+
  “phase2-autheap”           gchar *
+

Specifies the allowed 'phase 2' inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized EAP-based 'phase 2' methods are 'md5', 'mschapv2', 'otp', 'gtc', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.

+

Flags: Read / Write

Default value: NULL

-

The "phase2-ca-cert" property

-
  "phase2-ca-cert"           GArray_guchar_*       : Read / Write
-

-Contains the CA certificate if used by the EAP method specified in the -"phase2-auth" or "phase2-autheap" properties. -Setting this property directly is discouraged; use the -nm_setting_802_1x_set_phase2_ca_cert() function instead. -

+

The “phase2-ca-cert” property

+
  “phase2-ca-cert”           GArray_guchar_ *
+

Contains the 'phase 2' CA certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currentlysupported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

+

Flags: Read / Write

-

The "phase2-ca-path" property

-
  "phase2-ca-path"           gchar*                : Read / Write
-

-UTF-8 encoded path to a directory containing PEM or DER formatted -certificates to be added to the verification chain in addition to the -certificate specified in the "phase2-ca-cert" property. -

+

The “phase2-ca-path” property

+
  “phase2-ca-path”           gchar *
+

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'phase2-ca-cert' property.

+

Flags: Read / Write

Default value: NULL

-

The "phase2-client-cert" property

-
  "phase2-client-cert"       GArray_guchar_*       : Read / Write
-

-Contains the client certificate if used by the EAP method specified in -the "phase2-auth" or "phase2-autheap" -properties. Setting this property directly is discouraged; use the -nm_setting_802_1x_set_phase2_client_cert() function instead. -

+

The “phase2-client-cert” property

+
  “phase2-client-cert”       GArray_guchar_ *
+

Contains the 'phase 2' client certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.

+

Flags: Read / Write

-

The "phase2-private-key" property

-
  "phase2-private-key"       GArray_guchar_*       : Read / Write
-

-Private key data used by "phase 2" inner authentication methods. -

-

-Contains the "phase 2" inner private key if the "phase2-auth" -or "phase2-autheap" property is set to 'tls'. Setting this -property directly is discouraged; use the -nm_setting_802_1x_set_phase2_private_key() function instead. -

+

The “phase2-private-key” property

+
  “phase2-private-key”       GArray_guchar_ *
+

Contains the 'phase 2' inner private key when the 'phase2-auth' or 'phase2-autheap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the 'phase2-private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'phase2-private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.

+

Flags: Read / Write

-

The "phase2-private-key-password" property

-
  "phase2-private-key-password" gchar*                : Read / Write
-

-The password used to decrypt the private key specified in -"phase2-private-key" when the private key either uses the -path scheme, or if the private key is a PKCS12 format key. Setting this -property directly is not generally necessary except when returning -secrets to NetworkManager; it is generally set automatically when setting -the private key by the nm_setting_802_1x_set_phase2_private_key() function. -

+

The “phase2-private-key-password” property

+
  “phase2-private-key-password” gchar *
+

The password used to decrypt the 'phase 2' private key specified in the 'private-key' property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key.

+

Flags: Read / Write

Default value: NULL

-

The "phase2-private-key-password-flags" property

-
  "phase2-private-key-password-flags" guint                 : Read / Write
-

-Flags indicating how to handle "phase2-private-key-password":. -

+

The “phase2-private-key-password-flags” property

+
  “phase2-private-key-password-flags” guint
+

Flags indicating how to handle the 802.1x phase2 private key password.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "phase2-subject-match" property

-
  "phase2-subject-match"     gchar*                : Read / Write
-

-Substring to be matched against the subject of the certificate -presented by the authentication server during the inner "phase -2" authentication. When unset, no verification of the -authentication server certificate's subject is performed. -

+

The “phase2-subject-match” property

+
  “phase2-subject-match”     gchar *
+

Substring to be matched against the subject of the certificate presented by the authentication server during the inner 'phase2' authentication. When unset, no verification of the authentication server certificate's subject is performed.

+

Flags: Read / Write

Default value: NULL

-

The "pin" property

-
  "pin"                      gchar*                : Read / Write
-

-PIN used for EAP authentication methods. -

+

The “pin” property

+
  “pin”                      gchar *
+

PIN used for EAP authentication methods.

+

Flags: Read / Write

Default value: NULL

-

The "pin-flags" property

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

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

+

The “pin-flags” property

+
  “pin-flags”                guint
+

Flags indicating how to handle the 802.1x PIN.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "private-key" property

-
  "private-key"              GArray_guchar_*       : Read / Write
-

-Contains the private key if the "eap" property is set to -'tls'. Setting this property directly is discouraged; use the -nm_setting_802_1x_set_private_key() function instead. -

-

-WARNING: "private-key" is not a "secret" property, and thus -unencrypted private key data using the BLOB scheme may be readable by -unprivileged users. Private keys should always be encrypted with a -private key password to prevent unauthorized access to unencrypted -private key data. -

+

The “private-key” property

+
  “private-key”              GArray_guchar_ *
+

Contains the private key when the 'eap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the 'private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.

+

Flags: Read / Write

-

The "private-key-password" property

-
  "private-key-password"     gchar*                : Read / Write
-

-The password used to decrypt the private key specified in -"private-key" when the private key either uses the path -scheme, or if the private key is a PKCS12 format key. Setting this -property directly is not generally necessary except when returning -secrets to NetworkManager; it is generally set automatically when setting -the private key by the nm_setting_802_1x_set_private_key() function. -

+

The “private-key-password” property

+
  “private-key-password”     gchar *
+

The password used to decrypt the private key specified in the 'private-key' property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.

+

Flags: Read / Write

Default value: NULL

-

The "private-key-password-flags" property

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

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

+

The “private-key-password-flags” property

+
  “private-key-password-flags” guint
+

Flags indicating how to handle the 802.1x private key password.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "subject-match" property

-
  "subject-match"            gchar*                : Read / Write
-

-Substring to be matched against the subject of the certificate -presented by the authentication server. When unset, no -verification of the authentication server certificate's subject -is performed. -

+

The “subject-match” property

+
  “subject-match”            gchar *
+

Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed.

+

Flags: Read / Write

Default value: NULL

-

The "system-ca-certs" property

-
  "system-ca-certs"          gboolean              : Read / Write / Construct
-

-When TRUE, overrides "ca-path" and -"phase2-ca-path" properties using the system CA directory -specified at configure time with the --system-ca-path switch. The -certificates in this directory are added to the verification chain in -addition to any certificates specified by the "ca-cert" -and "phase2-ca-cert" properties. -

+

The “system-ca-certs” property

+
  “system-ca-certs”          gboolean
+

When TRUE, overrides 'ca-path' and 'phase2-ca-path' properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the 'ca-cert' and 'phase2-ca-cert' properties.

+

Flags: Read / Write / Construct

Default value: FALSE

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingAdsl.html b/docs/libnm-util/html/NMSettingAdsl.html index 761094b9..25a642bb 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
-

-ADSL connection encapsulation, can be vcmux or llc. -

+

The “encapsulation” property

+
  “encapsulation”            gchar *
+

Encapsulation of ADSL connection.

+

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

Password used to authenticate with the pppoa 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 ADSL password.

+

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

ADSL connection protocol.

+

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

Username used to authenticate with the pppoa service.

+

Flags: Read / Write

Default value: NULL

-

The "vci" property

-
  "vci"                      guint                 : Read / Write
-

-ADSL connection vci. -

+

The “vci” property

+
  “vci”                      guint
+

VCI of ADSL connection.

+

Flags: Read / Write

Allowed values: <= 65536

Default value: 0

-

The "vpi" property

-
  "vpi"                      guint                 : Read / Write
-

-ADSL connection vpi. -

+

The “vpi” property

+
  “vpi”                      guint
+

VPI of ADSL connection.

+

Flags: Read / Write

Allowed values: <= 65536

Default value: 0

@@ -536,6 +677,6 @@ ADSL connection vpi.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBluetooth.html b/docs/libnm-util/html/NMSettingBluetooth.html index 388ae5e7..0fa1c00a 100644 --- a/docs/libnm-util/html/NMSettingBluetooth.html +++ b/docs/libnm-util/html/NMSettingBluetooth.html @@ -2,34 +2,28 @@ -NMSettingBluetooth +libnm-util Reference Manual: NMSettingBluetooth - + - - - - - - - - - - + + + + + + +
@@ -37,59 +31,218 @@

NMSettingBluetooth

NMSettingBluetooth — Describes Bluetooth connection properties

- +
-
-

Synopsis

-
-#include <nm-setting-bluetooth.h>
-
-#define             NM_SETTING_BLUETOOTH_SETTING_NAME
-enum                NMSettingBluetoothError;
-#define             NM_SETTING_BLUETOOTH_ERROR
-GQuark              nm_setting_bluetooth_error_quark    (void);
-#define             NM_SETTING_BLUETOOTH_BDADDR
-#define             NM_SETTING_BLUETOOTH_TYPE
-#define             NM_SETTING_BLUETOOTH_TYPE_DUN
-#define             NM_SETTING_BLUETOOTH_TYPE_PANU
-                    NMSettingBluetooth;
-                    NMSettingBluetoothClass;
-NMSetting *         nm_setting_bluetooth_new            (void);
-const GByteArray *  nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);
-const char *        nm_setting_bluetooth_get_connection_type
-                                                        (NMSettingBluetooth *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_bluetooth_error_quark () +
+NMSetting * + +nm_setting_bluetooth_new () +
const GByteArray * + +nm_setting_bluetooth_get_bdaddr () +
const char * + +nm_setting_bluetooth_get_connection_type () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + +
+GArray_guchar_ *bdaddrRead / Write
+gchar *typeRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_BLUETOOTH_SETTING_NAME
enumNMSettingBluetoothError
#defineNM_SETTING_BLUETOOTH_ERROR
#defineNM_SETTING_BLUETOOTH_BDADDR
#defineNM_SETTING_BLUETOOTH_TYPE
#defineNM_SETTING_BLUETOOTH_TYPE_DUN
#defineNM_SETTING_BLUETOOTH_TYPE_PANU

Object Hierarchy

-
-  GEnum
-   +----NMSettingBluetoothError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingBluetooth
+
    GEnum
+    ╰── NMSettingBluetoothError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingBluetooth
-

Properties

-
-  "bdaddr"                   GArray_guchar_*       : Read / Write
-  "type"                     gchar*                : Read / Write
+
Includes

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

Description

-

-The NMSettingBluetooth object is a NMSetting subclass that describes +

The NMSettingBluetooth object is a NMSetting subclass that describes properties necessary for connection to devices that provide network connections via the Bluetooth Dial-Up Networking (DUN) and Network Access -Point (NAP) profiles. -

+Point (NAP) profiles.

+
+
+

Functions

+
+

nm_setting_bluetooth_error_quark ()

+
GQuark
+nm_setting_bluetooth_error_quark (void);
+

Registers an error quark for NMSettingBluetooth if necessary.

+
+

Returns

+

the error quark used for NMSettingBluetooth errors.

+

+
+
+
+
+

nm_setting_bluetooth_new ()

+
NMSetting *
+nm_setting_bluetooth_new (void);
+

Creates a new NMSettingBluetooth object with default values.

+
+

Returns

+

the new empty NMSettingBluetooth object.

+

[transfer full]

+
+
+
+
+

nm_setting_bluetooth_get_bdaddr ()

+
const GByteArray *
+nm_setting_bluetooth_get_bdaddr (NMSettingBluetooth *setting);
+

Gets the Bluetooth address of the remote device which this setting +describes a connection to.

+
+

Parameters

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

setting

the NMSettingBluetooth

 
+
+
+

Returns

+

the Bluetooth address

+

+
+
+
+
+

nm_setting_bluetooth_get_connection_type ()

+
const char *
+nm_setting_bluetooth_get_connection_type
+                               (NMSettingBluetooth *setting);
+

Returns the connection method for communicating with the remote device (i.e. +either DUN to a DUN-capable device or PANU to a NAP-capable device).

+
+

Parameters

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

setting

the NMSettingBluetooth

 
+
+
+

Returns

+

the type, either NM_SETTING_BLUETOOTH_PANU or NM_SETTING_BLUETOOTH_DUN

+

+
+
-

Details

+

Types and Values

NM_SETTING_BLUETOOTH_SETTING_NAME

#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth"
@@ -99,46 +252,51 @@ Point (NAP) profiles.
-

enum NMSettingBluetoothError

-
typedef enum {
-	NM_SETTING_BLUETOOTH_ERROR_UNKNOWN = 0,            /*< nick=UnknownError >*/
-	NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY,       /*< nick=InvalidProperty >*/
-	NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY,       /*< nick=MissingProperty >*/
-	NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND, /*< nick=TypeSettingNotFound >*/
-} NMSettingBluetoothError;
-
-
+

enum NMSettingBluetoothError

+
+

Members

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

NM_SETTING_BLUETOOTH_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_BLUETOOTH_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND

the connection +

NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND

 +

the connection did not contain a required type setting, ie for DUN connections the connection -must also contain an NMSettingGsm or NMSettingCdma as appropriate +must also contain an NMSettingGsm or NMSettingCdma as appropriate

 
+

NM_SETTING_BLUETOOTH_ERROR

@@ -149,24 +307,6 @@ must also contain an -

nm_setting_bluetooth_error_quark ()

-
GQuark              nm_setting_bluetooth_error_quark    (void);
-

-Registers an error quark for NMSettingBluetooth if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingBluetooth errors.
-
-
-

NM_SETTING_BLUETOOTH_BDADDR

#define NM_SETTING_BLUETOOTH_BDADDR    "bdaddr"
@@ -186,141 +326,38 @@ Registers an error quark for

NM_SETTING_BLUETOOTH_TYPE_DUN

#define NM_SETTING_BLUETOOTH_TYPE_DUN  "dun"
-

-Connection type describing a connection to devices that support the Bluetooth -DUN profile. -

+

Connection type describing a connection to devices that support the Bluetooth +DUN profile.

NM_SETTING_BLUETOOTH_TYPE_PANU

#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu"
-

-Connection type describing a connection to devices that support the Bluetooth -NAP (Network Access Point) protocol, which accepts connections via PANU. -

-
-
-
-

NMSettingBluetooth

-
typedef struct _NMSettingBluetooth NMSettingBluetooth;
-

-

-
-
-
-

NMSettingBluetoothClass

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

-

-
-
-
-

nm_setting_bluetooth_new ()

-
NMSetting *         nm_setting_bluetooth_new            (void);
-

-Creates a new NMSettingBluetooth object with default values. -

-
---- - - - - -

Returns :

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

nm_setting_bluetooth_get_bdaddr ()

-
const GByteArray *  nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);
-

-Gets the Bluetooth address of the remote device which this setting -describes a connection to. -

-
---- - - - - - - - - - - -

setting :

the NMSettingBluetooth -

Returns :

the Bluetooth address
-
-
-
-

nm_setting_bluetooth_get_connection_type ()

-
const char *        nm_setting_bluetooth_get_connection_type
-                                                        (NMSettingBluetooth *setting);
-

-Returns the connection method for communicating with the remote device (i.e. -either DUN to a DUN-capable device or PANU to a NAP-capable device). -

-
---- - - - - - - - - - - -

setting :

the NMSettingBluetooth -

Returns :

the type, either NM_SETTING_BLUETOOTH_PANU or NM_SETTING_BLUETOOTH_DUN -
+

Connection type describing a connection to devices that support the Bluetooth +NAP (Network Access Point) protocol, which accepts connections via PANU.

Property Details

-

The "bdaddr" property

-
  "bdaddr"                   GArray_guchar_*       : Read / Write
-

-The Bluetooth address of the device. -

+

The “bdaddr” property

+
  “bdaddr”                   GArray_guchar_ *
+

The Bluetooth address of the device.

+

Flags: Read / Write

-

The "type" property

-
  "type"                     gchar*                : Read / Write
-

-Either 'dun' for Dial-Up Networking connections or 'panu' for Personal -Area Networking connections to devices supporting the NAP profile. -

+

The “type” property

+
  “type”                     gchar *
+

Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBond.html b/docs/libnm-util/html/NMSettingBond.html index 89c6fe25..b047b365 100644 --- a/docs/libnm-util/html/NMSettingBond.html +++ b/docs/libnm-util/html/NMSettingBond.html @@ -2,34 +2,28 @@ -NMSettingBond +libnm-util Reference Manual: NMSettingBond - + - - - - - - - - - - + + + + + + +
@@ -37,544 +31,662 @@

NMSettingBond

NMSettingBond — Describes connection properties for bonds

- +
-
-

Synopsis

-
-#include <nm-setting-bond.h>
-
-#define             NM_SETTING_BOND_SETTING_NAME
-enum                NMSettingBondError;
-#define             NM_SETTING_BOND_ERROR
-GQuark              nm_setting_bond_error_quark         (void);
-#define             NM_SETTING_BOND_INTERFACE_NAME
-#define             NM_SETTING_BOND_OPTIONS
-#define             NM_SETTING_BOND_OPTION_MODE
-#define             NM_SETTING_BOND_OPTION_MIIMON
-#define             NM_SETTING_BOND_OPTION_DOWNDELAY
-#define             NM_SETTING_BOND_OPTION_UPDELAY
-#define             NM_SETTING_BOND_OPTION_ARP_INTERVAL
-#define             NM_SETTING_BOND_OPTION_ARP_IP_TARGET
-                    NMSettingBond;
-                    NMSettingBondClass;
-NMSetting *         nm_setting_bond_new                 (void);
-const char *        nm_setting_bond_get_interface_name  (NMSettingBond *setting);
-guint32             nm_setting_bond_get_num_options     (NMSettingBond *setting);
-gboolean            nm_setting_bond_get_option          (NMSettingBond *setting,
-                                                         guint32 idx,
-                                                         const char **out_name,
-                                                         const char **out_value);
-const char *        nm_setting_bond_get_option_by_name  (NMSettingBond *setting,
-                                                         const char *name);
-gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
-                                                         const char *name,
-                                                         const char *value);
-gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
-                                                         const char *name);
-const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);
-const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
-                                                         const char *name);
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingBondError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingBond
-
-
-
-

Properties

-
-  "interface-name"           gchar*                : Read / Write
-  "options"                  GHashTable_gchararray+gchararray_*  : Read / Write
-
-
-
-

Description

-

-The NMSettingBond object is a NMSetting subclass that describes properties -necessary for bond connections. -

-
-
-

Details

-
-

NM_SETTING_BOND_SETTING_NAME

-
#define NM_SETTING_BOND_SETTING_NAME "bond"
-
-

-

-
-
-
-

enum NMSettingBondError

-
typedef enum {
-	NM_SETTING_BOND_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_BOND_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_BOND_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-	NM_SETTING_BOND_ERROR_INVALID_OPTION,   /*< nick=InvalidOption >*/
-	NM_SETTING_BOND_ERROR_MISSING_OPTION,   /*< nick=MissingOption >*/
-} NMSettingBondError;
-
-
+

Functions

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

NM_SETTING_BOND_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_bond_error_quark () +
+NMSetting * + +nm_setting_bond_new () +
const char * + +nm_setting_bond_get_interface_name () +
+guint32 + +nm_setting_bond_get_num_options () +
+gboolean + +nm_setting_bond_get_option ()

NM_SETTING_BOND_ERROR_INVALID_PROPERTY

the property was invalid +const char * + +nm_setting_bond_get_option_by_name ()

NM_SETTING_BOND_ERROR_MISSING_PROPERTY

the property was missing and is -required + +gboolean + +nm_setting_bond_add_option ()

NM_SETTING_BOND_ERROR_INVALID_OPTION

 + +gboolean + +nm_setting_bond_remove_option ()

NM_SETTING_BOND_ERROR_MISSING_OPTION

 +const char ** + +nm_setting_bond_get_valid_options () +
const char * + +nm_setting_bond_get_option_default ()
-
-
-

NM_SETTING_BOND_ERROR

-
#define NM_SETTING_BOND_ERROR nm_setting_bond_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + +
+gchar *interface-nameRead / Write
GHashTable_gchararray+gchararray_*optionsRead / Write
-
-
-

nm_setting_bond_error_quark ()

-
GQuark              nm_setting_bond_error_quark         (void);
-

-Registers an error quark for NMSettingBond if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingBond errors.
#defineNM_SETTING_BOND_SETTING_NAME
enumNMSettingBondError
#defineNM_SETTING_BOND_ERROR
#defineNM_SETTING_BOND_INTERFACE_NAME
#defineNM_SETTING_BOND_OPTIONS
#defineNM_SETTING_BOND_OPTION_MODE
#defineNM_SETTING_BOND_OPTION_MIIMON
#defineNM_SETTING_BOND_OPTION_DOWNDELAY
#defineNM_SETTING_BOND_OPTION_UPDELAY
#defineNM_SETTING_BOND_OPTION_ARP_INTERVAL
#defineNM_SETTING_BOND_OPTION_ARP_IP_TARGET
-
-
-

NM_SETTING_BOND_INTERFACE_NAME

-
#define NM_SETTING_BOND_INTERFACE_NAME "interface-name"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingBondError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingBond
 

-

-

 

-

-

-
NM_SETTING_BOND_OPTIONS

-
#define NM_SETTING_BOND_OPTIONS "options"
+

+
Includes

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

-

-

 

-

-

-
NM_SETTING_BOND_OPTION_MODE

-
#define NM_SETTING_BOND_OPTION_MODE          "mode"
-

-

-

+

+
Description

+
The NMSettingBond object is a NMSetting subclass that describes properties
+necessary for bond connections.

 

-

+

+
Functions

 

-
NM_SETTING_BOND_OPTION_MIIMON

-
#define NM_SETTING_BOND_OPTION_MIIMON        "miimon"
-

-

-

+
nm_setting_bond_error_quark ()

+
GQuark
+nm_setting_bond_error_quark (void);

+
Registers an error quark for NMSettingBond if necessary.

+

+
Returns

+
 the error quark used for NMSettingBond errors.

+

 

-

-

-
NM_SETTING_BOND_OPTION_DOWNDELAY

-
#define NM_SETTING_BOND_OPTION_DOWNDELAY     "downdelay"
-

-

-

 

 

 

-
NM_SETTING_BOND_OPTION_UPDELAY

-
#define NM_SETTING_BOND_OPTION_UPDELAY       "updelay"
-

-

-

+
nm_setting_bond_new ()

+
NMSetting *
+nm_setting_bond_new (void);

+
Creates a new NMSettingBond object with default values.

+

+
Returns

+
 the new empty NMSettingBond object. 

+
[transfer full]

 

-

-

-
NM_SETTING_BOND_OPTION_ARP_INTERVAL

-
#define NM_SETTING_BOND_OPTION_ARP_INTERVAL  "arp_interval"
-

-

-

 

 

 

-
NM_SETTING_BOND_OPTION_ARP_IP_TARGET

-
#define NM_SETTING_BOND_OPTION_ARP_IP_TARGET "arp_ip_target"
-

-

-

+
nm_setting_bond_get_interface_name ()

+
const char *
+nm_setting_bond_get_interface_name (NMSettingBond *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingBond
 

 

-

-

-
NMSettingBond

-
typedef struct _NMSettingBond NMSettingBond;

-

-

+

+
Returns

+
 the “interface-name” property of the setting

+

 

-

-

-
NMSettingBondClass

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

-

-

 

 

 

-
nm_setting_bond_new ()

-
NMSetting *         nm_setting_bond_new                 (void);

-

-Creates a new NMSettingBond object with default values.
-

-

+
nm_setting_bond_get_num_options ()

+
guint32
+nm_setting_bond_get_num_options (NMSettingBond *setting);

+
Returns the number of options that should be set for this bond when it
+is activated. This can be used to retrieve each option individually
+using nm_setting_bond_get_option().

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingBond object. [transfer full]
-
setting
the NMSettingBond
 
 

 

 

+

+
Returns

+
 the number of bonding options

+

+

+

 

 

-
nm_setting_bond_get_interface_name ()

-
const char *        nm_setting_bond_get_interface_name  (NMSettingBond *setting);

-

+
nm_setting_bond_get_option ()

+
gboolean
+nm_setting_bond_get_option (NMSettingBond *setting,
+                            guint32 idx,
+                            const char **out_name,
+                            const char **out_value);

+
Given an index, return the value of the bonding option at that index.  Indexes
+are *not* guaranteed to be static across modifications to options done by
+nm_setting_bond_add_option() and nm_setting_bond_remove_option(),
+and should not be used to refer to options except for short periods of time
+such as during option iteration.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingBond
-
setting
the NMSettingBond
 
idx
index of the desired option, from 0 to
+nm_setting_bond_get_num_options() - 1
 
out_name
 on return, the name of the bonding option; this
+value is owned by the setting and should not be modified. 
[out]
 

 
Returns :
the "interface-name" property of the setting
out_value
 on return, the value of the name of the bonding
+option; this value is owned by the setting and should not be modified. 
[out]
 

 
 

 

+

+
Returns

+
 TRUE on success if the index was valid and an option was found,
+FALSE if the index was invalid (ie, greater than the number of options
+currently held by the setting)

+

+

+

 

 

-
nm_setting_bond_get_num_options ()

-
guint32             nm_setting_bond_get_num_options     (NMSettingBond *setting);

-

-Returns the number of options that should be set for this bond when it
-is activated. This can be used to retrieve each option individually
-using nm_setting_bond_get_option().
-

-

+
nm_setting_bond_get_option_by_name ()

+
const char *
+nm_setting_bond_get_option_by_name (NMSettingBond *setting,
+                                    const char *name);

+
Returns the value associated with the bonding option specified by
+name
+, if it exists.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingBond
-
setting
the NMSettingBond
 
 

 
Returns :
the number of bonding options
name
the option name for which to retrieve the value
 
 

 
 

 

+

+
Returns

+
 the value, or NULL if the key/value pair was never added to the
+setting; the value is owned by the setting and must not be modified

+

+

+

 

 

-
nm_setting_bond_get_option ()

-
gboolean            nm_setting_bond_get_option          (NMSettingBond *setting,
-                                                         guint32 idx,
-                                                         const char **out_name,
-                                                         const char **out_value);

-

-Given an index, return the value of the bonding option at that index.  Indexes
-are *not* guaranteed to be static across modifications to options done by
-nm_setting_bond_add_option() and nm_setting_bond_remove_option(),
-and should not be used to refer to options except for short periods of time
-such as during option iteration.
-

-

+
nm_setting_bond_add_option ()

+
gboolean
+nm_setting_bond_add_option (NMSettingBond *setting,
+                            const char *name,
+                            const char *value);

+
Add an option to the table.  The option is compared to an internal list
+of allowed options.  Option names may contain only alphanumeric characters
+(ie [a-zA-Z0-9]).  Adding a new name replaces any existing name/value pair
+that may already exist.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingBond
-
setting
the NMSettingBond
 
 

 
idx :
index of the desired option, from 0 to
-nm_setting_bond_get_num_options() - 1
name
name for the option
 
 

 
out_name :
on return, the name of the bonding option; this
-value is owned by the setting and should not be modified. [out]
-
out_value :
on return, the value of the name of the bonding
-option; this value is owned by the setting and should not be modified. [out]
-
Returns :

-TRUE on success if the index was valid and an option was found,
-FALSE if the index was invalid (ie, greater than the number of options
-currently held by the setting)
value
value for the option
 
 

 
 

 

+

+
Returns

+
 TRUE if the option was valid and was added to the internal option
+list, FALSE if it was not.

+

+

+

 

 

-
nm_setting_bond_get_option_by_name ()

-
const char *        nm_setting_bond_get_option_by_name  (NMSettingBond *setting,
-                                                         const char *name);

-

-Returns the value associated with the bonding option specified by
-name, if it exists.
-

-

+
nm_setting_bond_remove_option ()

+
gboolean
+nm_setting_bond_remove_option (NMSettingBond *setting,
+                               const char *name);

+
Remove the bonding option referenced by name
+ from the internal option
+list.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingBond
-
name :
the option name for which to retrieve the value
setting
the NMSettingBond
 
 

 
Returns :
the value, or NULL if the key/value pair was never added to the
-setting; the value is owned by the setting and must not be modified
name
name of the option to remove
 
 

 
 

 

+

+
Returns

+
 TRUE if the option was found and removed from the internal option
+list, FALSE if it was not.

+

+

+

 

 

-
nm_setting_bond_add_option ()

-
gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
-                                                         const char *name,
-                                                         const char *value);

-

-Add an option to the table.  The option is compared to an internal list
-of allowed options.  Option names may contain only alphanumeric characters
-(ie [a-zA-Z0-9]).  Adding a new name replaces any existing name/value pair
-that may already exist.
-

-

+
nm_setting_bond_get_valid_options ()

+
const char **
+nm_setting_bond_get_valid_options (NMSettingBond *setting);

+
Returns a list of valid bond options.

+

+
Parameters

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

 





 
setting :
the NMSettingBond
-
name :
name for the option
value :
value for the option
Returns :

-TRUE if the option was valid and was added to the internal option
-list, FALSE if it was not.
setting
the NMSettingBond
 

 

 

+

+
Returns

+
 a NULL-terminated array of strings of valid bond options. 

+
[transfer none]

+

+

 

 

-
nm_setting_bond_remove_option ()

-
gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
-                                                         const char *name);

-

-Remove the bonding option referenced by name from the internal option
-list.
-

-

+
nm_setting_bond_get_option_default ()

+
const char *
+nm_setting_bond_get_option_default (NMSettingBond *setting,
+                                    const char *name);

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingBond
-
setting
the NMSettingBond
 
 

 
name :
name of the option to remove
Returns :

-TRUE if the option was found and removed from the internal option
-list, FALSE if it was not.
name
the name of the option
 
 

 
 

 

-

+

+
Returns

+
 the value of the bond option if not overridden by an entry in
+the “options” property.

+

+

+

+
+
+

Types and Values

-

nm_setting_bond_get_valid_options ()

-
const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);
+

NM_SETTING_BOND_SETTING_NAME

+
#define NM_SETTING_BOND_SETTING_NAME "bond"
+

-Returns a list of valid bond options.

-
+ +
+
+

enum NMSettingBondError

+
+

Members

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

setting :

the NMSettingBond +

NM_SETTING_BOND_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

a NULL-terminated array of strings of valid bond options. [transfer none] +

NM_SETTING_BOND_ERROR_INVALID_PROPERTY

 +

the property was invalid

 
-
-
-
-

nm_setting_bond_get_option_default ()

-
const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
-                                                         const char *name);
-
---- - - - + + - - + + + - - + + +

setting :

the NMSettingBond +

NM_SETTING_BOND_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

name :

the name of the option

NM_SETTING_BOND_ERROR_INVALID_OPTION

  

Returns :

the value of the bond option if not overridden by an entry in -the "options" property.

NM_SETTING_BOND_ERROR_MISSING_OPTION

  
-
-

Property Details

+
-

The "interface-name" property

-
  "interface-name"           gchar*                : Read / Write
+

NM_SETTING_BOND_ERROR

+
#define NM_SETTING_BOND_ERROR nm_setting_bond_error_quark ()
+
+

+

+
+
+
+

NM_SETTING_BOND_INTERFACE_NAME

+
#define NM_SETTING_BOND_INTERFACE_NAME "interface-name"
+

-The name of the virtual in-kernel bonding network interface

-

Default value: NULL

-

The "options" property

-
  "options"                  GHashTable_gchararray+gchararray_*  : Read / Write
+

NM_SETTING_BOND_OPTIONS

+
#define NM_SETTING_BOND_OPTIONS "options"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_MODE

+
#define NM_SETTING_BOND_OPTION_MODE          "mode"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_MIIMON

+
#define NM_SETTING_BOND_OPTION_MIIMON        "miimon"
+

-Dictionary of key/value pairs of bonding options. Both keys -and values must be strings. Option names must contain only -alphanumeric characters (ie, [a-zA-Z0-9]).

+
+
+

NM_SETTING_BOND_OPTION_DOWNDELAY

+
#define NM_SETTING_BOND_OPTION_DOWNDELAY     "downdelay"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_UPDELAY

+
#define NM_SETTING_BOND_OPTION_UPDELAY       "updelay"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_ARP_INTERVAL

+
#define NM_SETTING_BOND_OPTION_ARP_INTERVAL  "arp_interval"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_ARP_IP_TARGET

+
#define NM_SETTING_BOND_OPTION_ARP_IP_TARGET "arp_ip_target"
+
+

+

+
+
+
+

Property Details

+
+

The “interface-name” property

+
  “interface-name”           gchar *
+

The name of the virtual in-kernel bonding network interface.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “options” property

+
  “options”                  GHashTable_gchararray+gchararray_*
+

Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

+

Flags: Read / Write

+
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBridge.html b/docs/libnm-util/html/NMSettingBridge.html index b5a9742c..8be803d6 100644 --- a/docs/libnm-util/html/NMSettingBridge.html +++ b/docs/libnm-util/html/NMSettingBridge.html @@ -2,34 +2,28 @@ -NMSettingBridge +libnm-util Reference Manual: NMSettingBridge - + - - - - - - - - - - + + + + + + +
@@ -37,70 +31,427 @@

NMSettingBridge

NMSettingBridge — Describes connection properties for bridges

- +
-
-

Synopsis

-
-#include <nm-setting-bridge.h>
-
-#define             NM_SETTING_BRIDGE_SETTING_NAME
-enum                NMSettingBridgeError;
-#define             NM_SETTING_BRIDGE_ERROR
-GQuark              nm_setting_bridge_error_quark       (void);
-#define             NM_SETTING_BRIDGE_INTERFACE_NAME
-#define             NM_SETTING_BRIDGE_STP
-#define             NM_SETTING_BRIDGE_PRIORITY
-#define             NM_SETTING_BRIDGE_FORWARD_DELAY
-#define             NM_SETTING_BRIDGE_HELLO_TIME
-#define             NM_SETTING_BRIDGE_MAX_AGE
-#define             NM_SETTING_BRIDGE_AGEING_TIME
-                    NMSettingBridge;
-                    NMSettingBridgeClass;
-NMSetting *         nm_setting_bridge_new               (void);
-const char *        nm_setting_bridge_get_interface_name
-                                                        (NMSettingBridge *setting);
-gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);
-guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_bridge_error_quark () +
+NMSetting * + +nm_setting_bridge_new () +
const char * + +nm_setting_bridge_get_interface_name () +
+gboolean + +nm_setting_bridge_get_stp () +
+guint16 + +nm_setting_bridge_get_priority () +
+guint16 + +nm_setting_bridge_get_forward_delay () +
+guint16 + +nm_setting_bridge_get_hello_time () +
+guint16 + +nm_setting_bridge_get_max_age () +
+guint32 + +nm_setting_bridge_get_ageing_time () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
guintageing-timeRead / Write / Construct
guintforward-delayRead / Write / Construct
guinthello-timeRead / Write / Construct
+gchar *interface-nameRead / Write
guintmax-ageRead / Write / Construct
guintpriorityRead / Write / Construct
gbooleanstpRead / Write / Construct
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_BRIDGE_SETTING_NAME
enumNMSettingBridgeError
#defineNM_SETTING_BRIDGE_ERROR
#defineNM_SETTING_BRIDGE_INTERFACE_NAME
#defineNM_SETTING_BRIDGE_STP
#defineNM_SETTING_BRIDGE_PRIORITY
#defineNM_SETTING_BRIDGE_FORWARD_DELAY
#defineNM_SETTING_BRIDGE_HELLO_TIME
#defineNM_SETTING_BRIDGE_MAX_AGE
#defineNM_SETTING_BRIDGE_AGEING_TIME

Object Hierarchy

-
-  GEnum
-   +----NMSettingBridgeError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingBridge
+
    GEnum
+    ╰── NMSettingBridgeError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingBridge
-

Properties

-
-  "ageing-time"              guint                 : Read / Write / Construct
-  "forward-delay"            guint                 : Read / Write / Construct
-  "hello-time"               guint                 : Read / Write / Construct
-  "interface-name"           gchar*                : Read / Write
-  "max-age"                  guint                 : Read / Write / Construct
-  "priority"                 guint                 : Read / Write / Construct
-  "stp"                      gboolean              : Read / Write / Construct
+
Includes

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

Description

-

-The NMSettingBridge object is a NMSetting subclass that describes properties -necessary for bridging connections. -

+

The NMSettingBridge object is a NMSetting subclass that describes properties +necessary for bridging connections.

+
+
+

Functions

+
+

nm_setting_bridge_error_quark ()

+
GQuark
+nm_setting_bridge_error_quark (void);
+

Registers an error quark for NMSettingBridge if necessary.

+
+

Returns

+

the error quark used for NMSettingBridge errors.

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_new ()

+
NMSetting *
+nm_setting_bridge_new (void);
+

Creates a new NMSettingBridge object with default values.

+
+

Returns

+

the new empty NMSettingBridge object.

+

[transfer full]

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_interface_name ()

+
const char *
+nm_setting_bridge_get_interface_name (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “interface-name” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_stp ()

+
gboolean
+nm_setting_bridge_get_stp (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “stp” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_priority ()

+
guint16
+nm_setting_bridge_get_priority (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “priority” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_forward_delay ()

+
guint16
+nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “forward-delay” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_hello_time ()

+
guint16
+nm_setting_bridge_get_hello_time (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “hello-time” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_max_age ()

+
guint16
+nm_setting_bridge_get_max_age (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “max-age” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_ageing_time ()

+
guint32
+nm_setting_bridge_get_ageing_time (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “ageing-time” property of the setting

+

+
+

Since 0.9.8

+
-

Details

+

Types and Values

NM_SETTING_BRIDGE_SETTING_NAME

#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
@@ -110,37 +461,41 @@ necessary for bridging connections.
-

enum NMSettingBridgeError

-
typedef enum {
-	NM_SETTING_BRIDGE_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-} NMSettingBridgeError;
-
-
+

enum NMSettingBridgeError

+
+

Members

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

NM_SETTING_BRIDGE_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_BRIDGE_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 
+

Since 0.9.8

@@ -153,25 +508,6 @@ required
-

nm_setting_bridge_error_quark ()

-
GQuark              nm_setting_bridge_error_quark       (void);
-

-Registers an error quark for NMSettingBridge if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingBridge errors.
-

Since 0.9.8

-
-
-

NM_SETTING_BRIDGE_INTERFACE_NAME

#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"
@@ -226,287 +562,73 @@ Registers an error quark for -

NMSettingBridge

-
typedef struct _NMSettingBridge NMSettingBridge;
-

-

-
-
-
-

NMSettingBridgeClass

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

-

-
-
-
-

nm_setting_bridge_new ()

-
NMSetting *         nm_setting_bridge_new               (void);
-

-Creates a new NMSettingBridge object with default values. -

-
---- - - - - -

Returns :

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

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_interface_name ()

-
const char *        nm_setting_bridge_get_interface_name
-                                                        (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "interface-name" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_stp ()

-
gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "stp" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_priority ()

-
guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "priority" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_forward_delay ()

-
guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "forward-delay" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_hello_time ()

-
guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "hello-time" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_max_age ()

-
guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "max-age" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_ageing_time ()

-
guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "ageing-time" property of the setting
-

Since 0.9.8

-

Property Details

-

The "ageing-time" property

-
  "ageing-time"              guint                 : Read / Write / Construct
-

-The ethernet MAC address aging time, in seconds. -

+

The “ageing-time” property

+
  “ageing-time”              guint
+

The ethernet MAC address aging time, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 1000000

Default value: 300

Since 0.9.8

-

The "forward-delay" property

-
  "forward-delay"            guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) forwarding delay, in seconds. -

+

The “forward-delay” property

+
  “forward-delay”            guint
+

The Spanning Tree Protocol (STP) forwarding delay, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 30

Default value: 15

Since 0.9.8

-

The "hello-time" property

-
  "hello-time"               guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) hello time, in seconds. -

+

The “hello-time” property

+
  “hello-time”               guint
+

The Spanning Tree Protocol (STP) hello time, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 10

Default value: 2

Since 0.9.8

-

The "interface-name" property

-
  "interface-name"           gchar*                : Read / Write
-

-The name of the virtual in-kernel briding network interface -

+

The “interface-name” property

+
  “interface-name”           gchar *
+

The name of the virtual in-kernel bridging network interface.

+

Flags: Read / Write

Default value: NULL

Since 0.9.8

-

The "max-age" property

-
  "max-age"                  guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) maximum message age, in seconds. -

+

The “max-age” property

+
  “max-age”                  guint
+

The Spanning Tree Protocol (STP) maximum message age, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 40

Default value: 20

Since 0.9.8

-

The "priority" property

-
  "priority"                 guint                 : Read / Write / Construct
-

-Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower -values are "better"; the lowest priority bridge will be elected the root -bridge. -

+

The “priority” property

+
  “priority”                 guint
+

Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are 'better'; the lowest priority bridge will be elected the root bridge.

+

Flags: Read / Write / Construct

Allowed values: <= 65535

-

Default value: 128

+

Default value: 32768

Since 0.9.8

-

The "stp" property

-
  "stp"                      gboolean              : Read / Write / Construct
-

-Controls whether Spanning Tree Protocol (STP) is enabled for this bridge. -

+

The “stp” property

+
  “stp”                      gboolean
+

Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.

+

Flags: Read / Write / Construct

Default value: TRUE

Since 0.9.8

@@ -514,6 +636,6 @@ Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBridgePort.html b/docs/libnm-util/html/NMSettingBridgePort.html index bb2e37d0..146e4a64 100644 --- a/docs/libnm-util/html/NMSettingBridgePort.html +++ b/docs/libnm-util/html/NMSettingBridgePort.html @@ -2,34 +2,28 @@ -NMSettingBridgePort +libnm-util Reference Manual: NMSettingBridgePort - + - - - - - - - - - - + + + + + + +
@@ -37,59 +31,252 @@

NMSettingBridgePort

NMSettingBridgePort — Describes connection properties for bridge ports

- +
-
-

Synopsis

-
-#include <nm-setting-bridge-port.h>
-
-#define             NM_SETTING_BRIDGE_PORT_SETTING_NAME
-enum                NMSettingBridgePortError;
-#define             NM_SETTING_BRIDGE_PORT_ERROR
-GQuark              nm_setting_bridge_port_error_quark  (void);
-#define             NM_SETTING_BRIDGE_PORT_PRIORITY
-#define             NM_SETTING_BRIDGE_PORT_PATH_COST
-#define             NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE
-                    NMSettingBridgePort;
-                    NMSettingBridgePortClass;
-NMSetting *         nm_setting_bridge_port_new          (void);
-guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
-guint16             nm_setting_bridge_port_get_path_cost
-                                                        (NMSettingBridgePort *setting);
-gboolean            nm_setting_bridge_port_get_hairpin_mode
-                                                        (NMSettingBridgePort *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_bridge_port_error_quark () +
+NMSetting * + +nm_setting_bridge_port_new () +
+guint16 + +nm_setting_bridge_port_get_priority () +
+guint16 + +nm_setting_bridge_port_get_path_cost () +
+gboolean + +nm_setting_bridge_port_get_hairpin_mode () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + +
gbooleanhairpin-modeRead / Write
guintpath-costRead / Write / Construct
guintpriorityRead / Write / Construct
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_BRIDGE_PORT_SETTING_NAME
enumNMSettingBridgePortError
#defineNM_SETTING_BRIDGE_PORT_ERROR
#defineNM_SETTING_BRIDGE_PORT_PRIORITY
#defineNM_SETTING_BRIDGE_PORT_PATH_COST
#defineNM_SETTING_BRIDGE_PORT_HAIRPIN_MODE

Object Hierarchy

-
-  GEnum
-   +----NMSettingBridgePortError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingBridgePort
+
    GEnum
+    ╰── NMSettingBridgePortError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingBridgePort
-

Properties

-
-  "hairpin-mode"             gboolean              : Read / Write
-  "path-cost"                guint                 : Read / Write / Construct
-  "priority"                 guint                 : Read / Write / Construct
+
Includes

+
#include <nm-setting-bridge-port.h>

Description

-

-The NMSettingBridgePort object is a NMSetting subclass that describes -optional properties that apply to bridge ports. -

+

The NMSettingBridgePort object is a NMSetting subclass that describes +optional properties that apply to bridge ports.

+
+
+

Functions

+
+

nm_setting_bridge_port_error_quark ()

+
GQuark
+nm_setting_bridge_port_error_quark (void);
+

Registers an error quark for NMSettingBridgePort if necessary.

+
+

Returns

+

the error quark used for NMSettingBridgePort errors.

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_port_new ()

+
NMSetting *
+nm_setting_bridge_port_new (void);
+

Creates a new NMSettingBridgePort object with default values.

+
+

Returns

+

the new empty NMSettingBridgePort object.

+

[transfer full]

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_port_get_priority ()

+
guint16
+nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
+
+

Parameters

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

setting

the NMSettingBridgePort

 
+
+
+

Returns

+

the “priority” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_port_get_path_cost ()

+
guint16
+nm_setting_bridge_port_get_path_cost (NMSettingBridgePort *setting);
+
+

Parameters

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

setting

the NMSettingBridgePort

 
+
+
+

Returns

+

the “path-cost” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_port_get_hairpin_mode ()

+
gboolean
+nm_setting_bridge_port_get_hairpin_mode
+                               (NMSettingBridgePort *setting);
+
+

Parameters

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

setting

the NMSettingBridgePort

 
+
+
+

Returns

+

the “hairpin-mode” property of the setting

+

+
+

Since 0.9.8

+
-

Details

+

Types and Values

NM_SETTING_BRIDGE_PORT_SETTING_NAME

#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port"
@@ -99,37 +286,41 @@ optional properties that apply to bridge ports.
-

enum NMSettingBridgePortError

-
typedef enum {
-	NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-} NMSettingBridgePortError;
-
-
+

enum NMSettingBridgePortError

+
+

Members

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

NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY

the property was missing and -is required +

NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY

 +

the property was missing and +is required

 
+

Since 0.9.8

@@ -142,25 +333,6 @@ is required
-

nm_setting_bridge_port_error_quark ()

-
GQuark              nm_setting_bridge_port_error_quark  (void);
-

-Registers an error quark for NMSettingBridgePort if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingBridgePort errors.
-

Since 0.9.8

-
-
-

NM_SETTING_BRIDGE_PORT_PRIORITY

#define NM_SETTING_BRIDGE_PORT_PRIORITY     "priority"
@@ -183,151 +355,33 @@ Registers an error quark for

-
-
-

NMSettingBridgePort

-
typedef struct _NMSettingBridgePort NMSettingBridgePort;
-

-

-
-
-
-

NMSettingBridgePortClass

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

-

-
-
-
-

nm_setting_bridge_port_new ()

-
NMSetting *         nm_setting_bridge_port_new          (void);
-

-Creates a new NMSettingBridgePort object with default values. -

-
---- - - - - -

Returns :

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

Since 0.9.8

-
-
-
-

nm_setting_bridge_port_get_priority ()

-
guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridgePort -

Returns :

the "priority" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_port_get_path_cost ()

-
guint16             nm_setting_bridge_port_get_path_cost
-                                                        (NMSettingBridgePort *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridgePort -

Returns :

the "path-cost" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_port_get_hairpin_mode ()

-
gboolean            nm_setting_bridge_port_get_hairpin_mode
-                                                        (NMSettingBridgePort *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridgePort -

Returns :

the "hairpin-mode" property of the setting
-

Since 0.9.8

-

Property Details

-

The "hairpin-mode" property

-
  "hairpin-mode"             gboolean              : Read / Write
-

-Enables or disabled 'hairpin mode' for the port, which allows frames to -be sent back out through the port the frame was received on. -

+

The “hairpin-mode” property

+
  “hairpin-mode”             gboolean
+

Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.

+

Flags: Read / Write

Default value: FALSE

Since 0.9.8

-

The "path-cost" property

-
  "path-cost"                guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) port cost for destinations via this port. -

+

The “path-cost” property

+
  “path-cost”                guint
+

The Spanning Tree Protocol (STP) port cost for destinations via this port.

+

Flags: Read / Write / Construct

Allowed values: <= 65535

Default value: 100

Since 0.9.8

-

The "priority" property

-
  "priority"                 guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) priority of this bridge port. -

+

The “priority” property

+
  “priority”                 guint
+

The Spanning Tree Protocol (STP) priority of this bridge port.

+

Flags: Read / Write / Construct

Allowed values: <= 63

Default value: 32

Since 0.9.8

@@ -336,6 +390,6 @@ The Spanning Tree Protocol (STP) priority of this bridge port.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingCdma.html b/docs/libnm-util/html/NMSettingCdma.html index 0ce20d15..0693faa6 100644 --- a/docs/libnm-util/html/NMSettingCdma.html +++ b/docs/libnm-util/html/NMSettingCdma.html @@ -2,34 +2,28 @@ -NMSettingCdma +libnm-util Reference Manual: NMSettingCdma - + - - - - - - - - - - + + + + + + +
@@ -37,61 +31,290 @@

NMSettingCdma

NMSettingCdma — Describes CDMA-based mobile broadband properties

- +
-
-

Synopsis

-
-#include <nm-setting-cdma.h>
-
-#define             NM_SETTING_CDMA_SETTING_NAME
-enum                NMSettingCdmaError;
-#define             NM_SETTING_CDMA_ERROR
-GQuark              nm_setting_cdma_error_quark         (void);
-#define             NM_SETTING_CDMA_NUMBER
-#define             NM_SETTING_CDMA_USERNAME
-#define             NM_SETTING_CDMA_PASSWORD
-#define             NM_SETTING_CDMA_PASSWORD_FLAGS
-                    NMSettingCdma;
-                    NMSettingCdmaClass;
-NMSetting *         nm_setting_cdma_new                 (void);
-const char *        nm_setting_cdma_get_number          (NMSettingCdma *setting);
-const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
-const char *        nm_setting_cdma_get_password        (NMSettingCdma *setting);
-NMSettingSecretFlags nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_cdma_error_quark () +
+NMSetting * + +nm_setting_cdma_new () +
const char * + +nm_setting_cdma_get_number () +
const char * + +nm_setting_cdma_get_username () +
const char * + +nm_setting_cdma_get_password () +
+NMSettingSecretFlags + +nm_setting_cdma_get_password_flags () +
+
+
+

Properties

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

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_CDMA_SETTING_NAME
enumNMSettingCdmaError
#defineNM_SETTING_CDMA_ERROR
#defineNM_SETTING_CDMA_NUMBER
#defineNM_SETTING_CDMA_USERNAME
#defineNM_SETTING_CDMA_PASSWORD
#defineNM_SETTING_CDMA_PASSWORD_FLAGS

Object Hierarchy

-
-  GEnum
-   +----NMSettingCdmaError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingCdma
+
    GEnum
+    ╰── NMSettingCdmaError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingCdma
-

Properties

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

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

Description

-

-The NMSettingCdma object is a NMSetting subclass that describes +

The NMSettingCdma object is a NMSetting subclass that describes properties that allow connections to IS-95-based mobile broadband -networks, including those using CDMA2000/EVDO technology. -

+networks, including those using CDMA2000/EVDO technology.

-

Details

+

Functions

+
+

nm_setting_cdma_error_quark ()

+
GQuark
+nm_setting_cdma_error_quark (void);
+

Registers an error quark for NMSettingCdma if necessary.

+
+

Returns

+

the error quark used for NMSettingCdma errors.

+

+
+
+
+
+

nm_setting_cdma_new ()

+
NMSetting *
+nm_setting_cdma_new (void);
+

Creates a new NMSettingCdma object with default values.

+
+

Returns

+

the new empty NMSettingCdma object

+

+
+
+
+
+

nm_setting_cdma_get_number ()

+
const char *
+nm_setting_cdma_get_number (NMSettingCdma *setting);
+
+

Parameters

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

setting

the NMSettingCdma

 
+
+
+

Returns

+

the “number” property of the setting

+

+
+
+
+
+

nm_setting_cdma_get_username ()

+
const char *
+nm_setting_cdma_get_username (NMSettingCdma *setting);
+
+

Parameters

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

setting

the NMSettingCdma

 
+
+
+

Returns

+

the “username” property of the setting

+

+
+
+
+
+

nm_setting_cdma_get_password ()

+
const char *
+nm_setting_cdma_get_password (NMSettingCdma *setting);
+
+

Parameters

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

setting

the NMSettingCdma

 
+
+
+

Returns

+

the “password” property of the setting

+

+
+
+
+
+

nm_setting_cdma_get_password_flags ()

+
NMSettingSecretFlags
+nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
+
+

Parameters

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

setting

the NMSettingCdma

 
+
+
+

Returns

+

the NMSettingSecretFlags pertaining to the “password”

+

+
+
+
+
+

Types and Values

NM_SETTING_CDMA_SETTING_NAME

#define NM_SETTING_CDMA_SETTING_NAME "cdma"
@@ -101,45 +324,50 @@ networks, including those using CDMA2000/EVDO technology.
-

enum NMSettingCdmaError

-
typedef enum {
-	NM_SETTING_CDMA_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_CDMA_ERROR_INVALID_PROPERTY,      /*< nick=InvalidProperty >*/
-	NM_SETTING_CDMA_ERROR_MISSING_PROPERTY,      /*< nick=MissingProperty >*/
-	NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING /*< nick=MissingSerialSetting >*/
-} NMSettingCdmaError;
-
-
+

enum NMSettingCdmaError

+
+

Members

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

NM_SETTING_CDMA_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_CDMA_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_CDMA_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_CDMA_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_CDMA_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_CDMA_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING

the required NMSettingSerial -is missing in the connection +

NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING

 +

the required NMSettingSerial +is missing in the connection

 
+

NM_SETTING_CDMA_ERROR

@@ -150,24 +378,6 @@ is missing in the connection
-

nm_setting_cdma_error_quark ()

-
GQuark              nm_setting_cdma_error_quark         (void);
-

-Registers an error quark for NMSettingCdma if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingCdma errors.
-
-
-

NM_SETTING_CDMA_NUMBER

#define NM_SETTING_CDMA_NUMBER         "number"
@@ -198,185 +408,45 @@ Registers an error quark for -

NMSettingCdma

-
typedef struct _NMSettingCdma NMSettingCdma;
-

-

-
-
-
-

NMSettingCdmaClass

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

-

-
-
-
-

nm_setting_cdma_new ()

-
NMSetting *         nm_setting_cdma_new                 (void);
-

-Creates a new NMSettingCdma object with default values. -

-
---- - - - - -

Returns :

the new empty NMSettingCdma object
-
-
-
-

nm_setting_cdma_get_number ()

-
const char *        nm_setting_cdma_get_number          (NMSettingCdma *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingCdma -

Returns :

the "number" property of the setting
-
-
-
-

nm_setting_cdma_get_username ()

-
const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingCdma -

Returns :

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

nm_setting_cdma_get_password ()

-
const char *        nm_setting_cdma_get_password        (NMSettingCdma *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingCdma -

Returns :

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

nm_setting_cdma_get_password_flags ()

-
NMSettingSecretFlags nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingCdma -

Returns :

the NMSettingSecretFlags pertaining to the "password" -
-

Property Details

-

The "number" property

-
  "number"                   gchar*                : Read / Write
-

-The number to dial to establish the connection to the CDMA-based mobile -broadband network, if any. If not specified, the default number (777) -is used when required. -

+

The “number” property

+
  “number”                   gchar *
+

Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required.

+

Flags: Read / Write

Default value: NULL

-

The "password" property

-
  "password"                 gchar*                : Read / Write
-

-The password used to authenticate with the network, if required. Many -providers do not require a password, or accept any password. But if a -password is required, it is specified here. -

+

The “password” property

+
  “password”                 gchar *
+

Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.

+

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 CDMA password.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "username" property

-
  "username"                 gchar*                : Read / Write
-

-The username used to authenticate with the network, if required. Many -providers do not require a username, or accept any username. But if a -username is required, it is specified here. -

+

The “username” property

+
  “username”                 gchar *
+

Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html index 95b82888..f212d48d 100644 --- a/docs/libnm-util/html/NMSettingConnection.html +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -2,34 +2,28 @@ -NMSettingConnection +libnm-util Reference Manual: NMSettingConnection - + - - - - - - - - - - + + + + + + +
@@ -37,1033 +31,1297 @@

NMSettingConnection

NMSettingConnection — Describes general connection properties

- +
-
-

Synopsis

-
-#include <nm-setting-connection.h>
-
-#define             NM_SETTING_CONNECTION_SETTING_NAME
-enum                NMSettingConnectionError;
-#define             NM_SETTING_CONNECTION_ERROR
-GQuark              nm_setting_connection_error_quark   (void);
-#define             NM_SETTING_CONNECTION_ID
-#define             NM_SETTING_CONNECTION_UUID
-#define             NM_SETTING_CONNECTION_TYPE
-#define             NM_SETTING_CONNECTION_AUTOCONNECT
-#define             NM_SETTING_CONNECTION_TIMESTAMP
-#define             NM_SETTING_CONNECTION_READ_ONLY
-#define             NM_SETTING_CONNECTION_PERMISSIONS
-#define             NM_SETTING_CONNECTION_ZONE
-#define             NM_SETTING_CONNECTION_MASTER
-#define             NM_SETTING_CONNECTION_SLAVE_TYPE
-#define             NM_SETTING_CONNECTION_SECONDARIES
-                    NMSettingConnection;
-                    NMSettingConnectionClass;
-NMSetting *         nm_setting_connection_new           (void);
-const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_connection_type
-                                                        (NMSettingConnection *setting);
-gboolean            nm_setting_connection_get_autoconnect
-                                                        (NMSettingConnection *setting);
-guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
-gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
-guint32             nm_setting_connection_get_num_permissions
-                                                        (NMSettingConnection *setting);
-gboolean            nm_setting_connection_get_permission
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx,
-                                                         const char **out_ptype,
-                                                         const char **out_pitem,
-                                                         const char **out_detail);
-const char *        nm_setting_connection_get_zone      (NMSettingConnection *setting);
-gboolean            nm_setting_connection_permissions_user_allowed
-                                                        (NMSettingConnection *setting,
-                                                         const char *uname);
-gboolean            nm_setting_connection_add_permission
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);
-void                nm_setting_connection_remove_permission
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx);
-const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);
-gboolean            nm_setting_connection_is_slave_type (NMSettingConnection *setting,
-                                                         const char *type);
-const char *        nm_setting_connection_get_slave_type
-                                                        (NMSettingConnection *setting);
-guint32             nm_setting_connection_get_num_secondaries
-                                                        (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
-                                                         guint32 idx);
-gboolean            nm_setting_connection_add_secondary (NMSettingConnection *setting,
-                                                         const char *sec_uuid);
-void                nm_setting_connection_remove_secondary
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingConnectionError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingConnection
-
-
-
-

Properties

-
-  "autoconnect"              gboolean              : Read / Write / Construct
-  "id"                       gchar*                : Read / Write
-  "master"                   gchar*                : Read / Write
-  "permissions"              GSList_gchararray_*   : Read / Write
-  "read-only"                gboolean              : Read / Write / Construct
-  "secondaries"              GSList_gchararray_*   : Read / Write
-  "slave-type"               gchar*                : Read / Write
-  "timestamp"                guint64               : Read / Write / Construct
-  "type"                     gchar*                : Read / Write
-  "uuid"                     gchar*                : Read / Write
-  "zone"                     gchar*                : Read / Write / Construct
-
-
-

Description

-

-The NMSettingConnection object is a NMSetting subclass that describes -properties that apply to all NMConnection objects, regardless of what type -of network connection they describe. Each NMConnection object must contain -a NMSettingConnection setting. -

-
-
-

Details

-
-

NM_SETTING_CONNECTION_SETTING_NAME

-
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
-
-

-

-
-
-
-

enum NMSettingConnectionError

-
typedef enum {
-	NM_SETTING_CONNECTION_ERROR_UNKNOWN = 0,            /*< nick=UnknownError >*/
-	NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY,       /*< nick=InvalidProperty >*/
-	NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY,       /*< nick=MissingProperty >*/
-	NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND, /*< nick=TypeSettingNotFound >*/
-	NM_SETTING_CONNECTION_ERROR_IP_CONFIG_NOT_ALLOWED,  /*< nick=IpConfigNotAllowed >*/
-} NMSettingConnectionError;
-
-

-Describes errors that may result from operations involving a -NMSettingConnection. -

-
+

Functions

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

NM_SETTING_CONNECTION_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_connection_error_quark () +
+NMSetting * + +nm_setting_connection_new ()

NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY

the property's value is - invalid +const char * + +nm_setting_connection_get_id ()

NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY

a required property is not - present +const char * + +nm_setting_connection_get_uuid ()

NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND

the NMSetting object - referenced by the setting name contained in the - "type" property was not present in the NMConnection +const char * + +nm_setting_connection_get_connection_type () +
+gboolean + +nm_setting_connection_get_autoconnect () +
+guint64 + +nm_setting_connection_get_timestamp () +
+gboolean + +nm_setting_connection_get_read_only () +
+guint32 + +nm_setting_connection_get_num_permissions ()

NM_SETTING_CONNECTION_ERROR_IP_CONFIG_NOT_ALLOWED

ip configuration is not - allowed to be present. + +gboolean + +nm_setting_connection_get_permission () +
const char * + +nm_setting_connection_get_zone () +
+gboolean + +nm_setting_connection_permissions_user_allowed () +
+gboolean + +nm_setting_connection_add_permission () +
+void + +nm_setting_connection_remove_permission () +
const char * + +nm_setting_connection_get_master () +
+gboolean + +nm_setting_connection_is_slave_type () +
const char * + +nm_setting_connection_get_slave_type () +
+guint32 + +nm_setting_connection_get_num_secondaries () +
const char * + +nm_setting_connection_get_secondary () +
+gboolean + +nm_setting_connection_add_secondary () +
+void + +nm_setting_connection_remove_secondary ()
-
-
-

NM_SETTING_CONNECTION_ERROR

-
#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark ()
-
-

-

-
-
-
-

nm_setting_connection_error_quark ()

-
GQuark              nm_setting_connection_error_quark   (void);
-

-Registers an error quark for NMSettingConnection if necessary. -

-
+
+

Properties

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

Returns :

the error quark used for NMSettingConnection errors.
gbooleanautoconnectRead / Write / Construct
+gchar *idRead / Write
+gchar *masterRead / Write
+GSList_gchararray_ *permissionsRead / Write
gbooleanread-onlyRead / Write / Construct
+GSList_gchararray_ *secondariesRead / Write
+gchar *slave-typeRead / Write
guint64timestampRead / Write / Construct
+gchar *typeRead / Write
+gchar *uuidRead / Write
+gchar *zoneRead / Write / Construct
-
-
-

NM_SETTING_CONNECTION_ID

-
#define NM_SETTING_CONNECTION_ID          "id"
-
-

-

-
-
-
-

NM_SETTING_CONNECTION_UUID

-
#define NM_SETTING_CONNECTION_UUID        "uuid"
-
-

-

-
-
-
-

NM_SETTING_CONNECTION_TYPE

-
#define NM_SETTING_CONNECTION_TYPE        "type"
-
-

-

-
-
-
-

NM_SETTING_CONNECTION_AUTOCONNECT

-
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect"
-
-

-

-
-
-
-

NM_SETTING_CONNECTION_TIMESTAMP

-
#define NM_SETTING_CONNECTION_TIMESTAMP   "timestamp"
-
-

-

-
-
-
-

NM_SETTING_CONNECTION_READ_ONLY

-
#define NM_SETTING_CONNECTION_READ_ONLY   "read-only"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_CONNECTION_SETTING_NAME
enumNMSettingConnectionError
#defineNM_SETTING_CONNECTION_ERROR
#defineNM_SETTING_CONNECTION_ID
#defineNM_SETTING_CONNECTION_UUID
#defineNM_SETTING_CONNECTION_TYPE
#defineNM_SETTING_CONNECTION_AUTOCONNECT
#defineNM_SETTING_CONNECTION_TIMESTAMP
#defineNM_SETTING_CONNECTION_READ_ONLY
#defineNM_SETTING_CONNECTION_PERMISSIONS
#defineNM_SETTING_CONNECTION_ZONE
#defineNM_SETTING_CONNECTION_MASTER
#defineNM_SETTING_CONNECTION_SLAVE_TYPE
#defineNM_SETTING_CONNECTION_SECONDARIES
 NMSettingConnection
-
-
-

NM_SETTING_CONNECTION_PERMISSIONS

-
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingConnectionError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingConnection
 

-

-

 

-

-

-
NM_SETTING_CONNECTION_ZONE

-
#define NM_SETTING_CONNECTION_ZONE        "zone"
+

+
Includes

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

-

-

 

-

-

-
NM_SETTING_CONNECTION_MASTER

-
#define NM_SETTING_CONNECTION_MASTER      "master"
-

-

-

+

+
Description

+
The NMSettingConnection object is a NMSetting subclass that describes
+properties that apply to all NMConnection objects, regardless of what type
+of network connection they describe.  Each NMConnection object must contain
+a NMSettingConnection setting.

 

-

+

+
Functions

 

-
NM_SETTING_CONNECTION_SLAVE_TYPE

-
#define NM_SETTING_CONNECTION_SLAVE_TYPE  "slave-type"
-

-

-

+
nm_setting_connection_error_quark ()

+
GQuark
+nm_setting_connection_error_quark (void);

+
Registers an error quark for NMSettingConnection if necessary.

+

+
Returns

+
 the error quark used for NMSettingConnection errors.

+

 

-

-

-
NM_SETTING_CONNECTION_SECONDARIES

-
#define NM_SETTING_CONNECTION_SECONDARIES "secondaries"
-

-

-

 

 

 

-
NMSettingConnection

-
typedef struct _NMSettingConnection NMSettingConnection;

-

-The NMSettingConnection struct contains only private data.
-It should only be accessed through the functions described below.
-

+
nm_setting_connection_new ()

+
NMSetting *
+nm_setting_connection_new (void);

+
Creates a new NMSettingConnection object with default values.

+

+
Returns

+
 the new empty NMSettingConnection object

+

 

-

-

-
NMSettingConnectionClass

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

-

-

 

 

 

-
nm_setting_connection_new ()

-
NMSetting *         nm_setting_connection_new           (void);

-

-Creates a new NMSettingConnection object with default values.
-

-

+
nm_setting_connection_get_id ()

+
const char *
+nm_setting_connection_get_id (NMSettingConnection *setting);

+
Returns the “id” property of the connection.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingConnection object
setting
the NMSettingConnection
 
 

 

 

-

-

-
nm_setting_connection_get_id ()

-
const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);

-

-Returns the "id" property of the connection.
-

-

----
-
-
-
-
-
-
-
-
-
-
-




setting :
the NMSettingConnection
-
Returns :
the connection ID

+

+
Returns

+
 the connection ID

+

+

 

 

 

-
nm_setting_connection_get_uuid ()

-
const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);

-

-Returns the "uuid" property of the connection.
-

-

+
nm_setting_connection_get_uuid ()

+
const char *
+nm_setting_connection_get_uuid (NMSettingConnection *setting);

+
Returns the “uuid” property of the connection.

+

+
Parameters

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

 





 
setting :
the NMSettingConnection
-
Returns :
the connection UUID
setting
the NMSettingConnection
 

 

 

+

+
Returns

+
 the connection UUID

+

+

+

 

 

-
nm_setting_connection_get_connection_type ()

-
const char *        nm_setting_connection_get_connection_type
-                                                        (NMSettingConnection *setting);

-

-Returns the "type" property of the connection.
-

-

+
nm_setting_connection_get_connection_type ()

+
const char *
+nm_setting_connection_get_connection_type
+                               (NMSettingConnection *setting);

+
Returns the “type” property of the connection.

+

+
Parameters

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

 





 
setting :
the NMSettingConnection
-
Returns :
the connection type
setting
the NMSettingConnection
 

 

 

+

+
Returns

+
 the connection type

+

+

+

 

 

-
nm_setting_connection_get_autoconnect ()

-
gboolean            nm_setting_connection_get_autoconnect
-                                                        (NMSettingConnection *setting);

-

-Returns the "autoconnect" property of the connection.
-

-

+
nm_setting_connection_get_autoconnect ()

+
gboolean
+nm_setting_connection_get_autoconnect (NMSettingConnection *setting);

+
Returns the “autoconnect” property of the connection.

+

+
Parameters

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

 





 
setting :
the NMSettingConnection
-
Returns :
the connection's autoconnect behavior
setting
the NMSettingConnection
 

 

 

+

+
Returns

+
 the connection's autoconnect behavior

+

+

+

 

 

-
nm_setting_connection_get_timestamp ()

-
guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);

-

-Returns the "timestamp" property of the connection.
-

-

+
nm_setting_connection_get_timestamp ()

+
guint64
+nm_setting_connection_get_timestamp (NMSettingConnection *setting);

+
Returns the “timestamp” property of the connection.

+

+
Parameters

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

 





 
setting :
the NMSettingConnection
-
Returns :
the connection's timestamp
setting
the NMSettingConnection
 

 

 

+

+
Returns

+
 the connection's timestamp

+

+

+

 

 

-
nm_setting_connection_get_read_only ()

-
gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);

-

-Returns the "read-only" property of the connection.
-

-

+
nm_setting_connection_get_read_only ()

+
gboolean
+nm_setting_connection_get_read_only (NMSettingConnection *setting);

+
Returns the “read-only” property of the connection.

+

+
Parameters

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

 





 
setting :
the NMSettingConnection
-
Returns :

-TRUE if the connection is read-only, FALSE if it is not
setting
the NMSettingConnection
 

 

 

+

+
Returns

+
 TRUE if the connection is read-only, FALSE if it is not

+

+

+

 

 

-
nm_setting_connection_get_num_permissions ()

-
guint32             nm_setting_connection_get_num_permissions
-                                                        (NMSettingConnection *setting);

-

-Returns the number of entires in the "permissions"
-property of this setting.
-

-

+
nm_setting_connection_get_num_permissions ()

+
guint32
+nm_setting_connection_get_num_permissions
+                               (NMSettingConnection *setting);

+
Returns the number of entires in the “permissions”
+property of this setting.

+

+
Parameters

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

 





 
setting :
the NMSettingConnection
-
Returns :
the number of permissions entires
setting
the NMSettingConnection
 

 

 

+

+
Returns

+
 the number of permissions entires

+

+

+
-

nm_setting_connection_get_permission ()

-
gboolean            nm_setting_connection_get_permission
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx,
-                                                         const char **out_ptype,
-                                                         const char **out_pitem,
-                                                         const char **out_detail);
-

-Retrieve one of the entries of the "permissions" property -of this setting. -

-
+

nm_setting_connection_get_permission ()

+
gboolean
+nm_setting_connection_get_permission (NMSettingConnection *setting,
+                                      guint32 idx,
+                                      const char **out_ptype,
+                                      const char **out_pitem,
+                                      const char **out_detail);
+

Retrieve one of the entries of the “permissions” property +of this setting.

+
+

Parameters

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

setting :

the NMSettingConnection -

idx :

the zero-based index of the permissions entry

setting

the NMSettingConnection

 

out_ptype :

on return, the permission type (at this time, always "user")

idx

the zero-based index of the permissions entry

 

out_pitem :

on return, the permission item (formatted accoring to ptype, see -"permissions" for more detail

out_ptype

on return, the permission type (at this time, always "user")

 

out_detail :

on return, the permission detail (at this time, always NULL)

out_pitem

on return, the permission item (formatted accoring to ptype +, see +“permissions” for more detail

 

Returns :

 -TRUE if a permission was returned, FALSE if idx was invalid

out_detail

on return, the permission detail (at this time, always NULL)

 
+
+

Returns

+

TRUE if a permission was returned, FALSE if idx +was invalid

+

+
+
-

nm_setting_connection_get_zone ()

-
const char *        nm_setting_connection_get_zone      (NMSettingConnection *setting);
-

-Returns the "zone" property of the connection. -

-
+

nm_setting_connection_get_zone ()

+
const char *
+nm_setting_connection_get_zone (NMSettingConnection *setting);
+

Returns the “zone” property of the connection.

+
+

Parameters

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

setting :

the NMSettingConnection -

Returns :

the trust level of a connection

setting

the NMSettingConnection

 
+
+

Returns

+

the trust level of a connection

+

+
+
-

nm_setting_connection_permissions_user_allowed ()

-
gboolean            nm_setting_connection_permissions_user_allowed
-                                                        (NMSettingConnection *setting,
-                                                         const char *uname);
-

-Checks whether the given username is allowed to view/access this connection. -

-
+

nm_setting_connection_permissions_user_allowed ()

+
gboolean
+nm_setting_connection_permissions_user_allowed
+                               (NMSettingConnection *setting,
+                                const char *uname);
+

Checks whether the given username is allowed to view/access this connection.

+
+

Parameters

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

setting :

the NMSettingConnection -

uname :

the user name to check permissions for

setting

the NMSettingConnection

 

Returns :

 -TRUE if the requested user is allowed to view this connection, -FALSE if the given user is not allowed to view this connection

uname

the user name to check permissions for

 
+
+

Returns

+

TRUE if the requested user is allowed to view this connection, +FALSE if the given user is not allowed to view this connection

+

+
+
-

nm_setting_connection_add_permission ()

-
gboolean            nm_setting_connection_add_permission
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);
-

-Adds a permission to the connection's permission list. At this time, only -the "user" permission type is supported, and pitem must be a username. See -"permissions": for more details. -

-
+

nm_setting_connection_add_permission ()

+
gboolean
+nm_setting_connection_add_permission (NMSettingConnection *setting,
+                                      const char *ptype,
+                                      const char *pitem,
+                                      const char *detail);
+

Adds a permission to the connection's permission list. At this time, only +the "user" permission type is supported, and pitem + must be a username. See +“permissions”: for more details.

+
+

Parameters

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

setting :

the NMSettingConnection -

ptype :

the permission type; at this time only "user" is supported

setting

the NMSettingConnection

 

pitem :

the permission item formatted as required for ptype -

ptype

the permission type; at this time only "user" is supported

 

detail :

unused at this time; must be NULL. [allow-none] -

pitem

the permission item formatted as required for ptype +

 

Returns :

TRUE if the permission was unique and was successfully added to the -list, FALSE if ptype or pitem was invalid or it the permission was already -present in the list

detail

unused at this time; must be NULL.

[allow-none]
+
+

Returns

+

TRUE if the permission was unique and was successfully added to the +list, FALSE if ptype +or pitem +was invalid or it the permission was already +present in the list

+

+
+
-

nm_setting_connection_remove_permission ()

-
void                nm_setting_connection_remove_permission
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx);
-

-Removes the permission at index idx from the connection. -

-
+

nm_setting_connection_remove_permission ()

+
void
+nm_setting_connection_remove_permission
+                               (NMSettingConnection *setting,
+                                guint32 idx);
+

Removes the permission at index idx + from the connection.

+
+

Parameters

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

setting :

the NMSettingConnection -

setting

the NMSettingConnection

 

idx :

the zero-based index of the permission to remove

idx

the zero-based index of the permission to remove

 
+
-

nm_setting_connection_get_master ()

-
const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);
-

-Returns the "master" property of the connection. -

-
+

nm_setting_connection_get_master ()

+
const char *
+nm_setting_connection_get_master (NMSettingConnection *setting);
+

Returns the “master” property of the connection.

+
+

Parameters

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

setting :

the NMSettingConnection -

Returns :

interface name of the master device or UUID of the master -connection.

setting

the NMSettingConnection

 
+
+

Returns

+

interface name of the master device or UUID of the master +connection.

+

+
+
-

nm_setting_connection_is_slave_type ()

-
gboolean            nm_setting_connection_is_slave_type (NMSettingConnection *setting,
-                                                         const char *type);
-
+

nm_setting_connection_is_slave_type ()

+
gboolean
+nm_setting_connection_is_slave_type (NMSettingConnection *setting,
+                                     const char *type);
+
+

Parameters

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

setting :

the NMSettingConnection -

type :

the setting name (ie NM_SETTING_BOND_SETTING_NAME) to be matched -against setting's slave type

setting

the NMSettingConnection

 

Returns :

TRUE if connection is of the given slave type -

type

the setting name (ie NM_SETTING_BOND_SETTING_NAME) to be matched +against setting +'s slave type

 
+
+

Returns

+

TRUE if connection is of the given slave type +

+

+
+
-

nm_setting_connection_get_slave_type ()

-
const char *        nm_setting_connection_get_slave_type
-                                                        (NMSettingConnection *setting);
-

-Returns the "slave-type" property of the connection. -

-
+

nm_setting_connection_get_slave_type ()

+
const char *
+nm_setting_connection_get_slave_type (NMSettingConnection *setting);
+

Returns the “slave-type” property of the connection.

+
+

Parameters

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

setting :

the NMSettingConnection -

Returns :

the type of slave this connection is, if any

setting

the NMSettingConnection

 
+
+
+

Returns

+

the type of slave this connection is, if any

+

+
+ +
+
+

nm_setting_connection_get_num_secondaries ()

+
guint32
+nm_setting_connection_get_num_secondaries
+                               (NMSettingConnection *setting);
+
+

Parameters

+
+++++ + + + + +

setting

the NMSettingConnection

 
+
+

Returns

+

the number of configured secondary connection UUIDs

+

+
+

Since 0.9.8

+
-

nm_setting_connection_get_num_secondaries ()

-
guint32             nm_setting_connection_get_num_secondaries
-                                                        (NMSettingConnection *setting);
-
+

nm_setting_connection_get_secondary ()

+
const char *
+nm_setting_connection_get_secondary (NMSettingConnection *setting,
+                                     guint32 idx);
+
+

Parameters

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

setting :

the NMSettingConnection -

setting

the NMSettingConnection

 

Returns :

the number of configured secondary connection UUIDs

idx

the zero-based index of the secondary connection UUID entry

 
+
+
+

Returns

+

the secondary connection UUID at index idx +

+

+

Since 0.9.8

-

nm_setting_connection_get_secondary ()

-
const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
-                                                         guint32 idx);
-
+

nm_setting_connection_add_secondary ()

+
gboolean
+nm_setting_connection_add_secondary (NMSettingConnection *setting,
+                                     const char *sec_uuid);
+

Adds a new secondary connetion UUID to the setting.

+
+

Parameters

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

setting :

the NMSettingConnection -

idx :

the zero-based index of the secondary connection UUID entry

setting

the NMSettingConnection

 

Returns :

the secondary connection UUID at index idx -

sec_uuid

the secondary connection UUID to add

 
+
+
+

Returns

+

TRUE if the secondary connection UUID was added; FALSE if the UUID +was already present

+

+

Since 0.9.8

-

nm_setting_connection_add_secondary ()

-
gboolean            nm_setting_connection_add_secondary (NMSettingConnection *setting,
-                                                         const char *sec_uuid);
-

-Adds a new secondary connetion UUID to the setting. -

-
+

nm_setting_connection_remove_secondary ()

+
void
+nm_setting_connection_remove_secondary
+                               (NMSettingConnection *setting,
+                                guint32 idx);
+

Removes the secondary coonnection UUID at index idx +.

+
+

Parameters

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

setting :

the NMSettingConnection -

sec_uuid :

the secondary connection UUID to add

setting

the NMSettingConnection

 

Returns :

 -TRUE if the secondary connection UUID was added; FALSE if the UUID -was already present

idx

index number of the secondary connection UUID

 
+

Since 0.9.8

-
+ +
+

Types and Values

-

nm_setting_connection_remove_secondary ()

-
void                nm_setting_connection_remove_secondary
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx);
+

NM_SETTING_CONNECTION_SETTING_NAME

+
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
+

-Removes the secondary coonnection UUID at index idx.

-
+ +
+
+

enum NMSettingConnectionError

+

Describes errors that may result from operations involving a +NMSettingConnection.

+
+

Members

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

setting :

the NMSettingConnection +

NM_SETTING_CONNECTION_ERROR_UNKNOWN

 +

unknown or unclassified error

+		 

NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY

 +

the property's value is + invalid

+		 

NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY

 +

a required property is not + present

+		 

NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND

 +

the NMSetting object + referenced by the setting name contained in the + “type” property was not present in the NMConnection

 

idx :

index number of the secondary connection UUID

NM_SETTING_CONNECTION_ERROR_IP_CONFIG_NOT_ALLOWED

 +

ip configuration is not + allowed to be present.

+		 
-

Since 0.9.8

-
-

Property Details

+
-

The "autoconnect" property

-
  "autoconnect"              gboolean              : Read / Write / Construct
+

NM_SETTING_CONNECTION_ERROR

+
#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark ()
+

-Whether or not the connection should be automatically connected by -NetworkManager when the resources for the connection are available. -TRUE to automatically activate the connection, FALSE to require manual -intervention to activate the connection. Defaults to TRUE.

-

Default value: TRUE

-

The "id" property

-
  "id"                       gchar*                : Read / Write
+

NM_SETTING_CONNECTION_ID

+
#define NM_SETTING_CONNECTION_ID          "id"
+

-A human readable unique idenfier for the connection, like "Work WiFi" or -"T-Mobile 3G".

-

Default value: NULL

-

The "master" property

-
  "master"                   gchar*                : Read / Write
+

NM_SETTING_CONNECTION_UUID

+
#define NM_SETTING_CONNECTION_UUID        "uuid"
+

-Interface name of the master device or UUID of the master connection.

-

Default value: NULL

-

The "permissions" property

-
  "permissions"              GSList_gchararray_*   : Read / Write
+

NM_SETTING_CONNECTION_TYPE

+
#define NM_SETTING_CONNECTION_TYPE        "type"
+

-An array of strings defining what access a given user has to this -connection. If this is NULL or empty, all users are allowed to access -this connection. Otherwise a user is allowed to access this connection -if and only if they are in this list. Each entry is of the form -"[type]:[id]:[reserved]", for example:

+
+
+
+

NM_SETTING_CONNECTION_AUTOCONNECT

+
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect"
+

- user:dcbw:blah

+
+
+
+

NM_SETTING_CONNECTION_TIMESTAMP

+
#define NM_SETTING_CONNECTION_TIMESTAMP   "timestamp"
+

-At this time only the 'user' [type] is allowed. Any other values are -ignored and reserved for future use. [id] is the username that this -permission refers to, which may not contain the ':' character. Any -[reserved] information present must be ignored and is reserved for -future use. All of [type], [id], and [reserved] must be valid UTF-8.

-

The "read-only" property

-
  "read-only"                gboolean              : Read / Write / Construct
+

NM_SETTING_CONNECTION_READ_ONLY

+
#define NM_SETTING_CONNECTION_READ_ONLY   "read-only"
+

-TRUE if the connection can be modified using the providing settings -service's D-Bus interface with the right privileges, or FALSE -if the connection is read-only and cannot be modified.

-

Default value: FALSE

-

The "secondaries" property

-
  "secondaries"              GSList_gchararray_*   : Read / Write
+

NM_SETTING_CONNECTION_PERMISSIONS

+
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"
+

-List of connection UUIDs that should be activated when the base connection -itself is activated.

-

Since 0.9.8

-

The "slave-type" property

-
  "slave-type"               gchar*                : Read / Write
+

NM_SETTING_CONNECTION_ZONE

+
#define NM_SETTING_CONNECTION_ZONE        "zone"
+

-Setting name describing the type of slave device (ie -NM_SETTING_BOND_SETTING_NAME) or NULL if this connection is not a slave.

-

Default value: NULL

-

The "timestamp" property

-
  "timestamp"                guint64               : Read / Write / Construct
+

NM_SETTING_CONNECTION_MASTER

+
#define NM_SETTING_CONNECTION_MASTER      "master"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_SLAVE_TYPE

+
#define NM_SETTING_CONNECTION_SLAVE_TYPE  "slave-type"
+

-The time, in seconds since the Unix Epoch, that the connection was last -_successfully_ fully activated.

-

Default value: 0

-

The "type" property

-
  "type"                     gchar*                : Read / Write
+

NM_SETTING_CONNECTION_SECONDARIES

+
#define NM_SETTING_CONNECTION_SECONDARIES "secondaries"
+

-The general hardware type of the device used for the network connection, +

+
+
+
+

NMSettingConnection

+
typedef struct _NMSettingConnection NMSettingConnection;
+

The NMSettingConnection struct contains only private data. +It should only be accessed through the functions described below.

+
+
+
+

Property Details

+
+

The “autoconnect” property

+
  “autoconnect”              gboolean
+

Whether or not the connection should be automatically connected by +NetworkManager when the resources for the connection are available. +TRUE to automatically activate the connection, FALSE to require manual +intervention to activate the connection. Defaults to TRUE.

+

Flags: Read / Write / Construct

+

Default value: TRUE

+
+
+
+

The “id” property

+
  “id”                       gchar *
+

A human readable unique idenfier for the connection, like "Work WiFi" or +"T-Mobile 3G".

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “master” property

+
  “master”                   gchar *
+

Interface name of the master device or UUID of the master connection.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “permissions” property

+
  “permissions”              GSList_gchararray_ *
+

An array of strings defining what access a given user has to this +connection. If this is NULL or empty, all users are allowed to access +this connection. Otherwise a user is allowed to access this connection +if and only if they are in this list. Each entry is of the form +"[type]:[id]:[reserved]", for example:

+

user:dcbw:blah

+

At this time only the 'user' [type] is allowed. Any other values are +ignored and reserved for future use. [id] is the username that this +permission refers to, which may not contain the ':' character. Any +[reserved] information present must be ignored and is reserved for +future use. All of [type], [id], and [reserved] must be valid UTF-8.

+

Flags: Read / Write

+
+
+
+

The “read-only” property

+
  “read-only”                gboolean
+

TRUE if the connection can be modified using the providing settings +service's D-Bus interface with the right privileges, or FALSE +if the connection is read-only and cannot be modified.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “secondaries” property

+
  “secondaries”              GSList_gchararray_ *
+

List of connection UUIDs that should be activated when the base connection +itself is activated.

+

Flags: Read / Write

+

Since 0.9.8

+
+
+
+

The “slave-type” property

+
  “slave-type”               gchar *
+

Setting name describing the type of slave device (ie +NM_SETTING_BOND_SETTING_NAME) or NULL if this connection is not a slave.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “timestamp” property

+
  “timestamp”                guint64
+

The time, in seconds since the Unix Epoch, that the connection was last +_successfully_ fully activated.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “type” property

+
  “type”                     gchar *
+

The general hardware type of the device used for the network connection, contains the name of the NMSetting object that describes that hardware type's parameters. For example, for WiFi devices, the name of the -NMSettingWireless setting. -

+NMSettingWireless setting.

+

Flags: Read / Write

Default value: NULL

-

The "uuid" property

-
  "uuid"                     gchar*                : Read / Write
-

-A universally unique idenfier for the connection, for example generated +

The “uuid” property

+
  “uuid”                     gchar *
+

A universally unique idenfier for the connection, for example generated with libuuid. Should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, should not be changed when the -"id" or NMSettingIP4Config changes, but might need +“id” or NMSettingIP4Config changes, but might need to be re-created when the WiFi SSID, mobile broadband network provider, -or "type" changes. -

-

-The UUID must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' +or “type” changes.

+

The UUID must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). A suitable UUID may -be generated by nm_utils_uuid_generate() or -nm_utils_uuid_generate_from_string(). -

+be generated by nm_utils_uuid_generate() or +nm_utils_uuid_generate_from_string().

+

Flags: Read / Write

Default value: NULL

-

The "zone" property

-
  "zone"                     gchar*                : Read / Write / Construct
-

-The trust level of a the connection. +

The “zone” property

+
  “zone”                     gchar *
+

The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the -default zone as defined by the firewall. -

+default zone as defined by the firewall.

+

Flags: Read / Write / Construct

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingGsm.html b/docs/libnm-util/html/NMSettingGsm.html index 653911bb..6501d29a 100644 --- a/docs/libnm-util/html/NMSettingGsm.html +++ b/docs/libnm-util/html/NMSettingGsm.html @@ -2,34 +2,28 @@ -NMSettingGsm +libnm-util Reference Manual: NMSettingGsm - + - - - - - - - - - - + + + + + + +
@@ -37,92 +31,601 @@

NMSettingGsm

NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties

- +
-
-

Synopsis

-
-#include <nm-setting-gsm.h>
-
-#define             NM_SETTING_GSM_SETTING_NAME
-enum                NMSettingGsmError;
-#define             NM_SETTING_GSM_ERROR
-GQuark              nm_setting_gsm_error_quark          (void);
-#define             NM_SETTING_GSM_NUMBER
-#define             NM_SETTING_GSM_USERNAME
-#define             NM_SETTING_GSM_PASSWORD
-#define             NM_SETTING_GSM_PASSWORD_FLAGS
-#define             NM_SETTING_GSM_APN
-#define             NM_SETTING_GSM_NETWORK_ID
-#define             NM_SETTING_GSM_NETWORK_TYPE
-#define             NM_SETTING_GSM_ALLOWED_BANDS
-#define             NM_SETTING_GSM_PIN
-#define             NM_SETTING_GSM_PIN_FLAGS
-#define             NM_SETTING_GSM_HOME_ONLY
-enum                NMSettingGsmNetworkType;
-enum                NMSettingGsmNetworkBand;
-                    NMSettingGsm;
-                    NMSettingGsmClass;
-NMSetting *         nm_setting_gsm_new                  (void);
-const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
-int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
-gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
-NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_gsm_error_quark () +
+NMSetting * + +nm_setting_gsm_new () +
const char * + +nm_setting_gsm_get_number () +
const char * + +nm_setting_gsm_get_username () +
const char * + +nm_setting_gsm_get_password () +
const char * + +nm_setting_gsm_get_apn () +
const char * + +nm_setting_gsm_get_network_id () +
+int + +nm_setting_gsm_get_network_type () +
+guint32 + +nm_setting_gsm_get_allowed_bands () +
const char * + +nm_setting_gsm_get_pin () +
+gboolean + +nm_setting_gsm_get_home_only () +
+NMSettingSecretFlags + +nm_setting_gsm_get_pin_flags () +
+NMSettingSecretFlags + +nm_setting_gsm_get_password_flags () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
guintallowed-bandsRead / Write / Construct
+gchar *apnRead / Write
gbooleanhome-onlyRead / Write
+gchar *network-idRead / Write
gintnetwork-typeRead / Write / Construct
+gchar *numberRead / Write
+gchar *passwordRead / Write
guintpassword-flagsRead / Write
+gchar *pinRead / Write
guintpin-flagsRead / Write
+gchar *usernameRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_GSM_SETTING_NAME
enumNMSettingGsmError
#defineNM_SETTING_GSM_ERROR
#defineNM_SETTING_GSM_NUMBER
#defineNM_SETTING_GSM_USERNAME
#defineNM_SETTING_GSM_PASSWORD
#defineNM_SETTING_GSM_PASSWORD_FLAGS
#defineNM_SETTING_GSM_APN
#defineNM_SETTING_GSM_NETWORK_ID
#defineNM_SETTING_GSM_NETWORK_TYPE
#defineNM_SETTING_GSM_ALLOWED_BANDS
#defineNM_SETTING_GSM_PIN
#defineNM_SETTING_GSM_PIN_FLAGS
#defineNM_SETTING_GSM_HOME_ONLY
enumNMSettingGsmNetworkType
enumNMSettingGsmNetworkBand

Object Hierarchy

-
-  GEnum
-   +----NMSettingGsmError
-
-
-  GEnum
-   +----NMSettingGsmNetworkType
-
-
-  GEnum
-   +----NMSettingGsmNetworkBand
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingGsm
+
    GEnum
+    ├── NMSettingGsmError
+    ├── NMSettingGsmNetworkBand
+    ╰── NMSettingGsmNetworkType
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingGsm
-

Properties

-
-  "allowed-bands"            guint                 : Read / Write / Construct
-  "apn"                      gchar*                : Read / Write
-  "home-only"                gboolean              : Read / Write
-  "network-id"               gchar*                : Read / Write
-  "network-type"             gint                  : Read / Write / Construct
-  "number"                   gchar*                : Read / Write
-  "password"                 gchar*                : Read / Write
-  "password-flags"           guint                 : Read / Write
-  "pin"                      gchar*                : Read / Write
-  "pin-flags"                guint                 : Read / Write
-  "username"                 gchar*                : Read / Write
+
Includes

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

Description

-

-The NMSettingGsm object is a NMSetting subclass that describes +

The NMSettingGsm object is a NMSetting subclass that describes properties that allow connections to 3GPP-based mobile broadband -networks, including those using GPRS/EDGE and UMTS/HSPA technology. -

+networks, including those using GPRS/EDGE and UMTS/HSPA technology.

+
+
+

Functions

+
+

nm_setting_gsm_error_quark ()

+
GQuark
+nm_setting_gsm_error_quark (void);
+

Registers an error quark for NMSettingGsm if necessary.

+
+

Returns

+

the error quark used for NMSettingGsm errors.

+

+
+
+
+
+

nm_setting_gsm_new ()

+
NMSetting *
+nm_setting_gsm_new (void);
+

Creates a new NMSettingGsm object with default values.

+
+

Returns

+

the new empty NMSettingGsm object

+

+
+
+
+
+

nm_setting_gsm_get_number ()

+
const char *
+nm_setting_gsm_get_number (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “number” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_username ()

+
const char *
+nm_setting_gsm_get_username (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “username” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_password ()

+
const char *
+nm_setting_gsm_get_password (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “password” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_apn ()

+
const char *
+nm_setting_gsm_get_apn (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “apn” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_network_id ()

+
const char *
+nm_setting_gsm_get_network_id (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “network-id” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_network_type ()

+
int
+nm_setting_gsm_get_network_type (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “network-type” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_allowed_bands ()

+
guint32
+nm_setting_gsm_get_allowed_bands (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “allowed-bands” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_pin ()

+
const char *
+nm_setting_gsm_get_pin (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “pin” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_home_only ()

+
gboolean
+nm_setting_gsm_get_home_only (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the “home-only” property of the setting

+

+
+
+
+
+

nm_setting_gsm_get_pin_flags ()

+
NMSettingSecretFlags
+nm_setting_gsm_get_pin_flags (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the NMSettingSecretFlags pertaining to the “pin”

+

+
+
+
+
+

nm_setting_gsm_get_password_flags ()

+
NMSettingSecretFlags
+nm_setting_gsm_get_password_flags (NMSettingGsm *setting);
+
+

Parameters

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

setting

the NMSettingGsm

 
+
+
+

Returns

+

the NMSettingSecretFlags pertaining to the “password”

+

+
+
-

Details

+

Types and Values

NM_SETTING_GSM_SETTING_NAME

#define NM_SETTING_GSM_SETTING_NAME "gsm"
@@ -132,45 +635,50 @@ networks, including those using GPRS/EDGE and UMTS/HSPA technology.
-

enum NMSettingGsmError

-
typedef enum {
-	NM_SETTING_GSM_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_GSM_ERROR_INVALID_PROPERTY,      /*< nick=InvalidProperty >*/
-	NM_SETTING_GSM_ERROR_MISSING_PROPERTY,      /*< nick=MissingProperty >*/
-	NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING /*< nick=MissingSerialSetting >*/
-} NMSettingGsmError;
-
-
+

enum NMSettingGsmError

+
+

Members

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

NM_SETTING_GSM_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_GSM_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_GSM_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_GSM_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_GSM_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_GSM_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING

the required NMSettingSerial -is missing in the connection +

NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING

 +

the required NMSettingSerial +is missing in the connection

 
+

NM_SETTING_GSM_ERROR

@@ -181,24 +689,6 @@ is missing in the connection
-

nm_setting_gsm_error_quark ()

-
GQuark              nm_setting_gsm_error_quark          (void);
-

-Registers an error quark for NMSettingGsm if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingGsm errors.
-
-
-

NM_SETTING_GSM_NUMBER

#define NM_SETTING_GSM_NUMBER         "number"
@@ -287,599 +777,298 @@ Registers an error quark for -

enum NMSettingGsmNetworkType

-
typedef enum {
-	NM_SETTING_GSM_NETWORK_TYPE_ANY = -1,
-	NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA = 0,
-	NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE = 1,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA = 2,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE = 3,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G = 4,
-	NM_SETTING_GSM_NETWORK_TYPE_4G = 5
-} NMSettingGsmNetworkType;
-
-

-NMSettingGsmNetworkType values indicate the allowed access technologies -the device may use when connecting to this network. -

-
+

enum NMSettingGsmNetworkType

+

NMSettingGsmNetworkType values indicate the allowed access technologies +the device may use when connecting to this network.

+
+

Members

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

NM_SETTING_GSM_NETWORK_TYPE_ANY

any access technology may be used +

NM_SETTING_GSM_NETWORK_TYPE_ANY

 +

any access technology may be used

 

NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA

only 3G-type (UMTS and HSPA) -technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA

 +

only 3G-type (UMTS and HSPA) +technologies may be used

 

NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE

only 2G-type (GPRS and EDGE) -technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE

 +

only 2G-type (GPRS and EDGE) +technologies may be used

 

NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA

3G-type technologies are -preferred but 2G-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA

 +

3G-type technologies are +preferred but 2G-type technologies may be used as a fallback

 

NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE

2G-type technologies are -preferred but 3G-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE

 +

2G-type technologies are +preferred but 3G-type technologies may be used as a fallback

 

NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G

4G/LTE-type technologies are -preferred but 3G/2/-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G

 +

4G/LTE-type technologies are +preferred but 3G/2/-type technologies may be used as a fallback

 

NM_SETTING_GSM_NETWORK_TYPE_4G

only 4G/LTE type -technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_4G

 +

only 4G/LTE type +technologies may be used

 
+
-

enum NMSettingGsmNetworkBand

-
typedef enum {
-	NM_SETTING_GSM_BAND_UNKNOWN      = 0x00000000,
-	NM_SETTING_GSM_BAND_ANY          = 0x00000001,
-	NM_SETTING_GSM_BAND_EGSM         = 0x00000002, /*  900 MHz */
-	NM_SETTING_GSM_BAND_DCS          = 0x00000004, /* 1800 MHz */
-	NM_SETTING_GSM_BAND_PCS          = 0x00000008, /* 1900 MHz */
-	NM_SETTING_GSM_BAND_G850         = 0x00000010, /*  850 MHz */
-	NM_SETTING_GSM_BAND_U2100        = 0x00000020, /* WCDMA 3GPP UMTS 2100 MHz     (Class I) */
-	NM_SETTING_GSM_BAND_U1800        = 0x00000040, /* WCDMA 3GPP UMTS 1800 MHz     (Class III) */
-	NM_SETTING_GSM_BAND_U17IV        = 0x00000080, /* WCDMA 3GPP AWS 1700/2100 MHz (Class IV) */
-	NM_SETTING_GSM_BAND_U800         = 0x00000100, /* WCDMA 3GPP UMTS 800 MHz      (Class VI) */
-	NM_SETTING_GSM_BAND_U850         = 0x00000200, /* WCDMA 3GPP UMTS 850 MHz      (Class V) */
-	NM_SETTING_GSM_BAND_U900         = 0x00000400, /* WCDMA 3GPP UMTS 900 MHz      (Class VIII) */
-	NM_SETTING_GSM_BAND_U17IX        = 0x00000800, /* WCDMA 3GPP UMTS 1700 MHz     (Class IX) */
-	NM_SETTING_GSM_BAND_U1900        = 0x00001000, /* WCDMA 3GPP UMTS 1900 MHz     (Class II) */
-	NM_SETTING_GSM_BAND_U2600        = 0x00002000, /* WCDMA 3GPP UMTS 2600 MHz     (Class VII, internal) */
-} NMSettingGsmNetworkBand;
-
-

-NMSettingGsmNetworkBand values indicate the allowed frequency bands -the device may use when connecting to this network. -

-
+

enum NMSettingGsmNetworkBand

+

NMSettingGsmNetworkBand values indicate the allowed frequency bands +the device may use when connecting to this network.

+
+

Members

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

NM_SETTING_GSM_BAND_UNKNOWN

unknown or no band specified -

NM_SETTING_GSM_BAND_ANY

any band is allowed -

NM_SETTING_GSM_BAND_EGSM

900 MHz original GSM band -

NM_SETTING_GSM_BAND_DCS

1800 MHz DCS band -

NM_SETTING_GSM_BAND_PCS

US 1900 MHz PCS band -

NM_SETTING_GSM_BAND_G850

US 850 MHz Cellular band +

NM_SETTING_GSM_BAND_UNKNOWN

 +

unknown or no band specified

 

NM_SETTING_GSM_BAND_U2100

WCDMA 3GPP UMTS 2100 MHz (Class I) +

NM_SETTING_GSM_BAND_ANY

 +

any band is allowed

 

NM_SETTING_GSM_BAND_U1800

WCDMA 3GPP UMTS 1800 MHz (Class III) +

NM_SETTING_GSM_BAND_EGSM

 +

900 MHz original GSM band

 

NM_SETTING_GSM_BAND_U17IV

WCDMA 3GPP AWS 1700/2100 MHz (Class IV) +

NM_SETTING_GSM_BAND_DCS

 +

1800 MHz DCS band

 

NM_SETTING_GSM_BAND_U800

WCDMA 3GPP UMTS 800 MHz (Class VI) +

NM_SETTING_GSM_BAND_PCS

 +

US 1900 MHz PCS band

 

NM_SETTING_GSM_BAND_U850

WCDMA 3GPP UMTS 850 MHz (Class V) -

NM_SETTING_GSM_BAND_U900

WCDMA 3GPP UMTS 900 MHz (Class VIII) -

NM_SETTING_GSM_BAND_U17IX

WCDMA 3GPP UMTS 1700 MHz (Class IX) -

NM_SETTING_GSM_BAND_U1900

WCDMA 3GPP UMTS 1900 MHz (Class II) -

NM_SETTING_GSM_BAND_U2600

WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) -
-
-
-
-

NMSettingGsm

-
typedef struct _NMSettingGsm NMSettingGsm;
-

-

-
-
-
-

NMSettingGsmClass

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

-

-
-
-
-

nm_setting_gsm_new ()

-
NMSetting *         nm_setting_gsm_new                  (void);
-

-Creates a new NMSettingGsm object with default values. -

-
---- - - - - -

Returns :

the new empty NMSettingGsm object
-
-
-
-

nm_setting_gsm_get_number ()

-
const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingGsm -

Returns :

the "number" property of the setting
-
-
-
-

nm_setting_gsm_get_username ()

-
const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_G850

 +

US 850 MHz Cellular band

 

Returns :

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

nm_setting_gsm_get_password ()

-
const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U2100

 +

WCDMA 3GPP UMTS 2100 MHz (Class I)

 

Returns :

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

nm_setting_gsm_get_apn ()

-
const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U1800

 +

WCDMA 3GPP UMTS 1800 MHz (Class III)

 

Returns :

the "apn" property of the setting
-
-
-
-

nm_setting_gsm_get_network_id ()

-
const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U17IV

 +

WCDMA 3GPP AWS 1700/2100 MHz (Class IV)

 

Returns :

the "network-id" property of the setting
-
-
-
-

nm_setting_gsm_get_network_type ()

-
int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U800

 +

WCDMA 3GPP UMTS 800 MHz (Class VI)

 

Returns :

the "network-type" property of the setting
-
-
-
-

nm_setting_gsm_get_allowed_bands ()

-
guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U850

 +

WCDMA 3GPP UMTS 850 MHz (Class V)

 

Returns :

the "allowed-bands" property of the setting
-
-
-
-

nm_setting_gsm_get_pin ()

-
const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U900

 +

WCDMA 3GPP UMTS 900 MHz (Class VIII)

 

Returns :

the "pin" property of the setting
-
-
-
-

nm_setting_gsm_get_home_only ()

-
gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
-
---- - - - - + + - - - - -

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U17IX

 +

WCDMA 3GPP UMTS 1700 MHz (Class IX)

 

Returns :

the "home-only" property of the setting
-
-
-
-

nm_setting_gsm_get_pin_flags ()

-
NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-
---- - - - - + + - - + +

setting :

the NMSettingGsm +

NM_SETTING_GSM_BAND_U1900

 +

WCDMA 3GPP UMTS 1900 MHz (Class II)

 

Returns :

the NMSettingSecretFlags pertaining to the "pin" +

NM_SETTING_GSM_BAND_U2600

 +

WCDMA 3GPP UMTS 2600 MHz (Class VII, internal)

 
-
-
-

nm_setting_gsm_get_password_flags ()

-
NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingGsm -

Returns :

the NMSettingSecretFlags pertaining to the "password" -

Property Details

-

The "allowed-bands" property

-
  "allowed-bands"            guint                 : Read / Write / Construct
-

-Bitfield of allowed frequency bands. Note that not all devices allow -frequency band control. Permitted values are those specified by -NMSettingGsmNetworkBand. -

+

The “allowed-bands” property

+
  “allowed-bands”            guint
+

Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.

+

Flags: Read / Write / Construct

Allowed values: <= 16383

Default value: 1

-

The "apn" property

-
  "apn"                      gchar*                : Read / Write
-

-The GPRS Access Point Name specifying the APN used when establishing a -data session with the GSM-based network. The APN often determines how -the user will be billed for their network usage and whether the user has -access to the Internet or just a provider-specific walled-garden, so it -is important to use the correct APN for the user's mobile broadband plan. -The APN may only be composed of the characters a-z, 0-9, ., and - per -GSM 03.60 Section 14.9. -

+

The “apn” property

+
  “apn”                      gchar *
+

The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.

+

Flags: Read / Write

Default value: NULL

-

The "home-only" property

-
  "home-only"                gboolean              : Read / Write
-

-When TRUE, only connections to the home network will be allowed. -Connections to roaming networks will not be made. -

+

The “home-only” property

+
  “home-only”                gboolean
+

When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.

+

Flags: Read / Write

Default value: FALSE

-

The "network-id" property

-
  "network-id"               gchar*                : Read / Write
-

-The Network ID (GSM LAI format, ie MCC-MNC) to force specific network -registration. If the Network ID is specified, NetworkManager will -attempt to force the device to register only on the specified network. -This can be used to ensure that the device does not roam when direct -roaming control of the device is not otherwise possible. -

+

The “network-id” property

+
  “network-id”               gchar *
+

The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.

+

Flags: Read / Write

Default value: NULL

-

The "network-type" property

-
  "network-type"             gint                  : Read / Write / Construct
-

-Network preference to force the device to only use specific network -technologies. Permitted values are those specified by -NMSettingGsmNetworkType. Note that not all devices allow network -preference control. -

+

The “network-type” property

+
  “network-type”             gint
+

Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Note that not all devices allow network preference control.

+

Flags: Read / Write / Construct

Allowed values: [-1,5]

Default value: -1

-

The "number" property

-
  "number"                   gchar*                : Read / Write
-

-Number to dial when establishing a PPP data session with the GSM-based -mobile broadband network. Many modems do not require PPP for connections -to the mobile network and thus this property should be left blank, which -allows NetworkManager to select the appropriate settings automatically. -

+

The “number” property

+
  “number”                   gchar *
+

Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.

+

Flags: Read / Write

Default value: NULL

-

The "password" property

-
  "password"                 gchar*                : Read / Write
-

-The password used to authenticate with the network, if required. Many -providers do not require a password, or accept any password. But if a -password is required, it is specified here. -

+

The “password” property

+
  “password”                 gchar *
+

Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.

+

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 GSM password.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "pin" property

-
  "pin"                      gchar*                : Read / Write
-

-If the SIM is locked with a PIN it must be unlocked before any other -operations are requested. Specify the PIN here to allow operation of -the device. -

+

The “pin” property

+
  “pin”                      gchar *
+

If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.

+

Flags: Read / Write

Default value: NULL

-

The "pin-flags" property

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

-Flags indicating how to handle "pin". -

+

The “pin-flags” property

+
  “pin-flags”                guint
+

Flags indicating how to handle the GSM SIM PIN.

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

The "username" property

-
  "username"                 gchar*                : Read / Write
-

-The username used to authenticate with the network, if required. Many -providers do not require a username, or accept any username. But if a -username is required, it is specified here. -

+

The “username” property

+
  “username”                 gchar *
+

Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingIP4Config.html b/docs/libnm-util/html/NMSettingIP4Config.html index 7e40149b..d177f3d5 100644 --- a/docs/libnm-util/html/NMSettingIP4Config.html +++ b/docs/libnm-util/html/NMSettingIP4Config.html @@ -2,34 +2,28 @@ -NMSettingIP4Config +libnm-util Reference Manual: NMSettingIP4Config - + - - - - - - - - - - + + + + + + +
@@ -37,1947 +31,2449 @@

NMSettingIP4Config

NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties

- +
-
-

Synopsis

-
-#include <nm-setting-ip4-config.h>
-
-#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
-enum                NMSettingIP4ConfigError;
-#define             NM_SETTING_IP4_CONFIG_ERROR
-GQuark              nm_setting_ip4_config_error_quark   (void);
-#define             NM_SETTING_IP4_CONFIG_METHOD
-#define             NM_SETTING_IP4_CONFIG_DNS
-#define             NM_SETTING_IP4_CONFIG_DNS_SEARCH
-#define             NM_SETTING_IP4_CONFIG_ADDRESSES
-#define             NM_SETTING_IP4_CONFIG_ROUTES
-#define             NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES
-#define             NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS
-#define             NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
-#define             NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME
-#define             NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME
-#define             NM_SETTING_IP4_CONFIG_NEVER_DEFAULT
-#define             NM_SETTING_IP4_CONFIG_MAY_FAIL
-#define             NM_SETTING_IP4_CONFIG_METHOD_AUTO
-#define             NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL
-#define             NM_SETTING_IP4_CONFIG_METHOD_MANUAL
-#define             NM_SETTING_IP4_CONFIG_METHOD_SHARED
-#define             NM_SETTING_IP4_CONFIG_METHOD_DISABLED
-typedef             NMIP4Address;
-NMIP4Address *      nm_ip4_address_new                  (void);
-NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);
-void                nm_ip4_address_ref                  (NMIP4Address *address);
-void                nm_ip4_address_unref                (NMIP4Address *address);
-gboolean            nm_ip4_address_compare              (NMIP4Address *address,
-                                                         NMIP4Address *other);
-guint32             nm_ip4_address_get_address          (NMIP4Address *address);
-void                nm_ip4_address_set_address          (NMIP4Address *address,
-                                                         guint32 addr);
-guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);
-void                nm_ip4_address_set_prefix           (NMIP4Address *address,
-                                                         guint32 prefix);
-guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);
-void                nm_ip4_address_set_gateway          (NMIP4Address *address,
-                                                         guint32 gateway);
-typedef             NMIP4Route;
-NMIP4Route *        nm_ip4_route_new                    (void);
-NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);
-void                nm_ip4_route_ref                    (NMIP4Route *route);
-void                nm_ip4_route_unref                  (NMIP4Route *route);
-gboolean            nm_ip4_route_compare                (NMIP4Route *route,
-                                                         NMIP4Route *other);
-guint32             nm_ip4_route_get_dest               (NMIP4Route *route);
-void                nm_ip4_route_set_dest               (NMIP4Route *route,
-                                                         guint32 dest);
-guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);
-void                nm_ip4_route_set_prefix             (NMIP4Route *route,
-                                                         guint32 prefix);
-guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);
-void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
-                                                         guint32 next_hop);
-guint32             nm_ip4_route_get_metric             (NMIP4Route *route);
-void                nm_ip4_route_set_metric             (NMIP4Route *route,
-                                                         guint32 metric);
-                    NMSettingIP4Config;
-                    NMSettingIP4ConfigClass;
-NMSetting *         nm_setting_ip4_config_new           (void);
-const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
-                                                         guint32 dns);
-void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_dns_searches
-                                                        (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip4_config_remove_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip4_config_clear_dns_searches
-                                                        (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_addresses
-                                                        (NMSettingIP4Config *setting);
-NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
-                                                         NMIP4Address *address);
-void                nm_setting_ip4_config_remove_address
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip4_config_clear_addresses
-                                                        (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_routes
-                                                        (NMSettingIP4Config *setting);
-NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
-                                                         NMIP4Route *route);
-void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_ignore_auto_routes
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_ignore_auto_dns
-                                                        (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_dhcp_client_id
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
-                                                        (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_dhcp_hostname
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_never_default
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingIP4ConfigError
-
-
-  GBoxed
-   +----NMIP4Address
-
-
-  GBoxed
-   +----NMIP4Route
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingIP4Config
-
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_ip4_config_error_quark () +
+NMIP4Address * + +nm_ip4_address_new () +
+NMIP4Address * + +nm_ip4_address_dup () +
+void + +nm_ip4_address_ref () +
+void + +nm_ip4_address_unref () +
+gboolean + +nm_ip4_address_compare () +
+guint32 + +nm_ip4_address_get_address () +
+void + +nm_ip4_address_set_address () +
+guint32 + +nm_ip4_address_get_prefix () +
+void + +nm_ip4_address_set_prefix () +
+guint32 + +nm_ip4_address_get_gateway () +
+void + +nm_ip4_address_set_gateway () +
+NMIP4Route * + +nm_ip4_route_new () +
+NMIP4Route * + +nm_ip4_route_dup () +
+void + +nm_ip4_route_ref () +
+void + +nm_ip4_route_unref () +
+gboolean + +nm_ip4_route_compare () +
+guint32 + +nm_ip4_route_get_dest () +
+void + +nm_ip4_route_set_dest () +
+guint32 + +nm_ip4_route_get_prefix () +
+void + +nm_ip4_route_set_prefix () +
+guint32 + +nm_ip4_route_get_next_hop () +
+void + +nm_ip4_route_set_next_hop () +
+guint32 + +nm_ip4_route_get_metric () +
+void + +nm_ip4_route_set_metric () +
+NMSetting * + +nm_setting_ip4_config_new () +
const char * + +nm_setting_ip4_config_get_method () +
+guint32 + +nm_setting_ip4_config_get_num_dns () +
+guint32 + +nm_setting_ip4_config_get_dns () +
+gboolean + +nm_setting_ip4_config_add_dns () +
+void + +nm_setting_ip4_config_remove_dns () +
+void + +nm_setting_ip4_config_clear_dns () +
+guint32 + +nm_setting_ip4_config_get_num_dns_searches () +
const char * + +nm_setting_ip4_config_get_dns_search () +
+gboolean + +nm_setting_ip4_config_add_dns_search () +
+void + +nm_setting_ip4_config_remove_dns_search () +
+void + +nm_setting_ip4_config_clear_dns_searches () +
+guint32 + +nm_setting_ip4_config_get_num_addresses () +
+NMIP4Address * + +nm_setting_ip4_config_get_address () +
+gboolean + +nm_setting_ip4_config_add_address () +
+void + +nm_setting_ip4_config_remove_address () +
+void + +nm_setting_ip4_config_clear_addresses () +
+guint32 + +nm_setting_ip4_config_get_num_routes () +
+NMIP4Route * + +nm_setting_ip4_config_get_route () +
+gboolean + +nm_setting_ip4_config_add_route () +
+void + +nm_setting_ip4_config_remove_route () +
+void + +nm_setting_ip4_config_clear_routes () +
+gboolean + +nm_setting_ip4_config_get_ignore_auto_routes () +
+gboolean + +nm_setting_ip4_config_get_ignore_auto_dns () +
const char * + +nm_setting_ip4_config_get_dhcp_client_id () +
+gboolean + +nm_setting_ip4_config_get_dhcp_send_hostname () +
const char * + +nm_setting_ip4_config_get_dhcp_hostname () +
+gboolean + +nm_setting_ip4_config_get_never_default () +
+gboolean + +nm_setting_ip4_config_get_may_fail () +

Properties

-
-  "addresses"                GPtrArray_GArray_guint__*  : Read / Write
-  "dhcp-client-id"           gchar*                : Read / Write
-  "dhcp-hostname"            gchar*                : Read / Write
-  "dhcp-send-hostname"       gboolean              : Read / Write / Construct
-  "dns"                      GArray_guint_*        : Read / Write
-  "dns-search"               GSList_gchararray_*   : Read / Write
-  "ignore-auto-dns"          gboolean              : Read / Write / Construct
-  "ignore-auto-routes"       gboolean              : Read / Write / Construct
-  "may-fail"                 gboolean              : Read / Write / Construct
-  "method"                   gchar*                : Read / Write
-  "never-default"            gboolean              : Read / Write / Construct
-  "routes"                   GPtrArray_GArray_guint__*  : Read / Write
-
-
-
-

Description

-

-The NMSettingIP4Config object is a NMSetting subclass that describes -properties related to IPv4 addressing, routing, and Domain Name Service -

-
-
-

Details

-
-

NM_SETTING_IP4_CONFIG_SETTING_NAME

-
#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
-
-

-

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GPtrArray_GArray_guint__ *addressesRead / Write
+gchar *dhcp-client-idRead / Write
+gchar *dhcp-hostnameRead / Write
gbooleandhcp-send-hostnameRead / Write / Construct
+GArray_guint_ *dnsRead / Write
+GSList_gchararray_ *dns-searchRead / Write
gbooleanignore-auto-dnsRead / Write / Construct
gbooleanignore-auto-routesRead / Write / Construct
gbooleanmay-failRead / Write / Construct
+gchar *methodRead / Write
gbooleannever-defaultRead / Write / Construct
+GPtrArray_GArray_guint__ *routesRead / Write
-
-
-

enum NMSettingIP4ConfigError

-
typedef enum {
-	NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY,      /*< nick=InvalidProperty >*/
-	NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY,      /*< nick=MissingProperty >*/
-	NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD /*< nick=NotAllowedForMethod >*/
-} NMSettingIP4ConfigError;
-
-
+
+

Types and Values

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

NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN

unknown or unclassified error -#defineNM_SETTING_IP4_CONFIG_SETTING_NAME
enumNMSettingIP4ConfigError
#defineNM_SETTING_IP4_CONFIG_ERROR
#defineNM_SETTING_IP4_CONFIG_METHOD
#defineNM_SETTING_IP4_CONFIG_DNS
#defineNM_SETTING_IP4_CONFIG_DNS_SEARCH
#defineNM_SETTING_IP4_CONFIG_ADDRESSES
#defineNM_SETTING_IP4_CONFIG_ROUTES
#defineNM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES
#defineNM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS
#defineNM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
#defineNM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME
#defineNM_SETTING_IP4_CONFIG_DHCP_HOSTNAME
#defineNM_SETTING_IP4_CONFIG_NEVER_DEFAULT

NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY

the property was invalid -#defineNM_SETTING_IP4_CONFIG_MAY_FAIL

NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY

the property was missing and is -required -#defineNM_SETTING_IP4_CONFIG_METHOD_AUTO

NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD

the property's value is -not valid with the given IP4 method -#defineNM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL
#defineNM_SETTING_IP4_CONFIG_METHOD_MANUAL
#defineNM_SETTING_IP4_CONFIG_METHOD_SHARED
#defineNM_SETTING_IP4_CONFIG_METHOD_DISABLED
-
-
-

NM_SETTING_IP4_CONFIG_ERROR

-
#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark ()
-
-

-

-
-
-
-

nm_setting_ip4_config_error_quark ()

-
GQuark              nm_setting_ip4_config_error_quark   (void);
-

-Registers an error quark for NMSettingIP4Config if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingIP4Config errors.
-
-
-
-

NM_SETTING_IP4_CONFIG_METHOD

-
#define NM_SETTING_IP4_CONFIG_METHOD             "method"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_DNS

-
#define NM_SETTING_IP4_CONFIG_DNS                "dns"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_DNS_SEARCH

-
#define NM_SETTING_IP4_CONFIG_DNS_SEARCH         "dns-search"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_ADDRESSES

-
#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_ROUTES

-
#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES

-
#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

-
#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

-
#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

-
#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

-
#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

-
#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_MAY_FAIL

-
#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"
+

+
Object Hierarchy

+
    GBoxed
+    ├── NMIP4Address
+    ╰── NMIP4Route
+    GEnum
+    ╰── NMSettingIP4ConfigError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingIP4Config
 

-

-

 

-

-

-
NM_SETTING_IP4_CONFIG_METHOD_AUTO

-
#define NM_SETTING_IP4_CONFIG_METHOD_AUTO       "auto"
+

+
Includes

+
#include <nm-setting-ip4-config.h>
 

-

-IPv4 configuration should be automatically determined via a method appropriate
-for the hardware interface, ie DHCP or PPP or some other device-specific
-manner.
-

 

-

-

-
NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

-
#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
-

-

-IPv4 configuration should be automatically configured for link-local-only
-operation.
-

+

+
Description

+
The NMSettingIP4Config object is a NMSetting subclass that describes
+properties related to IPv4 addressing, routing, and Domain Name Service

 

-

+

+
Functions

 

-
NM_SETTING_IP4_CONFIG_METHOD_MANUAL

-
#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL     "manual"
-

-

-All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified
-in the setting's properties.
-

+
nm_setting_ip4_config_error_quark ()

+
GQuark
+nm_setting_ip4_config_error_quark (void);

+
Registers an error quark for NMSettingIP4Config if necessary.

+

+
Returns

+
 the error quark used for NMSettingIP4Config errors.

+

 

-

-

-
NM_SETTING_IP4_CONFIG_METHOD_SHARED

-
#define NM_SETTING_IP4_CONFIG_METHOD_SHARED     "shared"
-

-

-This connection specifies configuration that allows other computers to
-connect through it to the default network (usually the Internet).  The
-connection's interface will be assigned a private address, and a DHCP server,
-caching DNS server, and Network Address Translation (NAT) functionality will
-be started on this connection's interface to allow other devices to connect
-through that interface to the default network.
-

 

 

 

-
NM_SETTING_IP4_CONFIG_METHOD_DISABLED

-
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"
-

-

-This connection does not use or require IPv4 address and it should be disabled.
-

+
nm_ip4_address_new ()

+
NMIP4Address *
+nm_ip4_address_new (void);

+
Creates and returns a new NMIP4Address object.

+

+
Returns

+
 the new empty NMIP4Address object. 

+
[transfer full]

 

-

-

-
NMIP4Address

-
typedef struct NMIP4Address NMIP4Address;
-

-

-

 

 

 

-
nm_ip4_address_new ()

-
NMIP4Address *      nm_ip4_address_new                  (void);

-

-Creates and returns a new NMIP4Address object.
-

-

+
nm_ip4_address_dup ()

+
NMIP4Address *
+nm_ip4_address_dup (NMIP4Address *source);

+
Copies a given NMIP4Address object and returns the copy.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMIP4Address object. [transfer full]
-
source
the NMIP4Address object to copy
 
 

 

 

-

-

-
nm_ip4_address_dup ()

-
NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);

-

-Copies a given NMIP4Address object and returns the copy.
-

-

----
-
-
-
-
-
-
-
-
-
-
-




source :
the NMIP4Address object to copy
Returns :
the copy of the given NMIP4Address copy. [transfer full]
-

+

+
Returns

+
 the copy of the given NMIP4Address copy. 

+
[transfer full]

+

 

 

 

-
nm_ip4_address_ref ()

-
void                nm_ip4_address_ref                  (NMIP4Address *address);

-

-Increases the reference count of the object.
-

-

+
nm_ip4_address_ref ()

+
void
+nm_ip4_address_ref (NMIP4Address *address);

+
Increases the reference count of the object.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
address :
the NMIP4Address
-
address
the NMIP4Address
 
 

 

 

+

 

 

-
nm_ip4_address_unref ()

-
void                nm_ip4_address_unref                (NMIP4Address *address);

-

-Decreases the reference count of the object.  If the reference count
-reaches zero, the object will be destroyed.
-

-

+
nm_ip4_address_unref ()

+
void
+nm_ip4_address_unref (NMIP4Address *address);

+
Decreases the reference count of the object.  If the reference count
+reaches zero, the object will be destroyed.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
address :
the NMIP4Address
-
address
the NMIP4Address
 
 

 

 

-

-

-
nm_ip4_address_compare ()

-
gboolean            nm_ip4_address_compare              (NMIP4Address *address,
-                                                         NMIP4Address *other);

-

-Determines if two NMIP4Address objects contain the same values.
-

-

----
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-




address :
the NMIP4Address
-
other :
the NMIP4Address to compare address to.
Returns :

-TRUE if the objects contain the same values, FALSE if they do not.

 

 

 

-
nm_ip4_address_get_address ()

-
guint32             nm_ip4_address_get_address          (NMIP4Address *address);

-

-Gets the IPv4 address property of this address object.
-

-

+
nm_ip4_address_compare ()

+
gboolean
+nm_ip4_address_compare (NMIP4Address *address,
+                        NMIP4Address *other);

+
Determines if two NMIP4Address objects contain the same values.

+

+
Parameters

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

 





 
 
 
address :
the NMIP4Address
-
address
the NMIP4Address
 
 

 
Returns :
the IPv4 address in network byte order
other
the NMIP4Address to compare address
+to.
 
 

 
 

 

-

-

-
nm_ip4_address_set_address ()

-
void                nm_ip4_address_set_address          (NMIP4Address *address,
-                                                         guint32 addr);

-

-Sets the IPv4 address property of this object.
-

-

----
-
-
-
-
-
-
-
-
-
-
-




address :
the NMIP4Address
-
addr :
the IPv4 address in network byte order

+

+
Returns

+
 TRUE if the objects contain the same values, FALSE if they do not.

+

+

 

 

 

-
nm_ip4_address_get_prefix ()

-
guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);

-

-Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address
-object.
-

-

+
nm_ip4_address_get_address ()

+
guint32
+nm_ip4_address_get_address (NMIP4Address *address);

+
Gets the IPv4 address property of this address object.

+

+
Parameters

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

 





 
address :
the NMIP4Address
-
Returns :
the IPv4 address prefix
address
the NMIP4Address
 

 

 

+

+
Returns

+
 the IPv4 address in network byte order

+

+

+

 

 

-
nm_ip4_address_set_prefix ()

-
void                nm_ip4_address_set_prefix           (NMIP4Address *address,
-                                                         guint32 prefix);

-

-Sets the IPv4 address prefix.
-

-

+
nm_ip4_address_set_address ()

+
void
+nm_ip4_address_set_address (NMIP4Address *address,
+                            guint32 addr);

+
Sets the IPv4 address property of this object.

+

+
Parameters

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

 





 
 
 
address :
the NMIP4Address
-
address
the NMIP4Address
 
 

 
prefix :
the address prefix, a number between 1 and 32 inclusive
addr
the IPv4 address in network byte order
 
 

 
 

 

+

 

 

-
nm_ip4_address_get_gateway ()

-
guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);

-

-Gets the IPv4 default gateway property of this address object.
-

-

+
nm_ip4_address_get_prefix ()

+
guint32
+nm_ip4_address_get_prefix (NMIP4Address *address);

+
Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address
+object.

+

+
Parameters

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

 





 
address :
the NMIP4Address
-
Returns :
the IPv4 gateway address in network byte order
address
the NMIP4Address
 

 

 

+

+
Returns

+
 the IPv4 address prefix

+

+

+

 

 

-
nm_ip4_address_set_gateway ()

-
void                nm_ip4_address_set_gateway          (NMIP4Address *address,
-                                                         guint32 gateway);

-

-Sets the IPv4 default gateway property of this address object.
-

-

+
nm_ip4_address_set_prefix ()

+
void
+nm_ip4_address_set_prefix (NMIP4Address *address,
+                           guint32 prefix);

+
Sets the IPv4 address prefix.

+

+
Parameters

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

 





 
 
 
address :
the NMIP4Address
-
address
the NMIP4Address
 
 

 
gateway :
the IPv4 default gateway in network byte order
prefix
the address prefix, a number between 1 and 32 inclusive
 
 

 
 

 

-

-

-
NMIP4Route

-
typedef struct NMIP4Route NMIP4Route;
-

-

-

 

 

 

-
nm_ip4_route_new ()

-
NMIP4Route *        nm_ip4_route_new                    (void);

-

-Creates and returns a new NMIP4Route object.
-

-

+
nm_ip4_address_get_gateway ()

+
guint32
+nm_ip4_address_get_gateway (NMIP4Address *address);

+
Gets the IPv4 default gateway property of this address object.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMIP4Route object. [transfer full]
-
address
the NMIP4Address
 
 

 

 

+

+
Returns

+
 the IPv4 gateway address in network byte order

+

+

+

 

 

-
nm_ip4_route_dup ()

-
NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);

-

-Copies a given NMIP4Route object and returns the copy.
-

-

+
nm_ip4_address_set_gateway ()

+
void
+nm_ip4_address_set_gateway (NMIP4Address *address,
+                            guint32 gateway);

+
Sets the IPv4 default gateway property of this address object.

+

+
Parameters

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

 





 
 
 
source :
the NMIP4Route object to copy
address
the NMIP4Address
 
 

 
Returns :
the copy of the given NMIP4Route copy. [transfer full]
-
gateway
the IPv4 default gateway in network byte order
 
 

 
 

 

+
-

nm_ip4_route_ref ()

-
void                nm_ip4_route_ref                    (NMIP4Route *route);
-

-Increases the reference count of the object. -

-
+

nm_ip4_route_new ()

+
NMIP4Route *
+nm_ip4_route_new (void);
+

Creates and returns a new NMIP4Route object.

+
+

Returns

+

the new empty NMIP4Route object.

+

[transfer full]

+
+ +
+
+

nm_ip4_route_dup ()

+
NMIP4Route *
+nm_ip4_route_dup (NMIP4Route *source);
+

Copies a given NMIP4Route object and returns the copy.

+
+

Parameters

+
--+++ - - + + +

route :

the NMIP4Route -

source

the NMIP4Route object to copy

 
+
+

Returns

+

the copy of the given NMIP4Route copy.

+

[transfer full]

+
+
-

nm_ip4_route_unref ()

-
void                nm_ip4_route_unref                  (NMIP4Route *route);
-

-Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed. -

-
+

nm_ip4_route_ref ()

+
void
+nm_ip4_route_ref (NMIP4Route *route);
+

Increases the reference count of the object.

+
+

Parameters

+
--+++ - - + + +

route :

the NMIP4Route -

route

the NMIP4Route

 
+
-

nm_ip4_route_compare ()

-
gboolean            nm_ip4_route_compare                (NMIP4Route *route,
-                                                         NMIP4Route *other);
-

-Determines if two NMIP4Route objects contain the same values. -

-
+

nm_ip4_route_unref ()

+
void
+nm_ip4_route_unref (NMIP4Route *route);
+

Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
+

Parameters

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

route :

the NMIP4Route -

other :

the NMIP4Route to compare route to.

Returns :

 -TRUE if the objects contain the same values, FALSE if they do not.

route

the NMIP4Route

 
+
-

nm_ip4_route_get_dest ()

-
guint32             nm_ip4_route_get_dest               (NMIP4Route *route);
-

-Gets the IPv4 destination address property of this route object. -

-
+

nm_ip4_route_compare ()

+
gboolean
+nm_ip4_route_compare (NMIP4Route *route,
+                      NMIP4Route *other);
+

Determines if two NMIP4Route objects contain the same values.

+
+

Parameters

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

route :

the NMIP4Route -

route

the NMIP4Route

 

Returns :

the IPv4 address in network byte order

other

the NMIP4Route to compare route +to.

 
+
+

Returns

+

TRUE if the objects contain the same values, FALSE if they do not.

+

+
+
-

nm_ip4_route_set_dest ()

-
void                nm_ip4_route_set_dest               (NMIP4Route *route,
-                                                         guint32 dest);
-

-Sets the IPv4 destination address property of this route object. -

-
+

nm_ip4_route_get_dest ()

+
guint32
+nm_ip4_route_get_dest (NMIP4Route *route);
+

Gets the IPv4 destination address property of this route object.

+
+

Parameters

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

route :

the NMIP4Route -

dest :

the destination address in network byte order

route

the NMIP4Route

 
+
+

Returns

+

the IPv4 address in network byte order

+

+
+
-

nm_ip4_route_get_prefix ()

-
guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);
-

-Gets the IPv4 prefix (ie "24" or "30" etc) of this route. -

-
+

nm_ip4_route_set_dest ()

+
void
+nm_ip4_route_set_dest (NMIP4Route *route,
+                       guint32 dest);
+

Sets the IPv4 destination address property of this route object.

+
+

Parameters

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

route :

the NMIP4Route -

route

the NMIP4Route

 

Returns :

the IPv4 prefix

dest

the destination address in network byte order

 
+
-

nm_ip4_route_set_prefix ()

-
void                nm_ip4_route_set_prefix             (NMIP4Route *route,
-                                                         guint32 prefix);
-

-Sets the IPv4 prefix of this route. -

-
+

nm_ip4_route_get_prefix ()

+
guint32
+nm_ip4_route_get_prefix (NMIP4Route *route);
+

Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

+
+

Parameters

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

route :

the NMIP4Route -

prefix :

the prefix, a number between 1 and 32 inclusive

route

the NMIP4Route

 
+
+

Returns

+

the IPv4 prefix

+

+
+
-

nm_ip4_route_get_next_hop ()

-
guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);
-

-Gets the IPv4 address of the next hop of this route. -

-
+

nm_ip4_route_set_prefix ()

+
void
+nm_ip4_route_set_prefix (NMIP4Route *route,
+                         guint32 prefix);
+

Sets the IPv4 prefix of this route.

+
+

Parameters

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

route :

the NMIP4Route -

route

the NMIP4Route

 

Returns :

the IPv4 address in network byte order

prefix

the prefix, a number between 1 and 32 inclusive

 
+
-

nm_ip4_route_set_next_hop ()

-
void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
-                                                         guint32 next_hop);
-

-Sets the IPv4 address of the next hop of this route. -

-
+

nm_ip4_route_get_next_hop ()

+
guint32
+nm_ip4_route_get_next_hop (NMIP4Route *route);
+

Gets the IPv4 address of the next hop of this route.

+
+

Parameters

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

route :

the NMIP4Route -

next_hop :

the IPv4 address of the next hop in network byte order

route

the NMIP4Route

 
+
+

Returns

+

the IPv4 address in network byte order

+

+
+
-

nm_ip4_route_get_metric ()

-
guint32             nm_ip4_route_get_metric             (NMIP4Route *route);
-

-Gets the route metric property of this route object; lower values indicate -"better" or more preferred routes. -

-
+

nm_ip4_route_set_next_hop ()

+
void
+nm_ip4_route_set_next_hop (NMIP4Route *route,
+                           guint32 next_hop);
+

Sets the IPv4 address of the next hop of this route.

+
+

Parameters

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

route :

the NMIP4Route -

route

the NMIP4Route

 

Returns :

the route metric

next_hop

the IPv4 address of the next hop in network byte order

 
+
-

nm_ip4_route_set_metric ()

-
void                nm_ip4_route_set_metric             (NMIP4Route *route,
-                                                         guint32 metric);
-

-Sets the route metric property of this route object; lower values indicate -"better" or more preferred routes. -

-
+

nm_ip4_route_get_metric ()

+
guint32
+nm_ip4_route_get_metric (NMIP4Route *route);
+

Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
+

Parameters

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

route

the NMIP4Route

 
+
+
+

Returns

+

the route metric

+

+
+ +
+
+

nm_ip4_route_set_metric ()

+
void
+nm_ip4_route_set_metric (NMIP4Route *route,
+                         guint32 metric);
+

Sets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
+

Parameters

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

route :

the NMIP4Route -

route

the NMIP4Route

 

metric :

the route metric

metric

the route metric

 
-
-
-

NMSettingIP4Config

-
typedef struct _NMSettingIP4Config NMSettingIP4Config;
-

-

-

NMSettingIP4ConfigClass

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

-

+

nm_setting_ip4_config_new ()

+
NMSetting *
+nm_setting_ip4_config_new (void);
+

Creates a new NMSettingIP4Config object with default values.

+
+

Returns

+

the new empty NMSettingIP4Config object.

+

[transfer full]

+
-

nm_setting_ip4_config_new ()

-
NMSetting *         nm_setting_ip4_config_new           (void);
-

-Creates a new NMSettingIP4Config object with default values. -

-
+

nm_setting_ip4_config_get_method ()

+
const char *
+nm_setting_ip4_config_get_method (NMSettingIP4Config *setting);
+
+

Parameters

+
--+++ - - + + +

Returns :

the new empty NMSettingIP4Config object. [transfer full] -

setting

the NMSettingIP4Config

 
+
+

Returns

+

the “method” property of the setting

+

+
+
-

nm_setting_ip4_config_get_method ()

-
const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_get_num_dns ()

+
guint32
+nm_setting_ip4_config_get_num_dns (NMSettingIP4Config *setting);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

the "method" property of the setting

setting

the NMSettingIP4Config

 
+
+

Returns

+

the number of configured DNS servers

+

+
+
-

nm_setting_ip4_config_get_num_dns ()

-
guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_get_dns ()

+
guint32
+nm_setting_ip4_config_get_dns (NMSettingIP4Config *setting,
+                               guint32 i);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 

Returns :

the number of configured DNS servers

i

index number of the DNS server to return

 
-
-
-

nm_setting_ip4_config_get_dns ()

-
guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
-                                                         guint32 i);
-
---- - - - - - - - - - - - - - - -

setting :

the NMSettingIP4Config -

i :

index number of the DNS server to return

Returns :

the IPv4 address (network byte order) of the DNS server at index +
+

Returns

+

the IPv4 address (network byte order) of the DNS server at index i -

+

+

+
-

nm_setting_ip4_config_add_dns ()

-
gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
-                                                         guint32 dns);
-

-Adds a new DNS server to the setting. -

-
+

nm_setting_ip4_config_add_dns ()

+
gboolean
+nm_setting_ip4_config_add_dns (NMSettingIP4Config *setting,
+                               guint32 dns);
+

Adds a new DNS server to the setting.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

dns :

the IPv4 address (network byte order) of the DNS server to add

setting

the NMSettingIP4Config

 

Returns :

 -TRUE if the DNS server was added; FALSE if the server was already -known

dns

the IPv4 address (network byte order) of the DNS server to add

 
+
+

Returns

+

TRUE if the DNS server was added; FALSE if the server was already +known

+

+
+
-

nm_setting_ip4_config_remove_dns ()

-
void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
-                                                         guint32 i);
-

-Removes the DNS server at index i. -

-
+

nm_setting_ip4_config_remove_dns ()

+
void
+nm_setting_ip4_config_remove_dns (NMSettingIP4Config *setting,
+                                  guint32 i);
+

Removes the DNS server at index i +.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 

i :

index number of the DNS server to remove

i

index number of the DNS server to remove

 
+
-

nm_setting_ip4_config_clear_dns ()

-
void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);
-

-Removes all configured DNS servers. -

-
+

nm_setting_ip4_config_clear_dns ()

+
void
+nm_setting_ip4_config_clear_dns (NMSettingIP4Config *setting);
+

Removes all configured DNS servers.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 
+
-

nm_setting_ip4_config_get_num_dns_searches ()

-
guint32             nm_setting_ip4_config_get_num_dns_searches
-                                                        (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_get_num_dns_searches ()

+
guint32
+nm_setting_ip4_config_get_num_dns_searches
+                               (NMSettingIP4Config *setting);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

the number of configured DNS search domains

setting

the NMSettingIP4Config

 
+
+

Returns

+

the number of configured DNS search domains

+

+
+
-

nm_setting_ip4_config_get_dns_search ()

-
const char *        nm_setting_ip4_config_get_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip4_config_get_dns_search ()

+
const char *
+nm_setting_ip4_config_get_dns_search (NMSettingIP4Config *setting,
+                                      guint32 i);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

i :

index number of the DNS search domain to return

setting

the NMSettingIP4Config

 

Returns :

the DNS search domain at index i -

i

index number of the DNS search domain to return

 
+
+

Returns

+

the DNS search domain at index i +

+

+
+
-

nm_setting_ip4_config_add_dns_search ()

-
gboolean            nm_setting_ip4_config_add_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         const char *dns_search);
-

-Adds a new DNS search domain to the setting. -

-
+

nm_setting_ip4_config_add_dns_search ()

+
gboolean
+nm_setting_ip4_config_add_dns_search (NMSettingIP4Config *setting,
+                                      const char *dns_search);
+

Adds a new DNS search domain to the setting.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

dns_search :

the search domain to add

setting

the NMSettingIP4Config

 

Returns :

 -TRUE if the DNS search domain was added; FALSE if the search -domain was already known

dns_search

the search domain to add

 
+
+

Returns

+

TRUE if the DNS search domain was added; FALSE if the search +domain was already known

+

+
+
-

nm_setting_ip4_config_remove_dns_search ()

-
void                nm_setting_ip4_config_remove_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-

-Removes the DNS search domain at index i. -

-
+

nm_setting_ip4_config_remove_dns_search ()

+
void
+nm_setting_ip4_config_remove_dns_search
+                               (NMSettingIP4Config *setting,
+                                guint32 i);
+

Removes the DNS search domain at index i +.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 

i :

index number of the DNS search domain

i

index number of the DNS search domain

 
+
-

nm_setting_ip4_config_clear_dns_searches ()

-
void                nm_setting_ip4_config_clear_dns_searches
-                                                        (NMSettingIP4Config *setting);
-

-Removes all configured DNS search domains. -

-
+

nm_setting_ip4_config_clear_dns_searches ()

+
void
+nm_setting_ip4_config_clear_dns_searches
+                               (NMSettingIP4Config *setting);
+

Removes all configured DNS search domains.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 
+
-

nm_setting_ip4_config_get_num_addresses ()

-
guint32             nm_setting_ip4_config_get_num_addresses
-                                                        (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_get_num_addresses ()

+
guint32
+nm_setting_ip4_config_get_num_addresses
+                               (NMSettingIP4Config *setting);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

the number of configured addresses

setting

the NMSettingIP4Config

 
+
+

Returns

+

the number of configured addresses

+

+
+
-

nm_setting_ip4_config_get_address ()

-
NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip4_config_get_address ()

+
NMIP4Address *
+nm_setting_ip4_config_get_address (NMSettingIP4Config *setting,
+                                   guint32 i);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

i :

index number of the address to return

setting

the NMSettingIP4Config

 

Returns :

the address at index i -

i

index number of the address to return

 
+
+

Returns

+

the address at index i +

+

+
+
-

nm_setting_ip4_config_add_address ()

-
gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
-                                                         NMIP4Address *address);
-

-Adds a new IPv4 address and associated information to the setting. The -given address is duplicated internally and is not changed by this function. -

-
+

nm_setting_ip4_config_add_address ()

+
gboolean
+nm_setting_ip4_config_add_address (NMSettingIP4Config *setting,
+                                   NMIP4Address *address);
+

Adds a new IPv4 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

address :

the new address to add

setting

the NMSettingIP4Config

 

Returns :

 -TRUE if the address was added; FALSE if the address was already -known.

address

the new address to add

 
+
+

Returns

+

TRUE if the address was added; FALSE if the address was already +known.

+

+
+
-

nm_setting_ip4_config_remove_address ()

-
void                nm_setting_ip4_config_remove_address
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-

-Removes the address at index i. -

-
+

nm_setting_ip4_config_remove_address ()

+
void
+nm_setting_ip4_config_remove_address (NMSettingIP4Config *setting,
+                                      guint32 i);
+

Removes the address at index i +.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 

i :

index number of the address to remove

i

index number of the address to remove

 
+
-

nm_setting_ip4_config_clear_addresses ()

-
void                nm_setting_ip4_config_clear_addresses
-                                                        (NMSettingIP4Config *setting);
-

-Removes all configured addresses. -

-
+

nm_setting_ip4_config_clear_addresses ()

+
void
+nm_setting_ip4_config_clear_addresses (NMSettingIP4Config *setting);
+

Removes all configured addresses.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 
+
-

nm_setting_ip4_config_get_num_routes ()

-
guint32             nm_setting_ip4_config_get_num_routes
-                                                        (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_get_num_routes ()

+
guint32
+nm_setting_ip4_config_get_num_routes (NMSettingIP4Config *setting);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

the number of configured routes

setting

the NMSettingIP4Config

 
+
+

Returns

+

the number of configured routes

+

+
+
-

nm_setting_ip4_config_get_route ()

-
NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip4_config_get_route ()

+
NMIP4Route *
+nm_setting_ip4_config_get_route (NMSettingIP4Config *setting,
+                                 guint32 i);
+
+

Parameters

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

setting :

the NMSettingIP4Config -

i :

index number of the route to return

setting

the NMSettingIP4Config

 

Returns :

the route at index i -

i

index number of the route to return

 
+
+

Returns

+

the route at index i +

+

+
+
-

nm_setting_ip4_config_add_route ()

-
gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
-                                                         NMIP4Route *route);
-

-Adds a new IPv4 route and associated information to the setting. The -given route is duplicated internally and is not changed by this function. -

-
+

nm_setting_ip4_config_add_route ()

+
gboolean
+nm_setting_ip4_config_add_route (NMSettingIP4Config *setting,
+                                 NMIP4Route *route);
+

Adds a new IPv4 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

route :

the route to add

setting

the NMSettingIP4Config

 

Returns :

 -TRUE if the route was added; FALSE if the route was already known.

route

the route to add

 
+
+

Returns

+

TRUE if the route was added; FALSE if the route was already known.

+

+
+
-

nm_setting_ip4_config_remove_route ()

-
void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
-                                                         guint32 i);
-

-Removes the route at index i. -

-
+

nm_setting_ip4_config_remove_route ()

+
void
+nm_setting_ip4_config_remove_route (NMSettingIP4Config *setting,
+                                    guint32 i);
+

Removes the route at index i +.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 

i :

index number of the route

i

index number of the route

 
+
-

nm_setting_ip4_config_clear_routes ()

-
void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);
-

-Removes all configured routes. -

-
+

nm_setting_ip4_config_clear_routes ()

+
void
+nm_setting_ip4_config_clear_routes (NMSettingIP4Config *setting);
+

Removes all configured routes.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSettingIP4Config -

setting

the NMSettingIP4Config

 
+
-

nm_setting_ip4_config_get_ignore_auto_routes ()

-
gboolean            nm_setting_ip4_config_get_ignore_auto_routes
-                                                        (NMSettingIP4Config *setting);
-

-Returns the value contained in the "ignore-auto-routes" -property. -

-
+

nm_setting_ip4_config_get_ignore_auto_routes ()

+
gboolean
+nm_setting_ip4_config_get_ignore_auto_routes
+                               (NMSettingIP4Config *setting);
+

Returns the value contained in the “ignore-auto-routes” +property.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

 -TRUE if automatically configured (ie via DHCP) routes should be -ignored.

setting

the NMSettingIP4Config

 
+
+

Returns

+

TRUE if automatically configured (ie via DHCP) routes should be +ignored.

+

+
+
-

nm_setting_ip4_config_get_ignore_auto_dns ()

-
gboolean            nm_setting_ip4_config_get_ignore_auto_dns
-                                                        (NMSettingIP4Config *setting);
-

-Returns the value contained in the "ignore-auto-dns" -property. -

-
+

nm_setting_ip4_config_get_ignore_auto_dns ()

+
gboolean
+nm_setting_ip4_config_get_ignore_auto_dns
+                               (NMSettingIP4Config *setting);
+

Returns the value contained in the “ignore-auto-dns” +property.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

 -TRUE if automatically configured (ie via DHCP) DNS information -should be ignored.

setting

the NMSettingIP4Config

 
+
+

Returns

+

TRUE if automatically configured (ie via DHCP) DNS information +should be ignored.

+

+
+
-

nm_setting_ip4_config_get_dhcp_client_id ()

-
const char *        nm_setting_ip4_config_get_dhcp_client_id
-                                                        (NMSettingIP4Config *setting);
-

-Returns the value contained in the "dhcp-client-id" -property. -

-
+

nm_setting_ip4_config_get_dhcp_client_id ()

+
const char *
+nm_setting_ip4_config_get_dhcp_client_id
+                               (NMSettingIP4Config *setting);
+

Returns the value contained in the “dhcp-client-id” +property.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

the configured Client ID to send to the DHCP server when requesting -addresses via DHCP.

setting

the NMSettingIP4Config

 
+
+

Returns

+

the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.

+

+
+
-

nm_setting_ip4_config_get_dhcp_send_hostname ()

-
gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
-                                                        (NMSettingIP4Config *setting);
-

-Returns the value contained in the "dhcp-send-hostname" -property. -

-
+

nm_setting_ip4_config_get_dhcp_send_hostname ()

+
gboolean
+nm_setting_ip4_config_get_dhcp_send_hostname
+                               (NMSettingIP4Config *setting);
+

Returns the value contained in the “dhcp-send-hostname” +property.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

 -TRUE if NetworkManager should send the machine hostname to the -DHCP server when requesting addresses to allow the server to automatically -update DNS information for this machine.

setting

the NMSettingIP4Config

 
+
+

Returns

+

TRUE if NetworkManager should send the machine hostname to the +DHCP server when requesting addresses to allow the server to automatically +update DNS information for this machine.

+

+
+
-

nm_setting_ip4_config_get_dhcp_hostname ()

-
const char *        nm_setting_ip4_config_get_dhcp_hostname
-                                                        (NMSettingIP4Config *setting);
-

-Returns the value contained in the "dhcp-hostname" -property. -

-
+

nm_setting_ip4_config_get_dhcp_hostname ()

+
const char *
+nm_setting_ip4_config_get_dhcp_hostname
+                               (NMSettingIP4Config *setting);
+

Returns the value contained in the “dhcp-hostname” +property.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

the configured hostname to send to the DHCP server

setting

the NMSettingIP4Config

 
+
+

Returns

+

the configured hostname to send to the DHCP server

+

+
+
-

nm_setting_ip4_config_get_never_default ()

-
gboolean            nm_setting_ip4_config_get_never_default
-                                                        (NMSettingIP4Config *setting);
-

-Returns the value contained in the "never-default" -property. -

-
+

nm_setting_ip4_config_get_never_default ()

+
gboolean
+nm_setting_ip4_config_get_never_default
+                               (NMSettingIP4Config *setting);
+

Returns the value contained in the “never-default” +property.

+
+

Parameters

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

setting :

the NMSettingIP4Config -

Returns :

 -TRUE if this connection should never be the default connection -for IPv4 addressing

setting

the NMSettingIP4Config

 
+
+

Returns

+

TRUE if this connection should never be the default connection +for IPv4 addressing

+

+
+
-

nm_setting_ip4_config_get_may_fail ()

-
gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_get_may_fail ()

+
gboolean
+nm_setting_ip4_config_get_may_fail (NMSettingIP4Config *setting);
+

Returns the value contained in the “may-fail” +property.

+
+

Parameters

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

setting

the NMSettingIP4Config

 
+
+
+

Returns

+

TRUE if this connection doesn't require IPv4 addressing to complete +for the connection to succeed.

+

+
+
+ +
+

Types and Values

+
+

NM_SETTING_IP4_CONFIG_SETTING_NAME

+
#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
+

-Returns the value contained in the "may-fail" -property.

-
+ +
+
+

enum NMSettingIP4ConfigError

+
+

Members

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

setting :

the NMSettingIP4Config +

NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN

 +

unknown or unclassified error

+		 

NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

Returns :

 -TRUE if this connection doesn't require IPv4 addressing to complete -for the connection to succeed.

NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 

NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD

 +

the property's value is +not valid with the given IP4 method

+		 
-
-

Property Details

+
+
+

NM_SETTING_IP4_CONFIG_ERROR

+
#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark ()
+
+

+

+
+
-

The "addresses" property

-
  "addresses"                GPtrArray_GArray_guint__*  : Read / Write
+

NM_SETTING_IP4_CONFIG_METHOD

+
#define NM_SETTING_IP4_CONFIG_METHOD             "method"
+

-Array of IPv4 address structures. Each IPv4 address structure is -composed of 3 32-bit values; the first being the IPv4 address (network -byte order), the second the prefix (1 - 32), and last the IPv4 gateway -(network byte order). The gateway may be left as 0 if no gateway exists -for that subnet. For the 'auto' method, given IP addresses are appended -to those returned by automatic configuration. Addresses cannot be used -with the 'shared', 'link-local', or 'disabled' methods as addressing is -either automatic or disabled with these methods.

-

The "dhcp-client-id" property

-
  "dhcp-client-id"           gchar*                : Read / Write
+

NM_SETTING_IP4_CONFIG_DNS

+
#define NM_SETTING_IP4_CONFIG_DNS                "dns"
+

-A string sent to the DHCP server to identify the local machine which the -DHCP server may use to customize the DHCP lease and options.

-

Default value: NULL

-

The "dhcp-hostname" property

-
  "dhcp-hostname"            gchar*                : Read / Write
+

NM_SETTING_IP4_CONFIG_DNS_SEARCH

+
#define NM_SETTING_IP4_CONFIG_DNS_SEARCH         "dns-search"
+

-If the "dhcp-send-hostname" property is TRUE, then the -specified name will be sent to the DHCP server when acquiring a lease.

-

Default value: NULL

-

The "dhcp-send-hostname" property

-
  "dhcp-send-hostname"       gboolean              : Read / Write / Construct
+

NM_SETTING_IP4_CONFIG_ADDRESSES

+
#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"
+

-If TRUE, a hostname is sent to the DHCP server when acquiring a lease. -Some DHCP servers use this hostname to update DNS databases, essentially -providing a static hostname for the computer. If -"dhcp-hostname" is empty and this property is TRUE, -the current persistent hostname of the computer is sent.

-

Default value: TRUE

-

The "dns" property

-
  "dns"                      GArray_guint_*        : Read / Write
+

NM_SETTING_IP4_CONFIG_ROUTES

+
#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
+

-List of DNS servers (network byte order). For the 'auto' method, these -DNS servers are appended to those (if any) returned by automatic -configuration. DNS servers cannot be used with the 'shared', 'link-local', -or 'disabled' methods as there is no upstream network. In all other -methods, these DNS servers are used as the only DNS servers for this -connection.

-

The "dns-search" property

-
  "dns-search"               GSList_gchararray_*   : Read / Write
+

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES

+
#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
+

-List of DNS search domains. For the 'auto' method, these search domains -are appended to those returned by automatic configuration. Search domains -cannot be used with the 'shared', 'link-local', or 'disabled' methods as -there is no upstream network. In all other methods, these search domains -are used as the only search domains for this connection.

-

The "ignore-auto-dns" property

-
  "ignore-auto-dns"          gboolean              : Read / Write / Construct
+

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

+
#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+

-When the method is set to 'auto' and this property to TRUE, automatically -configured nameservers and search domains are ignored and only nameservers -and search domains specified in "dns" and -"dns-search", if any, are used.

-

Default value: FALSE

-

The "ignore-auto-routes" property

-
  "ignore-auto-routes"       gboolean              : Read / Write / Construct
+

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

+
#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"
+

-When the method is set to 'auto' and this property to TRUE, automatically -configured routes are ignored and only routes specified in -"routes", if any, are used.

-

Default value: FALSE

-

The "may-fail" property

-
  "may-fail"                 gboolean              : Read / Write / Construct
+

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

+
#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
+

-If TRUE, allow overall network configuration to proceed even if IPv4 -configuration times out. Note that at least one IP configuration -must succeed or overall network configuration will still fail. For -example, in IPv6-only networks, setting this property to TRUE allows -the overall network configuration to succeed if IPv4 configuration fails -but IPv6 configuration completes successfully.

-

Default value: TRUE

-

The "method" property

-
  "method"                   gchar*                : Read / Write
+

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

+
#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+

-IPv4 configuration method. If 'auto' is specified then the appropriate -automatic method (DHCP, PPP, etc) is used for the interface and most -other properties can be left unset. If 'link-local' is specified, then a -link-local address in the 169.254/16 range will be assigned to the -interface. If 'manual' is specified, static IP addressing is used and at -least one IP address must be given in the 'addresses' property. If -'shared' is specified (indicating that this connection will provide -network access to other computers) then the interface is assigned an -address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server -are started, and the interface is NAT-ed to the current default network -connection. 'disabled' means IPv4 will not be used on this connection. -This property must be set.

-

Default value: NULL

-

The "never-default" property

-
  "never-default"            gboolean              : Read / Write / Construct
+

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

+
#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
+

-If TRUE, this connection will never be the default IPv4 connection, -meaning it will never be assigned the default route by NetworkManager.

-

Default value: FALSE

-

The "routes" property

-
  "routes"                   GPtrArray_GArray_guint__*  : Read / Write
+

NM_SETTING_IP4_CONFIG_MAY_FAIL

+
#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"
+

-Array of IPv4 route structures. Each IPv4 route structure is composed -of 4 32-bit values; the first being the destination IPv4 network or -address (network byte order), the second the destination network or -address prefix (1 - 32), the third being the next-hop (network byte -order) if any, and the fourth being the route metric. For the 'auto' -method, given IP routes are appended to those returned by automatic -configuration. Routes cannot be used with the 'shared', 'link-local', -or 'disabled' methods because there is no upstream network.

+
+
+

NM_SETTING_IP4_CONFIG_METHOD_AUTO

+
#define NM_SETTING_IP4_CONFIG_METHOD_AUTO       "auto"
+
+

IPv4 configuration should be automatically determined via a method appropriate +for the hardware interface, ie DHCP or PPP or some other device-specific +manner.

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

+
#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
+
+

IPv4 configuration should be automatically configured for link-local-only +operation.

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

+
#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL     "manual"
+
+

All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties.

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_SHARED

+
#define NM_SETTING_IP4_CONFIG_METHOD_SHARED     "shared"
+
+

This connection specifies configuration that allows other computers to +connect through it to the default network (usually the Internet). The +connection's interface will be assigned a private address, and a DHCP server, +caching DNS server, and Network Address Translation (NAT) functionality will +be started on this connection's interface to allow other devices to connect +through that interface to the default network.

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

+
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"
+
+

This connection does not use or require IPv4 address and it should be disabled.

+
+
+
+

Property Details

+
+

The “addresses” property

+
  “addresses”                GPtrArray_GArray_guint__ *
+

Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.

+

Flags: Read / Write

+
+
+
+

The “dhcp-client-id” property

+
  “dhcp-client-id”           gchar *
+

A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “dhcp-hostname” property

+
  “dhcp-hostname”            gchar *
+

If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “dhcp-send-hostname” property

+
  “dhcp-send-hostname”       gboolean
+

If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the 'dhcp-hostname' property is empty and this property is TRUE, the current persistent hostname of the computer is sent.

+

Flags: Read / Write / Construct

+

Default value: TRUE

+
+
+
+

The “dns” property

+
  “dns”                      GArray_guint_ *
+

List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.

+

Flags: Read / Write

+
+
+
+

The “dns-search” property

+
  “dns-search”               GSList_gchararray_ *
+

List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.

+

Flags: Read / Write

+
+
+
+

The “ignore-auto-dns” property

+
  “ignore-auto-dns”          gboolean
+

When the method is set to 'auto' and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “ignore-auto-routes” property

+
  “ignore-auto-routes”       gboolean
+

When the method is set to 'auto' and this property to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “may-fail” property

+
  “may-fail”                 gboolean
+

If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

+

Flags: Read / Write / Construct

+

Default value: TRUE

+
+
+
+

The “method” property

+
  “method”                   gchar *
+

IPv4 configuration method. If 'auto' is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset. If 'link-local' is specified, then a link-local address in the 169.254/16 range will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'shared' is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT-ed to the current default network connection. 'disabled' means IPv4 will not be used on this connection. This property must be set.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “never-default” property

+
  “never-default”            gboolean
+

If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “routes” property

+
  “routes”                   GPtrArray_GArray_guint__ *
+

Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.

+

Flags: Read / Write

+
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingIP6Config.html b/docs/libnm-util/html/NMSettingIP6Config.html index 9df4ad93..a3d62b10 100644 --- a/docs/libnm-util/html/NMSettingIP6Config.html +++ b/docs/libnm-util/html/NMSettingIP6Config.html @@ -2,34 +2,28 @@ -NMSettingIP6Config +libnm-util Reference Manual: NMSettingIP6Config - + - - - - - - - - - - + + + + + + +
@@ -37,1963 +31,2444 @@

NMSettingIP6Config

NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties

- +
-
-

Synopsis

-
-#include <nm-setting-ip6-config.h>
-
-#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
-enum                NMSettingIP6ConfigError;
-#define             NM_SETTING_IP6_CONFIG_ERROR
-GQuark              nm_setting_ip6_config_error_quark   (void);
-#define             NM_SETTING_IP6_CONFIG_METHOD
-#define             NM_SETTING_IP6_CONFIG_DNS
-#define             NM_SETTING_IP6_CONFIG_DNS_SEARCH
-#define             NM_SETTING_IP6_CONFIG_ADDRESSES
-#define             NM_SETTING_IP6_CONFIG_ROUTES
-#define             NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES
-#define             NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS
-#define             NM_SETTING_IP6_CONFIG_NEVER_DEFAULT
-#define             NM_SETTING_IP6_CONFIG_MAY_FAIL
-#define             NM_SETTING_IP6_CONFIG_IP6_PRIVACY
-#define             NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME
-#define             NM_SETTING_IP6_CONFIG_METHOD_IGNORE
-#define             NM_SETTING_IP6_CONFIG_METHOD_AUTO
-#define             NM_SETTING_IP6_CONFIG_METHOD_DHCP
-#define             NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL
-#define             NM_SETTING_IP6_CONFIG_METHOD_MANUAL
-#define             NM_SETTING_IP6_CONFIG_METHOD_SHARED
-enum                NMSettingIP6ConfigPrivacy;
-typedef             NMIP6Address;
-NMIP6Address *      nm_ip6_address_new                  (void);
-NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
-void                nm_ip6_address_ref                  (NMIP6Address *address);
-void                nm_ip6_address_unref                (NMIP6Address *address);
-gboolean            nm_ip6_address_compare              (NMIP6Address *address,
-                                                         NMIP6Address *other);
-const struct in6_addr * nm_ip6_address_get_address      (NMIP6Address *address);
-void                nm_ip6_address_set_address          (NMIP6Address *address,
-                                                         const struct in6_addr *addr);
-guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);
-void                nm_ip6_address_set_prefix           (NMIP6Address *address,
-                                                         guint32 prefix);
-const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
-void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gateway);
-typedef             NMIP6Route;
-NMIP6Route *        nm_ip6_route_new                    (void);
-NMIP6Route *        nm_ip6_route_dup                    (NMIP6Route *source);
-void                nm_ip6_route_ref                    (NMIP6Route *route);
-void                nm_ip6_route_unref                  (NMIP6Route *route);
-gboolean            nm_ip6_route_compare                (NMIP6Route *route,
-                                                         NMIP6Route *other);
-const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);
-void                nm_ip6_route_set_dest               (NMIP6Route *route,
-                                                         const struct in6_addr *dest);
-guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);
-void                nm_ip6_route_set_prefix             (NMIP6Route *route,
-                                                         guint32 prefix);
-const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);
-void                nm_ip6_route_set_next_hop           (NMIP6Route *route,
-                                                         const struct in6_addr *next_hop);
-guint32             nm_ip6_route_get_metric             (NMIP6Route *route);
-void                nm_ip6_route_set_metric             (NMIP6Route *route,
-                                                         guint32 metric);
-                    NMSettingIP6Config;
-                    NMSettingIP6ConfigClass;
-NMSetting *         nm_setting_ip6_config_new           (void);
-const char *        nm_setting_ip6_config_get_method    (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
-const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_dns       (NMSettingIP6Config *setting,
-                                                         const struct in6_addr *dns);
-void                nm_setting_ip6_config_remove_dns    (NMSettingIP6Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip6_config_clear_dns     (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_dns_searches
-                                                        (NMSettingIP6Config *setting);
-const char *        nm_setting_ip6_config_get_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip6_config_remove_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip6_config_clear_dns_searches
-                                                        (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_addresses
-                                                        (NMSettingIP6Config *setting);
-NMIP6Address *      nm_setting_ip6_config_get_address   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_address   (NMSettingIP6Config *setting,
-                                                         NMIP6Address *address);
-void                nm_setting_ip6_config_remove_address
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip6_config_clear_addresses
-                                                        (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_routes
-                                                        (NMSettingIP6Config *setting);
-NMIP6Route *        nm_setting_ip6_config_get_route     (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_route     (NMSettingIP6Config *setting,
-                                                         NMIP6Route *route);
-void                nm_setting_ip6_config_remove_route  (NMSettingIP6Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_ignore_auto_routes
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_ignore_auto_dns
-                                                        (NMSettingIP6Config *setting);
-const char *        nm_setting_ip6_config_get_dhcp_hostname
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_never_default
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);
-NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
-                                                        (NMSettingIP6Config *setting);
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingIP6ConfigError
-
-
-  GEnum
-   +----NMSettingIP6ConfigPrivacy
-
-
-  GBoxed
-   +----NMIP6Address
-
-
-  GBoxed
-   +----NMIP6Route
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingIP6Config
-
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_ip6_config_error_quark () +
+NMIP6Address * + +nm_ip6_address_new () +
+NMIP6Address * + +nm_ip6_address_dup () +
+void + +nm_ip6_address_ref () +
+void + +nm_ip6_address_unref () +
+gboolean + +nm_ip6_address_compare () +
const struct in6_addr * + +nm_ip6_address_get_address () +
+void + +nm_ip6_address_set_address () +
+guint32 + +nm_ip6_address_get_prefix () +
+void + +nm_ip6_address_set_prefix () +
const struct in6_addr * + +nm_ip6_address_get_gateway () +
+void + +nm_ip6_address_set_gateway () +
+NMIP6Route * + +nm_ip6_route_new () +
+NMIP6Route * + +nm_ip6_route_dup () +
+void + +nm_ip6_route_ref () +
+void + +nm_ip6_route_unref () +
+gboolean + +nm_ip6_route_compare () +
const struct in6_addr * + +nm_ip6_route_get_dest () +
+void + +nm_ip6_route_set_dest () +
+guint32 + +nm_ip6_route_get_prefix () +
+void + +nm_ip6_route_set_prefix () +
const struct in6_addr * + +nm_ip6_route_get_next_hop () +
+void + +nm_ip6_route_set_next_hop () +
+guint32 + +nm_ip6_route_get_metric () +
+void + +nm_ip6_route_set_metric () +
+NMSetting * + +nm_setting_ip6_config_new () +
const char * + +nm_setting_ip6_config_get_method () +
+guint32 + +nm_setting_ip6_config_get_num_dns () +
const struct in6_addr * + +nm_setting_ip6_config_get_dns () +
+gboolean + +nm_setting_ip6_config_add_dns () +
+void + +nm_setting_ip6_config_remove_dns () +
+void + +nm_setting_ip6_config_clear_dns () +
+guint32 + +nm_setting_ip6_config_get_num_dns_searches () +
const char * + +nm_setting_ip6_config_get_dns_search () +
+gboolean + +nm_setting_ip6_config_add_dns_search () +
+void + +nm_setting_ip6_config_remove_dns_search () +
+void + +nm_setting_ip6_config_clear_dns_searches () +
+guint32 + +nm_setting_ip6_config_get_num_addresses () +
+NMIP6Address * + +nm_setting_ip6_config_get_address () +
+gboolean + +nm_setting_ip6_config_add_address () +
+void + +nm_setting_ip6_config_remove_address () +
+void + +nm_setting_ip6_config_clear_addresses () +
+guint32 + +nm_setting_ip6_config_get_num_routes () +
+NMIP6Route * + +nm_setting_ip6_config_get_route () +
+gboolean + +nm_setting_ip6_config_add_route () +
+void + +nm_setting_ip6_config_remove_route () +
+void + +nm_setting_ip6_config_clear_routes () +
+gboolean + +nm_setting_ip6_config_get_ignore_auto_routes () +
+gboolean + +nm_setting_ip6_config_get_ignore_auto_dns () +
const char * + +nm_setting_ip6_config_get_dhcp_hostname () +
+gboolean + +nm_setting_ip6_config_get_never_default () +
+gboolean + +nm_setting_ip6_config_get_may_fail () +
+NMSettingIP6ConfigPrivacy + +nm_setting_ip6_config_get_ip6_privacy () +

Properties

-
-  "addresses"                GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*  : Read / Write
-  "dhcp-hostname"            gchar*                : Read / Write
-  "dns"                      GPtrArray_GArray_guchar__*  : Read / Write
-  "dns-search"               GSList_gchararray_*   : Read / Write
-  "ignore-auto-dns"          gboolean              : Read / Write / Construct
-  "ignore-auto-routes"       gboolean              : Read / Write / Construct
-  "ip6-privacy"              gint                  : Read / Write / Construct
-  "may-fail"                 gboolean              : Read / Write / Construct
-  "method"                   gchar*                : Read / Write
-  "never-default"            gboolean              : Read / Write / Construct
-  "routes"                   GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*  : Read / Write
-
-
-
-

Description

-

-The NMSettingIP6Config object is a NMSetting subclass that describes -properties related to IPv6 addressing, routing, and Domain Name Service -

-
-
-

Details

-
-

NM_SETTING_IP6_CONFIG_SETTING_NAME

-
#define NM_SETTING_IP6_CONFIG_SETTING_NAME "ipv6"
-
-

-

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*addressesRead / Write
+gchar *dhcp-hostnameRead / Write
+GPtrArray_GArray_guchar__ *dnsRead / Write
+GSList_gchararray_ *dns-searchRead / Write
gbooleanignore-auto-dnsRead / Write / Construct
gbooleanignore-auto-routesRead / Write / Construct
gintip6-privacyRead / Write / Construct
gbooleanmay-failRead / Write / Construct
+gchar *methodRead / Write
gbooleannever-defaultRead / Write / Construct
GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*routesRead / Write
-
-
-

enum NMSettingIP6ConfigError

-
typedef enum {
-	NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY,      /*< nick=InvalidProperty >*/
-	NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY,      /*< nick=MissingProperty >*/
-	NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD /*< nick=NotAllowedForMethod >*/
-} NMSettingIP6ConfigError;
-
-
+
+

Types and Values

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

NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN

unknown or unclassified error -#defineNM_SETTING_IP6_CONFIG_SETTING_NAME

NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY

the property was invalid -enumNMSettingIP6ConfigError

NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY

the property was missing and is -required -#defineNM_SETTING_IP6_CONFIG_ERROR
#defineNM_SETTING_IP6_CONFIG_METHOD
#defineNM_SETTING_IP6_CONFIG_DNS
#defineNM_SETTING_IP6_CONFIG_DNS_SEARCH
#defineNM_SETTING_IP6_CONFIG_ADDRESSES
#defineNM_SETTING_IP6_CONFIG_ROUTES
#defineNM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES
#defineNM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS
#defineNM_SETTING_IP6_CONFIG_NEVER_DEFAULT
#defineNM_SETTING_IP6_CONFIG_MAY_FAIL
#defineNM_SETTING_IP6_CONFIG_IP6_PRIVACY
#defineNM_SETTING_IP6_CONFIG_DHCP_HOSTNAME
#defineNM_SETTING_IP6_CONFIG_METHOD_IGNORE
#defineNM_SETTING_IP6_CONFIG_METHOD_AUTO
#defineNM_SETTING_IP6_CONFIG_METHOD_DHCP
#defineNM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL
#defineNM_SETTING_IP6_CONFIG_METHOD_MANUAL
#defineNM_SETTING_IP6_CONFIG_METHOD_SHARED

NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD

the property's value is -not valid with the given IPv6 method -enumNMSettingIP6ConfigPrivacy
+
+

Object Hierarchy

+
    GBoxed
+    ├── NMIP6Address
+    ╰── NMIP6Route
+    GEnum
+    ├── NMSettingIP6ConfigError
+    ╰── NMSettingIP6ConfigPrivacy
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingIP6Config
+
+
+
+

Includes

+
#include <nm-setting-ip6-config.h>
+
+
+
+

Description

+

The NMSettingIP6Config object is a NMSetting subclass that describes +properties related to IPv6 addressing, routing, and Domain Name Service

+
+
+

Functions

+
+

nm_setting_ip6_config_error_quark ()

+
GQuark
+nm_setting_ip6_config_error_quark (void);
+

Registers an error quark for NMSettingIP6Config if necessary.

+
+

Returns

+

the error quark used for NMSettingIP6Config errors.

+

+
+
-

NM_SETTING_IP6_CONFIG_ERROR

-
#define NM_SETTING_IP6_CONFIG_ERROR nm_setting_ip6_config_error_quark ()
-
-

-

+

nm_ip6_address_new ()

+
NMIP6Address *
+nm_ip6_address_new (void);
+

Creates and returns a new NMIP6Address object.

+
+

Returns

+

the new empty NMIP6Address object.

+

[transfer full]

+
-

nm_setting_ip6_config_error_quark ()

-
GQuark              nm_setting_ip6_config_error_quark   (void);
-

-Registers an error quark for NMSettingIP6Config if necessary. -

-
+

nm_ip6_address_dup ()

+
NMIP6Address *
+nm_ip6_address_dup (NMIP6Address *source);
+

Copies a given NMIP6Address object and returns the copy.

+
+

Parameters

+
--+++ - - + + +

Returns :

the error quark used for NMSettingIP6Config errors.

source

the NMIP6Address object to copy

 
-
-
-

NM_SETTING_IP6_CONFIG_METHOD

-
#define NM_SETTING_IP6_CONFIG_METHOD             "method"
-
-

-

+
+

Returns

+

the copy of the given NMIP6Address copy.

+

[transfer full]

-
-
-

NM_SETTING_IP6_CONFIG_DNS

-
#define NM_SETTING_IP6_CONFIG_DNS                "dns"
-
-

-

-

NM_SETTING_IP6_CONFIG_DNS_SEARCH

-
#define NM_SETTING_IP6_CONFIG_DNS_SEARCH         "dns-search"
-
-

-

+

nm_ip6_address_ref ()

+
void
+nm_ip6_address_ref (NMIP6Address *address);
+

Increases the reference count of the object.

+
+

Parameters

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

address

the NMIP6Address

 
-
-
-

NM_SETTING_IP6_CONFIG_ADDRESSES

-
#define NM_SETTING_IP6_CONFIG_ADDRESSES          "addresses"
-
-

-

-

NM_SETTING_IP6_CONFIG_ROUTES

-
#define NM_SETTING_IP6_CONFIG_ROUTES             "routes"
-
-

-

+

nm_ip6_address_unref ()

+
void
+nm_ip6_address_unref (NMIP6Address *address);
+

Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
+

Parameters

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

address

the NMIP6Address

 
-
-
-

NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES

-
#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
-
-

-

-

NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS

-
#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
-
-

-

+

nm_ip6_address_compare ()

+
gboolean
+nm_ip6_address_compare (NMIP6Address *address,
+                        NMIP6Address *other);
+

Determines if two NMIP6Address objects contain the same values.

+
+

Parameters

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

address

the NMIP6Address

 

other

the NMIP6Address to compare address +to.

 
-
-
-

NM_SETTING_IP6_CONFIG_NEVER_DEFAULT

-
#define NM_SETTING_IP6_CONFIG_NEVER_DEFAULT      "never-default"
-
-

-

+
+

Returns

+

TRUE if the objects contain the same values, FALSE if they do not.

+

-
-
-

NM_SETTING_IP6_CONFIG_MAY_FAIL

-
#define NM_SETTING_IP6_CONFIG_MAY_FAIL           "may-fail"
-
-

-

-

NM_SETTING_IP6_CONFIG_IP6_PRIVACY

-
#define NM_SETTING_IP6_CONFIG_IP6_PRIVACY        "ip6-privacy"
-
-

-

+

nm_ip6_address_get_address ()

+
const struct in6_addr *
+nm_ip6_address_get_address (NMIP6Address *address);
+

Gets the IPv6 address property of this address object.

+
+

Parameters

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

address

the NMIP6Address

 
-
-
-

NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME

-
#define NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
-
-

-

+
+

Returns

+

the IPv6 address.

+

[array fixed-size=16][element-type guint8][transfer none]

-
-
-

NM_SETTING_IP6_CONFIG_METHOD_IGNORE

-
#define NM_SETTING_IP6_CONFIG_METHOD_IGNORE     "ignore"
-
-

-IPv6 is not required or is handled by some other mechanism, and NetworkManager -should not configure IPv6 for this connection. -

-

NM_SETTING_IP6_CONFIG_METHOD_AUTO

-
#define NM_SETTING_IP6_CONFIG_METHOD_AUTO       "auto"
-
-

-IPv6 configuration should be automatically determined via a method appropriate -for the hardware interface, ie router advertisements, DHCP, or PPP or some -other device-specific manner. -

+

nm_ip6_address_set_address ()

+
void
+nm_ip6_address_set_address (NMIP6Address *address,
+                            const struct in6_addr *addr);
+

Sets the IPv6 address property of this object.

+
+

Parameters

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

address

the NMIP6Address

 

addr

the IPv6 address

 
-
-
-

NM_SETTING_IP6_CONFIG_METHOD_DHCP

-
#define NM_SETTING_IP6_CONFIG_METHOD_DHCP       "dhcp"
-
-

-IPv6 configuration should be automatically determined via DHCPv6 only and -router advertisements should be ignored. -

-

NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL

-
#define NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL "link-local"
-
-

-IPv6 configuration should be automatically configured for link-local-only -operation. -

+

nm_ip6_address_get_prefix ()

+
guint32
+nm_ip6_address_get_prefix (NMIP6Address *address);
+

Gets the IPv6 address prefix property of this address object.

+
+

Parameters

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

address

the NMIP6Address

 
-
-
-

NM_SETTING_IP6_CONFIG_METHOD_MANUAL

-
#define NM_SETTING_IP6_CONFIG_METHOD_MANUAL     "manual"
-
-

-All necessary IPv6 configuration (addresses, prefix, DNS, etc) is specified -in the setting's properties. -

+
+

Returns

+

the IPv6 address prefix

+

-
-
-

NM_SETTING_IP6_CONFIG_METHOD_SHARED

-
#define NM_SETTING_IP6_CONFIG_METHOD_SHARED     "shared"
-
-

-This connection specifies configuration that allows other computers to -connect through it to the default network (usually the Internet). The -connection's interface will be assigned a private address, and router -advertisements, a caching DNS server, and Network Address Translation (NAT) -functionality will be started on this connection's interface to allow other -devices to connect through that interface to the default network. (not yet -supported for IPv6) -

-

enum NMSettingIP6ConfigPrivacy

-
typedef enum {
-	NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN = -1,
-	NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED = 0,
-	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR = 1,
-	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR = 2
-} NMSettingIP6ConfigPrivacy;
-
-

-NMSettingIP6ConfigPrivacy values indicate if and how IPv6 Privacy -Extensions are used (RFC4941). -

-
+

nm_ip6_address_set_prefix ()

+
void
+nm_ip6_address_set_prefix (NMIP6Address *address,
+                           guint32 prefix);
+

Sets the IPv6 address prefix.

+
+

Parameters

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

NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN

unknown or no value specified -

NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED

IPv6 Privacy Extensions are disabled -

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR

IPv6 Privacy Extensions -are enabled, but public addresses are preferred over temporary addresses -

address

the NMIP6Address

 

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR

IPv6 Privacy Extensions -are enabled and temporary addresses are preferred over public addresses -

prefix

the address prefix, a number between 0 and 128 inclusive

 
-
-
-

NMIP6Address

-
typedef struct NMIP6Address NMIP6Address;
-
-

-

-

nm_ip6_address_new ()

-
NMIP6Address *      nm_ip6_address_new                  (void);
-

-Creates and returns a new NMIP6Address object. -

-
+

nm_ip6_address_get_gateway ()

+
const struct in6_addr *
+nm_ip6_address_get_gateway (NMIP6Address *address);
+

Gets the IPv6 default gateway property of this address object.

+
+

Parameters

+
--+++ - - + + +

Returns :

the new empty NMIP6Address object. [transfer full] -

address

the NMIP6Address

 
+
+

Returns

+

the IPv6 gateway address.

+

[array fixed-size=16][element-type guint8][transfer none]

+
+
-

nm_ip6_address_dup ()

-
NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
-

-Copies a given NMIP6Address object and returns the copy. -

-
+

nm_ip6_address_set_gateway ()

+
void
+nm_ip6_address_set_gateway (NMIP6Address *address,
+                            const struct in6_addr *gateway);
+

Sets the IPv6 default gateway property of this address object.

+
+

Parameters

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

source :

the NMIP6Address object to copy

address

the NMIP6Address

 

Returns :

the copy of the given NMIP6Address copy. [transfer full] -

gateway

the IPv6 default gateway

 
+
-

nm_ip6_address_ref ()

-
void                nm_ip6_address_ref                  (NMIP6Address *address);
-

-Increases the reference count of the object. -

-
+

nm_ip6_route_new ()

+
NMIP6Route *
+nm_ip6_route_new (void);
+

Creates and returns a new NMIP6Route object.

+
+

Returns

+

the new empty NMIP6Route object.

+

[transfer full]

+
+ +
+
+

nm_ip6_route_dup ()

+
NMIP6Route *
+nm_ip6_route_dup (NMIP6Route *source);
+

Copies a given NMIP6Route object and returns the copy.

+
+

Parameters

+
--+++ - - + + +

address :

the NMIP6Address -

source

the NMIP6Route object to copy

 
+
+

Returns

+

the copy of the given NMIP6Route copy.

+

[transfer full]

+
+
-

nm_ip6_address_unref ()

-
void                nm_ip6_address_unref                (NMIP6Address *address);
-

-Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed. -

-
+

nm_ip6_route_ref ()

+
void
+nm_ip6_route_ref (NMIP6Route *route);
+

Increases the reference count of the object.

+
+

Parameters

+
--+++ - - + + +

address :

the NMIP6Address -

route

the NMIP6Route

 
+
-

nm_ip6_address_compare ()

-
gboolean            nm_ip6_address_compare              (NMIP6Address *address,
-                                                         NMIP6Address *other);
-

-Determines if two NMIP6Address objects contain the same values. -

-
+

nm_ip6_route_unref ()

+
void
+nm_ip6_route_unref (NMIP6Route *route);
+

Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
+

Parameters

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

address :

the NMIP6Address -

other :

the NMIP6Address to compare address to.

Returns :

 -TRUE if the objects contain the same values, FALSE if they do not.

route

the NMIP6Route

 
+
-

nm_ip6_address_get_address ()

-
const struct in6_addr * nm_ip6_address_get_address      (NMIP6Address *address);
-

-Gets the IPv6 address property of this address object. -

-
+

nm_ip6_route_compare ()

+
gboolean
+nm_ip6_route_compare (NMIP6Route *route,
+                      NMIP6Route *other);
+

Determines if two NMIP6Route objects contain the same values.

+
+

Parameters

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

address :

the NMIP6Address -

route

the NMIP6Route

 

Returns :

the IPv6 address. [transfer none] -

other

the NMIP6Route to compare route +to.

 
+
+

Returns

+

TRUE if the objects contain the same values, FALSE if they do not.

+

+
+
-

nm_ip6_address_set_address ()

-
void                nm_ip6_address_set_address          (NMIP6Address *address,
-                                                         const struct in6_addr *addr);
-

-Sets the IPv6 address property of this object. -

-
+

nm_ip6_route_get_dest ()

+
const struct in6_addr *
+nm_ip6_route_get_dest (NMIP6Route *route);
+

Gets the IPv6 destination address property of this route object.

+
+

Parameters

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

address :

the NMIP6Address -

addr :

the IPv6 address

route

the NMIP6Route

 
+
+

Returns

+

the IPv6 address of destination.

+

[array fixed-size=16][element-type guint8][transfer none]

+
+
-

nm_ip6_address_get_prefix ()

-
guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);
-

-Gets the IPv6 address prefix property of this address object. -

-
+

nm_ip6_route_set_dest ()

+
void
+nm_ip6_route_set_dest (NMIP6Route *route,
+                       const struct in6_addr *dest);
+

Sets the IPv6 destination address property of this route object.

+
+

Parameters

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

address :

the NMIP6Address -

route

the NMIP6Route

 

Returns :

the IPv6 address prefix

dest

the destination address

 
+
+
+
+

nm_ip6_route_get_prefix ()

+
guint32
+nm_ip6_route_get_prefix (NMIP6Route *route);
+

Gets the IPv6 prefix (ie "32" or "64" etc) of this route.

+
+

Parameters

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

route

the NMIP6Route

 
+
+
+

Returns

+

the IPv6 prefix

+

+
+
-

nm_ip6_address_set_prefix ()

-
void                nm_ip6_address_set_prefix           (NMIP6Address *address,
-                                                         guint32 prefix);
-

-Sets the IPv6 address prefix. -

-
+

nm_ip6_route_set_prefix ()

+
void
+nm_ip6_route_set_prefix (NMIP6Route *route,
+                         guint32 prefix);
+

Sets the IPv6 prefix of this route.

+
+

Parameters

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

address :

the NMIP6Address -

route

the NMIP6Route

 

prefix :

the address prefix, a number between 0 and 128 inclusive

prefix

the prefix, a number between 1 and 128 inclusive

 
+
-

nm_ip6_address_get_gateway ()

-
const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
-

-Gets the IPv6 default gateway property of this address object. -

-
+

nm_ip6_route_get_next_hop ()

+
const struct in6_addr *
+nm_ip6_route_get_next_hop (NMIP6Route *route);
+

Gets the IPv6 address of the next hop of this route.

+
+

Parameters

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

address :

the NMIP6Address -

Returns :

the IPv6 gateway address. [transfer none] -

route

the NMIP6Route

 
+
+

Returns

+

the IPv6 address of next hop.

+

[array fixed-size=16][element-type guint8][transfer none]

+
+
-

nm_ip6_address_set_gateway ()

-
void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gateway);
-

-Sets the IPv6 default gateway property of this address object. -

-
+

nm_ip6_route_set_next_hop ()

+
void
+nm_ip6_route_set_next_hop (NMIP6Route *route,
+                           const struct in6_addr *next_hop);
+

Sets the IPv6 address of the next hop of this route.

+
+

Parameters

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

address :

the NMIP6Address -

route

the NMIP6Route

 

gateway :

the IPv6 default gateway

next_hop

the IPv6 address of the next hop

 
-
-
-

NMIP6Route

-
typedef struct NMIP6Route NMIP6Route;
-
-

-

-

nm_ip6_route_new ()

-
NMIP6Route *        nm_ip6_route_new                    (void);
-

-Creates and returns a new NMIP6Route object. -

-
+

nm_ip6_route_get_metric ()

+
guint32
+nm_ip6_route_get_metric (NMIP6Route *route);
+

Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
+

Parameters

+
--+++ - - + + +

Returns :

the new empty NMIP6Route object. [transfer full] -

route

the NMIP6Route

 
+
+

Returns

+

the route metric

+

+
+
-

nm_ip6_route_dup ()

-
NMIP6Route *        nm_ip6_route_dup                    (NMIP6Route *source);
-

-Copies a given NMIP6Route object and returns the copy. -

-
+

nm_ip6_route_set_metric ()

+
void
+nm_ip6_route_set_metric (NMIP6Route *route,
+                         guint32 metric);
+

Sets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
+

Parameters

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

source :

the NMIP6Route object to copy

route

the NMIP6Route

 

Returns :

the copy of the given NMIP6Route copy. [transfer full] -

metric

the route metric

 
+
-

nm_ip6_route_ref ()

-
void                nm_ip6_route_ref                    (NMIP6Route *route);
-

-Increases the reference count of the object. -

-
+

nm_setting_ip6_config_new ()

+
NMSetting *
+nm_setting_ip6_config_new (void);
+

Creates a new NMSettingIP6Config object with default values.

+
+

Returns

+

the new empty NMSettingIP6Config object.

+

[transfer full]

+
+ +
+
+

nm_setting_ip6_config_get_method ()

+
const char *
+nm_setting_ip6_config_get_method (NMSettingIP6Config *setting);
+
+

Parameters

+
--+++ - - + + +

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 
+
+

Returns

+

the “method” property of the setting

+

+
+
-

nm_ip6_route_unref ()

-
void                nm_ip6_route_unref                  (NMIP6Route *route);
-

-Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed. -

-
+

nm_setting_ip6_config_get_num_dns ()

+
guint32
+nm_setting_ip6_config_get_num_dns (NMSettingIP6Config *setting);
+
+

Parameters

+
--+++ - - + + +

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 
+
+

Returns

+

the number of configured DNS servers

+

+
+
-

nm_ip6_route_compare ()

-
gboolean            nm_ip6_route_compare                (NMIP6Route *route,
-                                                         NMIP6Route *other);
-

-Determines if two NMIP6Route objects contain the same values. -

-
+

nm_setting_ip6_config_get_dns ()

+
const struct in6_addr *
+nm_setting_ip6_config_get_dns (NMSettingIP6Config *setting,
+                               guint32 i);
+
+

Parameters

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

route :

the NMIP6Route -

other :

the NMIP6Route to compare route to.

setting

the NMSettingIP6Config

 

Returns :

 -TRUE if the objects contain the same values, FALSE if they do not.

i

index number of the DNS server to return

 
+
+

Returns

+

the IPv6 address of the DNS server at index i +.

+

[transfer none]

+
+
-

nm_ip6_route_get_dest ()

-
const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);
-

-Gets the IPv6 destination address property of this route object. -

-
+

nm_setting_ip6_config_add_dns ()

+
gboolean
+nm_setting_ip6_config_add_dns (NMSettingIP6Config *setting,
+                               const struct in6_addr *dns);
+

Adds a new DNS server to the setting.

+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

Returns :

the IPv6 address

dns

the IPv6 address of the DNS server to add

 
+
+

Returns

+

TRUE if the DNS server was added; FALSE if the server was already +known

+

+
+
-

nm_ip6_route_set_dest ()

-
void                nm_ip6_route_set_dest               (NMIP6Route *route,
-                                                         const struct in6_addr *dest);
-

-Sets the IPv6 destination address property of this route object. -

-
+

nm_setting_ip6_config_remove_dns ()

+
void
+nm_setting_ip6_config_remove_dns (NMSettingIP6Config *setting,
+                                  guint32 i);
+

Removes the DNS server at index i +.

+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

dest :

the destination address

i

index number of the DNS server to remove

 
+
-

nm_ip6_route_get_prefix ()

-
guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);
-

-Gets the IPv6 prefix (ie "32" or "64" etc) of this route. -

-
+

nm_setting_ip6_config_clear_dns ()

+
void
+nm_setting_ip6_config_clear_dns (NMSettingIP6Config *setting);
+

Removes all configured DNS servers.

+
+

Parameters

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

setting

the NMSettingIP6Config

 
+
+ +
+
+

nm_setting_ip6_config_get_num_dns_searches ()

+
guint32
+nm_setting_ip6_config_get_num_dns_searches
+                               (NMSettingIP6Config *setting);
+
+

Parameters

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

setting

the NMSettingIP6Config

 
+
+
+

Returns

+

the number of configured DNS search domains

+

+
+
+
+
+

nm_setting_ip6_config_get_dns_search ()

+
const char *
+nm_setting_ip6_config_get_dns_search (NMSettingIP6Config *setting,
+                                      guint32 i);
+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

Returns :

the IPv6 prefix

i

index number of the DNS search domain to return

 
+
+

Returns

+

the DNS search domain at index i +

+

+
+
-

nm_ip6_route_set_prefix ()

-
void                nm_ip6_route_set_prefix             (NMIP6Route *route,
-                                                         guint32 prefix);
-

-Sets the IPv6 prefix of this route. -

-
+

nm_setting_ip6_config_add_dns_search ()

+
gboolean
+nm_setting_ip6_config_add_dns_search (NMSettingIP6Config *setting,
+                                      const char *dns_search);
+

Adds a new DNS search domain to the setting.

+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

prefix :

the prefix, a number between 1 and 128 inclusive

dns_search

the search domain to add

 
+
+

Returns

+

TRUE if the DNS search domain was added; FALSE if the search +domain was already known

+

+
+
-

nm_ip6_route_get_next_hop ()

-
const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);
-

-Gets the IPv6 address of the next hop of this route. -

-
+

nm_setting_ip6_config_remove_dns_search ()

+
void
+nm_setting_ip6_config_remove_dns_search
+                               (NMSettingIP6Config *setting,
+                                guint32 i);
+

Removes the DNS search domain at index i +.

+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

Returns :

the IPv6 address

i

index number of the DNS search domain

 
+
-

nm_ip6_route_set_next_hop ()

-
void                nm_ip6_route_set_next_hop           (NMIP6Route *route,
-                                                         const struct in6_addr *next_hop);
-

-Sets the IPv6 address of the next hop of this route. -

-
+

nm_setting_ip6_config_clear_dns_searches ()

+
void
+nm_setting_ip6_config_clear_dns_searches
+                               (NMSettingIP6Config *setting);
+

Removes all configured DNS search domains.

+
+

Parameters

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

setting

the NMSettingIP6Config

 
+
+ +
+
+

nm_setting_ip6_config_get_num_addresses ()

+
guint32
+nm_setting_ip6_config_get_num_addresses
+                               (NMSettingIP6Config *setting);
+
+

Parameters

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

setting

the NMSettingIP6Config

 
+
+
+

Returns

+

the number of configured addresses

+

+
+
+
+
+

nm_setting_ip6_config_get_address ()

+
NMIP6Address *
+nm_setting_ip6_config_get_address (NMSettingIP6Config *setting,
+                                   guint32 i);
+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

next_hop :

the IPv6 address of the next hop

i

index number of the address to return

 
+
+

Returns

+

the address at index i +

+

+
+
-

nm_ip6_route_get_metric ()

-
guint32             nm_ip6_route_get_metric             (NMIP6Route *route);
-

-Gets the route metric property of this route object; lower values indicate -"better" or more preferred routes. -

-
+

nm_setting_ip6_config_add_address ()

+
gboolean
+nm_setting_ip6_config_add_address (NMSettingIP6Config *setting,
+                                   NMIP6Address *address);
+

Adds a new IPv6 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function.

+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

Returns :

the route metric

address

the new address to add

 
+
+

Returns

+

TRUE if the address was added; FALSE if the address was already +known.

+

+
+
-

nm_ip6_route_set_metric ()

-
void                nm_ip6_route_set_metric             (NMIP6Route *route,
-                                                         guint32 metric);
-

-Sets the route metric property of this route object; lower values indicate -"better" or more preferred routes. -

-
+

nm_setting_ip6_config_remove_address ()

+
void
+nm_setting_ip6_config_remove_address (NMSettingIP6Config *setting,
+                                      guint32 i);
+

Removes the address at index i +.

+
+

Parameters

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

route :

the NMIP6Route -

setting

the NMSettingIP6Config

 

metric :

the route metric

i

index number of the address to remove

 
-
-
-

NMSettingIP6Config

-
typedef struct _NMSettingIP6Config NMSettingIP6Config;
-

-

-
-
-
-

NMSettingIP6ConfigClass

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

-

-

nm_setting_ip6_config_new ()

-
NMSetting *         nm_setting_ip6_config_new           (void);
-

-Creates a new NMSettingIP6Config object with default values. -

-
+

nm_setting_ip6_config_clear_addresses ()

+
void
+nm_setting_ip6_config_clear_addresses (NMSettingIP6Config *setting);
+

Removes all configured addresses.

+
+

Parameters

+
--+++ - - + + +

Returns :

the new empty NMSettingIP6Config object. [transfer full] -

setting

the NMSettingIP6Config

 
+
-

nm_setting_ip6_config_get_method ()

-
const char *        nm_setting_ip6_config_get_method    (NMSettingIP6Config *setting);
-
+

nm_setting_ip6_config_get_num_routes ()

+
guint32
+nm_setting_ip6_config_get_num_routes (NMSettingIP6Config *setting);
+
+

Parameters

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

setting :

the NMSettingIP6Config -

Returns :

the "method" property of the setting

setting

the NMSettingIP6Config

 
+
+

Returns

+

the number of configured routes

+

+
+
-

nm_setting_ip6_config_get_num_dns ()

-
guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
-
+

nm_setting_ip6_config_get_route ()

+
NMIP6Route *
+nm_setting_ip6_config_get_route (NMSettingIP6Config *setting,
+                                 guint32 i);
+
+

Parameters

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

setting :

the NMSettingIP6Config -

setting

the NMSettingIP6Config

 

Returns :

the number of configured DNS servers

i

index number of the route to return

 
+
+

Returns

+

the route at index i +

+

+
+
-

nm_setting_ip6_config_get_dns ()

-
const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip6_config_add_route ()

+
gboolean
+nm_setting_ip6_config_add_route (NMSettingIP6Config *setting,
+                                 NMIP6Route *route);
+

Adds a new IPv6 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

+
+

Parameters

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

setting :

the NMSettingIP6Config -

i :

index number of the DNS server to return

setting

the NMSettingIP6Config

 

Returns :

the IPv6 address of the DNS server at index i. [transfer none] -

route

the route to add

 
+
+

Returns

+

TRUE if the route was added; FALSE if the route was already known.

+

+
+
-

nm_setting_ip6_config_add_dns ()

-
gboolean            nm_setting_ip6_config_add_dns       (NMSettingIP6Config *setting,
-                                                         const struct in6_addr *dns);
-

-Adds a new DNS server to the setting. -

-
+

nm_setting_ip6_config_remove_route ()

+
void
+nm_setting_ip6_config_remove_route (NMSettingIP6Config *setting,
+                                    guint32 i);
+

Removes the route at index i +.

+
+

Parameters

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

setting :

the NMSettingIP6Config -

dns :

the IPv6 address of the DNS server to add

setting

the NMSettingIP6Config

 

Returns :

 -TRUE if the DNS server was added; FALSE if the server was already -known

i

index number of the route

 
+
-

nm_setting_ip6_config_remove_dns ()

-
void                nm_setting_ip6_config_remove_dns    (NMSettingIP6Config *setting,
-                                                         guint32 i);
-

-Removes the DNS server at index i. -

-
+

nm_setting_ip6_config_clear_routes ()

+
void
+nm_setting_ip6_config_clear_routes (NMSettingIP6Config *setting);
+

Removes all configured routes.

+
+

Parameters

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

setting :

the NMSettingIP6Config -

i :

index number of the DNS server to remove

setting

the NMSettingIP6Config

 
+
-

nm_setting_ip6_config_clear_dns ()

-
void                nm_setting_ip6_config_clear_dns     (NMSettingIP6Config *setting);
-

-Removes all configured DNS servers. -

-
+

nm_setting_ip6_config_get_ignore_auto_routes ()

+
gboolean
+nm_setting_ip6_config_get_ignore_auto_routes
+                               (NMSettingIP6Config *setting);
+

Returns the value contained in the “ignore-auto-routes” +property.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSettingIP6Config -

setting

the NMSettingIP6Config

 
+
+

Returns

+

TRUE if automatically configured (ie via DHCP) routes should be +ignored.

+

+
+
-

nm_setting_ip6_config_get_num_dns_searches ()

-
guint32             nm_setting_ip6_config_get_num_dns_searches
-                                                        (NMSettingIP6Config *setting);
-
+

nm_setting_ip6_config_get_ignore_auto_dns ()

+
gboolean
+nm_setting_ip6_config_get_ignore_auto_dns
+                               (NMSettingIP6Config *setting);
+

Returns the value contained in the “ignore-auto-dns” +property.

+
+

Parameters

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

setting :

the NMSettingIP6Config -

Returns :

the number of configured DNS search domains

setting

the NMSettingIP6Config

 
+
+

Returns

+

TRUE if automatically configured (ie via DHCP or router +advertisements) DNS information should be ignored.

+

+
+
-

nm_setting_ip6_config_get_dns_search ()

-
const char *        nm_setting_ip6_config_get_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip6_config_get_dhcp_hostname ()

+
const char *
+nm_setting_ip6_config_get_dhcp_hostname
+                               (NMSettingIP6Config *setting);
+

Returns the value contained in the “dhcp-hostname” +property.

+
+

Parameters

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

setting :

the NMSettingIP6Config -

i :

index number of the DNS search domain to return

Returns :

the DNS search domain at index i -

setting

the NMSettingIP6Config

 
+
+

Returns

+

the configured hostname to send to the DHCP server

+

+
+

Since 0.9.8

+
-

nm_setting_ip6_config_add_dns_search ()

-
gboolean            nm_setting_ip6_config_add_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         const char *dns_search);
-

-Adds a new DNS search domain to the setting. -

-
+

nm_setting_ip6_config_get_never_default ()

+
gboolean
+nm_setting_ip6_config_get_never_default
+                               (NMSettingIP6Config *setting);
+

Returns the value contained in the “never-default” +property.

+
+

Parameters

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

setting :

the NMSettingIP6Config -

dns_search :

the search domain to add

Returns :

 -TRUE if the DNS search domain was added; FALSE if the search -domain was already known

setting

the NMSettingIP6Config

 
+
+

Returns

+

TRUE if this connection should never be the default connection +for IPv6 addressing

+

+
+
-

nm_setting_ip6_config_remove_dns_search ()

-
void                nm_setting_ip6_config_remove_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-

-Removes the DNS search domain at index i. -

-
+

nm_setting_ip6_config_get_may_fail ()

+
gboolean
+nm_setting_ip6_config_get_may_fail (NMSettingIP6Config *setting);
+

Returns the value contained in the “may-fail” +property.

+
+

Parameters

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

setting :

the NMSettingIP6Config -

i :

index number of the DNS search domain

setting

the NMSettingIP6Config

 
+
+

Returns

+

TRUE if this connection doesn't require IPv6 addressing to complete +for the connection to succeed.

+

+
+
-

nm_setting_ip6_config_clear_dns_searches ()

-
void                nm_setting_ip6_config_clear_dns_searches
-                                                        (NMSettingIP6Config *setting);
-

-Removes all configured DNS search domains. -

-
+

nm_setting_ip6_config_get_ip6_privacy ()

+
NMSettingIP6ConfigPrivacy
+nm_setting_ip6_config_get_ip6_privacy (NMSettingIP6Config *setting);
+

Returns the value contained in the “ip6-privacy” +property.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSettingIP6Config -

setting

the NMSettingIP6Config

 
+
+

Returns

+

IPv6 Privacy Extensions configuration value (NMSettingIP6ConfigPrivacy).

+

+
+ + +
+

Types and Values

+
+

NM_SETTING_IP6_CONFIG_SETTING_NAME

+
#define NM_SETTING_IP6_CONFIG_SETTING_NAME "ipv6"
+
+

+

+
-

nm_setting_ip6_config_get_num_addresses ()

-
guint32             nm_setting_ip6_config_get_num_addresses
-                                                        (NMSettingIP6Config *setting);
-
+

enum NMSettingIP6ConfigError

+
+

Members

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

setting :

the NMSettingIP6Config +

NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

the number of configured addresses
-
-
-
-

nm_setting_ip6_config_get_address ()

-
NMIP6Address *      nm_setting_ip6_config_get_address   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-
---- - - - - + + - - + + + - - + +

setting :

the NMSettingIP6Config +

NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

i :

index number of the address to return

NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 

Returns :

the address at index i +

NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD

 +

the property's value is +not valid with the given IPv6 method

 
+
-

nm_setting_ip6_config_add_address ()

-
gboolean            nm_setting_ip6_config_add_address   (NMSettingIP6Config *setting,
-                                                         NMIP6Address *address);
+

NM_SETTING_IP6_CONFIG_ERROR

+
#define NM_SETTING_IP6_CONFIG_ERROR nm_setting_ip6_config_error_quark ()
+

-Adds a new IPv6 address and associated information to the setting. The -given address is duplicated internally and is not changed by this function.

-
---- - - - - - - - - - - - - - - -

setting :

the NMSettingIP6Config -

address :

the new address to add

Returns :

 -TRUE if the address was added; FALSE if the address was already -known.
-

nm_setting_ip6_config_remove_address ()

-
void                nm_setting_ip6_config_remove_address
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
+

NM_SETTING_IP6_CONFIG_METHOD

+
#define NM_SETTING_IP6_CONFIG_METHOD             "method"
+

-Removes the address at index i.

-
---- - - - - - - - - - - -

setting :

the NMSettingIP6Config -

i :

index number of the address to remove
-

nm_setting_ip6_config_clear_addresses ()

-
void                nm_setting_ip6_config_clear_addresses
-                                                        (NMSettingIP6Config *setting);
+

NM_SETTING_IP6_CONFIG_DNS

+
#define NM_SETTING_IP6_CONFIG_DNS                "dns"
+

-Removes all configured addresses.

-
---- - - - - -

setting :

the NMSettingIP6Config -
-

nm_setting_ip6_config_get_num_routes ()

-
guint32             nm_setting_ip6_config_get_num_routes
-                                                        (NMSettingIP6Config *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingIP6Config -

Returns :

the number of configured routes
+

NM_SETTING_IP6_CONFIG_DNS_SEARCH

+
#define NM_SETTING_IP6_CONFIG_DNS_SEARCH         "dns-search"
+
+

+

-

nm_setting_ip6_config_get_route ()

-
NMIP6Route *        nm_setting_ip6_config_get_route     (NMSettingIP6Config *setting,
-                                                         guint32 i);
-
---- - - - - - - - - - - - - - - -

setting :

the NMSettingIP6Config -

i :

index number of the route to return

Returns :

the route at index i -
+

NM_SETTING_IP6_CONFIG_ADDRESSES

+
#define NM_SETTING_IP6_CONFIG_ADDRESSES          "addresses"
+
+

+

-

nm_setting_ip6_config_add_route ()

-
gboolean            nm_setting_ip6_config_add_route     (NMSettingIP6Config *setting,
-                                                         NMIP6Route *route);
+

NM_SETTING_IP6_CONFIG_ROUTES

+
#define NM_SETTING_IP6_CONFIG_ROUTES             "routes"
+

-Adds a new IPv6 route and associated information to the setting. The -given route is duplicated internally and is not changed by this function.

-
---- - - - - - - - - - - - - - - -

setting :

the NMSettingIP6Config -

route :

the route to add

Returns :

 -TRUE if the route was added; FALSE if the route was already known.
-

nm_setting_ip6_config_remove_route ()

-
void                nm_setting_ip6_config_remove_route  (NMSettingIP6Config *setting,
-                                                         guint32 i);
+

NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES

+
#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
+

-Removes the route at index i.

-
---- - - - - - - - - - - -

setting :

the NMSettingIP6Config -

i :

index number of the route
-

nm_setting_ip6_config_clear_routes ()

-
void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);
+

NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS

+
#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+

-Removes all configured routes.

-
---- - - - - -

setting :

the NMSettingIP6Config -
-

nm_setting_ip6_config_get_ignore_auto_routes ()

-
gboolean            nm_setting_ip6_config_get_ignore_auto_routes
-                                                        (NMSettingIP6Config *setting);
+

NM_SETTING_IP6_CONFIG_NEVER_DEFAULT

+
#define NM_SETTING_IP6_CONFIG_NEVER_DEFAULT      "never-default"
+

-Returns the value contained in the "ignore-auto-routes" -property.

-
---- - - - - - - - - - - -

setting :

the NMSettingIP6Config -

Returns :

 -TRUE if automatically configured (ie via DHCP) routes should be -ignored.
-

nm_setting_ip6_config_get_ignore_auto_dns ()

-
gboolean            nm_setting_ip6_config_get_ignore_auto_dns
-                                                        (NMSettingIP6Config *setting);
+

NM_SETTING_IP6_CONFIG_MAY_FAIL

+
#define NM_SETTING_IP6_CONFIG_MAY_FAIL           "may-fail"
+

-Returns the value contained in the "ignore-auto-dns" -property.

-
---- - - - - - - - - - - -

setting :

the NMSettingIP6Config -

Returns :

 -TRUE if automatically configured (ie via DHCP or router -advertisements) DNS information should be ignored.
-

nm_setting_ip6_config_get_dhcp_hostname ()

-
const char *        nm_setting_ip6_config_get_dhcp_hostname
-                                                        (NMSettingIP6Config *setting);
+

NM_SETTING_IP6_CONFIG_IP6_PRIVACY

+
#define NM_SETTING_IP6_CONFIG_IP6_PRIVACY        "ip6-privacy"
+

-Returns the value contained in the "dhcp-hostname" -property.

-
---- - - - - - - - - - - -

setting :

the NMSettingIP6Config -

Returns :

the configured hostname to send to the DHCP server
-

Since 0.9.8

-

nm_setting_ip6_config_get_never_default ()

-
gboolean            nm_setting_ip6_config_get_never_default
-                                                        (NMSettingIP6Config *setting);
+

NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME

+
#define NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+

-Returns the value contained in the "never-default" -property.

-
---- - - - - - - - - - - -

setting :

the NMSettingIP6Config -

Returns :

 -TRUE if this connection should never be the default connection -for IPv6 addressing
-

nm_setting_ip6_config_get_may_fail ()

-
gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);
-

-Returns the value contained in the "may-fail" -property. -

-
+

NM_SETTING_IP6_CONFIG_METHOD_IGNORE

+
#define NM_SETTING_IP6_CONFIG_METHOD_IGNORE     "ignore"
+
+

IPv6 is not required or is handled by some other mechanism, and NetworkManager +should not configure IPv6 for this connection.

+ +
+
+

NM_SETTING_IP6_CONFIG_METHOD_AUTO

+
#define NM_SETTING_IP6_CONFIG_METHOD_AUTO       "auto"
+
+

IPv6 configuration should be automatically determined via a method appropriate +for the hardware interface, ie router advertisements, DHCP, or PPP or some +other device-specific manner.

+
+
+
+

NM_SETTING_IP6_CONFIG_METHOD_DHCP

+
#define NM_SETTING_IP6_CONFIG_METHOD_DHCP       "dhcp"
+
+

IPv6 configuration should be automatically determined via DHCPv6 only and +router advertisements should be ignored.

+
+
+
+

NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL

+
#define NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL "link-local"
+
+

IPv6 configuration should be automatically configured for link-local-only +operation.

+
+
+
+

NM_SETTING_IP6_CONFIG_METHOD_MANUAL

+
#define NM_SETTING_IP6_CONFIG_METHOD_MANUAL     "manual"
+
+

All necessary IPv6 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties.

+
+
+
+

NM_SETTING_IP6_CONFIG_METHOD_SHARED

+
#define NM_SETTING_IP6_CONFIG_METHOD_SHARED     "shared"
+
+

This connection specifies configuration that allows other computers to +connect through it to the default network (usually the Internet). The +connection's interface will be assigned a private address, and router +advertisements, a caching DNS server, and Network Address Translation (NAT) +functionality will be started on this connection's interface to allow other +devices to connect through that interface to the default network. (not yet +supported for IPv6)

+
+
+
+

enum NMSettingIP6ConfigPrivacy

+

NMSettingIP6ConfigPrivacy values indicate if and how IPv6 Privacy +Extensions are used (RFC4941).

+
+

Members

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

setting :

the NMSettingIP6Config +

NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN

 +

unknown or no value specified

 

Returns :

 -TRUE if this connection doesn't require IPv6 addressing to complete -for the connection to succeed.

NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED

 +

IPv6 Privacy Extensions are disabled

+		 
-
-
-
-

nm_setting_ip6_config_get_ip6_privacy ()

-
NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
-                                                        (NMSettingIP6Config *setting);
-

-Returns the value contained in the "ip6-privacy" -property. -

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

setting :

the NMSettingIP6Config +

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR

 +

IPv6 Privacy Extensions +are enabled, but public addresses are preferred over temporary addresses

 

Returns :

IPv6 Privacy Extensions configuration value (NMSettingIP6ConfigPrivacy).

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR

 +

IPv6 Privacy Extensions +are enabled and temporary addresses are preferred over public addresses

+		 
+

Property Details

-

The "addresses" property

-
  "addresses"                GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*  : Read / Write
-

-Array of IPv6 address structures. Each IPv6 address structure is -composed of 3 members, the first being a byte array containing the IPv6 -address (network byte order), the second a 32-bit integer containing the -IPv6 address prefix, and the third a byte array containing the IPv6 -address (network byte order) of the gateway associated with this address, -if any. If no gateway is given, the third element should be given as -all zeros. For the 'auto' method, given IP addresses are appended to -those returned by automatic configuration. Addresses cannot be used with -the 'shared' or 'link-local' methods as the interface is automatically -assigned an address with these methods. -

+

The “addresses” property

+
  “addresses”                GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*
+

Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.

+

Flags: Read / Write

-

The "dhcp-hostname" property

-
  "dhcp-hostname"            gchar*                : Read / Write
-

-The specified name will be sent to the DHCP server when acquiring a lease. -

+

The “dhcp-hostname” property

+
  “dhcp-hostname”            gchar *
+

The specified name will be sent to the DHCP server when acquiring a lease.

+

Flags: Read / Write

Default value: NULL

Since 0.9.8

-

The "dns" property

-
  "dns"                      GPtrArray_GArray_guchar__*  : Read / Write
-

-Array of DNS servers, where each member of the array is a byte array -containing the IPv6 address of the DNS server (in network byte order). -For the 'auto' method, these DNS servers are appended to those (if any) -returned by automatic configuration. DNS servers cannot be used with -the 'shared' or 'link-local' methods as there is no usptream network. In -all other methods, these DNS servers are used as the only DNS servers for -this connection. -

+

The “dns” property

+
  “dns”                      GPtrArray_GArray_guchar__ *
+

Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.

+

Flags: Read / Write

-

The "dns-search" property

-
  "dns-search"               GSList_gchararray_*   : Read / Write
-

-List of DNS search domains. For the 'auto' method, these search domains -are appended to those returned by automatic configuration. Search domains -cannot be used with the 'shared' or 'link-local' methods as there is no -upstream network. In all other methods, these search domains are used -as the only search domains for this connection. -

+

The “dns-search” property

+
  “dns-search”               GSList_gchararray_ *
+

List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.

+

Flags: Read / Write

-

The "ignore-auto-dns" property

-
  "ignore-auto-dns"          gboolean              : Read / Write / Construct
-

-When the method is set to 'auto' or 'dhcp' and this property is set to -TRUE, automatically configured nameservers and search domains are ignored -and only nameservers and search domains specified in -"dns" and "dns-search", if any, are -used. -

+

The “ignore-auto-dns” property

+
  “ignore-auto-dns”          gboolean
+

When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.

+

Flags: Read / Write / Construct

Default value: FALSE

-

The "ignore-auto-routes" property

-
  "ignore-auto-routes"       gboolean              : Read / Write / Construct
-

-When the method is set to 'auto' or 'dhcp' and this property is set to -TRUE, automatically configured routes are ignored and only routes -specified in "routes", if any, are used. -

+

The “ignore-auto-routes” property

+
  “ignore-auto-routes”       gboolean
+

When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.

+

Flags: Read / Write / Construct

Default value: FALSE

-

The "ip6-privacy" property

-
  "ip6-privacy"              gint                  : Read / Write / Construct
-

-Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. -If enabled, it makes the kernel generate a temporary IPv6 address -in addition to the public one generated from MAC address via -modified EUI-64. This enhances privacy, but could cause problems -in some applications, on the other hand. The permitted values -are: 0: disabled, 1: enabled (prefer public address), -2: enabled (prefer temporary addresses). -

+

The “ip6-privacy” property

+
  “ip6-privacy”              gint
+

Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).

+

Flags: Read / Write / Construct

Allowed values: [-1,2]

Default value: -1

-

The "may-fail" property

-
  "may-fail"                 gboolean              : Read / Write / Construct
-

-If TRUE, allow overall network configuration to proceed even if IPv6 -configuration times out. Note that at least one IP configuration -must succeed or overall network configuration will still fail. For -example, in IPv4-only networks, setting this property to TRUE allows -the overall network configuration to succeed if IPv6 configuration fails -but IPv4 configuration completes successfully. -

+

The “may-fail” property

+
  “may-fail”                 gboolean
+

If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.

+

Flags: Read / Write / Construct

Default value: TRUE

-

The "method" property

-
  "method"                   gchar*                : Read / Write
-

-IPv6 configuration method. If 'auto' is specified then the appropriate -automatic method (DHCP, PPP, advertisement, etc) is used for the -interface and most other properties can be left unset. To force the use -of DHCP only, specify 'dhcp'; this method is only valid for ethernet- -based hardware. If 'link-local' is specified, then an IPv6 link-local -address will be assigned to the interface. If 'manual' is specified, -static IP addressing is used and at least one IP address must be given -in the 'addresses' property. If 'ignore' is specified, IPv6 -configuration is not done. This property must be set. NOTE: the 'shared' -method are not yet supported. -

+

The “method” property

+
  “method”                   gchar *
+

IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' methodis not yet supported.

+

Flags: Read / Write

Default value: NULL

-

The "never-default" property

-
  "never-default"            gboolean              : Read / Write / Construct
-

-If TRUE, this connection will never be the default IPv6 connection, -meaning it will never be assigned the default IPv6 route by NetworkManager. -

+

The “never-default” property

+
  “never-default”            gboolean
+

If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.

+

Flags: Read / Write / Construct

Default value: FALSE

-

The "routes" property

-
  "routes"                   GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*  : Read / Write
-

-Array of IPv6 route structures. Each IPv6 route structure is composed -of 4 members; the first being the destination IPv6 network or -address (network byte order) as a byte array, the second the destination -network or address IPv6 prefix, the third being the next-hop IPv6 address -(network byte order) if any, and the fourth being the route metric. For -the 'auto' method, given IP routes are appended to those returned by -automatic configuration. Routes cannot be used with the 'shared' or -'link-local' methods because there is no upstream network. -

+

The “routes” property

+
  “routes”                   GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*
+

Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.

+

Flags: Read / Write

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingInfiniband.html b/docs/libnm-util/html/NMSettingInfiniband.html index a5c4b46c..aa2612f8 100644 --- a/docs/libnm-util/html/NMSettingInfiniband.html +++ b/docs/libnm-util/html/NMSettingInfiniband.html @@ -2,34 +2,28 @@ -NMSettingInfiniband +libnm-util Reference Manual: NMSettingInfiniband - + - - - - - - - - - - + + + + + + +
@@ -37,300 +31,355 @@

NMSettingInfiniband

NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks

- +
-
-

Synopsis

-
-#include <nm-setting-infiniband.h>
-
-#define             NM_SETTING_INFINIBAND_SETTING_NAME
-enum                NMSettingInfinibandError;
-#define             NM_SETTING_INFINIBAND_ERROR
-GQuark              nm_setting_infiniband_error_quark   (void);
-#define             NM_SETTING_INFINIBAND_MAC_ADDRESS
-#define             NM_SETTING_INFINIBAND_MTU
-#define             NM_SETTING_INFINIBAND_TRANSPORT_MODE
-                    NMSettingInfiniband;
-                    NMSettingInfinibandClass;
-NMSetting *         nm_setting_infiniband_new           (void);
-const GByteArray *  nm_setting_infiniband_get_mac_address
-                                                        (NMSettingInfiniband *setting);
-guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);
-const char *        nm_setting_infiniband_get_transport_mode
-                                                        (NMSettingInfiniband *setting);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingInfinibandError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingInfiniband
-
-
-
-

Properties

-
-  "mac-address"              GArray_guchar_*       : Read / Write
-  "mtu"                      guint                 : Read / Write / Construct
-  "transport-mode"           gchar*                : Read / Write / Construct
-
-
-
-

Description

-

-The NMSettingInfiniband object is a NMSetting subclass that describes properties -necessary for connection to IP-over-InfiniBand networks. -

-
-

Details

-
-

NM_SETTING_INFINIBAND_SETTING_NAME

-
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
-
-

-

-
-
-
-

enum NMSettingInfinibandError

-
typedef enum {
-	NM_SETTING_INFINIBAND_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
-} NMSettingInfinibandError;
-
-
+

Functions

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

NM_SETTING_INFINIBAND_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_infiniband_error_quark () +
+NMSetting * + +nm_setting_infiniband_new ()

NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY

the property was invalid +const GByteArray * + +nm_setting_infiniband_get_mac_address ()

NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY

the property was missing and is -required + +guint32 + +nm_setting_infiniband_get_mtu () +
const char * + +nm_setting_infiniband_get_transport_mode ()
-
-
-

NM_SETTING_INFINIBAND_ERROR

-
#define NM_SETTING_INFINIBAND_ERROR nm_setting_infiniband_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + +
+GArray_guchar_ *mac-addressRead / Write
guintmtuRead / Write / Construct
+gchar *transport-modeRead / Write / Construct
-
-
-

nm_setting_infiniband_error_quark ()

-
GQuark              nm_setting_infiniband_error_quark   (void);
-

-Registers an error quark for NMSettingInfiniband if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingInfiniband errors.
#defineNM_SETTING_INFINIBAND_SETTING_NAME
enumNMSettingInfinibandError
#defineNM_SETTING_INFINIBAND_ERROR
#defineNM_SETTING_INFINIBAND_MAC_ADDRESS
#defineNM_SETTING_INFINIBAND_MTU
#defineNM_SETTING_INFINIBAND_TRANSPORT_MODE
-
-
-

NM_SETTING_INFINIBAND_MAC_ADDRESS

-
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingInfinibandError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingInfiniband
 

-

-

 

-

-

-
NM_SETTING_INFINIBAND_MTU

-
#define NM_SETTING_INFINIBAND_MTU            "mtu"
+

+
Includes

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

-

-

 

-

-

-
NM_SETTING_INFINIBAND_TRANSPORT_MODE

-
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
-

-

-

+

+
Description

+
The NMSettingInfiniband object is a NMSetting subclass that describes properties
+necessary for connection to IP-over-InfiniBand networks.

 

-

+

+
Functions

 

-
NMSettingInfiniband

-
typedef struct _NMSettingInfiniband NMSettingInfiniband;

-

-

+
nm_setting_infiniband_error_quark ()

+
GQuark
+nm_setting_infiniband_error_quark (void);

+
Registers an error quark for NMSettingInfiniband if necessary.

+

+
Returns

+
 the error quark used for NMSettingInfiniband errors.

+

+

 

 

 

-
NMSettingInfinibandClass

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

-

-

+
nm_setting_infiniband_new ()

+
NMSetting *
+nm_setting_infiniband_new (void);

+
Creates a new NMSettingInfiniband object with default values.

+

+
Returns

+
 the new empty NMSettingInfiniband object. 

+
[transfer full]

+

 

 

 

-
nm_setting_infiniband_new ()

-
NMSetting *         nm_setting_infiniband_new           (void);

-

-Creates a new NMSettingInfiniband object with default values.
-

-

+
nm_setting_infiniband_get_mac_address ()

+
const GByteArray *
+nm_setting_infiniband_get_mac_address (NMSettingInfiniband *setting);

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingInfiniband object. [transfer full]
-
setting
the NMSettingInfiniband
 
 

 

 

+

+
Returns

+
 the “mac-address” property of the setting

+

+

+

 

 

-
nm_setting_infiniband_get_mac_address ()

-
const GByteArray *  nm_setting_infiniband_get_mac_address
-                                                        (NMSettingInfiniband *setting);

-

+
nm_setting_infiniband_get_mtu ()

+
guint32
+nm_setting_infiniband_get_mtu (NMSettingInfiniband *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingInfiniband
-
Returns :
the "mac-address" property of the setting
setting
the NMSettingInfiniband
 

 

 

+

+
Returns

+
 the “mtu” property of the setting

+

+

+

 

 

-
nm_setting_infiniband_get_mtu ()

-
guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);

-

+
nm_setting_infiniband_get_transport_mode ()

+
const char *
+nm_setting_infiniband_get_transport_mode
+                               (NMSettingInfiniband *setting);

+
Returns the transport mode for this device. Either 'datagram' or
+'connected'.

+

+
Parameters

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

 





 
setting :
the NMSettingInfiniband
-
Returns :
the "mtu" property of the setting
setting
the NMSettingInfiniband
 

 

 

-

+

+
Returns

+
 the IPoIB transport mode

+

+

+

+
+
+

Types and Values

-

nm_setting_infiniband_get_transport_mode ()

-
const char *        nm_setting_infiniband_get_transport_mode
-                                                        (NMSettingInfiniband *setting);
+

NM_SETTING_INFINIBAND_SETTING_NAME

+
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
+

-Returns the transport mode for this device. Either 'datagram' or -'connected'.

-
+ +
+
+

enum NMSettingInfinibandError

+
+

Members

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

setting :

the NMSettingInfiniband +

NM_SETTING_INFINIBAND_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

the IPoIB transport mode

NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY

 +

the property was invalid

+		 

NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 
-
-

Property Details

+
-

The "mac-address" property

-
  "mac-address"              GArray_guchar_*       : Read / Write
+

NM_SETTING_INFINIBAND_ERROR

+
#define NM_SETTING_INFINIBAND_ERROR nm_setting_infiniband_error_quark ()
+

-If specified, this connection will only apply to the IPoIB -device whose permanent MAC address matches. This property does -not change the MAC address of the device (i.e. MAC spoofing).

-

The "mtu" property

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

NM_SETTING_INFINIBAND_MAC_ADDRESS

+
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
+

-If non-zero, only transmit packets of the specified size or smaller, -breaking larger packets up into multiple frames.

-

Default value: 0

-

The "transport-mode" property

-
  "transport-mode"           gchar*                : Read / Write / Construct
+

NM_SETTING_INFINIBAND_MTU

+
#define NM_SETTING_INFINIBAND_MTU            "mtu"
+
+

+

+
+
+
+

NM_SETTING_INFINIBAND_TRANSPORT_MODE

+
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
+

-The IP-over-InfiniBand transport mode. Either 'datagram' or -'connected'.

+
+
+
+

Property Details

+
+

The “mac-address” property

+
  “mac-address”              GArray_guchar_ *
+

If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

+

Flags: Read / Write

+
+
+
+

The “mtu” property

+
  “mtu”                      guint
+

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “transport-mode” property

+
  “transport-mode”           gchar *
+

The IPoIB transport mode. Either 'datagram' or 'connected'.

+

Flags: Read / Write / Construct

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingOlpcMesh.html b/docs/libnm-util/html/NMSettingOlpcMesh.html index 4b622152..59c0ad6f 100644 --- a/docs/libnm-util/html/NMSettingOlpcMesh.html +++ b/docs/libnm-util/html/NMSettingOlpcMesh.html @@ -2,34 +2,28 @@ -NMSettingOlpcMesh +libnm-util Reference Manual: NMSettingOlpcMesh - + - - - - - - - - - - + + + + + + +
@@ -37,193 +31,274 @@

NMSettingOlpcMesh

NMSettingOlpcMesh

- +
-
-

Synopsis

-
#define             NM_SETTING_OLPC_MESH_SETTING_NAME
-enum                NMSettingOlpcMeshError;
-#define             NM_SETTING_OLPC_MESH_ERROR
-GQuark              nm_setting_olpc_mesh_error_quark    (void);
-#define             NM_SETTING_OLPC_MESH_SSID
-#define             NM_SETTING_OLPC_MESH_CHANNEL
-#define             NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS
-                    NMSettingOlpcMesh;
-                    NMSettingOlpcMeshClass;
-NMSetting *         nm_setting_olpc_mesh_new            (void);
-const GByteArray *  nm_setting_olpc_mesh_get_ssid       (NMSettingOlpcMesh *setting);
-guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);
-const GByteArray *  nm_setting_olpc_mesh_get_dhcp_anycast_address
-                                                        (NMSettingOlpcMesh *setting);
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingOlpcMeshError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingOlpcMesh
-
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_olpc_mesh_error_quark () +
+NMSetting * + +nm_setting_olpc_mesh_new () +
const GByteArray * + +nm_setting_olpc_mesh_get_ssid () +
+guint32 + +nm_setting_olpc_mesh_get_channel () +
const GByteArray * + +nm_setting_olpc_mesh_get_dhcp_anycast_address () +

Properties

-
-  "channel"                  guint                 : Read / Write / Construct
-  "dhcp-anycast-address"     GArray_guchar_*       : Read / Write
-  "ssid"                     GArray_guchar_*       : Read / Write
-
-
-
-

Description

-

-

+
+++++ + + + + + + + + + + + + + + + + + +
guintchannelRead / Write / Construct
+GArray_guchar_ *dhcp-anycast-addressRead / Write
+GArray_guchar_ *ssidRead / Write
-

Details

-
-

NM_SETTING_OLPC_MESH_SETTING_NAME

-
#define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh"
-
-

-

-
-
-
-

enum NMSettingOlpcMeshError

-
typedef enum {
-	NM_SETTING_OLPC_MESH_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
-} NMSettingOlpcMeshError;
-
-
+

Types and Values

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

NM_SETTING_OLPC_MESH_ERROR_UNKNOWN

unknown or unclassified error -#defineNM_SETTING_OLPC_MESH_SETTING_NAME

NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY

the property was invalid -enumNMSettingOlpcMeshError

NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY

the property was missing and is -required -#defineNM_SETTING_OLPC_MESH_ERROR
#defineNM_SETTING_OLPC_MESH_SSID
#defineNM_SETTING_OLPC_MESH_CHANNEL
#defineNM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS
-
-
-

NM_SETTING_OLPC_MESH_ERROR

-
#define NM_SETTING_OLPC_MESH_ERROR nm_setting_olpc_mesh_error_quark ()
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingOlpcMeshError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingOlpcMesh
 

+

+

+
Description

 

 

 

-

+

+
Functions

 

-
nm_setting_olpc_mesh_error_quark ()

-
GQuark              nm_setting_olpc_mesh_error_quark    (void);

+
nm_setting_olpc_mesh_error_quark ()

+
GQuark
+nm_setting_olpc_mesh_error_quark (void);

 

 

+

+
Returns

+

+

 

 

 

-
NM_SETTING_OLPC_MESH_SSID

-
#define NM_SETTING_OLPC_MESH_SSID                 "ssid"
-

-

-

+
nm_setting_olpc_mesh_new ()

+
NMSetting *
+nm_setting_olpc_mesh_new (void);

+
Creates a new NMSettingOlpcMesh object with default values.

+

+
Returns

+
 the new empty NMSettingOlpcMesh object

+

+

 

 

 

-
NM_SETTING_OLPC_MESH_CHANNEL

-
#define NM_SETTING_OLPC_MESH_CHANNEL              "channel"
-

+
nm_setting_olpc_mesh_get_ssid ()

+
const GByteArray *
+nm_setting_olpc_mesh_get_ssid (NMSettingOlpcMesh *setting);

 

 

+

+
Returns

+

+

 

 

 

-
NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS

-
#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
-

+
nm_setting_olpc_mesh_get_channel ()

+
guint32
+nm_setting_olpc_mesh_get_channel (NMSettingOlpcMesh *setting);

 

 

+

+
Returns

+

+

 

 

 

-
NMSettingOlpcMesh

-
typedef struct _NMSettingOlpcMesh NMSettingOlpcMesh;

+
nm_setting_olpc_mesh_get_dhcp_anycast_address ()

+
const GByteArray *
+nm_setting_olpc_mesh_get_dhcp_anycast_address
+                               (NMSettingOlpcMesh *setting);

 

 

+

+
Returns

+

 

-

+

+

+

+
Types and Values

 

-
NMSettingOlpcMeshClass

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

+
#define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh"
 

 

 

 

 

 

-
nm_setting_olpc_mesh_new ()

-
NMSetting *         nm_setting_olpc_mesh_new            (void);

-

-Creates a new NMSettingOlpcMesh object with default values.
-

-

+
enum NMSettingOlpcMeshError

+

+
Members

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

 





 
Returns :
the new empty NMSettingOlpcMesh object
NM_SETTING_OLPC_MESH_ERROR_UNKNOWN

+
unknown or unclassified error

+		 
NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY

+
the property was invalid

+		 
NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY

+
the property was missing and is
+required

+		 

 

 

+

+

+

+
NM_SETTING_OLPC_MESH_ERROR

+
#define NM_SETTING_OLPC_MESH_ERROR nm_setting_olpc_mesh_error_quark ()
+

+

+

+

 

 

-
nm_setting_olpc_mesh_get_ssid ()

-
const GByteArray *  nm_setting_olpc_mesh_get_ssid       (NMSettingOlpcMesh *setting);

+
NM_SETTING_OLPC_MESH_SSID

+
#define NM_SETTING_OLPC_MESH_SSID                 "ssid"
+

 

 

 

 

 

-
nm_setting_olpc_mesh_get_channel ()

-
guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);

+
NM_SETTING_OLPC_MESH_CHANNEL

+
#define NM_SETTING_OLPC_MESH_CHANNEL              "channel"
+

 

 

 

 

 

-
nm_setting_olpc_mesh_get_dhcp_anycast_address ()

-
const GByteArray *  nm_setting_olpc_mesh_get_dhcp_anycast_address
-                                                        (NMSettingOlpcMesh *setting);

+
NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS

+
#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
+

 

 

 

@@ -231,35 +306,30 @@ Creates a new 
 
Property Details

 

-
The "channel" property

-
  "channel"                  guint                 : Read / Write / Construct

-

-Channel on which the mesh network to join is located.
-

+
The “channel” property

+
  “channel”                  guint

+
Channel on which the mesh network to join is located.

+
Flags: Read / Write / Construct

 
Default value: 0

 

 

 

-
The "dhcp-anycast-address" property

-
  "dhcp-anycast-address"     GArray_guchar_*       : Read / Write

-

-Anycast DHCP address used when requesting an IP address via DHCP.  The
-specific anycast address used determines which DHCP server class answers
-the request.
-

+
The “dhcp-anycast-address” property

+
  “dhcp-anycast-address”     GArray_guchar_ *

+
Anycast DHCP MAC address used when requesting an IP address via DHCP.  The specific anycast address used determines which DHCP server class answers the the request.

+
Flags: Read / Write

 

 

 

-
The "ssid" property

-
  "ssid"                     GArray_guchar_*       : Read / Write

-

-SSID of the mesh network to join.
-

+
The “ssid” property

+
  “ssid”                     GArray_guchar_ *

+
SSID of the mesh network to join.

+
Flags: Read / Write
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingPPP.html b/docs/libnm-util/html/NMSettingPPP.html index 9e13b48b..f064b8ed 100644 --- a/docs/libnm-util/html/NMSettingPPP.html +++ b/docs/libnm-util/html/NMSettingPPP.html @@ -2,34 +2,28 @@ -NMSettingPPP +libnm-util Reference Manual: NMSettingPPP - + - - - - - - - - - - + + + + + + +
@@ -38,951 +32,1248 @@

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

- +
-
-

Synopsis

-
-#include <nm-setting-ppp.h>
-
-#define             NM_SETTING_PPP_SETTING_NAME
-enum                NMSettingPPPError;
-#define             NM_SETTING_PPP_ERROR
-GQuark              nm_setting_ppp_error_quark          (void);
-#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
-                    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

-
-  GEnum
-   +----NMSettingPPPError
-
-
-  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"
-
-

-

-
-
-
-

enum NMSettingPPPError

-
typedef enum {
-	NM_SETTING_PPP_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_SETTING_PPP_ERROR_INVALID_PROPERTY,        /*< nick=InvalidProperty >*/
-	NM_SETTING_PPP_ERROR_MISSING_PROPERTY,        /*< nick=MissingProperty >*/
-	NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED /*< nick=RequireMPPENotAllowed >*/
-} NMSettingPPPError;
-
-
+

Functions

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

NM_SETTING_PPP_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_ppp_error_quark () +
+NMSetting * + +nm_setting_ppp_new () +
+gboolean + +nm_setting_ppp_get_noauth () +
+gboolean + +nm_setting_ppp_get_refuse_eap () +
+gboolean + +nm_setting_ppp_get_refuse_pap () +
+gboolean + +nm_setting_ppp_get_refuse_chap () +
+gboolean + +nm_setting_ppp_get_refuse_mschap () +
+gboolean + +nm_setting_ppp_get_refuse_mschapv2 () +
+gboolean + +nm_setting_ppp_get_nobsdcomp () +
+gboolean + +nm_setting_ppp_get_nodeflate () +
+gboolean + +nm_setting_ppp_get_no_vj_comp () +
+gboolean + +nm_setting_ppp_get_require_mppe () +
+gboolean + +nm_setting_ppp_get_require_mppe_128 () +
+gboolean + +nm_setting_ppp_get_mppe_stateful () +
+gboolean + +nm_setting_ppp_get_crtscts () +
+guint32 + +nm_setting_ppp_get_baud () +
+guint32 + +nm_setting_ppp_get_mru ()

NM_SETTING_PPP_ERROR_INVALID_PROPERTY

the property was invalid + +guint32 + +nm_setting_ppp_get_mtu ()

NM_SETTING_PPP_ERROR_MISSING_PROPERTY

the property was missing and is -required + +guint32 + +nm_setting_ppp_get_lcp_echo_failure ()

NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED

requiring MPPE is not compatible -with other setting configuration parameters + +guint32 + +nm_setting_ppp_get_lcp_echo_interval ()
-
-
-

NM_SETTING_PPP_ERROR

-
#define NM_SETTING_PPP_ERROR nm_setting_ppp_error_quark ()
-
-

-

-
-
-
-

nm_setting_ppp_error_quark ()

-
GQuark              nm_setting_ppp_error_quark          (void);
-

-Registers an error quark for NMSettingPPP if necessary. -

-
+
+

Properties

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

Returns :

the error quark used for NMSettingPPP errors.
guintbaudRead / Write / Construct
gbooleancrtsctsRead / Write / Construct
guintlcp-echo-failureRead / Write / Construct
guintlcp-echo-intervalRead / Write / Construct
gbooleanmppe-statefulRead / Write / Construct
guintmruRead / Write / Construct
guintmtuRead / Write / Construct
gbooleanno-vj-compRead / Write / Construct
gbooleannoauthRead / Write / Construct
gbooleannobsdcompRead / Write / Construct
gbooleannodeflateRead / Write / Construct
gbooleanrefuse-chapRead / Write / Construct
gbooleanrefuse-eapRead / Write / Construct
gbooleanrefuse-mschapRead / Write / Construct
gbooleanrefuse-mschapv2Read / Write / Construct
gbooleanrefuse-papRead / Write / Construct
gbooleanrequire-mppeRead / Write / Construct
gbooleanrequire-mppe-128Read / Write / Construct
-
-
-

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

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_PPP_SETTING_NAME
enumNMSettingPPPError
#defineNM_SETTING_PPP_ERROR
#defineNM_SETTING_PPP_NOAUTH
#defineNM_SETTING_PPP_REFUSE_EAP
#defineNM_SETTING_PPP_REFUSE_PAP
#defineNM_SETTING_PPP_REFUSE_CHAP
#defineNM_SETTING_PPP_REFUSE_MSCHAP
#defineNM_SETTING_PPP_REFUSE_MSCHAPV2
#defineNM_SETTING_PPP_NOBSDCOMP
#defineNM_SETTING_PPP_NODEFLATE
#defineNM_SETTING_PPP_NO_VJ_COMP
#defineNM_SETTING_PPP_REQUIRE_MPPE
#defineNM_SETTING_PPP_REQUIRE_MPPE_128
#defineNM_SETTING_PPP_MPPE_STATEFUL
#defineNM_SETTING_PPP_CRTSCTS
#defineNM_SETTING_PPP_BAUD
#defineNM_SETTING_PPP_MRU
#defineNM_SETTING_PPP_MTU
#defineNM_SETTING_PPP_LCP_ECHO_FAILURE
#defineNM_SETTING_PPP_LCP_ECHO_INTERVAL
-
-
-

NM_SETTING_PPP_REQUIRE_MPPE_128

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

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingPPPError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingPPP
 

-

-

 

-

-

-
NM_SETTING_PPP_MPPE_STATEFUL

-
#define NM_SETTING_PPP_MPPE_STATEFUL     "mppe-stateful"
+

+
Includes

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

-

-

 

-

-

-
NM_SETTING_PPP_CRTSCTS

-
#define NM_SETTING_PPP_CRTSCTS           "crtscts"
-

-

-

+

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

 

-

+

+
Functions

 

-
NM_SETTING_PPP_BAUD

-
#define NM_SETTING_PPP_BAUD              "baud"
-

-

-

+
nm_setting_ppp_error_quark ()

+
GQuark
+nm_setting_ppp_error_quark (void);

+
Registers an error quark for NMSettingPPP if necessary.

+

+
Returns

+
 the error quark used for NMSettingPPP errors.

+

 

-

-

-
NM_SETTING_PPP_MRU

-
#define NM_SETTING_PPP_MRU               "mru"
-

-

-

 

 

 

-
NM_SETTING_PPP_MTU

-
#define NM_SETTING_PPP_MTU               "mtu"
-

-

-

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

-

-

+
nm_setting_ppp_get_noauth ()

+
gboolean
+nm_setting_ppp_get_noauth (NMSettingPPP *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingPPP
 

 

-

-

-
NMSettingPPP

-
typedef struct _NMSettingPPP NMSettingPPP;

-

-

+

+
Returns

+
 the “noauth” property of the setting

+

 

-

-

-
NMSettingPPPClass

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

-

-

 

 

 

-
nm_setting_ppp_new ()

-
NMSetting *         nm_setting_ppp_new                  (void);

-

-Creates a new NMSettingPPP object with default values.
-

-

+
nm_setting_ppp_get_refuse_eap ()

+
gboolean
+nm_setting_ppp_get_refuse_eap (NMSettingPPP *setting);

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingPPP object. [transfer full]
-
setting
the NMSettingPPP
 
 

 

 

+

+
Returns

+
 the “refuse-eap” property of the setting

+

+

+

 

 

-
nm_setting_ppp_get_noauth ()

-
gboolean            nm_setting_ppp_get_noauth           (NMSettingPPP *setting);

-

+
nm_setting_ppp_get_refuse_pap ()

+
gboolean
+nm_setting_ppp_get_refuse_pap (NMSettingPPP *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingPPP
-
Returns :
the "noauth" property of the setting
setting
the NMSettingPPP
 

 

 

+

+
Returns

+
 the “refuse-pap” property of the setting

+

+

+

 

 

-
nm_setting_ppp_get_refuse_eap ()

-
gboolean            nm_setting_ppp_get_refuse_eap       (NMSettingPPP *setting);

-

+
nm_setting_ppp_get_refuse_chap ()

+
gboolean
+nm_setting_ppp_get_refuse_chap (NMSettingPPP *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingPPP
-
Returns :
the "refuse-eap" property of the setting
setting
the NMSettingPPP
 

 

 

+

+
Returns

+
 the “refuse-chap” property of the setting

+

+

+

 

 

-
nm_setting_ppp_get_refuse_pap ()

-
gboolean            nm_setting_ppp_get_refuse_pap       (NMSettingPPP *setting);

-

+
nm_setting_ppp_get_refuse_mschap ()

+
gboolean
+nm_setting_ppp_get_refuse_mschap (NMSettingPPP *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingPPP
-
Returns :
the "refuse-pap" property of the setting
setting
the NMSettingPPP
 

 

 

+

+
Returns

+
 the “refuse-mschap” property of the setting

+

+

+

 

 

-
nm_setting_ppp_get_refuse_chap ()

-
gboolean            nm_setting_ppp_get_refuse_chap      (NMSettingPPP *setting);

-

+
nm_setting_ppp_get_refuse_mschapv2 ()

+
gboolean
+nm_setting_ppp_get_refuse_mschapv2 (NMSettingPPP *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingPPP
-
Returns :
the "refuse-chap" property of the setting
setting
the NMSettingPPP
 

 

 

+

+
Returns

+
 the “refuse-mschapv2” property of the setting

+

+

+

 

 

-
nm_setting_ppp_get_refuse_mschap ()

-
gboolean            nm_setting_ppp_get_refuse_mschap    (NMSettingPPP *setting);

-

+
nm_setting_ppp_get_nobsdcomp ()

+
gboolean
+nm_setting_ppp_get_nobsdcomp (NMSettingPPP *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingPPP
-
Returns :
the "refuse-mschap" property of the setting
setting
the NMSettingPPP
 

 

 

+

+
Returns

+
 the “nobsdcomp” property of the setting

+

+

+

 

 

-
nm_setting_ppp_get_refuse_mschapv2 ()

-
gboolean            nm_setting_ppp_get_refuse_mschapv2  (NMSettingPPP *setting);

-

+
nm_setting_ppp_get_nodeflate ()

+
gboolean
+nm_setting_ppp_get_nodeflate (NMSettingPPP *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingPPP
-
Returns :
the "refuse-mschapv2" property of the setting
setting
the NMSettingPPP
 

 

 

+

+
Returns

+
 the “nodeflate” property of the setting

+

+

+

 

 

-
nm_setting_ppp_get_nobsdcomp ()

-
gboolean            nm_setting_ppp_get_nobsdcomp        (NMSettingPPP *setting);

-

+
nm_setting_ppp_get_no_vj_comp ()

+
gboolean
+nm_setting_ppp_get_no_vj_comp (NMSettingPPP *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingPPP
-
Returns :
the "nobsdcomp" property of the setting
setting
the NMSettingPPP
 

 

 

+

+
Returns

+
 the “no-vj-comp” property of the setting

+

+

+
-

nm_setting_ppp_get_nodeflate ()

-
gboolean            nm_setting_ppp_get_nodeflate        (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_require_mppe ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

the "nodeflate" property of the setting

setting

the NMSettingPPP

 
+
+

Returns

+

the “require-mppe” property of the setting

+

+
+
-

nm_setting_ppp_get_no_vj_comp ()

-
gboolean            nm_setting_ppp_get_no_vj_comp       (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_require_mppe_128 ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

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

setting

the NMSettingPPP

 
+
+

Returns

+

the “require-mppe-128” property of the setting

+

+
+
-

nm_setting_ppp_get_require_mppe ()

-
gboolean            nm_setting_ppp_get_require_mppe     (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_mppe_stateful ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

the "require-mppe" property of the setting

setting

the NMSettingPPP

 
+
+

Returns

+

the “mppe-stateful” property of the setting

+

+
+
-

nm_setting_ppp_get_require_mppe_128 ()

-
gboolean            nm_setting_ppp_get_require_mppe_128 (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_crtscts ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

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

setting

the NMSettingPPP

 
+
+

Returns

+

the “crtscts” property of the setting

+

+
+
-

nm_setting_ppp_get_mppe_stateful ()

-
gboolean            nm_setting_ppp_get_mppe_stateful    (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_baud ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

the "mppe-stateful" property of the setting

setting

the NMSettingPPP

 
+
+

Returns

+

the “baud” property of the setting

+

+
+
-

nm_setting_ppp_get_crtscts ()

-
gboolean            nm_setting_ppp_get_crtscts          (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_mru ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

the "crtscts" property of the setting

setting

the NMSettingPPP

 
+
+

Returns

+

the “mru” property of the setting

+

+
+
-

nm_setting_ppp_get_baud ()

-
guint32             nm_setting_ppp_get_baud             (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_mtu ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

the "baud" property of the setting

setting

the NMSettingPPP

 
+
+

Returns

+

the “mtu” property of the setting

+

+
+
-

nm_setting_ppp_get_mru ()

-
guint32             nm_setting_ppp_get_mru              (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_lcp_echo_failure ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

the "mru" property of the setting

setting

the NMSettingPPP

 
+
+

Returns

+

the “lcp-echo-failure” property of the setting

+

+
+
-

nm_setting_ppp_get_mtu ()

-
guint32             nm_setting_ppp_get_mtu              (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_lcp_echo_interval ()

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

Parameters

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

setting :

the NMSettingPPP -

Returns :

the "mtu" property of the setting

setting

the NMSettingPPP

 
+
+

Returns

+

the “lcp-echo-interval” property of the setting

+

+
+ + +
+

Types and Values

+
+

NM_SETTING_PPP_SETTING_NAME

+
#define NM_SETTING_PPP_SETTING_NAME "ppp"
+
+

+

+
-

nm_setting_ppp_get_lcp_echo_failure ()

-
guint32             nm_setting_ppp_get_lcp_echo_failure (NMSettingPPP *setting);
-
+

enum NMSettingPPPError

+
+

Members

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

setting :

the NMSettingPPP +

NM_SETTING_PPP_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

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

NM_SETTING_PPP_ERROR_INVALID_PROPERTY

 +

the property was invalid

+		 
-
-
-
-

nm_setting_ppp_get_lcp_echo_interval ()

-
guint32             nm_setting_ppp_get_lcp_echo_interval
-                                                        (NMSettingPPP *setting);
-
---- - - - + + - - + + +

setting :

the NMSettingPPP +

NM_SETTING_PPP_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

Returns :

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

NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED

 +

requiring MPPE is not compatible +with other setting configuration parameters

+		 
-
-

Property Details

+
-

The "baud" property

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

NM_SETTING_PPP_ERROR

+
#define NM_SETTING_PPP_ERROR nm_setting_ppp_error_quark ()
+

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

NM_SETTING_PPP_NOAUTH

+
#define NM_SETTING_PPP_NOAUTH            "noauth"
+

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

NM_SETTING_PPP_REFUSE_EAP

+
#define NM_SETTING_PPP_REFUSE_EAP        "refuse-eap"
+

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

NM_SETTING_PPP_REFUSE_PAP

+
#define NM_SETTING_PPP_REFUSE_PAP        "refuse-pap"
+

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

NM_SETTING_PPP_REFUSE_CHAP

+
#define NM_SETTING_PPP_REFUSE_CHAP       "refuse-chap"
+

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

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

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

NM_SETTING_PPP_NOBSDCOMP

+
#define NM_SETTING_PPP_NOBSDCOMP         "nobsdcomp"
+

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

NM_SETTING_PPP_NODEFLATE

+
#define NM_SETTING_PPP_NODEFLATE         "nodeflate"
+

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

-

Default value: FALSE

-

The "noauth" property

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

NM_SETTING_PPP_NO_VJ_COMP

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

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

NM_SETTING_PPP_REQUIRE_MPPE

+
#define NM_SETTING_PPP_REQUIRE_MPPE      "require-mppe"
+

-If TRUE, BSD compression will not be requested.

-

Default value: FALSE

-

The "nodeflate" property

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

NM_SETTING_PPP_REQUIRE_MPPE_128

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

-If TRUE, 'deflate' compression will not be requested.

-

Default value: FALSE

-

The "refuse-chap" property

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

NM_SETTING_PPP_MPPE_STATEFUL

+
#define NM_SETTING_PPP_MPPE_STATEFUL     "mppe-stateful"
+

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

-

Default value: FALSE

-

The "refuse-eap" property

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

NM_SETTING_PPP_CRTSCTS

+
#define NM_SETTING_PPP_CRTSCTS           "crtscts"
+

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

-

Default value: FALSE

-

The "refuse-mschap" property

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

NM_SETTING_PPP_BAUD

+
#define NM_SETTING_PPP_BAUD              "baud"
+

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

-

Default value: FALSE

-

The "refuse-mschapv2" property

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

NM_SETTING_PPP_MRU

+
#define NM_SETTING_PPP_MRU               "mru"
+

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

-

Default value: FALSE

-

The "refuse-pap" property

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

NM_SETTING_PPP_MTU

+
#define NM_SETTING_PPP_MTU               "mtu"
+

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

-

Default value: FALSE

-

The "require-mppe" property

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

NM_SETTING_PPP_LCP_ECHO_FAILURE

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

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

NM_SETTING_PPP_LCP_ECHO_INTERVAL

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

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

+
+
+
+

Property Details

+
+

The “baud” property

+
  “baud”                     guint
+

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.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “crtscts” property

+
  “crtscts”                  gboolean
+

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.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “lcp-echo-failure” property

+
  “lcp-echo-failure”         guint
+

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.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “lcp-echo-interval” property

+
  “lcp-echo-interval”        guint
+

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.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “mppe-stateful” property

+
  “mppe-stateful”            gboolean
+

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

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “mru” property

+
  “mru”                      guint
+

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.

+

Flags: Read / Write / Construct

+

Allowed values: <= 16384

+

Default value: 0

+
+
+
+

The “mtu” property

+
  “mtu”                      guint
+

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

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “no-vj-comp” property

+
  “no-vj-comp”               gboolean
+

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

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “noauth” property

+
  “noauth”                   gboolean
+

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.

+

Flags: Read / Write / Construct

+

Default value: TRUE

+
+
+
+

The “nobsdcomp” property

+
  “nobsdcomp”                gboolean
+

If TRUE, BSD compression will not be requested.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “nodeflate” property

+
  “nodeflate”                gboolean
+

If TRUE, 'deflate' compression will not be requested.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “refuse-chap” property

+
  “refuse-chap”              gboolean
+

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

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “refuse-eap” property

+
  “refuse-eap”               gboolean
+

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

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “refuse-mschap” property

+
  “refuse-mschap”            gboolean
+

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

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “refuse-mschapv2” property

+
  “refuse-mschapv2”          gboolean
+

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

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “refuse-pap” property

+
  “refuse-pap”               gboolean
+

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

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “require-mppe” property

+
  “require-mppe”             gboolean
+

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.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+
+
+
+

The “require-mppe-128” property

+
  “require-mppe-128”         gboolean
+

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.

+

Flags: Read / Write / Construct

Default value: FALSE

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file 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 diff --git a/docs/libnm-util/html/NMSettingSerial.html b/docs/libnm-util/html/NMSettingSerial.html index 16f6d603..8f107269 100644 --- a/docs/libnm-util/html/NMSettingSerial.html +++ b/docs/libnm-util/html/NMSettingSerial.html @@ -2,34 +2,28 @@ -NMSettingSerial +libnm-util Reference Manual: NMSettingSerial - + - - - - - - - - - - + + + + + + +
@@ -38,64 +32,333 @@

NMSettingSerial — Describes connection properties for devices that use serial communications

- +
-
-

Synopsis

-
-#include <nm-setting-serial.h>
-
-#define             NM_SETTING_SERIAL_SETTING_NAME
-enum                NMSettingSerialError;
-#define             NM_SETTING_SERIAL_ERROR
-GQuark              nm_setting_serial_error_quark       (void);
-#define             NM_SETTING_SERIAL_BAUD
-#define             NM_SETTING_SERIAL_BITS
-#define             NM_SETTING_SERIAL_PARITY
-#define             NM_SETTING_SERIAL_STOPBITS
-#define             NM_SETTING_SERIAL_SEND_DELAY
-                    NMSettingSerial;
-                    NMSettingSerialClass;
-NMSetting *         nm_setting_serial_new               (void);
-guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
-guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
-char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
-guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
-guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_serial_error_quark () +
+NMSetting * + +nm_setting_serial_new () +
+guint + +nm_setting_serial_get_baud () +
+guint + +nm_setting_serial_get_bits () +
+char + +nm_setting_serial_get_parity () +
+guint + +nm_setting_serial_get_stopbits () +
+guint64 + +nm_setting_serial_get_send_delay () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
guintbaudRead / Write / Construct
guintbitsRead / Write / Construct
gcharparityRead / Write / Construct
guint64send-delayRead / Write / Construct
guintstopbitsRead / Write / Construct
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_SERIAL_SETTING_NAME
enumNMSettingSerialError
#defineNM_SETTING_SERIAL_ERROR
#defineNM_SETTING_SERIAL_BAUD
#defineNM_SETTING_SERIAL_BITS
#defineNM_SETTING_SERIAL_PARITY
#defineNM_SETTING_SERIAL_STOPBITS
#defineNM_SETTING_SERIAL_SEND_DELAY

Object Hierarchy

-
-  GEnum
-   +----NMSettingSerialError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingSerial
+
    GEnum
+    ╰── NMSettingSerialError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingSerial
-

Properties

-
-  "baud"                     guint                 : Read / Write / Construct
-  "bits"                     guint                 : Read / Write / Construct
-  "parity"                   gchar                 : Read / Write / Construct
-  "send-delay"               guint64               : Read / Write / Construct
-  "stopbits"                 guint                 : Read / Write / Construct
+
Includes

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

Description

-

-The NMSettingSerial object is a NMSetting subclass that describes +

The NMSettingSerial object is a NMSetting subclass that describes properties necessary for connections that may use serial communications, -such as mobile broadband or analog telephone connections. -

+such as mobile broadband or analog telephone connections.

+
+
+

Functions

+
+

nm_setting_serial_error_quark ()

+
GQuark
+nm_setting_serial_error_quark (void);
+

Registers an error quark for NMSettingSerial if necessary.

+
+

Returns

+

the error quark used for NMSettingSerial errors.

+

+
+
+
+
+

nm_setting_serial_new ()

+
NMSetting *
+nm_setting_serial_new (void);
+

Creates a new NMSettingSerial object with default values.

+
+

Returns

+

the new empty NMSettingSerial object.

+

[transfer full]

+
+
+
+
+

nm_setting_serial_get_baud ()

+
guint
+nm_setting_serial_get_baud (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “baud” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_bits ()

+
guint
+nm_setting_serial_get_bits (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “bits” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_parity ()

+
char
+nm_setting_serial_get_parity (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “parity” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_stopbits ()

+
guint
+nm_setting_serial_get_stopbits (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “stopbits” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_send_delay ()

+
guint64
+nm_setting_serial_get_send_delay (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “send-delay” property of the setting

+

+
+
-

Details

+

Types and Values

NM_SETTING_SERIAL_SETTING_NAME

#define NM_SETTING_SERIAL_SETTING_NAME "serial"
@@ -105,45 +368,50 @@ such as mobile broadband or analog telephone connections.
-

enum NMSettingSerialError

-
typedef enum {
-	NM_SETTING_SERIAL_ERROR_UNKNOWN = 0,        /*< nick=UnknownError >*/
-	NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY,   /*< nick=InvalidProperty >*/
-	NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY,   /*< nick=MissingProperty >*/
-	NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING /*< nick=MissingPPPSetting >*/
-} NMSettingSerialError;
-
-
+

enum NMSettingSerialError

+
+

Members

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

NM_SETTING_SERIAL_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_SERIAL_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING

one of the properties of the -setting requires the connection to contain an NMSettingPPP setting +

NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING

 +

one of the properties of the +setting requires the connection to contain an NMSettingPPP setting

 
+

NM_SETTING_SERIAL_ERROR

@@ -154,24 +422,6 @@ setting requires the connection to contain an -

nm_setting_serial_error_quark ()

-
GQuark              nm_setting_serial_error_quark       (void);
-

-Registers an error quark for NMSettingSerial if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingSerial errors.
-
-
-

NM_SETTING_SERIAL_BAUD

#define NM_SETTING_SERIAL_BAUD "baud"
@@ -210,209 +460,48 @@ Registers an error quark for -

NMSettingSerial

-
typedef struct _NMSettingSerial NMSettingSerial;
-

-

-
-
-
-

NMSettingSerialClass

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

-

-
-
-
-

nm_setting_serial_new ()

-
NMSetting *         nm_setting_serial_new               (void);
-

-Creates a new NMSettingSerial object with default values. -

-
---- - - - - -

Returns :

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

nm_setting_serial_get_baud ()

-
guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "baud" property of the setting
-
-
-
-

nm_setting_serial_get_bits ()

-
guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "bits" property of the setting
-
-
-
-

nm_setting_serial_get_parity ()

-
char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "parity" property of the setting
-
-
-
-

nm_setting_serial_get_stopbits ()

-
guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "stopbits" property of the setting
-
-
-
-

nm_setting_serial_get_send_delay ()

-
guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "send-delay" property of the setting
-

Property Details

-

The "baud" property

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

-Speed to use for communication over the serial port. Note that this value -usually has no effect for mobile broadband modems as they generally -ignore speed settings and use the highest available speed. -

+

The “baud” property

+
  “baud”                     guint
+

Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.

+

Flags: Read / Write / Construct

Default value: 57600

-

The "bits" property

-
  "bits"                     guint                 : Read / Write / Construct
-

-Byte-width of the serial communication. -

+

The “bits” property

+
  “bits”                     guint
+

Byte-width of the serial communication. The 8 in '8n1' for example.

+

Flags: Read / Write / Construct

Allowed values: [5,8]

Default value: 8

-

The "parity" property

-
  "parity"                   gchar                 : Read / Write / Construct
-

-Parity setting of the serial port. Either 'E' for even parity, 'o' for -odd parity, or 'n' for no parity. -

+

The “parity” property

+
  “parity”                   gchar
+

Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.

+

Flags: Read / Write / Construct

Allowed values: [69,111]

Default value: 110

-

The "send-delay" property

-
  "send-delay"               guint64               : Read / Write / Construct
-

-Time to delay between each byte sent to the modem, in microseconds. -

+

The “send-delay” property

+
  “send-delay”               guint64
+

Time to delay between each byte sent to the modem, in microseconds.

+

Flags: Read / Write / Construct

Default value: 0

-

The "stopbits" property

-
  "stopbits"                 guint                 : Read / Write / Construct
-

-Number of stop bits for communication on the serial port. Either 1 or 2. -The 1 in '8n1' for example. -

+

The “stopbits” property

+
  “stopbits”                 guint
+

Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.

+

Flags: Read / Write / Construct

Allowed values: [1,2]

Default value: 1

@@ -420,6 +509,6 @@ The 1 in '8n1' for example.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingVPN.html b/docs/libnm-util/html/NMSettingVPN.html index afbe41bf..57039178 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -2,34 +2,28 @@ -NMSettingVPN +libnm-util Reference Manual: NMSettingVPN - + - - - - - - - - - - + + + + + + +
@@ -37,660 +31,822 @@

NMSettingVPN

NMSettingVPN — Describes connection properties for Virtual Private Networks

- +
-
-

Synopsis

-
-#include <nm-setting-vpn.h>
-
-#define             NM_SETTING_VPN_SETTING_NAME
-enum                NMSettingVpnError;
-#define             NM_SETTING_VPN_ERROR
-GQuark              nm_setting_vpn_error_quark          (void);
-#define             NM_SETTING_VPN_SERVICE_TYPE
-#define             NM_SETTING_VPN_USER_NAME
-#define             NM_SETTING_VPN_DATA
-#define             NM_SETTING_VPN_SECRETS
-                    NMSettingVPN;
-                    NMSettingVPNClass;
-void                (*NMVPNIterFunc)                    (const char *key,
-                                                         const char *value,
-                                                         gpointer user_data);
-NMSetting *         nm_setting_vpn_new                  (void);
-const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
-const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
-void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *item);
-const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
-                                                         const char *key);
-void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
-                                                         const char *key);
-void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
-guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);
-void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *secret);
-const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
-                                                         const char *key);
-void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
-                                                         const char *key);
-void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_vpn_error_quark () +
+void + +(*NMVPNIterFunc) () +
+NMSetting * + +nm_setting_vpn_new () +
const char * + +nm_setting_vpn_get_service_type () +
const char * + +nm_setting_vpn_get_user_name () +
+guint32 + +nm_setting_vpn_get_num_data_items () +
+void + +nm_setting_vpn_add_data_item () +
const char * + +nm_setting_vpn_get_data_item () +
+void + +nm_setting_vpn_remove_data_item () +
+void + +nm_setting_vpn_foreach_data_item () +
+guint32 + +nm_setting_vpn_get_num_secrets () +
+void + +nm_setting_vpn_add_secret () +
const char * + +nm_setting_vpn_get_secret () +
+void + +nm_setting_vpn_remove_secret () +
+void + +nm_setting_vpn_foreach_secret () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
GHashTable_gchararray+gchararray_*dataRead / Write
GHashTable_gchararray+gchararray_*secretsRead / Write
+gchar *service-typeRead / Write
+gchar *user-nameRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_VPN_SETTING_NAME
enumNMSettingVpnError
#defineNM_SETTING_VPN_ERROR
#defineNM_SETTING_VPN_SERVICE_TYPE
#defineNM_SETTING_VPN_USER_NAME
#defineNM_SETTING_VPN_DATA
#defineNM_SETTING_VPN_SECRETS

Object Hierarchy

-
-  GEnum
-   +----NMSettingVpnError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingVPN
+
    GEnum
+    ╰── NMSettingVpnError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingVPN
-

Properties

-
-  "data"                     GHashTable_gchararray+gchararray_*  : Read / Write
-  "secrets"                  GHashTable_gchararray+gchararray_*  : Read / Write
-  "service-type"             gchar*                : Read / Write
-  "user-name"                gchar*                : Read / Write
+
Includes

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

Description

-

-The NMSettingVPN object is a NMSetting subclass that describes properties +

The NMSettingVPN object is a NMSetting subclass that describes properties necessary for connection to Virtual Private Networks. NetworkManager uses a plugin architecture to allow easier use of new VPN types, and this setting abstracts the configuration for those plugins. Since the configuration options are only known to the VPN plugins themselves, the VPN configuration options are stored as key/value pairs of strings rather than GObject -properties. -

+properties.

-

Details

+

Functions

-

NM_SETTING_VPN_SETTING_NAME

-
#define NM_SETTING_VPN_SETTING_NAME "vpn"
-
-

-

+

nm_setting_vpn_error_quark ()

+
GQuark
+nm_setting_vpn_error_quark (void);
+

Registers an error quark for NMSettingVPN if necessary.

+
+

Returns

+

the error quark used for NMSettingVPN errors.

+

+
-

enum NMSettingVpnError

-
typedef enum {
-	NM_SETTING_VPN_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_VPN_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_VPN_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-} NMSettingVpnError;
-
-
+

NMVPNIterFunc ()

+
void
+(*NMVPNIterFunc) (const char *key,
+                  const char *value,
+                  gpointer user_data);
+
+

Parameters

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

NM_SETTING_VPN_ERROR_UNKNOWN

unknown or unclassified error -

key

the name of the data or secret item

 

NM_SETTING_VPN_ERROR_INVALID_PROPERTY

the property was invalid -

value

the value of the data or secret item

 

NM_SETTING_VPN_ERROR_MISSING_PROPERTY

the property was missing and is -required -

user_data

User data passed to nm_setting_vpn_foreach_data_item() or +nm_setting_vpn_foreach_secret()

 
+
-

NM_SETTING_VPN_ERROR

-
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
-
-

-

+

nm_setting_vpn_new ()

+
NMSetting *
+nm_setting_vpn_new (void);
+

Creates a new NMSettingVPN object with default values.

+
+

Returns

+

the new empty NMSettingVPN object.

+

[transfer full]

+
-

nm_setting_vpn_error_quark ()

-
GQuark              nm_setting_vpn_error_quark          (void);
-

-Registers an error quark for NMSettingVPN if necessary. -

-
+

nm_setting_vpn_get_service_type ()

+
const char *
+nm_setting_vpn_get_service_type (NMSettingVPN *setting);
+

Returns the service name of the VPN, which identifies the specific VPN +plugin that should be used to connect to this VPN.

+
+

Parameters

+
--+++ - - + + +

Returns :

the error quark used for NMSettingVPN errors.

setting

the NMSettingVPN

 
-
-
-

NM_SETTING_VPN_SERVICE_TYPE

-
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
-
-

-

-
-
-
-

NM_SETTING_VPN_USER_NAME

-
#define NM_SETTING_VPN_USER_NAME    "user-name"
-
-

-

-
-
-
-

NM_SETTING_VPN_DATA

-
#define NM_SETTING_VPN_DATA         "data"
-
-

-

-
-
-
-

NM_SETTING_VPN_SECRETS

-
#define NM_SETTING_VPN_SECRETS      "secrets"
-
-

-

-
-
-
-

NMSettingVPN

-
typedef struct _NMSettingVPN NMSettingVPN;
-

-

+
+

Returns

+

the VPN plugin's service name

+

-
-
-

NMSettingVPNClass

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

-

-

NMVPNIterFunc ()

-
void                (*NMVPNIterFunc)                    (const char *key,
-                                                         const char *value,
-                                                         gpointer user_data);
-
+

nm_setting_vpn_get_user_name ()

+
const char *
+nm_setting_vpn_get_user_name (NMSettingVPN *setting);
+
+

Parameters

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

key :

the name of the data or secret item

value :

the value of the data or secret item

user_data :

User data passed to nm_setting_vpn_foreach_data_item() or -nm_setting_vpn_foreach_secret() -

setting

the NMSettingVPN

 
+
+

Returns

+

the “user-name” property of the setting

+

+
+
-

nm_setting_vpn_new ()

-
NMSetting *         nm_setting_vpn_new                  (void);
-

-Creates a new NMSettingVPN object with default values. -

-
+

nm_setting_vpn_get_num_data_items ()

+
guint32
+nm_setting_vpn_get_num_data_items (NMSettingVPN *setting);
+

Gets number of key/value pairs of VPN configuration data.

+
+

Parameters

+
--+++ - - + + +

Returns :

the new empty NMSettingVPN object. [transfer full] -

setting

the NMSettingVPN

 
+
+

Returns

+

the number of VPN plugin specific configuration data items

+

+
+
-

nm_setting_vpn_get_service_type ()

-
const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
-

-Returns the service name of the VPN, which identifies the specific VPN -plugin that should be used to connect to this VPN. -

-
+

nm_setting_vpn_add_data_item ()

+
void
+nm_setting_vpn_add_data_item (NMSettingVPN *setting,
+                              const char *key,
+                              const char *item);
+

Establishes a relationship between key + and item + internally in the +setting which may be retrieved later. Should not be used to store passwords +or other secrets, which is what nm_setting_vpn_add_secret() is for.

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

the NMSettingVPN

 

Returns :

the VPN plugin's service name
-
-
-
-

nm_setting_vpn_get_user_name ()

-
const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-
---- - - - - + + + - - + + +

setting :

the NMSettingVPN -

key

a name that uniquely identifies the given value item +

 

Returns :

the "user-name" property of the setting

item

the value to be referenced by key +

 
+
-

nm_setting_vpn_get_num_data_items ()

-
guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
-

-Gets number of key/value pairs of VPN configuration data. -

-
+

nm_setting_vpn_get_data_item ()

+
const char *
+nm_setting_vpn_get_data_item (NMSettingVPN *setting,
+                              const char *key);
+

Retrieves the data item of a key/value relationship previously established +by nm_setting_vpn_add_data_item().

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

the NMSettingVPN

 

Returns :

the number of VPN plugin specific configuration data items

key

the name of the data item to retrieve

 
+
+

Returns

+

the data item, if any

+

+
+
-

nm_setting_vpn_add_data_item ()

-
void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *item);
-

-Establishes a relationship between key and item internally in the -setting which may be retrieved later. Should not be used to store passwords -or other secrets, which is what nm_setting_vpn_add_secret() is for. -

-
+

nm_setting_vpn_remove_data_item ()

+
void
+nm_setting_vpn_remove_data_item (NMSettingVPN *setting,
+                                 const char *key);
+

Deletes a key/value relationship previously established by +nm_setting_vpn_add_data_item().

+
+

Parameters

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

setting :

the NMSettingVPN -

key :

a name that uniquely identifies the given value item -

setting

the NMSettingVPN

 

item :

the value to be referenced by key -

key

the name of the data item to remove

 
+
-

nm_setting_vpn_get_data_item ()

-
const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
-                                                         const char *key);
-

-Retrieves the data item of a key/value relationship previously established -by nm_setting_vpn_add_data_item(). -

-
+

nm_setting_vpn_foreach_data_item ()

+
void
+nm_setting_vpn_foreach_data_item (NMSettingVPN *setting,
+                                  NMVPNIterFunc func,
+                                  gpointer user_data);
+

Iterates all data items stored in this setting. It is safe to add, remove, +and modify data items inside func +, though any additions or removals made +during iteration will not be part of the iteration.

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

a NMSettingVPN

 

key :

the name of the data item to retrieve

func

an user provided function.

[scope call]

Returns :

the data item, if any

user_data

data to be passed to func +

 
+
-

nm_setting_vpn_remove_data_item ()

-
void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
-                                                         const char *key);
-

-Deletes a key/value relationship previously established by -nm_setting_vpn_add_data_item(). -

-
+

nm_setting_vpn_get_num_secrets ()

+
guint32
+nm_setting_vpn_get_num_secrets (NMSettingVPN *setting);
+

Gets number of VPN plugin specific secrets in the setting.

+
+

Parameters

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

setting :

the NMSettingVPN -

key :

the name of the data item to remove

setting

the NMSettingVPN

 
+
+

Returns

+

the number of VPN plugin specific secrets

+

+
+
-

nm_setting_vpn_foreach_data_item ()

-
void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
-

-Iterates all data items stored in this setting. It is safe to add, remove, -and modify data items inside func, though any additions or removals made -during iteration will not be part of the iteration. -

-
+

nm_setting_vpn_add_secret ()

+
void
+nm_setting_vpn_add_secret (NMSettingVPN *setting,
+                           const char *key,
+                           const char *secret);
+

Establishes a relationship between key + and secret + internally in the +setting which may be retrieved later.

+
+

Parameters

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

setting :

a NMSettingVPN -

setting

the NMSettingVPN

 

func :

an user provided function. [scope call] -

key

a name that uniquely identifies the given secret secret +

 

user_data :

data to be passed to func -

secret

the secret to be referenced by key +

 
+
-

nm_setting_vpn_get_num_secrets ()

-
guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);
-

-Gets number of VPN plugin specific secrets in the setting. -

-
+

nm_setting_vpn_get_secret ()

+
const char *
+nm_setting_vpn_get_secret (NMSettingVPN *setting,
+                           const char *key);
+

Retrieves the secret of a key/value relationship previously established +by nm_setting_vpn_add_secret().

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

the NMSettingVPN

 

Returns :

the number of VPN plugin specific secrets

key

the name of the secret to retrieve

 
+
+

Returns

+

the secret, if any

+

+
+
-

nm_setting_vpn_add_secret ()

-
void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *secret);
-

-Establishes a relationship between key and secret internally in the -setting which may be retrieved later. -

-
+

nm_setting_vpn_remove_secret ()

+
void
+nm_setting_vpn_remove_secret (NMSettingVPN *setting,
+                              const char *key);
+

Deletes a key/value relationship previously established by +nm_setting_vpn_add_secret().

+
+

Parameters

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

setting :

the NMSettingVPN -

key :

a name that uniquely identifies the given secret secret -

setting

the NMSettingVPN

 

secret :

the secret to be referenced by key -

key

the name of the secret to remove

 
+
-

nm_setting_vpn_get_secret ()

-
const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
-                                                         const char *key);
-

-Retrieves the secret of a key/value relationship previously established -by nm_setting_vpn_add_secret(). -

-
+

nm_setting_vpn_foreach_secret ()

+
void
+nm_setting_vpn_foreach_secret (NMSettingVPN *setting,
+                               NMVPNIterFunc func,
+                               gpointer user_data);
+

Iterates all secrets stored in this setting. It is safe to add, remove, +and modify secrets inside func +, though any additions or removals made during +iteration will not be part of the iteration.

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

a NMSettingVPN

 

key :

the name of the secret to retrieve

func

an user provided function.

[scope call]

Returns :

the secret, if any

user_data

data to be passed to func +

 
-
+ + +
+

Types and Values

-

nm_setting_vpn_remove_secret ()

-
void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
-                                                         const char *key);
+

NM_SETTING_VPN_SETTING_NAME

+
#define NM_SETTING_VPN_SETTING_NAME "vpn"
+

-Deletes a key/value relationship previously established by -nm_setting_vpn_add_secret().

-
---- - - - - - - - - - - -

setting :

the NMSettingVPN -

key :

the name of the secret to remove
-

nm_setting_vpn_foreach_secret ()

-
void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
-

-Iterates all secrets stored in this setting. It is safe to add, remove, -and modify secrets inside func, though any additions or removals made during -iteration will not be part of the iteration. -

-
+

enum NMSettingVpnError

+
+

Members

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

setting :

a NMSettingVPN +

NM_SETTING_VPN_ERROR_UNKNOWN

 +

unknown or unclassified error

 

func :

an user provided function. [scope call] +

NM_SETTING_VPN_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

user_data :

data to be passed to func +

NM_SETTING_VPN_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 
-
-

Property Details

+
-

The "data" property

-
  "data"                     GHashTable_gchararray+gchararray_*  : Read / Write
+

NM_SETTING_VPN_ERROR

+
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
+

-Dictionary of key/value pairs of VPN plugin specific data. Both keys -and values must be strings.

-

The "secrets" property

-
  "secrets"                  GHashTable_gchararray+gchararray_*  : Read / Write
+

NM_SETTING_VPN_SERVICE_TYPE

+
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
+

-Dictionary of key/value pairs of VPN plugin specific secrets like -passwords or private keys. Both keys and values must be strings.

-

The "service-type" property

-
  "service-type"             gchar*                : Read / Write
+

NM_SETTING_VPN_USER_NAME

+
#define NM_SETTING_VPN_USER_NAME    "user-name"
+

-D-Bus service name of the VPN plugin that this setting uses to connect -to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc -plugin.

-

Default value: NULL

-

The "user-name" property

-
  "user-name"                gchar*                : Read / Write
+

NM_SETTING_VPN_DATA

+
#define NM_SETTING_VPN_DATA         "data"
+

-If the VPN connection requires a user name for authentication, that name -should be provided here. If the connection is available to more than -one user, and the VPN requires each user to supply a different name, then -leave this property empty. If this property is empty, NetworkManager -will automatically supply the username of the user which requested the -VPN connection.

+
+
+
+

NM_SETTING_VPN_SECRETS

+
#define NM_SETTING_VPN_SECRETS      "secrets"
+
+

+

+
+
+
+

Property Details

+
+

The “data” property

+
  “data”                     GHashTable_gchararray+gchararray_*
+

Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.

+

Flags: Read / Write

+
+
+
+

The “secrets” property

+
  “secrets”                  GHashTable_gchararray+gchararray_*
+

Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.

+

Flags: Read / Write

+
+
+
+

The “service-type” property

+
  “service-type”             gchar *
+

D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “user-name” property

+
  “user-name”                gchar *
+

If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingVlan.html b/docs/libnm-util/html/NMSettingVlan.html index edc209ba..3a023713 100644 --- a/docs/libnm-util/html/NMSettingVlan.html +++ b/docs/libnm-util/html/NMSettingVlan.html @@ -2,34 +2,28 @@ -NMSettingVlan +libnm-util Reference Manual: NMSettingVlan - + - - - - - - - - - - + + + + + + +
@@ -37,722 +31,873 @@

NMSettingVlan

NMSettingVlan — Describes connection properties for VLAN interfaces

- +
-
-

Synopsis

-
-#include <nm-setting-vlan.h>
-
-#define             NM_SETTING_VLAN_SETTING_NAME
-enum                NMSettingVlanError;
-#define             NM_SETTING_VLAN_ERROR
-GQuark              nm_setting_vlan_error_quark         (void);
-#define             NM_SETTING_VLAN_INTERFACE_NAME
-#define             NM_SETTING_VLAN_PARENT
-#define             NM_SETTING_VLAN_ID
-#define             NM_SETTING_VLAN_FLAGS
-#define             NM_SETTING_VLAN_INGRESS_PRIORITY_MAP
-#define             NM_SETTING_VLAN_EGRESS_PRIORITY_MAP
-                    NMSettingVlan;
-                    NMSettingVlanClass;
-enum                NMVlanPriorityMap;
-enum                NMVlanFlags;
-NMSetting *         nm_setting_vlan_new                 (void);
-const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
-const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
-guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
-guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-gint32              nm_setting_vlan_get_num_priorities  (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
-gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 idx,
-                                                         guint32 *out_from,
-                                                         guint32 *out_to);
-gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);
-void                nm_setting_vlan_remove_priority     (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 idx);
-void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
-gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         const char *str);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingVlanError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingVlan
-
-
-  GEnum
-   +----NMVlanPriorityMap
-
-
-  GEnum
-   +----NMVlanFlags
-
-
-

Properties

-
-  "egress-priority-map"      GSList_gchararray_*   : Read / Write
-  "flags"                    guint                 : Read / Write / Construct
-  "id"                       guint                 : Read / Write / Construct
-  "ingress-priority-map"     GSList_gchararray_*   : Read / Write
-  "interface-name"           gchar*                : Read / Write / Construct
-  "parent"                   gchar*                : Read / Write / Construct
-
-
-
-

Description

-

-The NMSettingVlan object is a NMSetting subclass that describes properties -necessary for connection to VLAN interfaces. -

-
-
-

Details

-
-

NM_SETTING_VLAN_SETTING_NAME

-
#define NM_SETTING_VLAN_SETTING_NAME "vlan"
-
-

-

-
-
-
-

enum NMSettingVlanError

-
typedef enum {
-	NM_SETTING_VLAN_ERROR_UNKNOWN = 0,      /*< nick=Unknown >*/
-	NM_SETTING_VLAN_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_VLAN_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-	NM_SETTING_VLAN_ERROR_INVALID_PARENT    /*< nick=InvalidParent >*/
-} NMSettingVlanError;
-
-
+

Functions

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

NM_SETTING_VLAN_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_vlan_error_quark () +
+NMSetting * + +nm_setting_vlan_new () +
const char * + +nm_setting_vlan_get_interface_name () +
const char * + +nm_setting_vlan_get_parent () +
+guint32 + +nm_setting_vlan_get_id () +
+guint32 + +nm_setting_vlan_get_flags () +
+gint32 + +nm_setting_vlan_get_num_priorities ()

NM_SETTING_VLAN_ERROR_INVALID_PROPERTY

the property was invalid + +gboolean + +nm_setting_vlan_get_priority ()

NM_SETTING_VLAN_ERROR_MISSING_PROPERTY

the property was missing and is - required + +gboolean + +nm_setting_vlan_add_priority ()

NM_SETTING_VLAN_ERROR_INVALID_PARENT

the VLAN parent was specified - inconsistently + +void + +nm_setting_vlan_remove_priority () +
+void + +nm_setting_vlan_clear_priorities () +
+gboolean + +nm_setting_vlan_add_priority_str ()
-
-
-

NM_SETTING_VLAN_ERROR

-
#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GSList_gchararray_ *egress-priority-mapRead / Write
guintflagsRead / Write / Construct
guintidRead / Write / Construct
+GSList_gchararray_ *ingress-priority-mapRead / Write
+gchar *interface-nameRead / Write / Construct
+gchar *parentRead / Write / Construct
-
-
-

nm_setting_vlan_error_quark ()

-
GQuark              nm_setting_vlan_error_quark         (void);
-

-Registers an error quark for NMSettingVlan if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingVlan errors.
#defineNM_SETTING_VLAN_SETTING_NAME
enumNMSettingVlanError
#defineNM_SETTING_VLAN_ERROR
#defineNM_SETTING_VLAN_INTERFACE_NAME
#defineNM_SETTING_VLAN_PARENT
#defineNM_SETTING_VLAN_ID
#defineNM_SETTING_VLAN_FLAGS
#defineNM_SETTING_VLAN_INGRESS_PRIORITY_MAP
#defineNM_SETTING_VLAN_EGRESS_PRIORITY_MAP
enumNMVlanPriorityMap
enumNMVlanFlags
-
-
-

NM_SETTING_VLAN_INTERFACE_NAME

-
#define NM_SETTING_VLAN_INTERFACE_NAME       "interface-name"
+

+
Object Hierarchy

+
    GEnum
+    ├── NMSettingVlanError
+    ├── NMVlanFlags
+    ╰── NMVlanPriorityMap
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingVlan
 

-

-

 

-

-

-
NM_SETTING_VLAN_PARENT

-
#define NM_SETTING_VLAN_PARENT               "parent"
+

+
Includes

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

-

-

 

-

+

+
Description

+
The NMSettingVlan object is a NMSetting subclass that describes properties
+necessary for connection to VLAN interfaces.

+

+

+
Functions

 

-
NM_SETTING_VLAN_ID

-
#define NM_SETTING_VLAN_ID                   "id"
-

-

-

+
nm_setting_vlan_error_quark ()

+
GQuark
+nm_setting_vlan_error_quark (void);

+
Registers an error quark for NMSettingVlan if necessary.

+

+
Returns

+
 the error quark used for NMSettingVlan errors.

+

+

 

 

 

-
NM_SETTING_VLAN_FLAGS

-
#define NM_SETTING_VLAN_FLAGS                "flags"
-

-

-

+
nm_setting_vlan_new ()

+
NMSetting *
+nm_setting_vlan_new (void);

+
Creates a new NMSettingVlan object with default values.

+

+
Returns

+
 the new empty NMSettingVlan object. 

+
[transfer full]

+

 

 

 

-
NM_SETTING_VLAN_INGRESS_PRIORITY_MAP

-
#define NM_SETTING_VLAN_INGRESS_PRIORITY_MAP "ingress-priority-map"
-

-

-

+
nm_setting_vlan_get_interface_name ()

+
const char *
+nm_setting_vlan_get_interface_name (NMSettingVlan *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingVlan
 

+

+

+
Returns

+
 the “interface_name” property of the setting

+

+

 

 

 

-
NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

-
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
-

-

-

+
nm_setting_vlan_get_parent ()

+
const char *
+nm_setting_vlan_get_parent (NMSettingVlan *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingVlan
 

+

+

+
Returns

+
 the “parent” property of the setting

+

+

 

 

 

-
NMSettingVlan

-
typedef struct _NMSettingVlan NMSettingVlan;

-

-

+
nm_setting_vlan_get_id ()

+
guint32
+nm_setting_vlan_get_id (NMSettingVlan *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingVlan
 

+

+

+
Returns

+
 the “id” property of the setting

+

+

 

 

 

-
NMSettingVlanClass

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

-

-

+
nm_setting_vlan_get_flags ()

+
guint32
+nm_setting_vlan_get_flags (NMSettingVlan *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingVlan
 

+

+

+
Returns

+
 the “flags” property of the setting

+

+

 

 

 

-
enum NMVlanPriorityMap

-
typedef enum {
-	NM_VLAN_INGRESS_MAP,
-	NM_VLAN_EGRESS_MAP
-} NMVlanPriorityMap;
-

-

-A selector for traffic priority maps; these map Linux SKB priorities
-to 802.1p priorities used in VLANs.
-

-

+
nm_setting_vlan_get_num_priorities ()

+
gint32
+nm_setting_vlan_get_num_priorities (NMSettingVlan *setting,
+                                    NMVlanPriorityMap map);

+
Returns the number of entires in the
+“ingress_priority_map” or “egress_priority_map”
+properties of this setting.

+

+
Parameters

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

 





 
 
 
NM_VLAN_INGRESS_MAP
map for incoming data
-
setting
the NMSettingVlan
 
 

 
NM_VLAN_EGRESS_MAP
map for outgoing data
-
map
the type of priority map
 
 

 
 

 

+

+
Returns

+
 return the number of ingress/egress priority entries, -1 if error

+

+

+

 

 

-
enum NMVlanFlags

-
typedef enum {
-	NM_VLAN_FLAG_REORDER_HEADERS = 0x1,
-	NM_VLAN_FLAG_GVRP            = 0x2,
-	NM_VLAN_FLAG_LOOSE_BINDING   = 0x4,
-
-	/* NOTE: if adding flags update nm-setting-vlan.c::verify() */
-} NMVlanFlags;
-

-

-NMVlanFlags values control the behavior of the VLAN interface.
-

-

+
nm_setting_vlan_get_priority ()

+
gboolean
+nm_setting_vlan_get_priority (NMSettingVlan *setting,
+                              NMVlanPriorityMap map,
+                              guint32 idx,
+                              guint32 *out_from,
+                              guint32 *out_to);

+
Retrieve one of the entries of the “ingress_priority_map”
+or “egress_priority_map” properties of this setting.

+

+
Parameters

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

 





 
 
 
NM_VLAN_FLAG_REORDER_HEADERS
indicates that this interface should reorder
- outgoing packet headers to look more like a non-VLAN ethernet interface
-
setting
the NMSettingVlan
 
 

 
NM_VLAN_FLAG_GVRP
indicates that this interface should use GVRP to register
- itself with it's switch
-
map
the type of priority map
 
 

 
NM_VLAN_FLAG_LOOSE_BINDING
indicates that this interface's operating
- state is tied to the underlying network interface but other details
- (like routing) are not.
-
idx
the zero-based index of the ingress/egress priority map entry
 
out_from
 on return the value of the priority map's 'from' item. 
[out]
out_to
 on return the value of priority map's 'to' item. 
[out]
 

 
 

 

-

-

-
nm_setting_vlan_new ()

-
NMSetting *         nm_setting_vlan_new                 (void);

-

-Creates a new NMSettingVlan object with default values.
-

-

----
-
-
-
-
-




Returns :
the new empty NMSettingVlan object. [transfer full]
-

+

+
Returns

+
 TRUE if a priority map was returned, FALSE if error

+

+

 

 

 

-
nm_setting_vlan_get_interface_name ()

-
const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);

-

+
nm_setting_vlan_add_priority ()

+
gboolean
+nm_setting_vlan_add_priority (NMSettingVlan *setting,
+                              NMVlanPriorityMap map,
+                              guint32 from,
+                              guint32 to);

+
Adds a priority mapping to the “ingress_priority_map” or
+“egress_priority_map” properties of the setting. If from
+ is
+already in the given priority map, this function will overwrite the
+existing entry with the new to
+.

+
If map
+ is NM_VLAN_INGRESS_MAP then from
+ is the incoming 802.1q VLAN
+Priority Code Point (PCP) value, and to
+ is the Linux SKB priority value.

+
If map
+ is NM_VLAN_EGRESS_MAP then from
+ is the Linux SKB priority value and
+to
+ is the outgoing 802.1q VLAN Priority Code Point (PCP) value.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingVlan
-
setting
the NMSettingVlan
 
 

 
Returns :
the "interface_name" property of the setting
map
the type of priority map
 
 

-

-

-

-
nm_setting_vlan_get_parent ()

-
const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);

-

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




 
setting :
the NMSettingVlan
-
from
the priority to map to to
+
 
 

 
Returns :
the "parent" property of the setting
to
the priority to map from
+to
 
 

 
 

 

+

+
Returns

+
 TRUE if the new priority mapping was successfully added to the
+list, FALSE if error

+

+

+

 

 

-
nm_setting_vlan_get_id ()

-
guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);

-

+
nm_setting_vlan_remove_priority ()

+
void
+nm_setting_vlan_remove_priority (NMSettingVlan *setting,
+                                 NMVlanPriorityMap map,
+                                 guint32 idx);

+
Removes the priority map at index idx
+ from the
+“ingress_priority_map” or “egress_priority_map”
+properties.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingVlan
-
setting
the NMSettingVlan
 
 

 
Returns :
the "id" property of the setting
map
the type of priority map
 
idx
the zero-based index of the priority map to remove
 
 

 
 

 

+
-

nm_setting_vlan_get_flags ()

-
guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-
+

nm_setting_vlan_clear_priorities ()

+
void
+nm_setting_vlan_clear_priorities (NMSettingVlan *setting,
+                                  NMVlanPriorityMap map);
+

Clear all the entires from “ingress_priority_map” or +“egress_priority_map” properties.

+
+

Parameters

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

setting :

the NMSettingVlan -

setting

the NMSettingVlan

 

Returns :

the "flags" property of the setting

map

the type of priority map

 
+
-

nm_setting_vlan_get_num_priorities ()

-
gint32              nm_setting_vlan_get_num_priorities  (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
-

-Returns the number of entires in the -"ingress_priority_map" or "egress_priority_map" -properties of this setting. -

-
+

nm_setting_vlan_add_priority_str ()

+
gboolean
+nm_setting_vlan_add_priority_str (NMSettingVlan *setting,
+                                  NMVlanPriorityMap map,
+                                  const char *str);
+

Adds a priority map entry into either the “ingress_priority_map” +or the “egress_priority_map” properties. The priority map maps +the Linux SKB priorities to 802.1p priorities.

+
+

Parameters

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

setting :

the NMSettingVlan -

setting

the NMSettingVlan

 

map :

the type of priority map

map

the type of priority map

 

Returns :

return the number of ingress/egress priority entries, -1 if error

str

the string which contains a priority map, like "3:7"

 
-
+
+

Returns

+

TRUE if the entry was successfully added to the list, or it +overwrote the old value, FALSE if error

+

+
+
+
+
+

Types and Values

-

nm_setting_vlan_get_priority ()

-
gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 idx,
-                                                         guint32 *out_from,
-                                                         guint32 *out_to);
+

NM_SETTING_VLAN_SETTING_NAME

+
#define NM_SETTING_VLAN_SETTING_NAME "vlan"
+

-Retrieve one of the entries of the "ingress_priority_map" -or "egress_priority_map" properties of this setting.

-
+ +
+
+

enum NMSettingVlanError

+
+

Members

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

setting :

the NMSettingVlan +

NM_SETTING_VLAN_ERROR_UNKNOWN

 +

unknown or unclassified error

 

map :

the type of priority map

idx :

the zero-based index of the ingress/egress priority map entry

out_from :

on return the value of the priority map's 'from' item. [out] +

NM_SETTING_VLAN_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

out_to :

on return the value of priority map's 'to' item. [out] +

NM_SETTING_VLAN_ERROR_MISSING_PROPERTY

 +

the property was missing and is + required

 

Returns :

 -TRUE if a priority map was returned, FALSE if error

NM_SETTING_VLAN_ERROR_INVALID_PARENT

 +

the VLAN parent was specified + inconsistently

+		 
+
+
+
+

NM_SETTING_VLAN_ERROR

+
#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark ()
+
+

+

+
-

nm_setting_vlan_add_priority ()

-
gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);
+

NM_SETTING_VLAN_INTERFACE_NAME

+
#define NM_SETTING_VLAN_INTERFACE_NAME       "interface-name"
+

-Adds a priority mapping to the "ingress_priority_map" or -"egress_priority_map" properties of the setting. If from is -already in the given priority map, this function will overwrite the -existing entry with the new to.

+
+
+
+

NM_SETTING_VLAN_PARENT

+
#define NM_SETTING_VLAN_PARENT               "parent"
+

-If map is NM_VLAN_INGRESS_MAP then from is the incoming 802.1q VLAN -Priority Code Point (PCP) value, and to is the Linux SKB priority value.

+
+
+
+

NM_SETTING_VLAN_ID

+
#define NM_SETTING_VLAN_ID                   "id"
+

-If map is NM_VLAN_EGRESS_MAP then from is the Linux SKB priority value and -to is the outgoing 802.1q VLAN Priority Code Point (PCP) value.

-
---- - - - - - - - - - - - - - - - - - - - - - - -

setting :

the NMSettingVlan -

map :

the type of priority map

from :

the priority to map to to -

to :

the priority to map from to

Returns :

TRUE if the new priority mapping was successfully added to the -list, FALSE if error
-

nm_setting_vlan_remove_priority ()

-
void                nm_setting_vlan_remove_priority     (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 idx);
+

NM_SETTING_VLAN_FLAGS

+
#define NM_SETTING_VLAN_FLAGS                "flags"
+
+

+

+
+
+
+

NM_SETTING_VLAN_INGRESS_PRIORITY_MAP

+
#define NM_SETTING_VLAN_INGRESS_PRIORITY_MAP "ingress-priority-map"
+

-Removes the priority map at index idx from the -"ingress_priority_map" or "egress_priority_map" -properties.

-
---- - - - - - - - - - - - - - - -

setting :

the NMSettingVlan -

map :

the type of priority map

idx :

the zero-based index of the priority map to remove
-

nm_setting_vlan_clear_priorities ()

-
void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
+

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

+
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
+

-Clear all the entires from "ingress_priority_map" or -"egress_priority_map" properties.

-
+ +
+
+

enum NMVlanPriorityMap

+

A selector for traffic priority maps; these map Linux SKB priorities +to 802.1p priorities used in VLANs.

+
+

Members

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

setting :

the NMSettingVlan +

NM_VLAN_INGRESS_MAP

 +

map for incoming data

 

map :

the type of priority map

NM_VLAN_EGRESS_MAP

 +

map for outgoing data

+		 
+
-

nm_setting_vlan_add_priority_str ()

-
gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         const char *str);
-

-Adds a priority map entry into either the "ingress_priority_map" -or the "egress_priority_map" properties. The priority map maps -the Linux SKB priorities to 802.1p priorities. -

-
+

enum NMVlanFlags

+

NMVlanFlags values control the behavior of the VLAN interface.

+
+

Members

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

setting :

the NMSettingVlan +

NM_VLAN_FLAG_REORDER_HEADERS

 +

indicates that this interface should reorder + outgoing packet headers to look more like a non-VLAN ethernet interface

 

map :

the type of priority map

str :

the string which contains a priority map, like "3:7"

NM_VLAN_FLAG_GVRP

 +

indicates that this interface should use GVRP to register + itself with it's switch

+		 

Returns :

TRUE if the entry was successfully added to the list, or it -overwrote the old value, FALSE if error

NM_VLAN_FLAG_LOOSE_BINDING

 +

indicates that this interface's operating + state is tied to the underlying network interface but other details + (like routing) are not.

+		 
+

Property Details

-

The "egress-priority-map" property

-
  "egress-priority-map"      GSList_gchararray_*   : Read / Write
-

-For outgoing packets, a list of mappings from Linux SKB priorities to -802.1p priorities. The mapping is given in the format 'from:to' -where both 'from' and 'to' are unsigned integers, ie '7:3'. -

+

The “egress-priority-map” property

+
  “egress-priority-map”      GSList_gchararray_ *
+

For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.

+

Flags: Read / Write

-

The "flags" property

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

-One or more of NMVlanFlags which control the behavior and features of -the VLAN interface. -

+

The “flags” property

+
  “flags”                    guint
+

One or more flags which control the behavior and features of the VLAN interface. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device's operating state (0x04).

+

Flags: Read / Write / Construct

Default value: 0

-

The "id" property

-
  "id"                       guint                 : Read / Write / Construct
-

-The VLAN identifier the interface created by this connection should be -assigned. -

+

The “id” property

+
  “id”                       guint
+

The VLAN indentifier the interface created by this connection should be assigned.

+

Flags: Read / Write / Construct

Allowed values: <= 4095

Default value: 0

-

The "ingress-priority-map" property

-
  "ingress-priority-map"     GSList_gchararray_*   : Read / Write
-

-For incoming packets, a list of mappings from 802.1p priorities to Linux -SKB priorities. The mapping is given in the format 'from:to' where both -'from' and 'to' are unsigned integers, ie '7:3'. -

+

The “ingress-priority-map” property

+
  “ingress-priority-map”     GSList_gchararray_ *
+

For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.

+

Flags: Read / Write

-

The "interface-name" property

-
  "interface-name"           gchar*                : Read / Write / Construct
-

-If given, specifies the kernel name of the VLAN interface. If not given, -a default name will be constructed from the interface described by the -parent interface and the "id" , ex 'eth2.1'. The parent -interface may be given by the "parent" property or by a -hardware address property, eg "mac-address". -

+

The “interface-name” property

+
  “interface-name”           gchar *
+

If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by a hardware address property, eg the 'wired' settings' 'mac-address' property.

+

Flags: Read / Write / Construct

Default value: NULL

-

The "parent" property

-
  "parent"                   gchar*                : Read / Write / Construct
-

-If given, specifies the parent interface name or parent connection UUID -from which this VLAN interface should be created. If this property is -not specified, the connection must contain a hardware address in a -hardware-specific setting, like "mac-address". -

+

The “parent” property

+
  “parent”                   gchar *
+

If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a hardware address in a hardware-specific setting, like the 'wired' settings' 'mac-address' property.

+

Flags: Read / Write / Construct

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWimax.html b/docs/libnm-util/html/NMSettingWimax.html index 00676582..89053dca 100644 --- a/docs/libnm-util/html/NMSettingWimax.html +++ b/docs/libnm-util/html/NMSettingWimax.html @@ -2,34 +2,28 @@ -NMSettingWimax +libnm-util Reference Manual: NMSettingWimax - + - - - - - - - - - - + + + + + + +
@@ -37,250 +31,297 @@

NMSettingWimax

NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties

- +
-
-

Synopsis

-
-#include <nm-setting-wimax.h>
-
-#define             NM_SETTING_WIMAX_SETTING_NAME
-enum                NMSettingWimaxError;
-#define             NM_SETTING_WIMAX_ERROR
-GQuark              nm_setting_wimax_error_quark        (void);
-#define             NM_SETTING_WIMAX_NETWORK_NAME
-#define             NM_SETTING_WIMAX_MAC_ADDRESS
-                    NMSettingWimax;
-                    NMSettingWimaxClass;
-NMSetting *         nm_setting_wimax_new                (void);
-const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
-const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingWimaxError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingWimax
-
-
-
-

Properties

-
-  "mac-address"              GArray_guchar_*       : Read / Write
-  "network-name"             gchar*                : Read / Write
-
-
-
-

Description

-

-The NMSettingWimax object is a NMSetting subclass that describes properties -necessary for connection to 802.16e Mobile WiMAX networks. -

-
-

Details

-
-

NM_SETTING_WIMAX_SETTING_NAME

-
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
-
-

-

-
-
-
-

enum NMSettingWimaxError

-
typedef enum {
-	NM_SETTING_WIMAX_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
-} NMSettingWimaxError;
-
-
+

Functions

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

NM_SETTING_WIMAX_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_wimax_error_quark ()

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

the property was invalid + +NMSetting * + +nm_setting_wimax_new ()

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

the property was missing and is -required +const char * + +nm_setting_wimax_get_network_name () +
const GByteArray * + +nm_setting_wimax_get_mac_address ()
-
-
-

NM_SETTING_WIMAX_ERROR

-
#define NM_SETTING_WIMAX_ERROR nm_setting_wimax_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + +
+GArray_guchar_ *mac-addressRead / Write
+gchar *network-nameRead / Write
-
-
-

nm_setting_wimax_error_quark ()

-
GQuark              nm_setting_wimax_error_quark        (void);
-

-Registers an error quark for NMSettingWimax if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingWimax errors.
#defineNM_SETTING_WIMAX_SETTING_NAME
enumNMSettingWimaxError
#defineNM_SETTING_WIMAX_ERROR
#defineNM_SETTING_WIMAX_NETWORK_NAME
#defineNM_SETTING_WIMAX_MAC_ADDRESS
-
-
-

NM_SETTING_WIMAX_NETWORK_NAME

-
#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingWimaxError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingWimax
 

-

-

 

-

-

-
NM_SETTING_WIMAX_MAC_ADDRESS

-
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
+

+
Includes

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

-

-

 

-

+

+
Description

+
The NMSettingWimax object is a NMSetting subclass that describes properties
+necessary for connection to 802.16e Mobile WiMAX networks.

+

+

+
Functions

 

-
NMSettingWimax

-
typedef struct _NMSettingWimax NMSettingWimax;

-

-

+
nm_setting_wimax_error_quark ()

+
GQuark
+nm_setting_wimax_error_quark (void);

+
Registers an error quark for NMSettingWimax if necessary.

+

+
Returns

+
 the error quark used for NMSettingWimax errors.

+

+

 

 

 

-
NMSettingWimaxClass

-
typedef struct {
-	NMSettingClass parent;
-} NMSettingWimaxClass;
-

-

-

+
nm_setting_wimax_new ()

+
NMSetting *
+nm_setting_wimax_new (void);

+
Creates a new NMSettingWimax object with default values.

+

+
Returns

+
 the new empty NMSettingWimax object

+

+

 

 

 

-
nm_setting_wimax_new ()

-
NMSetting *         nm_setting_wimax_new                (void);

-

-Creates a new NMSettingWimax object with default values.
-

-

+
nm_setting_wimax_get_network_name ()

+
const char *
+nm_setting_wimax_get_network_name (NMSettingWimax *setting);

+
Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the
+specific WiMAX network this setting describes a connection to.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingWimax object
setting
the NMSettingWimax
 
 

 

 

+

+
Returns

+
 the WiMAX NSP name

+

+

+

 

 

-
nm_setting_wimax_get_network_name ()

-
const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);

-

-Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the
-specific WiMAX network this setting describes a connection to.
-

-

+
nm_setting_wimax_get_mac_address ()

+
const GByteArray *
+nm_setting_wimax_get_mac_address (NMSettingWimax *setting);

+
Returns the MAC address of a WiMAX device which this connection is locked
+to.

+

+
Parameters

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

 





 
setting :
the NMSettingWimax
-
Returns :
the WiMAX NSP name
setting
the NMSettingWimax
 

 

 

-

+

+
Returns

+
 the MAC address

+

+

+

+
+
+

Types and Values

-

nm_setting_wimax_get_mac_address ()

-
const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+

NM_SETTING_WIMAX_SETTING_NAME

+
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
+

-Returns the MAC address of a WiMAX device which this connection is locked -to.

-
+ +
+
+

enum NMSettingWimaxError

+
+

Members

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

setting :

the NMSettingWimax +

NM_SETTING_WIMAX_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

the MAC address

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

 +

the property was invalid

+		 

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 
-
-

Property Details

+
+
+

NM_SETTING_WIMAX_ERROR

+
#define NM_SETTING_WIMAX_ERROR nm_setting_wimax_error_quark ()
+
+

+

+
+
-

The "mac-address" property

-
  "mac-address"              GArray_guchar_*       : Read / Write
+

NM_SETTING_WIMAX_NETWORK_NAME

+
#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
+

-If specified, this connection will only apply to the WiMAX device -whose MAC address matches. This property does not change the MAC address -of the device (known as MAC spoofing).

-

The "network-name" property

-
  "network-name"             gchar*                : Read / Write
+

NM_SETTING_WIMAX_MAC_ADDRESS

+
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
+

-Network Service Provider (NSP) name of the WiMAX network this connection -should use.

+
+
+
+

Property Details

+
+

The “mac-address” property

+
  “mac-address”              GArray_guchar_ *
+

If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).

+

Flags: Read / Write

+
+
+
+

The “network-name” property

+
  “network-name”             gchar *
+

Network Service Provider (NSP) name of the WiMAX network this connection should use.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWired.html b/docs/libnm-util/html/NMSettingWired.html index 75d9cf16..123af42f 100644 --- a/docs/libnm-util/html/NMSettingWired.html +++ b/docs/libnm-util/html/NMSettingWired.html @@ -2,34 +2,28 @@ -NMSettingWired +libnm-util Reference Manual: NMSettingWired - + - - - - - - - - - - + + + + + + +
@@ -37,781 +31,985 @@

NMSettingWired

NMSettingWired — Describes connection properties for Ethernet-based networks

- +
-
-

Synopsis

-
-#include <nm-setting-wired.h>
-
-#define             NM_SETTING_WIRED_SETTING_NAME
-enum                NMSettingWiredError;
-#define             NM_SETTING_WIRED_ERROR
-GQuark              nm_setting_wired_error_quark        (void);
-#define             NM_SETTING_WIRED_PORT
-#define             NM_SETTING_WIRED_SPEED
-#define             NM_SETTING_WIRED_DUPLEX
-#define             NM_SETTING_WIRED_AUTO_NEGOTIATE
-#define             NM_SETTING_WIRED_MAC_ADDRESS
-#define             NM_SETTING_WIRED_CLONED_MAC_ADDRESS
-#define             NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST
-#define             NM_SETTING_WIRED_MTU
-#define             NM_SETTING_WIRED_S390_SUBCHANNELS
-#define             NM_SETTING_WIRED_S390_NETTYPE
-#define             NM_SETTING_WIRED_S390_OPTIONS
-                    NMSettingWired;
-                    NMSettingWiredClass;
-NMSetting *         nm_setting_wired_new                (void);
-const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
-guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
-const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
-gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
-const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
-const GByteArray *  nm_setting_wired_get_cloned_mac_address
-                                                        (NMSettingWired *setting);
-const GSList *      nm_setting_wired_get_mac_address_blacklist
-                                                        (NMSettingWired *setting);
-guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
-const GPtrArray *   nm_setting_wired_get_s390_subchannels
-                                                        (NMSettingWired *setting);
-const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);
-guint32             nm_setting_wired_get_num_s390_options
-                                                        (NMSettingWired *setting);
-gboolean            nm_setting_wired_get_s390_option    (NMSettingWired *setting,
-                                                         guint32 idx,
-                                                         const char **out_key,
-                                                         const char **out_value);
-const char *        nm_setting_wired_get_s390_option_by_key
-                                                        (NMSettingWired *setting,
-                                                         const char *key);
-gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
-                                                         const char *key,
-                                                         const char *item);
-gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
-                                                         const char *key);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingWiredError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingWired
-
-
-
-

Properties

-
-  "auto-negotiate"           gboolean              : Read / Write / Construct
-  "cloned-mac-address"       GArray_guchar_*       : Read / Write
-  "duplex"                   gchar*                : Read / Write
-  "mac-address"              GArray_guchar_*       : Read / Write
-  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
-  "mtu"                      guint                 : Read / Write / Construct
-  "port"                     gchar*                : Read / Write
-  "s390-nettype"             gchar*                : Read / Write
-  "s390-options"             GHashTable_gchararray+gchararray_*  : Read / Write
-  "s390-subchannels"         GPtrArray_gchararray_*  : Read / Write
-  "speed"                    guint                 : Read / Write / Construct
-
-
-
-

Description

-

-The NMSettingWired object is a NMSetting subclass that describes properties -necessary for connection to Ethernet networks. -

-
-

Details

-
-

NM_SETTING_WIRED_SETTING_NAME

-
#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
-
-

-

-
-
-
-

enum NMSettingWiredError

-
typedef enum {
-	NM_SETTING_WIRED_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_WIRED_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_WIRED_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
-} NMSettingWiredError;
-
-
+

Functions

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

NM_SETTING_WIRED_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_wired_error_quark ()

NM_SETTING_WIRED_ERROR_INVALID_PROPERTY

the property was invalid + +NMSetting * + +nm_setting_wired_new ()

NM_SETTING_WIRED_ERROR_MISSING_PROPERTY

the property was missing and is -required +const char * + +nm_setting_wired_get_port () +
+guint32 + +nm_setting_wired_get_speed () +
const char * + +nm_setting_wired_get_duplex () +
+gboolean + +nm_setting_wired_get_auto_negotiate () +
const GByteArray * + +nm_setting_wired_get_mac_address () +
const GByteArray * + +nm_setting_wired_get_cloned_mac_address () +
const GSList * + +nm_setting_wired_get_mac_address_blacklist () +
+guint32 + +nm_setting_wired_get_mtu () +
const GPtrArray * + +nm_setting_wired_get_s390_subchannels () +
const char * + +nm_setting_wired_get_s390_nettype () +
+guint32 + +nm_setting_wired_get_num_s390_options () +
+gboolean + +nm_setting_wired_get_s390_option () +
const char * + +nm_setting_wired_get_s390_option_by_key () +
+gboolean + +nm_setting_wired_add_s390_option () +
+gboolean + +nm_setting_wired_remove_s390_option ()
-
-
-

NM_SETTING_WIRED_ERROR

-
#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
gbooleanauto-negotiateRead / Write / Construct
+GArray_guchar_ *cloned-mac-addressRead / Write
+gchar *duplexRead / Write
+GArray_guchar_ *mac-addressRead / Write
+GSList_gchararray_ *mac-address-blacklistRead / Write
guintmtuRead / Write / Construct
+gchar *portRead / Write
+gchar *s390-nettypeRead / Write
GHashTable_gchararray+gchararray_*s390-optionsRead / Write
+GPtrArray_gchararray_ *s390-subchannelsRead / Write
guintspeedRead / Write / Construct
-
-
-

nm_setting_wired_error_quark ()

-
GQuark              nm_setting_wired_error_quark        (void);
-

-Registers an error quark for NMSettingWired if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingWired errors.
#defineNM_SETTING_WIRED_SETTING_NAME
enumNMSettingWiredError
#defineNM_SETTING_WIRED_ERROR
#defineNM_SETTING_WIRED_PORT
#defineNM_SETTING_WIRED_SPEED
#defineNM_SETTING_WIRED_DUPLEX
#defineNM_SETTING_WIRED_AUTO_NEGOTIATE
#defineNM_SETTING_WIRED_MAC_ADDRESS
#defineNM_SETTING_WIRED_CLONED_MAC_ADDRESS
#defineNM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST
#defineNM_SETTING_WIRED_MTU
#defineNM_SETTING_WIRED_S390_SUBCHANNELS
#defineNM_SETTING_WIRED_S390_NETTYPE
#defineNM_SETTING_WIRED_S390_OPTIONS
-
-
-

NM_SETTING_WIRED_PORT

-
#define NM_SETTING_WIRED_PORT "port"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingWiredError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingWired
 

-

-

 

-

-

-
NM_SETTING_WIRED_SPEED

-
#define NM_SETTING_WIRED_SPEED "speed"
+

+
Includes

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

-

-

 

-

-

-
NM_SETTING_WIRED_DUPLEX

-
#define NM_SETTING_WIRED_DUPLEX "duplex"
-

-

-

+

+
Description

+
The NMSettingWired object is a NMSetting subclass that describes properties
+necessary for connection to Ethernet networks.

 

-

+

+
Functions

 

-
NM_SETTING_WIRED_AUTO_NEGOTIATE

-
#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
-

-

-

+
nm_setting_wired_error_quark ()

+
GQuark
+nm_setting_wired_error_quark (void);

+
Registers an error quark for NMSettingWired if necessary.

+

+
Returns

+
 the error quark used for NMSettingWired errors.

+

 

-

-

-
NM_SETTING_WIRED_MAC_ADDRESS

-
#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
-

-

-

 

 

 

-
NM_SETTING_WIRED_CLONED_MAC_ADDRESS

-
#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
-

-

-

+
nm_setting_wired_new ()

+
NMSetting *
+nm_setting_wired_new (void);

+
Creates a new NMSettingWired object with default values.

+

+
Returns

+
 the new empty NMSettingWired object. 

+
[transfer full]

 

-

-

-
NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

-
#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
-

-

-

 

 

 

-
NM_SETTING_WIRED_MTU

-
#define NM_SETTING_WIRED_MTU "mtu"
-

-

-

+
nm_setting_wired_get_port ()

+
const char *
+nm_setting_wired_get_port (NMSettingWired *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingWired
 

 

-

-

-
NM_SETTING_WIRED_S390_SUBCHANNELS

-
#define NM_SETTING_WIRED_S390_SUBCHANNELS "s390-subchannels"
-

-

-

+

+
Returns

+
 the “port” property of the setting

+

 

-

-

-
NM_SETTING_WIRED_S390_NETTYPE

-
#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
-

-

-

 

 

 

-
NM_SETTING_WIRED_S390_OPTIONS

-
#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
-

-

-

+
nm_setting_wired_get_speed ()

+
guint32
+nm_setting_wired_get_speed (NMSettingWired *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingWired
 

 

-

-

-
NMSettingWired

-
typedef struct _NMSettingWired NMSettingWired;

-

-

+

+
Returns

+
 the “speed” property of the setting

+

 

-

-

-
NMSettingWiredClass

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

-

-

 

 

 

-
nm_setting_wired_new ()

-
NMSetting *         nm_setting_wired_new                (void);

-

-Creates a new NMSettingWired object with default values.
-

-

+
nm_setting_wired_get_duplex ()

+
const char *
+nm_setting_wired_get_duplex (NMSettingWired *setting);

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingWired object. [transfer full]
-
setting
the NMSettingWired
 
 

 

 

+

+
Returns

+
 the “duplex” property of the setting

+

+

+

 

 

-
nm_setting_wired_get_port ()

-
const char *        nm_setting_wired_get_port           (NMSettingWired *setting);

-

+
nm_setting_wired_get_auto_negotiate ()

+
gboolean
+nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "port" property of the setting
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 the “auto-negotiate” property of the setting

+

+

+

 

 

-
nm_setting_wired_get_speed ()

-
guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);

-

+
nm_setting_wired_get_mac_address ()

+
const GByteArray *
+nm_setting_wired_get_mac_address (NMSettingWired *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "speed" property of the setting
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 the “mac-address” property of the setting

+

+

+

 

 

-
nm_setting_wired_get_duplex ()

-
const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);

-

+
nm_setting_wired_get_cloned_mac_address ()

+
const GByteArray *
+nm_setting_wired_get_cloned_mac_address
+                               (NMSettingWired *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "duplex" property of the setting
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 the “cloned-mac-address” property of the setting

+

+

+

 

 

-
nm_setting_wired_get_auto_negotiate ()

-
gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);

-

+
nm_setting_wired_get_mac_address_blacklist ()

+
const GSList *
+nm_setting_wired_get_mac_address_blacklist
+                               (NMSettingWired *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "auto-negotiate" property of the setting
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 the “mac-address-blacklist”
+property of the setting. 

+
[element-type GLib.ByteArray]

+

+

 

 

-
nm_setting_wired_get_mac_address ()

-
const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);

-

+
nm_setting_wired_get_mtu ()

+
guint32
+nm_setting_wired_get_mtu (NMSettingWired *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "mac-address" property of the setting
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 the “mtu” property of the setting

+

+

+

 

 

-
nm_setting_wired_get_cloned_mac_address ()

-
const GByteArray *  nm_setting_wired_get_cloned_mac_address
-                                                        (NMSettingWired *setting);

-

+
nm_setting_wired_get_s390_subchannels ()

+
const GPtrArray *
+nm_setting_wired_get_s390_subchannels (NMSettingWired *setting);

+
Return the list of s390 subchannels that identify the device that this
+connection is applicable to.  The connection should only be used in
+conjunction with that device.

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "cloned-mac-address" property of the setting
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 GPtrArray of strings, each specifying one
+subchannel the s390 device uses to communicate to the host. 

+
[element-type utf8]

+

+

 

 

-
nm_setting_wired_get_mac_address_blacklist ()

-
const GSList *      nm_setting_wired_get_mac_address_blacklist
-                                                        (NMSettingWired *setting);

-

+
nm_setting_wired_get_s390_nettype ()

+
const char *
+nm_setting_wired_get_s390_nettype (NMSettingWired *setting);

+
Returns the s390 device type this connection should apply to.  Will be one
+of 'qeth', 'lcs', or 'ctc'.

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "mac-address-blacklist"
-property of the setting. [element-type GLib.ByteArray]
-
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 the s390 device type

+

+

+

 

 

-
nm_setting_wired_get_mtu ()

-
guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);

-

+
nm_setting_wired_get_num_s390_options ()

+
guint32
+nm_setting_wired_get_num_s390_options (NMSettingWired *setting);

+
Returns the number of s390-specific options that should be set for this
+device when it is activated.  This can be used to retrieve each s390
+option individually using nm_setting_wired_get_s390_option().

+

+
Parameters

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

 





 
setting :
the NMSettingWired
-
Returns :
the "mtu" property of the setting
setting
the NMSettingWired
 

 

 

+

+
Returns

+
 the number of s390-specific device options

+

+

+

 

 

-
nm_setting_wired_get_s390_subchannels ()

-
const GPtrArray *   nm_setting_wired_get_s390_subchannels
-                                                        (NMSettingWired *setting);

-

-Return the list of s390 subchannels that identify the device that this
-connection is applicable to.  The connection should only be used in
-conjunction with that device.
-

-

+
nm_setting_wired_get_s390_option ()

+
gboolean
+nm_setting_wired_get_s390_option (NMSettingWired *setting,
+                                  guint32 idx,
+                                  const char **out_key,
+                                  const char **out_value);

+
Given an index, return the value of the s390 option at that index.  indexes
+are *not* guaranteed to be static across modifications to options done by
+nm_setting_wired_add_s390_option() and nm_setting_wired_remove_s390_option(),
+and should not be used to refer to options except for short periods of time
+such as during option iteration.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingWired
-
setting
the NMSettingWired
 
 

 
Returns :

-GPtrArray of strings, each specifying one
-subchannel the s390 device uses to communicate to the host. [element-type utf8]
-
idx
index of the desired option, from 0 to
+nm_setting_wired_get_num_s390_options() - 1
 
out_key
 on return, the key name of the s390 specific option; this
+value is owned by the setting and should not be modified. 
[out]
out_value
 on return, the value of the key of the s390 specific
+option; this value is owned by the setting and should not be modified. 
[out]
 

 
 

 

+

+
Returns

+
 TRUE on success if the index was valid and an option was found,
+FALSE if the index was invalid (ie, greater than the number of options
+currently held by the setting)

+

+

+
-

nm_setting_wired_get_s390_nettype ()

-
const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);
-

-Returns the s390 device type this connection should apply to. Will be one -of 'qeth', 'lcs', or 'ctc'. -

-
+

nm_setting_wired_get_s390_option_by_key ()

+
const char *
+nm_setting_wired_get_s390_option_by_key
+                               (NMSettingWired *setting,
+                                const char *key);
+

Returns the value associated with the s390-specific option specified by +key +, if it exists.

+
+

Parameters

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

setting :

the NMSettingWired -

setting

the NMSettingWired

 

Returns :

the s390 device type

key

the key for which to retrieve the value

 
+
+

Returns

+

the value, or NULL if the key/value pair was never added to the +setting; the value is owned by the setting and must not be modified

+

+
+
-

nm_setting_wired_get_num_s390_options ()

-
guint32             nm_setting_wired_get_num_s390_options
-                                                        (NMSettingWired *setting);
+

nm_setting_wired_add_s390_option ()

+
gboolean
+nm_setting_wired_add_s390_option (NMSettingWired *setting,
+                                  const char *key,
+                                  const char *item);

-Returns the number of s390-specific options that should be set for this -device when it is activated. This can be used to retrieve each s390 -option individually using nm_setting_wired_get_s390_option().

-
---- - - - - - - - - - - -

setting :

the NMSettingWired -

Returns :

the number of s390-specific device options
+
+

Returns

+

+
-

nm_setting_wired_get_s390_option ()

-
gboolean            nm_setting_wired_get_s390_option    (NMSettingWired *setting,
-                                                         guint32 idx,
-                                                         const char **out_key,
-                                                         const char **out_value);
+

nm_setting_wired_remove_s390_option ()

+
gboolean
+nm_setting_wired_remove_s390_option (NMSettingWired *setting,
+                                     const char *key);
+

+

+
+

Returns

+

+
+
+
+
+

Types and Values

+
+

NM_SETTING_WIRED_SETTING_NAME

+
#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
+

-Given an index, return the value of the s390 option at that index. indexes -are *not* guaranteed to be static across modifications to options done by -nm_setting_wired_add_s390_option() and nm_setting_wired_remove_s390_option(), -and should not be used to refer to options except for short periods of time -such as during option iteration.

-
+ +
+
+

enum NMSettingWiredError

+
+

Members

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

setting :

the NMSettingWired +

NM_SETTING_WIRED_ERROR_UNKNOWN

 +

unknown or unclassified error

 

idx :

index of the desired option, from 0 to -nm_setting_wired_get_num_s390_options() - 1

out_key :

on return, the key name of the s390 specific option; this -value is owned by the setting and should not be modified. [out] +

NM_SETTING_WIRED_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

out_value :

on return, the value of the key of the s390 specific -option; this value is owned by the setting and should not be modified. [out] +

NM_SETTING_WIRED_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

Returns :

 -TRUE on success if the index was valid and an option was found, -FALSE if the index was invalid (ie, greater than the number of options -currently held by the setting) 
+
-

nm_setting_wired_get_s390_option_by_key ()

-
const char *        nm_setting_wired_get_s390_option_by_key
-                                                        (NMSettingWired *setting,
-                                                         const char *key);
+

NM_SETTING_WIRED_ERROR

+
#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
+

-Returns the value associated with the s390-specific option specified by -key, if it exists.

-
---- - - - - - - - - - - - - - - -

setting :

the NMSettingWired -

key :

the key for which to retrieve the value

Returns :

the value, or NULL if the key/value pair was never added to the -setting; the value is owned by the setting and must not be modified
-

nm_setting_wired_add_s390_option ()

-
gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
-                                                         const char *key,
-                                                         const char *item);
+

NM_SETTING_WIRED_PORT

+
#define NM_SETTING_WIRED_PORT "port"
+

-

nm_setting_wired_remove_s390_option ()

-
gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
-                                                         const char *key);
+

NM_SETTING_WIRED_SPEED

+
#define NM_SETTING_WIRED_SPEED "speed"
+

-
-
-

Property Details

-
-

The "auto-negotiate" property

-
  "auto-negotiate"           gboolean              : Read / Write / Construct
-

If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.

-

Default value: TRUE

-
-

The "cloned-mac-address" property

-
  "cloned-mac-address"       GArray_guchar_*       : Read / Write
+

NM_SETTING_WIRED_DUPLEX

+
#define NM_SETTING_WIRED_DUPLEX "duplex"
+

-If specified, request that the device use this MAC address instead of its -permanent MAC address. This is known as MAC cloning or spoofing.

-

The "duplex" property

-
  "duplex"                   gchar*                : Read / Write
+

NM_SETTING_WIRED_AUTO_NEGOTIATE

+
#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
+

-If specified, request that the device only use the specified duplex mode. -Either 'half' or 'full'.

-

Default value: NULL

-

The "mac-address" property

-
  "mac-address"              GArray_guchar_*       : Read / Write
+

NM_SETTING_WIRED_MAC_ADDRESS

+
#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
+

-If specified, this connection will only apply to the ethernet device -whose permanent MAC address matches. This property does not change the MAC address -of the device (i.e. MAC spoofing).

-

The "mac-address-blacklist" property

-
  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
+

NM_SETTING_WIRED_CLONED_MAC_ADDRESS

+
#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
+

-If specified, this connection will never apply to the ethernet device -whose permanent MAC address matches an address in the list. Each -MAC address is in the standard hex-digits-and-colons notation -(00:11:22:33:44:55).

-

The "mtu" property

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

NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+

-If non-zero, only transmit packets of the specified size or smaller, -breaking larger packets up into multiple Ethernet frames.

-

Default value: 0

-

The "port" property

-
  "port"                     gchar*                : Read / Write
+

NM_SETTING_WIRED_MTU

+
#define NM_SETTING_WIRED_MTU "mtu"
+

-Specific port type to use if multiple the device supports multiple -attachment methods. One of 'tp' (Twisted Pair), 'aui' (Attachment Unit -Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface. -If the device supports only one port type, this setting is ignored.

-

Default value: NULL

-

The "s390-nettype" property

-
  "s390-nettype"             gchar*                : Read / Write
+

NM_SETTING_WIRED_S390_SUBCHANNELS

+
#define NM_SETTING_WIRED_S390_SUBCHANNELS "s390-subchannels"
+

-s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing -the different types of virtual network devices available on s390 systems.

-

Default value: NULL

-

The "s390-options" property

-
  "s390-options"             GHashTable_gchararray+gchararray_*  : Read / Write
+

NM_SETTING_WIRED_S390_NETTYPE

+
#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
+

-Dictionary of key/value pairs of s390-specific device options. Both keys -and values must be strings. Allowed keys include 'portno', 'layer2', -'portname', 'protocol', among others. Key names must contain only -alphanumeric characters (ie, [a-zA-Z0-9]).

-

The "s390-subchannels" property

-
  "s390-subchannels"         GPtrArray_gchararray_*  : Read / Write
+

NM_SETTING_WIRED_S390_OPTIONS

+
#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
+

-Identifies specific subchannels that this network device uses for -communcation with z/VM or s390 host. Like "mac-address" -for non-z/VM devices, this property can be used to ensure this connection -only applies to the network device that uses these subchannels. The -list should contain exactly 3 strings, and each string may only be -composed of hexadecimal characters and the period (.) character.

+
+
+

Property Details

+
+

The “auto-negotiate” property

+
  “auto-negotiate”           gboolean
+

If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.

+

Flags: Read / Write / Construct

+

Default value: TRUE

+
-

The "speed" property

-
  "speed"                    guint                 : Read / Write / Construct
-

-If non-zero, request that the device use only the specified speed. - -In Mbit/s, ie 100 == 100Mbit/s. -

+

The “cloned-mac-address” property

+
  “cloned-mac-address”       GArray_guchar_ *
+

If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.

+

Flags: Read / Write

+
+
+
+

The “duplex” property

+
  “duplex”                   gchar *
+

If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “mac-address” property

+
  “mac-address”              GArray_guchar_ *
+

If specified, this connection will only apply to the ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

+

Flags: Read / Write

+
+
+
+

The “mac-address-blacklist” property

+
  “mac-address-blacklist”    GSList_gchararray_ *
+

If specified, this connection will never apply to the ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).

+

Flags: Read / Write

+
+
+
+

The “mtu” property

+
  “mtu”                      guint
+

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “port” property

+
  “port”                     gchar *
+

Specific port type to use if multiple the device supports multiple attachment methods. One of 'tp' (Twisted Pair), 'aui' (Attachment Unit Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface. If the device supports only one port type, this setting is ignored.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “s390-nettype” property

+
  “s390-nettype”             gchar *
+

s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing the different types of virtual network devices available on s390 systems.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “s390-options” property

+
  “s390-options”             GHashTable_gchararray+gchararray_*
+

Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include 'portno', 'layer2', 'portname', 'protocol', among others.

+

Flags: Read / Write

+
+
+
+

The “s390-subchannels” property

+
  “s390-subchannels”         GPtrArray_gchararray_ *
+

Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host. Like the 'mac-address' property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.

+

Flags: Read / Write

+
+
+
+

The “speed” property

+
  “speed”                    guint
+

If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.

+

Flags: Read / Write / Construct

Default value: 0

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWireless.html b/docs/libnm-util/html/NMSettingWireless.html index a792acc9..7987e145 100644 --- a/docs/libnm-util/html/NMSettingWireless.html +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -2,34 +2,28 @@ -NMSettingWireless +libnm-util Reference Manual: NMSettingWireless - + - - - - - - - - - - + + + + + + +
@@ -37,967 +31,1218 @@

NMSettingWireless

NMSettingWireless — Describes connection properties for 802.11 WiFi networks

- +
-
-

Synopsis

-
-#include <nm-setting-wireless.h>
-
-#define             NM_SETTING_WIRELESS_SETTING_NAME
-enum                NMSettingWirelessError;
-#define             NM_SETTING_WIRELESS_ERROR
-GQuark              nm_setting_wireless_error_quark     (void);
-#define             NM_SETTING_WIRELESS_SSID
-#define             NM_SETTING_WIRELESS_MODE
-#define             NM_SETTING_WIRELESS_BAND
-#define             NM_SETTING_WIRELESS_CHANNEL
-#define             NM_SETTING_WIRELESS_BSSID
-#define             NM_SETTING_WIRELESS_RATE
-#define             NM_SETTING_WIRELESS_TX_POWER
-#define             NM_SETTING_WIRELESS_MAC_ADDRESS
-#define             NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS
-#define             NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST
-#define             NM_SETTING_WIRELESS_MTU
-#define             NM_SETTING_WIRELESS_SEEN_BSSIDS
-#define             NM_SETTING_WIRELESS_SEC
-#define             NM_SETTING_WIRELESS_HIDDEN
-#define             NM_SETTING_WIRELESS_MODE_ADHOC
-#define             NM_SETTING_WIRELESS_MODE_AP
-#define             NM_SETTING_WIRELESS_MODE_INFRA
-                    NMSettingWireless;
-                    NMSettingWirelessClass;
-NMSetting *         nm_setting_wireless_new             (void);
-const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
-const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
-const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
-const GByteArray *  nm_setting_wireless_get_cloned_mac_address
-                                                        (NMSettingWireless *setting);
-const GSList *      nm_setting_wireless_get_mac_address_blacklist
-                                                        (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
-gboolean            nm_setting_wireless_get_hidden      (NMSettingWireless *setting);
-gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
-                                                         const char *bssid);
-guint32             nm_setting_wireless_get_num_seen_bssids
-                                                        (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
-                                                         guint32 i);
-gboolean            nm_setting_wireless_ap_security_compatible
-                                                        (NMSettingWireless *s_wireless,
-                                                         NMSettingWirelessSecurity *s_wireless_sec,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn,
-                                                         NM80211Mode ap_mode);
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingWirelessError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingWireless
-
-
-
-

Properties

-
-  "band"                     gchar*                : Read / Write
-  "bssid"                    GArray_guchar_*       : Read / Write
-  "channel"                  guint                 : Read / Write / Construct
-  "cloned-mac-address"       GArray_guchar_*       : Read / Write
-  "hidden"                   gboolean              : Read / Write
-  "mac-address"              GArray_guchar_*       : Read / Write
-  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
-  "mode"                     gchar*                : Read / Write
-  "mtu"                      guint                 : Read / Write / Construct
-  "rate"                     guint                 : Read / Write / Construct
-  "security"                 gchar*                : Read / Write
-  "seen-bssids"              GSList_gchararray_*   : Read / Write
-  "ssid"                     GArray_guchar_*       : Read / Write
-  "tx-power"                 guint                 : Read / Write / Construct
-
-
-
-

Description

-

-The NMSettingWireless object is a NMSetting subclass that describes properties -necessary for connection to 802.11 WiFi networks. -

-
-
-

Details

-
-

NM_SETTING_WIRELESS_SETTING_NAME

-
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
-
-

-

-
-
-
-

enum NMSettingWirelessError

-
typedef enum {
-	NM_SETTING_WIRELESS_ERROR_UNKNOWN = 0,              /*< nick=UnknownError >*/
-	NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY,         /*< nick=InvalidProperty >*/
-	NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY,         /*< nick=MissingProperty >*/
-	NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING, /*< nick=MissingSecuritySetting >*/
-	NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND     /*< nick=ChannelRequiresBand >*/
-} NMSettingWirelessError;
-
-
+

Functions

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

NM_SETTING_WIRELESS_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_wireless_error_quark () +
+NMSetting * + +nm_setting_wireless_new () +
const GByteArray * + +nm_setting_wireless_get_ssid () +
const char * + +nm_setting_wireless_get_mode () +
const char * + +nm_setting_wireless_get_band () +
+guint32 + +nm_setting_wireless_get_channel () +
const GByteArray * + +nm_setting_wireless_get_bssid ()

NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY

the property was invalid + +guint32 + +nm_setting_wireless_get_rate ()

NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY

the property was missing and is -required + +guint32 + +nm_setting_wireless_get_tx_power ()

NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING

property values require -the presence of an NMSettingWirelessSecurity object in the connection +const GByteArray * + +nm_setting_wireless_get_mac_address ()

NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND

the property channel was -set to a value that requires the "band" property to be set +const GByteArray * + +nm_setting_wireless_get_cloned_mac_address () +
const GSList * + +nm_setting_wireless_get_mac_address_blacklist () +
+guint32 + +nm_setting_wireless_get_mtu () +
const char * + +nm_setting_wireless_get_security () +
+gboolean + +nm_setting_wireless_get_hidden () +
+gboolean + +nm_setting_wireless_add_seen_bssid () +
+guint32 + +nm_setting_wireless_get_num_seen_bssids () +
const char * + +nm_setting_wireless_get_seen_bssid () +
+gboolean + +nm_setting_wireless_ap_security_compatible ()
-
-
-

NM_SETTING_WIRELESS_ERROR

-
#define NM_SETTING_WIRELESS_ERROR nm_setting_wireless_error_quark ()
-
-

-

-
-
-
-

nm_setting_wireless_error_quark ()

-
GQuark              nm_setting_wireless_error_quark     (void);
-

-Registers an error quark for NMSettingWireless if necessary. -

-
+
+

Properties

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

Returns :

the error quark used for NMSettingWireless errors.
+gchar *bandRead / Write
+GArray_guchar_ *bssidRead / Write
guintchannelRead / Write / Construct
+GArray_guchar_ *cloned-mac-addressRead / Write
gbooleanhiddenRead / Write
+GArray_guchar_ *mac-addressRead / Write
+GSList_gchararray_ *mac-address-blacklistRead / Write
+gchar *modeRead / Write
guintmtuRead / Write / Construct
guintrateRead / Write / Construct
+gchar *securityRead / Write
+GSList_gchararray_ *seen-bssidsRead / Write
+GArray_guchar_ *ssidRead / Write
guinttx-powerRead / Write / Construct
-
-
-

NM_SETTING_WIRELESS_SSID

-
#define NM_SETTING_WIRELESS_SSID        "ssid"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_MODE

-
#define NM_SETTING_WIRELESS_MODE        "mode"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_BAND

-
#define NM_SETTING_WIRELESS_BAND        "band"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_CHANNEL

-
#define NM_SETTING_WIRELESS_CHANNEL     "channel"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_BSSID

-
#define NM_SETTING_WIRELESS_BSSID       "bssid"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_RATE

-
#define NM_SETTING_WIRELESS_RATE        "rate"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_TX_POWER

-
#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_MAC_ADDRESS

-
#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

-
#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_WIRELESS_SETTING_NAME
enumNMSettingWirelessError
#defineNM_SETTING_WIRELESS_ERROR
#defineNM_SETTING_WIRELESS_SSID
#defineNM_SETTING_WIRELESS_MODE
#defineNM_SETTING_WIRELESS_BAND
#defineNM_SETTING_WIRELESS_CHANNEL
#defineNM_SETTING_WIRELESS_BSSID
#defineNM_SETTING_WIRELESS_RATE
#defineNM_SETTING_WIRELESS_TX_POWER
#defineNM_SETTING_WIRELESS_MAC_ADDRESS
#defineNM_SETTING_WIRELESS_CLONED_MAC_ADDRESS
#defineNM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST
#defineNM_SETTING_WIRELESS_MTU
#defineNM_SETTING_WIRELESS_SEEN_BSSIDS
#defineNM_SETTING_WIRELESS_SEC
#defineNM_SETTING_WIRELESS_HIDDEN
#defineNM_SETTING_WIRELESS_MODE_ADHOC
#defineNM_SETTING_WIRELESS_MODE_AP
#defineNM_SETTING_WIRELESS_MODE_INFRA
-
-
-

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

-
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingWirelessError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingWireless
 

-

-

 

-

-

-
NM_SETTING_WIRELESS_MTU

-
#define NM_SETTING_WIRELESS_MTU         "mtu"
+

+
Includes

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

-

-

 

-

-

-
NM_SETTING_WIRELESS_SEEN_BSSIDS

-
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
-

-

-

+

+
Description

+
The NMSettingWireless object is a NMSetting subclass that describes properties
+necessary for connection to 802.11 WiFi networks.

 

-

+

+
Functions

 

-
NM_SETTING_WIRELESS_SEC

-
#define NM_SETTING_WIRELESS_SEC         "security"
-

-

-

+
nm_setting_wireless_error_quark ()

+
GQuark
+nm_setting_wireless_error_quark (void);

+
Registers an error quark for NMSettingWireless if necessary.

+

+
Returns

+
 the error quark used for NMSettingWireless errors.

+

 

-

-

-
NM_SETTING_WIRELESS_HIDDEN

-
#define NM_SETTING_WIRELESS_HIDDEN      "hidden"
-

-

-

 

 

 

-
NM_SETTING_WIRELESS_MODE_ADHOC

-
#define NM_SETTING_WIRELESS_MODE_ADHOC  "adhoc"
-

-

-Indicates Ad-Hoc mode where no access point is expected to be present.
-

+
nm_setting_wireless_new ()

+
NMSetting *
+nm_setting_wireless_new (void);

+
Creates a new NMSettingWireless object with default values.

+

+
Returns

+
 the new empty NMSettingWireless object. 

+
[transfer full]

 

-

-

-
NM_SETTING_WIRELESS_MODE_AP

-
#define NM_SETTING_WIRELESS_MODE_AP     "ap"
-

-

-Indicates AP/master mode where the wireless device is started as an access
-point/hotspot.
-

-
Since 0.9.8

 

 

 

-
NM_SETTING_WIRELESS_MODE_INFRA

-
#define NM_SETTING_WIRELESS_MODE_INFRA  "infrastructure"
-

-

-Indicates infrastructure mode where an access point is expected to be present
-for this connection.
-

+
nm_setting_wireless_get_ssid ()

+
const GByteArray *
+nm_setting_wireless_get_ssid (NMSettingWireless *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingWireless
 

 

-

-

-
NMSettingWireless

-
typedef struct _NMSettingWireless NMSettingWireless;

-

-

+

+
Returns

+
 the “ssid” property of the setting

+

 

-

-

-
NMSettingWirelessClass

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

-

-

 

 

 

-
nm_setting_wireless_new ()

-
NMSetting *         nm_setting_wireless_new             (void);

-

-Creates a new NMSettingWireless object with default values.
-

-

+
nm_setting_wireless_get_mode ()

+
const char *
+nm_setting_wireless_get_mode (NMSettingWireless *setting);

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingWireless object. [transfer full]
-
setting
the NMSettingWireless
 
 

 

 

+

+
Returns

+
 the “mode” property of the setting

+

+

+

 

 

-
nm_setting_wireless_get_ssid ()

-
const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);

-

+
nm_setting_wireless_get_band ()

+
const char *
+nm_setting_wireless_get_band (NMSettingWireless *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWireless
-
Returns :
the "ssid" property of the setting
setting
the NMSettingWireless
 

 

 

+

+
Returns

+
 the “band” property of the setting

+

+

+

 

 

-
nm_setting_wireless_get_mode ()

-
const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);

-

+
nm_setting_wireless_get_channel ()

+
guint32
+nm_setting_wireless_get_channel (NMSettingWireless *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWireless
-
Returns :
the "mode" property of the setting
setting
the NMSettingWireless
 

 

 

+

+
Returns

+
 the “channel” property of the setting

+

+

+

 

 

-
nm_setting_wireless_get_band ()

-
const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);

-

+
nm_setting_wireless_get_bssid ()

+
const GByteArray *
+nm_setting_wireless_get_bssid (NMSettingWireless *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWireless
-
Returns :
the "band" property of the setting
setting
the NMSettingWireless
 

 

 

+

+
Returns

+
 the “bssid” property of the setting

+

+

+

 

 

-
nm_setting_wireless_get_channel ()

-
guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);

-

+
nm_setting_wireless_get_rate ()

+
guint32
+nm_setting_wireless_get_rate (NMSettingWireless *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWireless
-
Returns :
the "channel" property of the setting
setting
the NMSettingWireless
 

 

 

+

+
Returns

+
 the “rate” property of the setting

+

+

+

 

 

-
nm_setting_wireless_get_bssid ()

-
const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);

-

+
nm_setting_wireless_get_tx_power ()

+
guint32
+nm_setting_wireless_get_tx_power (NMSettingWireless *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWireless
-
Returns :
the "bssid" property of the setting
setting
the NMSettingWireless
 

 

 

+

+
Returns

+
 the “tx-power” property of the setting

+

+

+

 

 

-
nm_setting_wireless_get_rate ()

-
guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);

-

+
nm_setting_wireless_get_mac_address ()

+
const GByteArray *
+nm_setting_wireless_get_mac_address (NMSettingWireless *setting);

+

+
Parameters

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

 



setting :
the NMSettingWireless
-
Returns :
the "rate" property of the setting




setting
the NMSettingWireless
 

 

 

+

+
Returns

+
 the “mac-address” property of the setting

+

+

+

 

 

-
nm_setting_wireless_get_tx_power ()

-
guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);

-

+
nm_setting_wireless_get_cloned_mac_address ()

+
const GByteArray *
+nm_setting_wireless_get_cloned_mac_address
+                               (NMSettingWireless *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWireless
-
Returns :
the "tx-power" property of the setting
setting
the NMSettingWireless
 

 

 

+

+
Returns

+
 the “cloned-mac-address” property of the setting

+

+

+
-

nm_setting_wireless_get_mac_address ()

-
const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_mac_address_blacklist ()

+
const GSList *
+nm_setting_wireless_get_mac_address_blacklist
+                               (NMSettingWireless *setting);
+
+

Parameters

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

setting :

the NMSettingWireless -

Returns :

the "mac-address" property of the setting

setting

the NMSettingWireless

 
+
+

Returns

+

the +“mac-address-blacklist” property of the setting.

+

[element-type GLib.ByteArray]

+
+
-

nm_setting_wireless_get_cloned_mac_address ()

-
const GByteArray *  nm_setting_wireless_get_cloned_mac_address
-                                                        (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_mtu ()

+
guint32
+nm_setting_wireless_get_mtu (NMSettingWireless *setting);
+
+

Parameters

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

setting :

the NMSettingWireless -

Returns :

the "cloned-mac-address" property of the setting

setting

the NMSettingWireless

 
+
+

Returns

+

the “mtu” property of the setting

+

+
+
-

nm_setting_wireless_get_mac_address_blacklist ()

-
const GSList *      nm_setting_wireless_get_mac_address_blacklist
-                                                        (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_security ()

+
const char *
+nm_setting_wireless_get_security (NMSettingWireless *setting);
+
+

Parameters

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

setting :

the NMSettingWireless -

Returns :

the -"mac-address-blacklist" property of the setting. [element-type GLib.ByteArray] -

setting

the NMSettingWireless

 
+
+

Returns

+

the “security” property of the setting

+

+
+
-

nm_setting_wireless_get_mtu ()

-
guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_hidden ()

+
gboolean
+nm_setting_wireless_get_hidden (NMSettingWireless *setting);
+
+

Parameters

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

setting :

the NMSettingWireless -

Returns :

the "mtu" property of the setting

setting

the NMSettingWireless

 
+
+

Returns

+

the “hidden” property of the setting

+

+
+
-

nm_setting_wireless_get_security ()

-
const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
-
+

nm_setting_wireless_add_seen_bssid ()

+
gboolean
+nm_setting_wireless_add_seen_bssid (NMSettingWireless *setting,
+                                    const char *bssid);
+

Adds a new Wi-Fi AP's BSSID to the previously seen BSSID list of the setting. +NetworkManager now tracks previously seen BSSIDs internally so this function +no longer has much use. Actually, changes you make using this function will +not be preserved.

+
+

Parameters

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

setting :

the NMSettingWireless -

setting

the NMSettingWireless

 

Returns :

the "security" property of the setting

bssid

the new BSSID to add to the list

 
+
+

Returns

+

TRUE if bssid +was already known, FALSE if not

+

+
+
-

nm_setting_wireless_get_hidden ()

-
gboolean            nm_setting_wireless_get_hidden      (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_num_seen_bssids ()

+
guint32
+nm_setting_wireless_get_num_seen_bssids
+                               (NMSettingWireless *setting);
+
+

Parameters

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

setting :

the NMSettingWireless -

Returns :

the "hidden" property of the setting

setting

the NMSettingWireless

 
+
+

Returns

+

the number of BSSIDs in the previously seen BSSID list

+

+
+
-

nm_setting_wireless_add_seen_bssid ()

-
gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
-                                                         const char *bssid);
-

-Adds a new Wi-Fi AP's BSSID to the previously seen BSSID list of the setting. -NetworkManager now tracks previously seen BSSIDs internally so this function -no longer has much use. Actually, changes you make using this function will -not be preserved. -

-
+

nm_setting_wireless_get_seen_bssid ()

+
const char *
+nm_setting_wireless_get_seen_bssid (NMSettingWireless *setting,
+                                    guint32 i);
+
+

Parameters

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

setting :

the NMSettingWireless -

bssid :

the new BSSID to add to the list

setting

the NMSettingWireless

 

Returns :

 -TRUE if bssid was already known, FALSE if not

i

index of a BSSID in the previously seen BSSID list

 
+
+

Returns

+

the BSSID at index i +

+

+
+
-

nm_setting_wireless_get_num_seen_bssids ()

-
guint32             nm_setting_wireless_get_num_seen_bssids
-                                                        (NMSettingWireless *setting);
-
+

nm_setting_wireless_ap_security_compatible ()

+
gboolean
+nm_setting_wireless_ap_security_compatible
+                               (NMSettingWireless *s_wireless,
+                                NMSettingWirelessSecurity *s_wireless_sec,
+                                NM80211ApFlags ap_flags,
+                                NM80211ApSecurityFlags ap_wpa,
+                                NM80211ApSecurityFlags ap_rsn,
+                                NM80211Mode ap_mode);
+

Given a NMSettingWireless and an optional NMSettingWirelessSecurity, +determine if the configuration given by the settings is compatible with +the security of an access point using that access point's capability flags +and mode. Useful for clients that wish to filter a set of connections +against a set of access points and determine which connections are +compatible with which access points.

+
+

Parameters

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

setting :

the NMSettingWireless -

s_wireless

a NMSettingWireless

 

Returns :

the number of BSSIDs in the previously seen BSSID list

s_wireless_sec

a NMSettingWirelessSecurity or NULL

 
-
-
-
-

nm_setting_wireless_get_seen_bssid ()

-
const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
-                                                         guint32 i);
-
---- - - - + + + - - + + + - - + + + + + + + +

setting :

the NMSettingWireless -

ap_flags

the NM80211ApFlags of the given access point

 

i :

index of a BSSID in the previously seen BSSID list

ap_wpa

the NM80211ApSecurityFlags of the given access point's WPA +capabilities

 

Returns :

the BSSID at index i -

ap_rsn

the NM80211ApSecurityFlags of the given access point's WPA2/RSN +capabilities

 

ap_mode

the 802.11 mode of the AP, either Ad-Hoc or Infrastructure

 
-
+
+

Returns

+

TRUE if the given settings are compatible with the access point's +security flags and mode, FALSE if they are not.

+

+
+ + +
+

Types and Values

-

nm_setting_wireless_ap_security_compatible ()

-
gboolean            nm_setting_wireless_ap_security_compatible
-                                                        (NMSettingWireless *s_wireless,
-                                                         NMSettingWirelessSecurity *s_wireless_sec,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn,
-                                                         NM80211Mode ap_mode);
+

NM_SETTING_WIRELESS_SETTING_NAME

+
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
+

-Given a NMSettingWireless and an optional NMSettingWirelessSecurity, -determine if the configuration given by the settings is compatible with -the security of an access point using that access point's capability flags -and mode. Useful for clients that wish to filter a set of connections -against a set of access points and determine which connections are -compatible with which access points.

-
+ +
+
+

enum NMSettingWirelessError

+
+

Members

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

s_wireless :

a NMSettingWireless +

NM_SETTING_WIRELESS_ERROR_UNKNOWN

 +

unknown or unclassified error

 

s_wireless_sec :

a NMSettingWirelessSecurity or NULL +

NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

ap_flags :

the NM80211ApFlags of the given access point

ap_wpa :

the NM80211ApSecurityFlags of the given access point's WPA -capabilities

ap_rsn :

the NM80211ApSecurityFlags of the given access point's WPA2/RSN -capabilities

NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 

ap_mode :

the 802.11 mode of the AP, either Ad-Hoc or Infrastructure

NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING

 +

property values require +the presence of an NMSettingWirelessSecurity object in the connection

+		 

Returns :

 -TRUE if the given settings are compatible with the access point's -security flags and mode, FALSE if they are not.

NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND

 +

the property channel was +set to a value that requires the “band” property to be set

+		 
-
-

Property Details

+
-

The "band" property

-
  "band"                     gchar*                : Read / Write
+

NM_SETTING_WIRELESS_ERROR

+
#define NM_SETTING_WIRELESS_ERROR nm_setting_wireless_error_quark ()
+

-802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or -'bg' for 2.4GHz 802.11. This will lock associations to the WiFi network -to the specific band, i.e. if 'a' is specified, the device will not -associate with the same network in the 2.4GHz band even if the network's -settings are compatible. This setting depends on specific driver -capability and may not work with all drivers.

-

Default value: NULL

-

The "bssid" property

-
  "bssid"                    GArray_guchar_*       : Read / Write
+

NM_SETTING_WIRELESS_SSID

+
#define NM_SETTING_WIRELESS_SSID        "ssid"
+

-If specified, directs the device to only associate with the given access -point. This capability is highly driver dependent and not supported by -all devices. Note: this property does not control the BSSID used when -creating an Ad-Hoc network and is unlikely to in the future.

-

The "channel" property

-
  "channel"                  guint                 : Read / Write / Construct
+

NM_SETTING_WIRELESS_MODE

+
#define NM_SETTING_WIRELESS_MODE        "mode"
+

-Wireless channel to use for the WiFi connection. The device will only -join (or create for Ad-Hoc networks) a WiFi network on the specified -channel. Because channel numbers overlap between bands, this property -also requires the 'band' property to be set.

-

Default value: 0

-

The "cloned-mac-address" property

-
  "cloned-mac-address"       GArray_guchar_*       : Read / Write
+

NM_SETTING_WIRELESS_BAND

+
#define NM_SETTING_WIRELESS_BAND        "band"
+

-If specified, request that the Wifi device use this MAC address instead of its -permanent MAC address. This is known as MAC cloning or spoofing.

-

The "hidden" property

-
  "hidden"                   gboolean              : Read / Write
+

NM_SETTING_WIRELESS_CHANNEL

+
#define NM_SETTING_WIRELESS_CHANNEL     "channel"
+

-If TRUE, indicates this network is a non-broadcasting network that -hides its SSID. In this case various workarounds may take place, such -as probe-scanning the SSID for more reliable network discovery. However, -these workarounds expose inherent insecurities with hidden SSID networks, -and thus hidden SSID networks should be used with caution.

-

Default value: FALSE

-

The "mac-address" property

-
  "mac-address"              GArray_guchar_*       : Read / Write
+

NM_SETTING_WIRELESS_BSSID

+
#define NM_SETTING_WIRELESS_BSSID       "bssid"
+

-If specified, this connection will only apply to the WiFi device -whose permanent MAC address matches. This property does not change the MAC address -of the device (i.e. MAC spoofing).

-

The "mac-address-blacklist" property

-
  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
+

NM_SETTING_WIRELESS_RATE

+
#define NM_SETTING_WIRELESS_RATE        "rate"
+

-A list of permanent MAC addresses of Wi-Fi devices to which this -connection should never apply. Each MAC address should be given in the -standard hex-digits-and-colons notation (eg '00:11:22:33:44:55').

-

The "mode" property

-
  "mode"                     gchar*                : Read / Write
+

NM_SETTING_WIRELESS_TX_POWER

+
#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_MAC_ADDRESS

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
+

-WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, -infrastructure is assumed.

-

Default value: NULL

-

The "mtu" property

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

NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

+
#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
+

-If non-zero, only transmit packets of the specified size or smaller, -breaking larger packets up into multiple Ethernet frames.

-

Default value: 0

-

The "rate" property

-
  "rate"                     guint                 : Read / Write / Construct
+

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+

-If non-zero, directs the device to only use the specified bitrate for -communication with the access point. Units are in Kb/s, ie 5500 = 5.5 -Mbit/s. This property is highly driver dependent and not all devices -support setting a static bitrate.

-

Default value: 0

-

The "security" property

-
  "security"                 gchar*                : Read / Write
+

NM_SETTING_WIRELESS_MTU

+
#define NM_SETTING_WIRELESS_MTU         "mtu"
+

-If the wireless connection has any security restrictions, like 802.1x, -WEP, or WPA, set this property to '802-11-wireless-security' and ensure -the connection contains a valid 802-11-wireless-security setting.

-

Default value: NULL

-

The "seen-bssids" property

-
  "seen-bssids"              GSList_gchararray_*   : Read / Write
+

NM_SETTING_WIRELESS_SEEN_BSSIDS

+
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
+

-A list of BSSIDs (each BSSID formatted as a MAC address like -'00:11:22:33:44:55') that have been detected as part of the Wi-FI network. -NetworkManager internally tracks previously seen BSSIDs. The property is only -meant for reading and reflects the BBSID list of NetworkManager. The changes you -make to this property will not be preserved.

-

The "ssid" property

-
  "ssid"                     GArray_guchar_*       : Read / Write
+

NM_SETTING_WIRELESS_SEC

+
#define NM_SETTING_WIRELESS_SEC         "security"
+

-SSID of the WiFi network.

-

The "tx-power" property

-
  "tx-power"                 guint                 : Read / Write / Construct
+

NM_SETTING_WIRELESS_HIDDEN

+
#define NM_SETTING_WIRELESS_HIDDEN      "hidden"
+

-If non-zero, directs the device to use the specified transmit power. -Units are dBm. This property is highly driver dependent and not all -devices support setting a static transmit power.

+
+
+
+

NM_SETTING_WIRELESS_MODE_ADHOC

+
#define NM_SETTING_WIRELESS_MODE_ADHOC  "adhoc"
+
+

Indicates Ad-Hoc mode where no access point is expected to be present.

+
+
+
+

NM_SETTING_WIRELESS_MODE_AP

+
#define NM_SETTING_WIRELESS_MODE_AP     "ap"
+
+

Indicates AP/master mode where the wireless device is started as an access +point/hotspot.

+

Since 0.9.8

+
+
+
+

NM_SETTING_WIRELESS_MODE_INFRA

+
#define NM_SETTING_WIRELESS_MODE_INFRA  "infrastructure"
+
+

Indicates infrastructure mode where an access point is expected to be present +for this connection.

+
+
+
+

Property Details

+
+

The “band” property

+
  “band”                     gchar *
+

802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or 'bg' for 2.4GHz 802.11. This will lock associations to the WiFi network to the specific band, i.e. if 'a' is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “bssid” property

+
  “bssid”                    GArray_guchar_ *
+

If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.

+

Flags: Read / Write

+
+
+
+

The “channel” property

+
  “channel”                  guint
+

Wireless channel to use for the WiFi connection. The device will only join (or create for Ad-Hoc networks) a WiFi network on the specified channel. Because channel numbers overlap between bands, this property also requires the 'band' property to be set.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “cloned-mac-address” property

+
  “cloned-mac-address”       GArray_guchar_ *
+

If specified, request that the WiFi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.

+

Flags: Read / Write

+
+
+
+

The “hidden” property

+
  “hidden”                   gboolean
+

If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.

+

Flags: Read / Write

+

Default value: FALSE

+
+
+
+

The “mac-address” property

+
  “mac-address”              GArray_guchar_ *
+

If specified, this connection will only apply to the WiFi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

+

Flags: Read / Write

+
+
+
+

The “mac-address-blacklist” property

+
  “mac-address-blacklist”    GSList_gchararray_ *
+

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg '00:11:22:33:44:55').

+

Flags: Read / Write

+
+
+
+

The “mode” property

+
  “mode”                     gchar *
+

WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “mtu” property

+
  “mtu”                      guint
+

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “rate” property

+
  “rate”                     guint
+

If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “security” property

+
  “security”                 gchar *
+

If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to '802-11-wireless-security' and ensure the connection contains a valid 802-11-wireless-security setting.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “seen-bssids” property

+
  “seen-bssids”              GSList_gchararray_ *
+

A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55') that have been detected as part of the WiFI network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BBSID list of NetworkManager. The changes you make to this property will not be preserved.

+

Flags: Read / Write

+
+
+
+

The “ssid” property

+
  “ssid”                     GArray_guchar_ *
+

SSID of the WiFi network. Must be specified.

+

Flags: Read / Write

+
+
+
+

The “tx-power” property

+
  “tx-power”                 guint
+

If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.

+

Flags: Read / Write / Construct

Default value: 0

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWirelessSecurity.html b/docs/libnm-util/html/NMSettingWirelessSecurity.html index bdde2c5b..b7deca45 100644 --- a/docs/libnm-util/html/NMSettingWirelessSecurity.html +++ b/docs/libnm-util/html/NMSettingWirelessSecurity.html @@ -2,34 +2,28 @@ -NMSettingWirelessSecurity +libnm-util Reference Manual: NMSettingWirelessSecurity - + - - - - - - - - - - + + + + + + +
@@ -38,1409 +32,1753 @@

NMSettingWirelessSecurity — Describes connection properties for WiFi networks that use WEP, LEAP, WPA or WPA2/RSN security

- +
-
-

Synopsis

-
-#include <nm-setting-wireless-security.h>
-
-#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
-enum                NMSettingWirelessSecurityError;
-#define             NM_SETTING_WIRELESS_SECURITY_ERROR
-GQuark              nm_setting_wireless_security_error_quark
-                                                        (void);
-enum                NMWepKeyType;
-#define             NM_SETTING_WIRELESS_SECURITY_KEY_MGMT
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX
-#define             NM_SETTING_WIRELESS_SECURITY_AUTH_ALG
-#define             NM_SETTING_WIRELESS_SECURITY_PROTO
-#define             NM_SETTING_WIRELESS_SECURITY_PAIRWISE
-#define             NM_SETTING_WIRELESS_SECURITY_GROUP
-#define             NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY0
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY1
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY2
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY3
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE
-#define             NM_SETTING_WIRELESS_SECURITY_PSK
-#define             NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS
-#define             NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD
-#define             NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS
-                    NMSettingWirelessSecurity;
-                    NMSettingWirelessSecurityClass;
-NMSetting *         nm_setting_wireless_security_new    (void);
-const char *        nm_setting_wireless_security_get_key_mgmt
-                                                        (NMSettingWirelessSecurity *setting);
-guint32             nm_setting_wireless_security_get_num_protos
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-gboolean            nm_setting_wireless_security_add_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *proto);
-void                nm_setting_wireless_security_remove_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-void                nm_setting_wireless_security_clear_protos
-                                                        (NMSettingWirelessSecurity *setting);
-guint32             nm_setting_wireless_security_get_num_pairwise
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-gboolean            nm_setting_wireless_security_add_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *pairwise);
-void                nm_setting_wireless_security_remove_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-void                nm_setting_wireless_security_clear_pairwise
-                                                        (NMSettingWirelessSecurity *setting);
-guint32             nm_setting_wireless_security_get_num_groups
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-gboolean            nm_setting_wireless_security_add_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *group);
-void                nm_setting_wireless_security_remove_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-void                nm_setting_wireless_security_clear_groups
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_psk
-                                                        (NMSettingWirelessSecurity *setting);
-NMSettingSecretFlags nm_setting_wireless_security_get_psk_flags
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_leap_username
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_leap_password
-                                                        (NMSettingWirelessSecurity *setting);
-NMSettingSecretFlags nm_setting_wireless_security_get_leap_password_flags
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_wep_key
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 idx);
-void                nm_setting_wireless_security_set_wep_key
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 idx,
-                                                         const char *key);
-guint32             nm_setting_wireless_security_get_wep_tx_keyidx
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_auth_alg
-                                                        (NMSettingWirelessSecurity *setting);
-NMSettingSecretFlags nm_setting_wireless_security_get_wep_key_flags
-                                                        (NMSettingWirelessSecurity *setting);
-NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
-                                                        (NMSettingWirelessSecurity *setting);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingWirelessSecurityError
-
-
-  GEnum
-   +----NMWepKeyType
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingWirelessSecurity
-
-
-
-

Properties

-
-  "auth-alg"                 gchar*                : Read / Write
-  "group"                    GSList_gchararray_*   : Read / Write
-  "key-mgmt"                 gchar*                : Read / Write
-  "leap-password"            gchar*                : Read / Write
-  "leap-password-flags"      guint                 : Read / Write
-  "leap-username"            gchar*                : Read / Write
-  "pairwise"                 GSList_gchararray_*   : Read / Write
-  "proto"                    GSList_gchararray_*   : Read / Write
-  "psk"                      gchar*                : Read / Write
-  "psk-flags"                guint                 : Read / Write
-  "wep-key-flags"            guint                 : Read / Write
-  "wep-key-type"             guint                 : Read / Write / Construct
-  "wep-key0"                 gchar*                : Read / Write
-  "wep-key1"                 gchar*                : Read / Write
-  "wep-key2"                 gchar*                : Read / Write
-  "wep-key3"                 gchar*                : Read / Write
-  "wep-tx-keyidx"            guint                 : Read / Write / Construct
-
-
-

Description

-

-The NMSettingWirelessSecurity object is a NMSetting subclass that describes -properties necessary for connection to encrypted WiFi networks. -

-

-It's a good idea to read up on wpa_supplicant configuration before using this -setting extensively, since most of the options here correspond closely with -the relevant wpa_supplicant configuration options. To get a better overview -of how WiFi security works, you may want to get copies of the following books. -

-

- 802.11 Wireless Networks: The Definitive Guide, Second Edition - Author: Matthew Gast - ISBN: 978-0596100520 -

-

- Cisco Wireless LAN Security - Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky - ISBN: 978-1587051548 -

-
-
-

Details

-
-

NM_SETTING_WIRELESS_SECURITY_SETTING_NAME

-
#define NM_SETTING_WIRELESS_SECURITY_SETTING_NAME "802-11-wireless-security"
-
-

-

-
-
-
-

enum NMSettingWirelessSecurityError

-
typedef enum {
-	NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN = 0,            /*< nick=UnknownError >*/
-	NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY,       /*< nick=InvalidProperty >*/
-	NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY,       /*< nick=MissingProperty >*/
-	NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING, /*< nick=Missing8021xSetting >*/
-	NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X,   /*< nick=LEAPRequires8021x >*/
-	NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME, /*< nick=LEAPRequiresUsername >*/
-	NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP /*< nick=SharedKeyRequiresWEP >*/
-} NMSettingWirelessSecurityError;
-
-
+

Functions

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

NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_wireless_security_error_quark ()

NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY

the property was invalid + +NMSetting * + +nm_setting_wireless_security_new () +
const char * + +nm_setting_wireless_security_get_key_mgmt ()

NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY

the property was -missing and is required + +guint32 + +nm_setting_wireless_security_get_num_protos ()

NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING

a property contained -a value that requires the connection to contain a NMSetting8021x setting +const char * + +nm_setting_wireless_security_get_proto ()

NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X

LEAP authentication -was specified but key management was not set to "8021x" + +gboolean + +nm_setting_wireless_security_add_proto ()

NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME

LEAP authentication -was specified but no LEAP username was given + +void + +nm_setting_wireless_security_remove_proto ()

NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP

Shared Key -authentication was specified but the setting did not specify WEP as the -encryption protocol + +void + +nm_setting_wireless_security_clear_protos () +
+guint32 + +nm_setting_wireless_security_get_num_pairwise () +
const char * + +nm_setting_wireless_security_get_pairwise () +
+gboolean + +nm_setting_wireless_security_add_pairwise () +
+void + +nm_setting_wireless_security_remove_pairwise () +
+void + +nm_setting_wireless_security_clear_pairwise () +
+guint32 + +nm_setting_wireless_security_get_num_groups () +
const char * + +nm_setting_wireless_security_get_group () +
+gboolean + +nm_setting_wireless_security_add_group () +
+void + +nm_setting_wireless_security_remove_group () +
+void + +nm_setting_wireless_security_clear_groups () +
const char * + +nm_setting_wireless_security_get_psk () +
+NMSettingSecretFlags + +nm_setting_wireless_security_get_psk_flags () +
const char * + +nm_setting_wireless_security_get_leap_username () +
const char * + +nm_setting_wireless_security_get_leap_password () +
+NMSettingSecretFlags + +nm_setting_wireless_security_get_leap_password_flags () +
const char * + +nm_setting_wireless_security_get_wep_key () +
+void + +nm_setting_wireless_security_set_wep_key () +
+guint32 + +nm_setting_wireless_security_get_wep_tx_keyidx () +
const char * + +nm_setting_wireless_security_get_auth_alg () +
+NMSettingSecretFlags + +nm_setting_wireless_security_get_wep_key_flags () +
+NMWepKeyType + +nm_setting_wireless_security_get_wep_key_type ()
-
-
-

NM_SETTING_WIRELESS_SECURITY_ERROR

-
#define NM_SETTING_WIRELESS_SECURITY_ERROR nm_setting_wireless_security_error_quark ()
-
-

-

-
-
-
-

nm_setting_wireless_security_error_quark ()

-
GQuark              nm_setting_wireless_security_error_quark
-                                                        (void);
-

-Registers an error quark for NMSettingWired if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingWired errors.
-
-
-
-

enum NMWepKeyType

-
typedef enum {
-	NM_WEP_KEY_TYPE_UNKNOWN = 0,
-	NM_WEP_KEY_TYPE_KEY = 1,          /* Hex or ASCII */
-	NM_WEP_KEY_TYPE_PASSPHRASE = 2,   /* 104/128-bit Passphrase */
-
-	NM_WEP_KEY_TYPE_LAST = NM_WEP_KEY_TYPE_PASSPHRASE
-} NMWepKeyType;
-
-

-The NMWepKeyType values specify how any WEP keys present in the setting -are intepreted. There are no standards governing how to hash the various WEP -key/passphrase formats into the actual WEP key. Unfortunately some WEP keys -can be interpreted in multiple ways, requring the setting to specify how to -interpret the any WEP keys. For example, the key "732f2d712e4a394a375d366931" -is both a valid Hexadecimal WEP key and a WEP passphrase. Further, many -ASCII keys are also valid WEP passphrases, but since passphrases and ASCII -keys are hashed differently to determine the actual WEP key the type must be -specified. -

-
+
+

Properties

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

NM_WEP_KEY_TYPE_UNKNOWN

unknown WEP key type - +gchar *auth-algRead / Write

NM_WEP_KEY_TYPE_KEY

indicates a hexadecimal or ASCII formatted WEP key. -Hex keys are either 10 or 26 hexadecimal characters (ie "5f782f2f5f" or -"732f2d712e4a394a375d366931"), while ASCII keys are either 5 or 13 ASCII -characters (ie "abcde" or "blahblah99$*1"). - +GSList_gchararray_ *groupRead / Write

NM_WEP_KEY_TYPE_PASSPHRASE

indicates a WEP passphrase (ex "I bought a duck -on my way back from the market 235Q&^%^*%") instead of a hexadecimal or ASCII -key. Passphrases are between 8 and 64 characters inclusive and are hashed -the actual WEP key using the MD5 hash algorithm. - +gchar *key-mgmtRead / Write

NM_WEP_KEY_TYPE_LAST

placeholder value for bounds-checking - +gchar *leap-passwordRead / Write
guintleap-password-flagsRead / Write
+gchar *leap-usernameRead / Write
+GSList_gchararray_ *pairwiseRead / Write
+GSList_gchararray_ *protoRead / Write
+gchar *pskRead / Write
guintpsk-flagsRead / Write
guintwep-key-flagsRead / Write
guintwep-key-typeRead / Write / Construct
+gchar *wep-key0Read / Write
+gchar *wep-key1Read / Write
+gchar *wep-key2Read / Write
+gchar *wep-key3Read / Write
guintwep-tx-keyidxRead / Write / Construct
-
-
-

NM_SETTING_WIRELESS_SECURITY_KEY_MGMT

-
#define NM_SETTING_WIRELESS_SECURITY_KEY_MGMT "key-mgmt"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX "wep-tx-keyidx"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_AUTH_ALG

-
#define NM_SETTING_WIRELESS_SECURITY_AUTH_ALG "auth-alg"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_PROTO

-
#define NM_SETTING_WIRELESS_SECURITY_PROTO "proto"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_PAIRWISE

-
#define NM_SETTING_WIRELESS_SECURITY_PAIRWISE "pairwise"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_GROUP

-
#define NM_SETTING_WIRELESS_SECURITY_GROUP "group"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME

-
#define NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME "leap-username"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY0

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 "wep-key0"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY1

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 "wep-key1"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY2

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 "wep-key2"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY3

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 "wep-key3"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS "wep-key-flags"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_WIRELESS_SECURITY_SETTING_NAME
enumNMSettingWirelessSecurityError
#defineNM_SETTING_WIRELESS_SECURITY_ERROR
enumNMWepKeyType
#defineNM_SETTING_WIRELESS_SECURITY_KEY_MGMT
#defineNM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX
#defineNM_SETTING_WIRELESS_SECURITY_AUTH_ALG
#defineNM_SETTING_WIRELESS_SECURITY_PROTO
#defineNM_SETTING_WIRELESS_SECURITY_PAIRWISE
#defineNM_SETTING_WIRELESS_SECURITY_GROUP
#defineNM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME
#defineNM_SETTING_WIRELESS_SECURITY_WEP_KEY0
#defineNM_SETTING_WIRELESS_SECURITY_WEP_KEY1
#defineNM_SETTING_WIRELESS_SECURITY_WEP_KEY2
#defineNM_SETTING_WIRELESS_SECURITY_WEP_KEY3
#defineNM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS
#defineNM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE
#defineNM_SETTING_WIRELESS_SECURITY_PSK
#defineNM_SETTING_WIRELESS_SECURITY_PSK_FLAGS
#defineNM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD
#defineNM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS
-
-
-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE "wep-key-type"
+

+
Object Hierarchy

+
    GEnum
+    ├── NMSettingWirelessSecurityError
+    ╰── NMWepKeyType
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingWirelessSecurity
 

-

-

 

-

-

-
NM_SETTING_WIRELESS_SECURITY_PSK

-
#define NM_SETTING_WIRELESS_SECURITY_PSK "psk"
+

+
Includes

+
#include <nm-setting-wireless-security.h>
 

-

-

 

-

-

-
NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS

-
#define NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS "psk-flags"
-

-

-

+

+
Description

+
The NMSettingWirelessSecurity object is a NMSetting subclass that describes
+properties necessary for connection to encrypted WiFi networks.

+
It's a good idea to read up on wpa_supplicant configuration before using this
+setting extensively, since most of the options here correspond closely with
+the relevant wpa_supplicant configuration options.  To get a better overview
+of how WiFi security works, you may want to get copies of the following books.

+
 802.11 Wireless Networks: The Definitive Guide, Second Edition
+      Author: Matthew Gast
+      ISBN: 978-0596100520

+
 Cisco Wireless LAN Security
+      Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky
+      ISBN: 978-1587051548

 

-

+

+
Functions

 

-
NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD

-
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD "leap-password"
-

-

-

+
nm_setting_wireless_security_error_quark ()

+
GQuark
+nm_setting_wireless_security_error_quark
+                               (void);

+
Registers an error quark for NMSettingWired if necessary.

+

+
Returns

+
 the error quark used for NMSettingWired errors.

+

 

-

-

-
NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS

-
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS "leap-password-flags"
-

-

-

 

 

 

-
NMSettingWirelessSecurity

-
typedef struct _NMSettingWirelessSecurity NMSettingWirelessSecurity;

-

-

+
nm_setting_wireless_security_new ()

+
NMSetting *
+nm_setting_wireless_security_new (void);

+
Creates a new NMSettingWirelessSecurity object with default values.

+

+
Returns

+
 the new empty NMSettingWirelessSecurity object. 

+
[transfer full]

 

-

-

-
NMSettingWirelessSecurityClass

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

-

-

 

 

 

-
nm_setting_wireless_security_new ()

-
NMSetting *         nm_setting_wireless_security_new    (void);

-

-Creates a new NMSettingWirelessSecurity object with default values.
-

-

+
nm_setting_wireless_security_get_key_mgmt ()

+
const char *
+nm_setting_wireless_security_get_key_mgmt
+                               (NMSettingWirelessSecurity *setting);

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingWirelessSecurity object. [transfer full]
-
setting
the NMSettingWirelessSecurity
 
 

 

 

-

-

-
nm_setting_wireless_security_get_key_mgmt ()

-
const char *        nm_setting_wireless_security_get_key_mgmt
-                                                        (NMSettingWirelessSecurity *setting);

-

----
-
-
-
-
-
-
-
-
-
-
-




setting :
the NMSettingWirelessSecurity
-
Returns :
the "key-mgmt" property of the setting

+

+
Returns

+
 the “key-mgmt” property of the setting

+

+

 

 

 

-
nm_setting_wireless_security_get_num_protos ()

-
guint32             nm_setting_wireless_security_get_num_protos
-                                                        (NMSettingWirelessSecurity *setting);

-

+
nm_setting_wireless_security_get_num_protos ()

+
guint32
+nm_setting_wireless_security_get_num_protos
+                               (NMSettingWirelessSecurity *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWirelessSecurity
-
Returns :
the number of security protocols this connection allows when
-connecting to secure WiFi networks
setting
the NMSettingWirelessSecurity
 

 

 

+

+
Returns

+
 the number of security protocols this connection allows when
+connecting to secure WiFi networks

+

+

+

 

 

-
nm_setting_wireless_security_get_proto ()

-
const char *        nm_setting_wireless_security_get_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);

-

+
nm_setting_wireless_security_get_proto ()

+
const char *
+nm_setting_wireless_security_get_proto
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 i);

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingWirelessSecurity
-
i :
an index into the protocol list
setting
the NMSettingWirelessSecurity
 
 

 
Returns :
the protocol at index i
-
i
an index into the protocol list
 
 

 
 

 

+

+
Returns

+
 the protocol at index i
+

+

+

+

 

 

-
nm_setting_wireless_security_add_proto ()

-
gboolean            nm_setting_wireless_security_add_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *proto);

-

-Adds a WiFi security protocol (one of "wpa" or "rsn") to the allowed list;
+
nm_setting_wireless_security_add_proto ()

+
gboolean
+nm_setting_wireless_security_add_proto
+                               (NMSettingWirelessSecurity *setting,
+                                const char *proto);

+
Adds a WiFi security protocol (one of "wpa" or "rsn") to the allowed list;
 only protocols in this list will be used when finding and connecting to
 the WiFi network specified by this connection.  For example, if the
 protocol list contains only "wpa" but the access point for the SSID specified
 by this connection only supports WPA2/RSN, the connection cannot be used
-with the access point.
-

-

+with the access point.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingWirelessSecurity
-
proto :
the protocol to add, one of "wpa" or "rsn"
setting
the NMSettingWirelessSecurity
 
 

 
Returns :

-TRUE if the protocol was new and and was added to the allowed
-protocol list, or FALSE if it was already in the list
proto
the protocol to add, one of "wpa" or "rsn"
 
 

 
 

 

+

+
Returns

+
 TRUE if the protocol was new and and was added to the allowed
+protocol list, or FALSE if it was already in the list

+

+

+

 

 

-
nm_setting_wireless_security_remove_proto ()

-
void                nm_setting_wireless_security_remove_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);

-

-Removes a protocol from the allowed protocol list.
-

-

+
nm_setting_wireless_security_remove_proto ()

+
void
+nm_setting_wireless_security_remove_proto
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 i);

+
Removes a protocol from the allowed protocol list.

+

+
Parameters

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

 





 
 
 
setting :
the NMSettingWirelessSecurity
-
setting
the NMSettingWirelessSecurity
 
 

 
i :
index of the protocol to remove
i
index of the protocol to remove
 
 

 
 

 

+

 

 

-
nm_setting_wireless_security_clear_protos ()

-
void                nm_setting_wireless_security_clear_protos
-                                                        (NMSettingWirelessSecurity *setting);

-

-Removes all protocols from the allowed list.  If there are no protocols
-specified then all protocols are allowed.
-

-

+
nm_setting_wireless_security_clear_protos ()

+
void
+nm_setting_wireless_security_clear_protos
+                               (NMSettingWirelessSecurity *setting);

+
Removes all protocols from the allowed list.  If there are no protocols
+specified then all protocols are allowed.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
setting :
the NMSettingWirelessSecurity
-
setting
the NMSettingWirelessSecurity
 
 

 

 

+

 

 

-
nm_setting_wireless_security_get_num_pairwise ()

-
guint32             nm_setting_wireless_security_get_num_pairwise
-                                                        (NMSettingWirelessSecurity *setting);

-

+
nm_setting_wireless_security_get_num_pairwise ()

+
guint32
+nm_setting_wireless_security_get_num_pairwise
+                               (NMSettingWirelessSecurity *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingWirelessSecurity
-
Returns :
the number of pairwise encryption algorithms in the allowed list
setting
the NMSettingWirelessSecurity
 

 

 

+

+
Returns

+
 the number of pairwise encryption algorithms in the allowed list

+

+

+
-

nm_setting_wireless_security_get_pairwise ()

-
const char *        nm_setting_wireless_security_get_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-

-Returns the allowed pairwise encryption algorithm from allowed algorithm -list. -

-
+

nm_setting_wireless_security_get_pairwise ()

+
const char *
+nm_setting_wireless_security_get_pairwise
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 i);
+

Returns the allowed pairwise encryption algorithm from allowed algorithm +list.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

i :

index of an item in the allowed pairwise encryption algorithm list

setting

the NMSettingWirelessSecurity

 

Returns :

the pairwise encryption algorithm at index i -

i

index of an item in the allowed pairwise encryption algorithm list

 
+
+

Returns

+

the pairwise encryption algorithm at index i +

+

+
+
-

nm_setting_wireless_security_add_pairwise ()

-
gboolean            nm_setting_wireless_security_add_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *pairwise);
-

-Adds an encryption algorithm to the list of allowed pairwise encryption +

nm_setting_wireless_security_add_pairwise ()

+
gboolean
+nm_setting_wireless_security_add_pairwise
+                               (NMSettingWirelessSecurity *setting,
+                                const char *pairwise);
+

Adds an encryption algorithm to the list of allowed pairwise encryption algorithms. If the list is not empty, then only access points that support one or more of the encryption algorithms in the list will be considered -compatible with this connection. -

-
+compatible with this connection.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

pairwise :

the encryption algorithm to add, one of "wep40", "wep104", -"tkip", or "ccmp"

setting

the NMSettingWirelessSecurity

 

Returns :

 -TRUE if the algorithm was added to the list, FALSE if it was -already in the list

pairwise

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

 
+
+

Returns

+

TRUE if the algorithm was added to the list, FALSE if it was +already in the list

+

+
+
-

nm_setting_wireless_security_remove_pairwise ()

-
void                nm_setting_wireless_security_remove_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-

-Removes an encryption algorithm from the allowed pairwise encryption -algorithm list. -

-
+

nm_setting_wireless_security_remove_pairwise ()

+
void
+nm_setting_wireless_security_remove_pairwise
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 i);
+

Removes an encryption algorithm from the allowed pairwise encryption +algorithm list.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

setting

the NMSettingWirelessSecurity

 

i :

the index of an item in the allowed pairwise encryption algorithm list

i

the index of an item in the allowed pairwise encryption algorithm list

 
+
-

nm_setting_wireless_security_clear_pairwise ()

-
void                nm_setting_wireless_security_clear_pairwise
-                                                        (NMSettingWirelessSecurity *setting);
-

-Removes all algorithms from the allowed list. If there are no algorithms -specified then all pairwise encryption algorithms are allowed. -

-
+

nm_setting_wireless_security_clear_pairwise ()

+
void
+nm_setting_wireless_security_clear_pairwise
+                               (NMSettingWirelessSecurity *setting);
+

Removes all algorithms from the allowed list. If there are no algorithms +specified then all pairwise encryption algorithms are allowed.

+
+

Parameters

+
--+++ - - + + +

setting :

the NMSettingWirelessSecurity -

setting

the NMSettingWirelessSecurity

 
+
-

nm_setting_wireless_security_get_num_groups ()

-
guint32             nm_setting_wireless_security_get_num_groups
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_get_num_groups ()

+
guint32
+nm_setting_wireless_security_get_num_groups
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

Returns :

the number of groupwise encryption algorithms in the allowed list

setting

the NMSettingWirelessSecurity

 
+
+

Returns

+

the number of groupwise encryption algorithms in the allowed list

+

+
+
-

nm_setting_wireless_security_get_group ()

-
const char *        nm_setting_wireless_security_get_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-

-Returns the allowed groupwise encryption algorithm from allowed algorithm -list. -

-
+

nm_setting_wireless_security_get_group ()

+
const char *
+nm_setting_wireless_security_get_group
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 i);
+

Returns the allowed groupwise encryption algorithm from allowed algorithm +list.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

i :

index of an item in the allowed groupwise encryption algorithm list

setting

the NMSettingWirelessSecurity

 

Returns :

the groupwise encryption algorithm at index i -

i

index of an item in the allowed groupwise encryption algorithm list

 
+
+

Returns

+

the groupwise encryption algorithm at index i +

+

+
+
-

nm_setting_wireless_security_add_group ()

-
gboolean            nm_setting_wireless_security_add_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *group);
-

-Adds an encryption algorithm to the list of allowed groupwise encryption +

nm_setting_wireless_security_add_group ()

+
gboolean
+nm_setting_wireless_security_add_group
+                               (NMSettingWirelessSecurity *setting,
+                                const char *group);
+

Adds an encryption algorithm to the list of allowed groupwise encryption algorithms. If the list is not empty, then only access points that support one or more of the encryption algorithms in the list will be considered -compatible with this connection. -

-
+compatible with this connection.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

group :

the encryption algorithm to add, one of "wep40", "wep104", -"tkip", or "ccmp"

setting

the NMSettingWirelessSecurity

 

Returns :

 -TRUE if the algorithm was added to the list, FALSE if it was -already in the list

group

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

 
+
+

Returns

+

TRUE if the algorithm was added to the list, FALSE if it was +already in the list

+

+
+
-

nm_setting_wireless_security_remove_group ()

-
void                nm_setting_wireless_security_remove_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-

-Removes an encryption algorithm from the allowed groupwise encryption -algorithm list. -

-
+

nm_setting_wireless_security_remove_group ()

+
void
+nm_setting_wireless_security_remove_group
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 i);
+

Removes an encryption algorithm from the allowed groupwise encryption +algorithm list.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

setting

the NMSettingWirelessSecurity

 

i :

the index of an item in the allowed groupwise encryption algorithm list

i

the index of an item in the allowed groupwise encryption algorithm list

 
+
-

nm_setting_wireless_security_clear_groups ()

-
void                nm_setting_wireless_security_clear_groups
-                                                        (NMSettingWirelessSecurity *setting);
-

-Removes all algorithms from the allowed list. If there are no algorithms -specified then all groupwise encryption algorithms are allowed. -

-
+

nm_setting_wireless_security_clear_groups ()

+
void
+nm_setting_wireless_security_clear_groups
+                               (NMSettingWirelessSecurity *setting);
+

Removes all algorithms from the allowed list. If there are no algorithms +specified then all groupwise encryption algorithms are allowed.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

setting

the NMSettingWirelessSecurity

 
+
+ +
+
+

nm_setting_wireless_security_get_psk ()

+
const char *
+nm_setting_wireless_security_get_psk (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting

the NMSettingWirelessSecurity

 
+
+
+

Returns

+

the “psk” property of the setting

+

+
+
+
+
+

nm_setting_wireless_security_get_psk_flags ()

+
NMSettingSecretFlags
+nm_setting_wireless_security_get_psk_flags
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

+
+++++ + + + +

setting

the NMSettingWirelessSecurity

 
+
+

Returns

+

the NMSettingSecretFlags pertaining to the +“psk”

+

+
+
+
+
+

nm_setting_wireless_security_get_leap_username ()

+
const char *
+nm_setting_wireless_security_get_leap_username
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting

the NMSettingWirelessSecurity

 
+
+
+

Returns

+

the “leap-username” property of the setting

+

+
+
+
+
+

nm_setting_wireless_security_get_leap_password ()

+
const char *
+nm_setting_wireless_security_get_leap_password
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting

the NMSettingWirelessSecurity

 
+
+
+

Returns

+

the “leap-password” property of the setting

+

+
+
+
+
+

nm_setting_wireless_security_get_leap_password_flags ()

+
NMSettingSecretFlags
+nm_setting_wireless_security_get_leap_password_flags
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting

the NMSettingWirelessSecurity

 
+
+
+

Returns

+

the NMSettingSecretFlags pertaining to the +“leap-password”

+

+
+
-

nm_setting_wireless_security_get_psk ()

-
const char *        nm_setting_wireless_security_get_psk
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_get_wep_key ()

+
const char *
+nm_setting_wireless_security_get_wep_key
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 idx);
+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

setting

the NMSettingWirelessSecurity

 

Returns :

the "psk" property of the setting

idx

the WEP key index (0..3 inclusive)

 
+
+

Returns

+

the WEP key at the given index

+

+
+
-

nm_setting_wireless_security_get_psk_flags ()

-
NMSettingSecretFlags nm_setting_wireless_security_get_psk_flags
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_set_wep_key ()

+
void
+nm_setting_wireless_security_set_wep_key
+                               (NMSettingWirelessSecurity *setting,
+                                guint32 idx,
+                                const char *key);
+

Sets a WEP key in the given index.

+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

setting

the NMSettingWirelessSecurity

 

Returns :

the NMSettingSecretFlags pertaining to the -"psk" -

idx

the index of the key (0..3 inclusive)

 

key

the WEP key as a string, in either hexadecimal, ASCII, or passphrase +form as determiend by the value of the “wep-key-type” +property.

 
+
-

nm_setting_wireless_security_get_leap_username ()

-
const char *        nm_setting_wireless_security_get_leap_username
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_get_wep_tx_keyidx ()

+
guint32
+nm_setting_wireless_security_get_wep_tx_keyidx
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

Returns :

the "leap-username" property of the setting

setting

the NMSettingWirelessSecurity

 
+
+

Returns

+

the “wep-tx-keyidx” property of the setting

+

+
+
-

nm_setting_wireless_security_get_leap_password ()

-
const char *        nm_setting_wireless_security_get_leap_password
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_get_auth_alg ()

+
const char *
+nm_setting_wireless_security_get_auth_alg
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

Returns :

the "leap-password" property of the setting

setting

the NMSettingWirelessSecurity

 
+
+

Returns

+

the “auth-alg” property of the setting

+

+
+
-

nm_setting_wireless_security_get_leap_password_flags ()

-
NMSettingSecretFlags nm_setting_wireless_security_get_leap_password_flags
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_get_wep_key_flags ()

+
NMSettingSecretFlags
+nm_setting_wireless_security_get_wep_key_flags
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

Returns :

the NMSettingSecretFlags pertaining to the -"leap-password" -

setting

the NMSettingWirelessSecurity

 
+
+

Returns

+

the NMSettingSecretFlags pertaining to the all WEP keys

+

+
+
-

nm_setting_wireless_security_get_wep_key ()

-
const char *        nm_setting_wireless_security_get_wep_key
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 idx);
-
+

nm_setting_wireless_security_get_wep_key_type ()

+
NMWepKeyType
+nm_setting_wireless_security_get_wep_key_type
+                               (NMSettingWirelessSecurity *setting);
+
+

Parameters

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

setting :

the NMSettingWirelessSecurity -

idx :

the WEP key index (0..3 inclusive)

Returns :

the WEP key at the given index

setting

the NMSettingWirelessSecurity

 
-
+
+

Returns

+

the “wep-key-type” property of the setting

+

+
+ + +
+

Types and Values

-

nm_setting_wireless_security_set_wep_key ()

-
void                nm_setting_wireless_security_set_wep_key
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 idx,
-                                                         const char *key);
+

NM_SETTING_WIRELESS_SECURITY_SETTING_NAME

+
#define NM_SETTING_WIRELESS_SECURITY_SETTING_NAME "802-11-wireless-security"
+

-Sets a WEP key in the given index.

-
+ +
+
+

enum NMSettingWirelessSecurityError

+
+

Members

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

setting :

the NMSettingWirelessSecurity +

NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN

 +

unknown or unclassified error

 

idx :

the index of the key (0..3 inclusive)

NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY

 +

the property was invalid

+		 

key :

the WEP key as a string, in either hexadecimal, ASCII, or passphrase -form as determiend by the value of the "wep-key-type" -property.

NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY

 +

the property was +missing and is required

+		 
-
-
-
-

nm_setting_wireless_security_get_wep_tx_keyidx ()

-
guint32             nm_setting_wireless_security_get_wep_tx_keyidx
-                                                        (NMSettingWirelessSecurity *setting);
-
---- - - - + + - - + + + - -

setting :

the NMSettingWirelessSecurity +

NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING

 +

a property contained +a value that requires the connection to contain a NMSetting8021x setting

 

Returns :

the "wep-tx-keyidx" property of the setting

NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X

 +

LEAP authentication +was specified but key management was not set to "8021x"

+		 
-
-
-
-

nm_setting_wireless_security_get_auth_alg ()

-
const char *        nm_setting_wireless_security_get_auth_alg
-                                                        (NMSettingWirelessSecurity *setting);
-
---- - - - + + - - + + +

setting :

the NMSettingWirelessSecurity +

NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME

 +

LEAP authentication +was specified but no LEAP username was given

 

Returns :

the "auth-alg" property of the setting

NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP

 +

Shared Key +authentication was specified but the setting did not specify WEP as the +encryption protocol

+		 
+
+
+
+

NM_SETTING_WIRELESS_SECURITY_ERROR

+
#define NM_SETTING_WIRELESS_SECURITY_ERROR nm_setting_wireless_security_error_quark ()
+
+

+

+
-

nm_setting_wireless_security_get_wep_key_flags ()

-
NMSettingSecretFlags nm_setting_wireless_security_get_wep_key_flags
-                                                        (NMSettingWirelessSecurity *setting);
-
+

enum NMWepKeyType

+

The NMWepKeyType values specify how any WEP keys present in the setting +are intepreted. There are no standards governing how to hash the various WEP +key/passphrase formats into the actual WEP key. Unfortunately some WEP keys +can be interpreted in multiple ways, requring the setting to specify how to +interpret the any WEP keys. For example, the key "732f2d712e4a394a375d366931" +is both a valid Hexadecimal WEP key and a WEP passphrase. Further, many +ASCII keys are also valid WEP passphrases, but since passphrases and ASCII +keys are hashed differently to determine the actual WEP key the type must be +specified.

+
+

Members

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

setting :

the NMSettingWirelessSecurity +

NM_WEP_KEY_TYPE_UNKNOWN

 +

unknown WEP key type

 

Returns :

the NMSettingSecretFlags pertaining to the all WEP keys

NM_WEP_KEY_TYPE_KEY

 +

indicates a hexadecimal or ASCII formatted WEP key. +Hex keys are either 10 or 26 hexadecimal characters (ie "5f782f2f5f" or +"732f2d712e4a394a375d366931"), while ASCII keys are either 5 or 13 ASCII +characters (ie "abcde" or "blahblah99$*1").

+		 
-
-
-
-

nm_setting_wireless_security_get_wep_key_type ()

-
NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
-                                                        (NMSettingWirelessSecurity *setting);
-
---- - - - + + - - + + +

setting :

the NMSettingWirelessSecurity +

NM_WEP_KEY_TYPE_PASSPHRASE

 +

indicates a WEP passphrase (ex "I bought a duck +on my way back from the market 235Q&^%^*%") instead of a hexadecimal or ASCII +key. Passphrases are between 8 and 64 characters inclusive and are hashed +the actual WEP key using the MD5 hash algorithm.

 

Returns :

the "wep-key-type" property of the setting

NM_WEP_KEY_TYPE_LAST

 +

placeholder value for bounds-checking

+		 
-
-

Property Details

+
-

The "auth-alg" property

-
  "auth-alg"                 gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_KEY_MGMT

+
#define NM_SETTING_WIRELESS_SECURITY_KEY_MGMT "key-mgmt"
+

-When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the -802.11 authentication algorithm required by the AP here. One of 'open' -for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP. -When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') -the 'leap-username' and 'leap-password' properties must be specified.

-

Default value: NULL

-

The "group" property

-
  "group"                    GSList_gchararray_*   : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX "wep-tx-keyidx"
+

-A list of group/broadcast encryption algorithms which prevents -connections to Wi-Fi networks that do not utilize one of the algorithms -in the list. For maximum compatibility leave this property empty. Each -list element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.

-

The "key-mgmt" property

-
  "key-mgmt"                 gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_AUTH_ALG

+
#define NM_SETTING_WIRELESS_SECURITY_AUTH_ALG "auth-alg"
+

-Key management used for the connection. One of 'none' (WEP), 'ieee8021x' -(Dynamic WEP), 'wpa-none' (Ad-Hoc WPA-PSK), 'wpa-psk' (infrastructure -WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for -any WiFi connection that uses security.

-

Default value: NULL

-

The "leap-password" property

-
  "leap-password"            gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_PROTO

+
#define NM_SETTING_WIRELESS_SECURITY_PROTO "proto"
+

-The login password for legacy LEAP connections (ie, key-mgmt = -'ieee8021x' and auth-alg = 'leap').

-

Default value: NULL

-

The "leap-password-flags" property

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

NM_SETTING_WIRELESS_SECURITY_PAIRWISE

+
#define NM_SETTING_WIRELESS_SECURITY_PAIRWISE "pairwise"
+

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

-

Allowed values: <= 7

-

Default value: 0

-

The "leap-username" property

-
  "leap-username"            gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_GROUP

+
#define NM_SETTING_WIRELESS_SECURITY_GROUP "group"
+

-The login username for legacy LEAP connections (ie, key-mgmt = -'ieee8021x' and auth-alg = 'leap').

-

Default value: NULL

-

The "pairwise" property

-
  "pairwise"                 GSList_gchararray_*   : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME

+
#define NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME "leap-username"
+

-A list of pairwise encryption algorithms which prevents connections to -Wi-Fi networks that do not utilize one of the algorithms in the list. For -maximum compatibility leave this property empty. Each list element may -be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.

-

The "proto" property

-
  "proto"                    GSList_gchararray_*   : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY0

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 "wep-key0"
+

-List of strings specifying the allowed WPA protocol versions to use. -Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If -not specified, both WPA and RSN connections are allowed.

-

The "psk" property

-
  "psk"                      gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY1

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 "wep-key1"
+

-Pre-Shared-Key for WPA networks. If the key is 64-characters long, it -must contain only hexadecimal characters and is interpreted as a -hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII -characters (as specified in the 802.11i standard) and is interpreted as -a WPA passphrase, and is hashed to derive the actual WPA-PSK used when -connecting to the WiFi network.

-

Default value: NULL

-

The "psk-flags" property

-
  "psk-flags"                guint                 : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY2

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 "wep-key2"
+

-Flags indicating how to handle "psk"

-

Allowed values: <= 7

-

Default value: 0

-

The "wep-key-flags" property

-
  "wep-key-flags"            guint                 : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY3

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 "wep-key3"
+

-Flags indicating how to handle NMSettingWirelessSecurity WEP keys.

-

Allowed values: <= 7

-

Default value: 0

-

The "wep-key-type" property

-
  "wep-key-type"             guint                 : Read / Write / Construct
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS "wep-key-flags"
+

-Controls the interpretation of WEP keys. Allowed values are those given -by NMWepKeyType. If set to 1 and the keys are hexadecimal, they must be -either 10 or 26 characters in length. If set to 1 and the keys are -ASCII keys, they must be either 5 or 13 characters in length. If set to -2, the passphrase is hashed using the de-facto MD5 method to derive the -actual WEP key.

-

Allowed values: <= 2

-

Default value: 0

-

The "wep-key0" property

-
  "wep-key0"                 gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE "wep-key-type"
+

-Index 0 WEP key. This is the WEP key used in most networks. See the -'wep-key-type' property for a description of how this key is interpreted.

-

Default value: NULL

-

The "wep-key1" property

-
  "wep-key1"                 gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_PSK

+
#define NM_SETTING_WIRELESS_SECURITY_PSK "psk"
+

-Index 1 WEP key. This WEP index is not used by most networks. See the -'wep-key-type' property for a description of how this key is interpreted.

-

Default value: NULL

-

The "wep-key2" property

-
  "wep-key2"                 gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS "psk-flags"
+

-Index 2 WEP key. This WEP index is not used by most networks. See the -'wep-key-type' property for a description of how this key is interpreted.

-

Default value: NULL

-

The "wep-key3" property

-
  "wep-key3"                 gchar*                : Read / Write
+

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD

+
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD "leap-password"
+

-Index 3 WEP key. This WEP index is not used by most networks. See the -'wep-key-type' property for a description of how this key is interpreted.

-

Default value: NULL

-

The "wep-tx-keyidx" property

-
  "wep-tx-keyidx"            guint                 : Read / Write / Construct
+

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS "leap-password-flags"
+

-When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key -index is used by the AP, put that WEP key index here. Valid values are 0 -(default key) through 3. Note that some consumer access points (like the -Linksys WRT54G) number the keys 1 - 4.

+
+
+
+

Property Details

+
+

The “auth-alg” property

+
  “auth-alg”                 gchar *
+

When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the 802.11 authentication algorithm required by the AP here. One of 'open' for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') the 'leap-username' and 'leap-password' properties must be specified.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “group” property

+
  “group”                    GSList_gchararray_ *
+

A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.

+

Flags: Read / Write

+
+
+
+

The “key-mgmt” property

+
  “key-mgmt”                 gchar *
+

Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any WiFi connection that uses security.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “leap-password” property

+
  “leap-password”            gchar *
+

The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “leap-password-flags” property

+
  “leap-password-flags”      guint
+

Flags indicating how to handle the LEAP password.

+

Flags: Read / Write

+

Allowed values: <= 7

+

Default value: 0

+
+
+
+

The “leap-username” property

+
  “leap-username”            gchar *
+

The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “pairwise” property

+
  “pairwise”                 GSList_gchararray_ *
+

A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of 'wep40', 'wep104', 'tkip' or 'ccmp'.

+

Flags: Read / Write

+
+
+
+

The “proto” property

+
  “proto”                    GSList_gchararray_ *
+

List of strings specifying the allowed WPA protocol versions to use. Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.

+

Flags: Read / Write

+
+
+
+

The “psk” property

+
  “psk”                      gchar *
+

Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the WiFi network.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “psk-flags” property

+
  “psk-flags”                guint
+

Flags indicating how to handle the WPA PSK key.

+

Flags: Read / Write

+

Allowed values: <= 7

+

Default value: 0

+
+
+
+

The “wep-key-flags” property

+
  “wep-key-flags”            guint
+

Flags indicating how to handle the WEP keys.

+

Flags: Read / Write

+

Allowed values: <= 7

+

Default value: 0

+
+
+
+

The “wep-key-type” property

+
  “wep-key-type”             guint
+

Controls the interpretation of WEP keys. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases). If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the actual WEP key.

+

Flags: Read / Write / Construct

+

Allowed values: <= 2

+

Default value: 0

+
+
+
+

The “wep-key0” property

+
  “wep-key0”                 gchar *
+

Index 0 WEP key. This is the WEP key used in most networks. See the 'wep-key-type' property for a description of how this key is interpreted.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “wep-key1” property

+
  “wep-key1”                 gchar *
+

Index 1 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “wep-key2” property

+
  “wep-key2”                 gchar *
+

Index 2 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “wep-key3” property

+
  “wep-key3”                 gchar *
+

Index 3 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “wep-tx-keyidx” property

+
  “wep-tx-keyidx”            guint
+

When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.

+

Flags: Read / Write / Construct

Allowed values: <= 3

Default value: 0

@@ -1448,6 +1786,6 @@ Linksys WRT54G) number the keys 1 - 4.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/annotation-glossary.html b/docs/libnm-util/html/annotation-glossary.html index ae9452da..f121b07a 100644 --- a/docs/libnm-util/html/annotation-glossary.html +++ b/docs/libnm-util/html/annotation-glossary.html @@ -2,53 +2,46 @@ -Annotation Glossary +libnm-util Reference Manual: Annotation Glossary - + - - - - - - - - - - + + + + + + +

Annotation Glossary

-

I

-
inout
-

Parameter for input and for returning results. Default is transfer full.

A

allow-none

NULL is ok, both for passing and for returning.

-

T

-
transfer container
-

Free data container after the code is done.

+
array
+

Parameter points to an array of items.

+

E

+
element-type
+

Generics and defining elements of containers and arrays.

+

I

+
inout
+

Parameter for input and for returning results. Default is transfer full.

O

out

Parameter for returning results. Default is transfer full.

@@ -56,17 +49,15 @@
scope call

The callback is valid only during the call to the method.

T

-
transfer none
-

Don't free data after the code is done.

-

E

-
element-type
-

Generics and defining elements of containers and arrays.

-

T

+
transfer container
+

Free data container after the code is done.

transfer full

Free data after the code is done.

+
transfer none
+

Don't free data after the code is done.

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/api-index-full.html b/docs/libnm-util/html/api-index-full.html index 9d53c16b..6eaf3b9d 100644 --- a/docs/libnm-util/html/api-index-full.html +++ b/docs/libnm-util/html/api-index-full.html @@ -2,38 +2,33 @@ -API Index +libnm-util Reference Manual: API Index - + - - - - - - - - - - + + + + + + +

API Index

@@ -43,55 +38,51 @@
-NMConnection::secrets-cleared, object signal in NMConnection +NMConnection::secrets-cleared, object signal in NMConnection
-NMConnection::secrets-updated, object signal in NMConnection +NMConnection::secrets-updated, object signal in NMConnection
-NMConnection:path, object property in NMConnection +NMConnection:path, object property in NMConnection
-NMConnectionClass, struct in NMConnection +NMConnectionError, enum in NMConnection
-NMConnectionError, enum in NMConnection +nm_connection_add_setting, function in NMConnection
-nm_connection_add_setting, function in NMConnection +nm_connection_clear_secrets, function in NMConnection
-nm_connection_clear_secrets, function in NMConnection +nm_connection_clear_secrets_with_flags, function in NMConnection
-nm_connection_clear_secrets_with_flags, function in NMConnection +nm_connection_compare, function in NMConnection
-nm_connection_compare, function in NMConnection +nm_connection_create_setting, function in NMConnection
-nm_connection_create_setting, function in NMConnection +nm_connection_diff, function in NMConnection
-nm_connection_diff, function in NMConnection +nm_connection_dump, function in NMConnection
-nm_connection_dump, function in NMConnection -
-
-
-nm_connection_duplicate, function in NMConnection +nm_connection_duplicate, function in NMConnection
@@ -99,147 +90,147 @@
-nm_connection_error_quark, function in NMConnection +nm_connection_error_quark, function in NMConnection
-nm_connection_for_each_setting_value, function in NMConnection +nm_connection_for_each_setting_value, function in NMConnection
-nm_connection_get_id, function in NMConnection +nm_connection_get_id, function in NMConnection
-nm_connection_get_path, function in NMConnection +nm_connection_get_path, function in NMConnection
-nm_connection_get_setting, function in NMConnection +nm_connection_get_setting, function in NMConnection
-nm_connection_get_setting_802_1x, function in NMConnection +nm_connection_get_setting_802_1x, function in NMConnection
-nm_connection_get_setting_adsl, function in NMConnection +nm_connection_get_setting_adsl, function in NMConnection
-nm_connection_get_setting_bluetooth, function in NMConnection +nm_connection_get_setting_bluetooth, function in NMConnection
-nm_connection_get_setting_bond, function in NMConnection +nm_connection_get_setting_bond, function in NMConnection
-nm_connection_get_setting_bridge, function in NMConnection +nm_connection_get_setting_bridge, function in NMConnection
-nm_connection_get_setting_bridge_port, function in NMConnection +nm_connection_get_setting_bridge_port, function in NMConnection
-nm_connection_get_setting_by_name, function in NMConnection +nm_connection_get_setting_by_name, function in NMConnection
-nm_connection_get_setting_cdma, function in NMConnection +nm_connection_get_setting_cdma, function in NMConnection
-nm_connection_get_setting_connection, function in NMConnection +nm_connection_get_setting_connection, function in NMConnection
-nm_connection_get_setting_gsm, function in NMConnection +nm_connection_get_setting_gsm, function in NMConnection
-nm_connection_get_setting_infiniband, function in NMConnection +nm_connection_get_setting_infiniband, function in NMConnection
-nm_connection_get_setting_ip4_config, function in NMConnection +nm_connection_get_setting_ip4_config, function in NMConnection
-nm_connection_get_setting_ip6_config, function in NMConnection +nm_connection_get_setting_ip6_config, function in NMConnection
-nm_connection_get_setting_olpc_mesh, function in NMConnection +nm_connection_get_setting_olpc_mesh, function in NMConnection
-nm_connection_get_setting_ppp, function in NMConnection +nm_connection_get_setting_ppp, function in NMConnection
-nm_connection_get_setting_pppoe, function in NMConnection +nm_connection_get_setting_pppoe, function in NMConnection
-nm_connection_get_setting_serial, function in NMConnection +nm_connection_get_setting_serial, function in NMConnection
-nm_connection_get_setting_vlan, function in NMConnection +nm_connection_get_setting_vlan, function in NMConnection
-nm_connection_get_setting_vpn, function in NMConnection +nm_connection_get_setting_vpn, function in NMConnection
-nm_connection_get_setting_wimax, function in NMConnection +nm_connection_get_setting_wimax, function in NMConnection
-nm_connection_get_setting_wired, function in NMConnection +nm_connection_get_setting_wired, function in NMConnection
-nm_connection_get_setting_wireless, function in NMConnection +nm_connection_get_setting_wireless, function in NMConnection
-nm_connection_get_setting_wireless_security, function in NMConnection +nm_connection_get_setting_wireless_security, function in NMConnection
-nm_connection_get_uuid, function in NMConnection +nm_connection_get_uuid, function in NMConnection
-nm_connection_get_virtual_iface_name, function in NMConnection +nm_connection_get_virtual_iface_name, function in NMConnection
-nm_connection_is_type, function in NMConnection +nm_connection_is_type, function in NMConnection
-nm_connection_lookup_setting_type, function in NMConnection +nm_connection_lookup_setting_type, function in NMConnection
-nm_connection_lookup_setting_type_by_quark, function in NMConnection +nm_connection_lookup_setting_type_by_quark, function in NMConnection
-nm_connection_need_secrets, function in NMConnection +nm_connection_need_secrets, function in NMConnection
-nm_connection_new, function in NMConnection +nm_connection_new, function in NMConnection
-nm_connection_new_from_hash, function in NMConnection +nm_connection_new_from_hash, function in NMConnection
@@ -247,236 +238,220 @@
-nm_connection_remove_setting, function in NMConnection +nm_connection_remove_setting, function in NMConnection
-nm_connection_replace_settings, function in NMConnection +nm_connection_replace_settings, function in NMConnection
-nm_connection_set_path, function in NMConnection +nm_connection_set_path, function in NMConnection
-nm_connection_to_hash, function in NMConnection +nm_connection_to_hash, function in NMConnection
-nm_connection_update_secrets, function in NMConnection +nm_connection_update_secrets, function in NMConnection
-nm_connection_verify, function in NMConnection +nm_connection_verify, function in NMConnection

I

-NMIP4Address, typedef in NMSettingIP4Config -
-
-
-NMIP4Route, typedef in NMSettingIP4Config +nm_ip4_address_compare, function in NMSettingIP4Config
-nm_ip4_address_compare, function in NMSettingIP4Config +nm_ip4_address_dup, function in NMSettingIP4Config
-nm_ip4_address_dup, function in NMSettingIP4Config +nm_ip4_address_get_address, function in NMSettingIP4Config
-nm_ip4_address_get_address, function in NMSettingIP4Config +nm_ip4_address_get_gateway, function in NMSettingIP4Config
-nm_ip4_address_get_gateway, function in NMSettingIP4Config +nm_ip4_address_get_prefix, function in NMSettingIP4Config
-nm_ip4_address_get_prefix, function in NMSettingIP4Config +nm_ip4_address_new, function in NMSettingIP4Config
-nm_ip4_address_new, function in NMSettingIP4Config +nm_ip4_address_ref, function in NMSettingIP4Config
-nm_ip4_address_ref, function in NMSettingIP4Config +nm_ip4_address_set_address, function in NMSettingIP4Config
-nm_ip4_address_set_address, function in NMSettingIP4Config +nm_ip4_address_set_gateway, function in NMSettingIP4Config
-nm_ip4_address_set_gateway, function in NMSettingIP4Config +nm_ip4_address_set_prefix, function in NMSettingIP4Config
-nm_ip4_address_set_prefix, function in NMSettingIP4Config +nm_ip4_address_unref, function in NMSettingIP4Config
-nm_ip4_address_unref, function in NMSettingIP4Config +nm_ip4_route_compare, function in NMSettingIP4Config
-nm_ip4_route_compare, function in NMSettingIP4Config +nm_ip4_route_dup, function in NMSettingIP4Config
-nm_ip4_route_dup, function in NMSettingIP4Config +nm_ip4_route_get_dest, function in NMSettingIP4Config
-nm_ip4_route_get_dest, function in NMSettingIP4Config +nm_ip4_route_get_metric, function in NMSettingIP4Config
-nm_ip4_route_get_metric, function in NMSettingIP4Config +nm_ip4_route_get_next_hop, function in NMSettingIP4Config
-nm_ip4_route_get_next_hop, function in NMSettingIP4Config +nm_ip4_route_get_prefix, function in NMSettingIP4Config
-nm_ip4_route_get_prefix, function in NMSettingIP4Config +nm_ip4_route_new, function in NMSettingIP4Config
-nm_ip4_route_new, function in NMSettingIP4Config +nm_ip4_route_ref, function in NMSettingIP4Config
-nm_ip4_route_ref, function in NMSettingIP4Config +nm_ip4_route_set_dest, function in NMSettingIP4Config
-nm_ip4_route_set_dest, function in NMSettingIP4Config +nm_ip4_route_set_metric, function in NMSettingIP4Config
-nm_ip4_route_set_metric, function in NMSettingIP4Config +nm_ip4_route_set_next_hop, function in NMSettingIP4Config
-nm_ip4_route_set_next_hop, function in NMSettingIP4Config +nm_ip4_route_set_prefix, function in NMSettingIP4Config
-nm_ip4_route_set_prefix, function in NMSettingIP4Config +nm_ip4_route_unref, function in NMSettingIP4Config
-nm_ip4_route_unref, function in NMSettingIP4Config +nm_ip6_address_compare, function in NMSettingIP6Config
-NMIP6Address, typedef in NMSettingIP6Config +nm_ip6_address_dup, function in NMSettingIP6Config
-NMIP6Route, typedef in NMSettingIP6Config +nm_ip6_address_get_address, function in NMSettingIP6Config
-nm_ip6_address_compare, function in NMSettingIP6Config +nm_ip6_address_get_gateway, function in NMSettingIP6Config
-nm_ip6_address_dup, function in NMSettingIP6Config +nm_ip6_address_get_prefix, function in NMSettingIP6Config
-nm_ip6_address_get_address, function in NMSettingIP6Config +nm_ip6_address_new, function in NMSettingIP6Config
-nm_ip6_address_get_gateway, function in NMSettingIP6Config +nm_ip6_address_ref, function in NMSettingIP6Config
-nm_ip6_address_get_prefix, function in NMSettingIP6Config +nm_ip6_address_set_address, function in NMSettingIP6Config
-nm_ip6_address_new, function in NMSettingIP6Config +nm_ip6_address_set_gateway, function in NMSettingIP6Config
-nm_ip6_address_ref, function in NMSettingIP6Config +nm_ip6_address_set_prefix, function in NMSettingIP6Config
-nm_ip6_address_set_address, function in NMSettingIP6Config +nm_ip6_address_unref, function in NMSettingIP6Config
-nm_ip6_address_set_gateway, function in NMSettingIP6Config +nm_ip6_route_compare, function in NMSettingIP6Config
-nm_ip6_address_set_prefix, function in NMSettingIP6Config +nm_ip6_route_dup, function in NMSettingIP6Config
-nm_ip6_address_unref, function in NMSettingIP6Config +nm_ip6_route_get_dest, function in NMSettingIP6Config
-nm_ip6_route_compare, function in NMSettingIP6Config +nm_ip6_route_get_metric, function in NMSettingIP6Config
-nm_ip6_route_dup, function in NMSettingIP6Config +nm_ip6_route_get_next_hop, function in NMSettingIP6Config
-nm_ip6_route_get_dest, function in NMSettingIP6Config +nm_ip6_route_get_prefix, function in NMSettingIP6Config
-nm_ip6_route_get_metric, function in NMSettingIP6Config +nm_ip6_route_new, function in NMSettingIP6Config
-nm_ip6_route_get_next_hop, function in NMSettingIP6Config +nm_ip6_route_ref, function in NMSettingIP6Config
-nm_ip6_route_get_prefix, function in NMSettingIP6Config +nm_ip6_route_set_dest, function in NMSettingIP6Config
-nm_ip6_route_new, function in NMSettingIP6Config +nm_ip6_route_set_metric, function in NMSettingIP6Config
-nm_ip6_route_ref, function in NMSettingIP6Config +nm_ip6_route_set_next_hop, function in NMSettingIP6Config
-nm_ip6_route_set_dest, function in NMSettingIP6Config +nm_ip6_route_set_prefix, function in NMSettingIP6Config
-nm_ip6_route_set_metric, function in NMSettingIP6Config -
-
-
-nm_ip6_route_set_next_hop, function in NMSettingIP6Config -
-
-
-nm_ip6_route_set_prefix, function in NMSettingIP6Config -
-
-
-nm_ip6_route_unref, function in NMSettingIP6Config +nm_ip6_route_unref, function in NMSettingIP6Config

S

@@ -485,339 +460,279 @@
-NMSetting8021x, struct in NMSetting8021x -
-
-
-NMSetting8021x:altsubject-matches, object property in NMSetting8021x -
-
-
-NMSetting8021x:anonymous-identity, object property in NMSetting8021x -
-
-
-NMSetting8021x:ca-cert, object property in NMSetting8021x -
-
-
-NMSetting8021x:ca-path, object property in NMSetting8021x -
-
-
-NMSetting8021x:client-cert, object property in NMSetting8021x -
-
-
-NMSetting8021x:eap, object property in NMSetting8021x -
-
-
-NMSetting8021x:identity, object property in NMSetting8021x -
-
-
-NMSetting8021x:pac-file, object property in NMSetting8021x -
-
-
-NMSetting8021x:password, object property in NMSetting8021x +NMSetting8021x:altsubject-matches, object property in NMSetting8021x
-NMSetting8021x:password-flags, object property in NMSetting8021x +NMSetting8021x:anonymous-identity, object property in NMSetting8021x
-NMSetting8021x:password-raw, object property in NMSetting8021x +NMSetting8021x:ca-cert, object property in NMSetting8021x
-NMSetting8021x:password-raw-flags, object property in NMSetting8021x +NMSetting8021x:ca-path, object property in NMSetting8021x
-NMSetting8021x:phase1-fast-provisioning, object property in NMSetting8021x +NMSetting8021x:client-cert, object property in NMSetting8021x
-NMSetting8021x:phase1-peaplabel, object property in NMSetting8021x +NMSetting8021x:eap, object property in NMSetting8021x
-NMSetting8021x:phase1-peapver, object property in NMSetting8021x +NMSetting8021x:identity, object property in NMSetting8021x
-NMSetting8021x:phase2-altsubject-matches, object property in NMSetting8021x +NMSetting8021x:pac-file, object property in NMSetting8021x
-NMSetting8021x:phase2-auth, object property in NMSetting8021x +NMSetting8021x:password, object property in NMSetting8021x
-NMSetting8021x:phase2-autheap, object property in NMSetting8021x +NMSetting8021x:password-flags, object property in NMSetting8021x
-NMSetting8021x:phase2-ca-cert, object property in NMSetting8021x +NMSetting8021x:password-raw, object property in NMSetting8021x
-NMSetting8021x:phase2-ca-path, object property in NMSetting8021x +NMSetting8021x:password-raw-flags, object property in NMSetting8021x
-NMSetting8021x:phase2-client-cert, object property in NMSetting8021x +NMSetting8021x:phase1-fast-provisioning, object property in NMSetting8021x
-NMSetting8021x:phase2-private-key, object property in NMSetting8021x +NMSetting8021x:phase1-peaplabel, object property in NMSetting8021x
-NMSetting8021x:phase2-private-key-password, object property in NMSetting8021x +NMSetting8021x:phase1-peapver, object property in NMSetting8021x
-NMSetting8021x:phase2-private-key-password-flags, object property in NMSetting8021x +NMSetting8021x:phase2-altsubject-matches, object property in NMSetting8021x
-NMSetting8021x:phase2-subject-match, object property in NMSetting8021x +NMSetting8021x:phase2-auth, object property in NMSetting8021x
-NMSetting8021x:pin, object property in NMSetting8021x +NMSetting8021x:phase2-autheap, object property in NMSetting8021x
-NMSetting8021x:pin-flags, object property in NMSetting8021x +NMSetting8021x:phase2-ca-cert, object property in NMSetting8021x
-NMSetting8021x:private-key, object property in NMSetting8021x +NMSetting8021x:phase2-ca-path, object property in NMSetting8021x
-NMSetting8021x:private-key-password, object property in NMSetting8021x +NMSetting8021x:phase2-client-cert, object property in NMSetting8021x
-NMSetting8021x:private-key-password-flags, object property in NMSetting8021x +NMSetting8021x:phase2-private-key, object property in NMSetting8021x
-NMSetting8021x:subject-match, object property in NMSetting8021x +NMSetting8021x:phase2-private-key-password, object property in NMSetting8021x
-NMSetting8021x:system-ca-certs, object property in NMSetting8021x +NMSetting8021x:phase2-private-key-password-flags, object property in NMSetting8021x
-NMSetting8021xCKFormat, enum in NMSetting8021x +NMSetting8021x:phase2-subject-match, object property in NMSetting8021x
-NMSetting8021xCKScheme, enum in NMSetting8021x +NMSetting8021x:pin, object property in NMSetting8021x
-NMSetting8021xClass, struct in NMSetting8021x +NMSetting8021x:pin-flags, object property in NMSetting8021x
-NMSetting8021xError, enum in NMSetting8021x +NMSetting8021x:private-key, object property in NMSetting8021x
-NMSetting:name, object property in NMSetting +NMSetting8021x:private-key-password, object property in NMSetting8021x
-NMSettingAdsl, struct in NMSettingAdsl +NMSetting8021x:private-key-password-flags, object property in NMSetting8021x
-NMSettingAdsl:encapsulation, object property in NMSettingAdsl +NMSetting8021x:subject-match, object property in NMSetting8021x
-NMSettingAdsl:password, object property in NMSettingAdsl +NMSetting8021x:system-ca-certs, object property in NMSetting8021x
-NMSettingAdsl:password-flags, object property in NMSettingAdsl +NMSetting8021xCKFormat, enum in NMSetting8021x
-NMSettingAdsl:protocol, object property in NMSettingAdsl +NMSetting8021xCKScheme, enum in NMSetting8021x
-NMSettingAdsl:username, object property in NMSettingAdsl +NMSetting8021xError, enum in NMSetting8021x
-NMSettingAdsl:vci, object property in NMSettingAdsl +NMSetting:name, object property in NMSetting
-NMSettingAdsl:vpi, object property in NMSettingAdsl +NMSettingAdsl:encapsulation, object property in NMSettingAdsl
-NMSettingAdslClass, struct in NMSettingAdsl +NMSettingAdsl:password, object property in NMSettingAdsl
-NMSettingAdslError, enum in NMSettingAdsl +NMSettingAdsl:password-flags, object property in NMSettingAdsl
-NMSettingBluetooth, struct in NMSettingBluetooth +NMSettingAdsl:protocol, object property in NMSettingAdsl
-NMSettingBluetooth:bdaddr, object property in NMSettingBluetooth +NMSettingAdsl:username, object property in NMSettingAdsl
-NMSettingBluetooth:type, object property in NMSettingBluetooth +NMSettingAdsl:vci, object property in NMSettingAdsl
-NMSettingBluetoothClass, struct in NMSettingBluetooth +NMSettingAdsl:vpi, object property in NMSettingAdsl
-NMSettingBluetoothError, enum in NMSettingBluetooth +NMSettingAdslError, enum in NMSettingAdsl
-NMSettingBond, struct in NMSettingBond +NMSettingBluetooth:bdaddr, object property in NMSettingBluetooth
-NMSettingBond:interface-name, object property in NMSettingBond +NMSettingBluetooth:type, object property in NMSettingBluetooth
-NMSettingBond:options, object property in NMSettingBond +NMSettingBluetoothError, enum in NMSettingBluetooth
-NMSettingBondClass, struct in NMSettingBond +NMSettingBond:interface-name, object property in NMSettingBond
-NMSettingBondError, enum in NMSettingBond +NMSettingBond:options, object property in NMSettingBond
-NMSettingBridge, struct in NMSettingBridge +NMSettingBondError, enum in NMSettingBond
-NMSettingBridge:ageing-time, object property in NMSettingBridge +NMSettingBridge:ageing-time, object property in NMSettingBridge
-NMSettingBridge:forward-delay, object property in NMSettingBridge +NMSettingBridge:forward-delay, object property in NMSettingBridge
-NMSettingBridge:hello-time, object property in NMSettingBridge +NMSettingBridge:hello-time, object property in NMSettingBridge
-NMSettingBridge:interface-name, object property in NMSettingBridge +NMSettingBridge:interface-name, object property in NMSettingBridge
-NMSettingBridge:max-age, object property in NMSettingBridge +NMSettingBridge:max-age, object property in NMSettingBridge
-NMSettingBridge:priority, object property in NMSettingBridge +NMSettingBridge:priority, object property in NMSettingBridge
-NMSettingBridge:stp, object property in NMSettingBridge +NMSettingBridge:stp, object property in NMSettingBridge
-NMSettingBridgeClass, struct in NMSettingBridge +NMSettingBridgeError, enum in NMSettingBridge
-NMSettingBridgeError, enum in NMSettingBridge +NMSettingBridgePort:hairpin-mode, object property in NMSettingBridgePort
-NMSettingBridgePort, struct in NMSettingBridgePort +NMSettingBridgePort:path-cost, object property in NMSettingBridgePort
-NMSettingBridgePort:hairpin-mode, object property in NMSettingBridgePort +NMSettingBridgePort:priority, object property in NMSettingBridgePort
-NMSettingBridgePort:path-cost, object property in NMSettingBridgePort +NMSettingBridgePortError, enum in NMSettingBridgePort
-NMSettingBridgePort:priority, object property in NMSettingBridgePort +NMSettingCdma:number, object property in NMSettingCdma
-NMSettingBridgePortClass, struct in NMSettingBridgePort +NMSettingCdma:password, object property in NMSettingCdma
-NMSettingBridgePortError, enum in NMSettingBridgePort +NMSettingCdma:password-flags, object property in NMSettingCdma
-NMSettingCdma, struct in NMSettingCdma +NMSettingCdma:username, object property in NMSettingCdma
-NMSettingCdma:number, object property in NMSettingCdma +NMSettingCdmaError, enum in NMSettingCdma
-NMSettingCdma:password, object property in NMSettingCdma +NMSettingClearSecretsWithFlagsFn, user_function in NMSetting
-NMSettingCdma:password-flags, object property in NMSettingCdma -
-
-
-NMSettingCdma:username, object property in NMSettingCdma -
-
-
-NMSettingCdmaClass, struct in NMSettingCdma -
-
-
-NMSettingCdmaError, enum in NMSettingCdma -
-
-
-NMSettingClass, struct in NMSetting -
-
-
-NMSettingClearSecretsWithFlagsFn, user_function in NMSetting -
-
-
-NMSettingCompareFlags, enum in NMSetting +NMSettingCompareFlags, enum in NMSetting
@@ -825,751 +740,635 @@
-NMSettingConnection:autoconnect, object property in NMSettingConnection -
-
-
-NMSettingConnection:id, object property in NMSettingConnection -
-
-
-NMSettingConnection:master, object property in NMSettingConnection -
-
-
-NMSettingConnection:permissions, object property in NMSettingConnection -
-
-
-NMSettingConnection:read-only, object property in NMSettingConnection -
-
-
-NMSettingConnection:secondaries, object property in NMSettingConnection -
-
-
-NMSettingConnection:slave-type, object property in NMSettingConnection -
-
-
-NMSettingConnection:timestamp, object property in NMSettingConnection -
-
-
-NMSettingConnection:type, object property in NMSettingConnection -
-
-
-NMSettingConnection:uuid, object property in NMSettingConnection -
-
-
-NMSettingConnection:zone, object property in NMSettingConnection -
-
-
-NMSettingConnectionClass, struct in NMSettingConnection -
-
-
-NMSettingConnectionError, enum in NMSettingConnection -
-
-
-NMSettingDiffResult, enum in NMSetting -
-
-
-NMSettingError, enum in NMSetting -
-
-
-NMSettingGsm, struct in NMSettingGsm -
-
-
-NMSettingGsm:allowed-bands, object property in NMSettingGsm -
-
-
-NMSettingGsm:apn, object property in NMSettingGsm -
-
-
-NMSettingGsm:home-only, object property in NMSettingGsm -
-
-
-NMSettingGsm:network-id, object property in NMSettingGsm -
-
-
-NMSettingGsm:network-type, object property in NMSettingGsm -
-
-
-NMSettingGsm:number, object property in NMSettingGsm -
-
-
-NMSettingGsm:password, object property in NMSettingGsm -
-
-
-NMSettingGsm:password-flags, object property in NMSettingGsm -
-
-
-NMSettingGsm:pin, object property in NMSettingGsm -
-
-
-NMSettingGsm:pin-flags, object property in NMSettingGsm -
-
-
-NMSettingGsm:username, object property in NMSettingGsm -
-
-
-NMSettingGsmClass, struct in NMSettingGsm -
-
-
-NMSettingGsmError, enum in NMSettingGsm -
-
-
-NMSettingGsmNetworkBand, enum in NMSettingGsm +NMSettingConnection:autoconnect, object property in NMSettingConnection
-NMSettingGsmNetworkType, enum in NMSettingGsm +NMSettingConnection:id, object property in NMSettingConnection
-NMSettingHashFlags, enum in NMSetting +NMSettingConnection:master, object property in NMSettingConnection
-NMSettingInfiniband, struct in NMSettingInfiniband +NMSettingConnection:permissions, object property in NMSettingConnection
-NMSettingInfiniband:mac-address, object property in NMSettingInfiniband +NMSettingConnection:read-only, object property in NMSettingConnection
-NMSettingInfiniband:mtu, object property in NMSettingInfiniband +NMSettingConnection:secondaries, object property in NMSettingConnection
-NMSettingInfiniband:transport-mode, object property in NMSettingInfiniband +NMSettingConnection:slave-type, object property in NMSettingConnection
-NMSettingInfinibandClass, struct in NMSettingInfiniband +NMSettingConnection:timestamp, object property in NMSettingConnection
-NMSettingInfinibandError, enum in NMSettingInfiniband +NMSettingConnection:type, object property in NMSettingConnection
-NMSettingIP4Config, struct in NMSettingIP4Config +NMSettingConnection:uuid, object property in NMSettingConnection
-NMSettingIP4Config:addresses, object property in NMSettingIP4Config +NMSettingConnection:zone, object property in NMSettingConnection
-NMSettingIP4Config:dhcp-client-id, object property in NMSettingIP4Config +NMSettingConnectionError, enum in NMSettingConnection
-NMSettingIP4Config:dhcp-hostname, object property in NMSettingIP4Config +NMSettingDiffResult, enum in NMSetting
-NMSettingIP4Config:dhcp-send-hostname, object property in NMSettingIP4Config +NMSettingError, enum in NMSetting
-NMSettingIP4Config:dns, object property in NMSettingIP4Config +NMSettingGsm:allowed-bands, object property in NMSettingGsm
-NMSettingIP4Config:dns-search, object property in NMSettingIP4Config +NMSettingGsm:apn, object property in NMSettingGsm
-NMSettingIP4Config:ignore-auto-dns, object property in NMSettingIP4Config +NMSettingGsm:home-only, object property in NMSettingGsm
-NMSettingIP4Config:ignore-auto-routes, object property in NMSettingIP4Config +NMSettingGsm:network-id, object property in NMSettingGsm
-NMSettingIP4Config:may-fail, object property in NMSettingIP4Config +NMSettingGsm:network-type, object property in NMSettingGsm
-NMSettingIP4Config:method, object property in NMSettingIP4Config +NMSettingGsm:number, object property in NMSettingGsm
-NMSettingIP4Config:never-default, object property in NMSettingIP4Config +NMSettingGsm:password, object property in NMSettingGsm
-NMSettingIP4Config:routes, object property in NMSettingIP4Config +NMSettingGsm:password-flags, object property in NMSettingGsm
-NMSettingIP4ConfigClass, struct in NMSettingIP4Config +NMSettingGsm:pin, object property in NMSettingGsm
-NMSettingIP4ConfigError, enum in NMSettingIP4Config +NMSettingGsm:pin-flags, object property in NMSettingGsm
-NMSettingIP6Config, struct in NMSettingIP6Config +NMSettingGsm:username, object property in NMSettingGsm
-NMSettingIP6Config:addresses, object property in NMSettingIP6Config +NMSettingGsmError, enum in NMSettingGsm
-NMSettingIP6Config:dhcp-hostname, object property in NMSettingIP6Config +NMSettingGsmNetworkBand, enum in NMSettingGsm
-NMSettingIP6Config:dns, object property in NMSettingIP6Config +NMSettingGsmNetworkType, enum in NMSettingGsm
-NMSettingIP6Config:dns-search, object property in NMSettingIP6Config +NMSettingHashFlags, enum in NMSetting
-NMSettingIP6Config:ignore-auto-dns, object property in NMSettingIP6Config +NMSettingInfiniband:mac-address, object property in NMSettingInfiniband
-NMSettingIP6Config:ignore-auto-routes, object property in NMSettingIP6Config +NMSettingInfiniband:mtu, object property in NMSettingInfiniband
-NMSettingIP6Config:ip6-privacy, object property in NMSettingIP6Config +NMSettingInfiniband:transport-mode, object property in NMSettingInfiniband
-NMSettingIP6Config:may-fail, object property in NMSettingIP6Config +NMSettingInfinibandError, enum in NMSettingInfiniband
-NMSettingIP6Config:method, object property in NMSettingIP6Config +NMSettingIP4Config:addresses, object property in NMSettingIP4Config
-NMSettingIP6Config:never-default, object property in NMSettingIP6Config +NMSettingIP4Config:dhcp-client-id, object property in NMSettingIP4Config
-NMSettingIP6Config:routes, object property in NMSettingIP6Config +NMSettingIP4Config:dhcp-hostname, object property in NMSettingIP4Config
-NMSettingIP6ConfigClass, struct in NMSettingIP6Config +NMSettingIP4Config:dhcp-send-hostname, object property in NMSettingIP4Config
-NMSettingIP6ConfigError, enum in NMSettingIP6Config +NMSettingIP4Config:dns, object property in NMSettingIP4Config
-NMSettingIP6ConfigPrivacy, enum in NMSettingIP6Config +NMSettingIP4Config:dns-search, object property in NMSettingIP4Config
-NMSettingOlpcMesh, struct in NMSettingOlpcMesh +NMSettingIP4Config:ignore-auto-dns, object property in NMSettingIP4Config
-NMSettingOlpcMesh:channel, object property in NMSettingOlpcMesh +NMSettingIP4Config:ignore-auto-routes, object property in NMSettingIP4Config
-NMSettingOlpcMesh:dhcp-anycast-address, object property in NMSettingOlpcMesh +NMSettingIP4Config:may-fail, object property in NMSettingIP4Config
-NMSettingOlpcMesh:ssid, object property in NMSettingOlpcMesh +NMSettingIP4Config:method, object property in NMSettingIP4Config
-NMSettingOlpcMeshClass, struct in NMSettingOlpcMesh +NMSettingIP4Config:never-default, object property in NMSettingIP4Config
-NMSettingOlpcMeshError, enum in NMSettingOlpcMesh +NMSettingIP4Config:routes, object property in NMSettingIP4Config
-NMSettingPPP, struct in NMSettingPPP +NMSettingIP4ConfigError, enum in NMSettingIP4Config
-NMSettingPPP:baud, object property in NMSettingPPP +NMSettingIP6Config:addresses, object property in NMSettingIP6Config
-NMSettingPPP:crtscts, object property in NMSettingPPP +NMSettingIP6Config:dhcp-hostname, object property in NMSettingIP6Config
-NMSettingPPP:lcp-echo-failure, object property in NMSettingPPP +NMSettingIP6Config:dns, object property in NMSettingIP6Config
-NMSettingPPP:lcp-echo-interval, object property in NMSettingPPP +NMSettingIP6Config:dns-search, object property in NMSettingIP6Config
-NMSettingPPP:mppe-stateful, object property in NMSettingPPP +NMSettingIP6Config:ignore-auto-dns, object property in NMSettingIP6Config
-NMSettingPPP:mru, object property in NMSettingPPP +NMSettingIP6Config:ignore-auto-routes, object property in NMSettingIP6Config
-NMSettingPPP:mtu, object property in NMSettingPPP +NMSettingIP6Config:ip6-privacy, object property in NMSettingIP6Config
-NMSettingPPP:no-vj-comp, object property in NMSettingPPP +NMSettingIP6Config:may-fail, object property in NMSettingIP6Config
-NMSettingPPP:noauth, object property in NMSettingPPP +NMSettingIP6Config:method, object property in NMSettingIP6Config
-NMSettingPPP:nobsdcomp, object property in NMSettingPPP +NMSettingIP6Config:never-default, object property in NMSettingIP6Config
-NMSettingPPP:nodeflate, object property in NMSettingPPP +NMSettingIP6Config:routes, object property in NMSettingIP6Config
-NMSettingPPP:refuse-chap, object property in NMSettingPPP +NMSettingIP6ConfigError, enum in NMSettingIP6Config
-NMSettingPPP:refuse-eap, object property in NMSettingPPP +NMSettingIP6ConfigPrivacy, enum in NMSettingIP6Config
-NMSettingPPP:refuse-mschap, object property in NMSettingPPP +NMSettingOlpcMesh:channel, object property in NMSettingOlpcMesh
-NMSettingPPP:refuse-mschapv2, object property in NMSettingPPP +NMSettingOlpcMesh:dhcp-anycast-address, object property in NMSettingOlpcMesh
-NMSettingPPP:refuse-pap, object property in NMSettingPPP +NMSettingOlpcMesh:ssid, object property in NMSettingOlpcMesh
-NMSettingPPP:require-mppe, object property in NMSettingPPP +NMSettingOlpcMeshError, enum in NMSettingOlpcMesh
-NMSettingPPP:require-mppe-128, object property in NMSettingPPP +NMSettingPPP:baud, object property in NMSettingPPP
-NMSettingPPPClass, struct in NMSettingPPP +NMSettingPPP:crtscts, object property in NMSettingPPP
-NMSettingPPPError, enum in NMSettingPPP +NMSettingPPP:lcp-echo-failure, object property in NMSettingPPP
-NMSettingPPPOE, struct in NMSettingPPPOE +NMSettingPPP:lcp-echo-interval, object property in NMSettingPPP
-NMSettingPPPOE:password, object property in NMSettingPPPOE +NMSettingPPP:mppe-stateful, object property in NMSettingPPP
-NMSettingPPPOE:password-flags, object property in NMSettingPPPOE +NMSettingPPP:mru, object property in NMSettingPPP
-NMSettingPPPOE:service, object property in NMSettingPPPOE +NMSettingPPP:mtu, object property in NMSettingPPP
-NMSettingPPPOE:username, object property in NMSettingPPPOE +NMSettingPPP:no-vj-comp, object property in NMSettingPPP
-NMSettingPPPOEClass, struct in NMSettingPPPOE +NMSettingPPP:noauth, object property in NMSettingPPP
-NMSettingPPPOEError, enum in NMSettingPPPOE +NMSettingPPP:nobsdcomp, object property in NMSettingPPP
-NMSettingSecretFlags, enum in NMSetting +NMSettingPPP:nodeflate, object property in NMSettingPPP
-NMSettingSerial, struct in NMSettingSerial +NMSettingPPP:refuse-chap, object property in NMSettingPPP
-NMSettingSerial:baud, object property in NMSettingSerial +NMSettingPPP:refuse-eap, object property in NMSettingPPP
-NMSettingSerial:bits, object property in NMSettingSerial +NMSettingPPP:refuse-mschap, object property in NMSettingPPP
-NMSettingSerial:parity, object property in NMSettingSerial +NMSettingPPP:refuse-mschapv2, object property in NMSettingPPP
-NMSettingSerial:send-delay, object property in NMSettingSerial +NMSettingPPP:refuse-pap, object property in NMSettingPPP
-NMSettingSerial:stopbits, object property in NMSettingSerial +NMSettingPPP:require-mppe, object property in NMSettingPPP
-NMSettingSerialClass, struct in NMSettingSerial +NMSettingPPP:require-mppe-128, object property in NMSettingPPP
-NMSettingSerialError, enum in NMSettingSerial +NMSettingPPPError, enum in NMSettingPPP
-NMSettingValueIterFn, user_function in NMSetting +NMSettingPPPOE:password, object property in NMSettingPPPOE
-NMSettingVlan, struct in NMSettingVlan +NMSettingPPPOE:password-flags, object property in NMSettingPPPOE
-NMSettingVlan:egress-priority-map, object property in NMSettingVlan +NMSettingPPPOE:service, object property in NMSettingPPPOE
-NMSettingVlan:flags, object property in NMSettingVlan +NMSettingPPPOE:username, object property in NMSettingPPPOE
-NMSettingVlan:id, object property in NMSettingVlan +NMSettingPPPOEError, enum in NMSettingPPPOE
-NMSettingVlan:ingress-priority-map, object property in NMSettingVlan +NMSettingSecretFlags, enum in NMSetting
-NMSettingVlan:interface-name, object property in NMSettingVlan +NMSettingSerial:baud, object property in NMSettingSerial
-NMSettingVlan:parent, object property in NMSettingVlan +NMSettingSerial:bits, object property in NMSettingSerial
-NMSettingVlanClass, struct in NMSettingVlan +NMSettingSerial:parity, object property in NMSettingSerial
-NMSettingVlanError, enum in NMSettingVlan +NMSettingSerial:send-delay, object property in NMSettingSerial
-NMSettingVPN, struct in NMSettingVPN +NMSettingSerial:stopbits, object property in NMSettingSerial
-NMSettingVPN:data, object property in NMSettingVPN +NMSettingSerialError, enum in NMSettingSerial
-NMSettingVPN:secrets, object property in NMSettingVPN +NMSettingValueIterFn, user_function in NMSetting
-NMSettingVPN:service-type, object property in NMSettingVPN +NMSettingVlan:egress-priority-map, object property in NMSettingVlan
-NMSettingVPN:user-name, object property in NMSettingVPN +NMSettingVlan:flags, object property in NMSettingVlan
-NMSettingVPNClass, struct in NMSettingVPN +NMSettingVlan:id, object property in NMSettingVlan
-NMSettingVpnError, enum in NMSettingVPN +NMSettingVlan:ingress-priority-map, object property in NMSettingVlan
-NMSettingWimax, struct in NMSettingWimax +NMSettingVlan:interface-name, object property in NMSettingVlan
-NMSettingWimax:mac-address, object property in NMSettingWimax +NMSettingVlan:parent, object property in NMSettingVlan
-NMSettingWimax:network-name, object property in NMSettingWimax +NMSettingVlanError, enum in NMSettingVlan
-NMSettingWimaxClass, struct in NMSettingWimax +NMSettingVPN:data, object property in NMSettingVPN
-NMSettingWimaxError, enum in NMSettingWimax +NMSettingVPN:secrets, object property in NMSettingVPN
-NMSettingWired, struct in NMSettingWired +NMSettingVPN:service-type, object property in NMSettingVPN
-NMSettingWired:auto-negotiate, object property in NMSettingWired +NMSettingVPN:user-name, object property in NMSettingVPN
-NMSettingWired:cloned-mac-address, object property in NMSettingWired +NMSettingVpnError, enum in NMSettingVPN
-NMSettingWired:duplex, object property in NMSettingWired +NMSettingWimax:mac-address, object property in NMSettingWimax
-NMSettingWired:mac-address, object property in NMSettingWired +NMSettingWimax:network-name, object property in NMSettingWimax
-NMSettingWired:mac-address-blacklist, object property in NMSettingWired +NMSettingWimaxError, enum in NMSettingWimax
-NMSettingWired:mtu, object property in NMSettingWired +NMSettingWired:auto-negotiate, object property in NMSettingWired
-NMSettingWired:port, object property in NMSettingWired +NMSettingWired:cloned-mac-address, object property in NMSettingWired
-NMSettingWired:s390-nettype, object property in NMSettingWired +NMSettingWired:duplex, object property in NMSettingWired
-NMSettingWired:s390-options, object property in NMSettingWired +NMSettingWired:mac-address, object property in NMSettingWired
-NMSettingWired:s390-subchannels, object property in NMSettingWired +NMSettingWired:mac-address-blacklist, object property in NMSettingWired
-NMSettingWired:speed, object property in NMSettingWired +NMSettingWired:mtu, object property in NMSettingWired
-NMSettingWiredClass, struct in NMSettingWired +NMSettingWired:port, object property in NMSettingWired
-NMSettingWiredError, enum in NMSettingWired +NMSettingWired:s390-nettype, object property in NMSettingWired
-NMSettingWireless, struct in NMSettingWireless +NMSettingWired:s390-options, object property in NMSettingWired
-NMSettingWireless:band, object property in NMSettingWireless +NMSettingWired:s390-subchannels, object property in NMSettingWired
-NMSettingWireless:bssid, object property in NMSettingWireless +NMSettingWired:speed, object property in NMSettingWired
-NMSettingWireless:channel, object property in NMSettingWireless +NMSettingWiredError, enum in NMSettingWired
-NMSettingWireless:cloned-mac-address, object property in NMSettingWireless +NMSettingWireless:band, object property in NMSettingWireless
-NMSettingWireless:hidden, object property in NMSettingWireless +NMSettingWireless:bssid, object property in NMSettingWireless
-NMSettingWireless:mac-address, object property in NMSettingWireless +NMSettingWireless:channel, object property in NMSettingWireless
-NMSettingWireless:mac-address-blacklist, object property in NMSettingWireless +NMSettingWireless:cloned-mac-address, object property in NMSettingWireless
-NMSettingWireless:mode, object property in NMSettingWireless +NMSettingWireless:hidden, object property in NMSettingWireless
-NMSettingWireless:mtu, object property in NMSettingWireless +NMSettingWireless:mac-address, object property in NMSettingWireless
-NMSettingWireless:rate, object property in NMSettingWireless +NMSettingWireless:mac-address-blacklist, object property in NMSettingWireless
-NMSettingWireless:security, object property in NMSettingWireless +NMSettingWireless:mode, object property in NMSettingWireless
-NMSettingWireless:seen-bssids, object property in NMSettingWireless +NMSettingWireless:mtu, object property in NMSettingWireless
-NMSettingWireless:ssid, object property in NMSettingWireless +NMSettingWireless:rate, object property in NMSettingWireless
-NMSettingWireless:tx-power, object property in NMSettingWireless +NMSettingWireless:security, object property in NMSettingWireless
-NMSettingWirelessClass, struct in NMSettingWireless +NMSettingWireless:seen-bssids, object property in NMSettingWireless
-NMSettingWirelessError, enum in NMSettingWireless +NMSettingWireless:ssid, object property in NMSettingWireless
-NMSettingWirelessSecurity, struct in NMSettingWirelessSecurity +NMSettingWireless:tx-power, object property in NMSettingWireless
-NMSettingWirelessSecurity:auth-alg, object property in NMSettingWirelessSecurity +NMSettingWirelessError, enum in NMSettingWireless
-NMSettingWirelessSecurity:group, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:auth-alg, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:key-mgmt, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:group, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:leap-password, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:key-mgmt, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:leap-password-flags, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:leap-password, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:leap-username, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:leap-password-flags, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:pairwise, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:leap-username, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:proto, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:pairwise, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:psk, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:proto, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:psk-flags, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:psk, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:wep-key-flags, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:psk-flags, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:wep-key-type, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:wep-key-flags, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:wep-key0, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:wep-key-type, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:wep-key1, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:wep-key0, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:wep-key2, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:wep-key1, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:wep-key3, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:wep-key2, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurity:wep-tx-keyidx, object property in NMSettingWirelessSecurity +NMSettingWirelessSecurity:wep-key3, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurityClass, struct in NMSettingWirelessSecurity +NMSettingWirelessSecurity:wep-tx-keyidx, object property in NMSettingWirelessSecurity
-NMSettingWirelessSecurityError, enum in NMSettingWirelessSecurity +NMSettingWirelessSecurityError, enum in NMSettingWirelessSecurity
-nm_setting_802_1x_add_altsubject_match, function in NMSetting8021x +nm_setting_802_1x_add_altsubject_match, function in NMSetting8021x
-nm_setting_802_1x_add_eap_method, function in NMSetting8021x +nm_setting_802_1x_add_eap_method, function in NMSetting8021x
-nm_setting_802_1x_add_phase2_altsubject_match, function in NMSetting8021x +nm_setting_802_1x_add_phase2_altsubject_match, function in NMSetting8021x
@@ -1589,15 +1388,15 @@
-nm_setting_802_1x_clear_altsubject_matches, function in NMSetting8021x +nm_setting_802_1x_clear_altsubject_matches, function in NMSetting8021x
-nm_setting_802_1x_clear_eap_methods, function in NMSetting8021x +nm_setting_802_1x_clear_eap_methods, function in NMSetting8021x
-nm_setting_802_1x_clear_phase2_altsubject_matches, function in NMSetting8021x +nm_setting_802_1x_clear_phase2_altsubject_matches, function in NMSetting8021x
@@ -1613,203 +1412,203 @@
-nm_setting_802_1x_error_quark, function in NMSetting8021x +nm_setting_802_1x_error_quark, function in NMSetting8021x
-nm_setting_802_1x_get_altsubject_match, function in NMSetting8021x +nm_setting_802_1x_get_altsubject_match, function in NMSetting8021x
-nm_setting_802_1x_get_anonymous_identity, function in NMSetting8021x +nm_setting_802_1x_get_anonymous_identity, function in NMSetting8021x
-nm_setting_802_1x_get_ca_cert_blob, function in NMSetting8021x +nm_setting_802_1x_get_ca_cert_blob, function in NMSetting8021x
-nm_setting_802_1x_get_ca_cert_path, function in NMSetting8021x +nm_setting_802_1x_get_ca_cert_path, function in NMSetting8021x
-nm_setting_802_1x_get_ca_cert_scheme, function in NMSetting8021x +nm_setting_802_1x_get_ca_cert_scheme, function in NMSetting8021x
-nm_setting_802_1x_get_ca_path, function in NMSetting8021x +nm_setting_802_1x_get_ca_path, function in NMSetting8021x
-nm_setting_802_1x_get_client_cert_blob, function in NMSetting8021x +nm_setting_802_1x_get_client_cert_blob, function in NMSetting8021x
-nm_setting_802_1x_get_client_cert_path, function in NMSetting8021x +nm_setting_802_1x_get_client_cert_path, function in NMSetting8021x
-nm_setting_802_1x_get_client_cert_scheme, function in NMSetting8021x +nm_setting_802_1x_get_client_cert_scheme, function in NMSetting8021x
-nm_setting_802_1x_get_eap_method, function in NMSetting8021x +nm_setting_802_1x_get_eap_method, function in NMSetting8021x
-nm_setting_802_1x_get_identity, function in NMSetting8021x +nm_setting_802_1x_get_identity, function in NMSetting8021x
-nm_setting_802_1x_get_num_altsubject_matches, function in NMSetting8021x +nm_setting_802_1x_get_num_altsubject_matches, function in NMSetting8021x
-nm_setting_802_1x_get_num_eap_methods, function in NMSetting8021x +nm_setting_802_1x_get_num_eap_methods, function in NMSetting8021x
-nm_setting_802_1x_get_num_phase2_altsubject_matches, function in NMSetting8021x +nm_setting_802_1x_get_num_phase2_altsubject_matches, function in NMSetting8021x
-nm_setting_802_1x_get_pac_file, function in NMSetting8021x +nm_setting_802_1x_get_pac_file, function in NMSetting8021x
-nm_setting_802_1x_get_password, function in NMSetting8021x +nm_setting_802_1x_get_password, function in NMSetting8021x
-nm_setting_802_1x_get_password_flags, function in NMSetting8021x +nm_setting_802_1x_get_password_flags, function in NMSetting8021x
-nm_setting_802_1x_get_password_raw, function in NMSetting8021x +nm_setting_802_1x_get_password_raw, function in NMSetting8021x
-nm_setting_802_1x_get_password_raw_flags, function in NMSetting8021x +nm_setting_802_1x_get_password_raw_flags, function in NMSetting8021x
-nm_setting_802_1x_get_phase1_fast_provisioning, function in NMSetting8021x +nm_setting_802_1x_get_phase1_fast_provisioning, function in NMSetting8021x
-nm_setting_802_1x_get_phase1_peaplabel, function in NMSetting8021x +nm_setting_802_1x_get_phase1_peaplabel, function in NMSetting8021x
-nm_setting_802_1x_get_phase1_peapver, function in NMSetting8021x +nm_setting_802_1x_get_phase1_peapver, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_altsubject_match, function in NMSetting8021x +nm_setting_802_1x_get_phase2_altsubject_match, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_auth, function in NMSetting8021x +nm_setting_802_1x_get_phase2_auth, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_autheap, function in NMSetting8021x +nm_setting_802_1x_get_phase2_autheap, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_ca_cert_blob, function in NMSetting8021x +nm_setting_802_1x_get_phase2_ca_cert_blob, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_ca_cert_path, function in NMSetting8021x +nm_setting_802_1x_get_phase2_ca_cert_path, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_ca_cert_scheme, function in NMSetting8021x +nm_setting_802_1x_get_phase2_ca_cert_scheme, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_ca_path, function in NMSetting8021x +nm_setting_802_1x_get_phase2_ca_path, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_client_cert_blob, function in NMSetting8021x +nm_setting_802_1x_get_phase2_client_cert_blob, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_client_cert_path, function in NMSetting8021x +nm_setting_802_1x_get_phase2_client_cert_path, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_client_cert_scheme, function in NMSetting8021x +nm_setting_802_1x_get_phase2_client_cert_scheme, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_private_key_blob, function in NMSetting8021x +nm_setting_802_1x_get_phase2_private_key_blob, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_private_key_format, function in NMSetting8021x +nm_setting_802_1x_get_phase2_private_key_format, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_private_key_password, function in NMSetting8021x +nm_setting_802_1x_get_phase2_private_key_password, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_private_key_password_flags, function in NMSetting8021x +nm_setting_802_1x_get_phase2_private_key_password_flags, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_private_key_path, function in NMSetting8021x +nm_setting_802_1x_get_phase2_private_key_path, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_private_key_scheme, function in NMSetting8021x +nm_setting_802_1x_get_phase2_private_key_scheme, function in NMSetting8021x
-nm_setting_802_1x_get_phase2_subject_match, function in NMSetting8021x +nm_setting_802_1x_get_phase2_subject_match, function in NMSetting8021x
-nm_setting_802_1x_get_pin, function in NMSetting8021x +nm_setting_802_1x_get_pin, function in NMSetting8021x
-nm_setting_802_1x_get_pin_flags, function in NMSetting8021x +nm_setting_802_1x_get_pin_flags, function in NMSetting8021x
-nm_setting_802_1x_get_private_key_blob, function in NMSetting8021x +nm_setting_802_1x_get_private_key_blob, function in NMSetting8021x
-nm_setting_802_1x_get_private_key_format, function in NMSetting8021x +nm_setting_802_1x_get_private_key_format, function in NMSetting8021x
-nm_setting_802_1x_get_private_key_password, function in NMSetting8021x +nm_setting_802_1x_get_private_key_password, function in NMSetting8021x
-nm_setting_802_1x_get_private_key_password_flags, function in NMSetting8021x +nm_setting_802_1x_get_private_key_password_flags, function in NMSetting8021x
-nm_setting_802_1x_get_private_key_path, function in NMSetting8021x +nm_setting_802_1x_get_private_key_path, function in NMSetting8021x
-nm_setting_802_1x_get_private_key_scheme, function in NMSetting8021x +nm_setting_802_1x_get_private_key_scheme, function in NMSetting8021x
-nm_setting_802_1x_get_subject_match, function in NMSetting8021x +nm_setting_802_1x_get_subject_match, function in NMSetting8021x
-nm_setting_802_1x_get_system_ca_certs, function in NMSetting8021x +nm_setting_802_1x_get_system_ca_certs, function in NMSetting8021x
@@ -1817,7 +1616,7 @@
-nm_setting_802_1x_new, function in NMSetting8021x +nm_setting_802_1x_new, function in NMSetting8021x
@@ -1913,15 +1712,15 @@
-nm_setting_802_1x_remove_altsubject_match, function in NMSetting8021x +nm_setting_802_1x_remove_altsubject_match, function in NMSetting8021x
-nm_setting_802_1x_remove_eap_method, function in NMSetting8021x +nm_setting_802_1x_remove_eap_method, function in NMSetting8021x
-nm_setting_802_1x_remove_phase2_altsubject_match, function in NMSetting8021x +nm_setting_802_1x_remove_phase2_altsubject_match, function in NMSetting8021x
@@ -1929,27 +1728,27 @@
-nm_setting_802_1x_set_ca_cert, function in NMSetting8021x +nm_setting_802_1x_set_ca_cert, function in NMSetting8021x
-nm_setting_802_1x_set_client_cert, function in NMSetting8021x +nm_setting_802_1x_set_client_cert, function in NMSetting8021x
-nm_setting_802_1x_set_phase2_ca_cert, function in NMSetting8021x +nm_setting_802_1x_set_phase2_ca_cert, function in NMSetting8021x
-nm_setting_802_1x_set_phase2_client_cert, function in NMSetting8021x +nm_setting_802_1x_set_phase2_client_cert, function in NMSetting8021x
-nm_setting_802_1x_set_phase2_private_key, function in NMSetting8021x +nm_setting_802_1x_set_phase2_private_key, function in NMSetting8021x
-nm_setting_802_1x_set_private_key, function in NMSetting8021x +nm_setting_802_1x_set_private_key, function in NMSetting8021x
@@ -1977,39 +1776,39 @@
-nm_setting_adsl_error_quark, function in NMSettingAdsl +nm_setting_adsl_error_quark, function in NMSettingAdsl
-nm_setting_adsl_get_encapsulation, function in NMSettingAdsl +nm_setting_adsl_get_encapsulation, function in NMSettingAdsl
-nm_setting_adsl_get_password, function in NMSettingAdsl +nm_setting_adsl_get_password, function in NMSettingAdsl
-nm_setting_adsl_get_password_flags, function in NMSettingAdsl +nm_setting_adsl_get_password_flags, function in NMSettingAdsl
-nm_setting_adsl_get_protocol, function in NMSettingAdsl +nm_setting_adsl_get_protocol, function in NMSettingAdsl
-nm_setting_adsl_get_username, function in NMSettingAdsl +nm_setting_adsl_get_username, function in NMSettingAdsl
-nm_setting_adsl_get_vci, function in NMSettingAdsl +nm_setting_adsl_get_vci, function in NMSettingAdsl
-nm_setting_adsl_get_vpi, function in NMSettingAdsl +nm_setting_adsl_get_vpi, function in NMSettingAdsl
-nm_setting_adsl_new, function in NMSettingAdsl +nm_setting_adsl_new, function in NMSettingAdsl
@@ -2061,19 +1860,19 @@
-nm_setting_bluetooth_error_quark, function in NMSettingBluetooth +nm_setting_bluetooth_error_quark, function in NMSettingBluetooth
-nm_setting_bluetooth_get_bdaddr, function in NMSettingBluetooth +nm_setting_bluetooth_get_bdaddr, function in NMSettingBluetooth
-nm_setting_bluetooth_get_connection_type, function in NMSettingBluetooth +nm_setting_bluetooth_get_connection_type, function in NMSettingBluetooth
-nm_setting_bluetooth_new, function in NMSettingBluetooth +nm_setting_bluetooth_new, function in NMSettingBluetooth
@@ -2093,7 +1892,7 @@
-nm_setting_bond_add_option, function in NMSettingBond +nm_setting_bond_add_option, function in NMSettingBond
@@ -2101,31 +1900,31 @@
-nm_setting_bond_error_quark, function in NMSettingBond +nm_setting_bond_error_quark, function in NMSettingBond
-nm_setting_bond_get_interface_name, function in NMSettingBond +nm_setting_bond_get_interface_name, function in NMSettingBond
-nm_setting_bond_get_num_options, function in NMSettingBond +nm_setting_bond_get_num_options, function in NMSettingBond
-nm_setting_bond_get_option, function in NMSettingBond +nm_setting_bond_get_option, function in NMSettingBond
-nm_setting_bond_get_option_by_name, function in NMSettingBond +nm_setting_bond_get_option_by_name, function in NMSettingBond
-nm_setting_bond_get_option_default, function in NMSettingBond +nm_setting_bond_get_option_default, function in NMSettingBond
-nm_setting_bond_get_valid_options, function in NMSettingBond +nm_setting_bond_get_valid_options, function in NMSettingBond
@@ -2133,7 +1932,7 @@
-nm_setting_bond_new, function in NMSettingBond +nm_setting_bond_new, function in NMSettingBond
@@ -2165,7 +1964,7 @@
-nm_setting_bond_remove_option, function in NMSettingBond +nm_setting_bond_remove_option, function in NMSettingBond
@@ -2181,7 +1980,7 @@
-nm_setting_bridge_error_quark, function in NMSettingBridge +nm_setting_bridge_error_quark, function in NMSettingBridge
@@ -2189,31 +1988,31 @@
-nm_setting_bridge_get_ageing_time, function in NMSettingBridge +nm_setting_bridge_get_ageing_time, function in NMSettingBridge
-nm_setting_bridge_get_forward_delay, function in NMSettingBridge +nm_setting_bridge_get_forward_delay, function in NMSettingBridge
-nm_setting_bridge_get_hello_time, function in NMSettingBridge +nm_setting_bridge_get_hello_time, function in NMSettingBridge
-nm_setting_bridge_get_interface_name, function in NMSettingBridge +nm_setting_bridge_get_interface_name, function in NMSettingBridge
-nm_setting_bridge_get_max_age, function in NMSettingBridge +nm_setting_bridge_get_max_age, function in NMSettingBridge
-nm_setting_bridge_get_priority, function in NMSettingBridge +nm_setting_bridge_get_priority, function in NMSettingBridge
-nm_setting_bridge_get_stp, function in NMSettingBridge +nm_setting_bridge_get_stp, function in NMSettingBridge
@@ -2229,7 +2028,7 @@
-nm_setting_bridge_new, function in NMSettingBridge +nm_setting_bridge_new, function in NMSettingBridge
@@ -2237,19 +2036,19 @@
-nm_setting_bridge_port_error_quark, function in NMSettingBridgePort +nm_setting_bridge_port_error_quark, function in NMSettingBridgePort
-nm_setting_bridge_port_get_hairpin_mode, function in NMSettingBridgePort +nm_setting_bridge_port_get_hairpin_mode, function in NMSettingBridgePort
-nm_setting_bridge_port_get_path_cost, function in NMSettingBridgePort +nm_setting_bridge_port_get_path_cost, function in NMSettingBridgePort
-nm_setting_bridge_port_get_priority, function in NMSettingBridgePort +nm_setting_bridge_port_get_priority, function in NMSettingBridgePort
@@ -2257,7 +2056,7 @@
-nm_setting_bridge_port_new, function in NMSettingBridgePort +nm_setting_bridge_port_new, function in NMSettingBridgePort
@@ -2289,27 +2088,27 @@
-nm_setting_cdma_error_quark, function in NMSettingCdma +nm_setting_cdma_error_quark, function in NMSettingCdma
-nm_setting_cdma_get_number, function in NMSettingCdma +nm_setting_cdma_get_number, function in NMSettingCdma
-nm_setting_cdma_get_password, function in NMSettingCdma +nm_setting_cdma_get_password, function in NMSettingCdma
-nm_setting_cdma_get_password_flags, function in NMSettingCdma +nm_setting_cdma_get_password_flags, function in NMSettingCdma
-nm_setting_cdma_get_username, function in NMSettingCdma +nm_setting_cdma_get_username, function in NMSettingCdma
-nm_setting_cdma_new, function in NMSettingCdma +nm_setting_cdma_new, function in NMSettingCdma
@@ -2333,23 +2132,23 @@
-nm_setting_clear_secrets, function in NMSetting +nm_setting_clear_secrets, function in NMSetting
-nm_setting_clear_secrets_with_flags, function in NMSetting +nm_setting_clear_secrets_with_flags, function in NMSetting
-nm_setting_compare, function in NMSetting +nm_setting_compare, function in NMSetting
-nm_setting_connection_add_permission, function in NMSettingConnection +nm_setting_connection_add_permission, function in NMSettingConnection
-nm_setting_connection_add_secondary, function in NMSettingConnection +nm_setting_connection_add_secondary, function in NMSettingConnection
@@ -2361,59 +2160,59 @@
-nm_setting_connection_error_quark, function in NMSettingConnection +nm_setting_connection_error_quark, function in NMSettingConnection
-nm_setting_connection_get_autoconnect, function in NMSettingConnection +nm_setting_connection_get_autoconnect, function in NMSettingConnection
-nm_setting_connection_get_connection_type, function in NMSettingConnection +nm_setting_connection_get_connection_type, function in NMSettingConnection
-nm_setting_connection_get_id, function in NMSettingConnection +nm_setting_connection_get_id, function in NMSettingConnection
-nm_setting_connection_get_master, function in NMSettingConnection +nm_setting_connection_get_master, function in NMSettingConnection
-nm_setting_connection_get_num_permissions, function in NMSettingConnection +nm_setting_connection_get_num_permissions, function in NMSettingConnection
-nm_setting_connection_get_num_secondaries, function in NMSettingConnection +nm_setting_connection_get_num_secondaries, function in NMSettingConnection
-nm_setting_connection_get_permission, function in NMSettingConnection +nm_setting_connection_get_permission, function in NMSettingConnection
-nm_setting_connection_get_read_only, function in NMSettingConnection +nm_setting_connection_get_read_only, function in NMSettingConnection
-nm_setting_connection_get_secondary, function in NMSettingConnection +nm_setting_connection_get_secondary, function in NMSettingConnection
-nm_setting_connection_get_slave_type, function in NMSettingConnection +nm_setting_connection_get_slave_type, function in NMSettingConnection
-nm_setting_connection_get_timestamp, function in NMSettingConnection +nm_setting_connection_get_timestamp, function in NMSettingConnection
-nm_setting_connection_get_uuid, function in NMSettingConnection +nm_setting_connection_get_uuid, function in NMSettingConnection
-nm_setting_connection_get_zone, function in NMSettingConnection +nm_setting_connection_get_zone, function in NMSettingConnection
@@ -2421,7 +2220,7 @@
-nm_setting_connection_is_slave_type, function in NMSettingConnection +nm_setting_connection_is_slave_type, function in NMSettingConnection
@@ -2429,7 +2228,7 @@
-nm_setting_connection_new, function in NMSettingConnection +nm_setting_connection_new, function in NMSettingConnection
@@ -2437,7 +2236,7 @@
-nm_setting_connection_permissions_user_allowed, function in NMSettingConnection +nm_setting_connection_permissions_user_allowed, function in NMSettingConnection
@@ -2445,11 +2244,11 @@
-nm_setting_connection_remove_permission, function in NMSettingConnection +nm_setting_connection_remove_permission, function in NMSettingConnection
-nm_setting_connection_remove_secondary, function in NMSettingConnection +nm_setting_connection_remove_secondary, function in NMSettingConnection
@@ -2481,15 +2280,15 @@
-nm_setting_diff, function in NMSetting +nm_setting_diff, function in NMSetting
-nm_setting_duplicate, function in NMSetting +nm_setting_duplicate, function in NMSetting
-nm_setting_enumerate_values, function in NMSetting +nm_setting_enumerate_values, function in NMSetting
@@ -2497,19 +2296,19 @@
-nm_setting_error_quark, function in NMSetting +nm_setting_error_quark, function in NMSetting
-nm_setting_get_name, function in NMSetting +nm_setting_get_name, function in NMSetting
-nm_setting_get_secret_flags, function in NMSetting +nm_setting_get_secret_flags, function in NMSetting
-nm_setting_get_virtual_iface_name, function in NMSetting +nm_setting_get_virtual_iface_name, function in NMSetting
@@ -2525,51 +2324,51 @@
-nm_setting_gsm_error_quark, function in NMSettingGsm +nm_setting_gsm_error_quark, function in NMSettingGsm
-nm_setting_gsm_get_allowed_bands, function in NMSettingGsm +nm_setting_gsm_get_allowed_bands, function in NMSettingGsm
-nm_setting_gsm_get_apn, function in NMSettingGsm +nm_setting_gsm_get_apn, function in NMSettingGsm
-nm_setting_gsm_get_home_only, function in NMSettingGsm +nm_setting_gsm_get_home_only, function in NMSettingGsm
-nm_setting_gsm_get_network_id, function in NMSettingGsm +nm_setting_gsm_get_network_id, function in NMSettingGsm
-nm_setting_gsm_get_network_type, function in NMSettingGsm +nm_setting_gsm_get_network_type, function in NMSettingGsm
-nm_setting_gsm_get_number, function in NMSettingGsm +nm_setting_gsm_get_number, function in NMSettingGsm
-nm_setting_gsm_get_password, function in NMSettingGsm +nm_setting_gsm_get_password, function in NMSettingGsm
-nm_setting_gsm_get_password_flags, function in NMSettingGsm +nm_setting_gsm_get_password_flags, function in NMSettingGsm
-nm_setting_gsm_get_pin, function in NMSettingGsm +nm_setting_gsm_get_pin, function in NMSettingGsm
-nm_setting_gsm_get_pin_flags, function in NMSettingGsm +nm_setting_gsm_get_pin_flags, function in NMSettingGsm
-nm_setting_gsm_get_username, function in NMSettingGsm +nm_setting_gsm_get_username, function in NMSettingGsm
@@ -2585,7 +2384,7 @@
-nm_setting_gsm_new, function in NMSettingGsm +nm_setting_gsm_new, function in NMSettingGsm
@@ -2621,19 +2420,19 @@
-nm_setting_infiniband_error_quark, function in NMSettingInfiniband +nm_setting_infiniband_error_quark, function in NMSettingInfiniband
-nm_setting_infiniband_get_mac_address, function in NMSettingInfiniband +nm_setting_infiniband_get_mac_address, function in NMSettingInfiniband
-nm_setting_infiniband_get_mtu, function in NMSettingInfiniband +nm_setting_infiniband_get_mtu, function in NMSettingInfiniband
-nm_setting_infiniband_get_transport_mode, function in NMSettingInfiniband +nm_setting_infiniband_get_transport_mode, function in NMSettingInfiniband
@@ -2645,7 +2444,7 @@
-nm_setting_infiniband_new, function in NMSettingInfiniband +nm_setting_infiniband_new, function in NMSettingInfiniband
@@ -2661,35 +2460,35 @@
-nm_setting_ip4_config_add_address, function in NMSettingIP4Config +nm_setting_ip4_config_add_address, function in NMSettingIP4Config
-nm_setting_ip4_config_add_dns, function in NMSettingIP4Config +nm_setting_ip4_config_add_dns, function in NMSettingIP4Config
-nm_setting_ip4_config_add_dns_search, function in NMSettingIP4Config +nm_setting_ip4_config_add_dns_search, function in NMSettingIP4Config
-nm_setting_ip4_config_add_route, function in NMSettingIP4Config +nm_setting_ip4_config_add_route, function in NMSettingIP4Config
-nm_setting_ip4_config_clear_addresses, function in NMSettingIP4Config +nm_setting_ip4_config_clear_addresses, function in NMSettingIP4Config
-nm_setting_ip4_config_clear_dns, function in NMSettingIP4Config +nm_setting_ip4_config_clear_dns, function in NMSettingIP4Config
-nm_setting_ip4_config_clear_dns_searches, function in NMSettingIP4Config +nm_setting_ip4_config_clear_dns_searches, function in NMSettingIP4Config
-nm_setting_ip4_config_clear_routes, function in NMSettingIP4Config +nm_setting_ip4_config_clear_routes, function in NMSettingIP4Config
@@ -2717,71 +2516,71 @@
-nm_setting_ip4_config_error_quark, function in NMSettingIP4Config +nm_setting_ip4_config_error_quark, function in NMSettingIP4Config
-nm_setting_ip4_config_get_address, function in NMSettingIP4Config +nm_setting_ip4_config_get_address, function in NMSettingIP4Config
-nm_setting_ip4_config_get_dhcp_client_id, function in NMSettingIP4Config +nm_setting_ip4_config_get_dhcp_client_id, function in NMSettingIP4Config
-nm_setting_ip4_config_get_dhcp_hostname, function in NMSettingIP4Config +nm_setting_ip4_config_get_dhcp_hostname, function in NMSettingIP4Config
-nm_setting_ip4_config_get_dhcp_send_hostname, function in NMSettingIP4Config +nm_setting_ip4_config_get_dhcp_send_hostname, function in NMSettingIP4Config
-nm_setting_ip4_config_get_dns, function in NMSettingIP4Config +nm_setting_ip4_config_get_dns, function in NMSettingIP4Config
-nm_setting_ip4_config_get_dns_search, function in NMSettingIP4Config +nm_setting_ip4_config_get_dns_search, function in NMSettingIP4Config
-nm_setting_ip4_config_get_ignore_auto_dns, function in NMSettingIP4Config +nm_setting_ip4_config_get_ignore_auto_dns, function in NMSettingIP4Config
-nm_setting_ip4_config_get_ignore_auto_routes, function in NMSettingIP4Config +nm_setting_ip4_config_get_ignore_auto_routes, function in NMSettingIP4Config
-nm_setting_ip4_config_get_may_fail, function in NMSettingIP4Config +nm_setting_ip4_config_get_may_fail, function in NMSettingIP4Config
-nm_setting_ip4_config_get_method, function in NMSettingIP4Config +nm_setting_ip4_config_get_method, function in NMSettingIP4Config
-nm_setting_ip4_config_get_never_default, function in NMSettingIP4Config +nm_setting_ip4_config_get_never_default, function in NMSettingIP4Config
-nm_setting_ip4_config_get_num_addresses, function in NMSettingIP4Config +nm_setting_ip4_config_get_num_addresses, function in NMSettingIP4Config
-nm_setting_ip4_config_get_num_dns, function in NMSettingIP4Config +nm_setting_ip4_config_get_num_dns, function in NMSettingIP4Config
-nm_setting_ip4_config_get_num_dns_searches, function in NMSettingIP4Config +nm_setting_ip4_config_get_num_dns_searches, function in NMSettingIP4Config
-nm_setting_ip4_config_get_num_routes, function in NMSettingIP4Config +nm_setting_ip4_config_get_num_routes, function in NMSettingIP4Config
-nm_setting_ip4_config_get_route, function in NMSettingIP4Config +nm_setting_ip4_config_get_route, function in NMSettingIP4Config
@@ -2825,23 +2624,23 @@
-nm_setting_ip4_config_new, function in NMSettingIP4Config +nm_setting_ip4_config_new, function in NMSettingIP4Config
-nm_setting_ip4_config_remove_address, function in NMSettingIP4Config +nm_setting_ip4_config_remove_address, function in NMSettingIP4Config
-nm_setting_ip4_config_remove_dns, function in NMSettingIP4Config +nm_setting_ip4_config_remove_dns, function in NMSettingIP4Config
-nm_setting_ip4_config_remove_dns_search, function in NMSettingIP4Config +nm_setting_ip4_config_remove_dns_search, function in NMSettingIP4Config
-nm_setting_ip4_config_remove_route, function in NMSettingIP4Config +nm_setting_ip4_config_remove_route, function in NMSettingIP4Config
@@ -2857,35 +2656,35 @@
-nm_setting_ip6_config_add_address, function in NMSettingIP6Config +nm_setting_ip6_config_add_address, function in NMSettingIP6Config
-nm_setting_ip6_config_add_dns, function in NMSettingIP6Config +nm_setting_ip6_config_add_dns, function in NMSettingIP6Config
-nm_setting_ip6_config_add_dns_search, function in NMSettingIP6Config +nm_setting_ip6_config_add_dns_search, function in NMSettingIP6Config
-nm_setting_ip6_config_add_route, function in NMSettingIP6Config +nm_setting_ip6_config_add_route, function in NMSettingIP6Config
-nm_setting_ip6_config_clear_addresses, function in NMSettingIP6Config +nm_setting_ip6_config_clear_addresses, function in NMSettingIP6Config
-nm_setting_ip6_config_clear_dns, function in NMSettingIP6Config +nm_setting_ip6_config_clear_dns, function in NMSettingIP6Config
-nm_setting_ip6_config_clear_dns_searches, function in NMSettingIP6Config +nm_setting_ip6_config_clear_dns_searches, function in NMSettingIP6Config
-nm_setting_ip6_config_clear_routes, function in NMSettingIP6Config +nm_setting_ip6_config_clear_routes, function in NMSettingIP6Config
@@ -2905,67 +2704,67 @@
-nm_setting_ip6_config_error_quark, function in NMSettingIP6Config +nm_setting_ip6_config_error_quark, function in NMSettingIP6Config
-nm_setting_ip6_config_get_address, function in NMSettingIP6Config +nm_setting_ip6_config_get_address, function in NMSettingIP6Config
-nm_setting_ip6_config_get_dhcp_hostname, function in NMSettingIP6Config +nm_setting_ip6_config_get_dhcp_hostname, function in NMSettingIP6Config
-nm_setting_ip6_config_get_dns, function in NMSettingIP6Config +nm_setting_ip6_config_get_dns, function in NMSettingIP6Config
-nm_setting_ip6_config_get_dns_search, function in NMSettingIP6Config +nm_setting_ip6_config_get_dns_search, function in NMSettingIP6Config
-nm_setting_ip6_config_get_ignore_auto_dns, function in NMSettingIP6Config +nm_setting_ip6_config_get_ignore_auto_dns, function in NMSettingIP6Config
-nm_setting_ip6_config_get_ignore_auto_routes, function in NMSettingIP6Config +nm_setting_ip6_config_get_ignore_auto_routes, function in NMSettingIP6Config
-nm_setting_ip6_config_get_ip6_privacy, function in NMSettingIP6Config +nm_setting_ip6_config_get_ip6_privacy, function in NMSettingIP6Config
-nm_setting_ip6_config_get_may_fail, function in NMSettingIP6Config +nm_setting_ip6_config_get_may_fail, function in NMSettingIP6Config
-nm_setting_ip6_config_get_method, function in NMSettingIP6Config +nm_setting_ip6_config_get_method, function in NMSettingIP6Config
-nm_setting_ip6_config_get_never_default, function in NMSettingIP6Config +nm_setting_ip6_config_get_never_default, function in NMSettingIP6Config
-nm_setting_ip6_config_get_num_addresses, function in NMSettingIP6Config +nm_setting_ip6_config_get_num_addresses, function in NMSettingIP6Config
-nm_setting_ip6_config_get_num_dns, function in NMSettingIP6Config +nm_setting_ip6_config_get_num_dns, function in NMSettingIP6Config
-nm_setting_ip6_config_get_num_dns_searches, function in NMSettingIP6Config +nm_setting_ip6_config_get_num_dns_searches, function in NMSettingIP6Config
-nm_setting_ip6_config_get_num_routes, function in NMSettingIP6Config +nm_setting_ip6_config_get_num_routes, function in NMSettingIP6Config
-nm_setting_ip6_config_get_route, function in NMSettingIP6Config +nm_setting_ip6_config_get_route, function in NMSettingIP6Config
@@ -3017,23 +2816,23 @@
-nm_setting_ip6_config_new, function in NMSettingIP6Config +nm_setting_ip6_config_new, function in NMSettingIP6Config
-nm_setting_ip6_config_remove_address, function in NMSettingIP6Config +nm_setting_ip6_config_remove_address, function in NMSettingIP6Config
-nm_setting_ip6_config_remove_dns, function in NMSettingIP6Config +nm_setting_ip6_config_remove_dns, function in NMSettingIP6Config
-nm_setting_ip6_config_remove_dns_search, function in NMSettingIP6Config +nm_setting_ip6_config_remove_dns_search, function in NMSettingIP6Config
-nm_setting_ip6_config_remove_route, function in NMSettingIP6Config +nm_setting_ip6_config_remove_route, function in NMSettingIP6Config
@@ -3049,11 +2848,11 @@
-nm_setting_need_secrets, function in NMSetting +nm_setting_need_secrets, function in NMSetting
-nm_setting_new_from_hash, function in NMSetting +nm_setting_new_from_hash, function in NMSetting
@@ -3069,23 +2868,23 @@
-nm_setting_olpc_mesh_error_quark, function in NMSettingOlpcMesh +nm_setting_olpc_mesh_error_quark, function in NMSettingOlpcMesh
-nm_setting_olpc_mesh_get_channel, function in NMSettingOlpcMesh +nm_setting_olpc_mesh_get_channel, function in NMSettingOlpcMesh
-nm_setting_olpc_mesh_get_dhcp_anycast_address, function in NMSettingOlpcMesh +nm_setting_olpc_mesh_get_dhcp_anycast_address, function in NMSettingOlpcMesh
-nm_setting_olpc_mesh_get_ssid, function in NMSettingOlpcMesh +nm_setting_olpc_mesh_get_ssid, function in NMSettingOlpcMesh
-nm_setting_olpc_mesh_new, function in NMSettingOlpcMesh +nm_setting_olpc_mesh_new, function in NMSettingOlpcMesh
@@ -3117,27 +2916,27 @@
-nm_setting_pppoe_error_quark, function in NMSettingPPPOE +nm_setting_pppoe_error_quark, function in NMSettingPPPOE
-nm_setting_pppoe_get_password, function in NMSettingPPPOE +nm_setting_pppoe_get_password, function in NMSettingPPPOE
-nm_setting_pppoe_get_password_flags, function in NMSettingPPPOE +nm_setting_pppoe_get_password_flags, function in NMSettingPPPOE
-nm_setting_pppoe_get_service, function in NMSettingPPPOE +nm_setting_pppoe_get_service, function in NMSettingPPPOE
-nm_setting_pppoe_get_username, function in NMSettingPPPOE +nm_setting_pppoe_get_username, function in NMSettingPPPOE
-nm_setting_pppoe_new, function in NMSettingPPPOE +nm_setting_pppoe_new, function in NMSettingPPPOE
@@ -3173,79 +2972,79 @@
-nm_setting_ppp_error_quark, function in NMSettingPPP +nm_setting_ppp_error_quark, function in NMSettingPPP
-nm_setting_ppp_get_baud, function in NMSettingPPP +nm_setting_ppp_get_baud, function in NMSettingPPP
-nm_setting_ppp_get_crtscts, function in NMSettingPPP +nm_setting_ppp_get_crtscts, function in NMSettingPPP
-nm_setting_ppp_get_lcp_echo_failure, function in NMSettingPPP +nm_setting_ppp_get_lcp_echo_failure, function in NMSettingPPP
-nm_setting_ppp_get_lcp_echo_interval, function in NMSettingPPP +nm_setting_ppp_get_lcp_echo_interval, function in NMSettingPPP
-nm_setting_ppp_get_mppe_stateful, function in NMSettingPPP +nm_setting_ppp_get_mppe_stateful, function in NMSettingPPP
-nm_setting_ppp_get_mru, function in NMSettingPPP +nm_setting_ppp_get_mru, function in NMSettingPPP
-nm_setting_ppp_get_mtu, function in NMSettingPPP +nm_setting_ppp_get_mtu, function in NMSettingPPP
-nm_setting_ppp_get_noauth, function in NMSettingPPP +nm_setting_ppp_get_noauth, function in NMSettingPPP
-nm_setting_ppp_get_nobsdcomp, function in NMSettingPPP +nm_setting_ppp_get_nobsdcomp, function in NMSettingPPP
-nm_setting_ppp_get_nodeflate, function in NMSettingPPP +nm_setting_ppp_get_nodeflate, function in NMSettingPPP
-nm_setting_ppp_get_no_vj_comp, function in NMSettingPPP +nm_setting_ppp_get_no_vj_comp, function in NMSettingPPP
-nm_setting_ppp_get_refuse_chap, function in NMSettingPPP +nm_setting_ppp_get_refuse_chap, function in NMSettingPPP
-nm_setting_ppp_get_refuse_eap, function in NMSettingPPP +nm_setting_ppp_get_refuse_eap, function in NMSettingPPP
-nm_setting_ppp_get_refuse_mschap, function in NMSettingPPP +nm_setting_ppp_get_refuse_mschap, function in NMSettingPPP
-nm_setting_ppp_get_refuse_mschapv2, function in NMSettingPPP +nm_setting_ppp_get_refuse_mschapv2, function in NMSettingPPP
-nm_setting_ppp_get_refuse_pap, function in NMSettingPPP +nm_setting_ppp_get_refuse_pap, function in NMSettingPPP
-nm_setting_ppp_get_require_mppe, function in NMSettingPPP +nm_setting_ppp_get_require_mppe, function in NMSettingPPP
-nm_setting_ppp_get_require_mppe_128, function in NMSettingPPP +nm_setting_ppp_get_require_mppe_128, function in NMSettingPPP
@@ -3269,7 +3068,7 @@
-nm_setting_ppp_new, function in NMSettingPPP +nm_setting_ppp_new, function in NMSettingPPP
@@ -3341,31 +3140,31 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_serial_error_quark, function in NMSettingSerial +nm_setting_serial_error_quark, function in NMSettingSerial
-nm_setting_serial_get_baud, function in NMSettingSerial +nm_setting_serial_get_baud, function in NMSettingSerial
-nm_setting_serial_get_bits, function in NMSettingSerial +nm_setting_serial_get_bits, function in NMSettingSerial
-nm_setting_serial_get_parity, function in NMSettingSerial +nm_setting_serial_get_parity, function in NMSettingSerial
-nm_setting_serial_get_send_delay, function in NMSettingSerial +nm_setting_serial_get_send_delay, function in NMSettingSerial
-nm_setting_serial_get_stopbits, function in NMSettingSerial +nm_setting_serial_get_stopbits, function in NMSettingSerial
-nm_setting_serial_new, function in NMSettingSerial +nm_setting_serial_new, function in NMSettingSerial
@@ -3385,35 +3184,35 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_set_secret_flags, function in NMSetting +nm_setting_set_secret_flags, function in NMSetting
-nm_setting_to_hash, function in NMSetting +nm_setting_to_hash, function in NMSetting
-nm_setting_to_string, function in NMSetting +nm_setting_to_string, function in NMSetting
-nm_setting_update_secrets, function in NMSetting +nm_setting_update_secrets, function in NMSetting
-nm_setting_verify, function in NMSetting +nm_setting_verify, function in NMSetting
-nm_setting_vlan_add_priority, function in NMSettingVlan +nm_setting_vlan_add_priority, function in NMSettingVlan
-nm_setting_vlan_add_priority_str, function in NMSettingVlan +nm_setting_vlan_add_priority_str, function in NMSettingVlan
-nm_setting_vlan_clear_priorities, function in NMSettingVlan +nm_setting_vlan_clear_priorities, function in NMSettingVlan
@@ -3425,7 +3224,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_vlan_error_quark, function in NMSettingVlan +nm_setting_vlan_error_quark, function in NMSettingVlan
@@ -3433,27 +3232,27 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_vlan_get_flags, function in NMSettingVlan +nm_setting_vlan_get_flags, function in NMSettingVlan
-nm_setting_vlan_get_id, function in NMSettingVlan +nm_setting_vlan_get_id, function in NMSettingVlan
-nm_setting_vlan_get_interface_name, function in NMSettingVlan +nm_setting_vlan_get_interface_name, function in NMSettingVlan
-nm_setting_vlan_get_num_priorities, function in NMSettingVlan +nm_setting_vlan_get_num_priorities, function in NMSettingVlan
-nm_setting_vlan_get_parent, function in NMSettingVlan +nm_setting_vlan_get_parent, function in NMSettingVlan
-nm_setting_vlan_get_priority, function in NMSettingVlan +nm_setting_vlan_get_priority, function in NMSettingVlan
@@ -3469,7 +3268,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_vlan_new, function in NMSettingVlan +nm_setting_vlan_new, function in NMSettingVlan
@@ -3477,7 +3276,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_vlan_remove_priority, function in NMSettingVlan +nm_setting_vlan_remove_priority, function in NMSettingVlan
@@ -3485,11 +3284,11 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_vpn_add_data_item, function in NMSettingVPN +nm_setting_vpn_add_data_item, function in NMSettingVPN
-nm_setting_vpn_add_secret, function in NMSettingVPN +nm_setting_vpn_add_secret, function in NMSettingVPN
@@ -3501,51 +3300,51 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_vpn_error_quark, function in NMSettingVPN +nm_setting_vpn_error_quark, function in NMSettingVPN
-nm_setting_vpn_foreach_data_item, function in NMSettingVPN +nm_setting_vpn_foreach_data_item, function in NMSettingVPN
-nm_setting_vpn_foreach_secret, function in NMSettingVPN +nm_setting_vpn_foreach_secret, function in NMSettingVPN
-nm_setting_vpn_get_data_item, function in NMSettingVPN +nm_setting_vpn_get_data_item, function in NMSettingVPN
-nm_setting_vpn_get_num_data_items, function in NMSettingVPN +nm_setting_vpn_get_num_data_items, function in NMSettingVPN
-nm_setting_vpn_get_num_secrets, function in NMSettingVPN +nm_setting_vpn_get_num_secrets, function in NMSettingVPN
-nm_setting_vpn_get_secret, function in NMSettingVPN +nm_setting_vpn_get_secret, function in NMSettingVPN
-nm_setting_vpn_get_service_type, function in NMSettingVPN +nm_setting_vpn_get_service_type, function in NMSettingVPN
-nm_setting_vpn_get_user_name, function in NMSettingVPN +nm_setting_vpn_get_user_name, function in NMSettingVPN
-nm_setting_vpn_new, function in NMSettingVPN +nm_setting_vpn_new, function in NMSettingVPN
-nm_setting_vpn_remove_data_item, function in NMSettingVPN +nm_setting_vpn_remove_data_item, function in NMSettingVPN
-nm_setting_vpn_remove_secret, function in NMSettingVPN +nm_setting_vpn_remove_secret, function in NMSettingVPN
@@ -3569,15 +3368,15 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wimax_error_quark, function in NMSettingWimax +nm_setting_wimax_error_quark, function in NMSettingWimax
-nm_setting_wimax_get_mac_address, function in NMSettingWimax +nm_setting_wimax_get_mac_address, function in NMSettingWimax
-nm_setting_wimax_get_network_name, function in NMSettingWimax +nm_setting_wimax_get_network_name, function in NMSettingWimax
@@ -3589,7 +3388,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wimax_new, function in NMSettingWimax +nm_setting_wimax_new, function in NMSettingWimax
@@ -3597,7 +3396,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wired_add_s390_option, function in NMSettingWired +nm_setting_wired_add_s390_option, function in NMSettingWired
@@ -3617,59 +3416,59 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wired_error_quark, function in NMSettingWired +nm_setting_wired_error_quark, function in NMSettingWired
-nm_setting_wired_get_auto_negotiate, function in NMSettingWired +nm_setting_wired_get_auto_negotiate, function in NMSettingWired
-nm_setting_wired_get_cloned_mac_address, function in NMSettingWired +nm_setting_wired_get_cloned_mac_address, function in NMSettingWired
-nm_setting_wired_get_duplex, function in NMSettingWired +nm_setting_wired_get_duplex, function in NMSettingWired
-nm_setting_wired_get_mac_address, function in NMSettingWired +nm_setting_wired_get_mac_address, function in NMSettingWired
-nm_setting_wired_get_mac_address_blacklist, function in NMSettingWired +nm_setting_wired_get_mac_address_blacklist, function in NMSettingWired
-nm_setting_wired_get_mtu, function in NMSettingWired +nm_setting_wired_get_mtu, function in NMSettingWired
-nm_setting_wired_get_num_s390_options, function in NMSettingWired +nm_setting_wired_get_num_s390_options, function in NMSettingWired
-nm_setting_wired_get_port, function in NMSettingWired +nm_setting_wired_get_port, function in NMSettingWired
-nm_setting_wired_get_s390_nettype, function in NMSettingWired +nm_setting_wired_get_s390_nettype, function in NMSettingWired
-nm_setting_wired_get_s390_option, function in NMSettingWired +nm_setting_wired_get_s390_option, function in NMSettingWired
-nm_setting_wired_get_s390_option_by_key, function in NMSettingWired +nm_setting_wired_get_s390_option_by_key, function in NMSettingWired
-nm_setting_wired_get_s390_subchannels, function in NMSettingWired +nm_setting_wired_get_s390_subchannels, function in NMSettingWired
-nm_setting_wired_get_speed, function in NMSettingWired +nm_setting_wired_get_speed, function in NMSettingWired
@@ -3685,7 +3484,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wired_new, function in NMSettingWired +nm_setting_wired_new, function in NMSettingWired
@@ -3693,7 +3492,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wired_remove_s390_option, function in NMSettingWired +nm_setting_wired_remove_s390_option, function in NMSettingWired
@@ -3717,11 +3516,11 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_add_seen_bssid, function in NMSettingWireless +nm_setting_wireless_add_seen_bssid, function in NMSettingWireless
-nm_setting_wireless_ap_security_compatible, function in NMSettingWireless +nm_setting_wireless_ap_security_compatible, function in NMSettingWireless
@@ -3745,67 +3544,67 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_error_quark, function in NMSettingWireless +nm_setting_wireless_error_quark, function in NMSettingWireless
-nm_setting_wireless_get_band, function in NMSettingWireless +nm_setting_wireless_get_band, function in NMSettingWireless
-nm_setting_wireless_get_bssid, function in NMSettingWireless +nm_setting_wireless_get_bssid, function in NMSettingWireless
-nm_setting_wireless_get_channel, function in NMSettingWireless +nm_setting_wireless_get_channel, function in NMSettingWireless
-nm_setting_wireless_get_cloned_mac_address, function in NMSettingWireless +nm_setting_wireless_get_cloned_mac_address, function in NMSettingWireless
-nm_setting_wireless_get_hidden, function in NMSettingWireless +nm_setting_wireless_get_hidden, function in NMSettingWireless
-nm_setting_wireless_get_mac_address, function in NMSettingWireless +nm_setting_wireless_get_mac_address, function in NMSettingWireless
-nm_setting_wireless_get_mac_address_blacklist, function in NMSettingWireless +nm_setting_wireless_get_mac_address_blacklist, function in NMSettingWireless
-nm_setting_wireless_get_mode, function in NMSettingWireless +nm_setting_wireless_get_mode, function in NMSettingWireless
-nm_setting_wireless_get_mtu, function in NMSettingWireless +nm_setting_wireless_get_mtu, function in NMSettingWireless
-nm_setting_wireless_get_num_seen_bssids, function in NMSettingWireless +nm_setting_wireless_get_num_seen_bssids, function in NMSettingWireless
-nm_setting_wireless_get_rate, function in NMSettingWireless +nm_setting_wireless_get_rate, function in NMSettingWireless
-nm_setting_wireless_get_security, function in NMSettingWireless +nm_setting_wireless_get_security, function in NMSettingWireless
-nm_setting_wireless_get_seen_bssid, function in NMSettingWireless +nm_setting_wireless_get_seen_bssid, function in NMSettingWireless
-nm_setting_wireless_get_ssid, function in NMSettingWireless +nm_setting_wireless_get_ssid, function in NMSettingWireless
-nm_setting_wireless_get_tx_power, function in NMSettingWireless +nm_setting_wireless_get_tx_power, function in NMSettingWireless
@@ -3841,7 +3640,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_new, function in NMSettingWireless +nm_setting_wireless_new, function in NMSettingWireless
@@ -3853,15 +3652,15 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_security_add_group, function in NMSettingWirelessSecurity +nm_setting_wireless_security_add_group, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_add_pairwise, function in NMSettingWirelessSecurity +nm_setting_wireless_security_add_pairwise, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_add_proto, function in NMSettingWirelessSecurity +nm_setting_wireless_security_add_proto, function in NMSettingWirelessSecurity
@@ -3869,15 +3668,15 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_security_clear_groups, function in NMSettingWirelessSecurity +nm_setting_wireless_security_clear_groups, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_clear_pairwise, function in NMSettingWirelessSecurity +nm_setting_wireless_security_clear_pairwise, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_clear_protos, function in NMSettingWirelessSecurity +nm_setting_wireless_security_clear_protos, function in NMSettingWirelessSecurity
@@ -3885,75 +3684,75 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_security_error_quark, function in NMSettingWirelessSecurity +nm_setting_wireless_security_error_quark, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_auth_alg, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_auth_alg, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_group, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_group, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_key_mgmt, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_key_mgmt, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_leap_password, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_leap_password, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_leap_password_flags, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_leap_password_flags, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_leap_username, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_leap_username, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_num_groups, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_num_groups, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_num_pairwise, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_num_pairwise, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_num_protos, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_num_protos, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_pairwise, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_pairwise, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_proto, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_proto, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_psk, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_psk, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_psk_flags, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_psk_flags, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_wep_key, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_wep_key, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_wep_key_flags, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_wep_key_flags, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_wep_key_type, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_wep_key_type, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_get_wep_tx_keyidx, function in NMSettingWirelessSecurity +nm_setting_wireless_security_get_wep_tx_keyidx, function in NMSettingWirelessSecurity
@@ -3977,7 +3776,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_security_new, function in NMSettingWirelessSecurity +nm_setting_wireless_security_new, function in NMSettingWirelessSecurity
@@ -3997,15 +3796,15 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_security_remove_group, function in NMSettingWirelessSecurity +nm_setting_wireless_security_remove_group, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_remove_pairwise, function in NMSettingWirelessSecurity +nm_setting_wireless_security_remove_pairwise, function in NMSettingWirelessSecurity
-nm_setting_wireless_security_remove_proto, function in NMSettingWirelessSecurity +nm_setting_wireless_security_remove_proto, function in NMSettingWirelessSecurity
@@ -4013,7 +3812,7 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_setting_wireless_security_set_wep_key, function in NMSettingWirelessSecurity +nm_setting_wireless_security_set_wep_key, function in NMSettingWirelessSecurity
@@ -4062,39 +3861,39 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private

U

-NMUtilsSecurityType, enum in nm-utils +NMUtilsSecurityType, enum in nm-utils
-nm_utils_ap_mode_security_valid, function in nm-utils +nm_utils_ap_mode_security_valid, function in nm-utils
-nm_utils_deinit, function in nm-utils +nm_utils_deinit, function in nm-utils
-nm_utils_escape_ssid, function in nm-utils +nm_utils_escape_ssid, function in nm-utils
-nm_utils_file_is_pkcs12, function in nm-utils +nm_utils_file_is_pkcs12, function in nm-utils
-nm_utils_gvalue_hash_dup, function in nm-utils +nm_utils_gvalue_hash_dup, function in nm-utils
-nm_utils_hwaddr_atoba, function in nm-utils +nm_utils_hwaddr_atoba, function in nm-utils
-nm_utils_hwaddr_aton, function in nm-utils +nm_utils_hwaddr_aton, function in nm-utils
-nm_utils_hwaddr_len, function in nm-utils +nm_utils_hwaddr_len, function in nm-utils
@@ -4102,154 +3901,154 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-nm_utils_hwaddr_ntoa, function in nm-utils +nm_utils_hwaddr_ntoa, function in nm-utils
-nm_utils_hwaddr_type, function in nm-utils +nm_utils_hwaddr_type, function in nm-utils
-nm_utils_iface_valid_name, function in nm-utils +nm_utils_iface_valid_name, function in nm-utils
-nm_utils_init, function in nm-utils +nm_utils_init, function in nm-utils
-nm_utils_ip4_addresses_from_gvalue, function in nm-utils +nm_utils_ip4_addresses_from_gvalue, function in nm-utils
-nm_utils_ip4_addresses_to_gvalue, function in nm-utils +nm_utils_ip4_addresses_to_gvalue, function in nm-utils
-nm_utils_ip4_get_default_prefix, function in nm-utils +nm_utils_ip4_get_default_prefix, function in nm-utils
-nm_utils_ip4_netmask_to_prefix, function in nm-utils +nm_utils_ip4_netmask_to_prefix, function in nm-utils
-nm_utils_ip4_prefix_to_netmask, function in nm-utils +nm_utils_ip4_prefix_to_netmask, function in nm-utils
-nm_utils_ip4_routes_from_gvalue, function in nm-utils +nm_utils_ip4_routes_from_gvalue, function in nm-utils
-nm_utils_ip4_routes_to_gvalue, function in nm-utils +nm_utils_ip4_routes_to_gvalue, function in nm-utils
-nm_utils_ip6_addresses_from_gvalue, function in nm-utils +nm_utils_ip6_addresses_from_gvalue, function in nm-utils
-nm_utils_ip6_addresses_to_gvalue, function in nm-utils +nm_utils_ip6_addresses_to_gvalue, function in nm-utils
-nm_utils_ip6_dns_from_gvalue, function in nm-utils +nm_utils_ip6_dns_from_gvalue, function in nm-utils
-nm_utils_ip6_dns_to_gvalue, function in nm-utils +nm_utils_ip6_dns_to_gvalue, function in nm-utils
-nm_utils_ip6_routes_from_gvalue, function in nm-utils +nm_utils_ip6_routes_from_gvalue, function in nm-utils
-nm_utils_ip6_routes_to_gvalue, function in nm-utils +nm_utils_ip6_routes_to_gvalue, function in nm-utils
-nm_utils_is_empty_ssid, function in nm-utils +nm_utils_is_empty_ssid, function in nm-utils
-nm_utils_is_uuid, function in nm-utils +nm_utils_is_uuid, function in nm-utils
-nm_utils_rsa_key_encrypt, function in nm-utils +nm_utils_rsa_key_encrypt, function in nm-utils
-nm_utils_same_ssid, function in nm-utils +nm_utils_same_ssid, function in nm-utils
-nm_utils_security_valid, function in nm-utils +nm_utils_security_valid, function in nm-utils
-nm_utils_slist_free, function in nm-utils +nm_utils_slist_free, function in nm-utils
-nm_utils_ssid_to_utf8, function in nm-utils +nm_utils_ssid_to_utf8, function in nm-utils
-nm_utils_uuid_generate, function in nm-utils +nm_utils_uuid_generate, function in nm-utils
-nm_utils_uuid_generate_from_string, function in nm-utils +nm_utils_uuid_generate_from_string, function in nm-utils
-nm_utils_wep_key_valid, function in nm-utils +nm_utils_wep_key_valid, function in nm-utils
-nm_utils_wifi_channel_to_freq, function in nm-utils +nm_utils_wifi_channel_to_freq, function in nm-utils
-nm_utils_wifi_find_next_channel, function in nm-utils +nm_utils_wifi_find_next_channel, function in nm-utils
-nm_utils_wifi_freq_to_channel, function in nm-utils +nm_utils_wifi_freq_to_channel, function in nm-utils
-nm_utils_wifi_is_channel_valid, function in nm-utils +nm_utils_wifi_is_channel_valid, function in nm-utils
-nm_utils_wpa_psk_valid, function in nm-utils +nm_utils_wpa_psk_valid, function in nm-utils

V

-NMVlanFlags, enum in NMSettingVlan +NMVlanFlags, enum in NMSettingVlan
-NMVlanPriorityMap, enum in NMSettingVlan +NMVlanPriorityMap, enum in NMSettingVlan
-NMVPNIterFunc, user_function in NMSettingVPN +NMVPNIterFunc, user_function in NMSettingVPN

W

-NMWepKeyType, enum in NMSettingWirelessSecurity +NMWepKeyType, enum in NMSettingWirelessSecurity
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/ch01.html b/docs/libnm-util/html/ch01.html index 5b79f668..6b733efe 100644 --- a/docs/libnm-util/html/ch01.html +++ b/docs/libnm-util/html/ch01.html @@ -2,22 +2,22 @@ -libnm-util API Reference +libnm-util Reference Manual: libnm-util API Reference - + - - - - - - + + + + + +

@@ -105,6 +105,6 @@ that require PPP to deliver IP capability

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/home.png b/docs/libnm-util/html/home.png index 17003611..9346b336 100644 Binary files a/docs/libnm-util/html/home.png and b/docs/libnm-util/html/home.png differ diff --git a/docs/libnm-util/html/index.html b/docs/libnm-util/html/index.html index a7e470a3..8eecb7c8 100644 --- a/docs/libnm-util/html/index.html +++ b/docs/libnm-util/html/index.html @@ -2,11 +2,11 @@ -libnm-util Reference Manual +libnm-util Reference Manual: libnm-util Reference Manual - + @@ -15,10 +15,10 @@

- for libnm-util 0.9.8.8 + for libnm-util 0.9.8.10 The latest version of this documentation can be found on-line at - http://projects.gnome.org/NetworkManager/developers/libnm-util/09/. + https://developer.gnome.org/libnm-util/0.9/.

Copyright © 2012 The NetworkManager Authors

@@ -135,6 +135,6 @@ that require PPP to deliver IP capability
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file diff --git a/docs/libnm-util/html/index.sgml b/docs/libnm-util/html/index.sgml index 203b6e1b..9fbc3d5c 100644 --- a/docs/libnm-util/html/index.sgml +++ b/docs/libnm-util/html/index.sgml @@ -1,22 +1,14 @@ - + - - - + + + + - - - - - - - + - - - @@ -66,64 +58,37 @@ + + + + + - - - - - - - + + + + - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - @@ -134,37 +99,26 @@ + + + + + + + + + - - - + + + + - - - - - - - - - + - - - - - - - - - - - - - @@ -185,6 +139,22 @@ + + + + + + + + + + + + + + + + @@ -198,32 +168,14 @@ - - - + + + + - - - - - - - + - - - - - - - - - - - - - @@ -240,6 +192,21 @@ + + + + + + + + + + + + + + + @@ -253,40 +220,14 @@ - - - + + + + - - - - - - - - - + - - - - - - - - - - - - - - - - - - - @@ -305,6 +246,27 @@ + + + + + + + + + + + + + + + + + + + + + @@ -321,48 +283,14 @@ - - - - + + + + - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - @@ -391,6 +319,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -410,60 +360,52 @@ - - - + + + + - + + + + + + - - - - - + - - - - - - - - - + + + + - - - - - - - - + - - - - - - - + + + + + + + + + @@ -471,90 +413,41 @@ - - - + + + + - - - - - - - - + - - - - - - + + + + + + + + - - - - - + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -567,6 +460,23 @@ + + + + + + + + + + + + + + + + + @@ -580,55 +490,35 @@ - - - + + + + - - - - - - - + - - - - + + + + + + - - - + + + + - - - - - - - - - + - - - - - - - - - - @@ -638,32 +528,30 @@ + + + + + + + + + + + + - - - + + + + - - - - - - - + - - - - - - - - - @@ -672,6 +560,17 @@ + + + + + + + + + + + @@ -681,91 +580,62 @@ - - - + + + + - - - - - - - + - - - - - + + + + + + + - - - + + + + - - - - - - - + - - - - - + + + + + + + - - - - - + + + + - - - - - - - - + - - - - - - - - - - - - - - - @@ -777,6 +647,18 @@ + + + + + + + + + + + + @@ -785,46 +667,49 @@ - - - + + + - - - - - - - + - - - - - + + + + + + + - - - + + + + - + + + + + + + + + + + - - - - + - @@ -835,18 +720,8 @@ - - - - - - - - - - - - + + @@ -856,64 +731,14 @@ - - - - - + + + + - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -979,6 +804,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1013,40 +876,16 @@ - - + + + - + - - - - - - - - + - - - - - - - - - - - - - - - - - - @@ -1058,7 +897,6 @@ - @@ -1072,8 +910,6 @@ - - @@ -1103,6 +939,27 @@ + + + + + + + + + + + + + + + + + + + + + @@ -1117,46 +974,16 @@ - - - + + + - + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - @@ -1168,7 +995,6 @@ - @@ -1182,8 +1008,6 @@ - - @@ -1212,6 +1036,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -1225,40 +1071,14 @@ - - - + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - @@ -1278,6 +1098,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -1298,56 +1140,41 @@ - - - + + + + - - - - - - - - + - - - - - - + + + + + + + + - - - + + + + - - - - - - - + - - - - - - @@ -1362,17 +1189,26 @@ + + + + + + + + - - + + + - + @@ -1381,16 +1217,6 @@ - - - - - - - - - - @@ -1416,7 +1242,6 @@ - @@ -1424,11 +1249,15 @@ - + + + - + + + - - + + diff --git a/docs/libnm-util/html/left-insensitive.png b/docs/libnm-util/html/left-insensitive.png new file mode 100644 index 00000000..3269393a Binary files /dev/null and b/docs/libnm-util/html/left-insensitive.png differ diff --git a/docs/libnm-util/html/left.png b/docs/libnm-util/html/left.png index 2d05b3d5..2abde032 100644 Binary files a/docs/libnm-util/html/left.png and b/docs/libnm-util/html/left.png differ diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index 91e04c2d..22e4362b 100644 --- a/docs/libnm-util/html/libnm-util-nm-utils.html +++ b/docs/libnm-util/html/libnm-util-nm-utils.html @@ -2,32 +2,27 @@ -nm-utils +libnm-util Reference Manual: nm-utils - + - - - - - - - - - - + + + + + + +
@@ -35,263 +30,552 @@

nm-utils

nm-utils — Utility functions

- +
-
-

Synopsis

-
-#include <nm-utils.h>
-
-gboolean            nm_utils_init                       (GError **error);
-void                nm_utils_deinit                     (void);
-gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
-                                                         int len);
-const char *        nm_utils_escape_ssid                (const guint8 *ssid,
-                                                         guint32 len);
-gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
-                                                         const GByteArray *ssid2,
-                                                         gboolean ignore_trailing_null);
-char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);
-GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);
-void                nm_utils_slist_free                 (GSList *list,
-                                                         GDestroyNotify elem_destroy_fn);
-enum                NMUtilsSecurityType;
-gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps,
-                                                         gboolean have_ap,
-                                                         gboolean adhoc,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn);
-gboolean            nm_utils_ap_mode_security_valid     (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps);
-gboolean            nm_utils_wep_key_valid              (const char *key,
-                                                         NMWepKeyType wep_type);
-gboolean            nm_utils_wpa_psk_valid              (const char *psk);
-GSList *            nm_utils_ip4_addresses_from_gvalue  (const GValue *value);
-void                nm_utils_ip4_addresses_to_gvalue    (GSList *list,
-                                                         GValue *value);
-GSList *            nm_utils_ip4_routes_from_gvalue     (const GValue *value);
-void                nm_utils_ip4_routes_to_gvalue       (GSList *list,
-                                                         GValue *value);
-guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);
-guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);
-guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);
-GSList *            nm_utils_ip6_addresses_from_gvalue  (const GValue *value);
-void                nm_utils_ip6_addresses_to_gvalue    (GSList *list,
-                                                         GValue *value);
-GSList *            nm_utils_ip6_routes_from_gvalue     (const GValue *value);
-void                nm_utils_ip6_routes_to_gvalue       (GSList *list,
-                                                         GValue *value);
-GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);
-void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
-                                                         GValue *value);
-char *              nm_utils_uuid_generate              (void);
-char *              nm_utils_uuid_generate_from_string  (const char *s);
-GByteArray *        nm_utils_rsa_key_encrypt            (const GByteArray *data,
-                                                         const char *in_password,
-                                                         char **out_password,
-                                                         GError **error);
-gboolean            nm_utils_file_is_pkcs12             (const char *filename);
-guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);
-guint32             nm_utils_wifi_channel_to_freq       (guint32 channel,
-                                                         const char *band);
-guint32             nm_utils_wifi_find_next_channel     (guint32 channel,
-                                                         int direction,
-                                                         char *band);
-gboolean            nm_utils_wifi_is_channel_valid      (guint32 channel,
-                                                         const char *band);
-#define             NM_UTILS_HWADDR_LEN_MAX
-int                 nm_utils_hwaddr_len                 (int type);
-int                 nm_utils_hwaddr_type                (int len);
-char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
-                                                         int type);
-GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
-                                                         int type);
-guint8 *            nm_utils_hwaddr_aton                (const char *asc,
-                                                         int type,
-                                                         gpointer buffer);
-gboolean            nm_utils_iface_valid_name           (const char *name);
-gboolean            nm_utils_is_uuid                    (const char *str);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +nm_utils_init () +
+void + +nm_utils_deinit () +
+gboolean + +nm_utils_is_empty_ssid () +
const char * + +nm_utils_escape_ssid () +
+gboolean + +nm_utils_same_ssid () +
+char * + +nm_utils_ssid_to_utf8 () +
+GHashTable * + +nm_utils_gvalue_hash_dup () +
+void + +nm_utils_slist_free () +
+gboolean + +nm_utils_security_valid () +
+gboolean + +nm_utils_ap_mode_security_valid () +
+gboolean + +nm_utils_wep_key_valid () +
+gboolean + +nm_utils_wpa_psk_valid () +
+GSList * + +nm_utils_ip4_addresses_from_gvalue () +
+void + +nm_utils_ip4_addresses_to_gvalue () +
+GSList * + +nm_utils_ip4_routes_from_gvalue () +
+void + +nm_utils_ip4_routes_to_gvalue () +
+guint32 + +nm_utils_ip4_netmask_to_prefix () +
+guint32 + +nm_utils_ip4_prefix_to_netmask () +
+guint32 + +nm_utils_ip4_get_default_prefix () +
+GSList * + +nm_utils_ip6_addresses_from_gvalue () +
+void + +nm_utils_ip6_addresses_to_gvalue () +
+GSList * + +nm_utils_ip6_routes_from_gvalue () +
+void + +nm_utils_ip6_routes_to_gvalue () +
+GSList * + +nm_utils_ip6_dns_from_gvalue () +
+void + +nm_utils_ip6_dns_to_gvalue () +
+char * + +nm_utils_uuid_generate () +
+char * + +nm_utils_uuid_generate_from_string () +
+GByteArray * + +nm_utils_rsa_key_encrypt () +
+gboolean + +nm_utils_file_is_pkcs12 () +
+guint32 + +nm_utils_wifi_freq_to_channel () +
+guint32 + +nm_utils_wifi_channel_to_freq () +
+guint32 + +nm_utils_wifi_find_next_channel () +
+gboolean + +nm_utils_wifi_is_channel_valid () +
+int + +nm_utils_hwaddr_len () +
+int + +nm_utils_hwaddr_type () +
+char * + +nm_utils_hwaddr_ntoa () +
+GByteArray * + +nm_utils_hwaddr_atoba () +
+guint8 * + +nm_utils_hwaddr_aton () +
+gboolean + +nm_utils_iface_valid_name () +
+gboolean + +nm_utils_is_uuid () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
enumNMUtilsSecurityType
#defineNM_UTILS_HWADDR_LEN_MAX

Object Hierarchy

-
-  GEnum
-   +----NMUtilsSecurityType
+
    GEnum
+    ╰── NMUtilsSecurityType
+

+
+
+

Includes

+
#include <nm-utils.h>

Description

-

-A collection of utility functions for working SSIDs, IP addresses, WiFi -access points and devices, among other things. -

+

A collection of utility functions for working SSIDs, IP addresses, WiFi +access points and devices, among other things.

-

Details

+

Functions

-

nm_utils_init ()

-
gboolean            nm_utils_init                       (GError **error);
-

-Initializes libnm-util; should be called when starting and program that +

nm_utils_init ()

+
gboolean
+nm_utils_init (GError **error);
+

Initializes libnm-util; should be called when starting and program that uses libnm-util. Sets up an atexit() handler to ensure de-initialization -is performed, but calling nm_utils_deinit() to explicitly deinitialize -libnm-util can also be done. This function can be called more than once. -

-
+is performed, but calling nm_utils_deinit() to explicitly deinitialize +libnm-util can also be done. This function can be called more than once.

+
+

Parameters

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

error :

location to store error, or NULL -

Returns :

TRUE if the initialization was successful, FALSE on failure.

error

location to store error, or NULL

 
+
+

Returns

+

TRUE if the initialization was successful, FALSE on failure.

+

+
+
-

nm_utils_deinit ()

-
void                nm_utils_deinit                     (void);
-

-Frees all resources used internally by libnm-util. This function is called -from an atexit() handler, set up by nm_utils_init(), but is safe to be called -more than once. Subsequent calls have no effect until nm_utils_init() is -called again. -

+

nm_utils_deinit ()

+
void
+nm_utils_deinit (void);
+

Frees all resources used internally by libnm-util. This function is called +from an atexit() handler, set up by nm_utils_init(), but is safe to be called +more than once. Subsequent calls have no effect until nm_utils_init() is +called again.

-

nm_utils_is_empty_ssid ()

-
gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
-                                                         int len);
-

-Different manufacturers use different mechanisms for not broadcasting the +

nm_utils_is_empty_ssid ()

+
gboolean
+nm_utils_is_empty_ssid (const guint8 *ssid,
+                        int len);
+

Different manufacturers use different mechanisms for not broadcasting the AP's SSID. This function attempts to detect blank/empty SSIDs using a -number of known SSID-cloaking methods. -

-
+number of known SSID-cloaking methods.

+
+

Parameters

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

ssid :

pointer to a buffer containing the SSID data

ssid

pointer to a buffer containing the SSID data

 

len :

length of the SSID data in ssid -

Returns :

TRUE if the SSID is "empty", FALSE if it is not

len

length of the SSID data in ssid +

 
+
+

Returns

+

TRUE if the SSID is "empty", FALSE if it is not

+

+
+
-

nm_utils_escape_ssid ()

-
const char *        nm_utils_escape_ssid                (const guint8 *ssid,
-                                                         guint32 len);
-

-This function does a quick printable character conversion of the SSID, simply +

nm_utils_escape_ssid ()

+
const char *
+nm_utils_escape_ssid (const guint8 *ssid,
+                      guint32 len);
+

This function does a quick printable character conversion of the SSID, simply replacing embedded NULLs and non-printable characters with the hexadecimal representation of that character. Intended for debugging only, should not -be used for display of SSIDs. -

-
+be used for display of SSIDs.

+
+

Parameters

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

ssid :

pointer to a buffer containing the SSID data

ssid

pointer to a buffer containing the SSID data

 

len :

length of the SSID data in ssid -

Returns :

pointer to the escaped SSID, which uses an internal static buffer -and will be overwritten by subsequent calls to this function

len

length of the SSID data in ssid +

 
+
+

Returns

+

pointer to the escaped SSID, which uses an internal static buffer +and will be overwritten by subsequent calls to this function

+

+
+
-

nm_utils_same_ssid ()

-
gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
-                                                         const GByteArray *ssid2,
-                                                         gboolean ignore_trailing_null);
-

-Earlier versions of the Linux kernel added a NULL byte to the end of the +

nm_utils_same_ssid ()

+
gboolean
+nm_utils_same_ssid (const GByteArray *ssid1,
+                    const GByteArray *ssid2,
+                    gboolean ignore_trailing_null);
+

Earlier versions of the Linux kernel added a NULL byte to the end of the SSID to enable easy printing of the SSID on the console or in a terminal, but this behavior was problematic (SSIDs are simply byte arrays, not strings) and thus was changed. This function compensates for that behavior at the cost of some compatibility with odd SSIDs that may legitimately have trailing -NULLs, even though that is functionally pointless. -

-
+NULLs, even though that is functionally pointless.

+
+

Parameters

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

ssid1 :

first SSID data to compare

ssid1

first SSID data to compare

 

ssid2 :

second SSID data to compare

ssid2

second SSID data to compare

 

ignore_trailing_null :

TRUE to ignore one trailing NULL byte

Returns :

TRUE if the SSIDs are the same, FALSE if they are not

ignore_trailing_null

TRUE to ignore one trailing NULL byte

 
+
+

Returns

+

TRUE if the SSIDs are the same, FALSE if they are not

+

+
+
-

nm_utils_ssid_to_utf8 ()

-
char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);
-

-WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may +

nm_utils_ssid_to_utf8 ()

+
char *
+nm_utils_ssid_to_utf8 (const GByteArray *ssid);
+

WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may contain embedded NULLs and other unprintable characters. Often it is useful to print the SSID out for debugging purposes, but that should be the _only_ use of this function. Do not use this function for any persistent storage of the SSID, since the printable SSID returned from this function -cannot be converted back into the real SSID of the access point. -

-

-This function does almost everything humanly possible to convert the input -into a printable UTF-8 string, using roughly the following procedure: -

-

-1) if the input data is already UTF-8 safe, no conversion is performed +cannot be converted back into the real SSID of the access point.

+

This function does almost everything humanly possible to convert the input +into a printable UTF-8 string, using roughly the following procedure:

+

1) if the input data is already UTF-8 safe, no conversion is performed 2) attempts to get the current system language from the LANG environment variable, and depending on the language, uses a table of alternative encodings to try. For example, if LANG=hu_HU, the table may first try @@ -299,1146 +583,1292 @@ into a printable UTF-8 string, using roughly the following procedure: If all fallback encodings fail, replaces non-UTF-8 characters with '?'. 3) If the system language was unable to be determined, falls back to the ISO-8859-1 encoding, then to the Windows-1251 encoding. -4) If step 3 fails, replaces non-UTF-8 characters with '?'. -

-

-Again, this function should be used for debugging and display purposes -_only_. -

-
+4) If step 3 fails, replaces non-UTF-8 characters with '?'.

+

Again, this function should be used for debugging and display purposes +_only_.

+
+

Parameters

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

ssid :

a byte array containing the SSID data

Returns :

an allocated string containing a UTF-8 -representation of the SSID, which must be freed by the caller using g_free(). -Returns NULL on errors. [transfer full] -

ssid

a byte array containing the SSID data

 
-
-
-

nm_utils_gvalue_hash_dup ()

-
GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);
-

-Utility function to duplicate a hash table of GValues. -

-
---- - - - - - - - - - - -

hash :

a GHashTable mapping string:GValue

Returns :

a newly allocated duplicated GHashTable, caller must free the -returned hash with g_hash_table_unref() or g_hash_table_destroy(). [transfer container][element-type utf8 GObject.Value] -
+
+

Returns

+

an allocated string containing a UTF-8 +representation of the SSID, which must be freed by the caller using g_free(). +Returns NULL on errors.

+

[transfer full]

+
-

nm_utils_slist_free ()

-
void                nm_utils_slist_free                 (GSList *list,
-                                                         GDestroyNotify elem_destroy_fn);
-

-Utility function to free a GSList. -

-
+

nm_utils_gvalue_hash_dup ()

+
GHashTable *
+nm_utils_gvalue_hash_dup (GHashTable *hash);
+

Utility function to duplicate a hash table of GValues.

+
+

Parameters

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

list :

a GSList -

elem_destroy_fn :

user function called for each element in list -

hash

a GHashTable mapping string:GValue

 
+
+

Returns

+

a newly allocated duplicated GHashTable, caller must free the +returned hash with g_hash_table_unref() or g_hash_table_destroy().

+

[transfer container][element-type utf8 GObject.Value]

+
+
-

enum NMUtilsSecurityType

-
typedef enum {
-	NMU_SEC_INVALID = 0,
-	NMU_SEC_NONE,
-	NMU_SEC_STATIC_WEP,
-	NMU_SEC_LEAP,
-	NMU_SEC_DYNAMIC_WEP,
-	NMU_SEC_WPA_PSK,
-	NMU_SEC_WPA_ENTERPRISE,
-	NMU_SEC_WPA2_PSK,
-	NMU_SEC_WPA2_ENTERPRISE
-} NMUtilsSecurityType;
-
-

-Describes generic security mechanisms that 802.11 access points may offer. -Used with nm_utils_security_valid() for checking whether a given access -point is compatible with a network device. -

-
+

nm_utils_slist_free ()

+
void
+nm_utils_slist_free (GSList *list,
+                     GDestroyNotify elem_destroy_fn);
+

Utility function to free a GSList.

+
+

Parameters

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

NMU_SEC_INVALID

unknown or invalid security, placeholder and not used -

NMU_SEC_NONE

unencrypted and open -

NMU_SEC_STATIC_WEP

static WEP keys are used for encryption -

NMU_SEC_LEAP

Cisco LEAP is used for authentication and for generating the -dynamic WEP keys automatically -

NMU_SEC_DYNAMIC_WEP

standard 802.1x is used for authentication and -generating the dynamic WEP keys automatically -

NMU_SEC_WPA_PSK

WPA1 is used with Pre-Shared Keys (PSK) -

list

a GSList

 

NMU_SEC_WPA_ENTERPRISE

WPA1 is used with 802.1x authentication -

NMU_SEC_WPA2_PSK

WPA2/RSN is used with Pre-Shared Keys (PSK) -

NMU_SEC_WPA2_ENTERPRISE

WPA2 is used with 802.1x authentication -

elem_destroy_fn

user function called for each element in list +

 
+
-

nm_utils_security_valid ()

-
gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps,
-                                                         gboolean have_ap,
-                                                         gboolean adhoc,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn);
-

-Given a set of device capabilities, and a desired security type to check +

nm_utils_security_valid ()

+
gboolean
+nm_utils_security_valid (NMUtilsSecurityType type,
+                         NMDeviceWifiCapabilities wifi_caps,
+                         gboolean have_ap,
+                         gboolean adhoc,
+                         NM80211ApFlags ap_flags,
+                         NM80211ApSecurityFlags ap_wpa,
+                         NM80211ApSecurityFlags ap_rsn);
+

Given a set of device capabilities, and a desired security type to check against, determines whether the combination of device, desired security -type, and AP capabilities intersect. -

-

-NOTE: this function cannot handle checking security for AP/Hotspot mode; -use nm_utils_ap_mode_security_valid() instead. -

-
+type, and AP capabilities intersect.

+

NOTE: this function cannot handle checking security for AP/Hotspot mode; +use nm_utils_ap_mode_security_valid() instead.

+
+

Parameters

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

type :

the security type to check AP flags and device capabilties against, -e.g. NMU_SEC_STATIC_WEP -

type

the security type to check AP flags and device capabilties against, +e.g. NMU_SEC_STATIC_WEP

 

wifi_caps :

bitfield of the capabilities of the specific WiFi device, e.g. -NM_WIFI_DEVICE_CAP_CIPHER_WEP40 -

have_ap :

whether the ap_flags, ap_wpa, and ap_rsn arguments are valid

wifi_caps

bitfield of the capabilities of the specific WiFi device, e.g. +NM_WIFI_DEVICE_CAP_CIPHER_WEP40

 

adhoc :

whether the capabilities being tested are from an Ad-Hoc AP (IBSS)

have_ap

whether the ap_flags +, ap_wpa +, and ap_rsn +arguments are valid

 

ap_flags :

bitfield of AP capabilities, e.g. NM_802_11_AP_FLAGS_PRIVACY -

adhoc

whether the capabilities being tested are from an Ad-Hoc AP (IBSS)

 

ap_wpa :

bitfield of AP capabilties derived from the AP's WPA beacon, -e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)

ap_flags

bitfield of AP capabilities, e.g. NM_802_11_AP_FLAGS_PRIVACY

 

ap_rsn :

bitfield of AP capabilties derived from the AP's RSN/WPA2 beacon, -e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)

ap_wpa

bitfield of AP capabilties derived from the AP's WPA beacon, +e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)

 

Returns :

TRUE if the device capabilities and AP capabilties intersect and are -compatible with the desired type, FALSE if they are not

ap_rsn

bitfield of AP capabilties derived from the AP's RSN/WPA2 beacon, +e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)

 
+
+

Returns

+

TRUE if the device capabilities and AP capabilties intersect and are +compatible with the desired type +, FALSE if they are not

+

+
+
-

nm_utils_ap_mode_security_valid ()

-
gboolean            nm_utils_ap_mode_security_valid     (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps);
-

-Given a set of device capabilities, and a desired security type to check +

nm_utils_ap_mode_security_valid ()

+
gboolean
+nm_utils_ap_mode_security_valid (NMUtilsSecurityType type,
+                                 NMDeviceWifiCapabilities wifi_caps);
+

Given a set of device capabilities, and a desired security type to check against, determines whether the combination of device capabilities and -desired security type are valid for AP/Hotspot connections. -

-
+desired security type are valid for AP/Hotspot connections.

+
+

Parameters

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

type :

the security type to check device capabilties against, -e.g. NMU_SEC_STATIC_WEP -

wifi_caps :

bitfield of the capabilities of the specific WiFi device, e.g. -NM_WIFI_DEVICE_CAP_CIPHER_WEP40 -

type

the security type to check device capabilties against, +e.g. NMU_SEC_STATIC_WEP

 

Returns :

TRUE if the device capabilities are compatible with the desired -type, FALSE if they are not.

wifi_caps

bitfield of the capabilities of the specific WiFi device, e.g. +NM_WIFI_DEVICE_CAP_CIPHER_WEP40

 
+
+
+

Returns

+

TRUE if the device capabilities are compatible with the desired +type +, FALSE if they are not.

+

+

Since 0.9.8

-

nm_utils_wep_key_valid ()

-
gboolean            nm_utils_wep_key_valid              (const char *key,
-                                                         NMWepKeyType wep_type);
-

-Checks if key is a valid WEP key -

-
+

nm_utils_wep_key_valid ()

+
gboolean
+nm_utils_wep_key_valid (const char *key,
+                        NMWepKeyType wep_type);
+

Checks if key + is a valid WEP key

+
+

Parameters

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

key :

a string that might be a WEP key

key

a string that might be a WEP key

 

wep_type :

the NMWepKeyType type of the WEP key

Returns :

 -TRUE if key is a WEP key, FALSE if not

wep_type

the NMWepKeyType type of the WEP key

 
+
+
+

Returns

+

TRUE if key +is a WEP key, FALSE if not

+

+

Since 0.9.8

-

nm_utils_wpa_psk_valid ()

-
gboolean            nm_utils_wpa_psk_valid              (const char *psk);
-

-Checks if psk is a valid WPA PSK -

-
+

nm_utils_wpa_psk_valid ()

+
gboolean
+nm_utils_wpa_psk_valid (const char *psk);
+

Checks if psk + is a valid WPA PSK

+
+

Parameters

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

psk :

a string that might be a WPA PSK

Returns :

 -TRUE if psk is a WPA PSK, FALSE if not

psk

a string that might be a WPA PSK

 
+
+
+

Returns

+

TRUE if psk +is a WPA PSK, FALSE if not

+

+

Since 0.9.8

-

nm_utils_ip4_addresses_from_gvalue ()

-
GSList *            nm_utils_ip4_addresses_from_gvalue  (const GValue *value);
-

-Utility function to convert a GPtrArray of GArrays of guint32s representing +

nm_utils_ip4_addresses_from_gvalue ()

+
GSList *
+nm_utils_ip4_addresses_from_gvalue (const GValue *value);
+

Utility function to convert a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, and prefix) into a GSList of NMIP4Address objects. The specific format of this serialization is not guaranteed to be stable and the GArray may be -extended in the future. -

-
+extended in the future.

+
+

Parameters

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

value :

gvalue containing a GPtrArray of GArrays of guint32s

Returns :

a newly allocated GSList of NMIP4Address objects. [transfer full][element-type NetworkManager.IP4Address] -

value

gvalue containing a GPtrArray of GArrays of guint32s

 
+
+

Returns

+

a newly allocated GSList of NMIP4Address objects.

+

[transfer full][element-type NetworkManager.IP4Address]

+
+
-

nm_utils_ip4_addresses_to_gvalue ()

-
void                nm_utils_ip4_addresses_to_gvalue    (GSList *list,
-                                                         GValue *value);
-

-Utility function to convert a GSList of NMIP4Address objects into a +

nm_utils_ip4_addresses_to_gvalue ()

+
void
+nm_utils_ip4_addresses_to_gvalue (GSList *list,
+                                  GValue *value);
+

Utility function to convert a GSList of NMIP4Address objects into a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, and prefix). The specific format of this serialization is not guaranteed to be stable and may be -extended in the future. -

-
+extended in the future.

+
+

Parameters

+
--+++ - - + + + - - + +g_value_unset().

+

list :

a list of NMIP4Address objects. [element-type NMIP4Address] -

list

a list of NMIP4Address objects.

[element-type NMIP4Address]

value :

a pointer to a GValue into which to place the converted addresses, +

value

a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset().

 
+
-

nm_utils_ip4_routes_from_gvalue ()

-
GSList *            nm_utils_ip4_routes_from_gvalue     (const GValue *value);
-

-Utility function to convert a GPtrArray of GArrays of guint32s representing +

nm_utils_ip4_routes_from_gvalue ()

+
GSList *
+nm_utils_ip4_routes_from_gvalue (const GValue *value);
+

Utility function to convert a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, prefix, and metric) into a GSList of NMIP4Route objects. The specific format of this serialization is not guaranteed to be stable and may be -extended in the future. -

-
+extended in the future.

+
+

Parameters

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

value :

gvalue containing a GPtrArray of GArrays of guint32s

Returns :

a newly allocated GSList of NMIP4Route objects. [transfer full][element-type NetworkManager.IP4Route] -

value

gvalue containing a GPtrArray of GArrays of guint32s

 
+
+

Returns

+

a newly allocated GSList of NMIP4Route objects.

+

[transfer full][element-type NetworkManager.IP4Route]

+
+
-

nm_utils_ip4_routes_to_gvalue ()

-
void                nm_utils_ip4_routes_to_gvalue       (GSList *list,
-                                                         GValue *value);
-

-Utility function to convert a GSList of NMIP4Route objects into a +

nm_utils_ip4_routes_to_gvalue ()

+
void
+nm_utils_ip4_routes_to_gvalue (GSList *list,
+                               GValue *value);
+

Utility function to convert a GSList of NMIP4Route objects into a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, prefix, and metric). The specific format of this serialization is not guaranteed to be stable and may -be extended in the future. -

-
+be extended in the future.

+
+

Parameters

+
--+++ - - + + + - - + +g_value_unset().

+

list :

a list of NMIP4Route objects. [element-type NMIP4Route] -

list

a list of NMIP4Route objects.

[element-type NMIP4Route]

value :

a pointer to a GValue into which to place the converted routes, +

value

a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset().

 
+
-

nm_utils_ip4_netmask_to_prefix ()

-
guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);
-
+

nm_utils_ip4_netmask_to_prefix ()

+
guint32
+nm_utils_ip4_netmask_to_prefix (guint32 netmask);
+
+

Parameters

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

netmask :

an IPv4 netmask in network byte order

Returns :

the CIDR prefix represented by the netmask

netmask

an IPv4 netmask in network byte order

 
+
+

Returns

+

the CIDR prefix represented by the netmask

+

+
+
-

nm_utils_ip4_prefix_to_netmask ()

-
guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);
-
+

nm_utils_ip4_prefix_to_netmask ()

+
guint32
+nm_utils_ip4_prefix_to_netmask (guint32 prefix);
+
+

Parameters

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

prefix :

a CIDR prefix

Returns :

the netmask represented by the prefix, in network byte order

prefix

a CIDR prefix

 
+
+

Returns

+

the netmask represented by the prefix, in network byte order

+

+
+
-

nm_utils_ip4_get_default_prefix ()

-
guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);
-

-When the Internet was originally set up, various ranges of IP addresses were +

nm_utils_ip4_get_default_prefix ()

+
guint32
+nm_utils_ip4_get_default_prefix (guint32 ip);
+

When the Internet was originally set up, various ranges of IP addresses were segmented into three network classes: A, B, and C. This function will return a prefix that is associated with the IP address specified defining where it -falls in the predefined classes. -

-
+falls in the predefined classes.

+
+

Parameters

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

ip :

an IPv4 address (in network byte order)

Returns :

the default class prefix for the given IP

ip

an IPv4 address (in network byte order)

 
+
+

Returns

+

the default class prefix for the given IP

+

+
+
-

nm_utils_ip6_addresses_from_gvalue ()

-
GSList *            nm_utils_ip6_addresses_from_gvalue  (const GValue *value);
-

-Utility function to convert a GPtrArray of GValueArrays of (GArray of guchars) and guint32 +

nm_utils_ip6_addresses_from_gvalue ()

+
GSList *
+nm_utils_ip6_addresses_from_gvalue (const GValue *value);
+

Utility function to convert a GPtrArray of GValueArrays of (GArray of guchars) and guint32 representing a list of NetworkManager IPv6 addresses (which is a tuple of address, prefix, and gateway), into a GSList of NMIP6Address objects. The specific format of this serialization is not guaranteed to be stable and the GValueArray may be -extended in the future. -

-
+extended in the future.

+
+

Parameters

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

value :

gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32

Returns :

a newly allocated GSList of NMIP6Address objects. [transfer full][element-type NetworkManager.IP6Address] -

value

gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32

 
+
+

Returns

+

a newly allocated GSList of NMIP6Address objects.

+

[transfer full][element-type NetworkManager.IP6Address]

+
+
-

nm_utils_ip6_addresses_to_gvalue ()

-
void                nm_utils_ip6_addresses_to_gvalue    (GSList *list,
-                                                         GValue *value);
-

-Utility function to convert a GSList of NMIP6Address objects into a +

nm_utils_ip6_addresses_to_gvalue ()

+
void
+nm_utils_ip6_addresses_to_gvalue (GSList *list,
+                                  GValue *value);
+

Utility function to convert a GSList of NMIP6Address objects into a GPtrArray of GValueArrays representing a list of NetworkManager IPv6 addresses (which is a tuple of address, prefix, and gateway). The specific format of this serialization is not guaranteed to be stable and may be extended in the -future. -

-
+future.

+
+

Parameters

+
--+++ - - + + + - - + +g_value_unset().

+

list :

a list of NMIP6Address objects. [element-type NMIP6Address] -

list

a list of NMIP6Address objects.

[element-type NMIP6Address]

value :

a pointer to a GValue into which to place the converted addresses, +

value

a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset().

 
+
-

nm_utils_ip6_routes_from_gvalue ()

-
GSList *            nm_utils_ip6_routes_from_gvalue     (const GValue *value);
-

-Utility function GPtrArray of GValueArrays of (GArray or guchars), guint32, +

nm_utils_ip6_routes_from_gvalue ()

+
GSList *
+nm_utils_ip6_routes_from_gvalue (const GValue *value);
+

Utility function GPtrArray of GValueArrays of (GArray or guchars), guint32, (GArray of guchars), and guint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric) into a GSList of NMIP6Route objects. The specific format of this serialization -is not guaranteed to be stable and may be extended in the future. -

-
+is not guaranteed to be stable and may be extended in the future.

+
+

Parameters

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

value :

gvalue containing a GPtrArray of GValueArrays of (GArray or guchars), guint32, -(GArray of guchars), and guint32

Returns :

a newly allocated GSList of NMIP6Route objects. [transfer full][element-type NetworkManager.IP6Route] -

value

gvalue containing a GPtrArray of GValueArrays of (GArray or guchars), guint32, +(GArray of guchars), and guint32

 
+
+

Returns

+

a newly allocated GSList of NMIP6Route objects.

+

[transfer full][element-type NetworkManager.IP6Route]

+
+
-

nm_utils_ip6_routes_to_gvalue ()

-
void                nm_utils_ip6_routes_to_gvalue       (GSList *list,
-                                                         GValue *value);
-

-Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of +

nm_utils_ip6_routes_to_gvalue ()

+
void
+nm_utils_ip6_routes_to_gvalue (GSList *list,
+                               GValue *value);
+

Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of GValueArrays of (GArray or guchars), guint32, (GArray of guchars), and guint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric). The specific format of this serialization is not -guaranteed to be stable and may be extended in the future. -

-
+guaranteed to be stable and may be extended in the future.

+
+

Parameters

+
--+++ - - + + + - - + +g_value_unset().

+

list :

a list of NMIP6Route objects. [element-type NMIP6Route] -

list

a list of NMIP6Route objects.

[element-type NMIP6Route]

value :

a pointer to a GValue into which to place the converted routes, +

value

a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset().

 
+
-

nm_utils_ip6_dns_from_gvalue ()

-
GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);
-

-Converts a GValue containing a GPtrArray of IP6 DNS, represented as -GByteArrays into a GSList of in6_addrs. -

-
+

nm_utils_ip6_dns_from_gvalue ()

+
GSList *
+nm_utils_ip6_dns_from_gvalue (const GValue *value);
+

Converts a GValue containing a GPtrArray of IP6 DNS, represented as +GByteArrays into a GSList of in6_addrs.

+
+

Parameters

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

value :

a GValue -

Returns :

a GSList of IP6 -addresses. [transfer full][element-type Posix.in6_addr] -

value

a GValue

 
+
+

Returns

+

a GSList of IP6 addresses.

+

+
+
-

nm_utils_ip6_dns_to_gvalue ()

-
void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
-                                                         GValue *value);
-

-Utility function to convert a GSList of 'struct in6_addr' structs into a +

nm_utils_ip6_dns_to_gvalue ()

+
void
+nm_utils_ip6_dns_to_gvalue (GSList *list,
+                            GValue *value);
+

Utility function to convert a GSList of 'struct in6_addr' structs into a GPtrArray of GByteArrays representing each server's IPv6 addresses in network byte order. The specific format of this serialization is not -guaranteed to be stable and may be extended in the future. -

-
+guaranteed to be stable and may be extended in the future.

+
+

Parameters

+
--+++ - - + + + - - + +g_value_unset().

+

list :

a list of NMIP6Route objects

list

a list of NMIP6Route objects

 

value :

a pointer to a GValue into which to place the converted DNS server +

value

a pointer to a GValue into which to place the converted DNS server addresses, which should be unset by the caller (when no longer needed) with -g_value_unset().

 
+
-

nm_utils_uuid_generate ()

-
char *              nm_utils_uuid_generate              (void);
-
---- - - - - -

Returns :

a newly allocated UUID suitable for use as the NMSettingConnection -object's "id": property. Should be freed with g_free() -
+

nm_utils_uuid_generate ()

+
char *
+nm_utils_uuid_generate (void);
+
+

Returns

+

a newly allocated UUID suitable for use as the NMSettingConnection +object's “id”: property. Should be freed with g_free()

+

+
-

nm_utils_uuid_generate_from_string ()

-
char *              nm_utils_uuid_generate_from_string  (const char *s);
-

-For a given s, this function will always return the same UUID. -

-
+

nm_utils_uuid_generate_from_string ()

+
char *
+nm_utils_uuid_generate_from_string (const char *s);
+

For a given s +, this function will always return the same UUID.

+
+

Parameters

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

s :

a string to use as the seed for the UUID

Returns :

a newly allocated UUID suitable for use as the NMSettingConnection -object's "id": property

s

a string to use as the seed for the UUID

 
+
+

Returns

+

a newly allocated UUID suitable for use as the NMSettingConnection +object's “id”: property

+

+
+
-

nm_utils_rsa_key_encrypt ()

-
GByteArray *        nm_utils_rsa_key_encrypt            (const GByteArray *data,
-                                                         const char *in_password,
-                                                         char **out_password,
-                                                         GError **error);
-

-Encrypts the given RSA private key data with the given password (or generates +

nm_utils_rsa_key_encrypt ()

+
GByteArray *
+nm_utils_rsa_key_encrypt (const GByteArray *data,
+                          const char *in_password,
+                          char **out_password,
+                          GError **error);
+

Encrypts the given RSA private key data with the given password (or generates a password if no password was given) and converts the data to PEM format -suitable for writing to a file. -

-
+suitable for writing to a file.

+
+

Parameters

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

data :

RSA private key data to be encrypted

in_password :

existing password to use, if any. [allow-none] -

data

RSA private key data to be encrypted

 

out_password :

if in_password was NULL, a random password will be generated -and returned in this argument. [out][allow-none] -

in_password

existing password to use, if any.

[allow-none]

error :

detailed error information on return, if an error occurred

out_password

if in_password +was NULL, a random password will be generated +and returned in this argument.

[out][allow-none]

Returns :

on success, PEM-formatted data suitable for writing to a PEM-formatted -certificate/private key file. [transfer full] -

error

detailed error information on return, if an error occurred

 
+
+

Returns

+

on success, PEM-formatted data suitable for writing to a PEM-formatted +certificate/private key file.

+

[transfer full]

+
+
-

nm_utils_file_is_pkcs12 ()

-
gboolean            nm_utils_file_is_pkcs12             (const char *filename);
-

-Utility function to find out if the filename is in PKCS12 format. -

-
+

nm_utils_file_is_pkcs12 ()

+
gboolean
+nm_utils_file_is_pkcs12 (const char *filename);
+

Utility function to find out if the filename + is in PKCS12 format.

+
+

Parameters

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

filename :

name of the file to test

Returns :

TRUE if the file is PKCS12, FALSE if it is not

filename

name of the file to test

 
+
+

Returns

+

TRUE if the file is PKCS12, FALSE if it is not

+

+
+
-

nm_utils_wifi_freq_to_channel ()

-
guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);
-

-Utility function to translate a WiFi frequency to its corresponding channel. -

-
+

nm_utils_wifi_freq_to_channel ()

+
guint32
+nm_utils_wifi_freq_to_channel (guint32 freq);
+

Utility function to translate a WiFi frequency to its corresponding channel.

+
+

Parameters

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

freq :

frequency

Returns :

the channel represented by the frequency or 0

freq

frequency

 
+
+

Returns

+

the channel represented by the frequency or 0

+

+
+
-

nm_utils_wifi_channel_to_freq ()

-
guint32             nm_utils_wifi_channel_to_freq       (guint32 channel,
-                                                         const char *band);
-

-Utility function to translate a WiFi channel to its corresponding frequency. -

-
+

nm_utils_wifi_channel_to_freq ()

+
guint32
+nm_utils_wifi_channel_to_freq (guint32 channel,
+                               const char *band);
+

Utility function to translate a WiFi channel to its corresponding frequency.

+
+

Parameters

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

channel :

channel

band :

frequency band for wireless ("a" or "bg")

channel

channel

 

Returns :

the frequency represented by the channel of the band, -or -1 when the freq is invalid, or 0 when the band -is invalid

band

frequency band for wireless ("a" or "bg")

 
+
+

Returns

+

the frequency represented by the channel of the band, +or -1 when the freq is invalid, or 0 when the band +is invalid

+

+
+
-

nm_utils_wifi_find_next_channel ()

-
guint32             nm_utils_wifi_find_next_channel     (guint32 channel,
-                                                         int direction,
-                                                         char *band);
-

-Utility function to find out next/previous WiFi channel for a channel. -

-
+

nm_utils_wifi_find_next_channel ()

+
guint32
+nm_utils_wifi_find_next_channel (guint32 channel,
+                                 int direction,
+                                 char *band);
+

Utility function to find out next/previous WiFi channel for a channel.

+
+

Parameters

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

channel :

current channel

direction :

whether going downward (0 or less) or upward (1 or more)

channel

current channel

 

band :

frequency band for wireless ("a" or "bg")

direction

whether going downward (0 or less) or upward (1 or more)

 

Returns :

the next channel in the specified direction or 0

band

frequency band for wireless ("a" or "bg")

 
+
+

Returns

+

the next channel in the specified direction or 0

+

+
+
-

nm_utils_wifi_is_channel_valid ()

-
gboolean            nm_utils_wifi_is_channel_valid      (guint32 channel,
-                                                         const char *band);
-

-Utility function to verify WiFi channel validity. -

-
+

nm_utils_wifi_is_channel_valid ()

+
gboolean
+nm_utils_wifi_is_channel_valid (guint32 channel,
+                                const char *band);
+

Utility function to verify WiFi channel validity.

+
+

Parameters

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

channel :

channel

band :

frequency band for wireless ("a" or "bg")

channel

channel

 

Returns :

TRUE or FALSE

band

frequency band for wireless ("a" or "bg")

 
+
+

Returns

+

TRUE or FALSE

+

+
+
-

NM_UTILS_HWADDR_LEN_MAX

-
#define NM_UTILS_HWADDR_LEN_MAX 20 /* INFINIBAND_ALEN */
-
-

-The maximum length of a hardware address of a type known by -nm_utils_hwaddr_len() or nm_utils_hwaddr_aton(). This can be used -as the size of the buffer passed to nm_utils_hwaddr_aton(). -

+

nm_utils_hwaddr_len ()

+
int
+nm_utils_hwaddr_len (int type);
+

Returns the length in octets of a hardware address of type type +.

+
+

Parameters

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

type

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND

 
+
+
+

Returns

+

the length

+

+
+
+
+
+

nm_utils_hwaddr_type ()

+
int
+nm_utils_hwaddr_type (int len);
+

Returns the type (either ARPHRD_ETHER or ARPHRD_INFINIBAND) of the raw +address given its length.

+
+

Parameters

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

len

the length of hardware address in bytes

 
+
+
+

Returns

+

the type, either ARPHRD_ETHER or ARPHRD_INFINIBAND, or -1 if +the address length was not recognized

+

+
-

nm_utils_hwaddr_len ()

-
int                 nm_utils_hwaddr_len                 (int type);
-

-Returns the length in octets of a hardware address of type type. -

-
+

nm_utils_hwaddr_ntoa ()

+
char *
+nm_utils_hwaddr_ntoa (gconstpointer addr,
+                      int type);
+

Converts addr + to textual form.

+
+

Parameters

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

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND -

addr

a binary hardware address

 

Returns :

the length

type

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND

 
+
+

Returns

+

the textual form of addr +.

+

[transfer full]

+
+
-

nm_utils_hwaddr_type ()

-
int                 nm_utils_hwaddr_type                (int len);
-

-Returns the type (either ARPHRD_ETHER or ARPHRD_INFINIBAND) of the raw -address given its length. -

-
+

nm_utils_hwaddr_atoba ()

+
GByteArray *
+nm_utils_hwaddr_atoba (const char *asc,
+                       int type);
+

Parses asc + and converts it to binary form in a GByteArray. See +nm_utils_hwaddr_aton() if you don't want a GByteArray.

+
+

Parameters

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

len :

the length of hardware address in bytes

asc

the ASCII representation of a hardware address

 

Returns :

the type, either ARPHRD_ETHER or ARPHRD_INFINIBAND, or -1 if -the address length was not recognized

type

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND

 
+
+

Returns

+

a new GByteArray, or NULL if asc +couldn't +be parsed.

+

[transfer full]

+
+
-

nm_utils_hwaddr_ntoa ()

-
char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
-                                                         int type);
-

-Converts addr to textual form. -

-
+

nm_utils_hwaddr_aton ()

+
guint8 *
+nm_utils_hwaddr_aton (const char *asc,
+                      int type,
+                      gpointer buffer);
+

Parses asc + and converts it to binary form in buffer +. See +nm_utils_hwaddr_atoba() if you'd rather have the result in a +GByteArray.

+
+

Parameters

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

addr :

a binary hardware address

asc

the ASCII representation of a hardware address

 

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND -

type

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND

 

Returns :

the textual form of addr. [transfer full] -

buffer

buffer to store the result into

 
+
+

Returns

+

buffer +, or NULL if asc +couldn't be parsed

+

+
+ +
+
+

nm_utils_iface_valid_name ()

+
gboolean
+nm_utils_iface_valid_name (const char *name);
+

This function is a 1:1 copy of the kernel's interface validation +function in net/core/dev.c.

+
+

Parameters

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

name

Name of interface

 
+
+
+

Returns

+

TRUE if interface name is valid, otherwise FALSE is returned.

+

+
+

Since 0.9.8

+
-

nm_utils_hwaddr_atoba ()

-
GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
-                                                         int type);
-

-Parses asc and converts it to binary form in a GByteArray. See -nm_utils_hwaddr_aton() if you don't want a GByteArray. -

-
+

nm_utils_is_uuid ()

+
gboolean
+nm_utils_is_uuid (const char *str);
+

Checks if str + is a UUID

+
+

Parameters

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

str

a string that might be a UUID

 
+
+
+

Returns

+

TRUE if str +is a UUID, FALSE if not

+

+
+

Since 0.9.8

+ + +
+

Types and Values

+
+

enum NMUtilsSecurityType

+

Describes generic security mechanisms that 802.11 access points may offer. +Used with nm_utils_security_valid() for checking whether a given access +point is compatible with a network device.

+
+

Members

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

asc :

the ASCII representation of a hardware address

NMU_SEC_INVALID

 +

unknown or invalid security, placeholder and not used

+		 

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

NMU_SEC_NONE

 +

unencrypted and open

 

Returns :

a new GByteArray, or NULL if asc couldn't -be parsed. [transfer full] +

NMU_SEC_STATIC_WEP

 +

static WEP keys are used for encryption

 
-
-
-
-

nm_utils_hwaddr_aton ()

-
guint8 *            nm_utils_hwaddr_aton                (const char *asc,
-                                                         int type,
-                                                         gpointer buffer);
-

-Parses asc and converts it to binary form in buffer. See -nm_utils_hwaddr_atoba() if you'd rather have the result in a -GByteArray. -

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

asc :

the ASCII representation of a hardware address

NMU_SEC_LEAP

 +

Cisco LEAP is used for authentication and for generating the +dynamic WEP keys automatically

+		 

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

NMU_SEC_DYNAMIC_WEP

 +

standard 802.1x is used for authentication and +generating the dynamic WEP keys automatically

 

buffer :

buffer to store the result into

NMU_SEC_WPA_PSK

 +

WPA1 is used with Pre-Shared Keys (PSK)

+		 

Returns :

 -buffer, or NULL if asc couldn't be parsed

NMU_SEC_WPA_ENTERPRISE

 +

WPA1 is used with 802.1x authentication

+		 
-
-
-
-

nm_utils_iface_valid_name ()

-
gboolean            nm_utils_iface_valid_name           (const char *name);
-

-This function is a 1:1 copy of the kernel's interface validation -function in net/core/dev.c. -

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

name :

Name of interface

NMU_SEC_WPA2_PSK

 +

WPA2/RSN is used with Pre-Shared Keys (PSK)

+		 

Returns :

 -TRUE if interface name is valid, otherwise FALSE is returned.

NMU_SEC_WPA2_ENTERPRISE

 +

WPA2 is used with 802.1x authentication

+		 
-

Since 0.9.8

+
-

nm_utils_is_uuid ()

-
gboolean            nm_utils_is_uuid                    (const char *str);
-

-Checks if str is a UUID -

-
---- - - - - - - - - - - -

str :

a string that might be a UUID

Returns :

 -TRUE if str is a UUID, FALSE if not
-

Since 0.9.8

+

NM_UTILS_HWADDR_LEN_MAX

+
#define NM_UTILS_HWADDR_LEN_MAX 20 /* INFINIBAND_ALEN */
+
+

The maximum length of a hardware address of a type known by +nm_utils_hwaddr_len() or nm_utils_hwaddr_aton(). This can be used +as the size of the buffer passed to nm_utils_hwaddr_aton().

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/libnm-util.devhelp2 b/docs/libnm-util/html/libnm-util.devhelp2 index f1daa3d4..a5489de5 100644 --- a/docs/libnm-util/html/libnm-util.devhelp2 +++ b/docs/libnm-util/html/libnm-util.devhelp2 @@ -34,101 +34,119 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - + - @@ -141,42 +159,37 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - @@ -188,39 +201,39 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - @@ -238,45 +251,53 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + @@ -294,113 +315,89 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - + + + + + + + + + - + - - - - - - - - - - - - - - + + + + + + + + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - + - @@ -412,50 +409,43 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - + - - - - - - - - + + + + + + + + + + + + - + - @@ -464,23 +454,20 @@ - - - - - - - - - - - - - + + + + + + + + + + + - + - @@ -488,106 +475,96 @@ - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - + - - - - - - - - - - + + + + + + + + - + - - - - - - - - - - + + + + + + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + - + - - - - - - - - - - + + + + + + + + + + + + - + - @@ -600,29 +577,84 @@ - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - @@ -655,109 +687,95 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - @@ -775,79 +793,74 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - @@ -865,78 +878,41 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - @@ -955,293 +931,108 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/libnm-util/html/object-tree.html b/docs/libnm-util/html/object-tree.html index df07ca9f..404390f1 100644 --- a/docs/libnm-util/html/object-tree.html +++ b/docs/libnm-util/html/object-tree.html @@ -2,99 +2,99 @@ -Object Hierarchy +libnm-util Reference Manual: Object Hierarchy - + - - - - - - + + + + + +

Object Hierarchy

     GObject
-        NMSetting
-            NMSetting8021x
-            NMSettingAdsl
-            NMSettingBluetooth
-            NMSettingBond
-            NMSettingBridge
-            NMSettingBridgePort
-            NMSettingConnection
-            NMSettingInfiniband
-            NMSettingIP4Config
-            NMSettingVlan
-            NMSettingIP6Config
-            NMSettingPPP
-            NMSettingPPPOE
-            NMSettingSerial
-            NMSettingGsm
-            NMSettingCdma
-            NMSettingOlpcMesh
-            NMSettingWimax
-            NMSettingWired
-            NMSettingWireless
-            NMSettingWirelessSecurity
-            NMSettingVPN
-        NMConnection
+    ├── NMSetting
+    │   ├── NMSetting8021x
+    │   ├── NMSettingAdsl
+    │   ├── NMSettingBluetooth
+    │   ├── NMSettingBond
+    │   ├── NMSettingBridge
+    │   ├── NMSettingBridgePort
+    │   ├── NMSettingConnection
+    │   ├── NMSettingInfiniband
+    │   ├── NMSettingIP4Config
+    │   ├── NMSettingVlan
+    │   ├── NMSettingIP6Config
+    │   ├── NMSettingPPP
+    │   ├── NMSettingPPPOE
+    │   ├── NMSettingSerial
+    │   ├── NMSettingGsm
+    │   ├── NMSettingCdma
+    │   ├── NMSettingOlpcMesh
+    │   ├── NMSettingWimax
+    │   ├── NMSettingWired
+    │   ├── NMSettingWireless
+    │   ├── NMSettingWirelessSecurity
+    │   ╰── NMSettingVPN
+    ╰── NMConnection
     GEnum
-        NMConnectionError
-        NMSetting8021xCKFormat
-        NMSetting8021xCKScheme
-        NMSetting8021xError
-        NMSettingAdslError
-        NMSettingBluetoothError
-        NMSettingBondError
-        NMSettingBridgeError
-        NMSettingBridgePortError
-        NMSettingCdmaError
-        NMSettingCompareFlags
-        NMSettingConnectionError
-        NMSettingDiffResult
-        NMSettingError
-        NMSettingGsmError
-        NMSettingGsmNetworkBand
-        NMSettingGsmNetworkType
-        NMSettingHashFlags
-        NMSettingInfinibandError
-        NMSettingIP4ConfigError
-        NMSettingIP6ConfigError
-        NMSettingIP6ConfigPrivacy
-        NMSettingOlpcMeshError
-        NMSettingPPPError
-        NMSettingPPPOEError
-        NMSettingSecretFlags
-        NMSettingSerialError
-        NMSettingVlanError
-        NMSettingVpnError
-        NMSettingWimaxError
-        NMSettingWiredError
-        NMSettingWirelessError
-        NMSettingWirelessSecurityError
-        NMUtilsSecurityType
-        NMVlanFlags
-        NMVlanPriorityMap
-        NMWepKeyType
+    ├── NMConnectionError
+    ├── NMSetting8021xCKFormat
+    ├── NMSetting8021xCKScheme
+    ├── NMSetting8021xError
+    ├── NMSettingAdslError
+    ├── NMSettingBluetoothError
+    ├── NMSettingBondError
+    ├── NMSettingBridgeError
+    ├── NMSettingBridgePortError
+    ├── NMSettingCdmaError
+    ├── NMSettingCompareFlags
+    ├── NMSettingConnectionError
+    ├── NMSettingDiffResult
+    ├── NMSettingError
+    ├── NMSettingGsmError
+    ├── NMSettingGsmNetworkBand
+    ├── NMSettingGsmNetworkType
+    ├── NMSettingHashFlags
+    ├── NMSettingInfinibandError
+    ├── NMSettingIP4ConfigError
+    ├── NMSettingIP6ConfigError
+    ├── NMSettingIP6ConfigPrivacy
+    ├── NMSettingOlpcMeshError
+    ├── NMSettingPPPError
+    ├── NMSettingPPPOEError
+    ├── NMSettingSecretFlags
+    ├── NMSettingSerialError
+    ├── NMSettingVlanError
+    ├── NMSettingVpnError
+    ├── NMSettingWimaxError
+    ├── NMSettingWiredError
+    ├── NMSettingWirelessError
+    ├── NMSettingWirelessSecurityError
+    ├── NMUtilsSecurityType
+    ├── NMVlanFlags
+    ├── NMVlanPriorityMap
+    ╰── NMWepKeyType
     GBoxed
-        NMIP4Address
-        NMIP4Route
-        NMIP6Address
-        NMIP6Route
+    ├── NMIP4Address
+    ├── NMIP4Route
+    ├── NMIP6Address
+    ╰── NMIP6Route
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-util/html/right-insensitive.png b/docs/libnm-util/html/right-insensitive.png new file mode 100644 index 00000000..4c95785b Binary files /dev/null and b/docs/libnm-util/html/right-insensitive.png differ diff --git a/docs/libnm-util/html/right.png b/docs/libnm-util/html/right.png index 92832e3a..76260ec8 100644 Binary files a/docs/libnm-util/html/right.png and b/docs/libnm-util/html/right.png differ diff --git a/docs/libnm-util/html/style.css b/docs/libnm-util/html/style.css index d6f6c26e..705a5c9a 100644 --- a/docs/libnm-util/html/style.css +++ b/docs/libnm-util/html/style.css @@ -1,15 +1,23 @@ +body +{ + font-family: cantarell, sans-serif; +} .synopsis, .classsynopsis { /* tango:aluminium 1/2 */ background: #eeeeec; - border: solid 1px #d3d7cf; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); padding: 0.5em; } .programlisting { /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ background: #e6f3ff; border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); padding: 0.5em; } .variablelist @@ -27,7 +35,6 @@ { position: relative; top: 0em ! important; - } /* this is needed so that the local anchors are displayed below the naviagtion */ div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] @@ -46,16 +53,20 @@ */ body { - padding-top: 3.2em; - padding-bottom: 20em; + padding-top: 5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; } /* style and size the navigation bar */ table.navigation#top { position: fixed; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; margin-top: 0; margin-bottom: 0; top: 0; @@ -65,21 +76,57 @@ } .navigation a, .navigation a:visited { - /* tango:scarlet red 3 */ - color: #a40000; + /* tango:sky blue 3 */ + color: #204a87; } .navigation a:hover { - /* tango:scarlet red 1 */ - color: #ef2929; + /* tango:sky blue 2 */ + color: #3465a4; } td.shortcuts { - /* tango:scarlet red 1 */ - color: #ef2929; + /* tango:sky blue 2 */ + color: #3465a4; font-size: 80%; white-space: nowrap; } + td.shortcuts .dim + { + color: #babdb6; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } } @media print { table.navigation { @@ -89,9 +136,8 @@ div.titlepage table.navigation { visibility: visible; display: table; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; + background: #e2e2e2; + border: solid 1px #babdb6; margin-top: 0; margin-bottom: 0; top: 0; @@ -102,7 +148,7 @@ .navigation .title { - font-size: 200%; + font-size: 120%; } div.gallery-float @@ -132,6 +178,67 @@ a:hover color: #729fcf; } +div.informaltable table +{ + border-collapse: separate; + border-spacing: 20px 3px; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + div.table table { border-collapse: collapse; @@ -154,14 +261,43 @@ div.table table th background-color: #d3d7cf; } +h4 +{ + color: #555753; +} + hr { - /* tango:aluminium 3 */ - color: #babdb6; - background: #babdb6; + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; border: none 0px; height: 1px; clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dd > dl > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 1em; + padding-bottom: 0.5em; + font-weight: bold; +} + +.parameter +{ + font-style: normal; } .footer @@ -173,31 +309,70 @@ hr font-size: 80%; } +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + .warning { /* tango:orange 0/1 */ background: #ffeed9; + background: rgba(252, 175, 62, 0.1); border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); } .note { /* tango:chameleon 0/0.5 */ background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); } -.note, .warning +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote { padding: 0.5em; border-width: 1px; border-style: solid; + margin: 2em; } -.note h3, .warning h3 +.note p, .warning p { - margin-top: 0.0em + margin: 0; } -.note p, .warning p + +div.warning h3.title, +div.note h3.title { - margin-bottom: 0.0em + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; } /* blob links */ @@ -210,11 +385,22 @@ h2 .extralinks, h3 .extralinks font-weight: normal; } +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + .annotation { /* tango:aluminium 5 */ color: #555753; - font-size: 80%; + font-weight: normal; +} + +.structfield +{ + font-style: normal; font-weight: normal; } @@ -237,6 +423,7 @@ h2 .extralinks, h3 .extralinks .listing_frame { /* tango:sky blue 1 */ border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); padding: 0px; } @@ -245,20 +432,28 @@ h2 .extralinks, h3 .extralinks margin-bottom: 0px; padding: 0.5em; } +.listing_lines { + /* this just adds visual clutter and + takes precious room from small screens */ + display: none; +} .listing_lines { /* tango:sky blue 0.5 */ background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); /* tango:aluminium 6 */ color: #2e3436; } .listing_code { /* tango:sky blue 0 */ background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); } .listing_code .programlisting { /* override from previous */ border: none 0px; padding: 0px; + background: none; } .listing_lines pre, .listing_code pre { margin: 0px; diff --git a/docs/libnm-util/html/up-insensitive.png b/docs/libnm-util/html/up-insensitive.png new file mode 100644 index 00000000..f4049860 Binary files /dev/null and b/docs/libnm-util/html/up-insensitive.png differ diff --git a/docs/libnm-util/html/up.png b/docs/libnm-util/html/up.png index 85b3e2a2..80b4b37e 100644 Binary files a/docs/libnm-util/html/up.png and b/docs/libnm-util/html/up.png differ diff --git a/docs/libnm-util/libnm-util-docs.sgml b/docs/libnm-util/libnm-util-docs.sgml index eaef2623..b2b34c36 100644 --- a/docs/libnm-util/libnm-util-docs.sgml +++ b/docs/libnm-util/libnm-util-docs.sgml @@ -11,7 +11,7 @@ for libnm-util &version; The latest version of this documentation can be found on-line at - http://projects.gnome.org/NetworkManager/developers/libnm-util/09/. + https://developer.gnome.org/libnm-util/0.9/. diff --git a/docs/libnm-util/libnm-util-sections.txt b/docs/libnm-util/libnm-util-sections.txt index e70e2682..49ebc622 100644 --- a/docs/libnm-util/libnm-util-sections.txt +++ b/docs/libnm-util/libnm-util-sections.txt @@ -6,7 +6,6 @@ NM_CONNECTION_ERROR nm_connection_error_quark NM_CONNECTION_PATH NMConnection -NMConnectionClass nm_connection_new nm_connection_new_from_hash nm_connection_duplicate @@ -57,6 +56,7 @@ nm_connection_get_setting_wireless nm_connection_get_setting_wireless_security nm_connection_get_setting_vlan +NMConnectionClass NM_CONNECTION NM_CONNECTION_CLASS NM_CONNECTION_GET_CLASS @@ -81,7 +81,6 @@ NMSettingSecretFlags NMSettingCompareFlags NMSetting NMSettingClearSecretsWithFlagsFn -NMSettingClass NMSettingValueIterFn NMSettingHashFlags nm_setting_to_hash @@ -102,6 +101,7 @@ nm_setting_get_secret_flags nm_setting_set_secret_flags nm_setting_get_virtual_iface_name +NMSettingClass NM_IS_SETTING NM_IS_SETTING_CLASS NM_SETTING @@ -152,8 +152,6 @@ NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS NM_SETTING_802_1X_PIN NM_SETTING_802_1X_PIN_FLAGS NM_SETTING_802_1X_SYSTEM_CA_CERTS -NMSetting8021x -NMSetting8021xClass nm_setting_802_1x_new nm_setting_802_1x_get_num_eap_methods nm_setting_802_1x_get_eap_method @@ -220,6 +218,8 @@ nm_setting_802_1x_get_phase2_private_key_password nm_setting_802_1x_get_phase2_private_key_password_flags nm_setting_802_1x_get_phase2_private_key_format +NMSetting8021x +NMSetting8021xClass NM_IS_SETTING_802_1X NM_IS_SETTING_802_1X_CLASS NM_SETTING_802_1X @@ -248,8 +248,6 @@ NM_SETTING_ADSL_PROTOCOL_PPPOE NM_SETTING_ADSL_PROTOCOL_IPOATM NM_SETTING_ADSL_ENCAPSULATION_VCMUX NM_SETTING_ADSL_ENCAPSULATION_LLC -NMSettingAdsl -NMSettingAdslClass nm_setting_adsl_new nm_setting_adsl_get_username nm_setting_adsl_get_password @@ -259,6 +257,8 @@ nm_setting_adsl_get_vpi nm_setting_adsl_get_vci nm_setting_adsl_get_password_flags +NMSettingAdsl +NMSettingAdslClass NM_IS_SETTING_ADSL NM_IS_SETTING_ADSL_CLASS NM_SETTING_ADSL @@ -279,12 +279,12 @@ NM_SETTING_BLUETOOTH_BDADDR NM_SETTING_BLUETOOTH_TYPE NM_SETTING_BLUETOOTH_TYPE_DUN NM_SETTING_BLUETOOTH_TYPE_PANU -NMSettingBluetooth -NMSettingBluetoothClass nm_setting_bluetooth_new nm_setting_bluetooth_get_bdaddr nm_setting_bluetooth_get_connection_type +NMSettingBluetooth +NMSettingBluetoothClass NM_IS_SETTING_BLUETOOTH NM_IS_SETTING_BLUETOOTH_CLASS NM_SETTING_BLUETOOTH @@ -309,8 +309,6 @@ NM_SETTING_BOND_OPTION_DOWNDELAY NM_SETTING_BOND_OPTION_UPDELAY NM_SETTING_BOND_OPTION_ARP_INTERVAL NM_SETTING_BOND_OPTION_ARP_IP_TARGET -NMSettingBond -NMSettingBondClass nm_setting_bond_new nm_setting_bond_get_interface_name nm_setting_bond_get_num_options @@ -321,6 +319,8 @@ nm_setting_bond_remove_option nm_setting_bond_get_valid_options nm_setting_bond_get_option_default +NMSettingBond +NMSettingBondClass NM_IS_SETTING_BOND NM_IS_SETTING_BOND_CLASS NM_SETTING_BOND @@ -344,8 +344,6 @@ NM_SETTING_BRIDGE_FORWARD_DELAY NM_SETTING_BRIDGE_HELLO_TIME NM_SETTING_BRIDGE_MAX_AGE NM_SETTING_BRIDGE_AGEING_TIME -NMSettingBridge -NMSettingBridgeClass nm_setting_bridge_new nm_setting_bridge_get_interface_name nm_setting_bridge_get_stp @@ -355,6 +353,8 @@ nm_setting_bridge_get_hello_time nm_setting_bridge_get_max_age nm_setting_bridge_get_ageing_time +NMSettingBridge +NMSettingBridgeClass NM_IS_SETTING_BRIDGE NM_IS_SETTING_BRIDGE_CLASS NM_SETTING_BRIDGE @@ -374,13 +374,13 @@ nm_setting_bridge_port_error_quark NM_SETTING_BRIDGE_PORT_PRIORITY NM_SETTING_BRIDGE_PORT_PATH_COST NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE -NMSettingBridgePort -NMSettingBridgePortClass nm_setting_bridge_port_new nm_setting_bridge_port_get_priority nm_setting_bridge_port_get_path_cost nm_setting_bridge_port_get_hairpin_mode +NMSettingBridgePort +NMSettingBridgePortClass NM_IS_SETTING_BRIDGE_PORT NM_IS_SETTING_BRIDGE_PORT_CLASS NM_SETTING_BRIDGE_PORT @@ -401,14 +401,14 @@ NM_SETTING_CDMA_NUMBER NM_SETTING_CDMA_USERNAME NM_SETTING_CDMA_PASSWORD NM_SETTING_CDMA_PASSWORD_FLAGS -NMSettingCdma -NMSettingCdmaClass nm_setting_cdma_new nm_setting_cdma_get_number nm_setting_cdma_get_username nm_setting_cdma_get_password nm_setting_cdma_get_password_flags +NMSettingCdma +NMSettingCdmaClass NM_IS_SETTING_CDMA NM_IS_SETTING_CDMA_CLASS NM_SETTING_CDMA @@ -437,7 +437,6 @@ NM_SETTING_CONNECTION_MASTER NM_SETTING_CONNECTION_SLAVE_TYPE NM_SETTING_CONNECTION_SECONDARIES NMSettingConnection -NMSettingConnectionClass nm_setting_connection_new nm_setting_connection_get_id nm_setting_connection_get_uuid @@ -459,6 +458,7 @@ nm_setting_connection_get_secondary nm_setting_connection_add_secondary nm_setting_connection_remove_secondary +NMSettingConnectionClass NM_IS_SETTING_CONNECTION NM_IS_SETTING_CONNECTION_CLASS NM_SETTING_CONNECTION @@ -488,8 +488,6 @@ NM_SETTING_GSM_PIN_FLAGS NM_SETTING_GSM_HOME_ONLY NMSettingGsmNetworkType NMSettingGsmNetworkBand -NMSettingGsm -NMSettingGsmClass nm_setting_gsm_new nm_setting_gsm_get_number nm_setting_gsm_get_username @@ -503,6 +501,8 @@ nm_setting_gsm_get_home_only nm_setting_gsm_get_pin_flags nm_setting_gsm_get_password_flags +NMSettingGsm +NMSettingGsmClass NM_IS_SETTING_GSM NM_IS_SETTING_GSM_CLASS NM_SETTING_GSM @@ -522,13 +522,13 @@ nm_setting_infiniband_error_quark NM_SETTING_INFINIBAND_MAC_ADDRESS NM_SETTING_INFINIBAND_MTU NM_SETTING_INFINIBAND_TRANSPORT_MODE -NMSettingInfiniband -NMSettingInfinibandClass nm_setting_infiniband_new nm_setting_infiniband_get_mac_address nm_setting_infiniband_get_mtu nm_setting_infiniband_get_transport_mode +NMSettingInfiniband +NMSettingInfinibandClass NM_IS_SETTING_INFINIBAND NM_IS_SETTING_INFINIBAND_CLASS NM_SETTING_INFINIBAND @@ -562,7 +562,6 @@ NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL NM_SETTING_IP4_CONFIG_METHOD_MANUAL NM_SETTING_IP4_CONFIG_METHOD_SHARED NM_SETTING_IP4_CONFIG_METHOD_DISABLED -NMIP4Address nm_ip4_address_new nm_ip4_address_dup nm_ip4_address_ref @@ -574,7 +573,6 @@ nm_ip4_address_get_prefix nm_ip4_address_set_prefix nm_ip4_address_get_gateway nm_ip4_address_set_gateway -NMIP4Route nm_ip4_route_new nm_ip4_route_dup nm_ip4_route_ref @@ -588,8 +586,6 @@ nm_ip4_route_get_next_hop nm_ip4_route_set_next_hop nm_ip4_route_get_metric nm_ip4_route_set_metric -NMSettingIP4Config -NMSettingIP4ConfigClass nm_setting_ip4_config_new nm_setting_ip4_config_get_method nm_setting_ip4_config_get_num_dns @@ -620,6 +616,10 @@ nm_setting_ip4_config_get_dhcp_hostname nm_setting_ip4_config_get_never_default nm_setting_ip4_config_get_may_fail +NMIP4Address +NMIP4Route +NMSettingIP4Config +NMSettingIP4ConfigClass NM_IS_SETTING_IP4_CONFIG NM_IS_SETTING_IP4_CONFIG_CLASS NM_SETTING_IP4_CONFIG @@ -656,7 +656,6 @@ NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL NM_SETTING_IP6_CONFIG_METHOD_MANUAL NM_SETTING_IP6_CONFIG_METHOD_SHARED NMSettingIP6ConfigPrivacy -NMIP6Address nm_ip6_address_new nm_ip6_address_dup nm_ip6_address_ref @@ -668,7 +667,6 @@ nm_ip6_address_get_prefix nm_ip6_address_set_prefix nm_ip6_address_get_gateway nm_ip6_address_set_gateway -NMIP6Route nm_ip6_route_new nm_ip6_route_dup nm_ip6_route_ref @@ -682,8 +680,6 @@ nm_ip6_route_get_next_hop nm_ip6_route_set_next_hop nm_ip6_route_get_metric nm_ip6_route_set_metric -NMSettingIP6Config -NMSettingIP6ConfigClass nm_setting_ip6_config_new nm_setting_ip6_config_get_method nm_setting_ip6_config_get_num_dns @@ -713,6 +709,10 @@ nm_setting_ip6_config_get_never_default nm_setting_ip6_config_get_may_fail nm_setting_ip6_config_get_ip6_privacy +NMIP6Address +NMIP6Route +NMSettingIP6Config +NMSettingIP6ConfigClass NM_IS_SETTING_IP6_CONFIG NM_IS_SETTING_IP6_CONFIG_CLASS NM_SETTING_IP6_CONFIG @@ -734,13 +734,13 @@ nm_setting_olpc_mesh_error_quark NM_SETTING_OLPC_MESH_SSID NM_SETTING_OLPC_MESH_CHANNEL NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS -NMSettingOlpcMesh -NMSettingOlpcMeshClass nm_setting_olpc_mesh_new nm_setting_olpc_mesh_get_ssid nm_setting_olpc_mesh_get_channel nm_setting_olpc_mesh_get_dhcp_anycast_address +NMSettingOlpcMesh +NMSettingOlpcMeshClass NM_IS_SETTING_OLPC_MESH NM_IS_SETTING_OLPC_MESH_CLASS NM_SETTING_OLPC_MESH @@ -775,8 +775,6 @@ NM_SETTING_PPP_MRU NM_SETTING_PPP_MTU NM_SETTING_PPP_LCP_ECHO_FAILURE NM_SETTING_PPP_LCP_ECHO_INTERVAL -NMSettingPPP -NMSettingPPPClass nm_setting_ppp_new nm_setting_ppp_get_noauth nm_setting_ppp_get_refuse_eap @@ -797,6 +795,8 @@ nm_setting_ppp_get_mtu nm_setting_ppp_get_lcp_echo_failure nm_setting_ppp_get_lcp_echo_interval +NMSettingPPP +NMSettingPPPClass NM_IS_SETTING_PPP NM_IS_SETTING_PPP_CLASS NM_SETTING_PPP @@ -817,14 +817,14 @@ NM_SETTING_PPPOE_SERVICE NM_SETTING_PPPOE_USERNAME NM_SETTING_PPPOE_PASSWORD NM_SETTING_PPPOE_PASSWORD_FLAGS -NMSettingPPPOE -NMSettingPPPOEClass nm_setting_pppoe_new nm_setting_pppoe_get_service nm_setting_pppoe_get_username nm_setting_pppoe_get_password nm_setting_pppoe_get_password_flags +NMSettingPPPOE +NMSettingPPPOEClass NM_IS_SETTING_PPPOE NM_IS_SETTING_PPPOE_CLASS NM_SETTING_PPPOE @@ -852,8 +852,6 @@ NM_SETTING_SERIAL_BITS NM_SETTING_SERIAL_PARITY NM_SETTING_SERIAL_STOPBITS NM_SETTING_SERIAL_SEND_DELAY -NMSettingSerial -NMSettingSerialClass nm_setting_serial_new nm_setting_serial_get_baud nm_setting_serial_get_bits @@ -861,6 +859,8 @@ nm_setting_serial_get_parity nm_setting_serial_get_stopbits nm_setting_serial_get_send_delay +NMSettingSerial +NMSettingSerialClass NM_IS_SETTING_SERIAL NM_IS_SETTING_SERIAL_CLASS NM_SETTING_SERIAL @@ -883,8 +883,6 @@ NM_SETTING_VLAN_ID NM_SETTING_VLAN_FLAGS NM_SETTING_VLAN_INGRESS_PRIORITY_MAP NM_SETTING_VLAN_EGRESS_PRIORITY_MAP -NMSettingVlan -NMSettingVlanClass NMVlanPriorityMap NMVlanFlags nm_setting_vlan_new @@ -899,6 +897,8 @@ nm_setting_vlan_remove_priority nm_setting_vlan_clear_priorities nm_setting_vlan_add_priority_str +NMSettingVlan +NMSettingVlanClass NM_IS_SETTING_VLAN NM_IS_SETTING_VLAN_CLASS NM_SETTING_VLAN @@ -919,8 +919,6 @@ NM_SETTING_VPN_SERVICE_TYPE NM_SETTING_VPN_USER_NAME NM_SETTING_VPN_DATA NM_SETTING_VPN_SECRETS -NMSettingVPN -NMSettingVPNClass NMVPNIterFunc nm_setting_vpn_new nm_setting_vpn_get_service_type @@ -936,6 +934,8 @@ nm_setting_vpn_get_secret nm_setting_vpn_remove_secret nm_setting_vpn_foreach_secret +NMSettingVPN +NMSettingVPNClass NM_IS_SETTING_VPN NM_IS_SETTING_VPN_CLASS NM_SETTING_VPN @@ -954,12 +954,12 @@ NM_SETTING_WIMAX_ERROR nm_setting_wimax_error_quark NM_SETTING_WIMAX_NETWORK_NAME NM_SETTING_WIMAX_MAC_ADDRESS -NMSettingWimax -NMSettingWimaxClass nm_setting_wimax_new nm_setting_wimax_get_network_name nm_setting_wimax_get_mac_address +NMSettingWimax +NMSettingWimaxClass NM_IS_SETTING_WIMAX NM_IS_SETTING_WIMAX_CLASS NM_SETTING_WIMAX @@ -987,8 +987,6 @@ NM_SETTING_WIRED_MTU NM_SETTING_WIRED_S390_SUBCHANNELS NM_SETTING_WIRED_S390_NETTYPE NM_SETTING_WIRED_S390_OPTIONS -NMSettingWired -NMSettingWiredClass nm_setting_wired_new nm_setting_wired_get_port nm_setting_wired_get_speed @@ -1006,6 +1004,8 @@ nm_setting_wired_get_s390_option_by_key nm_setting_wired_add_s390_option nm_setting_wired_remove_s390_option +NMSettingWired +NMSettingWiredClass NM_IS_SETTING_WIRED NM_IS_SETTING_WIRED_CLASS NM_SETTING_WIRED @@ -1039,8 +1039,6 @@ NM_SETTING_WIRELESS_HIDDEN NM_SETTING_WIRELESS_MODE_ADHOC NM_SETTING_WIRELESS_MODE_AP NM_SETTING_WIRELESS_MODE_INFRA -NMSettingWireless -NMSettingWirelessClass nm_setting_wireless_new nm_setting_wireless_get_ssid nm_setting_wireless_get_mode @@ -1060,6 +1058,8 @@ nm_setting_wireless_get_num_seen_bssids nm_setting_wireless_get_seen_bssid nm_setting_wireless_ap_security_compatible +NMSettingWireless +NMSettingWirelessClass NM_IS_SETTING_WIRELESS NM_IS_SETTING_WIRELESS_CLASS NM_SETTING_WIRELESS @@ -1094,8 +1094,6 @@ NM_SETTING_WIRELESS_SECURITY_PSK NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS -NMSettingWirelessSecurity -NMSettingWirelessSecurityClass nm_setting_wireless_security_new nm_setting_wireless_security_get_key_mgmt nm_setting_wireless_security_get_num_protos @@ -1125,6 +1123,8 @@ nm_setting_wireless_security_get_auth_alg nm_setting_wireless_security_get_wep_key_flags nm_setting_wireless_security_get_wep_key_type +NMSettingWirelessSecurity +NMSettingWirelessSecurityClass NM_IS_SETTING_WIRELESS_SECURITY NM_IS_SETTING_WIRELESS_SECURITY_CLASS NM_SETTING_WIRELESS_SECURITY diff --git a/docs/libnm-util/tmpl/nm-connection.sgml b/docs/libnm-util/tmpl/nm-connection.sgml index e8491ee1..7a40b5e0 100644 --- a/docs/libnm-util/tmpl/nm-connection.sgml +++ b/docs/libnm-util/tmpl/nm-connection.sgml @@ -81,14 +81,6 @@ NMConnection - - - - - -@parent: -@secrets_updated: - diff --git a/docs/libnm-util/tmpl/nm-setting-8021x.sgml b/docs/libnm-util/tmpl/nm-setting-8021x.sgml index 881d2e94..580a508f 100644 --- a/docs/libnm-util/tmpl/nm-setting-8021x.sgml +++ b/docs/libnm-util/tmpl/nm-setting-8021x.sgml @@ -297,183 +297,6 @@ NMSetting8021x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-adsl.sgml b/docs/libnm-util/tmpl/nm-setting-adsl.sgml index 4b3716ef..aa9a1661 100644 --- a/docs/libnm-util/tmpl/nm-setting-adsl.sgml +++ b/docs/libnm-util/tmpl/nm-setting-adsl.sgml @@ -138,58 +138,6 @@ NMSettingAdsl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml b/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml index 3a9c9773..058e98fc 100644 --- a/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml @@ -83,33 +83,6 @@ NMSettingBluetooth - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-bond.sgml b/docs/libnm-util/tmpl/nm-setting-bond.sgml index 2500beed..bc2f7627 100644 --- a/docs/libnm-util/tmpl/nm-setting-bond.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bond.sgml @@ -112,33 +112,6 @@ NMSettingBond - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml b/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml index 692cb73d..ebbed6db 100644 --- a/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml @@ -75,38 +75,6 @@ NMSettingBridgePort - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-bridge.sgml b/docs/libnm-util/tmpl/nm-setting-bridge.sgml index bf9593e5..328eb755 100644 --- a/docs/libnm-util/tmpl/nm-setting-bridge.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bridge.sgml @@ -103,58 +103,6 @@ NMSettingBridge - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-cdma.sgml b/docs/libnm-util/tmpl/nm-setting-cdma.sgml index 4c90acb1..fdcad0de 100644 --- a/docs/libnm-util/tmpl/nm-setting-cdma.sgml +++ b/docs/libnm-util/tmpl/nm-setting-cdma.sgml @@ -83,43 +83,6 @@ NMSettingCdma - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-connection.sgml b/docs/libnm-util/tmpl/nm-setting-connection.sgml index aa04897e..e92e758a 100644 --- a/docs/libnm-util/tmpl/nm-setting-connection.sgml +++ b/docs/libnm-util/tmpl/nm-setting-connection.sgml @@ -194,17 +194,6 @@ NMSettingConnection - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-gsm.sgml b/docs/libnm-util/tmpl/nm-setting-gsm.sgml index d73ab6df..ec7f841e 100644 --- a/docs/libnm-util/tmpl/nm-setting-gsm.sgml +++ b/docs/libnm-util/tmpl/nm-setting-gsm.sgml @@ -166,78 +166,6 @@ NMSettingGsm @NM_SETTING_GSM_BAND_U1900: @NM_SETTING_GSM_BAND_U2600: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-infiniband.sgml b/docs/libnm-util/tmpl/nm-setting-infiniband.sgml index 39f397eb..9331ee3e 100644 --- a/docs/libnm-util/tmpl/nm-setting-infiniband.sgml +++ b/docs/libnm-util/tmpl/nm-setting-infiniband.sgml @@ -75,38 +75,6 @@ NMSettingInfiniband - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml b/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml index ea5b49c9..c01e5a96 100644 --- a/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml +++ b/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml @@ -174,12 +174,6 @@ NMSettingIP4Config - - - - - - @@ -278,12 +272,6 @@ NMSettingIP4Config @gateway: - - - - - - @@ -400,83 +388,6 @@ NMSettingIP4Config @metric: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml b/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml index df2fbec4..dc99e3e1 100644 --- a/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml +++ b/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml @@ -184,12 +184,6 @@ NMSettingIP6Config @NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR: @NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR: - - - - - - @@ -288,12 +282,6 @@ NMSettingIP6Config @gateway: - - - - - - @@ -410,78 +398,6 @@ NMSettingIP6Config @metric: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml b/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml index 6d525379..c3971303 100644 --- a/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml +++ b/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml @@ -75,38 +75,6 @@ NMSettingOlpcMesh - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-ppp.sgml b/docs/libnm-util/tmpl/nm-setting-ppp.sgml index 69cf509c..ccf4f0d9 100644 --- a/docs/libnm-util/tmpl/nm-setting-ppp.sgml +++ b/docs/libnm-util/tmpl/nm-setting-ppp.sgml @@ -181,113 +181,6 @@ NMSettingPPP - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-pppoe.sgml b/docs/libnm-util/tmpl/nm-setting-pppoe.sgml index 1ab1ae55..f34ba1d2 100644 --- a/docs/libnm-util/tmpl/nm-setting-pppoe.sgml +++ b/docs/libnm-util/tmpl/nm-setting-pppoe.sgml @@ -83,43 +83,6 @@ NMSettingPPPOE - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-serial.sgml b/docs/libnm-util/tmpl/nm-setting-serial.sgml index b79ec0a9..fcd7e170 100644 --- a/docs/libnm-util/tmpl/nm-setting-serial.sgml +++ b/docs/libnm-util/tmpl/nm-setting-serial.sgml @@ -90,48 +90,6 @@ NMSettingSerial - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-vlan.sgml b/docs/libnm-util/tmpl/nm-setting-vlan.sgml index 47b44bd6..4443c2a0 100644 --- a/docs/libnm-util/tmpl/nm-setting-vlan.sgml +++ b/docs/libnm-util/tmpl/nm-setting-vlan.sgml @@ -97,53 +97,6 @@ NMSettingVlan - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-vpn.sgml b/docs/libnm-util/tmpl/nm-setting-vpn.sgml index 4b323f35..a3f8b7fb 100644 --- a/docs/libnm-util/tmpl/nm-setting-vpn.sgml +++ b/docs/libnm-util/tmpl/nm-setting-vpn.sgml @@ -82,43 +82,6 @@ NMSettingVPN - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-wimax.sgml b/docs/libnm-util/tmpl/nm-setting-wimax.sgml index 151e723e..ebfbd61a 100644 --- a/docs/libnm-util/tmpl/nm-setting-wimax.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wimax.sgml @@ -68,29 +68,6 @@ NMSettingWimax - - - - - - - - - - - - - - - - - - - - - -@parent: - diff --git a/docs/libnm-util/tmpl/nm-setting-wired.sgml b/docs/libnm-util/tmpl/nm-setting-wired.sgml index 893a9c06..d2e80029 100644 --- a/docs/libnm-util/tmpl/nm-setting-wired.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wired.sgml @@ -131,78 +131,6 @@ NMSettingWired - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml b/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml index 7c8b7dc8..cb67e6e2 100644 --- a/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml @@ -187,108 +187,6 @@ NMSettingWirelessSecurity - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting-wireless.sgml b/docs/libnm-util/tmpl/nm-setting-wireless.sgml index e390bb09..af9da818 100644 --- a/docs/libnm-util/tmpl/nm-setting-wireless.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wireless.sgml @@ -175,93 +175,6 @@ NMSettingWireless - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: - diff --git a/docs/libnm-util/tmpl/nm-setting.sgml b/docs/libnm-util/tmpl/nm-setting.sgml index d5df34e5..beb8c66b 100644 --- a/docs/libnm-util/tmpl/nm-setting.sgml +++ b/docs/libnm-util/tmpl/nm-setting.sgml @@ -128,22 +128,6 @@ NMSetting @Returns: - - - - - -@parent: -@verify: -@need_secrets: -@update_one_secret: -@get_secret_flags: -@set_secret_flags: -@compare_property: -@clear_secrets_with_flags: -@get_virtual_iface_name: -@_reserved1: - diff --git a/docs/libnm-util/version.xml b/docs/libnm-util/version.xml index fe98bd59..dd62f24f 100644 --- a/docs/libnm-util/version.xml +++ b/docs/libnm-util/version.xml @@ -1 +1 @@ -0.9.8.8 +0.9.8.10 -- cgit 1.3.0-6-gf8a5