From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm/html/NMAccessPoint.html | 613 ++ docs/libnm/html/NMActiveConnection.html | 816 +++ docs/libnm/html/NMClient.html | 3059 +++++++++ docs/libnm/html/NMDevice.html | 1858 ++++++ docs/libnm/html/NMDeviceAdsl.html | 147 + docs/libnm/html/NMDeviceBond.html | 243 + docs/libnm/html/NMDeviceBridge.html | 243 + docs/libnm/html/NMDeviceBt.html | 237 + docs/libnm/html/NMDeviceEthernet.html | 286 + docs/libnm/html/NMDeviceGeneric.html | 167 + docs/libnm/html/NMDeviceInfiniband.html | 193 + docs/libnm/html/NMDeviceModem.html | 202 + docs/libnm/html/NMDeviceOlpcMesh.html | 239 + docs/libnm/html/NMDeviceTeam.html | 243 + docs/libnm/html/NMDeviceVlan.html | 278 + docs/libnm/html/NMDeviceWifi.html | 668 ++ docs/libnm/html/NMDeviceWimax.html | 597 ++ docs/libnm/html/NMDhcpConfig.html | 232 + docs/libnm/html/NMIPConfig.html | 473 ++ docs/libnm/html/NMObject.html | 188 + docs/libnm/html/NMRemoteConnection.html | 761 +++ docs/libnm/html/NMSecretAgentOld.html | 911 +++ docs/libnm/html/NMSetting.html | 932 +++ docs/libnm/html/NMSetting8021x.html | 3251 ++++++++++ docs/libnm/html/NMSettingAdsl.html | 463 ++ docs/libnm/html/NMSettingBluetooth.html | 244 + docs/libnm/html/NMSettingBond.html | 573 ++ docs/libnm/html/NMSettingBridge.html | 426 ++ docs/libnm/html/NMSettingBridgePort.html | 257 + docs/libnm/html/NMSettingCdma.html | 297 + docs/libnm/html/NMSettingConnection.html | 1246 ++++ docs/libnm/html/NMSettingDcb.html | 1140 ++++ docs/libnm/html/NMSettingGeneric.html | 119 + docs/libnm/html/NMSettingGsm.html | 521 ++ docs/libnm/html/NMSettingIP4Config.html | 251 + docs/libnm/html/NMSettingIP6Config.html | 316 + docs/libnm/html/NMSettingIPConfig.html | 2580 ++++++++ docs/libnm/html/NMSettingInfiniband.html | 391 ++ docs/libnm/html/NMSettingOlpcMesh.html | 213 + docs/libnm/html/NMSettingPpp.html | 905 +++ docs/libnm/html/NMSettingPppoe.html | 297 + docs/libnm/html/NMSettingSerial.html | 381 ++ docs/libnm/html/NMSettingTeam.html | 168 + docs/libnm/html/NMSettingTeamPort.html | 168 + docs/libnm/html/NMSettingVlan.html | 727 +++ docs/libnm/html/NMSettingVpn.html | 682 ++ docs/libnm/html/NMSettingWimax.html | 217 + docs/libnm/html/NMSettingWired.html | 1015 +++ docs/libnm/html/NMSettingWireless.html | 1053 ++++ docs/libnm/html/NMSettingWirelessSecurity.html | 1450 +++++ docs/libnm/html/NMSimpleConnection.html | 175 + docs/libnm/html/NMVpnConnection.html | 233 + docs/libnm/html/NMWimaxNsp.html | 357 ++ docs/libnm/html/annotation-glossary.html | 77 + docs/libnm/html/api-index-full.html | 7247 ++++++++++++++++++++++ docs/libnm/html/ch02.html | 47 + docs/libnm/html/ch03.html | 126 + docs/libnm/html/ch04.html | 95 + docs/libnm/html/ch05.html | 38 + docs/libnm/html/ch06.html | 38 + docs/libnm/html/home.png | Bin 0 -> 654 bytes docs/libnm/html/index.html | 259 + docs/libnm/html/index.sgml | 2622 ++++++++ docs/libnm/html/left.png | Bin 0 -> 459 bytes docs/libnm/html/libnm-NMConnection.html | 1868 ++++++ docs/libnm/html/libnm-NMVpnEditorPlugin.html | 382 ++ docs/libnm/html/libnm-nm-dbus-interface.html | 1806 ++++++ docs/libnm/html/libnm-nm-errors.html | 844 +++ docs/libnm/html/libnm-nm-utils.html | 2042 ++++++ docs/libnm/html/libnm-nm-version.html | 249 + docs/libnm/html/libnm-nm-vpn-dbus-interface.html | 882 +++ docs/libnm/html/libnm.devhelp2 | 2207 +++++++ docs/libnm/html/libnm.png | Bin 0 -> 82140 bytes docs/libnm/html/object-tree.html | 136 + docs/libnm/html/ref-overview.html | 48 + docs/libnm/html/right.png | Bin 0 -> 472 bytes docs/libnm/html/style.css | 266 + docs/libnm/html/up.png | Bin 0 -> 406 bytes 78 files changed, 54981 insertions(+) create mode 100644 docs/libnm/html/NMAccessPoint.html create mode 100644 docs/libnm/html/NMActiveConnection.html create mode 100644 docs/libnm/html/NMClient.html create mode 100644 docs/libnm/html/NMDevice.html create mode 100644 docs/libnm/html/NMDeviceAdsl.html create mode 100644 docs/libnm/html/NMDeviceBond.html create mode 100644 docs/libnm/html/NMDeviceBridge.html create mode 100644 docs/libnm/html/NMDeviceBt.html create mode 100644 docs/libnm/html/NMDeviceEthernet.html create mode 100644 docs/libnm/html/NMDeviceGeneric.html create mode 100644 docs/libnm/html/NMDeviceInfiniband.html create mode 100644 docs/libnm/html/NMDeviceModem.html create mode 100644 docs/libnm/html/NMDeviceOlpcMesh.html create mode 100644 docs/libnm/html/NMDeviceTeam.html create mode 100644 docs/libnm/html/NMDeviceVlan.html create mode 100644 docs/libnm/html/NMDeviceWifi.html create mode 100644 docs/libnm/html/NMDeviceWimax.html create mode 100644 docs/libnm/html/NMDhcpConfig.html create mode 100644 docs/libnm/html/NMIPConfig.html create mode 100644 docs/libnm/html/NMObject.html create mode 100644 docs/libnm/html/NMRemoteConnection.html create mode 100644 docs/libnm/html/NMSecretAgentOld.html create mode 100644 docs/libnm/html/NMSetting.html create mode 100644 docs/libnm/html/NMSetting8021x.html create mode 100644 docs/libnm/html/NMSettingAdsl.html create mode 100644 docs/libnm/html/NMSettingBluetooth.html create mode 100644 docs/libnm/html/NMSettingBond.html create mode 100644 docs/libnm/html/NMSettingBridge.html create mode 100644 docs/libnm/html/NMSettingBridgePort.html create mode 100644 docs/libnm/html/NMSettingCdma.html create mode 100644 docs/libnm/html/NMSettingConnection.html create mode 100644 docs/libnm/html/NMSettingDcb.html create mode 100644 docs/libnm/html/NMSettingGeneric.html create mode 100644 docs/libnm/html/NMSettingGsm.html create mode 100644 docs/libnm/html/NMSettingIP4Config.html create mode 100644 docs/libnm/html/NMSettingIP6Config.html create mode 100644 docs/libnm/html/NMSettingIPConfig.html create mode 100644 docs/libnm/html/NMSettingInfiniband.html create mode 100644 docs/libnm/html/NMSettingOlpcMesh.html create mode 100644 docs/libnm/html/NMSettingPpp.html create mode 100644 docs/libnm/html/NMSettingPppoe.html create mode 100644 docs/libnm/html/NMSettingSerial.html create mode 100644 docs/libnm/html/NMSettingTeam.html create mode 100644 docs/libnm/html/NMSettingTeamPort.html create mode 100644 docs/libnm/html/NMSettingVlan.html create mode 100644 docs/libnm/html/NMSettingVpn.html create mode 100644 docs/libnm/html/NMSettingWimax.html create mode 100644 docs/libnm/html/NMSettingWired.html create mode 100644 docs/libnm/html/NMSettingWireless.html create mode 100644 docs/libnm/html/NMSettingWirelessSecurity.html create mode 100644 docs/libnm/html/NMSimpleConnection.html create mode 100644 docs/libnm/html/NMVpnConnection.html create mode 100644 docs/libnm/html/NMWimaxNsp.html create mode 100644 docs/libnm/html/annotation-glossary.html create mode 100644 docs/libnm/html/api-index-full.html create mode 100644 docs/libnm/html/ch02.html create mode 100644 docs/libnm/html/ch03.html create mode 100644 docs/libnm/html/ch04.html create mode 100644 docs/libnm/html/ch05.html create mode 100644 docs/libnm/html/ch06.html create mode 100644 docs/libnm/html/home.png create mode 100644 docs/libnm/html/index.html create mode 100644 docs/libnm/html/index.sgml create mode 100644 docs/libnm/html/left.png create mode 100644 docs/libnm/html/libnm-NMConnection.html create mode 100644 docs/libnm/html/libnm-NMVpnEditorPlugin.html create mode 100644 docs/libnm/html/libnm-nm-dbus-interface.html create mode 100644 docs/libnm/html/libnm-nm-errors.html create mode 100644 docs/libnm/html/libnm-nm-utils.html create mode 100644 docs/libnm/html/libnm-nm-version.html create mode 100644 docs/libnm/html/libnm-nm-vpn-dbus-interface.html create mode 100644 docs/libnm/html/libnm.devhelp2 create mode 100644 docs/libnm/html/libnm.png create mode 100644 docs/libnm/html/object-tree.html create mode 100644 docs/libnm/html/ref-overview.html create mode 100644 docs/libnm/html/right.png create mode 100644 docs/libnm/html/style.css create mode 100644 docs/libnm/html/up.png (limited to 'docs/libnm/html') diff --git a/docs/libnm/html/NMAccessPoint.html b/docs/libnm/html/NMAccessPoint.html new file mode 100644 index 00000000..9b21cae9 --- /dev/null +++ b/docs/libnm/html/NMAccessPoint.html @@ -0,0 +1,613 @@ + + + + +NMAccessPoint + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMAccessPoint

+

NMAccessPoint

+
+
+

Synopsis

+
#define             NM_ACCESS_POINT_FLAGS
+#define             NM_ACCESS_POINT_WPA_FLAGS
+#define             NM_ACCESS_POINT_RSN_FLAGS
+#define             NM_ACCESS_POINT_SSID
+#define             NM_ACCESS_POINT_BSSID
+#define             NM_ACCESS_POINT_FREQUENCY
+#define             NM_ACCESS_POINT_MODE
+#define             NM_ACCESS_POINT_MAX_BITRATE
+#define             NM_ACCESS_POINT_STRENGTH
+#define             NM_ACCESS_POINT_HW_ADDRESS
+struct              NMAccessPoint;
+                    NMAccessPointClass;
+NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
+NM80211ApSecurityFlags nm_access_point_get_wpa_flags    (NMAccessPoint *ap);
+NM80211ApSecurityFlags nm_access_point_get_rsn_flags    (NMAccessPoint *ap);
+GBytes *            nm_access_point_get_ssid            (NMAccessPoint *ap);
+const char *        nm_access_point_get_bssid           (NMAccessPoint *ap);
+guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
+NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
+guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
+guint8              nm_access_point_get_strength        (NMAccessPoint *ap);
+GPtrArray *         nm_access_point_filter_connections  (NMAccessPoint *ap,
+                                                         const GPtrArray *connections);
+gboolean            nm_access_point_connection_valid    (NMAccessPoint *ap,
+                                                         NMConnection *connection);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMAccessPoint
+
+
+
+

Implemented Interfaces

+

+NMAccessPoint implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "bssid"                    gchar*                : Read
+  "flags"                    NM80211ApFlags        : Read
+  "frequency"                guint                 : Read
+  "hw-address"               gchar*                : Read
+  "max-bitrate"              guint                 : Read
+  "mode"                     NM80211Mode           : Read
+  "rsn-flags"                NM80211ApSecurityFlags  : Read
+  "ssid"                     GBytes*               : Read
+  "strength"                 guchar                : Read
+  "wpa-flags"                NM80211ApSecurityFlags  : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_ACCESS_POINT_FLAGS

+
#define NM_ACCESS_POINT_FLAGS       "flags"
+
+

+

+
+
+
+

NM_ACCESS_POINT_WPA_FLAGS

+
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
+
+

+

+
+
+
+

NM_ACCESS_POINT_RSN_FLAGS

+
#define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
+
+

+

+
+
+
+

NM_ACCESS_POINT_SSID

+
#define NM_ACCESS_POINT_SSID        "ssid"
+
+

+

+
+
+
+

NM_ACCESS_POINT_BSSID

+
#define NM_ACCESS_POINT_BSSID       "bssid"
+
+

+

+
+
+
+

NM_ACCESS_POINT_FREQUENCY

+
#define NM_ACCESS_POINT_FREQUENCY   "frequency"
+
+

+

+
+
+
+

NM_ACCESS_POINT_MODE

+
#define NM_ACCESS_POINT_MODE        "mode"
+
+

+

+
+
+
+

NM_ACCESS_POINT_MAX_BITRATE

+
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
+
+

+

+
+
+
+

NM_ACCESS_POINT_STRENGTH

+
#define NM_ACCESS_POINT_STRENGTH    "strength"
+
+

+

+
+
+
+

NM_ACCESS_POINT_HW_ADDRESS

+
#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

struct NMAccessPoint

+
struct NMAccessPoint;
+

+

+
+
+
+

NMAccessPointClass

+
typedef struct {
+	NMObjectClass parent;
+} NMAccessPointClass;
+
+

+

+
+
+
+

nm_access_point_get_flags ()

+
NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
+

+Gets the flags of the access point. +

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

ap :

a NMAccessPoint +

Returns :

the flags
+
+
+
+

nm_access_point_get_wpa_flags ()

+
NM80211ApSecurityFlags nm_access_point_get_wpa_flags    (NMAccessPoint *ap);
+

+Gets the WPA (version 1) flags of the access point. +

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

ap :

a NMAccessPoint +

Returns :

the WPA flags
+
+
+
+

nm_access_point_get_rsn_flags ()

+
NM80211ApSecurityFlags nm_access_point_get_rsn_flags    (NMAccessPoint *ap);
+

+Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access +point. +

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

ap :

a NMAccessPoint +

Returns :

the RSN flags
+
+
+
+

nm_access_point_get_ssid ()

+
GBytes *            nm_access_point_get_ssid            (NMAccessPoint *ap);
+

+Gets the SSID of the access point. +

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

ap :

a NMAccessPoint +

Returns :

the GBytes containing the SSID, or NULL if the +SSID is unknown. [transfer none] +
+
+
+
+

nm_access_point_get_bssid ()

+
const char *        nm_access_point_get_bssid           (NMAccessPoint *ap);
+

+Gets the Basic Service Set ID (BSSID) of the Wi-Fi access point. +

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

ap :

a NMAccessPoint +

Returns :

the BSSID of the access point. This is an internal string and must +not be modified or freed.
+
+
+
+

nm_access_point_get_frequency ()

+
guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
+

+Gets the frequency of the access point. +

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

ap :

a NMAccessPoint +

Returns :

the frequency
+
+
+
+

nm_access_point_get_mode ()

+
NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
+

+Gets the mode of the access point. +

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

ap :

a NMAccessPoint +

Returns :

the mode
+
+
+
+

nm_access_point_get_max_bitrate ()

+
guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
+

+Gets the maximum bit rate of the access point in kbit/s. +

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

ap :

a NMAccessPoint +

Returns :

the maximum bit rate (kbit/s)
+
+
+
+

nm_access_point_get_strength ()

+
guint8              nm_access_point_get_strength        (NMAccessPoint *ap);
+

+Gets the current signal strength of the access point. +

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

ap :

a NMAccessPoint +

Returns :

the signal strength
+
+
+
+

nm_access_point_filter_connections ()

+
GPtrArray *         nm_access_point_filter_connections  (NMAccessPoint *ap,
+                                                         const GPtrArray *connections);
+

+Filters a given array of connections for a given NMAccessPoint object and +returns connections which may be activated with the access point. Any +returned connections will match the ap's SSID and (if given) BSSID and +other attributes like security settings, channel, etc. +

+

+To obtain the list of connections that are compatible with this access point, +use nm_client_get_connections() and then filter the returned list for a given +NMDevice using nm_device_filter_connections() and finally filter that list +with this function. +

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

ap :

an NMAccessPoint to filter connections for

connections :

an array of NMConnections to +filter. [element-type NMConnection] +

Returns :

an array of +NMConnections that could be activated with the given ap. The array should +be freed with g_ptr_array_unref() when it is no longer required. [transfer container][element-type NMConnection] +
+
+
+
+

nm_access_point_connection_valid ()

+
gboolean            nm_access_point_connection_valid    (NMAccessPoint *ap,
+                                                         NMConnection *connection);
+

+Validates a given connection against a given Wi-Fi access point to ensure that +the connection may be activated with that AP. The connection must match the +ap's SSID, (if given) BSSID, and other attributes like security settings, +channel, band, etc. +

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

ap :

an NMAccessPoint to validate connection against

connection :

an NMConnection to validate against ap +

Returns :

 +TRUE if the connection may be activated with this Wi-Fi AP, +FALSE if it cannot be.
+
+
+
+

Property Details

+
+

The "bssid" property

+
  "bssid"                    gchar*                : Read
+

+The BSSID of the access point. +

+

Default value: NULL

+
+
+
+

The "flags" property

+
  "flags"                    NM80211ApFlags        : Read
+

+The flags of the access point. +

+
+
+
+

The "frequency" property

+
  "frequency"                guint                 : Read
+

+The frequency of the access point. +

+

Allowed values: <= 10000

+

Default value: 0

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+
+

Warning

+

NMAccessPoint:hw-address has been deprecated since version 1.0 and should not be used in newly-written code. use "bssid".

+
+

+Alias for "bssid". +

+

Default value: NULL

+
+
+
+

The "max-bitrate" property

+
  "max-bitrate"              guint                 : Read
+

+The maximum bit rate of the access point in kbit/s. +

+

Default value: 0

+
+
+
+

The "mode" property

+
  "mode"                     NM80211Mode           : Read
+

+The mode of the access point; either "infrastructure" (a central +coordinator of the wireless network allowing clients to connect) or +"ad-hoc" (a network with no central controller). +

+

Default value: NM_802_11_MODE_INFRA

+
+
+
+

The "rsn-flags" property

+
  "rsn-flags"                NM80211ApSecurityFlags  : Read
+

+The RSN flags of the access point. +

+
+
+
+

The "ssid" property

+
  "ssid"                     GBytes*               : Read
+

+The SSID of the access point, or NULL if it is not known. +

+
+
+
+

The "strength" property

+
  "strength"                 guchar                : Read
+

+The current signal strength of the access point. +

+

Default value: 0

+
+
+
+

The "wpa-flags" property

+
  "wpa-flags"                NM80211ApSecurityFlags  : Read
+

+The WPA flags of the access point. +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMActiveConnection.html b/docs/libnm/html/NMActiveConnection.html new file mode 100644 index 00000000..15ac0158 --- /dev/null +++ b/docs/libnm/html/NMActiveConnection.html @@ -0,0 +1,816 @@ + + + + +NMActiveConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMActiveConnection

+

NMActiveConnection

+
+
+

Synopsis

+
#define             NM_ACTIVE_CONNECTION_CONNECTION
+#define             NM_ACTIVE_CONNECTION_ID
+#define             NM_ACTIVE_CONNECTION_UUID
+#define             NM_ACTIVE_CONNECTION_TYPE
+#define             NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH
+#define             NM_ACTIVE_CONNECTION_DEVICES
+#define             NM_ACTIVE_CONNECTION_STATE
+#define             NM_ACTIVE_CONNECTION_DEFAULT
+#define             NM_ACTIVE_CONNECTION_IP4_CONFIG
+#define             NM_ACTIVE_CONNECTION_DHCP4_CONFIG
+#define             NM_ACTIVE_CONNECTION_DEFAULT6
+#define             NM_ACTIVE_CONNECTION_IP6_CONFIG
+#define             NM_ACTIVE_CONNECTION_DHCP6_CONFIG
+#define             NM_ACTIVE_CONNECTION_VPN
+#define             NM_ACTIVE_CONNECTION_MASTER
+struct              NMActiveConnection;
+                    NMActiveConnectionClass;
+NMRemoteConnection * nm_active_connection_get_connection
+                                                        (NMActiveConnection *connection);
+const char *        nm_active_connection_get_id         (NMActiveConnection *connection);
+const char *        nm_active_connection_get_uuid       (NMActiveConnection *connection);
+const char *        nm_active_connection_get_connection_type
+                                                        (NMActiveConnection *connection);
+const char *        nm_active_connection_get_specific_object_path
+                                                        (NMActiveConnection *connection);
+const GPtrArray *   nm_active_connection_get_devices    (NMActiveConnection *connection);
+NMActiveConnectionState nm_active_connection_get_state  (NMActiveConnection *connection);
+NMDevice *          nm_active_connection_get_master     (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
+NMIPConfig *        nm_active_connection_get_ip4_config (NMActiveConnection *connection);
+NMDhcpConfig *      nm_active_connection_get_dhcp4_config
+                                                        (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
+NMIPConfig *        nm_active_connection_get_ip6_config (NMActiveConnection *connection);
+NMDhcpConfig *      nm_active_connection_get_dhcp6_config
+                                                        (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_vpn        (NMActiveConnection *connection);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMActiveConnection
+               +----NMVpnConnection
+
+
+
+

Implemented Interfaces

+

+NMActiveConnection implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "connection"               NMRemoteConnection*   : Read
+  "default"                  gboolean              : Read
+  "default6"                 gboolean              : Read
+  "devices"                  GPtrArray*            : Read
+  "dhcp4-config"             NMDhcpConfig*         : Read
+  "dhcp6-config"             NMDhcpConfig*         : Read
+  "id"                       gchar*                : Read
+  "ip4-config"               NMIPConfig*           : Read
+  "ip6-config"               NMIPConfig*           : Read
+  "master"                   NMDevice*             : Read
+  "specific-object-path"     gchar*                : Read
+  "state"                    NMActiveConnectionState  : Read
+  "type"                     gchar*                : Read
+  "uuid"                     gchar*                : Read
+  "vpn"                      gboolean              : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_ACTIVE_CONNECTION_CONNECTION

+
#define NM_ACTIVE_CONNECTION_CONNECTION           "connection"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_ID

+
#define NM_ACTIVE_CONNECTION_ID                   "id"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_UUID

+
#define NM_ACTIVE_CONNECTION_UUID                 "uuid"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_TYPE

+
#define NM_ACTIVE_CONNECTION_TYPE                 "type"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH

+
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH "specific-object-path"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEVICES

+
#define NM_ACTIVE_CONNECTION_DEVICES              "devices"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_STATE

+
#define NM_ACTIVE_CONNECTION_STATE                "state"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEFAULT

+
#define NM_ACTIVE_CONNECTION_DEFAULT              "default"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_IP4_CONFIG

+
#define NM_ACTIVE_CONNECTION_IP4_CONFIG           "ip4-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DHCP4_CONFIG

+
#define NM_ACTIVE_CONNECTION_DHCP4_CONFIG         "dhcp4-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEFAULT6

+
#define NM_ACTIVE_CONNECTION_DEFAULT6             "default6"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_IP6_CONFIG

+
#define NM_ACTIVE_CONNECTION_IP6_CONFIG           "ip6-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DHCP6_CONFIG

+
#define NM_ACTIVE_CONNECTION_DHCP6_CONFIG         "dhcp6-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_VPN

+
#define NM_ACTIVE_CONNECTION_VPN                  "vpn"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_MASTER

+
#define NM_ACTIVE_CONNECTION_MASTER               "master"
+
+

+

+
+
+
+

struct NMActiveConnection

+
struct NMActiveConnection;
+

+

+
+
+
+

NMActiveConnectionClass

+
typedef struct {
+	NMObjectClass parent;
+} NMActiveConnectionClass;
+
+

+

+
+
+
+

nm_active_connection_get_connection ()

+
NMRemoteConnection * nm_active_connection_get_connection
+                                                        (NMActiveConnection *connection);
+

+Gets the NMRemoteConnection associated with connection. +

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

connection :

a NMActiveConnection +

Returns :

the NMRemoteConnection which this +NMActiveConnection is an active instance of. [transfer none] +
+
+
+
+

nm_active_connection_get_id ()

+
const char *        nm_active_connection_get_id         (NMActiveConnection *connection);
+

+Gets the NMConnection's ID. +

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

connection :

a NMActiveConnection +

Returns :

the ID of the NMConnection that backs the NMActiveConnection. +This is the internal string used by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_uuid ()

+
const char *        nm_active_connection_get_uuid       (NMActiveConnection *connection);
+

+Gets the NMConnection's UUID. +

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

connection :

a NMActiveConnection +

Returns :

the UUID of the NMConnection that backs the NMActiveConnection. +This is the internal string used by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_connection_type ()

+
const char *        nm_active_connection_get_connection_type
+                                                        (NMActiveConnection *connection);
+

+Gets the NMConnection's type. +

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

connection :

a NMActiveConnection +

Returns :

the type of the NMConnection that backs the NMActiveConnection. +This is the internal string used by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_specific_object_path ()

+
const char *        nm_active_connection_get_specific_object_path
+                                                        (NMActiveConnection *connection);
+

+Gets the path of the "specific object" used at activation. +

+

+Currently there is no single method that will allow you to automatically turn +this into an appropriate NMObject; you need to know what kind of object it +is based on other information. (Eg, if connection corresponds to a Wi-Fi +connection, then the specific object will be an NMAccessPoint, and you can +resolve it with nm_device_wifi_get_access_point_by_path().) +

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

connection :

a NMActiveConnection +

Returns :

the specific object's D-Bus path. This is the internal string used +by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_devices ()

+
const GPtrArray *   nm_active_connection_get_devices    (NMActiveConnection *connection);
+

+Gets the NMDevices used for the active connections. +

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

connection :

a NMActiveConnection +

Returns :

the GPtrArray containing NMDevices. +This is the internal copy used by the connection, and must not be modified. [element-type NMDevice] +
+
+
+
+

nm_active_connection_get_state ()

+
NMActiveConnectionState nm_active_connection_get_state  (NMActiveConnection *connection);
+

+Gets the active connection's state. +

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

connection :

a NMActiveConnection +

Returns :

the state
+
+
+
+

nm_active_connection_get_master ()

+
NMDevice *          nm_active_connection_get_master     (NMActiveConnection *connection);
+

+Gets the master NMDevice of the connection. +

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

connection :

a NMActiveConnection +

Returns :

the master NMDevice of the NMActiveConnection. [transfer none] +
+
+
+
+

nm_active_connection_get_default ()

+
gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
+

+Whether the active connection is the default IPv4 one (that is, is used for +the default IPv4 route and DNS information). +

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

connection :

a NMActiveConnection +

Returns :

 +TRUE if the active connection is the default IPv4 connection
+
+
+
+

nm_active_connection_get_ip4_config ()

+
NMIPConfig *        nm_active_connection_get_ip4_config (NMActiveConnection *connection);
+

+Gets the current IPv4 NMIPConfig associated with the NMActiveConnection. +

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

connection :

an NMActiveConnection +

Returns :

the IPv4 NMIPConfig, or NULL if the connection is +not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. [transfer none] +
+
+
+
+

nm_active_connection_get_dhcp4_config ()

+
NMDhcpConfig *      nm_active_connection_get_dhcp4_config
+                                                        (NMActiveConnection *connection);
+

+Gets the current IPv4 NMDhcpConfig (if any) associated with the +NMActiveConnection. +

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

connection :

an NMActiveConnection +

Returns :

the IPv4 NMDhcpConfig, or NULL if the connection +does not use DHCP, or is not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED +state. [transfer none] +
+
+
+
+

nm_active_connection_get_default6 ()

+
gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
+

+Whether the active connection is the default IPv6 one (that is, is used for +the default IPv6 route and DNS information). +

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

connection :

a NMActiveConnection +

Returns :

 +TRUE if the active connection is the default IPv6 connection
+
+
+
+

nm_active_connection_get_ip6_config ()

+
NMIPConfig *        nm_active_connection_get_ip6_config (NMActiveConnection *connection);
+

+Gets the current IPv6 NMIPConfig associated with the NMActiveConnection. +

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

connection :

an NMActiveConnection +

Returns :

the IPv6 NMIPConfig, or NULL if the connection is +not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. [transfer none] +
+
+
+
+

nm_active_connection_get_dhcp6_config ()

+
NMDhcpConfig *      nm_active_connection_get_dhcp6_config
+                                                        (NMActiveConnection *connection);
+

+Gets the current IPv6 NMDhcpConfig (if any) associated with the +NMActiveConnection. +

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

connection :

an NMActiveConnection +

Returns :

the IPv6 NMDhcpConfig, or NULL if the connection +does not use DHCPv6, or is not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED +state. [transfer none] +
+
+
+
+

nm_active_connection_get_vpn ()

+
gboolean            nm_active_connection_get_vpn        (NMActiveConnection *connection);
+

+Whether the active connection is a VPN connection. +

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

connection :

a NMActiveConnection +

Returns :

 +TRUE if the active connection is a VPN connection
+
+
+
+

Property Details

+
+

The "connection" property

+
  "connection"               NMRemoteConnection*   : Read
+

+The connection that this is an active instance of. +

+
+
+
+

The "default" property

+
  "default"                  gboolean              : Read
+

+Whether the active connection is the default IPv4 one. +

+

Default value: FALSE

+
+
+
+

The "default6" property

+
  "default6"                 gboolean              : Read
+

+Whether the active connection is the default IPv6 one. +

+

Default value: FALSE

+
+
+
+

The "devices" property

+
  "devices"                  GPtrArray*            : Read
+

+The devices of the active connection. +

+

+Element-type: NMDevice +

+
+
+
+

The "dhcp4-config" property

+
  "dhcp4-config"             NMDhcpConfig*         : Read
+

+The IPv4 NMDhcpConfig of the connection. +

+
+
+
+

The "dhcp6-config" property

+
  "dhcp6-config"             NMDhcpConfig*         : Read
+

+The IPv6 NMDhcpConfig of the connection. +

+
+
+
+

The "id" property

+
  "id"                       gchar*                : Read
+

+The active connection's ID +

+

Default value: NULL

+
+
+
+

The "ip4-config" property

+
  "ip4-config"               NMIPConfig*           : Read
+

+The IPv4 NMIPConfig of the connection. +

+
+
+
+

The "ip6-config" property

+
  "ip6-config"               NMIPConfig*           : Read
+

+The IPv6 NMIPConfig of the connection. +

+
+
+
+

The "master" property

+
  "master"                   NMDevice*             : Read
+

+The master device if one exists. +

+
+
+
+

The "specific-object-path" property

+
  "specific-object-path"     gchar*                : Read
+

+The path to the "specific object" of the active connection; see +nm_active_connection_get_specific_object_path() for more details. +

+

Default value: NULL

+
+
+
+

The "state" property

+
  "state"                    NMActiveConnectionState  : Read
+

+The state of the active connection. +

+

Default value: NM_ACTIVE_CONNECTION_STATE_UNKNOWN

+
+
+
+

The "type" property

+
  "type"                     gchar*                : Read
+

+The active connection's type +

+

Default value: NULL

+
+
+
+

The "uuid" property

+
  "uuid"                     gchar*                : Read
+

+The active connection's UUID +

+

Default value: NULL

+
+
+
+

The "vpn" property

+
  "vpn"                      gboolean              : Read
+

+Whether the active connection is a VPN connection. +

+

Default value: FALSE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html new file mode 100644 index 00000000..604d0330 --- /dev/null +++ b/docs/libnm/html/NMClient.html @@ -0,0 +1,3059 @@ + + + + +NMClient + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMClient

+

NMClient

+
+
+

Synopsis

+
#define             NM_CLIENT_VERSION
+#define             NM_CLIENT_STATE
+#define             NM_CLIENT_STARTUP
+#define             NM_CLIENT_NM_RUNNING
+#define             NM_CLIENT_NETWORKING_ENABLED
+#define             NM_CLIENT_WIRELESS_ENABLED
+#define             NM_CLIENT_WIRELESS_HARDWARE_ENABLED
+#define             NM_CLIENT_WWAN_ENABLED
+#define             NM_CLIENT_WWAN_HARDWARE_ENABLED
+#define             NM_CLIENT_WIMAX_ENABLED
+#define             NM_CLIENT_WIMAX_HARDWARE_ENABLED
+#define             NM_CLIENT_ACTIVE_CONNECTIONS
+#define             NM_CLIENT_CONNECTIVITY
+#define             NM_CLIENT_PRIMARY_CONNECTION
+#define             NM_CLIENT_ACTIVATING_CONNECTION
+#define             NM_CLIENT_DEVICES
+#define             NM_CLIENT_CONNECTIONS
+#define             NM_CLIENT_HOSTNAME
+#define             NM_CLIENT_CAN_MODIFY
+#define             NM_CLIENT_DEVICE_ADDED
+#define             NM_CLIENT_DEVICE_REMOVED
+#define             NM_CLIENT_PERMISSION_CHANGED
+#define             NM_CLIENT_CONNECTION_ADDED
+#define             NM_CLIENT_CONNECTION_REMOVED
+enum                NMClientPermission;
+enum                NMClientPermissionResult;
+enum                NMClientError;
+#define             NM_CLIENT_ERROR
+GQuark              nm_client_error_quark               (void);
+struct              NMClient;
+                    NMClientClass;
+NMClient *          nm_client_new                       (GCancellable *cancellable,
+                                                         GError **error);
+void                nm_client_new_async                 (GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+NMClient *          nm_client_new_finish                (GAsyncResult *result,
+                                                         GError **error);
+const char *        nm_client_get_version               (NMClient *client);
+NMState             nm_client_get_state                 (NMClient *client);
+gboolean            nm_client_get_startup               (NMClient *client);
+gboolean            nm_client_get_nm_running            (NMClient *client);
+gboolean            nm_client_networking_get_enabled    (NMClient *client);
+gboolean            nm_client_networking_set_enabled    (NMClient *client,
+                                                         gboolean enabled,
+                                                         GError **error);
+gboolean            nm_client_wireless_get_enabled      (NMClient *client);
+void                nm_client_wireless_set_enabled      (NMClient *client,
+                                                         gboolean enabled);
+gboolean            nm_client_wireless_hardware_get_enabled
+                                                        (NMClient *client);
+gboolean            nm_client_wwan_get_enabled          (NMClient *client);
+void                nm_client_wwan_set_enabled          (NMClient *client,
+                                                         gboolean enabled);
+gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
+gboolean            nm_client_wimax_get_enabled         (NMClient *client);
+void                nm_client_wimax_set_enabled         (NMClient *client,
+                                                         gboolean enabled);
+gboolean            nm_client_wimax_hardware_get_enabled
+                                                        (NMClient *client);
+gboolean            nm_client_get_logging               (NMClient *client,
+                                                         char **level,
+                                                         char **domains,
+                                                         GError **error);
+gboolean            nm_client_set_logging               (NMClient *client,
+                                                         const char *level,
+                                                         const char *domains,
+                                                         GError **error);
+NMClientPermissionResult nm_client_get_permission_result
+                                                        (NMClient *client,
+                                                         NMClientPermission permission);
+NMConnectivityState nm_client_get_connectivity          (NMClient *client);
+NMConnectivityState nm_client_check_connectivity        (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_client_check_connectivity_async  (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+NMConnectivityState nm_client_check_connectivity_finish (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_client_save_hostname             (NMClient *client,
+                                                         const char *hostname,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_client_save_hostname_async       (NMClient *client,
+                                                         const char *hostname,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_client_save_hostname_finish      (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+const GPtrArray *   nm_client_get_devices               (NMClient *client);
+NMDevice *          nm_client_get_device_by_path        (NMClient *client,
+                                                         const char *object_path);
+NMDevice *          nm_client_get_device_by_iface       (NMClient *client,
+                                                         const char *iface);
+const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
+NMActiveConnection * nm_client_get_primary_connection   (NMClient *client);
+NMActiveConnection * nm_client_get_activating_connection
+                                                        (NMClient *client);
+void                nm_client_activate_connection_async (NMClient *client,
+                                                         NMConnection *connection,
+                                                         NMDevice *device,
+                                                         const char *specific_object,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+NMActiveConnection * nm_client_activate_connection_finish
+                                                        (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+void                nm_client_add_and_activate_connection_async
+                                                        (NMClient *client,
+                                                         NMConnection *partial,
+                                                         NMDevice *device,
+                                                         const char *specific_object,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+NMActiveConnection * nm_client_add_and_activate_connection_finish
+                                                        (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_client_deactivate_connection     (NMClient *client,
+                                                         NMActiveConnection *active,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_client_deactivate_connection_async
+                                                        (NMClient *client,
+                                                         NMActiveConnection *active,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_client_deactivate_connection_finish
+                                                        (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+const GPtrArray *   nm_client_get_connections           (NMClient *client);
+NMRemoteConnection * nm_client_get_connection_by_id     (NMClient *client,
+                                                         const char *id);
+NMRemoteConnection * nm_client_get_connection_by_path   (NMClient *client,
+                                                         const char *path);
+NMRemoteConnection * nm_client_get_connection_by_uuid   (NMClient *client,
+                                                         const char *uuid);
+void                nm_client_add_connection_async      (NMClient *client,
+                                                         NMConnection *connection,
+                                                         gboolean save_to_disk,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+NMRemoteConnection * nm_client_add_connection_finish    (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_client_load_connections          (NMClient *client,
+                                                         char **filenames,
+                                                         char ***failures,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_client_load_connections_async    (NMClient *client,
+                                                         char **filenames,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_client_load_connections_finish   (NMClient *client,
+                                                         char ***failures,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_client_reload_connections        (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_client_reload_connections_async  (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_client_reload_connections_finish (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMClientPermission
+
+
+  GEnum
+   +----NMClientPermissionResult
+
+
+  GEnum
+   +----NMClientError
+
+
+  GObject
+   +----NMClient
+
+
+
+

Implemented Interfaces

+

+NMClient implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "activating-connection"    NMActiveConnection*   : Read
+  "active-connections"       GPtrArray*            : Read
+  "can-modify"               gboolean              : Read
+  "connections"              GPtrArray*            : Read
+  "connectivity"             NMConnectivityState   : Read
+  "devices"                  GPtrArray*            : Read
+  "hostname"                 gchar*                : Read
+  "networking-enabled"       gboolean              : Read / Write
+  "nm-running"               gboolean              : Read
+  "primary-connection"       NMActiveConnection*   : Read
+  "startup"                  gboolean              : Read
+  "state"                    NMState               : Read
+  "version"                  gchar*                : Read
+  "wimax-enabled"            gboolean              : Read / Write
+  "wimax-hardware-enabled"   gboolean              : Read
+  "wireless-enabled"         gboolean              : Read / Write
+  "wireless-hardware-enabled" gboolean              : Read
+  "wwan-enabled"             gboolean              : Read / Write
+  "wwan-hardware-enabled"    gboolean              : Read
+
+
+
+

Signals

+
+  "connection-added"                               : Run First
+  "connection-removed"                             : Run First
+  "device-added"                                   : Run First
+  "device-removed"                                 : Run First
+  "permission-changed"                             : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_CLIENT_VERSION

+
#define NM_CLIENT_VERSION "version"
+
+

+

+
+
+
+

NM_CLIENT_STATE

+
#define NM_CLIENT_STATE "state"
+
+

+

+
+
+
+

NM_CLIENT_STARTUP

+
#define NM_CLIENT_STARTUP "startup"
+
+

+

+
+
+
+

NM_CLIENT_NM_RUNNING

+
#define NM_CLIENT_NM_RUNNING "nm-running"
+
+

+

+
+
+
+

NM_CLIENT_NETWORKING_ENABLED

+
#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WIRELESS_ENABLED

+
#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

+
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WWAN_ENABLED

+
#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WWAN_HARDWARE_ENABLED

+
#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WIMAX_ENABLED

+
#define NM_CLIENT_WIMAX_ENABLED "wimax-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WIMAX_HARDWARE_ENABLED

+
#define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled"
+
+

+

+
+
+
+

NM_CLIENT_ACTIVE_CONNECTIONS

+
#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
+
+

+

+
+
+
+

NM_CLIENT_CONNECTIVITY

+
#define NM_CLIENT_CONNECTIVITY "connectivity"
+
+

+

+
+
+
+

NM_CLIENT_PRIMARY_CONNECTION

+
#define NM_CLIENT_PRIMARY_CONNECTION "primary-connection"
+
+

+

+
+
+
+

NM_CLIENT_ACTIVATING_CONNECTION

+
#define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection"
+
+

+

+
+
+
+

NM_CLIENT_DEVICES

+
#define NM_CLIENT_DEVICES "devices"
+
+

+

+
+
+
+

NM_CLIENT_CONNECTIONS

+
#define NM_CLIENT_CONNECTIONS "connections"
+
+

+

+
+
+
+

NM_CLIENT_HOSTNAME

+
#define NM_CLIENT_HOSTNAME "hostname"
+
+

+

+
+
+
+

NM_CLIENT_CAN_MODIFY

+
#define NM_CLIENT_CAN_MODIFY "can-modify"
+
+

+

+
+
+
+

NM_CLIENT_DEVICE_ADDED

+
#define NM_CLIENT_DEVICE_ADDED "device-added"
+
+

+

+
+
+
+

NM_CLIENT_DEVICE_REMOVED

+
#define NM_CLIENT_DEVICE_REMOVED "device-removed"
+
+

+

+
+
+
+

NM_CLIENT_PERMISSION_CHANGED

+
#define NM_CLIENT_PERMISSION_CHANGED "permission-changed"
+
+

+

+
+
+
+

NM_CLIENT_CONNECTION_ADDED

+
#define NM_CLIENT_CONNECTION_ADDED "connection-added"
+
+

+

+
+
+
+

NM_CLIENT_CONNECTION_REMOVED

+
#define NM_CLIENT_CONNECTION_REMOVED "connection-removed"
+
+

+

+
+
+
+

enum NMClientPermission

+
typedef enum {
+	NM_CLIENT_PERMISSION_NONE = 0,
+	NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK = 1,
+	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI = 2,
+	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN = 3,
+	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX = 4,
+	NM_CLIENT_PERMISSION_SLEEP_WAKE = 5,
+	NM_CLIENT_PERMISSION_NETWORK_CONTROL = 6,
+	NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED = 7,
+	NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN = 8,
+	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM = 9,
+	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN = 10,
+	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME = 11,
+
+	NM_CLIENT_PERMISSION_LAST = NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME
+} NMClientPermission;
+
+

+NMClientPermission values indicate various permissions that NetworkManager +clients can obtain to perform certain tasks on behalf of the current user. +

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

NM_CLIENT_PERMISSION_NONE

unknown or no permission +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK

controls whether networking + can be globally enabled or disabled +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI

controls whether Wi-Fi can be + globally enabled or disabled +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN

controls whether WWAN (3G) can be + globally enabled or disabled +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX

controls whether WiMAX can be + globally enabled or disabled +

NM_CLIENT_PERMISSION_SLEEP_WAKE

controls whether the client can ask + NetworkManager to sleep and wake +

NM_CLIENT_PERMISSION_NETWORK_CONTROL

controls whether networking connections + can be started, stopped, and changed +

NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED

controls whether a password + protected Wi-Fi hotspot can be created +

NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN

controls whether an open Wi-Fi hotspot + can be created +

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM

controls whether connections + that are available to all users can be modified +

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN

controls whether connections + owned by the current user can be modified +

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME

controls whether the + persistent hostname can be changed +

NM_CLIENT_PERMISSION_LAST

a reserved boundary value +
+
+
+
+

enum NMClientPermissionResult

+
typedef enum {
+	NM_CLIENT_PERMISSION_RESULT_UNKNOWN = 0,
+	NM_CLIENT_PERMISSION_RESULT_YES,
+	NM_CLIENT_PERMISSION_RESULT_AUTH,
+	NM_CLIENT_PERMISSION_RESULT_NO
+} NMClientPermissionResult;
+
+

+NMClientPermissionResult values indicate what authorizations and permissions +the user requires to obtain a given NMClientPermission +

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

NM_CLIENT_PERMISSION_RESULT_UNKNOWN

unknown or no authorization +

NM_CLIENT_PERMISSION_RESULT_YES

the permission is available +

NM_CLIENT_PERMISSION_RESULT_AUTH

authorization is necessary before the + permission is available +

NM_CLIENT_PERMISSION_RESULT_NO

permission to perform the operation is + denied by system policy +
+
+
+
+

enum NMClientError

+
typedef enum {
+	NM_CLIENT_ERROR_FAILED = 0,
+	NM_CLIENT_ERROR_MANAGER_NOT_RUNNING,
+	NM_CLIENT_ERROR_OBJECT_CREATION_FAILED,
+} NMClientError;
+
+

+Describes errors that may result from operations involving a NMClient. +

+

+D-Bus operations may also return errors from other domains, including +NMManagerError, NMSettingsError, NMAgentManagerError, and NMConnectionError. +

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

NM_CLIENT_ERROR_FAILED

unknown or unclassified error +

NM_CLIENT_ERROR_MANAGER_NOT_RUNNING

an operation that requires NetworkManager + failed because NetworkManager is not running +

NM_CLIENT_ERROR_OBJECT_CREATION_FAILED

NetworkManager claimed that an + operation succeeded, but the object that was allegedly created (eg, + NMRemoteConnection, NMActiveConnection) was apparently destroyed before + NMClient could create a representation of it. +
+
+
+
+

NM_CLIENT_ERROR

+
#define NM_CLIENT_ERROR nm_client_error_quark ()
+
+

+

+
+
+
+

nm_client_error_quark ()

+
GQuark              nm_client_error_quark               (void);
+

+Registers an error quark for NMClient if necessary. +

+
++++ + + + + +

Returns :

the error quark used for NMClient errors.
+
+
+
+

struct NMClient

+
struct NMClient;
+

+

+
+
+
+

NMClientClass

+
typedef struct {
+	GObjectClass parent;
+
+	/* Signals */
+	void (*device_added) (NMClient *client, NMDevice *device);
+	void (*device_removed) (NMClient *client, NMDevice *device);
+	void (*permission_changed) (NMClient *client,
+	                            NMClientPermission permission,
+	                            NMClientPermissionResult result);
+	void (*connection_added)   (NMClient *client, NMRemoteConnection *connection);
+	void (*connection_removed) (NMClient *client, NMRemoteConnection *connection);
+} NMClientClass;
+
+

+

+
+
+
+

nm_client_new ()

+
NMClient *          nm_client_new                       (GCancellable *cancellable,
+                                                         GError **error);
+

+Creates a new NMClient. +

+

+Note that this will do blocking D-Bus calls to initialize the +client. You can use nm_client_new_async() if you want to avoid +that. +

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

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

a new NMClient or NULL on an error
+
+
+
+

nm_client_new_async ()

+
void                nm_client_new_async                 (GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Creates a new NMClient and begins asynchronously initializing it. +callback will be called when it is done; use +nm_client_new_finish() to get the result. Note that on an error, +the callback can be invoked with two first parameters as NULL. +

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

cancellable :

a GCancellable, or NULL +

callback :

callback to call when the client is created

user_data :

data for callback +
+
+
+
+

nm_client_new_finish ()

+
NMClient *          nm_client_new_finish                (GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of an nm_client_new_async() call. +

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

result :

a GAsyncResult +

error :

location for a GError, or NULL +

Returns :

a new NMClient, or NULL on error
+
+
+
+

nm_client_get_version ()

+
const char *        nm_client_get_version               (NMClient *client);
+

+Gets NetworkManager version. +

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

client :

a NMClient +

Returns :

string with the version (or NULL if NetworkManager is not running)
+
+
+
+

nm_client_get_state ()

+
NMState             nm_client_get_state                 (NMClient *client);
+

+Gets the current daemon state. +

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

client :

a NMClient +

Returns :

the current NMState +
+
+
+
+

nm_client_get_startup ()

+
gboolean            nm_client_get_startup               (NMClient *client);
+

+Tests whether the daemon is still in the process of activating +connections at startup. +

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

client :

a NMClient +

Returns :

whether the daemon is still starting up
+
+
+
+

nm_client_get_nm_running ()

+
gboolean            nm_client_get_nm_running            (NMClient *client);
+

+Determines whether the daemon is running. +

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

client :

a NMClient +

Returns :

 +TRUE if the daemon is running
+
+
+
+

nm_client_networking_get_enabled ()

+
gboolean            nm_client_networking_get_enabled    (NMClient *client);
+

+Whether networking is enabled or disabled. +

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

client :

a NMClient +

Returns :

 +TRUE if networking is enabled, FALSE if networking is disabled
+
+
+
+

nm_client_networking_set_enabled ()

+
gboolean            nm_client_networking_set_enabled    (NMClient *client,
+                                                         gboolean enabled,
+                                                         GError **error);
+

+Enables or disables networking. When networking is disabled, all controlled +interfaces are disconnected and deactivated. When networking is enabled, +all controlled interfaces are available for activation. +

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

client :

a NMClient +

enabled :

 +TRUE to set networking enabled, FALSE to set networking disabled

error :

return location for a GError, or NULL. [allow-none] +

Returns :

 +TRUE on success, FALSE otherwise
+
+
+
+

nm_client_wireless_get_enabled ()

+
gboolean            nm_client_wireless_get_enabled      (NMClient *client);
+

+Determines whether the wireless is enabled. +

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

client :

a NMClient +

Returns :

 +TRUE if wireless is enabled
+
+
+
+

nm_client_wireless_set_enabled ()

+
void                nm_client_wireless_set_enabled      (NMClient *client,
+                                                         gboolean enabled);
+

+Enables or disables wireless devices. +

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

client :

a NMClient +

enabled :

 +TRUE to enable wireless
+
+
+
+

nm_client_wireless_hardware_get_enabled ()

+
gboolean            nm_client_wireless_hardware_get_enabled
+                                                        (NMClient *client);
+

+Determines whether the wireless hardware is enabled. +

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

client :

a NMClient +

Returns :

 +TRUE if the wireless hardware is enabled
+
+
+
+

nm_client_wwan_get_enabled ()

+
gboolean            nm_client_wwan_get_enabled          (NMClient *client);
+

+Determines whether WWAN is enabled. +

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

client :

a NMClient +

Returns :

 +TRUE if WWAN is enabled
+
+
+
+

nm_client_wwan_set_enabled ()

+
void                nm_client_wwan_set_enabled          (NMClient *client,
+                                                         gboolean enabled);
+

+Enables or disables WWAN devices. +

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

client :

a NMClient +

enabled :

 +TRUE to enable WWAN
+
+
+
+

nm_client_wwan_hardware_get_enabled ()

+
gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
+

+Determines whether the WWAN hardware is enabled. +

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

client :

a NMClient +

Returns :

 +TRUE if the WWAN hardware is enabled
+
+
+
+

nm_client_wimax_get_enabled ()

+
gboolean            nm_client_wimax_get_enabled         (NMClient *client);
+

+Determines whether WiMAX is enabled. +

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

client :

a NMClient +

Returns :

 +TRUE if WiMAX is enabled
+
+
+
+

nm_client_wimax_set_enabled ()

+
void                nm_client_wimax_set_enabled         (NMClient *client,
+                                                         gboolean enabled);
+

+Enables or disables WiMAX devices. +

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

client :

a NMClient +

enabled :

 +TRUE to enable WiMAX
+
+
+
+

nm_client_wimax_hardware_get_enabled ()

+
gboolean            nm_client_wimax_hardware_get_enabled
+                                                        (NMClient *client);
+

+Determines whether the WiMAX hardware is enabled. +

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

client :

a NMClient +

Returns :

 +TRUE if the WiMAX hardware is enabled
+
+
+
+

nm_client_get_logging ()

+
gboolean            nm_client_get_logging               (NMClient *client,
+                                                         char **level,
+                                                         char **domains,
+                                                         GError **error);
+

+Gets NetworkManager current logging level and domains. +

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

client :

a NMClient +

level :

return location for logging level string. [allow-none] +

domains :

return location for log domains string. The string is +a list of domains separated by ",". [allow-none] +

error :

return location for a GError, or NULL. [allow-none] +

Returns :

 +TRUE on success, FALSE otherwise
+
+
+
+

nm_client_set_logging ()

+
gboolean            nm_client_set_logging               (NMClient *client,
+                                                         const char *level,
+                                                         const char *domains,
+                                                         GError **error);
+

+Sets NetworkManager logging level and/or domains. +

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

client :

a NMClient +

level :

logging level to set (NULL or an empty string for no change). [allow-none] +

domains :

logging domains to set. The string should be a list of log +domains separated by ",". (NULL or an empty string for no change). [allow-none] +

error :

return location for a GError, or NULL. [allow-none] +

Returns :

 +TRUE on success, FALSE otherwise
+
+
+
+

nm_client_get_permission_result ()

+
NMClientPermissionResult nm_client_get_permission_result
+                                                        (NMClient *client,
+                                                         NMClientPermission permission);
+

+Requests the result of a specific permission, which indicates whether the +client can or cannot perform the action the permission represents +

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

client :

a NMClient +

permission :

the permission for which to return the result, one of NMClientPermission +

Returns :

the permission's result, one of NMClientPermissionResult +
+
+
+
+

nm_client_get_connectivity ()

+
NMConnectivityState nm_client_get_connectivity          (NMClient *client);
+

+Gets the current network connectivity state. Contrast +nm_client_check_connectivity() and +nm_client_check_connectivity_async(), which re-check the +connectivity state first before returning any information. +

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

client :

an NMClient +

Returns :

the current connectivity state
+
+
+
+

nm_client_check_connectivity ()

+
NMConnectivityState nm_client_check_connectivity        (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Updates the network connectivity state and returns the (new) +current state. Contrast nm_client_get_connectivity(), which returns +the most recent known state without re-checking. +

+

+This is a blocking call; use nm_client_check_connectivity_async() +if you do not want to block. +

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

client :

an NMClient +

cancellable :

a GCancellable +

error :

return location for a GError +

Returns :

the (new) current connectivity state
+
+
+
+

nm_client_check_connectivity_async ()

+
void                nm_client_check_connectivity_async  (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously updates the network connectivity state and invokes +callback when complete. Contrast nm_client_get_connectivity(), +which (immediately) returns the most recent known state without +re-checking, and nm_client_check_connectivity(), which blocks. +

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

client :

an NMClient +

cancellable :

a GCancellable +

callback :

callback to call with the result

user_data :

data for callback.
+
+
+
+

nm_client_check_connectivity_finish ()

+
NMConnectivityState nm_client_check_connectivity_finish (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Retrieves the result of an nm_client_check_connectivity_async() +call. +

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

client :

an NMClient +

result :

the GAsyncResult +

error :

return location for a GError +

Returns :

the (new) current connectivity state
+
+
+
+

nm_client_save_hostname ()

+
gboolean            nm_client_save_hostname             (NMClient *client,
+                                                         const char *hostname,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Requests that the machine's persistent hostname be set to the specified value +or cleared. +

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

client :

the NMClient +

hostname :

the new persistent hostname to set, or NULL to +clear any existing persistent hostname. [allow-none] +

cancellable :

a GCancellable, or NULL +

error :

return location for GError +

Returns :

 +TRUE if the request was successful, FALSE if it failed
+
+
+
+

nm_client_save_hostname_async ()

+
void                nm_client_save_hostname_async       (NMClient *client,
+                                                         const char *hostname,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Requests that the machine's persistent hostname be set to the specified value +or cleared. +

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

client :

the NMClient +

hostname :

the new persistent hostname to set, or NULL to +clear any existing persistent hostname. [allow-none] +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the operation completes. [scope async] +

user_data :

caller-specific data passed to callback. [closure] +
+
+
+
+

nm_client_save_hostname_finish ()

+
gboolean            nm_client_save_hostname_finish      (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of an nm_client_save_hostname_async() call. +

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

client :

the NMClient +

result :

the result passed to the GAsyncReadyCallback +

error :

return location for GError +

Returns :

 +TRUE if the request was successful, FALSE if it failed
+
+
+
+

nm_client_get_devices ()

+
const GPtrArray *   nm_client_get_devices               (NMClient *client);
+

+Gets all the known network devices. Use nm_device_get_type() or the +NM_IS_DEVICE_XXXX functions to determine what kind of +device member of the returned array is, and then you may use device-specific +methods such as nm_device_ethernet_get_hw_address(). +

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

client :

a NMClient +

Returns :

a GPtrArray +containing all the NMDevices. The returned array is owned by the +NMClient object and should not be modified. [transfer none][element-type NMDevice] +
+
+
+
+

nm_client_get_device_by_path ()

+
NMDevice *          nm_client_get_device_by_path        (NMClient *client,
+                                                         const char *object_path);
+

+Gets a NMDevice from a NMClient. +

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

client :

a NMClient +

object_path :

the object path to search for

Returns :

the NMDevice for the given object_path or NULL if none is found. [transfer none] +
+
+
+
+

nm_client_get_device_by_iface ()

+
NMDevice *          nm_client_get_device_by_iface       (NMClient *client,
+                                                         const char *iface);
+

+Gets a NMDevice from a NMClient. +

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

client :

a NMClient +

iface :

the interface name to search for

Returns :

the NMDevice for the given iface or NULL if none is found. [transfer none] +
+
+
+
+

nm_client_get_active_connections ()

+
const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
+

+Gets the active connections. +

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

client :

a NMClient +

Returns :

a GPtrArray +containing all the active NMActiveConnections. +The returned array is owned by the client and should not be modified. [transfer none][element-type NMActiveConnection] +
+
+
+
+

nm_client_get_primary_connection ()

+
NMActiveConnection * nm_client_get_primary_connection   (NMClient *client);
+

+Gets the NMActiveConnection corresponding to the primary active +network device. +

+

+In particular, when there is no VPN active, or the VPN does not +have the default route, this returns the active connection that has +the default route. If there is a VPN active with the default route, +then this function returns the active connection that contains the +route to the VPN endpoint. +

+

+If there is no default route, or the default route is over a +non-NetworkManager-recognized device, this will return NULL. +

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

client :

an NMClient +

Returns :

the appropriate NMActiveConnection, if +any. [transfer none] +
+
+
+
+

nm_client_get_activating_connection ()

+
NMActiveConnection * nm_client_get_activating_connection
+                                                        (NMClient *client);
+

+Gets the NMActiveConnection corresponding to a +currently-activating connection that is expected to become the new +"primary-connection" upon successful activation. +

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

client :

an NMClient +

Returns :

the appropriate NMActiveConnection, if +any. [transfer none] +
+
+
+
+

nm_client_activate_connection_async ()

+
void                nm_client_activate_connection_async (NMClient *client,
+                                                         NMConnection *connection,
+                                                         NMDevice *device,
+                                                         const char *specific_object,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously starts a connection to a particular network using the +configuration settings from connection and the network device device. +Certain connection types also take a "specific object" which is the object +path of a connection- specific object, like an NMAccessPoint for Wi-Fi +connections, or an NMWimaxNsp for WiMAX connections, to which you wish to +connect. If the specific object is not given, NetworkManager can, in some +cases, automatically determine which network to connect to given the settings +in connection. +

+

+If connection is not given for a device-based activation, NetworkManager +picks the best available connection for the device and activates it. +

+

+Note that the callback is invoked when NetworkManager has started activating +the new connection, not when it finishes. You can used the returned +NMActiveConnection object (in particular, "state") to +track the activation to its completion. +

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

client :

a NMClient +

connection :

an NMConnection. [allow-none] +

device :

the NMDevice. [allow-none] +

specific_object :

the object path of a connection-type-specific +object this activation should use. This parameter is currently ignored for +wired and mobile broadband connections, and the value of NULL should be used +(ie, no specific object). For Wi-Fi or WiMAX connections, pass the object +path of a NMAccessPoint or NMWimaxNsp owned by device, which you can +get using nm_object_get_path(), and which will be used to complete the +details of the newly added connection. [allow-none] +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the activation has started

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_client_activate_connection_finish ()

+
NMActiveConnection * nm_client_activate_connection_finish
+                                                        (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_client_activate_connection_async(). +

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

client :

an NMClient +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

the new NMActiveConnection on success, NULL on +failure, in which case error will be set. [transfer full] +
+
+
+
+

nm_client_add_and_activate_connection_async ()

+
void                nm_client_add_and_activate_connection_async
+                                                        (NMClient *client,
+                                                         NMConnection *partial,
+                                                         NMDevice *device,
+                                                         const char *specific_object,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Adds a new connection using the given details (if any) as a template, +automatically filling in missing settings with the capabilities of the given +device and specific object. The new connection is then asynchronously +activated as with nm_client_activate_connection_async(). Cannot be used for +VPN connections at this time. +

+

+Note that the callback is invoked when NetworkManager has started activating +the new connection, not when it finishes. You can used the returned +NMActiveConnection object (in particular, "state") to +track the activation to its completion. +

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

client :

a NMClient +

partial :

an NMConnection to add; the connection may be +partially filled (or even NULL) and will be completed by NetworkManager +using the given device and specific_object before being added. [allow-none] +

device :

the NMDevice +

specific_object :

the object path of a connection-type-specific +object this activation should use. This parameter is currently ignored for +wired and mobile broadband connections, and the value of NULL should be used +(ie, no specific object). For Wi-Fi or WiMAX connections, pass the object +path of a NMAccessPoint or NMWimaxNsp owned by device, which you can +get using nm_object_get_path(), and which will be used to complete the +details of the newly added connection. [allow-none] +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the activation has started

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_client_add_and_activate_connection_finish ()

+
NMActiveConnection * nm_client_add_and_activate_connection_finish
+                                                        (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_client_add_and_activate_connection_async(). +

+

+You can call nm_active_connection_get_connection() on the returned +NMActiveConnection to find the path of the created NMConnection. +

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

client :

an NMClient +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

the new NMActiveConnection on success, NULL on +failure, in which case error will be set. [transfer full] +
+
+
+
+

nm_client_deactivate_connection ()

+
gboolean            nm_client_deactivate_connection     (NMClient *client,
+                                                         NMActiveConnection *active,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Deactivates an active NMActiveConnection. +

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

client :

a NMClient +

active :

the NMActiveConnection to deactivate

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

success or failure
+
+
+
+

nm_client_deactivate_connection_async ()

+
void                nm_client_deactivate_connection_async
+                                                        (NMClient *client,
+                                                         NMActiveConnection *active,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously deactivates an active NMActiveConnection. +

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

client :

a NMClient +

active :

the NMActiveConnection to deactivate

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the deactivation has completed

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_client_deactivate_connection_finish ()

+
gboolean            nm_client_deactivate_connection_finish
+                                                        (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_client_deactivate_connection_async(). +

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

client :

a NMClient +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

success or failure
+
+
+
+

nm_client_get_connections ()

+
const GPtrArray *   nm_client_get_connections           (NMClient *client);
+
++++ + + + + + + + + + + +

client :

the NMClient +

Returns :

an array +containing all connections provided by the remote settings service. The +returned array is owned by the NMClient object and should not be modified. [transfer none][element-type NMRemoteConnection] +
+
+
+
+

nm_client_get_connection_by_id ()

+
NMRemoteConnection * nm_client_get_connection_by_id     (NMClient *client,
+                                                         const char *id);
+

+Returns the first matching NMRemoteConnection matching a given id. +

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

client :

the NMClient +

id :

the id of the remote connection

Returns :

the remote connection object on success, or NULL if no +matching object was found. [transfer none] +
+
+
+
+

nm_client_get_connection_by_path ()

+
NMRemoteConnection * nm_client_get_connection_by_path   (NMClient *client,
+                                                         const char *path);
+

+Returns the NMRemoteConnection representing the connection at path. +

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

client :

the NMClient +

path :

the D-Bus object path of the remote connection

Returns :

the remote connection object on success, or NULL if the object was +not known. [transfer none] +
+
+
+
+

nm_client_get_connection_by_uuid ()

+
NMRemoteConnection * nm_client_get_connection_by_uuid   (NMClient *client,
+                                                         const char *uuid);
+

+Returns the NMRemoteConnection identified by uuid. +

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

client :

the NMClient +

uuid :

the UUID of the remote connection

Returns :

the remote connection object on success, or NULL if the object was +not known. [transfer none] +
+
+
+
+

nm_client_add_connection_async ()

+
void                nm_client_add_connection_async      (NMClient *client,
+                                                         NMConnection *connection,
+                                                         gboolean save_to_disk,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Requests that the remote settings service add the given settings to a new +connection. If save_to_disk is TRUE, the connection is immediately written +to disk; otherwise it is initially only stored in memory, but may be saved +later by calling the connection's nm_remote_connection_commit_changes() +method. +

+

+connection is untouched by this function and only serves as a template of +the settings to add. The NMRemoteConnection object that represents what +NetworkManager actually added is returned to callback when the addition +operation is complete. +

+

+Note that the NMRemoteConnection returned in callback may not contain +identical settings to connection as NetworkManager may perform automatic +completion and/or normalization of connection properties. +

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

client :

the NMClient +

connection :

the connection to add. Note that this object's settings will be +added, not the object itself

save_to_disk :

whether to immediately save the connection to disk

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the add operation completes. [scope async] +

user_data :

caller-specific data passed to callback. [closure] +
+
+
+
+

nm_client_add_connection_finish ()

+
NMRemoteConnection * nm_client_add_connection_finish    (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_client_add_connection_async(). +

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

client :

an NMClient +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

the new NMRemoteConnection on success, NULL on +failure, in which case error will be set. [transfer full] +
+
+
+
+

nm_client_load_connections ()

+
gboolean            nm_client_load_connections          (NMClient *client,
+                                                         char **filenames,
+                                                         char ***failures,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Requests that the remote settings service load or reload the given files, +adding or updating the connections described within. +

+

+The changes to the indicated files will not yet be reflected in +client's connections array when the function returns. +

+

+If all of the indicated files were successfully loaded, the +function will return TRUE, and failures will be set to NULL. If +NetworkManager tried to load the files, but some (or all) failed, +then failures will be set to a NULL-terminated array of the +filenames that failed to load. +

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

client :

the NMClient +

filenames :

 +NULL-terminated array of filenames to load

failures :

on return, a NULL-terminated array of +filenames that failed to load. [out][transfer full] +

cancellable :

a GCancellable, or NULL +

error :

return location for GError +

Returns :

 +TRUE if NetworkManager at least tried to load filenames, +FALSE if an error occurred (eg, permission denied).
+
+
+
+

nm_client_load_connections_async ()

+
void                nm_client_load_connections_async    (NMClient *client,
+                                                         char **filenames,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Requests that the remote settings service asynchronously load or reload the +given files, adding or updating the connections described within. +

+

+See nm_client_load_connections() for more details. +

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

client :

the NMClient +

filenames :

 +NULL-terminated array of filenames to load

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the operation completes. [scope async] +

user_data :

caller-specific data passed to callback. [closure] +
+
+
+
+

nm_client_load_connections_finish ()

+
gboolean            nm_client_load_connections_finish   (NMClient *client,
+                                                         char ***failures,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of an nm_client_load_connections_async() call. +

+

+See nm_client_load_connections() for more details. +

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

client :

the NMClient +

failures :

on return, a NULL-terminated array of +filenames that failed to load. [out][transfer full] +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

 +TRUE if NetworkManager at least tried to load filenames, +FALSE if an error occurred (eg, permission denied).
+
+
+
+

nm_client_reload_connections ()

+
gboolean            nm_client_reload_connections        (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Requests that the remote settings service reload all connection +files from disk, adding, updating, and removing connections until +the in-memory state matches the on-disk state. +

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

client :

the NMClient +

cancellable :

a GCancellable, or NULL +

error :

return location for GError +

Returns :

 +TRUE on success, FALSE on failure
+
+
+
+

nm_client_reload_connections_async ()

+
void                nm_client_reload_connections_async  (NMClient *client,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Requests that the remote settings service begin reloading all connection +files from disk, adding, updating, and removing connections until the +in-memory state matches the on-disk state. +

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

client :

the NMClient +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the reload operation completes. [scope async] +

user_data :

caller-specific data passed to callback. [closure] +
+
+
+
+

nm_client_reload_connections_finish ()

+
gboolean            nm_client_reload_connections_finish (NMClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of an nm_client_reload_connections_async() call. +

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

client :

the NMClient +

result :

the result passed to the GAsyncReadyCallback +

error :

return location for GError +

Returns :

 +TRUE on success, FALSE on failure
+
+
+
+

Property Details

+
+

The "activating-connection" property

+
  "activating-connection"    NMActiveConnection*   : Read
+

+The NMActiveConnection of the activating connection that is +likely to become the new "primary-connection". +

+
+
+
+

The "active-connections" property

+
  "active-connections"       GPtrArray*            : Read
+

+The active connections. +

+

+Element-type: NMActiveConnection +

+
+
+
+

The "can-modify" property

+
  "can-modify"               gboolean              : Read
+

+If TRUE, adding and modifying connections is supported. +

+

Default value: FALSE

+
+
+
+

The "connections" property

+
  "connections"              GPtrArray*            : Read
+

+The list of configured connections that are available to the user. (Note +that this differs from the underlying D-Bus property, which may also +contain the object paths of connections that the user does not have +permission to read the details of.) +

+

+Element-type: NMRemoteConnection +

+
+
+
+

The "connectivity" property

+
  "connectivity"             NMConnectivityState   : Read
+

+The network connectivity state. +

+

Default value: NM_CONNECTIVITY_UNKNOWN

+
+
+
+

The "devices" property

+
  "devices"                  GPtrArray*            : Read
+

+List of known network devices. +

+

+Element-type: NMDevice +

+
+
+
+

The "hostname" property

+
  "hostname"                 gchar*                : Read
+

+The machine hostname stored in persistent configuration. This can be +modified by calling nm_client_save_hostname(). +

+

Default value: NULL

+
+
+
+

The "networking-enabled" property

+
  "networking-enabled"       gboolean              : Read / Write
+

+Whether networking is enabled. +

+

Default value: TRUE

+
+
+
+

The "nm-running" property

+
  "nm-running"               gboolean              : Read
+

+Whether the daemon is running. +

+

Default value: FALSE

+
+
+
+

The "primary-connection" property

+
  "primary-connection"       NMActiveConnection*   : Read
+

+The NMActiveConnection of the device with the default route; +see nm_client_get_primary_connection() for more details. +

+
+
+
+

The "startup" property

+
  "startup"                  gboolean              : Read
+

+Whether the daemon is still starting up. +

+

Default value: FALSE

+
+
+
+

The "state" property

+
  "state"                    NMState               : Read
+

+The current daemon state. +

+

Default value: NM_STATE_UNKNOWN

+
+
+
+

The "version" property

+
  "version"                  gchar*                : Read
+

+The NetworkManager version. +

+

Default value: NULL

+
+
+
+

The "wimax-enabled" property

+
  "wimax-enabled"            gboolean              : Read / Write
+

+Whether WiMAX functionality is enabled. +

+

Default value: FALSE

+
+
+
+

The "wimax-hardware-enabled" property

+
  "wimax-hardware-enabled"   gboolean              : Read
+

+Whether the WiMAX hardware is enabled. +

+

Default value: FALSE

+
+
+
+

The "wireless-enabled" property

+
  "wireless-enabled"         gboolean              : Read / Write
+

+Whether wireless is enabled. +

+

Default value: FALSE

+
+
+
+

The "wireless-hardware-enabled" property

+
  "wireless-hardware-enabled" gboolean              : Read
+

+Whether the wireless hardware is enabled. +

+

Default value: TRUE

+
+
+
+

The "wwan-enabled" property

+
  "wwan-enabled"             gboolean              : Read / Write
+

+Whether WWAN functionality is enabled. +

+

Default value: FALSE

+
+
+
+

The "wwan-hardware-enabled" property

+
  "wwan-hardware-enabled"    gboolean              : Read
+

+Whether the WWAN hardware is enabled. +

+

Default value: FALSE

+
+
+
+

Signal Details

+
+

The "connection-added" signal

+
void                user_function                      (NMClient           *client,
+                                                        NMRemoteConnection *connection,
+                                                        gpointer            user_data)       : Run First
+

+Notifies that a NMConnection has been added. +

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

client :

the settings object that received the signal

connection :

the new connection

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "connection-removed" signal

+
void                user_function                      (NMClient           *client,
+                                                        NMRemoteConnection *connection,
+                                                        gpointer            user_data)       : Run First
+

+Notifies that a NMConnection has been removed. +

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

client :

the settings object that received the signal

connection :

the removed connection

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "device-added" signal

+
void                user_function                      (NMClient *client,
+                                                        GObject  *device,
+                                                        gpointer  user_data)      : Run First
+

+Notifies that a NMDevice is added. +

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

client :

the client that received the signal

device :

the new device. [type NMDevice] +

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "device-removed" signal

+
void                user_function                      (NMClient *client,
+                                                        GObject  *device,
+                                                        gpointer  user_data)      : Run First
+

+Notifies that a NMDevice is removed. +

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

client :

the client that received the signal

device :

the removed device. [type NMDevice] +

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "permission-changed" signal

+
void                user_function                      (NMClient *client,
+                                                        guint     permission,
+                                                        guint     result,
+                                                        gpointer  user_data)       : Run First
+

+Notifies that a permission has changed +

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

client :

the client that received the signal

permission :

a permission from NMClientPermission +

result :

the permission's result, one of NMClientPermissionResult +

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDevice.html b/docs/libnm/html/NMDevice.html new file mode 100644 index 00000000..9ac8d27a --- /dev/null +++ b/docs/libnm/html/NMDevice.html @@ -0,0 +1,1858 @@ + + + + +NMDevice + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDevice

+

NMDevice

+
+
+

Synopsis

+
#define             NM_DEVICE_DEVICE_TYPE
+#define             NM_DEVICE_UDI
+#define             NM_DEVICE_INTERFACE
+#define             NM_DEVICE_IP_INTERFACE
+#define             NM_DEVICE_DRIVER
+#define             NM_DEVICE_DRIVER_VERSION
+#define             NM_DEVICE_FIRMWARE_VERSION
+#define             NM_DEVICE_CAPABILITIES
+#define             NM_DEVICE_MANAGED
+#define             NM_DEVICE_AUTOCONNECT
+#define             NM_DEVICE_FIRMWARE_MISSING
+#define             NM_DEVICE_IP4_CONFIG
+#define             NM_DEVICE_DHCP4_CONFIG
+#define             NM_DEVICE_IP6_CONFIG
+#define             NM_DEVICE_DHCP6_CONFIG
+#define             NM_DEVICE_STATE
+#define             NM_DEVICE_STATE_REASON
+#define             NM_DEVICE_ACTIVE_CONNECTION
+#define             NM_DEVICE_AVAILABLE_CONNECTIONS
+#define             NM_DEVICE_VENDOR
+#define             NM_DEVICE_PRODUCT
+#define             NM_DEVICE_PHYSICAL_PORT_ID
+#define             NM_DEVICE_MTU
+struct              NMDevice;
+                    NMDeviceClass;
+const char *        nm_device_get_iface                 (NMDevice *device);
+const char *        nm_device_get_ip_iface              (NMDevice *device);
+NMDeviceType        nm_device_get_device_type           (NMDevice *device);
+const char *        nm_device_get_udi                   (NMDevice *device);
+const char *        nm_device_get_driver                (NMDevice *device);
+const char *        nm_device_get_driver_version        (NMDevice *device);
+const char *        nm_device_get_firmware_version      (NMDevice *device);
+const char *        nm_device_get_type_description      (NMDevice *device);
+const char *        nm_device_get_hw_address            (NMDevice *device);
+NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);
+gboolean            nm_device_get_managed               (NMDevice *device);
+gboolean            nm_device_get_autoconnect           (NMDevice *device);
+void                nm_device_set_autoconnect           (NMDevice *device,
+                                                         gboolean autoconnect);
+gboolean            nm_device_get_firmware_missing      (NMDevice *device);
+NMIPConfig *        nm_device_get_ip4_config            (NMDevice *device);
+NMDhcpConfig *      nm_device_get_dhcp4_config          (NMDevice *device);
+NMIPConfig *        nm_device_get_ip6_config            (NMDevice *device);
+NMDhcpConfig *      nm_device_get_dhcp6_config          (NMDevice *device);
+NMDeviceState       nm_device_get_state                 (NMDevice *device);
+NMDeviceStateReason nm_device_get_state_reason          (NMDevice *device);
+NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
+const GPtrArray *   nm_device_get_available_connections (NMDevice *device);
+const char *        nm_device_get_physical_port_id      (NMDevice *device);
+guint32             nm_device_get_mtu                   (NMDevice *device);
+gboolean            nm_device_is_software               (NMDevice *device);
+const char *        nm_device_get_product               (NMDevice *device);
+const char *        nm_device_get_vendor                (NMDevice *device);
+const char *        nm_device_get_description           (NMDevice *device);
+char **             nm_device_disambiguate_names        (NMDevice **devices,
+                                                         int num_devices);
+gboolean            nm_device_disconnect                (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_device_disconnect_async          (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_device_disconnect_finish         (NMDevice *device,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_device_delete                    (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_device_delete_async              (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_device_delete_finish             (NMDevice *device,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+GPtrArray *         nm_device_filter_connections        (NMDevice *device,
+                                                         const GPtrArray *connections);
+gboolean            nm_device_connection_valid          (NMDevice *device,
+                                                         NMConnection *connection);
+gboolean            nm_device_connection_compatible     (NMDevice *device,
+                                                         NMConnection *connection,
+                                                         GError **error);
+GType               nm_device_get_setting_type          (NMDevice *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceAdsl
+               +----NMDeviceBond
+               +----NMDeviceBridge
+               +----NMDeviceBt
+               +----NMDeviceEthernet
+               +----NMDeviceGeneric
+               +----NMDeviceInfiniband
+               +----NMDeviceModem
+               +----NMDeviceOlpcMesh
+               +----NMDeviceTeam
+               +----NMDeviceVlan
+               +----NMDeviceWifi
+               +----NMDeviceWimax
+
+
+
+

Implemented Interfaces

+

+NMDevice implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "active-connection"        NMActiveConnection*   : Read
+  "autoconnect"              gboolean              : Read / Write
+  "available-connections"    GPtrArray*            : Read
+  "capabilities"             NMDeviceCapabilities  : Read
+  "device-type"              NMDeviceType          : Read
+  "dhcp4-config"             NMDhcpConfig*         : Read
+  "dhcp6-config"             NMDhcpConfig*         : Read
+  "driver"                   gchar*                : Read
+  "driver-version"           gchar*                : Read
+  "firmware-missing"         gboolean              : Read
+  "firmware-version"         gchar*                : Read
+  "interface"                gchar*                : Read
+  "ip-interface"             gchar*                : Read
+  "ip4-config"               NMIPConfig*           : Read
+  "ip6-config"               NMIPConfig*           : Read
+  "managed"                  gboolean              : Read
+  "mtu"                      guint                 : Read
+  "physical-port-id"         gchar*                : Read
+  "product"                  gchar*                : Read
+  "state"                    NMDeviceState         : Read
+  "state-reason"             guint                 : Read
+  "udi"                      gchar*                : Read
+  "vendor"                   gchar*                : Read
+
+
+
+

Signals

+
+  "state-changed"                                  : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_DEVICE_TYPE

+
#define NM_DEVICE_DEVICE_TYPE "device-type"
+
+

+

+
+
+
+

NM_DEVICE_UDI

+
#define NM_DEVICE_UDI "udi"
+
+

+

+
+
+
+

NM_DEVICE_INTERFACE

+
#define NM_DEVICE_INTERFACE "interface"
+
+

+

+
+
+
+

NM_DEVICE_IP_INTERFACE

+
#define NM_DEVICE_IP_INTERFACE "ip-interface"
+
+

+

+
+
+
+

NM_DEVICE_DRIVER

+
#define NM_DEVICE_DRIVER "driver"
+
+

+

+
+
+
+

NM_DEVICE_DRIVER_VERSION

+
#define NM_DEVICE_DRIVER_VERSION "driver-version"
+
+

+

+
+
+
+

NM_DEVICE_FIRMWARE_VERSION

+
#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
+
+

+

+
+
+
+

NM_DEVICE_CAPABILITIES

+
#define NM_DEVICE_CAPABILITIES "capabilities"
+
+

+

+
+
+
+

NM_DEVICE_MANAGED

+
#define NM_DEVICE_MANAGED "managed"
+
+

+

+
+
+
+

NM_DEVICE_AUTOCONNECT

+
#define NM_DEVICE_AUTOCONNECT "autoconnect"
+
+

+

+
+
+
+

NM_DEVICE_FIRMWARE_MISSING

+
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
+
+

+

+
+
+
+

NM_DEVICE_IP4_CONFIG

+
#define NM_DEVICE_IP4_CONFIG "ip4-config"
+
+

+

+
+
+
+

NM_DEVICE_DHCP4_CONFIG

+
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
+
+

+

+
+
+
+

NM_DEVICE_IP6_CONFIG

+
#define NM_DEVICE_IP6_CONFIG "ip6-config"
+
+

+

+
+
+
+

NM_DEVICE_DHCP6_CONFIG

+
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
+
+

+

+
+
+
+

NM_DEVICE_STATE

+
#define NM_DEVICE_STATE "state"
+
+

+

+
+
+
+

NM_DEVICE_STATE_REASON

+
#define NM_DEVICE_STATE_REASON "state-reason"
+
+

+

+
+
+
+

NM_DEVICE_ACTIVE_CONNECTION

+
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
+
+

+

+
+
+
+

NM_DEVICE_AVAILABLE_CONNECTIONS

+
#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
+
+

+

+
+
+
+

NM_DEVICE_VENDOR

+
#define NM_DEVICE_VENDOR "vendor"
+
+

+

+
+
+
+

NM_DEVICE_PRODUCT

+
#define NM_DEVICE_PRODUCT "product"
+
+

+

+
+
+
+

NM_DEVICE_PHYSICAL_PORT_ID

+
#define NM_DEVICE_PHYSICAL_PORT_ID "physical-port-id"
+
+

+

+
+
+
+

NM_DEVICE_MTU

+
#define NM_DEVICE_MTU "mtu"
+
+

+

+
+
+
+

struct NMDevice

+
struct NMDevice;
+

+

+
+
+
+

NMDeviceClass

+
typedef struct {
+	NMObjectClass parent;
+
+	/* Signals */
+	void (*state_changed) (NMDevice *device,
+	                       NMDeviceState new_state,
+	                       NMDeviceState old_state,
+	                       NMDeviceStateReason reason);
+
+	/* Methods */
+	gboolean (*connection_compatible) (NMDevice *device,
+	                                   NMConnection *connection,
+	                                   GError **error);
+
+	const char * (*get_type_description) (NMDevice *device);
+	const char * (*get_hw_address) (NMDevice *device);
+
+	GType (*get_setting_type) (NMDevice *device);
+} NMDeviceClass;
+
+

+

+
+
+
+

nm_device_get_iface ()

+
const char *        nm_device_get_iface                 (NMDevice *device);
+

+Gets the interface name of the NMDevice. +

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

device :

a NMDevice +

Returns :

the interface of the device. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_get_ip_iface ()

+
const char *        nm_device_get_ip_iface              (NMDevice *device);
+

+Gets the IP interface name of the NMDevice over which IP traffic flows +when the device is in the ACTIVATED state. +

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

device :

a NMDevice +

Returns :

the IP traffic interface of the device. This is the internal string +used by the device, and must not be modified.
+
+
+
+

nm_device_get_device_type ()

+
NMDeviceType        nm_device_get_device_type           (NMDevice *device);
+

+Returns the numeric type of the NMDevice, ie Ethernet, Wi-Fi, etc. +

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

device :

a NMDevice +

Returns :

the device type
+
+
+
+

nm_device_get_udi ()

+
const char *        nm_device_get_udi                   (NMDevice *device);
+

+Gets the Unique Device Identifier of the NMDevice. +

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

device :

a NMDevice +

Returns :

the Unique Device Identifier of the device. This identifier may be +used to gather more information about the device from various operating +system services like udev or sysfs.
+
+
+
+

nm_device_get_driver ()

+
const char *        nm_device_get_driver                (NMDevice *device);
+

+Gets the driver of the NMDevice. +

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

device :

a NMDevice +

Returns :

the driver of the device. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_get_driver_version ()

+
const char *        nm_device_get_driver_version        (NMDevice *device);
+

+Gets the driver version of the NMDevice. +

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

device :

a NMDevice +

Returns :

the version of the device driver. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_get_firmware_version ()

+
const char *        nm_device_get_firmware_version      (NMDevice *device);
+

+Gets the firmware version of the NMDevice. +

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

device :

a NMDevice +

Returns :

the firmware version of the device. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_get_type_description ()

+
const char *        nm_device_get_type_description      (NMDevice *device);
+

+Gets a (non-localized) description of the type of device that +device is. +

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

device :

a NMDevice +

Returns :

the type description of the device. This is the internal +string used by the device, and must not be modified.
+
+
+
+

nm_device_get_hw_address ()

+
const char *        nm_device_get_hw_address            (NMDevice *device);
+

+Gets the current a hardware address (MAC) for the device. +

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

device :

a NMDevice +

Returns :

the current MAC of the device, or NULL. +This is the internal string used by the device, and must not be modified.
+
+
+
+

nm_device_get_capabilities ()

+
NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);
+

+Gets the device' capabilities. +

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

device :

a NMDevice +

Returns :

the capabilities
+
+
+
+

nm_device_get_managed ()

+
gboolean            nm_device_get_managed               (NMDevice *device);
+

+Whether the NMDevice is managed by NetworkManager. +

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

device :

a NMDevice +

Returns :

 +TRUE if the device is managed by NetworkManager
+
+
+
+

nm_device_get_autoconnect ()

+
gboolean            nm_device_get_autoconnect           (NMDevice *device);
+

+Whether the NMDevice can be autoconnected. +

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

device :

a NMDevice +

Returns :

 +TRUE if the device is allowed to be autoconnected
+
+
+
+

nm_device_set_autoconnect ()

+
void                nm_device_set_autoconnect           (NMDevice *device,
+                                                         gboolean autoconnect);
+

+Enables or disables automatic activation of the NMDevice. +

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

device :

a NMDevice +

autoconnect :

 +TRUE to enable autoconnecting
+
+
+
+

nm_device_get_firmware_missing ()

+
gboolean            nm_device_get_firmware_missing      (NMDevice *device);
+

+Indicates that firmware required for the device's operation is likely +to be missing. +

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

device :

a NMDevice +

Returns :

 +TRUE if firmware required for the device's operation is likely +to be missing.
+
+
+
+

nm_device_get_ip4_config ()

+
NMIPConfig *        nm_device_get_ip4_config            (NMDevice *device);
+

+Gets the current IPv4 NMIPConfig associated with the NMDevice. +

+

+You can alternatively use nm_active_connection_get_ip4_config(), which also +works with VPN connections. +

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

device :

a NMDevice +

Returns :

the IPv4 NMIPConfig, or NULL if the device is not +activated. [transfer none] +
+
+
+
+

nm_device_get_dhcp4_config ()

+
NMDhcpConfig *      nm_device_get_dhcp4_config          (NMDevice *device);
+

+Gets the current IPv4 NMDhcpConfig associated with the NMDevice. +

+

+You can alternatively use nm_active_connection_get_dhcp4_config(), which also +works with VPN connections. +

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

device :

a NMDevice +

Returns :

the IPv4 NMDhcpConfig, or NULL if the device is +not activated or not using DHCP. [transfer none] +
+
+
+
+

nm_device_get_ip6_config ()

+
NMIPConfig *        nm_device_get_ip6_config            (NMDevice *device);
+

+Gets the current IPv6 NMIPConfig associated with the NMDevice. +

+

+You can alternatively use nm_active_connection_get_ip6_config(), which also +works with VPN connections. +

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

device :

a NMDevice +

Returns :

the IPv6 NMIPConfig or NULL if the device is not activated. [transfer none] +
+
+
+
+

nm_device_get_dhcp6_config ()

+
NMDhcpConfig *      nm_device_get_dhcp6_config          (NMDevice *device);
+

+Gets the current IPv6 NMDhcpConfig associated with the NMDevice. +

+

+You can alternatively use nm_active_connection_get_dhcp6_config(), which also +works with VPN connections. +

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

device :

a NMDevice +

Returns :

the IPv6 NMDhcpConfig, or NULL if the device is +not activated or not using DHCPv6. [transfer none] +
+
+
+
+

nm_device_get_state ()

+
NMDeviceState       nm_device_get_state                 (NMDevice *device);
+

+Gets the current NMDevice state. +

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

device :

a NMDevice +

Returns :

the current device state
+
+
+
+

nm_device_get_state_reason ()

+
NMDeviceStateReason nm_device_get_state_reason          (NMDevice *device);
+

+Gets the reason for entering the current NMDevice state. +

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

device :

a NMDevice +

Returns :

the reason for entering the current device state
+
+
+
+

nm_device_get_active_connection ()

+
NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
+

+Gets the NMActiveConnection object which owns this device during activation. +

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

device :

a NMDevice +

Returns :

the NMActiveConnection or NULL if the device is +not part of an active connection. [transfer none] +
+
+
+
+

nm_device_get_available_connections ()

+
const GPtrArray *   nm_device_get_available_connections (NMDevice *device);
+

+Gets the NMRemoteConnections currently known to the daemon that could +be activated on device. +

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

device :

a NMDevice +

Returns :

the GPtrArray +containing NMRemoteConnections. This is the internal copy used by +the connection, and must not be modified. [element-type NMRemoteConnection] +
+
+
+
+

nm_device_get_physical_port_id ()

+
const char *        nm_device_get_physical_port_id      (NMDevice *device);
+

+Gets the physical port ID of the NMDevice. If non-NULL, this is +an opaque string that can be used to recognize when +seemingly-unrelated NMDevices are actually just different virtual +ports on a single physical port. (Eg, NPAR / SR-IOV.) +

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

device :

a NMDevice +

Returns :

the physical port ID of the device, or NULL if the port +ID is unknown. This is the internal string used by the device and +must not be modified.
+
+
+
+

nm_device_get_mtu ()

+
guint32             nm_device_get_mtu                   (NMDevice *device);
+

+Gets the MTU of the NMDevice. +

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

device :

a NMDevice +

Returns :

the MTU of the device.
+
+
+
+

nm_device_is_software ()

+
gboolean            nm_device_is_software               (NMDevice *device);
+

+Whether the device is a software device. +

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

device :

a NMDevice +

Returns :

 +TRUE if device is a software device, FALSE if it is a hardware device.
+
+
+
+

nm_device_get_product ()

+
const char *        nm_device_get_product               (NMDevice *device);
+

+Gets the product string of the NMDevice. +

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

device :

a NMDevice +

Returns :

the product name of the device. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_get_vendor ()

+
const char *        nm_device_get_vendor                (NMDevice *device);
+

+Gets the vendor string of the NMDevice. +

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

device :

a NMDevice +

Returns :

the vendor name of the device. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_get_description ()

+
const char *        nm_device_get_description           (NMDevice *device);
+

+Gets a description of device, based on its vendor and product names. +

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

device :

an NMDevice +

Returns :

a description of device. If either the vendor or the +product name is unknown, this returns the interface name.
+
+
+
+

nm_device_disambiguate_names ()

+
char **             nm_device_disambiguate_names        (NMDevice **devices,
+                                                         int num_devices);
+

+Generates a list of short-ish unique presentation names for the +devices in devices. +

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

devices :

an array of NMDevice. [array length=num_devices] +

num_devices :

length of devices +

Returns :

the device names. [transfer full][array zero-terminated=1] +
+
+
+
+

nm_device_disconnect ()

+
gboolean            nm_device_disconnect                (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Disconnects the device if currently connected, and prevents the device from +automatically connecting to networks until the next manual network connection +request. +

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

device :

a NMDevice +

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be set.
+
+
+
+

nm_device_disconnect_async ()

+
void                nm_device_disconnect_async          (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously begins disconnecting the device if currently connected, and +prevents the device from automatically connecting to networks until the next +manual network connection request. +

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

device :

a NMDevice +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the disconnect operation completes

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_device_disconnect_finish ()

+
gboolean            nm_device_disconnect_finish         (NMDevice *device,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_device_disconnect_async(). +

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

device :

a NMDevice +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error +will be set.
+
+
+
+

nm_device_delete ()

+
gboolean            nm_device_delete                    (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Deletes the software device. Hardware devices can't be deleted. +

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

device :

a NMDevice +

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error +will be set.
+
+
+
+

nm_device_delete_async ()

+
void                nm_device_delete_async              (NMDevice *device,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously begins deleteing the software device. Hardware devices can't +be deleted. +

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

device :

a NMDevice +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when delete operation completes

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_device_delete_finish ()

+
gboolean            nm_device_delete_finish             (NMDevice *device,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_device_delete_async(). +

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

device :

a NMDevice +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error +will be set.
+
+
+
+

nm_device_filter_connections ()

+
GPtrArray *         nm_device_filter_connections        (NMDevice *device,
+                                                         const GPtrArray *connections);
+

+Filters a given array of connections for a given NMDevice object and returns +connections which may be activated with the device. For example if device +is a Wi-Fi device that supports only WEP encryption, the returned array will +contain any Wi-Fi connections in connections that allow connection to +unencrypted or WEP-enabled SSIDs. The returned array will not contain +Ethernet, Bluetooth, Wi-Fi WPA connections, or any other connection that is +incompatible with the device. To get the full list of connections see +nm_client_get_connections(). +

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

device :

an NMDevice to filter connections for

connections :

an array of NMConnections to filter. [element-type NMConnection] +

Returns :

an array of +NMConnections that could be activated with the given device. The array +should be freed with g_ptr_array_unref() when it is no longer required. [transfer container][element-type NMConnection] +
+
+
+
+

nm_device_connection_valid ()

+
gboolean            nm_device_connection_valid          (NMDevice *device,
+                                                         NMConnection *connection);
+

+Validates a given connection for a given NMDevice object and returns +whether the connection may be activated with the device. For example if +device is a Wi-Fi device that supports only WEP encryption, the connection +will only be valid if it is a Wi-Fi connection which describes a WEP or open +network, and will not be valid if it describes a WPA network, or if it is +an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the +device. +

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

device :

an NMDevice to validate connection against

connection :

an NMConnection to validate against device +

Returns :

 +TRUE if the connection may be activated with this device, FALSE +if is incompatible with the device's capabilities and characteristics.
+
+
+
+

nm_device_connection_compatible ()

+
gboolean            nm_device_connection_compatible     (NMDevice *device,
+                                                         NMConnection *connection,
+                                                         GError **error);
+

+Validates a given connection for a given NMDevice object and returns +whether the connection may be activated with the device. For example if +device is a Wi-Fi device that supports only WEP encryption, the connection +will only be valid if it is a Wi-Fi connection which describes a WEP or open +network, and will not be valid if it describes a WPA network, or if it is +an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the +device. +

+

+This function does the same as nm_device_connection_valid(), i.e. checking +compatibility of the given device and connection. But, in addition, it sets +GError when FALSE is returned. +

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

device :

an NMDevice to validate connection against

connection :

an NMConnection to validate against device +

error :

return location for a GError, or NULL +

Returns :

 +TRUE if the connection may be activated with this device, FALSE +if is incompatible with the device's capabilities and characteristics.
+
+
+
+

nm_device_get_setting_type ()

+
GType               nm_device_get_setting_type          (NMDevice *device);
+

+Gets the (primary) NMSetting subtype associated with connections +that can be used on device. +

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

device :

an NMDevice +

Returns :

 +device's associated NMSetting type
+
+
+
+

Property Details

+
+

The "active-connection" property

+
  "active-connection"        NMActiveConnection*   : Read
+

+The NMActiveConnection object that "owns" this device during activation. +

+
+
+
+

The "autoconnect" property

+
  "autoconnect"              gboolean              : Read / Write
+

+Whether the device can auto-activate a connection. +

+

Default value: TRUE

+
+
+
+

The "available-connections" property

+
  "available-connections"    GPtrArray*            : Read
+

+The available connections of the device +

+

+Element-type: NMRemoteConnection +

+
+
+
+

The "capabilities" property

+
  "capabilities"             NMDeviceCapabilities  : Read
+

+The capabilities of the device. +

+
+
+
+

The "device-type" property

+
  "device-type"              NMDeviceType          : Read
+

+The numeric type of the device. +

+

Default value: NM_DEVICE_TYPE_UNKNOWN

+
+
+
+

The "dhcp4-config" property

+
  "dhcp4-config"             NMDhcpConfig*         : Read
+

+The IPv4 NMDhcpConfig of the device. +

+
+
+
+

The "dhcp6-config" property

+
  "dhcp6-config"             NMDhcpConfig*         : Read
+

+The IPv6 NMDhcpConfig of the device. +

+
+
+
+

The "driver" property

+
  "driver"                   gchar*                : Read
+

+The driver of the device. +

+

Default value: NULL

+
+
+
+

The "driver-version" property

+
  "driver-version"           gchar*                : Read
+

+The version of the device driver. +

+

Default value: NULL

+
+
+
+

The "firmware-missing" property

+
  "firmware-missing"         gboolean              : Read
+

+When TRUE indicates the device is likely missing firmware required +for its operation. +

+

Default value: FALSE

+
+
+
+

The "firmware-version" property

+
  "firmware-version"         gchar*                : Read
+

+The firmware version of the device. +

+

Default value: NULL

+
+
+
+

The "interface" property

+
  "interface"                gchar*                : Read
+

+The interface of the device. +

+

Default value: NULL

+
+
+
+

The "ip-interface" property

+
  "ip-interface"             gchar*                : Read
+

+The IP interface of the device which should be used for all IP-related +operations like addressing and routing. +

+

Default value: NULL

+
+
+
+

The "ip4-config" property

+
  "ip4-config"               NMIPConfig*           : Read
+

+The NMIP4Config of the device. +

+
+
+
+

The "ip6-config" property

+
  "ip6-config"               NMIPConfig*           : Read
+

+The IPv6 NMIPConfig of the device. +

+
+
+
+

The "managed" property

+
  "managed"                  gboolean              : Read
+

+Whether the device is managed by NetworkManager. +

+

Default value: FALSE

+
+
+
+

The "mtu" property

+
  "mtu"                      guint                 : Read
+

+The MTU of the device. +

+

Default value: 1500

+
+
+
+

The "physical-port-id" property

+
  "physical-port-id"         gchar*                : Read
+

+The physical port ID of the device. (See +nm_device_get_physical_port_id().) +

+

Default value: NULL

+
+
+
+

The "product" property

+
  "product"                  gchar*                : Read
+

+The product string of the device. +

+

Default value: NULL

+
+
+
+

The "state" property

+
  "state"                    NMDeviceState         : Read
+

+The state of the device. +

+

Default value: NM_DEVICE_STATE_UNKNOWN

+
+
+
+

The "state-reason" property

+
  "state-reason"             guint                 : Read
+

+The reason for the device state. +

+

Default value: 0

+
+
+
+

The "udi" property

+
  "udi"                      gchar*                : Read
+

+An operating-system specific device hardware identifier; this is not +unique to a specific hardware device across reboots or hotplugs. It +is an opaque string which for some device types (Bluetooth, Modem) +contains an identifier provided by the underlying hardware service daemon +such as Bluez or ModemManager, and clients can use this property to +request more information about the device from those services. +

+

Default value: NULL

+
+
+
+

The "vendor" property

+
  "vendor"                   gchar*                : Read
+

+The vendor string of the device. +

+

Default value: NULL

+
+
+
+

Signal Details

+
+

The "state-changed" signal

+
void                user_function                      (NMDevice *device,
+                                                        guint     new_state,
+                                                        guint     old_state,
+                                                        guint     reason,
+                                                        gpointer  user_data)      : Run First
+

+Notifies the state change of a NMDevice. +

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

device :

the device object that received the signal

new_state :

the new state of the device

old_state :

the previous state of the device

reason :

the reason describing the state change

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceAdsl.html b/docs/libnm/html/NMDeviceAdsl.html new file mode 100644 index 00000000..e983c287 --- /dev/null +++ b/docs/libnm/html/NMDeviceAdsl.html @@ -0,0 +1,147 @@ + + + + +NMDeviceAdsl + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceAdsl

+

NMDeviceAdsl

+
+
+

Synopsis

+
#define             NM_DEVICE_ADSL_CARRIER
+struct              NMDeviceAdsl;
+                    NMDeviceAdslClass;
+gboolean            nm_device_adsl_get_carrier          (NMDeviceAdsl *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceAdsl
+
+
+
+

Implemented Interfaces

+

+NMDeviceAdsl implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_ADSL_CARRIER

+
#define NM_DEVICE_ADSL_CARRIER "carrier"
+
+

+

+
+
+
+

struct NMDeviceAdsl

+
struct NMDeviceAdsl;
+

+

+
+
+
+

NMDeviceAdslClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceAdslClass;
+
+

+

+
+
+
+

nm_device_adsl_get_carrier ()

+
gboolean            nm_device_adsl_get_carrier          (NMDeviceAdsl *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceAdsl +

Returns :

 +TRUE if the device has carrier
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceBond.html b/docs/libnm/html/NMDeviceBond.html new file mode 100644 index 00000000..7213a45a --- /dev/null +++ b/docs/libnm/html/NMDeviceBond.html @@ -0,0 +1,243 @@ + + + + +NMDeviceBond + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceBond

+

NMDeviceBond

+
+
+

Synopsis

+
#define             NM_DEVICE_BOND_HW_ADDRESS
+#define             NM_DEVICE_BOND_CARRIER
+#define             NM_DEVICE_BOND_SLAVES
+struct              NMDeviceBond;
+                    NMDeviceBondClass;
+const char *        nm_device_bond_get_hw_address       (NMDeviceBond *device);
+gboolean            nm_device_bond_get_carrier          (NMDeviceBond *device);
+const GPtrArray *   nm_device_bond_get_slaves           (NMDeviceBond *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceBond
+
+
+
+

Implemented Interfaces

+

+NMDeviceBond implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "slaves"                   GPtrArray*            : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_BOND_HW_ADDRESS

+
#define NM_DEVICE_BOND_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_BOND_CARRIER

+
#define NM_DEVICE_BOND_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_BOND_SLAVES

+
#define NM_DEVICE_BOND_SLAVES      "slaves"
+
+

+

+
+
+
+

struct NMDeviceBond

+
struct NMDeviceBond;
+

+

+
+
+
+

NMDeviceBondClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceBondClass;
+
+

+

+
+
+
+

nm_device_bond_get_hw_address ()

+
const char *        nm_device_bond_get_hw_address       (NMDeviceBond *device);
+

+Gets the hardware (MAC) address of the NMDeviceBond +

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

device :

a NMDeviceBond +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_bond_get_carrier ()

+
gboolean            nm_device_bond_get_carrier          (NMDeviceBond *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceBond +

Returns :

 +TRUE if the device has carrier
+
+
+
+

nm_device_bond_get_slaves ()

+
const GPtrArray *   nm_device_bond_get_slaves           (NMDeviceBond *device);
+

+Gets the devices currently slaved to device. +

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

device :

a NMDeviceBond +

Returns :

the GPtrArray containing +NMDevices that are slaves of device. This is the internal +copy used by the device, and must not be modified. [element-type NMDevice] +
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "slaves" property

+
  "slaves"                   GPtrArray*            : Read
+

+The devices slaved to the bond device. +

+

+Element-type: NMDevice +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceBridge.html b/docs/libnm/html/NMDeviceBridge.html new file mode 100644 index 00000000..14ed6a10 --- /dev/null +++ b/docs/libnm/html/NMDeviceBridge.html @@ -0,0 +1,243 @@ + + + + +NMDeviceBridge + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceBridge

+

NMDeviceBridge

+
+
+

Synopsis

+
#define             NM_DEVICE_BRIDGE_HW_ADDRESS
+#define             NM_DEVICE_BRIDGE_CARRIER
+#define             NM_DEVICE_BRIDGE_SLAVES
+struct              NMDeviceBridge;
+                    NMDeviceBridgeClass;
+const char *        nm_device_bridge_get_hw_address     (NMDeviceBridge *device);
+gboolean            nm_device_bridge_get_carrier        (NMDeviceBridge *device);
+const GPtrArray *   nm_device_bridge_get_slaves         (NMDeviceBridge *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceBridge
+
+
+
+

Implemented Interfaces

+

+NMDeviceBridge implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "slaves"                   GPtrArray*            : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_BRIDGE_HW_ADDRESS

+
#define NM_DEVICE_BRIDGE_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_BRIDGE_CARRIER

+
#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_BRIDGE_SLAVES

+
#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
+
+

+

+
+
+
+

struct NMDeviceBridge

+
struct NMDeviceBridge;
+

+

+
+
+
+

NMDeviceBridgeClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceBridgeClass;
+
+

+

+
+
+
+

nm_device_bridge_get_hw_address ()

+
const char *        nm_device_bridge_get_hw_address     (NMDeviceBridge *device);
+

+Gets the hardware (MAC) address of the NMDeviceBridge +

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

device :

a NMDeviceBridge +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_bridge_get_carrier ()

+
gboolean            nm_device_bridge_get_carrier        (NMDeviceBridge *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceBridge +

Returns :

 +TRUE if the device has carrier
+
+
+
+

nm_device_bridge_get_slaves ()

+
const GPtrArray *   nm_device_bridge_get_slaves         (NMDeviceBridge *device);
+

+Gets the devices currently slaved to device. +

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

device :

a NMDeviceBridge +

Returns :

the GPtrArray containing +NMDevices that are slaves of device. This is the internal +copy used by the device, and must not be modified. [element-type NMDevice] +
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "slaves" property

+
  "slaves"                   GPtrArray*            : Read
+

+The devices slaved to the bridge device. +

+

+Element-type: NMDevice +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceBt.html b/docs/libnm/html/NMDeviceBt.html new file mode 100644 index 00000000..d074d0bf --- /dev/null +++ b/docs/libnm/html/NMDeviceBt.html @@ -0,0 +1,237 @@ + + + + +NMDeviceBt + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceBt

+

NMDeviceBt

+
+
+

Synopsis

+
#define             NM_DEVICE_BT_HW_ADDRESS
+#define             NM_DEVICE_BT_NAME
+#define             NM_DEVICE_BT_CAPABILITIES
+struct              NMDeviceBt;
+                    NMDeviceBtClass;
+const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);
+const char *        nm_device_bt_get_name               (NMDeviceBt *device);
+NMBluetoothCapabilities nm_device_bt_get_capabilities   (NMDeviceBt *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceBt
+
+
+
+

Implemented Interfaces

+

+NMDeviceBt implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "bt-capabilities"          NMBluetoothCapabilities  : Read
+  "hw-address"               gchar*                : Read
+  "name"                     gchar*                : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_BT_HW_ADDRESS

+
#define NM_DEVICE_BT_HW_ADDRESS   "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_BT_NAME

+
#define NM_DEVICE_BT_NAME         "name"
+
+

+

+
+
+
+

NM_DEVICE_BT_CAPABILITIES

+
#define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"
+
+

+

+
+
+
+

struct NMDeviceBt

+
struct NMDeviceBt;
+

+

+
+
+
+

NMDeviceBtClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceBtClass;
+
+

+

+
+
+
+

nm_device_bt_get_hw_address ()

+
const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);
+

+Gets the hardware (MAC) address of the NMDeviceBt +

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

device :

a NMDeviceBt +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_bt_get_name ()

+
const char *        nm_device_bt_get_name               (NMDeviceBt *device);
+

+Gets the name of the NMDeviceBt. +

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

device :

a NMDeviceBt +

Returns :

the name of the device
+
+
+
+

nm_device_bt_get_capabilities ()

+
NMBluetoothCapabilities nm_device_bt_get_capabilities   (NMDeviceBt *device);
+

+Returns the Bluetooth device's usable capabilities. +

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

device :

a NMDeviceBt +

Returns :

a combination of NMBluetoothCapabilities +
+
+
+
+

Property Details

+
+

The "bt-capabilities" property

+
  "bt-capabilities"          NMBluetoothCapabilities  : Read
+

+The device's bluetooth capabilities, a combination of NMBluetoothCapabilities. +

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "name" property

+
  "name"                     gchar*                : Read
+

+The name of the bluetooth device. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceEthernet.html b/docs/libnm/html/NMDeviceEthernet.html new file mode 100644 index 00000000..2b5681d9 --- /dev/null +++ b/docs/libnm/html/NMDeviceEthernet.html @@ -0,0 +1,286 @@ + + + + +NMDeviceEthernet + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceEthernet

+

NMDeviceEthernet

+
+
+

Synopsis

+
#define             NM_DEVICE_ETHERNET_HW_ADDRESS
+#define             NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS
+#define             NM_DEVICE_ETHERNET_SPEED
+#define             NM_DEVICE_ETHERNET_CARRIER
+struct              NMDeviceEthernet;
+                    NMDeviceEthernetClass;
+const char *        nm_device_ethernet_get_hw_address   (NMDeviceEthernet *device);
+const char *        nm_device_ethernet_get_permanent_hw_address
+                                                        (NMDeviceEthernet *device);
+guint32             nm_device_ethernet_get_speed        (NMDeviceEthernet *device);
+gboolean            nm_device_ethernet_get_carrier      (NMDeviceEthernet *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceEthernet
+
+
+
+

Implemented Interfaces

+

+NMDeviceEthernet implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "perm-hw-address"          gchar*                : Read
+  "speed"                    guint                 : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_ETHERNET_HW_ADDRESS

+
#define NM_DEVICE_ETHERNET_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS

+
#define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
+
+

+

+
+
+
+

NM_DEVICE_ETHERNET_SPEED

+
#define NM_DEVICE_ETHERNET_SPEED       "speed"
+
+

+

+
+
+
+

NM_DEVICE_ETHERNET_CARRIER

+
#define NM_DEVICE_ETHERNET_CARRIER     "carrier"
+
+

+

+
+
+
+

struct NMDeviceEthernet

+
struct NMDeviceEthernet;
+

+

+
+
+
+

NMDeviceEthernetClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceEthernetClass;
+
+

+

+
+
+
+

nm_device_ethernet_get_hw_address ()

+
const char *        nm_device_ethernet_get_hw_address   (NMDeviceEthernet *device);
+

+Gets the active hardware (MAC) address of the NMDeviceEthernet +

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

device :

a NMDeviceEthernet +

Returns :

the active hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_ethernet_get_permanent_hw_address ()

+
const char *        nm_device_ethernet_get_permanent_hw_address
+                                                        (NMDeviceEthernet *device);
+

+Gets the permanent hardware (MAC) address of the NMDeviceEthernet +

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

device :

a NMDeviceEthernet +

Returns :

the permanent hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_ethernet_get_speed ()

+
guint32             nm_device_ethernet_get_speed        (NMDeviceEthernet *device);
+

+Gets the speed of the NMDeviceEthernet. +

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

device :

a NMDeviceEthernet +

Returns :

the speed of the device
+
+
+
+

nm_device_ethernet_get_carrier ()

+
gboolean            nm_device_ethernet_get_carrier      (NMDeviceEthernet *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceEthernet +

Returns :

 +TRUE if the device has carrier
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The active hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "perm-hw-address" property

+
  "perm-hw-address"          gchar*                : Read
+

+The permanent hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "speed" property

+
  "speed"                    guint                 : Read
+

+The speed of the device. +

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceGeneric.html b/docs/libnm/html/NMDeviceGeneric.html new file mode 100644 index 00000000..3efbf0a6 --- /dev/null +++ b/docs/libnm/html/NMDeviceGeneric.html @@ -0,0 +1,167 @@ + + + + +NMDeviceGeneric + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceGeneric

+

NMDeviceGeneric

+
+
+

Synopsis

+
#define             NM_DEVICE_GENERIC_HW_ADDRESS
+#define             NM_DEVICE_GENERIC_TYPE_DESCRIPTION
+struct              NMDeviceGeneric;
+                    NMDeviceGenericClass;
+const char *        nm_device_generic_get_hw_address    (NMDeviceGeneric *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceGeneric
+
+
+
+

Implemented Interfaces

+

+NMDeviceGeneric implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "hw-address"               gchar*                : Read
+  "type-description"         gchar*                : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_GENERIC_HW_ADDRESS

+
#define NM_DEVICE_GENERIC_HW_ADDRESS       "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_GENERIC_TYPE_DESCRIPTION

+
#define NM_DEVICE_GENERIC_TYPE_DESCRIPTION "type-description"
+
+

+

+
+
+
+

struct NMDeviceGeneric

+
struct NMDeviceGeneric;
+

+

+
+
+
+

NMDeviceGenericClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceGenericClass;
+
+

+

+
+
+
+

nm_device_generic_get_hw_address ()

+
const char *        nm_device_generic_get_hw_address    (NMDeviceGeneric *device);
+

+Gets the hardware address of the NMDeviceGeneric +

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

device :

a NMDeviceGeneric +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

Property Details

+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware address of the device. +

+

Default value: NULL

+
+
+
+

The "type-description" property

+
  "type-description"         gchar*                : Read
+

+A description of the specific type of device this is, or NULL +if not known. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceInfiniband.html b/docs/libnm/html/NMDeviceInfiniband.html new file mode 100644 index 00000000..b5646e85 --- /dev/null +++ b/docs/libnm/html/NMDeviceInfiniband.html @@ -0,0 +1,193 @@ + + + + +NMDeviceInfiniband + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceInfiniband

+

NMDeviceInfiniband

+
+
+

Synopsis

+
#define             NM_DEVICE_INFINIBAND_HW_ADDRESS
+#define             NM_DEVICE_INFINIBAND_CARRIER
+struct              NMDeviceInfiniband;
+                    NMDeviceInfinibandClass;
+const char *        nm_device_infiniband_get_hw_address (NMDeviceInfiniband *device);
+gboolean            nm_device_infiniband_get_carrier    (NMDeviceInfiniband *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceInfiniband
+
+
+
+

Implemented Interfaces

+

+NMDeviceInfiniband implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_INFINIBAND_HW_ADDRESS

+
#define NM_DEVICE_INFINIBAND_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_INFINIBAND_CARRIER

+
#define NM_DEVICE_INFINIBAND_CARRIER     "carrier"
+
+

+

+
+
+
+

struct NMDeviceInfiniband

+
struct NMDeviceInfiniband;
+

+

+
+
+
+

NMDeviceInfinibandClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceInfinibandClass;
+
+

+

+
+
+
+

nm_device_infiniband_get_hw_address ()

+
const char *        nm_device_infiniband_get_hw_address (NMDeviceInfiniband *device);
+

+Gets the hardware (MAC) address of the NMDeviceInfiniband +

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

device :

a NMDeviceInfiniband +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_infiniband_get_carrier ()

+
gboolean            nm_device_infiniband_get_carrier    (NMDeviceInfiniband *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceInfiniband +

Returns :

 +TRUE if the device has carrier
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceModem.html b/docs/libnm/html/NMDeviceModem.html new file mode 100644 index 00000000..12e5d37d --- /dev/null +++ b/docs/libnm/html/NMDeviceModem.html @@ -0,0 +1,202 @@ + + + + +NMDeviceModem + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceModem

+

NMDeviceModem

+
+
+

Synopsis

+
#define             NM_DEVICE_MODEM_MODEM_CAPABILITIES
+#define             NM_DEVICE_MODEM_CURRENT_CAPABILITIES
+struct              NMDeviceModem;
+                    NMDeviceModemClass;
+NMDeviceModemCapabilities nm_device_modem_get_modem_capabilities
+                                                        (NMDeviceModem *self);
+NMDeviceModemCapabilities nm_device_modem_get_current_capabilities
+                                                        (NMDeviceModem *self);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceModem
+
+
+
+

Implemented Interfaces

+

+NMDeviceModem implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "current-capabilities"     NMDeviceModemCapabilities  : Read
+  "modem-capabilities"       NMDeviceModemCapabilities  : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_MODEM_MODEM_CAPABILITIES

+
#define NM_DEVICE_MODEM_MODEM_CAPABILITIES   "modem-capabilities"
+
+

+

+
+
+
+

NM_DEVICE_MODEM_CURRENT_CAPABILITIES

+
#define NM_DEVICE_MODEM_CURRENT_CAPABILITIES "current-capabilities"
+
+

+

+
+
+
+

struct NMDeviceModem

+
struct NMDeviceModem;
+

+

+
+
+
+

NMDeviceModemClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceModemClass;
+
+

+

+
+
+
+

nm_device_modem_get_modem_capabilities ()

+
NMDeviceModemCapabilities nm_device_modem_get_modem_capabilities
+                                                        (NMDeviceModem *self);
+

+Returns a bitfield of the generic access technology families the modem +supports. Not all capabilities are available concurrently however; some +may require a firmware reload or reinitialization. +

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

self :

a NMDeviceModem +

Returns :

the generic access technology families the modem supports
+
+
+
+

nm_device_modem_get_current_capabilities ()

+
NMDeviceModemCapabilities nm_device_modem_get_current_capabilities
+                                                        (NMDeviceModem *self);
+

+Returns a bitfield of the generic access technology families the modem +supports without a firmware reload or reinitialization. This value +represents the network types the modem can immediately connect to. +

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

self :

a NMDeviceModem +

Returns :

the generic access technology families the modem supports without +a firmware reload or other reinitialization
+
+
+
+

Property Details

+
+

The "current-capabilities" property

+
  "current-capabilities"     NMDeviceModemCapabilities  : Read
+

+The generic family of access technologies the modem currently supports +without a firmware reload or reinitialization. +

+
+
+
+

The "modem-capabilities" property

+
  "modem-capabilities"       NMDeviceModemCapabilities  : Read
+

+The generic family of access technologies the modem supports. Not all +capabilities are available at the same time however; some modems require +a firmware reload or other reinitialization to switch between eg +CDMA/EVDO and GSM/UMTS. +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceOlpcMesh.html b/docs/libnm/html/NMDeviceOlpcMesh.html new file mode 100644 index 00000000..88a6d71b --- /dev/null +++ b/docs/libnm/html/NMDeviceOlpcMesh.html @@ -0,0 +1,239 @@ + + + + +NMDeviceOlpcMesh + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceOlpcMesh

+

NMDeviceOlpcMesh

+
+
+

Synopsis

+
#define             NM_DEVICE_OLPC_MESH_HW_ADDRESS
+#define             NM_DEVICE_OLPC_MESH_COMPANION
+#define             NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL
+struct              NMDeviceOlpcMesh;
+                    NMDeviceOlpcMeshClass;
+const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);
+NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);
+guint32             nm_device_olpc_mesh_get_active_channel
+                                                        (NMDeviceOlpcMesh *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceOlpcMesh
+
+
+
+

Implemented Interfaces

+

+NMDeviceOlpcMesh implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "active-channel"           guint                 : Read
+  "companion"                NMDeviceWifi*         : Read
+  "hw-address"               gchar*                : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_OLPC_MESH_HW_ADDRESS

+
#define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_OLPC_MESH_COMPANION

+
#define NM_DEVICE_OLPC_MESH_COMPANION      "companion"
+
+

+

+
+
+
+

NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

+
#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
+
+

+

+
+
+
+

struct NMDeviceOlpcMesh

+
struct NMDeviceOlpcMesh;
+

+

+
+
+
+

NMDeviceOlpcMeshClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceOlpcMeshClass;
+
+

+

+
+
+
+

nm_device_olpc_mesh_get_hw_address ()

+
const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);
+

+Gets the hardware (MAC) address of the NMDeviceOlpcMesh +

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

device :

a NMDeviceOlpcMesh +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_olpc_mesh_get_companion ()

+
NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);
+

+Gets the companion device of the NMDeviceOlpcMesh. +

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

device :

a NMDeviceOlpcMesh +

Returns :

the companion of the device of NULL. [transfer none] +
+
+
+
+

nm_device_olpc_mesh_get_active_channel ()

+
guint32             nm_device_olpc_mesh_get_active_channel
+                                                        (NMDeviceOlpcMesh *device);
+

+Returns the active channel of the NMDeviceOlpcMesh device. +

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

device :

a NMDeviceOlpcMesh +

Returns :

active channel of the device
+
+
+
+

Property Details

+
+

The "active-channel" property

+
  "active-channel"           guint                 : Read
+

+The device's active channel. +

+

Default value: 0

+
+
+
+

The "companion" property

+
  "companion"                NMDeviceWifi*         : Read
+

+The companion device. +

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceTeam.html b/docs/libnm/html/NMDeviceTeam.html new file mode 100644 index 00000000..9edc63f6 --- /dev/null +++ b/docs/libnm/html/NMDeviceTeam.html @@ -0,0 +1,243 @@ + + + + +NMDeviceTeam + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceTeam

+

NMDeviceTeam

+
+
+

Synopsis

+
#define             NM_DEVICE_TEAM_HW_ADDRESS
+#define             NM_DEVICE_TEAM_CARRIER
+#define             NM_DEVICE_TEAM_SLAVES
+struct              NMDeviceTeam;
+                    NMDeviceTeamClass;
+const char *        nm_device_team_get_hw_address       (NMDeviceTeam *device);
+gboolean            nm_device_team_get_carrier          (NMDeviceTeam *device);
+const GPtrArray *   nm_device_team_get_slaves           (NMDeviceTeam *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceTeam
+
+
+
+

Implemented Interfaces

+

+NMDeviceTeam implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "slaves"                   GPtrArray*            : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_TEAM_HW_ADDRESS

+
#define NM_DEVICE_TEAM_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_TEAM_CARRIER

+
#define NM_DEVICE_TEAM_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_TEAM_SLAVES

+
#define NM_DEVICE_TEAM_SLAVES      "slaves"
+
+

+

+
+
+
+

struct NMDeviceTeam

+
struct NMDeviceTeam;
+

+

+
+
+
+

NMDeviceTeamClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceTeamClass;
+
+

+

+
+
+
+

nm_device_team_get_hw_address ()

+
const char *        nm_device_team_get_hw_address       (NMDeviceTeam *device);
+

+Gets the hardware (MAC) address of the NMDeviceTeam +

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

device :

a NMDeviceTeam +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_team_get_carrier ()

+
gboolean            nm_device_team_get_carrier          (NMDeviceTeam *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceTeam +

Returns :

 +TRUE if the device has carrier
+
+
+
+

nm_device_team_get_slaves ()

+
const GPtrArray *   nm_device_team_get_slaves           (NMDeviceTeam *device);
+

+Gets the devices currently enslaved to device. +

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

device :

a NMDeviceTeam +

Returns :

the GPtrArray containing +NMDevices that are slaves of device. This is the internal +copy used by the device, and must not be modified. [element-type NMDevice] +
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "slaves" property

+
  "slaves"                   GPtrArray*            : Read
+

+The devices enslaved to the team device. +

+

+Element-type: NMDevice +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceVlan.html b/docs/libnm/html/NMDeviceVlan.html new file mode 100644 index 00000000..7351cc96 --- /dev/null +++ b/docs/libnm/html/NMDeviceVlan.html @@ -0,0 +1,278 @@ + + + + +NMDeviceVlan + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceVlan

+

NMDeviceVlan

+
+
+

Synopsis

+
#define             NM_DEVICE_VLAN_HW_ADDRESS
+#define             NM_DEVICE_VLAN_CARRIER
+#define             NM_DEVICE_VLAN_PARENT
+#define             NM_DEVICE_VLAN_VLAN_ID
+struct              NMDeviceVlan;
+                    NMDeviceVlanClass;
+const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);
+gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);
+NMDevice *          nm_device_vlan_get_parent           (NMDeviceVlan *device);
+guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceVlan
+
+
+
+

Implemented Interfaces

+

+NMDeviceVlan implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "parent"                   NMDevice*             : Read
+  "vlan-id"                  guint                 : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_VLAN_HW_ADDRESS

+
#define NM_DEVICE_VLAN_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_VLAN_CARRIER

+
#define NM_DEVICE_VLAN_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_VLAN_PARENT

+
#define NM_DEVICE_VLAN_PARENT      "parent"
+
+

+

+
+
+
+

NM_DEVICE_VLAN_VLAN_ID

+
#define NM_DEVICE_VLAN_VLAN_ID     "vlan-id"
+
+

+

+
+
+
+

struct NMDeviceVlan

+
struct NMDeviceVlan;
+

+

+
+
+
+

NMDeviceVlanClass

+
typedef struct {
+	NMDeviceClass parent;
+} NMDeviceVlanClass;
+
+

+

+
+
+
+

nm_device_vlan_get_hw_address ()

+
const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);
+

+Gets the hardware (MAC) address of the NMDeviceVlan +

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

device :

a NMDeviceVlan +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_vlan_get_carrier ()

+
gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceVlan +

Returns :

 +TRUE if the device has carrier
+
+
+
+

nm_device_vlan_get_parent ()

+
NMDevice *          nm_device_vlan_get_parent           (NMDeviceVlan *device);
+
++++ + + + + + + + + + + +

device :

a NMDeviceVlan +

Returns :

the device's parent device. [transfer none] +
+
+
+
+

nm_device_vlan_get_vlan_id ()

+
guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);
+
++++ + + + + + + + + + + +

device :

a NMDeviceVlan +

Returns :

the device's VLAN ID
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "parent" property

+
  "parent"                   NMDevice*             : Read
+

+The devices's parent device. +

+
+
+
+

The "vlan-id" property

+
  "vlan-id"                  guint                 : Read
+

+The device's VLAN ID. +

+

Allowed values: <= 4095

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceWifi.html b/docs/libnm/html/NMDeviceWifi.html new file mode 100644 index 00000000..4fce8985 --- /dev/null +++ b/docs/libnm/html/NMDeviceWifi.html @@ -0,0 +1,668 @@ + + + + +NMDeviceWifi + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceWifi

+

NMDeviceWifi

+
+
+

Synopsis

+
#define             NM_DEVICE_WIFI_HW_ADDRESS
+#define             NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS
+#define             NM_DEVICE_WIFI_MODE
+#define             NM_DEVICE_WIFI_BITRATE
+#define             NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
+#define             NM_DEVICE_WIFI_CAPABILITIES
+#define             NM_DEVICE_WIFI_ACCESS_POINTS
+struct              NMDeviceWifi;
+                    NMDeviceWifiClass;
+const char *        nm_device_wifi_get_hw_address       (NMDeviceWifi *device);
+const char *        nm_device_wifi_get_permanent_hw_address
+                                                        (NMDeviceWifi *device);
+NM80211Mode         nm_device_wifi_get_mode             (NMDeviceWifi *device);
+guint32             nm_device_wifi_get_bitrate          (NMDeviceWifi *device);
+NMDeviceWifiCapabilities nm_device_wifi_get_capabilities
+                                                        (NMDeviceWifi *device);
+NMAccessPoint *     nm_device_wifi_get_active_access_point
+                                                        (NMDeviceWifi *device);
+NMAccessPoint *     nm_device_wifi_get_access_point_by_path
+                                                        (NMDeviceWifi *device,
+                                                         const char *path);
+const GPtrArray *   nm_device_wifi_get_access_points    (NMDeviceWifi *device);
+gboolean            nm_device_wifi_request_scan         (NMDeviceWifi *device,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_device_wifi_request_scan_async   (NMDeviceWifi *device,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_device_wifi_request_scan_finish  (NMDeviceWifi *device,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceWifi
+
+
+
+

Implemented Interfaces

+

+NMDeviceWifi implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "access-points"            GPtrArray*            : Read
+  "active-access-point"      NMAccessPoint*        : Read
+  "bitrate"                  guint                 : Read
+  "hw-address"               gchar*                : Read
+  "mode"                     NM80211Mode           : Read
+  "perm-hw-address"          gchar*                : Read
+  "wireless-capabilities"    NMDeviceWifiCapabilities  : Read
+
+
+
+

Signals

+
+  "access-point-added"                             : Run First
+  "access-point-removed"                           : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_WIFI_HW_ADDRESS

+
#define NM_DEVICE_WIFI_HW_ADDRESS          "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

+
#define NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS "perm-hw-address"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_MODE

+
#define NM_DEVICE_WIFI_MODE                "mode"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_BITRATE

+
#define NM_DEVICE_WIFI_BITRATE             "bitrate"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT

+
#define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_CAPABILITIES

+
#define NM_DEVICE_WIFI_CAPABILITIES        "wireless-capabilities"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_ACCESS_POINTS

+
#define NM_DEVICE_WIFI_ACCESS_POINTS       "access-points"
+
+

+

+
+
+
+

struct NMDeviceWifi

+
struct NMDeviceWifi;
+

+

+
+
+
+

NMDeviceWifiClass

+
typedef struct {
+	NMDeviceClass parent;
+
+	/* Signals */
+	void (*access_point_added) (NMDeviceWifi *device, NMAccessPoint *ap);
+	void (*access_point_removed) (NMDeviceWifi *device, NMAccessPoint *ap);
+} NMDeviceWifiClass;
+
+

+

+
+
+
+

nm_device_wifi_get_hw_address ()

+
const char *        nm_device_wifi_get_hw_address       (NMDeviceWifi *device);
+

+Gets the actual hardware (MAC) address of the NMDeviceWifi +

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

device :

a NMDeviceWifi +

Returns :

the actual hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_wifi_get_permanent_hw_address ()

+
const char *        nm_device_wifi_get_permanent_hw_address
+                                                        (NMDeviceWifi *device);
+

+Gets the permanent hardware (MAC) address of the NMDeviceWifi +

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

device :

a NMDeviceWifi +

Returns :

the permanent hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_wifi_get_mode ()

+
NM80211Mode         nm_device_wifi_get_mode             (NMDeviceWifi *device);
+

+Gets the NMDeviceWifi mode. +

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

device :

a NMDeviceWifi +

Returns :

the mode
+
+
+
+

nm_device_wifi_get_bitrate ()

+
guint32             nm_device_wifi_get_bitrate          (NMDeviceWifi *device);
+

+Gets the bit rate of the NMDeviceWifi in kbit/s. +

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

device :

a NMDeviceWifi +

Returns :

the bit rate (kbit/s)
+
+
+
+

nm_device_wifi_get_capabilities ()

+
NMDeviceWifiCapabilities nm_device_wifi_get_capabilities
+                                                        (NMDeviceWifi *device);
+

+Gets the Wi-Fi capabilities of the NMDeviceWifi. +

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

device :

a NMDeviceWifi +

Returns :

the capabilities
+
+
+
+

nm_device_wifi_get_active_access_point ()

+
NMAccessPoint *     nm_device_wifi_get_active_access_point
+                                                        (NMDeviceWifi *device);
+

+Gets the active NMAccessPoint. +

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

device :

a NMDeviceWifi +

Returns :

the access point or NULL if none is active. [transfer none] +
+
+
+
+

nm_device_wifi_get_access_point_by_path ()

+
NMAccessPoint *     nm_device_wifi_get_access_point_by_path
+                                                        (NMDeviceWifi *device,
+                                                         const char *path);
+

+Gets a NMAccessPoint by path. +

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

device :

a NMDeviceWifi +

path :

the object path of the access point

Returns :

the access point or NULL if none is found. [transfer none] +
+
+
+
+

nm_device_wifi_get_access_points ()

+
const GPtrArray *   nm_device_wifi_get_access_points    (NMDeviceWifi *device);
+

+Gets all the scanned access points of the NMDeviceWifi. +

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

device :

a NMDeviceWifi +

Returns :

a GPtrArray containing all the +scanned NMAccessPoints. +The returned array is owned by the client and should not be modified. [element-type NMAccessPoint] +
+
+
+
+

nm_device_wifi_request_scan ()

+
gboolean            nm_device_wifi_request_scan         (NMDeviceWifi *device,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Request NM to scan for access points on device. Note that the function +returns immediately after requesting the scan, and it may take some time +after that for the scan to complete. +

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

device :

a NMDeviceWifi +

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be +set.
+
+
+
+

nm_device_wifi_request_scan_async ()

+
void                nm_device_wifi_request_scan_async   (NMDeviceWifi *device,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Request NM to scan for access points on device. Note that callback will be +called immediately after requesting the scan, and it may take some time after +that for the scan to complete. +

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

device :

a NMDeviceWifi +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the scan has been requested

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_device_wifi_request_scan_finish ()

+
gboolean            nm_device_wifi_request_scan_finish  (NMDeviceWifi *device,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_device_wifi_request_scan_async(). +

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

device :

a NMDeviceWifi +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be +set.
+
+
+
+

Property Details

+
+

The "access-points" property

+
  "access-points"            GPtrArray*            : Read
+

+List of all Wi-Fi access points the device can see. +

+

+Element-type: NMAccessPoint +

+
+
+
+

The "active-access-point" property

+
  "active-access-point"      NMAccessPoint*        : Read
+

+The active NMAccessPoint of the device. +

+
+
+
+

The "bitrate" property

+
  "bitrate"                  guint                 : Read
+

+The bit rate of the device in kbit/s. +

+

Default value: 0

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "mode" property

+
  "mode"                     NM80211Mode           : Read
+

+The mode of the device. +

+

Default value: NM_802_11_MODE_UNKNOWN

+
+
+
+

The "perm-hw-address" property

+
  "perm-hw-address"          gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "wireless-capabilities" property

+
  "wireless-capabilities"    NMDeviceWifiCapabilities  : Read
+

+The wireless capabilities of the device. +

+
+
+
+

Signal Details

+
+

The "access-point-added" signal

+
void                user_function                      (NMDeviceWifi *device,
+                                                        GObject      *ap,
+                                                        gpointer      user_data)      : Run First
+

+Notifies that a NMAccessPoint is added to the Wi-Fi device. +

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

device :

the Wi-Fi device that received the signal

ap :

the new access point

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "access-point-removed" signal

+
void                user_function                      (NMDeviceWifi *device,
+                                                        GObject      *ap,
+                                                        gpointer      user_data)      : Run First
+

+Notifies that a NMAccessPoint is removed from the Wi-Fi device. +

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

device :

the Wi-Fi device that received the signal

ap :

the removed access point

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDeviceWimax.html b/docs/libnm/html/NMDeviceWimax.html new file mode 100644 index 00000000..2a97f81d --- /dev/null +++ b/docs/libnm/html/NMDeviceWimax.html @@ -0,0 +1,597 @@ + + + + +NMDeviceWimax + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceWimax

+

NMDeviceWimax

+
+
+

Synopsis

+
#define             NM_DEVICE_WIMAX_HW_ADDRESS
+#define             NM_DEVICE_WIMAX_ACTIVE_NSP
+#define             NM_DEVICE_WIMAX_CENTER_FREQUENCY
+#define             NM_DEVICE_WIMAX_RSSI
+#define             NM_DEVICE_WIMAX_CINR
+#define             NM_DEVICE_WIMAX_TX_POWER
+#define             NM_DEVICE_WIMAX_BSID
+#define             NM_DEVICE_WIMAX_NSPS
+struct              NMDeviceWimax;
+                    NMDeviceWimaxClass;
+const char *        nm_device_wimax_get_hw_address      (NMDeviceWimax *wimax);
+NMWimaxNsp *        nm_device_wimax_get_active_nsp      (NMDeviceWimax *wimax);
+NMWimaxNsp *        nm_device_wimax_get_nsp_by_path     (NMDeviceWimax *wimax,
+                                                         const char *path);
+const GPtrArray *   nm_device_wimax_get_nsps            (NMDeviceWimax *wimax);
+guint               nm_device_wimax_get_center_frequency
+                                                        (NMDeviceWimax *self);
+gint                nm_device_wimax_get_rssi            (NMDeviceWimax *self);
+gint                nm_device_wimax_get_cinr            (NMDeviceWimax *self);
+gint                nm_device_wimax_get_tx_power        (NMDeviceWimax *self);
+const char *        nm_device_wimax_get_bsid            (NMDeviceWimax *self);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceWimax
+
+
+
+

Implemented Interfaces

+

+NMDeviceWimax implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "active-nsp"               NMWimaxNsp*           : Read
+  "bsid"                     gchar*                : Read
+  "center-frequency"         guint                 : Read
+  "cinr"                     gint                  : Read
+  "hw-address"               gchar*                : Read
+  "nsps"                     GPtrArray*            : Read
+  "rssi"                     gint                  : Read
+  "tx-power"                 gint                  : Read
+
+
+
+

Signals

+
+  "nsp-added"                                      : Run First
+  "nsp-removed"                                    : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_WIMAX_HW_ADDRESS

+
#define NM_DEVICE_WIMAX_HW_ADDRESS       "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_ACTIVE_NSP

+
#define NM_DEVICE_WIMAX_ACTIVE_NSP       "active-nsp"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_CENTER_FREQUENCY

+
#define NM_DEVICE_WIMAX_CENTER_FREQUENCY "center-frequency"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_RSSI

+
#define NM_DEVICE_WIMAX_RSSI             "rssi"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_CINR

+
#define NM_DEVICE_WIMAX_CINR             "cinr"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_TX_POWER

+
#define NM_DEVICE_WIMAX_TX_POWER         "tx-power"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_BSID

+
#define NM_DEVICE_WIMAX_BSID             "bsid"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_NSPS

+
#define NM_DEVICE_WIMAX_NSPS             "nsps"
+
+

+

+
+
+
+

struct NMDeviceWimax

+
struct NMDeviceWimax;
+

+

+
+
+
+

NMDeviceWimaxClass

+
typedef struct {
+	NMDeviceClass parent;
+
+	/* Signals */
+	void (*nsp_added)   (NMDeviceWimax *self, NMWimaxNsp *nsp);
+	void (*nsp_removed) (NMDeviceWimax *self, NMWimaxNsp *nsp);
+} NMDeviceWimaxClass;
+
+

+

+
+
+
+

nm_device_wimax_get_hw_address ()

+
const char *        nm_device_wimax_get_hw_address      (NMDeviceWimax *wimax);
+

+Gets the hardware (MAC) address of the NMDeviceWimax +

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

wimax :

a NMDeviceWimax +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
+
+
+
+

nm_device_wimax_get_active_nsp ()

+
NMWimaxNsp *        nm_device_wimax_get_active_nsp      (NMDeviceWimax *wimax);
+

+Gets the active NMWimaxNsp. +

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

wimax :

a NMDeviceWimax +

Returns :

the access point or NULL if none is active. [transfer full] +
+
+
+
+

nm_device_wimax_get_nsp_by_path ()

+
NMWimaxNsp *        nm_device_wimax_get_nsp_by_path     (NMDeviceWimax *wimax,
+                                                         const char *path);
+

+Gets a NMWimaxNsp by path. +

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

wimax :

a NMDeviceWimax +

path :

the object path of the NSP

Returns :

the access point or NULL if none is found. [transfer none] +
+
+
+
+

nm_device_wimax_get_nsps ()

+
const GPtrArray *   nm_device_wimax_get_nsps            (NMDeviceWimax *wimax);
+

+Gets all the scanned NSPs of the NMDeviceWimax. +

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

wimax :

a NMDeviceWimax +

Returns :

a GPtrArray containing +all the scanned NMWimaxNsps. +The returned array is owned by the client and should not be modified. [element-type NMWimaxNsp] +
+
+
+
+

nm_device_wimax_get_center_frequency ()

+
guint               nm_device_wimax_get_center_frequency
+                                                        (NMDeviceWimax *self);
+

+Gets the center frequency (in KHz) of the radio channel the device is using +to communicate with the network when connected. Has no meaning when the +device is not connected. +

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

self :

a NMDeviceWimax +

Returns :

the center frequency in KHz, or 0
+
+
+
+

nm_device_wimax_get_rssi ()

+
gint                nm_device_wimax_get_rssi            (NMDeviceWimax *self);
+

+Gets the RSSI of the current radio link in dBm. This value indicates how +strong the raw received RF signal from the base station is, but does not +indicate the overall quality of the radio link. Has no meaning when the +device is not connected. +

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

self :

a NMDeviceWimax +

Returns :

the RSSI in dBm, or 0
+
+
+
+

nm_device_wimax_get_cinr ()

+
gint                nm_device_wimax_get_cinr            (NMDeviceWimax *self);
+

+Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio +link in dB. CINR is a more accurate measure of radio link quality. Has no +meaning when the device is not connected. +

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

self :

a NMDeviceWimax +

Returns :

the CINR in dB, or 0
+
+
+
+

nm_device_wimax_get_tx_power ()

+
gint                nm_device_wimax_get_tx_power        (NMDeviceWimax *self);
+

+Average power of the last burst transmitted by the device, in units of +0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of +-5.5 dBm. Has no meaning when the device is not connected. +

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

self :

a NMDeviceWimax +

Returns :

the TX power in dBm, or 0
+
+
+
+

nm_device_wimax_get_bsid ()

+
const char *        nm_device_wimax_get_bsid            (NMDeviceWimax *self);
+

+Gets the ID of the serving Base Station when the device is connected. +

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

self :

a NMDeviceWimax +

Returns :

the ID of the serving Base Station, or NULL +
+
+
+
+

Property Details

+
+

The "active-nsp" property

+
  "active-nsp"               NMWimaxNsp*           : Read
+

+The active NMWimaxNsp of the device. +

+
+
+
+

The "bsid" property

+
  "bsid"                     gchar*                : Read
+

+The ID of the serving base station as received from the network. Has +no meaning when the device is not connected. +

+

Default value: NULL

+
+
+
+

The "center-frequency" property

+
  "center-frequency"         guint                 : Read
+

+The center frequency (in KHz) of the radio channel the device is using to +communicate with the network when connected. Has no meaning when the +device is not connected. +

+

Default value: 0

+
+
+
+

The "cinr" property

+
  "cinr"                     gint                  : Read
+

+CINR (Carrier to Interference + Noise Ratio) of the current radio link +in dB. CINR is a more accurate measure of radio link quality. Has no +meaning when the device is not connected. +

+

Default value: 0

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "nsps" property

+
  "nsps"                     GPtrArray*            : Read
+

+List of all WiMAX Network Service Providers the device can see. +

+

+Element-type: NMWimaxNsp +

+
+
+
+

The "rssi" property

+
  "rssi"                     gint                  : Read
+

+RSSI of the current radio link in dBm. This value indicates how strong +the raw received RF signal from the base station is, but does not +indicate the overall quality of the radio link. Has no meaning when the +device is not connected. +

+

Default value: 0

+
+
+
+

The "tx-power" property

+
  "tx-power"                 gint                  : Read
+

+Average power of the last burst transmitted by the device, in units of +0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of +-5.5 dBm. Has no meaning when the device is not connected. +

+

Default value: 0

+
+
+
+

Signal Details

+
+

The "nsp-added" signal

+
void                user_function                      (NMDeviceWimax *self,
+                                                        GObject       *nsp,
+                                                        gpointer       user_data)      : Run First
+

+Notifies that a NMWimaxNsp is added to the wimax device. +

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

self :

the wimax device that received the signal

nsp :

the new NSP

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "nsp-removed" signal

+
void                user_function                      (NMDeviceWimax *self,
+                                                        GObject       *nsp,
+                                                        gpointer       user_data)      : Run First
+

+Notifies that a NMWimaxNsp is removed from the wimax device. +

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

self :

the wimax device that received the signal

nsp :

the removed NSP

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMDhcpConfig.html b/docs/libnm/html/NMDhcpConfig.html new file mode 100644 index 00000000..3a48d730 --- /dev/null +++ b/docs/libnm/html/NMDhcpConfig.html @@ -0,0 +1,232 @@ + + + + +NMDhcpConfig + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDhcpConfig

+

NMDhcpConfig

+
+
+

Synopsis

+
struct              NMDhcpConfig;
+                    NMDhcpConfigClass;
+#define             NM_DHCP_CONFIG_FAMILY
+#define             NM_DHCP_CONFIG_OPTIONS
+int                 nm_dhcp_config_get_family           (NMDhcpConfig *config);
+GHashTable *        nm_dhcp_config_get_options          (NMDhcpConfig *config);
+const char *        nm_dhcp_config_get_one_option       (NMDhcpConfig *config,
+                                                         const char *option);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDhcpConfig
+
+
+
+

Implemented Interfaces

+

+NMDhcpConfig implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "family"                   gint                  : Read
+  "options"                  GHashTable*           : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

struct NMDhcpConfig

+
struct NMDhcpConfig;
+

+

+
+
+
+

NMDhcpConfigClass

+
typedef struct {
+	NMObjectClass parent;
+} NMDhcpConfigClass;
+
+

+

+
+
+
+

NM_DHCP_CONFIG_FAMILY

+
#define NM_DHCP_CONFIG_FAMILY  "family"
+
+

+

+
+
+
+

NM_DHCP_CONFIG_OPTIONS

+
#define NM_DHCP_CONFIG_OPTIONS "options"
+
+

+

+
+
+
+

nm_dhcp_config_get_family ()

+
int                 nm_dhcp_config_get_family           (NMDhcpConfig *config);
+

+Gets the IP address family of the configuration +

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

config :

a NMDhcpConfig +

Returns :

the IP address family; either AF_INET or +AF_INET6 +
+
+
+
+

nm_dhcp_config_get_options ()

+
GHashTable *        nm_dhcp_config_get_options          (NMDhcpConfig *config);
+

+Gets all the options contained in the configuration. +

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

config :

a NMDhcpConfig +

Returns :

the GHashTable containing +strings for keys and values. This is the internal copy used by the +configuration, and must not be modified. [transfer none][element-type utf8 utf8] +
+
+
+
+

nm_dhcp_config_get_one_option ()

+
const char *        nm_dhcp_config_get_one_option       (NMDhcpConfig *config,
+                                                         const char *option);
+

+Gets one option by option name. +

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

config :

a NMDhcpConfig +

option :

the option to retrieve

Returns :

the configuration option's value. This is the internal string used by the +configuration, and must not be modified.
+
+
+
+

Property Details

+
+

The "family" property

+
  "family"                   gint                  : Read
+

+The IP address family of the configuration; either +AF_INET or AF_INET6. +

+

Allowed values: [0,255]

+

Default value: 0

+
+
+
+

The "options" property

+
  "options"                  GHashTable*           : Read
+

+The GHashTable containing options of the configuration. +

+

+Type: GLib.HashTable(utf8,utf8) +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMIPConfig.html b/docs/libnm/html/NMIPConfig.html new file mode 100644 index 00000000..83ede1e4 --- /dev/null +++ b/docs/libnm/html/NMIPConfig.html @@ -0,0 +1,473 @@ + + + + +NMIPConfig + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMIPConfig

+

NMIPConfig

+
+
+

Synopsis

+
struct              NMIPConfig;
+                    NMIPConfigClass;
+#define             NM_IP_CONFIG_FAMILY
+#define             NM_IP_CONFIG_GATEWAY
+#define             NM_IP_CONFIG_ADDRESSES
+#define             NM_IP_CONFIG_ROUTES
+#define             NM_IP_CONFIG_NAMESERVERS
+#define             NM_IP_CONFIG_DOMAINS
+#define             NM_IP_CONFIG_SEARCHES
+#define             NM_IP_CONFIG_WINS_SERVERS
+int                 nm_ip_config_get_family             (NMIPConfig *config);
+const char *        nm_ip_config_get_gateway            (NMIPConfig *config);
+GPtrArray *         nm_ip_config_get_addresses          (NMIPConfig *config);
+GPtrArray *         nm_ip_config_get_routes             (NMIPConfig *config);
+const char * const * nm_ip_config_get_nameservers       (NMIPConfig *config);
+const char * const * nm_ip_config_get_domains           (NMIPConfig *config);
+const char * const * nm_ip_config_get_searches          (NMIPConfig *config);
+const char * const * nm_ip_config_get_wins_servers      (NMIPConfig *config);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMIPConfig
+
+
+
+

Implemented Interfaces

+

+NMIPConfig implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "addresses"                GPtrArray*            : Read
+  "domains"                  GStrv                 : Read
+  "family"                   gint                  : Read
+  "gateway"                  gchar*                : Read
+  "nameservers"              GStrv                 : Read
+  "routes"                   GPtrArray*            : Read
+  "searches"                 GStrv                 : Read
+  "wins-servers"             GStrv                 : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

struct NMIPConfig

+
struct NMIPConfig;
+

+

+
+
+
+

NMIPConfigClass

+
typedef struct {
+	NMObjectClass parent;
+} NMIPConfigClass;
+
+

+

+
+
+
+

NM_IP_CONFIG_FAMILY

+
#define NM_IP_CONFIG_FAMILY "family"
+
+

+

+
+
+
+

NM_IP_CONFIG_GATEWAY

+
#define NM_IP_CONFIG_GATEWAY "gateway"
+
+

+

+
+
+
+

NM_IP_CONFIG_ADDRESSES

+
#define NM_IP_CONFIG_ADDRESSES "addresses"
+
+

+

+
+
+
+

NM_IP_CONFIG_ROUTES

+
#define NM_IP_CONFIG_ROUTES "routes"
+
+

+

+
+
+
+

NM_IP_CONFIG_NAMESERVERS

+
#define NM_IP_CONFIG_NAMESERVERS "nameservers"
+
+

+

+
+
+
+

NM_IP_CONFIG_DOMAINS

+
#define NM_IP_CONFIG_DOMAINS "domains"
+
+

+

+
+
+
+

NM_IP_CONFIG_SEARCHES

+
#define NM_IP_CONFIG_SEARCHES "searches"
+
+

+

+
+
+
+

NM_IP_CONFIG_WINS_SERVERS

+
#define NM_IP_CONFIG_WINS_SERVERS "wins-servers"
+
+

+

+
+
+
+

nm_ip_config_get_family ()

+
int                 nm_ip_config_get_family             (NMIPConfig *config);
+

+Gets the IP address family +

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

config :

a NMIPConfig +

Returns :

the IP address family; either AF_INET or +AF_INET6 +
+
+
+
+

nm_ip_config_get_gateway ()

+
const char *        nm_ip_config_get_gateway            (NMIPConfig *config);
+

+Gets the IP gateway address. +

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

config :

a NMIPConfig +

Returns :

the IP address of the gateway. [transfer none] +
+
+
+
+

nm_ip_config_get_addresses ()

+
GPtrArray *         nm_ip_config_get_addresses          (NMIPConfig *config);
+

+Gets the IP addresses (containing the address, prefix, and gateway). +

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

config :

a NMIPConfig +

Returns :

the GPtrArray +containing NMIPAddresses. This is the internal copy used by the +configuration and must not be modified. [element-type NMIPAddress][transfer none] +
+
+
+
+

nm_ip_config_get_routes ()

+
GPtrArray *         nm_ip_config_get_routes             (NMIPConfig *config);
+

+Gets the routes. +

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

config :

a NMIPConfig +

Returns :

the GPtrArray containing +NMIPRoutes. This is the internal copy used by the configuration, and must +not be modified. [element-type NMIPRoute][transfer none] +
+
+
+
+

nm_ip_config_get_nameservers ()

+
const char * const * nm_ip_config_get_nameservers       (NMIPConfig *config);
+

+Gets the domain name servers (DNS). +

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

config :

a NMIPConfig +

Returns :

the array of nameserver IP addresses. [transfer none] +
+
+
+
+

nm_ip_config_get_domains ()

+
const char * const * nm_ip_config_get_domains           (NMIPConfig *config);
+

+Gets the domain names. +

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

config :

a NMIPConfig +

Returns :

the array of domains. +(This is never NULL, though it may be 0-length). [transfer none] +
+
+
+
+

nm_ip_config_get_searches ()

+
const char * const * nm_ip_config_get_searches          (NMIPConfig *config);
+

+Gets the DNS searches. +

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

config :

a NMIPConfig +

Returns :

the array of DNS search strings. +(This is never NULL, though it may be 0-length). [transfer none] +
+
+
+
+

nm_ip_config_get_wins_servers ()

+
const char * const * nm_ip_config_get_wins_servers      (NMIPConfig *config);
+

+Gets the Windows Internet Name Service servers (WINS). +

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

config :

a NMIPConfig +

Returns :

the arry of WINS server IP address strings. +(This is never NULL, though it may be 0-length.). [transfer none] +
+
+
+
+

Property Details

+
+

The "addresses" property

+
  "addresses"                GPtrArray*            : Read
+

+A GPtrArray containing the addresses (NMIPAddress) of the configuration. +

+
+
+
+

The "domains" property

+
  "domains"                  GStrv                 : Read
+

+The array containing domain strings of the configuration. +

+
+
+
+

The "family" property

+
  "family"                   gint                  : Read
+

+The IP address family of the configuration; either +AF_INET or AF_INET6. +

+

Allowed values: [0,255]

+

Default value: 0

+
+
+
+

The "gateway" property

+
  "gateway"                  gchar*                : Read
+

+The IP gateway address of the configuration as string. +

+

Default value: NULL

+
+
+
+

The "nameservers" property

+
  "nameservers"              GStrv                 : Read
+

+The array containing name server IP addresses of the configuration. +

+
+
+
+

The "routes" property

+
  "routes"                   GPtrArray*            : Read
+

+A GPtrArray containing the routes (NMIPRoute) of the configuration. +

+
+
+
+

The "searches" property

+
  "searches"                 GStrv                 : Read
+

+The array containing DNS search strings of the configuration. +

+
+
+
+

The "wins-servers" property

+
  "wins-servers"             GStrv                 : Read
+

+The array containing WINS server IP addresses of the configuration. +(This will always be empty for IPv6 configurations.) +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMObject.html b/docs/libnm/html/NMObject.html new file mode 100644 index 00000000..84324d98 --- /dev/null +++ b/docs/libnm/html/NMObject.html @@ -0,0 +1,188 @@ + + + + +NMObject + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMObject

+

NMObject

+
+
+

Synopsis

+
#define             NM_OBJECT_PATH
+#define             NM_OBJECT_DBUS_CONNECTION
+struct              NMObject;
+                    NMObjectClass;
+const char *        nm_object_get_path                  (NMObject *object);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMAccessPoint
+         +----NMActiveConnection
+         +----NMDevice
+         +----NMDhcpConfig
+         +----NMIPConfig
+         +----NMRemoteConnection
+         +----NMWimaxNsp
+
+
+
+

Implemented Interfaces

+

+NMObject implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "dbus-connection"          GDBusConnection*      : Read / Write / Construct Only
+  "nm-running-internal"      gboolean              : Read
+  "path"                     gchar*                : Read / Write / Construct Only
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_OBJECT_PATH

+
#define NM_OBJECT_PATH "path"
+
+

+

+
+
+
+

NM_OBJECT_DBUS_CONNECTION

+
#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
+
+

+

+
+
+
+

struct NMObject

+
struct NMObject;
+

+

+
+
+
+

NMObjectClass

+
typedef struct {
+	GObjectClass parent;
+
+	/* Methods */
+	void (*init_dbus) (NMObject *object);
+
+	/* The "object-creation-failed" method is PRIVATE for libnm and
+	 * is not meant for any external usage.  It indicates that an error
+	 * occured during creation of an object.
+	 */
+	void (*object_creation_failed) (NMObject *master_object,
+	                                const char *failed_path);
+} NMObjectClass;
+
+

+

+
+
+
+

nm_object_get_path ()

+
const char *        nm_object_get_path                  (NMObject *object);
+

+Gets the DBus path of the NMObject. +

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

object :

a NMObject +

Returns :

the object's path. This is the internal string used by the +device, and must not be modified.
+
+
+
+

Property Details

+
+

The "dbus-connection" property

+
  "dbus-connection"          GDBusConnection*      : Read / Write / Construct Only
+

+The GDBusConnection of the object. +

+
+
+
+

The "nm-running-internal" property

+
  "nm-running-internal"      gboolean              : Read
+

+

Default value: FALSE

+
+
+
+

The "path" property

+
  "path"                     gchar*                : Read / Write / Construct Only
+

+The D-Bus object path. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMRemoteConnection.html b/docs/libnm/html/NMRemoteConnection.html new file mode 100644 index 00000000..96e95e2e --- /dev/null +++ b/docs/libnm/html/NMRemoteConnection.html @@ -0,0 +1,761 @@ + + + + +NMRemoteConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMRemoteConnection

+

NMRemoteConnection

+
+
+

Synopsis

+
#define             NM_REMOTE_CONNECTION_DBUS_CONNECTION
+#define             NM_REMOTE_CONNECTION_PATH
+#define             NM_REMOTE_CONNECTION_UNSAVED
+#define             NM_REMOTE_CONNECTION_VISIBLE
+struct              NMRemoteConnection;
+                    NMRemoteConnectionClass;
+gboolean            nm_remote_connection_commit_changes (NMRemoteConnection *connection,
+                                                         gboolean save_to_disk,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_remote_connection_commit_changes_async
+                                                        (NMRemoteConnection *connection,
+                                                         gboolean save_to_disk,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_remote_connection_commit_changes_finish
+                                                        (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_remote_connection_save           (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_remote_connection_save_async     (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_remote_connection_save_finish    (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_remote_connection_delete         (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_remote_connection_delete_async   (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_remote_connection_delete_finish  (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+GVariant *          nm_remote_connection_get_secrets    (NMRemoteConnection *connection,
+                                                         const char *setting_name,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_remote_connection_get_secrets_async
+                                                        (NMRemoteConnection *connection,
+                                                         const char *setting_name,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+GVariant *          nm_remote_connection_get_secrets_finish
+                                                        (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_remote_connection_get_unsaved    (NMRemoteConnection *connection);
+gboolean            nm_remote_connection_get_visible    (NMRemoteConnection *connection);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMRemoteConnection
+
+
+
+

Implemented Interfaces

+

+NMRemoteConnection implements + GInitable, GAsyncInitable and NMConnection.

+
+
+

Properties

+
+  "unsaved"                  gboolean              : Read
+  "visible"                  gboolean              : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_REMOTE_CONNECTION_DBUS_CONNECTION

+
#define NM_REMOTE_CONNECTION_DBUS_CONNECTION "dbus-connection"
+
+

+

+
+
+
+

NM_REMOTE_CONNECTION_PATH

+
#define NM_REMOTE_CONNECTION_PATH            "path"
+
+

+

+
+
+
+

NM_REMOTE_CONNECTION_UNSAVED

+
#define NM_REMOTE_CONNECTION_UNSAVED         "unsaved"
+
+

+

+
+
+
+

NM_REMOTE_CONNECTION_VISIBLE

+
#define NM_REMOTE_CONNECTION_VISIBLE         "visible"
+
+

+

+
+
+
+

struct NMRemoteConnection

+
struct NMRemoteConnection;
+

+

+
+
+
+

NMRemoteConnectionClass

+
typedef struct {
+	NMObjectClass parent_class;
+} NMRemoteConnectionClass;
+
+

+

+
+
+
+

nm_remote_connection_commit_changes ()

+
gboolean            nm_remote_connection_commit_changes (NMRemoteConnection *connection,
+                                                         gboolean save_to_disk,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Send any local changes to the settings and properties of connection to +NetworkManager. If save_to_disk is TRUE, the updated connection will be saved to +disk; if FALSE, then only the in-memory representation will be changed. +

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

connection :

the NMRemoteConnection +

save_to_disk :

whether to persist the changes to disk

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be set.
+
+
+
+

nm_remote_connection_commit_changes_async ()

+
void                nm_remote_connection_commit_changes_async
+                                                        (NMRemoteConnection *connection,
+                                                         gboolean save_to_disk,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously sends any local changes to the settings and properties of +connection to NetworkManager. If save is TRUE, the updated connection will +be saved to disk; if FALSE, then only the in-memory representation will be +changed. +

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

connection :

the NMRemoteConnection +

save_to_disk :

whether to save the changes to persistent storage

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the commit operation completes

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_remote_connection_commit_changes_finish ()

+
gboolean            nm_remote_connection_commit_changes_finish
+                                                        (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_remote_connection_commit_changes_async(). +

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

connection :

the NMRemoteConnection +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be set.
+
+
+
+

nm_remote_connection_save ()

+
gboolean            nm_remote_connection_save           (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Saves the connection to disk if the connection has changes that have not yet +been written to disk, or if the connection has never been saved. +

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

connection :

the NMRemoteConnection +

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be set.
+
+
+
+

nm_remote_connection_save_async ()

+
void                nm_remote_connection_save_async     (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Saves the connection to disk if the connection has changes that have not yet +been written to disk, or if the connection has never been saved. +

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

connection :

the NMRemoteConnection +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the save operation completes

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_remote_connection_save_finish ()

+
gboolean            nm_remote_connection_save_finish    (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_remote_connection_save_async(). +

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

connection :

the NMRemoteConnection +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be set.
+
+
+
+

nm_remote_connection_delete ()

+
gboolean            nm_remote_connection_delete         (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Deletes the connection. +

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

connection :

the NMRemoteConnection +

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be set.
+
+
+
+

nm_remote_connection_delete_async ()

+
void                nm_remote_connection_delete_async   (NMRemoteConnection *connection,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously deletes the connection. +

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

connection :

the NMRemoteConnection +

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the delete operation completes

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_remote_connection_delete_finish ()

+
gboolean            nm_remote_connection_delete_finish  (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_remote_connection_delete_async(). +

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

connection :

the NMRemoteConnection +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

 +TRUE on success, FALSE on error, in which case error will be set.
+
+
+
+

nm_remote_connection_get_secrets ()

+
GVariant *          nm_remote_connection_get_secrets    (NMRemoteConnection *connection,
+                                                         const char *setting_name,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Request the connection's secrets. Note that this is a blocking D-Bus call, +not a simple property accessor. +

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

connection :

the NMRemoteConnection +

setting_name :

the NMSetting object name to get secrets for

cancellable :

a GCancellable, or NULL +

error :

location for a GError, or NULL +

Returns :

a GVariant of type NM_VARIANT_TYPE_CONNECTION containing +connection's secrets, or NULL on error.
+
+
+
+

nm_remote_connection_get_secrets_async ()

+
void                nm_remote_connection_get_secrets_async
+                                                        (NMRemoteConnection *connection,
+                                                         const char *setting_name,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously requests the connection's secrets. +

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

connection :

the NMRemoteConnection +

setting_name :

the NMSetting object name to get secrets for

cancellable :

a GCancellable, or NULL +

callback :

callback to be called when the secret request completes

user_data :

caller-specific data passed to callback +
+
+
+
+

nm_remote_connection_get_secrets_finish ()

+
GVariant *          nm_remote_connection_get_secrets_finish
+                                                        (NMRemoteConnection *connection,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_remote_connection_get_secrets_async(). +

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

connection :

the NMRemoteConnection +

result :

the result passed to the GAsyncReadyCallback +

error :

location for a GError, or NULL +

Returns :

a GVariant of type NM_VARIANT_TYPE_CONNECTION +containing connection's secrets, or NULL on error. [transfer full] +
+
+
+
+

nm_remote_connection_get_unsaved ()

+
gboolean            nm_remote_connection_get_unsaved    (NMRemoteConnection *connection);
+
++++ + + + + + + + + + + +

connection :

the NMRemoteConnection +

Returns :

 +TRUE if the remote connection contains changes that have not +been saved to disk, FALSE if the connection is the same as its on-disk +representation.
+
+
+
+

nm_remote_connection_get_visible ()

+
gboolean            nm_remote_connection_get_visible    (NMRemoteConnection *connection);
+

+Checks if the connection is visible to the current user. If the +connection is not visible then it is essentially useless; it will +not contain any settings, and operations such as +nm_remote_connection_save() and nm_remote_connection_delete() will +always fail. (NMRemoteSettings will not normally return +non-visible connections to callers, but it is possible for a +connection's visibility to change after you already have a +reference to it.) +

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

connection :

the NMRemoteConnection +

Returns :

 +TRUE if the remote connection is visible to the current +user, FALSE if not.
+
+
+
+

Property Details

+
+

The "unsaved" property

+
  "unsaved"                  gboolean              : Read
+

+TRUE if the remote connection contains changes that have not been saved +to disk, FALSE if the connection is the same as its on-disk representation. +

+

Default value: FALSE

+
+
+
+

The "visible" property

+
  "visible"                  gboolean              : Read
+

+TRUE if the remote connection is visible to the current user, FALSE if +not. If the connection is not visible then it is essentially useless; it +will not contain any settings, and operations such as +nm_remote_connection_save() and nm_remote_connection_delete() will always +fail. (NMRemoteSettings will not normally return non-visible connections +to callers, but it is possible for a connection's visibility to change +after you already have a reference to it.) +

+

Default value: FALSE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSecretAgentOld.html b/docs/libnm/html/NMSecretAgentOld.html new file mode 100644 index 00000000..8ba81e68 --- /dev/null +++ b/docs/libnm/html/NMSecretAgentOld.html @@ -0,0 +1,911 @@ + + + + +NMSecretAgentOld + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSecretAgentOld

+

NMSecretAgentOld

+
+
+

Synopsis

+
#define             NM_SECRET_AGENT_OLD_IDENTIFIER
+#define             NM_SECRET_AGENT_OLD_AUTO_REGISTER
+#define             NM_SECRET_AGENT_OLD_REGISTERED
+#define             NM_SECRET_AGENT_OLD_CAPABILITIES
+                    NMSecretAgentOld;
+void                (*NMSecretAgentOldGetSecretsFunc)   (NMSecretAgentOld *agent,
+                                                         NMConnection *connection,
+                                                         GVariant *secrets,
+                                                         GError *error,
+                                                         gpointer user_data);
+void                (*NMSecretAgentOldSaveSecretsFunc)  (NMSecretAgentOld *agent,
+                                                         NMConnection *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+void                (*NMSecretAgentOldDeleteSecretsFunc)
+                                                        (NMSecretAgentOld *agent,
+                                                         NMConnection *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+                    NMSecretAgentOldClass;
+gboolean            nm_secret_agent_old_register        (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_secret_agent_old_register_async  (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_secret_agent_old_register_finish (NMSecretAgentOld *self,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_secret_agent_old_unregister      (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+void                nm_secret_agent_old_unregister_async
+                                                        (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+gboolean            nm_secret_agent_old_unregister_finish
+                                                        (NMSecretAgentOld *self,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+gboolean            nm_secret_agent_old_get_registered  (NMSecretAgentOld *self);
+void                nm_secret_agent_old_get_secrets     (NMSecretAgentOld *self,
+                                                         NMConnection *connection,
+                                                         const char *setting_name,
+                                                         const char **hints,
+                                                         NMSecretAgentGetSecretsFlags flags,
+                                                         NMSecretAgentOldGetSecretsFunc callback,
+                                                         gpointer user_data);
+void                nm_secret_agent_old_save_secrets    (NMSecretAgentOld *self,
+                                                         NMConnection *connection,
+                                                         NMSecretAgentOldSaveSecretsFunc callback,
+                                                         gpointer user_data);
+void                nm_secret_agent_old_delete_secrets  (NMSecretAgentOld *self,
+                                                         NMConnection *connection,
+                                                         NMSecretAgentOldDeleteSecretsFunc callback,
+                                                         gpointer user_data);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSecretAgentOld
+
+
+
+

Implemented Interfaces

+

+NMSecretAgentOld implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "auto-register"            gboolean              : Read / Write / Construct
+  "capabilities"             NMSecretAgentCapabilities  : Read / Write / Construct
+  "identifier"               gchar*                : Read / Write / Construct Only
+  "registered"               gboolean              : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_SECRET_AGENT_OLD_IDENTIFIER

+
#define NM_SECRET_AGENT_OLD_IDENTIFIER          "identifier"
+
+

+

+
+
+
+

NM_SECRET_AGENT_OLD_AUTO_REGISTER

+
#define NM_SECRET_AGENT_OLD_AUTO_REGISTER       "auto-register"
+
+

+

+
+
+
+

NM_SECRET_AGENT_OLD_REGISTERED

+
#define NM_SECRET_AGENT_OLD_REGISTERED          "registered"
+
+

+

+
+
+
+

NM_SECRET_AGENT_OLD_CAPABILITIES

+
#define NM_SECRET_AGENT_OLD_CAPABILITIES        "capabilities"
+
+

+

+
+
+
+

NMSecretAgentOld

+
typedef struct _NMSecretAgentOld NMSecretAgentOld;
+

+

+
+
+
+

NMSecretAgentOldGetSecretsFunc ()

+
void                (*NMSecretAgentOldGetSecretsFunc)   (NMSecretAgentOld *agent,
+                                                         NMConnection *connection,
+                                                         GVariant *secrets,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+Called as a result of a request by NM to retrieve secrets. When the +NMSecretAgentOld subclass has finished retrieving secrets and is ready to +return them, or to return an error, this function should be called with +those secrets or the error. +

+

+To easily create the dictionary to return the Wi-Fi PSK, you could do +something like this: +

+
+

Example 1. Creating a secrets dictionary

+
+ + + + + + + + 
1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
NMConnection *secrets;
+NMSettingWirelessSecurity *s_wsec;
+GVariant *secrets_dict;
+
+secrets = nm_simple_connection_new ();
+s_wsec = (NMSettingWirelessSecurity *) nm_setting_wireless_security_new ();
+g_object_set (G_OBJECT (s_wsec),
+              NM_SETTING_WIRELESS_SECURITY_PSK, "my really cool PSK",
+              NULL);
+nm_connection_add_setting (secrets, NM_SETTING (s_wsec));
+secrets_dict = nm_connection_to_dbus (secrets, NM_CONNECTION_SERIALIZE_ALL);
+
+(call the NMSecretAgentOldGetSecretsFunc with secrets_dict)
+
+g_object_unref (secrets);
+g_variant_unref (secrets_dict);
+
+ +
+


+

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

agent :

the secret agent object

connection :

the connection for which secrets were requested, +note that this object will be unrefed after the callback has returned, use +g_object_ref()/g_object_unref() if you want to use this object after the callback +has returned. [transfer none] +

secrets :

the GVariant of type NM_VARIANT_TYPE_CONNECTION containing the requested +secrets (as created by nm_connection_to_dbus() for example). Each key in secrets +should be the name of a NMSetting object (like "802-11-wireless-security") +and each value should be an NM_VARIANT_TYPE_SETTING variant. The sub-dicts +map string:value, where the string is the setting property name (like "psk") +and the value is the secret

error :

if the secrets request failed, give a descriptive error here

user_data :

caller-specific data to be passed to the function
+
+
+
+

NMSecretAgentOldSaveSecretsFunc ()

+
void                (*NMSecretAgentOldSaveSecretsFunc)  (NMSecretAgentOld *agent,
+                                                         NMConnection *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+Called as a result of a request by NM to save secrets. When the +NMSecretAgentOld subclass has finished saving the secrets, this function +should be called. +

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

agent :

the secret agent object

connection :

the connection for which secrets were to be saved, +note that this object will be unrefed after the callback has returned, use +g_object_ref()/g_object_unref() if you want to use this object after the callback +has returned. [transfer none] +

error :

if the saving secrets failed, give a descriptive error here

user_data :

caller-specific data to be passed to the function
+
+
+
+

NMSecretAgentOldDeleteSecretsFunc ()

+
void                (*NMSecretAgentOldDeleteSecretsFunc)
+                                                        (NMSecretAgentOld *agent,
+                                                         NMConnection *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+Called as a result of a request by NM to delete secrets. When the +NMSecretAgentOld subclass has finished deleting the secrets, this function +should be called. +

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

agent :

the secret agent object

connection :

the connection for which secrets were to be deleted, +note that this object will be unrefed after the callback has returned, use +g_object_ref()/g_object_unref() if you want to use this object after the callback +has returned. [transfer none] +

error :

if the deleting secrets failed, give a descriptive error here

user_data :

caller-specific data to be passed to the function
+
+
+
+

NMSecretAgentOldClass

+
typedef struct {
+	GObjectClass parent;
+
+	/* Virtual methods for subclasses */
+
+	/* Called when the subclass should retrieve and return secrets.  Subclass
+	 * must copy or reference any arguments it may require after returning from
+	 * this method, as the arguments will freed (except for 'self', 'callback',
+	 * and 'user_data' of course).  If the request is canceled, the callback
+	 * should still be called, but with the
+	 * NM_SECRET_AGENT_OLD_ERROR_AGENT_CANCELED error.
+	 */
+	void (*get_secrets) (NMSecretAgentOld *self,
+	                     NMConnection *connection,
+	                     const char *connection_path,
+	                     const char *setting_name,
+	                     const char **hints,
+	                     NMSecretAgentGetSecretsFlags flags,
+	                     NMSecretAgentOldGetSecretsFunc callback,
+	                     gpointer user_data);
+
+	/* Called when the subclass should cancel an outstanding request to
+	 * get secrets for a given connection.  Canceling the request MUST
+	 * call the callback that was passed along with the initial get_secrets
+	 * call, sending the NM_SECRET_AGENT_OLD_ERROR/
+	 * NM_SECRET_AGENT_OLD_ERROR_AGENT_CANCELED error to that callback.
+	 */
+	void (*cancel_get_secrets) (NMSecretAgentOld *self,
+	                            const char *connection_path,
+	                            const char *setting_name);
+
+	/* Called when the subclass should save the secrets contained in the
+	 * connection to backing storage.  Subclass must copy or reference any
+	 * arguments it may require after returning from this method, as the
+	 * arguments will freed (except for 'self', 'callback', and 'user_data'
+	 * of course).
+	 */
+	void (*save_secrets) (NMSecretAgentOld *self,
+	                      NMConnection *connection,
+	                      const char *connection_path,
+	                      NMSecretAgentOldSaveSecretsFunc callback,
+	                      gpointer user_data);
+
+	/* Called when the subclass should delete the secrets contained in the
+	 * connection from backing storage.  Subclass must copy or reference any
+	 * arguments it may require after returning from this method, as the
+	 * arguments will freed (except for 'self', 'callback', and 'user_data'
+	 * of course).
+	 */
+	void (*delete_secrets) (NMSecretAgentOld *self,
+	                        NMConnection *connection,
+	                        const char *connection_path,
+	                        NMSecretAgentOldDeleteSecretsFunc callback,
+	                        gpointer user_data);
+} NMSecretAgentOldClass;
+
+

+

+
+
+
+

nm_secret_agent_old_register ()

+
gboolean            nm_secret_agent_old_register        (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Registers the NMSecretAgentOld with the NetworkManager secret manager, +indicating to NetworkManager that the agent is able to provide and save +secrets for connections on behalf of its user. +

+

+It is a programmer error to attempt to register an agent that is already +registered, or in the process of registering. +

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

self :

a NMSecretAgentOld +

cancellable :

a GCancellable, or NULL +

error :

return location for a GError, or NULL +

Returns :

 +TRUE if registration was successful, FALSE on error.
+
+
+
+

nm_secret_agent_old_register_async ()

+
void                nm_secret_agent_old_register_async  (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously registers the NMSecretAgentOld with the NetworkManager secret +manager, indicating to NetworkManager that the agent is able to provide and +save secrets for connections on behalf of its user. +

+

+It is a programmer error to attempt to register an agent that is already +registered, or in the process of registering. +

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

self :

a NMSecretAgentOld +

cancellable :

a GCancellable, or NULL +

callback :

callback to call when the agent is registered

user_data :

data for callback +
+
+
+
+

nm_secret_agent_old_register_finish ()

+
gboolean            nm_secret_agent_old_register_finish (NMSecretAgentOld *self,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_secret_agent_old_register_async(). +

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

self :

a NMSecretAgentOld +

result :

the result passed to the GAsyncReadyCallback +

error :

return location for a GError, or NULL +

Returns :

 +TRUE if registration was successful, FALSE on error.
+
+
+
+

nm_secret_agent_old_unregister ()

+
gboolean            nm_secret_agent_old_unregister      (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GError **error);
+

+Unregisters the NMSecretAgentOld with the NetworkManager secret manager, +indicating to NetworkManager that the agent will no longer provide or +store secrets on behalf of this user. +

+

+It is a programmer error to attempt to unregister an agent that is not +registered. +

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

self :

a NMSecretAgentOld +

cancellable :

a GCancellable, or NULL +

error :

return location for a GError, or NULL +

Returns :

 +TRUE if unregistration was successful, FALSE on error
+
+
+
+

nm_secret_agent_old_unregister_async ()

+
void                nm_secret_agent_old_unregister_async
+                                                        (NMSecretAgentOld *self,
+                                                         GCancellable *cancellable,
+                                                         GAsyncReadyCallback callback,
+                                                         gpointer user_data);
+

+Asynchronously unregisters the NMSecretAgentOld with the NetworkManager secret +manager, indicating to NetworkManager that the agent will no longer provide +or store secrets on behalf of this user. +

+

+It is a programmer error to attempt to unregister an agent that is not +registered. +

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

self :

a NMSecretAgentOld +

cancellable :

a GCancellable, or NULL +

callback :

callback to call when the agent is unregistered

user_data :

data for callback +
+
+
+
+

nm_secret_agent_old_unregister_finish ()

+
gboolean            nm_secret_agent_old_unregister_finish
+                                                        (NMSecretAgentOld *self,
+                                                         GAsyncResult *result,
+                                                         GError **error);
+

+Gets the result of a call to nm_secret_agent_old_unregister_async(). +

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

self :

a NMSecretAgentOld +

result :

the result passed to the GAsyncReadyCallback +

error :

return location for a GError, or NULL +

Returns :

 +TRUE if unregistration was successful, FALSE on error.
+
+
+
+

nm_secret_agent_old_get_registered ()

+
gboolean            nm_secret_agent_old_get_registered  (NMSecretAgentOld *self);
+
++++ + + + + + + + + + + +

self :

a NMSecretAgentOld +

Returns :

a TRUE if the agent is registered, FALSE if it is not.
+
+
+
+

nm_secret_agent_old_get_secrets ()

+
void                nm_secret_agent_old_get_secrets     (NMSecretAgentOld *self,
+                                                         NMConnection *connection,
+                                                         const char *setting_name,
+                                                         const char **hints,
+                                                         NMSecretAgentGetSecretsFlags flags,
+                                                         NMSecretAgentOldGetSecretsFunc callback,
+                                                         gpointer user_data);
+

+Asynchronously retrieves secrets belonging to connection for the +setting setting_name. flags indicate specific behavior that the secret +agent should use when performing the request, for example returning only +existing secrets without user interaction, or requesting entirely new +secrets from the user. +

+

+Virtual: get_secrets +

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

self :

a NMSecretAgentOld +

connection :

the NMConnection for which we're asked secrets

setting_name :

the name of the secret setting

hints :

hints to the agent. [array zero-terminated=1] +

flags :

flags that modify the behavior of the request

callback :

a callback, to be invoked when the operation is done. [scope async] +

user_data :

caller-specific data to be passed to callback. [closure] +
+
+
+
+

nm_secret_agent_old_save_secrets ()

+
void                nm_secret_agent_old_save_secrets    (NMSecretAgentOld *self,
+                                                         NMConnection *connection,
+                                                         NMSecretAgentOldSaveSecretsFunc callback,
+                                                         gpointer user_data);
+

+Asynchronously ensures that all secrets inside connection are stored to +disk. +

+

+Virtual: save_secrets +

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

self :

a NMSecretAgentOld +

connection :

a NMConnection +

callback :

a callback, to be invoked when the operation is done. [scope async] +

user_data :

caller-specific data to be passed to callback. [closure] +
+
+
+
+

nm_secret_agent_old_delete_secrets ()

+
void                nm_secret_agent_old_delete_secrets  (NMSecretAgentOld *self,
+                                                         NMConnection *connection,
+                                                         NMSecretAgentOldDeleteSecretsFunc callback,
+                                                         gpointer user_data);
+

+Asynchronously asks the agent to delete all saved secrets belonging to +connection. +

+

+Virtual: delete_secrets +

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

self :

a NMSecretAgentOld +

connection :

a NMConnection +

callback :

a callback, to be invoked when the operation is done. [scope async] +

user_data :

caller-specific data to be passed to callback. [closure] +
+
+
+
+

Property Details

+
+

The "auto-register" property

+
  "auto-register"            gboolean              : Read / Write / Construct
+

+If TRUE (the default), the agent will always be registered when +NetworkManager is running; if NetworkManager exits and restarts, the +agent will re-register itself automatically. +

+

+In particular, if this property is TRUE at construct time, then the +agent will register itself with NetworkManager during +construction/initialization, and initialization will fail with an error +if the agent is unable to register itself. +

+

+If the property is FALSE, the agent will not automatically register with +NetworkManager, and nm_secret_agent_old_register() or +nm_secret_agent_old_register_async() must be called to register it. +

+

+Calling nm_secret_agent_old_unregister() will suppress auto-registration +until nm_secret_agent_old_register() is called, which re-enables +auto-registration. This ensures that the agent remains un-registered when +you expect it to be unregistered. +

+

Default value: TRUE

+
+
+
+

The "capabilities" property

+
  "capabilities"             NMSecretAgentCapabilities  : Read / Write / Construct
+

+A bitfield of NMSecretAgentCapabilities. +

+
+
+
+

The "identifier" property

+
  "identifier"               gchar*                : Read / Write / Construct Only
+

+Identifies this agent; only one agent in each user session may use the +same identifier. Identifier formatting follows the same rules as +D-Bus bus names with the exception that the ':' character is not +allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the +identifier is limited in length to 255 characters with a minimum +of 3 characters. An example valid identifier is 'org.gnome.nm-applet' +(without quotes). +

+

Default value: NULL

+
+
+
+

The "registered" property

+
  "registered"               gboolean              : Read
+

+TRUE if the agent is registered with NetworkManager, FALSE if not. +

+

Default value: FALSE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSetting.html b/docs/libnm/html/NMSetting.html new file mode 100644 index 00000000..6c7f830b --- /dev/null +++ b/docs/libnm/html/NMSetting.html @@ -0,0 +1,932 @@ + + + + +NMSetting + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSetting

+

NMSetting — Describes related configuration information

+
+
+

Synopsis

+
#define             NM_SETTING_PARAM_REQUIRED
+#define             NM_SETTING_PARAM_SECRET
+#define             NM_SETTING_PARAM_FUZZY_IGNORE
+#define             NM_SETTING_NAME
+enum                NMSettingSecretFlags;
+enum                NMSettingCompareFlags;
+struct              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);
+GType               nm_setting_lookup_type              (const char *name);
+NMSetting *         nm_setting_duplicate                (NMSetting *setting);
+const char *        nm_setting_get_name                 (NMSetting *setting);
+gboolean            nm_setting_verify                   (NMSetting *setting,
+                                                         NMConnection *connection,
+                                                         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);
+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 GVariantType * nm_setting_get_dbus_property_type  (NMSetting *setting,
+                                                         const char *property_name);
+
+
+
+

Object Hierarchy

+
+  GFlags
+   +----NMSettingSecretFlags
+
+
+  GEnum
+   +----NMSettingCompareFlags
+
+
+  GObject
+   +----NMSetting
+         +----NMSetting8021x
+         +----NMSettingAdsl
+         +----NMSettingBluetooth
+         +----NMSettingBond
+         +----NMSettingBridgePort
+         +----NMSettingBridge
+         +----NMSettingCdma
+         +----NMSettingConnection
+         +----NMSettingDcb
+         +----NMSettingGeneric
+         +----NMSettingGsm
+         +----NMSettingInfiniband
+         +----NMSettingIPConfig
+         +----NMSettingOlpcMesh
+         +----NMSettingPpp
+         +----NMSettingPppoe
+         +----NMSettingSerial
+         +----NMSettingTeamPort
+         +----NMSettingTeam
+         +----NMSettingVlan
+         +----NMSettingVpn
+         +----NMSettingWimax
+         +----NMSettingWired
+         +----NMSettingWirelessSecurity
+         +----NMSettingWireless
+
+
+  GEnum
+   +----NMSettingDiffResult
+
+
+
+

Properties

+
+  "name"                     gchar*                : Read
+
+
+
+

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 Wi-Fi). 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

+
+

NM_SETTING_PARAM_REQUIRED

+
#define NM_SETTING_PARAM_REQUIRED     (1 << (1 + G_PARAM_USER_SHIFT))
+
+

+

+
+
+
+

NM_SETTING_PARAM_SECRET

+
#define NM_SETTING_PARAM_SECRET       (1 << (2 + G_PARAM_USER_SHIFT))
+
+

+

+
+
+
+

NM_SETTING_PARAM_FUZZY_IGNORE

+
#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT))
+
+

+

+
+
+
+

NM_SETTING_NAME

+
#define NM_SETTING_NAME "name"
+
+

+

+
+
+
+

enum NMSettingSecretFlags

+
typedef enum {
+ /*< flags >*/
+	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-core-internal.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. +

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

NM_SETTING_SECRET_FLAG_NONE

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

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 +

NM_SETTING_SECRET_FLAG_NOT_SAVED

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

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

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,
+	NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT = 0x00000020,
+	NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT = 0x00000040,
+	NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP = 0x00000080,
+
+	/* 0x80000000 is used for a private flag */
+} NMSettingCompareFlags;
+
+

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

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

NM_SETTING_COMPARE_FLAG_EXACT

match all properties exactly +

NM_SETTING_COMPARE_FLAG_FUZZY

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

NM_SETTING_COMPARE_FLAG_IGNORE_ID

ignore the connection's ID +

NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS

ignore all secrets +

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_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT

if this flag is set, + nm_setting_diff() and nm_connection_diff() will also include properties that + are set to their default value. See also NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT. +

NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT

if this flag is set, + nm_setting_diff() and nm_connection_diff() will not include properties that + are set to their default value. This is the opposite of + NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT. If both flags are set together, + NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT wins. If both flags are unset, + this means to exclude default properties if there is a setting to compare, + but include all properties, if the setting 'b' is missing. This is the legacy + behaviour of libnm-util, where nm_setting_diff() behaved differently depending + on whether the setting 'b' was available. If NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT + is set, nm_setting_diff() will also set the flags NM_SETTING_DIFF_RESULT_IN_A_DEFAULT + and NM_SETTING_DIFF_RESULT_IN_B_DEFAULT, if the values are default values. +

NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP

ignore the connection's timestamp +
+
+
+
+

struct NMSetting

+
struct 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);
+
++++ + + + + + + + + + + + + + + + + + + + + + + +

setting :

The setting for which secrets are being iterated

secret :

The secret's name

flags :

The secret's flags, eg NM_SETTING_SECRET_FLAG_AGENT_OWNED +

user_data :

User data passed to nm_connection_clear_secrets_with_flags() +

Returns :

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

NMSettingClass

+
typedef struct {
+	GObjectClass parent;
+
+	/* Virtual functions */
+	gint        (*verify)            (NMSetting     *setting,
+	                                  NMConnection  *connection,
+	                                  GError       **error);
+
+	GPtrArray  *(*need_secrets)      (NMSetting  *setting);
+
+	int         (*update_one_secret) (NMSetting  *setting,
+	                                  const char *key,
+	                                  GVariant   *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);
+
+	gboolean    (*clear_secrets_with_flags) (NMSetting *setting,
+	                                         GParamSpec *pspec,
+	                                         NMSettingClearSecretsWithFlagsFn func,
+	                                         gpointer user_data);
+
+	/* 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);
+} NMSettingClass;
+
+

+

+
+
+
+

NMSettingValueIterFn ()

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

setting :

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

key :

The value/property name

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

nm_setting_lookup_type ()

+
GType               nm_setting_lookup_type              (const char *name);
+

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

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

name :

a setting name

Returns :

the GType of the setting's class, or G_TYPE_INVALID if +name is not recognized.
+
+
+
+

nm_setting_duplicate ()

+
NMSetting *         nm_setting_duplicate                (NMSetting *setting);
+

+Duplicates a NMSetting. +

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

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 +

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

setting :

the NMSetting +

Returns :

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

nm_setting_verify ()

+
gboolean            nm_setting_verify                   (NMSetting *setting,
+                                                         NMConnection *connection,
+                                                         GError **error);
+

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

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

setting :

the NMSetting to verify

connection :

the NMConnection that setting came from, or +NULL if setting is being verified in isolation. [allow-none] +

error :

location to store error, or NULL +

Returns :

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

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

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

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

enum NMSettingDiffResult

+
typedef enum {
+	NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000,
+	NM_SETTING_DIFF_RESULT_IN_A =    0x00000001,
+	NM_SETTING_DIFF_RESULT_IN_B =    0x00000002,
+	NM_SETTING_DIFF_RESULT_IN_A_DEFAULT = 0x00000004,
+	NM_SETTING_DIFF_RESULT_IN_B_DEFAULT = 0x00000004,
+} NMSettingDiffResult;
+
+

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

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

NM_SETTING_DIFF_RESULT_UNKNOWN

unknown result +

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 +

NM_SETTING_DIFF_RESULT_IN_A_DEFAULT

the property is present in +setting A but is set to the default value. This flag is only set, +if you specify NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT. +

NM_SETTING_DIFF_RESULT_IN_B_DEFAULT

analog to NM_SETTING_DIFF_RESULT_IN_A_DEFAULT. +
+
+
+
+

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

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

a :

a NMSetting +

b :

a second NMSetting to compare with the first

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT +

invert_results :

this parameter is used internally by libnm 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_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. +

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

setting :

the NMSetting +

func :

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

user_data :

user data passed to func at each invocation
+
+
+
+

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 +

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

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

setting :

the NMSetting +

secret_name :

the secret key name to get flags for

out_flags :

on success, the NMSettingSecretFlags for the secret

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_set_secret_flags ()

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

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

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

setting :

the NMSetting +

secret_name :

the secret key name to set flags for

flags :

the NMSettingSecretFlags for the secret

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_get_dbus_property_type ()

+
const GVariantType * nm_setting_get_dbus_property_type  (NMSetting *setting,
+                                                         const char *property_name);
+

+Gets the D-Bus marshalling type of a property. property_name is a D-Bus +property name, which may not necessarily be a GObject property. +

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

setting :

an NMSetting +

property_name :

the property of setting to get the type of

Returns :

the D-Bus marshalling type of property on setting.
+
+
+
+

Property Details

+
+

The "name" property

+
  "name"                     gchar*                : Read
+

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

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSetting8021x.html b/docs/libnm/html/NMSetting8021x.html new file mode 100644 index 00000000..ea6a7740 --- /dev/null +++ b/docs/libnm/html/NMSetting8021x.html @@ -0,0 +1,3251 @@ + + + + +NMSetting8021x + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSetting8021x

+

NMSetting8021x — Describes 802.1x-authenticated connection properties

+
+
+

Synopsis

+
enum                NMSetting8021xCKFormat;
+enum                NMSetting8021xCKScheme;
+#define             NM_SETTING_802_1X_SETTING_NAME
+#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
+struct              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);
+gboolean            nm_setting_802_1x_remove_eap_method_by_value
+                                                        (NMSetting8021x *setting,
+                                                         const char *eap);
+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);
+GBytes *            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);
+gboolean            nm_setting_802_1x_remove_altsubject_match_by_value
+                                                        (NMSetting8021x *setting,
+                                                         const char *altsubject_match);
+void                nm_setting_802_1x_clear_altsubject_matches
+                                                        (NMSetting8021x *setting);
+NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
+                                                        (NMSetting8021x *setting);
+GBytes *            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);
+GBytes *            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);
+gboolean            nm_setting_802_1x_remove_phase2_altsubject_match_by_value
+                                                        (NMSetting8021x *setting,
+                                                         const char *phase2_altsubject_match);
+void                nm_setting_802_1x_clear_phase2_altsubject_matches
+                                                        (NMSetting8021x *setting);
+NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
+                                                        (NMSetting8021x *setting);
+GBytes *            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);
+GBytes *            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);
+GBytes *            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);
+GBytes *            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
+
+
+  GObject
+   +----NMSetting
+         +----NMSetting8021x
+
+
+
+

Properties

+
+  "altsubject-matches"       GStrv                 : Read / Write
+  "anonymous-identity"       gchar*                : Read / Write
+  "ca-cert"                  GBytes*               : Read / Write
+  "ca-path"                  gchar*                : Read / Write
+  "client-cert"              GBytes*               : Read / Write
+  "eap"                      GStrv                 : Read / Write
+  "identity"                 gchar*                : Read / Write
+  "pac-file"                 gchar*                : Read / Write
+  "password"                 gchar*                : Read / Write
+  "password-flags"           NMSettingSecretFlags  : Read / Write
+  "password-raw"             GBytes*               : Read / Write
+  "password-raw-flags"       NMSettingSecretFlags  : Read / Write
+  "phase1-fast-provisioning" gchar*                : Read / Write
+  "phase1-peaplabel"         gchar*                : Read / Write
+  "phase1-peapver"           gchar*                : Read / Write
+  "phase2-altsubject-matches" GStrv                 : Read / Write
+  "phase2-auth"              gchar*                : Read / Write
+  "phase2-autheap"           gchar*                : Read / Write
+  "phase2-ca-cert"           GBytes*               : Read / Write
+  "phase2-ca-path"           gchar*                : Read / Write
+  "phase2-client-cert"       GBytes*               : Read / Write
+  "phase2-private-key"       GBytes*               : Read / Write
+  "phase2-private-key-password" gchar*                : Read / Write
+  "phase2-private-key-password-flags" NMSettingSecretFlags  : Read / Write
+  "phase2-subject-match"     gchar*                : Read / Write
+  "pin"                      gchar*                : Read / Write
+  "pin-flags"                NMSettingSecretFlags  : Read / Write
+  "private-key"              GBytes*               : Read / Write
+  "private-key-password"     gchar*                : Read / Write
+  "private-key-password-flags" NMSettingSecretFlags  : 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 Wi-Fi 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 Wi-Fi 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 +

+
+
+

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 +

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

NM_SETTING_802_1X_CK_FORMAT_UNKNOWN

unknown file format +

NM_SETTING_802_1X_CK_FORMAT_X509

file contains an X.509 format certificate +

NM_SETTING_802_1X_CK_FORMAT_RAW_KEY

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

NM_SETTING_802_1X_CK_FORMAT_PKCS12

file contains a PKCS#12 certificate +and private key +
+
+
+
+

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 +

NM_SETTING_802_1X_CK_SCHEME_BLOB

certificate or key is stored as the raw +item data +

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_SETTING_NAME

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

+

+
+
+
+

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

+

+
+
+
+

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_PHASE2_CA_CERT

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

+

+
+
+
+

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_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_PASSWORD

+
#define NM_SETTING_802_1X_PASSWORD "password"
+
+

+

+
+
+
+

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_PASSWORD_RAW_FLAGS

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

+

+
+
+
+

NM_SETTING_802_1X_PRIVATE_KEY

+
#define NM_SETTING_802_1X_PRIVATE_KEY "private-key"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

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

+

+
+
+
+

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_PHASE2_PRIVATE_KEY

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

+

+
+
+
+

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_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

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

+

+
+
+
+

NM_SETTING_802_1X_PIN

+
#define NM_SETTING_802_1X_PIN "pin"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PIN_FLAGS

+
#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
+
+

+

+
+
+
+

NM_SETTING_802_1X_SYSTEM_CA_CERTS

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

+

+
+
+
+

struct NMSetting8021x

+
struct NMSetting8021x;
+

+

+
+
+
+

NMSetting8021xClass

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

+

+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

the number of allowed EAP methods
+
+
+
+

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

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

setting :

the NMSetting8021x +

i :

the index of the EAP method name to return

Returns :

the name of the allowed EAP method 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. +

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

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_remove_eap_method ()

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

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

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

setting :

the NMSetting8021x +

i :

the index of the EAP method to remove
+
+
+
+

nm_setting_802_1x_remove_eap_method_by_value ()

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

+Removes the allowed EAP method method. +

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

setting :

the NMSetting8021x +

eap :

the name of the EAP method to remove

Returns :

 +TRUE if the EAP method was founs and removed, FALSE if it was not.
+
+
+
+

nm_setting_802_1x_clear_eap_methods ()

+
void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
+

+Clears all allowed EAP methods. +

+
++++ + + + + +

setting :

the NMSetting8021x +
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

the user identifier
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

the anonymous identifier
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

the PAC file
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

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

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

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

setting :

the NMSetting8021x +

Returns :

the CA certificate directory path
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

the "phase 2" CA certificate directory path
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

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

nm_setting_802_1x_get_ca_cert_blob ()

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

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

setting :

the NMSetting8021x +

Returns :

the CA certificate data. [transfer none] +
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

path to the 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. +

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

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

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_subject_match ()

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

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

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

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

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

setting :

the NMSettingConnection +

i :

the zero-based index of the array of altSubjectName matches

Returns :

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

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

setting :

the NMSetting8021x +

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_altsubject_match ()

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

+Removes the allowed altSubjectName at the specified index. +

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

setting :

the NMSetting8021x +

i :

the index of the altSubjectName match to remove
+
+
+
+

nm_setting_802_1x_remove_altsubject_match_by_value ()

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

+Removes the allowed altSubjectName altsubject_match. +

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

setting :

the NMSetting8021x +

altsubject_match :

the altSubjectName to remove

Returns :

 +TRUE if the alternative subject name match was found and removed, +FALSE if it was not.
+
+
+
+

nm_setting_802_1x_clear_altsubject_matches ()

+
void                nm_setting_802_1x_clear_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Clears all altSubjectName matches. +

+
++++ + + + + +

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

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

setting :

the NMSetting8021x +

Returns :

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

nm_setting_802_1x_get_client_cert_blob ()

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

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

setting :

the NMSetting8021x +

Returns :

the client certificate data. [transfer none] +
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

path to the 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" +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. +

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

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 PKCS#12 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

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

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_phase1_peaplabel ()

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

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_phase1_fast_provisioning ()

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

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_phase2_auth ()

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

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_autheap ()

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

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_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(). +

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

setting :

the NMSetting8021x +

Returns :

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

nm_setting_802_1x_get_phase2_ca_cert_blob ()

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

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

setting :

the NMSetting8021x +

Returns :

the "phase 2" CA certificate data. [transfer none] +
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

path to the "phase 2" CA certificate file
+
+
+
+

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

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

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

nm_setting_802_1x_get_phase2_subject_match ()

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

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

Returns :

the number of phase2-altsubject-matches entries.
+
+
+
+

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 +

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

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

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

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

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

setting :

the NMSetting8021x +

i :

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

nm_setting_802_1x_remove_phase2_altsubject_match_by_value ()

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

+Removes the allowed "phase 2" altSubjectName phase2_altsubject_match. +

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

setting :

the NMSetting8021x +

phase2_altsubject_match :

the "phase 2" altSubjectName to remove

Returns :

 +TRUE if the alternative subject name match for "phase 2" was found and removed, +FALSE if it was not.
+
+
+
+

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

+
++++ + + + + +

setting :

the NMSetting8021x +
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

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

nm_setting_802_1x_get_phase2_client_cert_blob ()

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

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

setting :

the NMSetting8021x +

Returns :

the "phase 2" client certificate data. [transfer none] +
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

path to the "phase 2" client certificate 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 +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method. +

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

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 PKCS#12 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.

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

nm_setting_802_1x_get_password ()

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

setting :

the NMSetting8021x +

Returns :

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

nm_setting_802_1x_get_password_flags ()

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

setting :

the NMSetting8021x +

Returns :

the NMSettingSecretFlags pertaining to the "password" +
+
+
+
+

nm_setting_802_1x_get_password_raw ()

+
GBytes *            nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
+
++++ + + + + + + + + + + +

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. [transfer none] +
+
+
+
+

nm_setting_802_1x_get_password_raw_flags ()

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

setting :

the NMSetting8021x +

Returns :

the NMSettingSecretFlags pertaining to the +"password-raw" +
+
+
+
+

nm_setting_802_1x_get_pin ()

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

setting :

the NMSetting8021x +

Returns :

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

nm_setting_802_1x_get_pin_flags ()

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

setting :

the NMSetting8021x +

Returns :

the NMSettingSecretFlags pertaining to the +"pin" +
+
+
+
+

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

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

setting :

the NMSetting8021x +

Returns :

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

nm_setting_802_1x_get_private_key_blob ()

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

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

setting :

the NMSetting8021x +

Returns :

the private key data. [transfer none] +
+
+
+
+

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

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

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

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

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

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 PKCS#12 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_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_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_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(). +

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

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 ()

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

+

+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. [transfer none] +
+
+
+
+

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

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

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

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

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

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 PKCS#12 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_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_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
+
+
+
+

Property Details

+
+

The "altsubject-matches" property

+
  "altsubject-matches"       GStrv                 : Read / Write
+

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

+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"                  GBytes*               : Read / Write
+

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

+

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

+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"              GBytes*               : Read / Write
+

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

+

+Setting this property directly is discouraged; use the +nm_setting_802_1x_set_client_cert() function instead. +

+
+
+
+

The "eap" property

+
  "eap"                      GStrv                 : Read / Write
+

+The allowed EAP method to be used when authenticating to the network with +802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", +and "fast". Each method requires different configuration using the +properties of this setting; refer to wpa_supplicant documentation for the +allowed combinations. +

+
+
+
+

The "identity" property

+
  "identity"                 gchar*                : Read / Write
+

+Identity string for EAP authentication methods. Often the user's user or +login name. +

+

Default value: NULL

+
+
+
+

The "pac-file" property

+
  "pac-file"                 gchar*                : Read / Write
+

+UTF-8 encoded file path containing PAC for EAP-FAST. +

+

Default value: NULL

+
+
+
+

The "password" property

+
  "password"                 gchar*                : Read / Write
+

+UTF-8 encoded password used for EAP authentication methods. If both the +"password" property and the "password-raw" +property are specified, "password" is preferred. +

+

Default value: NULL

+
+
+
+

The "password-flags" property

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

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

+
+
+
+

The "password-raw" property

+
  "password-raw"             GBytes*               : Read / Write
+

+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 the +"password" property and the "password-raw" +property are specified, "password" is preferred. +

+
+
+
+

The "password-raw-flags" property

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

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

+
+
+
+

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

+

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

+

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

+

Default value: NULL

+
+
+
+

The "phase2-altsubject-matches" property

+
  "phase2-altsubject-matches" GStrv                 : 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-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 "phase 2" 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. +

+

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

+

Default value: NULL

+
+
+
+

The "phase2-ca-cert" property

+
  "phase2-ca-cert"           GBytes*               : Read / Write
+

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

+

+Setting this property directly is discouraged; use the +nm_setting_802_1x_set_phase2_ca_cert() function instead. +

+
+
+
+

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

+

Default value: NULL

+
+
+
+

The "phase2-client-cert" property

+
  "phase2-client-cert"       GBytes*               : Read / Write
+

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

+

+Setting this property directly is discouraged; use the +nm_setting_802_1x_set_phase2_client_cert() function instead. +

+
+
+
+

The "phase2-private-key" property

+
  "phase2-private-key"       GBytes*               : Read / Write
+

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

+

+Setting this property directly is discouraged; use the +nm_setting_802_1x_set_phase2_private_key() function instead. +

+
+
+
+

The "phase2-private-key-password" property

+
  "phase2-private-key-password" gchar*                : Read / Write
+

+The password used to decrypt the "phase 2" private key specified in the +"phase2-private-key" property when the private key either +uses the path scheme, or is a PKCS#12 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. +

+

Default value: NULL

+
+
+
+

The "phase2-private-key-password-flags" property

+
  "phase2-private-key-password-flags" NMSettingSecretFlags  : Read / Write
+

+Flags indicating how to handle the +"phase2-private-key-password" property. +

+
+
+
+

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

+

Default value: NULL

+
+
+
+

The "pin" property

+
  "pin"                      gchar*                : Read / Write
+

+PIN used for EAP authentication methods. +

+

Default value: NULL

+
+
+
+

The "pin-flags" property

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

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

+
+
+
+

The "private-key" property

+
  "private-key"              GBytes*               : Read / Write
+

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

+

+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-password" property

+
  "private-key-password"     gchar*                : Read / Write
+

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

+

Default value: NULL

+
+
+
+

The "private-key-password-flags" property

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

+Flags indicating how to handle the "private-key-password" +property. +

+
+
+
+

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

+

Default value: NULL

+
+
+
+

The "system-ca-certs" property

+
  "system-ca-certs"          gboolean              : Read / Write / Construct
+

+When TRUE, overrides the "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. +

+

Default value: FALSE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingAdsl.html b/docs/libnm/html/NMSettingAdsl.html new file mode 100644 index 00000000..cbbf1701 --- /dev/null +++ b/docs/libnm/html/NMSettingAdsl.html @@ -0,0 +1,463 @@ + + + + +NMSettingAdsl + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingAdsl

+

NMSettingAdsl — Describes ADSL-based properties

+
+
+

Synopsis

+
#define             NM_SETTING_ADSL_SETTING_NAME
+#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
+struct              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);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingAdsl
+
+
+
+

Properties

+
+  "encapsulation"            gchar*                : Read / Write
+  "password"                 gchar*                : Read / Write
+  "password-flags"           NMSettingSecretFlags  : Read / Write
+  "protocol"                 gchar*                : Read / Write
+  "username"                 gchar*                : Read / Write
+  "vci"                      guint                 : Read / Write
+  "vpi"                      guint                 : Read / Write
+
+
+
+

Description

+

+The NMSettingAdsl object is a NMSetting subclass that describes +properties of ADSL connections. +

+
+
+

Details

+
+

NM_SETTING_ADSL_SETTING_NAME

+
#define NM_SETTING_ADSL_SETTING_NAME "adsl"
+
+

+

+
+
+
+

NM_SETTING_ADSL_USERNAME

+
#define NM_SETTING_ADSL_USERNAME            "username"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PASSWORD

+
#define NM_SETTING_ADSL_PASSWORD            "password"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PASSWORD_FLAGS

+
#define NM_SETTING_ADSL_PASSWORD_FLAGS      "password-flags"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL

+
#define NM_SETTING_ADSL_PROTOCOL            "protocol"
+
+

+

+
+
+
+

NM_SETTING_ADSL_ENCAPSULATION

+
#define NM_SETTING_ADSL_ENCAPSULATION       "encapsulation"
+
+

+

+
+
+
+

NM_SETTING_ADSL_VPI

+
#define NM_SETTING_ADSL_VPI                 "vpi"
+
+

+

+
+
+
+

NM_SETTING_ADSL_VCI

+
#define NM_SETTING_ADSL_VCI                 "vci"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL_PPPOA

+
#define NM_SETTING_ADSL_PROTOCOL_PPPOA      "pppoa"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL_PPPOE

+
#define NM_SETTING_ADSL_PROTOCOL_PPPOE      "pppoe"
+
+

+

+
+
+
+

NM_SETTING_ADSL_PROTOCOL_IPOATM

+
#define NM_SETTING_ADSL_PROTOCOL_IPOATM     "ipoatm"
+
+

+

+
+
+
+

NM_SETTING_ADSL_ENCAPSULATION_VCMUX

+
#define NM_SETTING_ADSL_ENCAPSULATION_VCMUX "vcmux"
+
+

+

+
+
+
+

NM_SETTING_ADSL_ENCAPSULATION_LLC

+
#define NM_SETTING_ADSL_ENCAPSULATION_LLC   "llc"
+
+

+

+
+
+
+

struct NMSettingAdsl

+
struct NMSettingAdsl;
+

+

+
+
+
+

NMSettingAdslClass

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

+Encapsulation of ADSL connection. Can be "vcmux" or "llc". +

+

Default value: NULL

+
+
+
+

The "password" property

+
  "password"                 gchar*                : Read / Write
+

+Password used to authenticate with the ADSL service. +

+

Default value: NULL

+
+
+
+

The "password-flags" property

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

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

+
+
+
+

The "protocol" property

+
  "protocol"                 gchar*                : Read / Write
+

+ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". +

+

Default value: NULL

+
+
+
+

The "username" property

+
  "username"                 gchar*                : Read / Write
+

+Username used to authenticate with the ADSL service. +

+

Default value: NULL

+
+
+
+

The "vci" property

+
  "vci"                      guint                 : Read / Write
+

+VCI of ADSL connection +

+

Allowed values: <= 65536

+

Default value: 0

+
+
+
+

The "vpi" property

+
  "vpi"                      guint                 : Read / Write
+

+VPI of ADSL connection +

+

Allowed values: <= 65536

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingBluetooth.html b/docs/libnm/html/NMSettingBluetooth.html new file mode 100644 index 00000000..203c3911 --- /dev/null +++ b/docs/libnm/html/NMSettingBluetooth.html @@ -0,0 +1,244 @@ + + + + +NMSettingBluetooth + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingBluetooth

+

NMSettingBluetooth — Describes Bluetooth connection properties

+
+
+

Synopsis

+
#define             NM_SETTING_BLUETOOTH_SETTING_NAME
+#define             NM_SETTING_BLUETOOTH_BDADDR
+#define             NM_SETTING_BLUETOOTH_TYPE
+#define             NM_SETTING_BLUETOOTH_TYPE_DUN
+#define             NM_SETTING_BLUETOOTH_TYPE_PANU
+struct              NMSettingBluetooth;
+                    NMSettingBluetoothClass;
+NMSetting *         nm_setting_bluetooth_new            (void);
+const char *        nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);
+const char *        nm_setting_bluetooth_get_connection_type
+                                                        (NMSettingBluetooth *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingBluetooth
+
+
+
+

Properties

+
+  "bdaddr"                   gchar*                : Read / Write
+  "type"                     gchar*                : Read / Write
+
+
+
+

Description

+

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

+
+
+

Details

+
+

NM_SETTING_BLUETOOTH_SETTING_NAME

+
#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth"
+
+

+

+
+
+
+

NM_SETTING_BLUETOOTH_BDADDR

+
#define NM_SETTING_BLUETOOTH_BDADDR    "bdaddr"
+
+

+

+
+
+
+

NM_SETTING_BLUETOOTH_TYPE

+
#define NM_SETTING_BLUETOOTH_TYPE      "type"
+
+

+

+
+
+
+

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

+
+
+
+

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

+
+
+
+

struct NMSettingBluetooth

+
struct NMSettingBluetooth;
+

+

+
+
+
+

NMSettingBluetoothClass

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

Property Details

+
+

The "bdaddr" property

+
  "bdaddr"                   gchar*                : Read / Write
+

+The Bluetooth address of the device. +

+

Default value: NULL

+
+
+
+

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

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingBond.html b/docs/libnm/html/NMSettingBond.html new file mode 100644 index 00000000..6a4d566c --- /dev/null +++ b/docs/libnm/html/NMSettingBond.html @@ -0,0 +1,573 @@ + + + + +NMSettingBond + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingBond

+

NMSettingBond — Describes connection properties for bonds

+
+
+

Synopsis

+
#define             NM_SETTING_BOND_SETTING_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
+#define             NM_SETTING_BOND_OPTION_ARP_VALIDATE
+#define             NM_SETTING_BOND_OPTION_PRIMARY
+#define             NM_SETTING_BOND_OPTION_PRIMARY_RESELECT
+#define             NM_SETTING_BOND_OPTION_FAIL_OVER_MAC
+#define             NM_SETTING_BOND_OPTION_USE_CARRIER
+#define             NM_SETTING_BOND_OPTION_AD_SELECT
+#define             NM_SETTING_BOND_OPTION_XMIT_HASH_POLICY
+#define             NM_SETTING_BOND_OPTION_RESEND_IGMP
+#define             NM_SETTING_BOND_OPTION_LACP_RATE
+struct              NMSettingBond;
+                    NMSettingBondClass;
+NMSetting *         nm_setting_bond_new                 (void);
+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);
+gboolean            nm_setting_bond_validate_option     (const char *name,
+                                                         const char *value);
+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

+
+  GObject
+   +----NMSetting
+         +----NMSettingBond
+
+
+
+

Properties

+
+  "options"                  GHashTable*           : 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"
+
+

+

+
+
+
+

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

+

+
+
+
+

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

+

+
+
+
+

NM_SETTING_BOND_OPTION_ARP_VALIDATE

+
#define NM_SETTING_BOND_OPTION_ARP_VALIDATE     "arp_validate"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_PRIMARY

+
#define NM_SETTING_BOND_OPTION_PRIMARY          "primary"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_PRIMARY_RESELECT

+
#define NM_SETTING_BOND_OPTION_PRIMARY_RESELECT "primary_reselect"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_FAIL_OVER_MAC

+
#define NM_SETTING_BOND_OPTION_FAIL_OVER_MAC    "fail_over_mac"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_USE_CARRIER

+
#define NM_SETTING_BOND_OPTION_USE_CARRIER      "use_carrier"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_AD_SELECT

+
#define NM_SETTING_BOND_OPTION_AD_SELECT        "ad_select"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_XMIT_HASH_POLICY

+
#define NM_SETTING_BOND_OPTION_XMIT_HASH_POLICY "xmit_hash_policy"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_RESEND_IGMP

+
#define NM_SETTING_BOND_OPTION_RESEND_IGMP      "resend_igmp"
+
+

+

+
+
+
+

NM_SETTING_BOND_OPTION_LACP_RATE

+
#define NM_SETTING_BOND_OPTION_LACP_RATE        "lacp_rate"
+
+

+

+
+
+
+

struct NMSettingBond

+
struct NMSettingBond;
+

+

+
+
+
+

NMSettingBondClass

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

+

+
+
+
+

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_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(). +

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

setting :

the NMSettingBond +

Returns :

the number of bonding options
+
+
+
+

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

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

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][transfer none] +

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][transfer none] +

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

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

setting :

the NMSettingBond +

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

+

+The order of how to set several options is relevant because there are options +that conflict with each other. +

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

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

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

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

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

nm_setting_bond_validate_option ()

+
gboolean            nm_setting_bond_validate_option     (const char *name,
+                                                         const char *value);
+

+Checks whether name is a valid bond option and value is a valid value for +the name. If value is NULL, the function only validates the option name. +

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

name :

the name of the option to validate

value :

the value of the option to validate

Returns :

 +TRUE, if the value is valid for the given name. +If the name is not a valid option, FALSE will be returned.
+
+
+
+

nm_setting_bond_get_valid_options ()

+
const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);
+

+Returns a list of valid bond options. +

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

setting :

the NMSettingBond +

Returns :

a NULL-terminated array of strings of valid bond options. [transfer none] +
+
+
+
+

nm_setting_bond_get_option_default ()

+
const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
+                                                         const char *name);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingBond +

name :

the name of the option

Returns :

the value of the bond option if not overridden by an entry in +the "options" property.
+
+
+
+

Property Details

+
+

The "options" property

+
  "options"                  GHashTable*           : Read / Write
+

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

+

+Type: GHashTable(utf8,utf8) +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingBridge.html b/docs/libnm/html/NMSettingBridge.html new file mode 100644 index 00000000..7248b61b --- /dev/null +++ b/docs/libnm/html/NMSettingBridge.html @@ -0,0 +1,426 @@ + + + + +NMSettingBridge + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingBridge

+

NMSettingBridge — Describes connection properties for bridges

+
+
+

Synopsis

+
#define             NM_SETTING_BRIDGE_SETTING_NAME
+#define             NM_SETTING_BRIDGE_MAC_ADDRESS
+#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
+struct              NMSettingBridge;
+                    NMSettingBridgeClass;
+NMSetting *         nm_setting_bridge_new               (void);
+const char *        nm_setting_bridge_get_mac_address   (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);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingBridge
+
+
+
+

Properties

+
+  "ageing-time"              guint                 : Read / Write / Construct
+  "forward-delay"            guint                 : Read / Write / Construct
+  "hello-time"               guint                 : Read / Write / Construct
+  "mac-address"              gchar*                : Read / Write
+  "max-age"                  guint                 : Read / Write / Construct
+  "priority"                 guint                 : Read / Write / Construct
+  "stp"                      gboolean              : Read / Write / Construct
+
+
+
+

Description

+

+The NMSettingBridge object is a NMSetting subclass that describes properties +necessary for bridging connections. +

+
+
+

Details

+
+

NM_SETTING_BRIDGE_SETTING_NAME

+
#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_MAC_ADDRESS

+
#define NM_SETTING_BRIDGE_MAC_ADDRESS    "mac-address"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_STP

+
#define NM_SETTING_BRIDGE_STP            "stp"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_PRIORITY

+
#define NM_SETTING_BRIDGE_PRIORITY       "priority"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_FORWARD_DELAY

+
#define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_HELLO_TIME

+
#define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_MAX_AGE

+
#define NM_SETTING_BRIDGE_MAX_AGE        "max-age"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_AGEING_TIME

+
#define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"
+
+

+

+
+
+
+

struct NMSettingBridge

+
struct NMSettingBridge;
+

+

+
+
+
+

NMSettingBridgeClass

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

nm_setting_bridge_get_mac_address ()

+
const char *        nm_setting_bridge_get_mac_address   (NMSettingBridge *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingBridge +

Returns :

the "mac-address" property of the setting
+
+
+
+

nm_setting_bridge_get_stp ()

+
gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingBridge +

Returns :

the "stp" property of the setting
+
+
+
+

nm_setting_bridge_get_priority ()

+
guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingBridge +

Returns :

the "priority" property of the setting
+
+
+
+

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

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

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

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

Property Details

+
+

The "ageing-time" property

+
  "ageing-time"              guint                 : Read / Write / Construct
+

+The Ethernet MAC address aging time, in seconds. +

+

Allowed values: <= 1000000

+

Default value: 300

+
+
+
+

The "forward-delay" property

+
  "forward-delay"            guint                 : Read / Write / Construct
+

+The Spanning Tree Protocol (STP) forwarding delay, in seconds. +

+

Allowed values: <= 30

+

Default value: 15

+
+
+
+

The "hello-time" property

+
  "hello-time"               guint                 : Read / Write / Construct
+

+The Spanning Tree Protocol (STP) hello time, in seconds. +

+

Allowed values: <= 10

+

Default value: 2

+
+
+
+

The "mac-address" property

+
  "mac-address"              gchar*                : Read / Write
+

+If specified, the MAC address of bridge. When creating a new bridge, this +MAC address will be set. When matching an existing (outside +NetworkManager created) bridge, this MAC address must match. +

+

Default value: NULL

+
+
+
+

The "max-age" property

+
  "max-age"                  guint                 : Read / Write / Construct
+

+The Spanning Tree Protocol (STP) maximum message age, in seconds. +

+

Allowed values: <= 40

+

Default value: 20

+
+
+
+

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

+

Allowed values: <= 65535

+

Default value: 32768

+
+
+
+

The "stp" property

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

+Controls whether Spanning Tree Protocol (STP) is enabled for this bridge. +

+

Default value: TRUE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingBridgePort.html b/docs/libnm/html/NMSettingBridgePort.html new file mode 100644 index 00000000..b6e0035f --- /dev/null +++ b/docs/libnm/html/NMSettingBridgePort.html @@ -0,0 +1,257 @@ + + + + +NMSettingBridgePort + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingBridgePort

+

NMSettingBridgePort — Describes connection properties for bridge ports

+
+
+

Synopsis

+
#define             NM_SETTING_BRIDGE_PORT_SETTING_NAME
+#define             NM_SETTING_BRIDGE_PORT_PRIORITY
+#define             NM_SETTING_BRIDGE_PORT_PATH_COST
+#define             NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE
+struct              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);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingBridgePort
+
+
+
+

Properties

+
+  "hairpin-mode"             gboolean              : Read / Write
+  "path-cost"                guint                 : Read / Write / Construct
+  "priority"                 guint                 : Read / Write / Construct
+
+
+
+

Description

+

+The NMSettingBridgePort object is a NMSetting subclass that describes +optional properties that apply to bridge ports. +

+
+
+

Details

+
+

NM_SETTING_BRIDGE_PORT_SETTING_NAME

+
#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_PORT_PRIORITY

+
#define NM_SETTING_BRIDGE_PORT_PRIORITY     "priority"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_PORT_PATH_COST

+
#define NM_SETTING_BRIDGE_PORT_PATH_COST    "path-cost"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE

+
#define NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE "hairpin-mode"
+
+

+

+
+
+
+

struct NMSettingBridgePort

+
struct NMSettingBridgePort;
+

+

+
+
+
+

NMSettingBridgePortClass

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

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

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

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

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

+

Default value: FALSE

+
+
+
+

The "path-cost" property

+
  "path-cost"                guint                 : Read / Write / Construct
+

+The Spanning Tree Protocol (STP) port cost for destinations via this +port. +

+

Allowed values: <= 65535

+

Default value: 100

+
+
+
+

The "priority" property

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

+The Spanning Tree Protocol (STP) priority of this bridge port. +

+

Allowed values: <= 63

+

Default value: 32

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingCdma.html b/docs/libnm/html/NMSettingCdma.html new file mode 100644 index 00000000..653c020b --- /dev/null +++ b/docs/libnm/html/NMSettingCdma.html @@ -0,0 +1,297 @@ + + + + +NMSettingCdma + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingCdma

+

NMSettingCdma — Describes CDMA-based mobile broadband properties

+
+
+

Synopsis

+
#define             NM_SETTING_CDMA_SETTING_NAME
+#define             NM_SETTING_CDMA_NUMBER
+#define             NM_SETTING_CDMA_USERNAME
+#define             NM_SETTING_CDMA_PASSWORD
+#define             NM_SETTING_CDMA_PASSWORD_FLAGS
+struct              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);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingCdma
+
+
+
+

Properties

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

Description

+

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

+
+
+

Details

+
+

NM_SETTING_CDMA_SETTING_NAME

+
#define NM_SETTING_CDMA_SETTING_NAME "cdma"
+
+

+

+
+
+
+

NM_SETTING_CDMA_NUMBER

+
#define NM_SETTING_CDMA_NUMBER         "number"
+
+

+

+
+
+
+

NM_SETTING_CDMA_USERNAME

+
#define NM_SETTING_CDMA_USERNAME       "username"
+
+

+

+
+
+
+

NM_SETTING_CDMA_PASSWORD

+
#define NM_SETTING_CDMA_PASSWORD       "password"
+
+

+

+
+
+
+

NM_SETTING_CDMA_PASSWORD_FLAGS

+
#define NM_SETTING_CDMA_PASSWORD_FLAGS "password-flags"
+
+

+

+
+
+
+

struct NMSettingCdma

+
struct NMSettingCdma;
+

+

+
+
+
+

NMSettingCdmaClass

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

+

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

+

Default value: NULL

+
+
+
+

The "password-flags" property

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

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

+
+
+
+

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

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingConnection.html b/docs/libnm/html/NMSettingConnection.html new file mode 100644 index 00000000..2ebace0b --- /dev/null +++ b/docs/libnm/html/NMSettingConnection.html @@ -0,0 +1,1246 @@ + + + + +NMSettingConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingConnection

+

NMSettingConnection — Describes general connection properties

+
+
+

Synopsis

+
#define             NM_SETTING_CONNECTION_SETTING_NAME
+#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN
+#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX
+#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT
+#define             NM_SETTING_CONNECTION_ID
+#define             NM_SETTING_CONNECTION_UUID
+#define             NM_SETTING_CONNECTION_INTERFACE_NAME
+#define             NM_SETTING_CONNECTION_TYPE
+#define             NM_SETTING_CONNECTION_AUTOCONNECT
+#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY
+#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
+#define             NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT
+struct              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_interface_name
+                                                        (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_connection_type
+                                                        (NMSettingConnection *setting);
+gboolean            nm_setting_connection_get_autoconnect
+                                                        (NMSettingConnection *setting);
+gint                nm_setting_connection_get_autoconnect_priority
+                                                        (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);
+gboolean            nm_setting_connection_remove_permission_by_value
+                                                        (NMSettingConnection *setting,
+                                                         const char *ptype,
+                                                         const char *pitem,
+                                                         const char *detail);
+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);
+gboolean            nm_setting_connection_remove_secondary_by_value
+                                                        (NMSettingConnection *setting,
+                                                         const char *sec_uuid);
+guint32             nm_setting_connection_get_gateway_ping_timeout
+                                                        (NMSettingConnection *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingConnection
+
+
+
+

Properties

+
+  "autoconnect"              gboolean              : Read / Write / Construct
+  "autoconnect-priority"     gint                  : Read / Write / Construct
+  "gateway-ping-timeout"     guint                 : Read / Write / Construct
+  "id"                       gchar*                : Read / Write
+  "interface-name"           gchar*                : Read / Write
+  "master"                   gchar*                : Read / Write
+  "permissions"              GStrv                 : Read / Write
+  "read-only"                gboolean              : Read / Write / Construct
+  "secondaries"              GStrv                 : 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"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN

+
#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN -999
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX

+
#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX 999
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT

+
#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT 0
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_ID

+
#define NM_SETTING_CONNECTION_ID             "id"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_UUID

+
#define NM_SETTING_CONNECTION_UUID           "uuid"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_INTERFACE_NAME

+
#define NM_SETTING_CONNECTION_INTERFACE_NAME "interface-name"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_TYPE

+
#define NM_SETTING_CONNECTION_TYPE           "type"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_AUTOCONNECT

+
#define NM_SETTING_CONNECTION_AUTOCONNECT    "autoconnect"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY

+
#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY "autoconnect-priority"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_TIMESTAMP

+
#define NM_SETTING_CONNECTION_TIMESTAMP      "timestamp"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_READ_ONLY

+
#define NM_SETTING_CONNECTION_READ_ONLY      "read-only"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_PERMISSIONS

+
#define NM_SETTING_CONNECTION_PERMISSIONS    "permissions"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_ZONE

+
#define NM_SETTING_CONNECTION_ZONE           "zone"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_MASTER

+
#define NM_SETTING_CONNECTION_MASTER         "master"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_SLAVE_TYPE

+
#define NM_SETTING_CONNECTION_SLAVE_TYPE     "slave-type"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_SECONDARIES

+
#define NM_SETTING_CONNECTION_SECONDARIES    "secondaries"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT

+
#define NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT "gateway-ping-timeout"
+
+

+

+
+
+
+

struct NMSettingConnection

+
struct NMSettingConnection;
+

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

+
+
+
+

NMSettingConnectionClass

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

+

+
+
+
+

nm_setting_connection_new ()

+
NMSetting *         nm_setting_connection_new           (void);
+

+Creates a new NMSettingConnection object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingConnection object
+
+
+
+

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

nm_setting_connection_get_uuid ()

+
const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
+

+Returns the "uuid" property of the connection. +

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

setting :

the NMSettingConnection +

Returns :

the connection UUID
+
+
+
+

nm_setting_connection_get_interface_name ()

+
const char *        nm_setting_connection_get_interface_name
+                                                        (NMSettingConnection *setting);
+

+Returns the "interface-name" property of the connection. +

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

setting :

the NMSettingConnection +

Returns :

the connection's interface name
+
+
+
+

nm_setting_connection_get_connection_type ()

+
const char *        nm_setting_connection_get_connection_type
+                                                        (NMSettingConnection *setting);
+

+Returns the "type" property of the connection. +

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

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

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

setting :

the NMSettingConnection +

Returns :

the connection's autoconnect behavior
+
+
+
+

nm_setting_connection_get_autoconnect_priority ()

+
gint                nm_setting_connection_get_autoconnect_priority
+                                                        (NMSettingConnection *setting);
+

+Returns the "autoconnect-priority" property of the connection. +The higher number, the higher priority. +

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

setting :

the NMSettingConnection +

Returns :

the connection's autoconnect priority
+
+
+
+

nm_setting_connection_get_timestamp ()

+
guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
+

+Returns the "timestamp" property of the connection. +

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

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

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

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

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

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

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

setting :

the NMSettingConnection +

idx :

the zero-based index of the permissions entry

out_ptype :

on return, the permission type (at this time, always "user")

out_pitem :

on return, the permission item (formatted accoring to ptype, see +"permissions" for more detail

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

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

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

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

setting :

the NMSettingConnection +

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

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

setting :

the NMSettingConnection +

ptype :

the permission type; at this time only "user" is supported

pitem :

the permission item formatted as required for ptype +

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

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

setting :

the NMSettingConnection +

idx :

the zero-based index of the permission to remove
+
+
+
+

nm_setting_connection_remove_permission_by_value ()

+
gboolean            nm_setting_connection_remove_permission_by_value
+                                                        (NMSettingConnection *setting,
+                                                         const char *ptype,
+                                                         const char *pitem,
+                                                         const char *detail);
+

+Removes the permission from the connection. +At this time, only the "user" permission type is supported, and pitem must +be a username. See "permissions": for more details. +

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

setting :

the NMSettingConnection +

ptype :

the permission type; at this time only "user" is supported

pitem :

the permission item formatted as required for ptype +

detail :

unused at this time; must be NULL. [allow-none] +

Returns :

 +TRUE if the permission was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_connection_get_master ()

+
const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);
+

+Returns the "master" property of the 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);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingConnection +

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

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

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

setting :

the NMSettingConnection +

Returns :

the number of configured secondary connection UUIDs
+
+
+
+

nm_setting_connection_get_secondary ()

+
const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
+                                                         guint32 idx);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingConnection +

idx :

the zero-based index of the secondary connection UUID entry

Returns :

the secondary connection UUID at index 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. +

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

setting :

the NMSettingConnection +

sec_uuid :

the secondary connection UUID to add

Returns :

 +TRUE if the secondary connection UUID was added; FALSE if the UUID +was already present
+
+
+
+

nm_setting_connection_remove_secondary ()

+
void                nm_setting_connection_remove_secondary
+                                                        (NMSettingConnection *setting,
+                                                         guint32 idx);
+

+Removes the secondary coonnection UUID at index idx. +

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

setting :

the NMSettingConnection +

idx :

index number of the secondary connection UUID
+
+
+
+

nm_setting_connection_remove_secondary_by_value ()

+
gboolean            nm_setting_connection_remove_secondary_by_value
+                                                        (NMSettingConnection *setting,
+                                                         const char *sec_uuid);
+

+Removes the secondary coonnection UUID sec_uuid. +

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

setting :

the NMSettingConnection +

sec_uuid :

the secondary connection UUID to remove

Returns :

 +TRUE if the secondary connection UUID was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_connection_get_gateway_ping_timeout ()

+
guint32             nm_setting_connection_get_gateway_ping_timeout
+                                                        (NMSettingConnection *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingConnection +

Returns :

the value contained in the "gateway-ping-timeout" +property.
+
+
+
+

Property Details

+
+

The "autoconnect" property

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

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

+

Default value: TRUE

+
+
+
+

The "autoconnect-priority" property

+
  "autoconnect-priority"     gint                  : Read / Write / Construct
+

+The autoconnect priority. If the connection is set to autoconnect, +connections with higher priority will be preferred. Defaults to 0. +The higher number means higher priority. +

+

Allowed values: [-999,999]

+

Default value: 0

+
+
+
+

The "gateway-ping-timeout" property

+
  "gateway-ping-timeout"     guint                 : Read / Write / Construct
+

+If greater than zero, delay success of IP addressing until either the +timeout is reached, or an IP gateway replies to a ping. +

+

Allowed values: <= 30

+

Default value: 0

+
+
+
+

The "id" property

+
  "id"                       gchar*                : Read / Write
+

+A human readable unique identifier for the connection, like "Work Wi-Fi" +or "T-Mobile 3G". +

+

Default value: NULL

+
+
+
+

The "interface-name" property

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

+The name of the network interface this connection is bound to. If not +set, then the connection can be attached to any interface of the +appropriate type (subject to restrictions imposed by other settings). +

+

+For software devices this specifies the name of the created device. +

+

+For connection types where interface names cannot easily be made +persistent (e.g. mobile broadband or USB Ethernet), this property should +not be used. Setting this property restricts the interfaces a connection +can be used with, and if interface names change or are reordered the +connection may be applied to the wrong interface. +

+

Default value: NULL

+
+
+
+

The "master" property

+
  "master"                   gchar*                : Read / Write
+

+Interface name of the master device or UUID of the master connection. +

+

Default value: NULL

+
+
+
+

The "permissions" property

+
  "permissions"              GStrv                 : Read / Write
+

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

+
+
+
+

The "read-only" property

+
  "read-only"                gboolean              : Read / Write / Construct
+

+FALSE if the connection can be modified using the provided settings +service's D-Bus interface with the right privileges, or TRUE if the +connection is read-only and cannot be modified. +

+

Default value: FALSE

+
+
+
+

The "secondaries" property

+
  "secondaries"              GStrv                 : Read / Write
+

+List of connection UUIDs that should be activated when the base +connection itself is activated. Currently only VPN connections are +supported. +

+
+
+
+

The "slave-type" property

+
  "slave-type"               gchar*                : Read / Write
+

+Setting name of the device type of this slave's master connection (eg, +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
+

+The time, in seconds since the Unix Epoch, that the connection was last +_successfully_ fully activated. +

+

+NetworkManager updates the connection timestamp periodically when the +connection is active to ensure that an active connection has the latest +timestamp. The property is only meant for reading (changes to this +property will not be preserved). +

+

Default value: 0

+
+
+
+

The "type" property

+
  "type"                     gchar*                : Read / Write
+

+Base type of the connection. For hardware-dependent connections, should +contain the setting name of the hardware-type specific setting (ie, +"802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for +non-hardware dependent connections like VPN or otherwise, should contain +the setting name of that setting type (ie, "vpn" or "bridge", etc). +

+

Default value: NULL

+
+
+
+

The "uuid" property

+
  "uuid"                     gchar*                : Read / Write
+

+A universally unique identifier for the connection, for example generated +with libuuid. It should be assigned when the connection is created, and +never changed as long as the connection still applies to the same +network. For example, it should not be changed when the +"id" property or NMSettingIP4Config changes, but +might need to be re-created when the Wi-Fi SSID, mobile broadband network +provider, or "type" property 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(). +

+

Default value: NULL

+
+
+
+

The "zone" property

+
  "zone"                     gchar*                : Read / Write / Construct
+

+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 value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingDcb.html b/docs/libnm/html/NMSettingDcb.html new file mode 100644 index 00000000..e9d9de64 --- /dev/null +++ b/docs/libnm/html/NMSettingDcb.html @@ -0,0 +1,1140 @@ + + + + +NMSettingDcb + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingDcb

+

NMSettingDcb — Connection properties for Data Center Bridging

+
+
+

Synopsis

+
#define             NM_SETTING_DCB_SETTING_NAME
+enum                NMSettingDcbFlags;
+#define             NM_SETTING_DCB_FCOE_MODE_FABRIC
+#define             NM_SETTING_DCB_FCOE_MODE_VN2VN
+#define             NM_SETTING_DCB_APP_FCOE_FLAGS
+#define             NM_SETTING_DCB_APP_FCOE_PRIORITY
+#define             NM_SETTING_DCB_APP_FCOE_MODE
+#define             NM_SETTING_DCB_APP_ISCSI_FLAGS
+#define             NM_SETTING_DCB_APP_ISCSI_PRIORITY
+#define             NM_SETTING_DCB_APP_FIP_FLAGS
+#define             NM_SETTING_DCB_APP_FIP_PRIORITY
+#define             NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS
+#define             NM_SETTING_DCB_PRIORITY_FLOW_CONTROL
+#define             NM_SETTING_DCB_PRIORITY_GROUP_FLAGS
+#define             NM_SETTING_DCB_PRIORITY_GROUP_ID
+#define             NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH
+#define             NM_SETTING_DCB_PRIORITY_BANDWIDTH
+#define             NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH
+#define             NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS
+struct              NMSettingDcb;
+                    NMSettingDcbClass;
+NMSetting *         nm_setting_dcb_new                  (void);
+NMSettingDcbFlags   nm_setting_dcb_get_app_fcoe_flags   (NMSettingDcb *setting);
+gint                nm_setting_dcb_get_app_fcoe_priority
+                                                        (NMSettingDcb *setting);
+const char *        nm_setting_dcb_get_app_fcoe_mode    (NMSettingDcb *setting);
+NMSettingDcbFlags   nm_setting_dcb_get_app_iscsi_flags  (NMSettingDcb *setting);
+gint                nm_setting_dcb_get_app_iscsi_priority
+                                                        (NMSettingDcb *setting);
+NMSettingDcbFlags   nm_setting_dcb_get_app_fip_flags    (NMSettingDcb *setting);
+gint                nm_setting_dcb_get_app_fip_priority (NMSettingDcb *setting);
+NMSettingDcbFlags   nm_setting_dcb_get_priority_flow_control_flags
+                                                        (NMSettingDcb *setting);
+gboolean            nm_setting_dcb_get_priority_flow_control
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+void                nm_setting_dcb_set_priority_flow_control
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         gboolean enabled);
+NMSettingDcbFlags   nm_setting_dcb_get_priority_group_flags
+                                                        (NMSettingDcb *setting);
+guint               nm_setting_dcb_get_priority_group_id
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+void                nm_setting_dcb_set_priority_group_id
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         guint group_id);
+guint               nm_setting_dcb_get_priority_group_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint group_id);
+void                nm_setting_dcb_set_priority_group_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint group_id,
+                                                         guint bandwidth_percent);
+guint               nm_setting_dcb_get_priority_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+void                nm_setting_dcb_set_priority_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         guint bandwidth_percent);
+gboolean            nm_setting_dcb_get_priority_strict_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+void                nm_setting_dcb_set_priority_strict_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         gboolean strict);
+guint               nm_setting_dcb_get_priority_traffic_class
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+void                nm_setting_dcb_set_priority_traffic_class
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         guint traffic_class);
+
+
+
+

Object Hierarchy

+
+  GFlags
+   +----NMSettingDcbFlags
+
+
+  GObject
+   +----NMSetting
+         +----NMSettingDcb
+
+
+
+

Properties

+
+  "app-fcoe-flags"           NMSettingDcbFlags     : Read / Write
+  "app-fcoe-mode"            gchar*                : Read / Write / Construct
+  "app-fcoe-priority"        gint                  : Read / Write / Construct
+  "app-fip-flags"            NMSettingDcbFlags     : Read / Write
+  "app-fip-priority"         gint                  : Read / Write / Construct
+  "app-iscsi-flags"          NMSettingDcbFlags     : Read / Write
+  "app-iscsi-priority"       gint                  : Read / Write / Construct
+  "priority-bandwidth"       GArray*               : Read / Write
+  "priority-flow-control"    GArray*               : Read / Write
+  "priority-flow-control-flags" NMSettingDcbFlags     : Read / Write
+  "priority-group-bandwidth" GArray*               : Read / Write
+  "priority-group-flags"     NMSettingDcbFlags     : Read / Write
+  "priority-group-id"        GArray*               : Read / Write
+  "priority-strict-bandwidth" GArray*               : Read / Write
+  "priority-traffic-class"   GArray*               : Read / Write
+
+
+
+

Description

+

+The NMSettingDcb object is a NMSetting subclass that describes properties +for enabling and using Data Center Bridging (DCB) on Ethernet networks. +DCB is a set of protocols (including 802.1Qbb, 802.1Qaz, 802.1Qau, and +802.1AB) to eliminate packet loss in Ethernet networks and support the use +of storage technologies like Fibre Channel over Ethernet (FCoE) and iSCSI. +

+
+
+

Details

+
+

NM_SETTING_DCB_SETTING_NAME

+
#define NM_SETTING_DCB_SETTING_NAME "dcb"
+
+

+

+
+
+
+

enum NMSettingDcbFlags

+
typedef enum {
+ /*< flags >*/
+	NM_SETTING_DCB_FLAG_NONE      = 0x00000000,
+	NM_SETTING_DCB_FLAG_ENABLE    = 0x00000001,
+	NM_SETTING_DCB_FLAG_ADVERTISE = 0x00000002,
+	NM_SETTING_DCB_FLAG_WILLING   = 0x00000004
+} NMSettingDcbFlags;
+
+

+DCB feature flags. +

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

NM_SETTING_DCB_FLAG_NONE

no flag +

NM_SETTING_DCB_FLAG_ENABLE

the feature is enabled +

NM_SETTING_DCB_FLAG_ADVERTISE

the feature is advertised +

NM_SETTING_DCB_FLAG_WILLING

the feature is willing to change based on +peer configuration advertisements +
+
+
+
+

NM_SETTING_DCB_FCOE_MODE_FABRIC

+
#define NM_SETTING_DCB_FCOE_MODE_FABRIC  "fabric"
+
+

+Indicates that the FCoE controller should use "fabric" mode (default) +

+
+
+
+

NM_SETTING_DCB_FCOE_MODE_VN2VN

+
#define NM_SETTING_DCB_FCOE_MODE_VN2VN   "vn2vn"
+
+

+Indicates that the FCoE controller should use "VN2VN" mode. +

+
+
+
+

NM_SETTING_DCB_APP_FCOE_FLAGS

+
#define NM_SETTING_DCB_APP_FCOE_FLAGS         "app-fcoe-flags"
+
+

+

+
+
+
+

NM_SETTING_DCB_APP_FCOE_PRIORITY

+
#define NM_SETTING_DCB_APP_FCOE_PRIORITY      "app-fcoe-priority"
+
+

+

+
+
+
+

NM_SETTING_DCB_APP_FCOE_MODE

+
#define NM_SETTING_DCB_APP_FCOE_MODE          "app-fcoe-mode"
+
+

+

+
+
+
+

NM_SETTING_DCB_APP_ISCSI_FLAGS

+
#define NM_SETTING_DCB_APP_ISCSI_FLAGS        "app-iscsi-flags"
+
+

+

+
+
+
+

NM_SETTING_DCB_APP_ISCSI_PRIORITY

+
#define NM_SETTING_DCB_APP_ISCSI_PRIORITY     "app-iscsi-priority"
+
+

+

+
+
+
+

NM_SETTING_DCB_APP_FIP_FLAGS

+
#define NM_SETTING_DCB_APP_FIP_FLAGS          "app-fip-flags"
+
+

+

+
+
+
+

NM_SETTING_DCB_APP_FIP_PRIORITY

+
#define NM_SETTING_DCB_APP_FIP_PRIORITY       "app-fip-priority"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS

+
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS  "priority-flow-control-flags"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_FLOW_CONTROL

+
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL        "priority-flow-control"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_GROUP_FLAGS

+
#define NM_SETTING_DCB_PRIORITY_GROUP_FLAGS      "priority-group-flags"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_GROUP_ID

+
#define NM_SETTING_DCB_PRIORITY_GROUP_ID         "priority-group-id"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH

+
#define NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH  "priority-group-bandwidth"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_BANDWIDTH

+
#define NM_SETTING_DCB_PRIORITY_BANDWIDTH        "priority-bandwidth"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH

+
#define NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH "priority-strict-bandwidth"
+
+

+

+
+
+
+

NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS

+
#define NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS    "priority-traffic-class"
+
+

+

+
+
+
+

struct NMSettingDcb

+
struct NMSettingDcb;
+

+

+
+
+
+

NMSettingDcbClass

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

+

+
+
+
+

nm_setting_dcb_new ()

+
NMSetting *         nm_setting_dcb_new                  (void);
+

+Creates a new NMSettingDcb object with default values. +

+
++++ + + + + +

Returns :

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

nm_setting_dcb_get_app_fcoe_flags ()

+
NMSettingDcbFlags   nm_setting_dcb_get_app_fcoe_flags   (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "app-fcoe-flags" property of the setting
+
+
+
+

nm_setting_dcb_get_app_fcoe_priority ()

+
gint                nm_setting_dcb_get_app_fcoe_priority
+                                                        (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "app-fcoe-priority" property of the setting
+
+
+
+

nm_setting_dcb_get_app_fcoe_mode ()

+
const char *        nm_setting_dcb_get_app_fcoe_mode    (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "app-fcoe-mode" property of the setting
+
+
+
+

nm_setting_dcb_get_app_iscsi_flags ()

+
NMSettingDcbFlags   nm_setting_dcb_get_app_iscsi_flags  (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "app-iscsi-flags" property of the setting
+
+
+
+

nm_setting_dcb_get_app_iscsi_priority ()

+
gint                nm_setting_dcb_get_app_iscsi_priority
+                                                        (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "app-iscsi-priority" property of the setting
+
+
+
+

nm_setting_dcb_get_app_fip_flags ()

+
NMSettingDcbFlags   nm_setting_dcb_get_app_fip_flags    (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "app-fip-flags" property of the setting
+
+
+
+

nm_setting_dcb_get_app_fip_priority ()

+
gint                nm_setting_dcb_get_app_fip_priority (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "app-fip-priority" property of the setting
+
+
+
+

nm_setting_dcb_get_priority_flow_control_flags ()

+
NMSettingDcbFlags   nm_setting_dcb_get_priority_flow_control_flags
+                                                        (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "priority-flow-control-flags" property of the setting
+
+
+
+

nm_setting_dcb_get_priority_flow_control ()

+
gboolean            nm_setting_dcb_get_priority_flow_control
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to retrieve flow control for

Returns :

 +TRUE if flow control is enabled for the given user_priority, +FALSE if not enabled
+
+
+
+

nm_setting_dcb_set_priority_flow_control ()

+
void                nm_setting_dcb_set_priority_flow_control
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         gboolean enabled);
+

+These values are only valid when "priority-flow-control" includes +the NM_SETTING_DCB_FLAG_ENABLE flag. +

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

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to set flow control for

enabled :

 +TRUE to enable flow control for this priority, FALSE to disable it
+
+
+
+

nm_setting_dcb_get_priority_group_flags ()

+
NMSettingDcbFlags   nm_setting_dcb_get_priority_group_flags
+                                                        (NMSettingDcb *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingDcb +

Returns :

the "priority-group-flags" property of the setting
+
+
+
+

nm_setting_dcb_get_priority_group_id ()

+
guint               nm_setting_dcb_get_priority_group_id
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to retrieve the group ID for

Returns :

the group number user_priority is assigned to. These values are +only valid when "priority-group-flags" includes the +NM_SETTING_DCB_FLAG_ENABLE flag.
+
+
+
+

nm_setting_dcb_set_priority_group_id ()

+
void                nm_setting_dcb_set_priority_group_id
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         guint group_id);
+

+These values are only valid when "priority-group-flags" includes +the NM_SETTING_DCB_FLAG_ENABLE flag. +

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

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to set flow control for

group_id :

the group (0 - 7) to assign user_priority to, or 15 for the +unrestricted group.
+
+
+
+

nm_setting_dcb_get_priority_group_bandwidth ()

+
guint               nm_setting_dcb_get_priority_group_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint group_id);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingDcb +

group_id :

the priority group (0 - 7) to retrieve the bandwidth percentage for

Returns :

the bandwidth percentage assigned to group_id. These values are +only valid when "priority-group-flags" includes the +NM_SETTING_DCB_FLAG_ENABLE flag.
+
+
+
+

nm_setting_dcb_set_priority_group_bandwidth ()

+
void                nm_setting_dcb_set_priority_group_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint group_id,
+                                                         guint bandwidth_percent);
+

+These values are only valid when "priority-group-flags" includes +the NM_SETTING_DCB_FLAG_ENABLE flag. +

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

setting :

the NMSettingDcb +

group_id :

the priority group (0 - 7) to set the bandwidth percentage for

bandwidth_percent :

the bandwidth percentage (0 - 100) to assign to group_id to
+
+
+
+

nm_setting_dcb_get_priority_bandwidth ()

+
guint               nm_setting_dcb_get_priority_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to retrieve the group bandwidth percentage for

Returns :

the allowed bandwidth percentage of user_priority in its priority group. +These values are only valid when "priority-group-flags" includes the +NM_SETTING_DCB_FLAG_ENABLE flag.
+
+
+
+

nm_setting_dcb_set_priority_bandwidth ()

+
void                nm_setting_dcb_set_priority_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         guint bandwidth_percent);
+

+These values are only valid when "priority-group-flags" includes +the NM_SETTING_DCB_FLAG_ENABLE flag. +

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

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to set the bandwidth percentage for

bandwidth_percent :

the bandwidth percentage (0 - 100) that user_priority is +allowed to use within its priority group
+
+
+
+

nm_setting_dcb_get_priority_strict_bandwidth ()

+
gboolean            nm_setting_dcb_get_priority_strict_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to retrieve strict bandwidth for

Returns :

 +TRUE if user_priority may use all of the bandwidth allocated to its +assigned group, or FALSE if not. These values are only valid when +"priority-group-flags" includes the NM_SETTING_DCB_FLAG_ENABLE flag.
+
+
+
+

nm_setting_dcb_set_priority_strict_bandwidth ()

+
void                nm_setting_dcb_set_priority_strict_bandwidth
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         gboolean strict);
+

+These values are only valid when "priority-group-flags" includes +the NM_SETTING_DCB_FLAG_ENABLE flag. +

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

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to set strict bandwidth for

strict :

 +TRUE to allow user_priority to use all the bandwidth allocated to +its priority group, or FALSE if not
+
+
+
+

nm_setting_dcb_get_priority_traffic_class ()

+
guint               nm_setting_dcb_get_priority_traffic_class
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingDcb +

user_priority :

the User Priority (0 - 7) to retrieve the traffic class for

Returns :

the traffic class assigned to user_priority. These values are only +valid when "priority-group-flags" includes the +NM_SETTING_DCB_FLAG_ENABLE flag.
+
+
+
+

nm_setting_dcb_set_priority_traffic_class ()

+
void                nm_setting_dcb_set_priority_traffic_class
+                                                        (NMSettingDcb *setting,
+                                                         guint user_priority,
+                                                         guint traffic_class);
+

+

+
+
+
+

Property Details

+
+

The "app-fcoe-flags" property

+
  "app-fcoe-flags"           NMSettingDcbFlags     : Read / Write
+

+Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may +be any combination of NM_SETTING_DCB_FLAG_ENABLE, +NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING. +

+
+
+
+

The "app-fcoe-mode" property

+
  "app-fcoe-mode"            gchar*                : Read / Write / Construct
+

+The FCoE controller mode; either NM_SETTING_DCB_FCOE_MODE_FABRIC +(default) or NM_SETTING_DCB_FCOE_MODE_VN2VN. +

+

Default value: "fabric"

+
+
+
+

The "app-fcoe-priority" property

+
  "app-fcoe-priority"        gint                  : Read / Write / Construct
+

+The highest User Priority (0 - 7) which FCoE frames should use, or -1 for +default priority. Only used when the "app-fcoe-flags" +property includes the NM_SETTING_DCB_FLAG_ENABLE flag. +

+

Allowed values: [-1,7]

+

Default value: -1

+
+
+
+

The "app-fip-flags" property

+
  "app-fip-flags"            NMSettingDcbFlags     : Read / Write
+

+Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may +be any combination of NM_SETTING_DCB_FLAG_ENABLE, +NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING. +

+
+
+
+

The "app-fip-priority" property

+
  "app-fip-priority"         gint                  : Read / Write / Construct
+

+The highest User Priority (0 - 7) which FIP frames should use, or -1 for +default priority. Only used when the "app-fip-flags" +property includes the NM_SETTING_DCB_FLAG_ENABLE flag. +

+

Allowed values: [-1,7]

+

Default value: -1

+
+
+
+

The "app-iscsi-flags" property

+
  "app-iscsi-flags"          NMSettingDcbFlags     : Read / Write
+

+Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags +may be any combination of NM_SETTING_DCB_FLAG_ENABLE, +NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING. +

+
+
+
+

The "app-iscsi-priority" property

+
  "app-iscsi-priority"       gint                  : Read / Write / Construct
+

+The highest User Priority (0 - 7) which iSCSI frames should use, or -1 +for default priority. Only used when the "app-iscsi-flags" +property includes the NM_SETTING_DCB_FLAG_ENABLE flag. +

+

Allowed values: [-1,7]

+

Default value: -1

+
+
+
+

The "priority-bandwidth" property

+
  "priority-bandwidth"       GArray*               : Read / Write
+

+An array of 8 uint values, where the array index corresponds to the User +Priority (0 - 7) and the value indicates the percentage of bandwidth of +the priority's assigned group that the priority may use. The sum of all +percentages for priorities which belong to the same group must total 100 +percent. +

+

+Element-type: guint +

+
+
+
+

The "priority-flow-control" property

+
  "priority-flow-control"    GArray*               : Read / Write
+

+An array of 8 boolean values, where the array index corresponds to the User +Priority (0 - 7) and the value indicates whether or not the corresponding +priority should transmit priority pause. +

+

+Element-type: gboolean +

+
+
+
+

The "priority-flow-control-flags" property

+
  "priority-flow-control-flags" NMSettingDcbFlags     : Read / Write
+

+Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). +Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE, +NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING. +

+
+
+
+

The "priority-group-bandwidth" property

+
  "priority-group-bandwidth" GArray*               : Read / Write
+

+An array of 8 uint values, where the array index corresponds to the +Priority Group ID (0 - 7) and the value indicates the percentage of link +bandwidth allocated to that group. Allowed values are 0 - 100, and the +sum of all values must total 100 percent. +

+

+Element-type: guint +

+
+
+
+

The "priority-group-flags" property

+
  "priority-group-flags"     NMSettingDcbFlags     : Read / Write
+

+Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be +any combination of NM_SETTING_DCB_FLAG_ENABLE, +NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING. +

+
+
+
+

The "priority-group-id" property

+
  "priority-group-id"        GArray*               : Read / Write
+

+An array of 8 uint values, where the array index corresponds to the User +Priority (0 - 7) and the value indicates the Priority Group ID. Allowed +Priority Group ID values are 0 - 7 or 15 for the unrestricted group. +

+

+Element-type: guint +

+
+
+
+

The "priority-strict-bandwidth" property

+
  "priority-strict-bandwidth" GArray*               : Read / Write
+

+An array of 8 boolean values, where the array index corresponds to the User +Priority (0 - 7) and the value indicates whether or not the priority may +use all of the bandwidth allocated to its assigned group. +

+

+Element-type: gboolean +

+
+
+
+

The "priority-traffic-class" property

+
  "priority-traffic-class"   GArray*               : Read / Write
+

+An array of 8 uint values, where the array index corresponds to the User +Priority (0 - 7) and the value indicates the traffic class (0 - 7) to +which the priority is mapped. +

+

+Element-type: guint +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingGeneric.html b/docs/libnm/html/NMSettingGeneric.html new file mode 100644 index 00000000..1ade9b46 --- /dev/null +++ b/docs/libnm/html/NMSettingGeneric.html @@ -0,0 +1,119 @@ + + + + +NMSettingGeneric + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingGeneric

+

NMSettingGeneric — Describes connection properties for generic devices

+
+
+

Synopsis

+
#define             NM_SETTING_GENERIC_SETTING_NAME
+struct              NMSettingGeneric;
+                    NMSettingGenericClass;
+NMSetting *         nm_setting_generic_new              (void);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingGeneric
+
+
+
+

Description

+

+The NMSettingGeneric object is a NMSetting subclass that describes +optional properties that apply to "generic" devices (ie, devices that +NetworkManager does not specifically recognize). +

+

+There are currently no properties on this object; it exists only to be +the "connection type" setting on NMConnections for generic devices. +

+
+
+

Details

+
+

NM_SETTING_GENERIC_SETTING_NAME

+
#define NM_SETTING_GENERIC_SETTING_NAME "generic"
+
+

+

+
+
+
+

struct NMSettingGeneric

+
struct NMSettingGeneric;
+

+

+
+
+
+

NMSettingGenericClass

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

+

+
+
+
+

nm_setting_generic_new ()

+
NMSetting *         nm_setting_generic_new              (void);
+

+Creates a new NMSettingGeneric object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingGeneric object. [transfer full] +
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingGsm.html b/docs/libnm/html/NMSettingGsm.html new file mode 100644 index 00000000..f3bd95cd --- /dev/null +++ b/docs/libnm/html/NMSettingGsm.html @@ -0,0 +1,521 @@ + + + + +NMSettingGsm + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingGsm

+

NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties

+
+
+

Synopsis

+
#define             NM_SETTING_GSM_SETTING_NAME
+#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_PIN
+#define             NM_SETTING_GSM_PIN_FLAGS
+#define             NM_SETTING_GSM_HOME_ONLY
+struct              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);
+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);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingGsm
+
+
+
+

Properties

+
+  "apn"                      gchar*                : Read / Write
+  "home-only"                gboolean              : Read / Write
+  "network-id"               gchar*                : Read / Write
+  "number"                   gchar*                : Read / Write
+  "password"                 gchar*                : Read / Write
+  "password-flags"           NMSettingSecretFlags  : Read / Write
+  "pin"                      gchar*                : Read / Write
+  "pin-flags"                NMSettingSecretFlags  : Read / Write
+  "username"                 gchar*                : Read / Write
+
+
+
+

Description

+

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

+
+
+

Details

+
+

NM_SETTING_GSM_SETTING_NAME

+
#define NM_SETTING_GSM_SETTING_NAME "gsm"
+
+

+

+
+
+
+

NM_SETTING_GSM_NUMBER

+
#define NM_SETTING_GSM_NUMBER         "number"
+
+

+

+
+
+
+

NM_SETTING_GSM_USERNAME

+
#define NM_SETTING_GSM_USERNAME       "username"
+
+

+

+
+
+
+

NM_SETTING_GSM_PASSWORD

+
#define NM_SETTING_GSM_PASSWORD       "password"
+
+

+

+
+
+
+

NM_SETTING_GSM_PASSWORD_FLAGS

+
#define NM_SETTING_GSM_PASSWORD_FLAGS "password-flags"
+
+

+

+
+
+
+

NM_SETTING_GSM_APN

+
#define NM_SETTING_GSM_APN            "apn"
+
+

+

+
+
+
+

NM_SETTING_GSM_NETWORK_ID

+
#define NM_SETTING_GSM_NETWORK_ID     "network-id"
+
+

+

+
+
+
+

NM_SETTING_GSM_PIN

+
#define NM_SETTING_GSM_PIN            "pin"
+
+

+

+
+
+
+

NM_SETTING_GSM_PIN_FLAGS

+
#define NM_SETTING_GSM_PIN_FLAGS      "pin-flags"
+
+

+

+
+
+
+

NM_SETTING_GSM_HOME_ONLY

+
#define NM_SETTING_GSM_HOME_ONLY      "home-only"
+
+

+

+
+
+
+

struct NMSettingGsm

+
struct NMSettingGsm;
+

+

+
+
+
+

NMSettingGsmClass

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

Returns :

the "username" property of the setting
+
+
+
+

nm_setting_gsm_get_password ()

+
const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingGsm +

Returns :

the "password" property of the setting
+
+
+
+

nm_setting_gsm_get_apn ()

+
const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
+
++++ + + + + + + + + + + +

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

setting :

the NMSettingGsm +

Returns :

the "network-id" property of the setting
+
+
+
+

nm_setting_gsm_get_pin ()

+
const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
+
++++ + + + + + + + + + + +

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

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

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

setting :

the NMSettingGsm +

Returns :

the NMSettingSecretFlags pertaining to the "password" +
+
+
+
+

Property Details

+
+

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

+

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

+

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

+

Default value: NULL

+
+
+
+

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

+

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

+

Default value: NULL

+
+
+
+

The "password-flags" property

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

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

+
+
+
+

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

+

Default value: NULL

+
+
+
+

The "pin-flags" property

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

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

+
+
+
+

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

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingIP4Config.html b/docs/libnm/html/NMSettingIP4Config.html new file mode 100644 index 00000000..cb7542b8 --- /dev/null +++ b/docs/libnm/html/NMSettingIP4Config.html @@ -0,0 +1,251 @@ + + + + +NMSettingIP4Config + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingIP4Config

+

NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties

+
+
+

Synopsis

+
#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
+#define             NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
+#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
+struct              NMSettingIP4Config;
+                    NMSettingIP4ConfigClass;
+NMSetting *         nm_setting_ip4_config_new           (void);
+const char *        nm_setting_ip4_config_get_dhcp_client_id
+                                                        (NMSettingIP4Config *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingIPConfig
+               +----NMSettingIP4Config
+
+
+
+

Properties

+
+  "dhcp-client-id"           gchar*                : Read / Write
+
+
+
+

Description

+

+The NMSettingIP4Config object is a NMSetting subclass that describes +properties related to IPv4 addressing, routing, and Domain Name Service. +

+

+NMSettingIP4Config has few properties or methods of its own; it inherits +almost everything from NMSettingIPConfig. +

+

+NetworkManager supports 5 values for the "method" property +for IPv4. 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. +

+
+
+

Details

+
+

NM_SETTING_IP4_CONFIG_SETTING_NAME

+
#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
+
+

+

+
+
+
+

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

+
#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"
+
+

+

+
+
+
+

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

+
+
+
+

struct NMSettingIP4Config

+
struct NMSettingIP4Config;
+

+

+
+
+
+

NMSettingIP4ConfigClass

+
typedef struct {
+	NMSettingIPConfigClass parent;
+} 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_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. +

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

setting :

the NMSettingIP4Config +

Returns :

the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.
+
+
+
+

Property Details

+
+

The "dhcp-client-id" property

+
  "dhcp-client-id"           gchar*                : Read / Write
+

+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

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingIP6Config.html b/docs/libnm/html/NMSettingIP6Config.html new file mode 100644 index 00000000..c5640b40 --- /dev/null +++ b/docs/libnm/html/NMSettingIP6Config.html @@ -0,0 +1,316 @@ + + + + +NMSettingIP6Config + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingIP6Config

+

NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties

+
+
+

Synopsis

+
#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
+#define             NM_SETTING_IP6_CONFIG_IP6_PRIVACY
+#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;
+struct              NMSettingIP6Config;
+                    NMSettingIP6ConfigClass;
+NMSetting *         nm_setting_ip6_config_new           (void);
+NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
+                                                        (NMSettingIP6Config *setting);
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMSettingIP6ConfigPrivacy
+
+
+  GObject
+   +----NMSetting
+         +----NMSettingIPConfig
+               +----NMSettingIP6Config
+
+
+
+

Properties

+
+  "ip6-privacy"              NMSettingIP6ConfigPrivacy  : Read / Write / Construct
+
+
+
+

Description

+

+The NMSettingIP6Config object is a NMSetting subclass that describes +properties related to IPv6 addressing, routing, and Domain Name Service +

+

+NMSettingIP6Config has few properties or methods of its own; it inherits +almost everything from NMSettingIPConfig. +

+

+NetworkManager supports 6 values for the "method" property +for IPv6. 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. Note: the "shared" method is not yet +supported. +

+
+
+

Details

+
+

NM_SETTING_IP6_CONFIG_SETTING_NAME

+
#define NM_SETTING_IP6_CONFIG_SETTING_NAME "ipv6"
+
+

+

+
+
+
+

NM_SETTING_IP6_CONFIG_IP6_PRIVACY

+
#define NM_SETTING_IP6_CONFIG_IP6_PRIVACY "ip6-privacy"
+
+

+

+
+
+
+

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

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

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR

IPv6 Privacy Extensions +are enabled and temporary addresses are preferred over public addresses +
+
+
+
+

struct NMSettingIP6Config

+
struct NMSettingIP6Config;
+

+

+
+
+
+

NMSettingIP6ConfigClass

+
typedef struct {
+	NMSettingIPConfigClass parent;
+} NMSettingIP6ConfigClass;
+
+

+

+
+
+
+

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_ip6_privacy ()

+
NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
+                                                        (NMSettingIP6Config *setting);
+

+Returns the value contained in the "ip6-privacy" +property. +

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

setting :

the NMSettingIP6Config +

Returns :

IPv6 Privacy Extensions configuration value (NMSettingIP6ConfigPrivacy).
+
+
+
+

Property Details

+
+

The "ip6-privacy" property

+
  "ip6-privacy"              NMSettingIP6ConfigPrivacy  : 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). +

+

Default value: NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingIPConfig.html b/docs/libnm/html/NMSettingIPConfig.html new file mode 100644 index 00000000..413c392a --- /dev/null +++ b/docs/libnm/html/NMSettingIPConfig.html @@ -0,0 +1,2580 @@ + + + + +NMSettingIPConfig + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingIPConfig

+

NMSettingIPConfig — Abstract base class for IPv4 and IPv6 + addressing, routing, and name service properties

+
+
+

Synopsis

+
+#include <nm-setting-ip-config.h>
+
+typedef             NMIPAddress;
+NMIPAddress *       nm_ip_address_new                   (int family,
+                                                         const char *addr,
+                                                         guint prefix,
+                                                         GError **error);
+NMIPAddress *       nm_ip_address_new_binary            (int family,
+                                                         gconstpointer addr,
+                                                         guint prefix,
+                                                         GError **error);
+void                nm_ip_address_ref                   (NMIPAddress *address);
+void                nm_ip_address_unref                 (NMIPAddress *address);
+gboolean            nm_ip_address_equal                 (NMIPAddress *address,
+                                                         NMIPAddress *other);
+NMIPAddress *       nm_ip_address_dup                   (NMIPAddress *address);
+int                 nm_ip_address_get_family            (NMIPAddress *address);
+const char *        nm_ip_address_get_address           (NMIPAddress *address);
+void                nm_ip_address_set_address           (NMIPAddress *address,
+                                                         const char *addr);
+void                nm_ip_address_get_address_binary    (NMIPAddress *address,
+                                                         gpointer addr);
+void                nm_ip_address_set_address_binary    (NMIPAddress *address,
+                                                         gconstpointer addr);
+guint               nm_ip_address_get_prefix            (NMIPAddress *address);
+void                nm_ip_address_set_prefix            (NMIPAddress *address,
+                                                         guint prefix);
+char **             nm_ip_address_get_attribute_names   (NMIPAddress *address);
+GVariant *          nm_ip_address_get_attribute         (NMIPAddress *address,
+                                                         const char *name);
+void                nm_ip_address_set_attribute         (NMIPAddress *address,
+                                                         const char *name,
+                                                         GVariant *value);
+typedef             NMIPRoute;
+NMIPRoute *         nm_ip_route_new                     (int family,
+                                                         const char *dest,
+                                                         guint prefix,
+                                                         const char *next_hop,
+                                                         gint64 metric,
+                                                         GError **error);
+NMIPRoute *         nm_ip_route_new_binary              (int family,
+                                                         gconstpointer dest,
+                                                         guint prefix,
+                                                         gconstpointer next_hop,
+                                                         gint64 metric,
+                                                         GError **error);
+void                nm_ip_route_ref                     (NMIPRoute *route);
+void                nm_ip_route_unref                   (NMIPRoute *route);
+gboolean            nm_ip_route_equal                   (NMIPRoute *route,
+                                                         NMIPRoute *other);
+NMIPRoute *         nm_ip_route_dup                     (NMIPRoute *route);
+int                 nm_ip_route_get_family              (NMIPRoute *route);
+const char *        nm_ip_route_get_dest                (NMIPRoute *route);
+void                nm_ip_route_set_dest                (NMIPRoute *route,
+                                                         const char *dest);
+void                nm_ip_route_get_dest_binary         (NMIPRoute *route,
+                                                         gpointer dest);
+void                nm_ip_route_set_dest_binary         (NMIPRoute *route,
+                                                         gconstpointer dest);
+guint               nm_ip_route_get_prefix              (NMIPRoute *route);
+void                nm_ip_route_set_prefix              (NMIPRoute *route,
+                                                         guint prefix);
+const char *        nm_ip_route_get_next_hop            (NMIPRoute *route);
+void                nm_ip_route_set_next_hop            (NMIPRoute *route,
+                                                         const char *next_hop);
+gboolean            nm_ip_route_get_next_hop_binary     (NMIPRoute *route,
+                                                         gpointer next_hop);
+void                nm_ip_route_set_next_hop_binary     (NMIPRoute *route,
+                                                         gconstpointer next_hop);
+gint64              nm_ip_route_get_metric              (NMIPRoute *route);
+void                nm_ip_route_set_metric              (NMIPRoute *route,
+                                                         gint64 metric);
+char **             nm_ip_route_get_attribute_names     (NMIPRoute *route);
+GVariant *          nm_ip_route_get_attribute           (NMIPRoute *route,
+                                                         const char *name);
+void                nm_ip_route_set_attribute           (NMIPRoute *route,
+                                                         const char *name,
+                                                         GVariant *value);
+#define             NM_SETTING_IP_CONFIG_METHOD
+#define             NM_SETTING_IP_CONFIG_DNS
+#define             NM_SETTING_IP_CONFIG_DNS_SEARCH
+#define             NM_SETTING_IP_CONFIG_ADDRESSES
+#define             NM_SETTING_IP_CONFIG_GATEWAY
+#define             NM_SETTING_IP_CONFIG_ROUTES
+#define             NM_SETTING_IP_CONFIG_ROUTE_METRIC
+#define             NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES
+#define             NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS
+#define             NM_SETTING_IP_CONFIG_DHCP_HOSTNAME
+#define             NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME
+#define             NM_SETTING_IP_CONFIG_NEVER_DEFAULT
+#define             NM_SETTING_IP_CONFIG_MAY_FAIL
+struct              NMSettingIPConfig;
+                    NMSettingIPConfigClass;
+const char *        nm_setting_ip_config_get_method     (NMSettingIPConfig *setting);
+guint               nm_setting_ip_config_get_num_dns    (NMSettingIPConfig *setting);
+const char *        nm_setting_ip_config_get_dns        (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_add_dns        (NMSettingIPConfig *setting,
+                                                         const char *dns);
+void                nm_setting_ip_config_remove_dns     (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_remove_dns_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         const char *dns);
+void                nm_setting_ip_config_clear_dns      (NMSettingIPConfig *setting);
+guint               nm_setting_ip_config_get_num_dns_searches
+                                                        (NMSettingIPConfig *setting);
+const char *        nm_setting_ip_config_get_dns_search (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_add_dns_search (NMSettingIPConfig *setting,
+                                                         const char *dns_search);
+void                nm_setting_ip_config_remove_dns_search
+                                                        (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_remove_dns_search_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         const char *dns_search);
+void                nm_setting_ip_config_clear_dns_searches
+                                                        (NMSettingIPConfig *setting);
+guint               nm_setting_ip_config_get_num_addresses
+                                                        (NMSettingIPConfig *setting);
+NMIPAddress *       nm_setting_ip_config_get_address    (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_add_address    (NMSettingIPConfig *setting,
+                                                         NMIPAddress *address);
+void                nm_setting_ip_config_remove_address (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_remove_address_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         NMIPAddress *address);
+void                nm_setting_ip_config_clear_addresses
+                                                        (NMSettingIPConfig *setting);
+const char *        nm_setting_ip_config_get_gateway    (NMSettingIPConfig *setting);
+guint               nm_setting_ip_config_get_num_routes (NMSettingIPConfig *setting);
+NMIPRoute *         nm_setting_ip_config_get_route      (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_add_route      (NMSettingIPConfig *setting,
+                                                         NMIPRoute *route);
+void                nm_setting_ip_config_remove_route   (NMSettingIPConfig *setting,
+                                                         int i);
+gboolean            nm_setting_ip_config_remove_route_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         NMIPRoute *route);
+void                nm_setting_ip_config_clear_routes   (NMSettingIPConfig *setting);
+gint64              nm_setting_ip_config_get_route_metric
+                                                        (NMSettingIPConfig *setting);
+gboolean            nm_setting_ip_config_get_ignore_auto_routes
+                                                        (NMSettingIPConfig *setting);
+gboolean            nm_setting_ip_config_get_ignore_auto_dns
+                                                        (NMSettingIPConfig *setting);
+const char *        nm_setting_ip_config_get_dhcp_hostname
+                                                        (NMSettingIPConfig *setting);
+gboolean            nm_setting_ip_config_get_dhcp_send_hostname
+                                                        (NMSettingIPConfig *setting);
+gboolean            nm_setting_ip_config_get_never_default
+                                                        (NMSettingIPConfig *setting);
+gboolean            nm_setting_ip_config_get_may_fail   (NMSettingIPConfig *setting);
+
+
+
+

Object Hierarchy

+
+  GBoxed
+   +----NMIPAddress
+
+
+  GBoxed
+   +----NMIPRoute
+
+
+  GObject
+   +----NMSetting
+         +----NMSettingIPConfig
+               +----NMSettingIP4Config
+               +----NMSettingIP6Config
+
+
+
+

Properties

+
+  "addresses"                GPtrArray*            : Read / Write
+  "dhcp-hostname"            gchar*                : Read / Write
+  "dhcp-send-hostname"       gboolean              : Read / Write / Construct
+  "dns"                      GStrv                 : Read / Write
+  "dns-search"               GStrv                 : Read / Write
+  "gateway"                  gchar*                : 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
+  "route-metric"             gint64                : Read / Write / Construct
+  "routes"                   GPtrArray*            : Read / Write
+
+
+
+

Description

+

+NMSettingIPConfig is the abstract base class of +NMSettingIP4Config and NMSettingIP6Config, providing properties +related to IP addressing, routing, and Domain Name Service. +

+
+
+

Details

+
+

NMIPAddress

+
typedef struct NMIPAddress NMIPAddress;
+
+

+

+
+
+
+

nm_ip_address_new ()

+
NMIPAddress *       nm_ip_address_new                   (int family,
+                                                         const char *addr,
+                                                         guint prefix,
+                                                         GError **error);
+

+Creates a new NMIPAddress object. +

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

family :

the IP address family (AF_INET or +AF_INET6)

addr :

the IP address

prefix :

the address prefix length

error :

location to store error, or NULL +

Returns :

the new NMIPAddress object, or NULL on error. [transfer full] +
+
+
+
+

nm_ip_address_new_binary ()

+
NMIPAddress *       nm_ip_address_new_binary            (int family,
+                                                         gconstpointer addr,
+                                                         guint prefix,
+                                                         GError **error);
+

+Creates a new NMIPAddress object. addr must point to a buffer of the +correct size for family. +

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

family :

the IP address family (AF_INET or +AF_INET6)

addr :

the IP address

prefix :

the address prefix length

error :

location to store error, or NULL +

Returns :

the new NMIPAddress object, or NULL on error. [transfer full] +
+
+
+
+

nm_ip_address_ref ()

+
void                nm_ip_address_ref                   (NMIPAddress *address);
+

+Increases the reference count of the object. +

+
++++ + + + + +

address :

the NMIPAddress +
+
+
+
+

nm_ip_address_unref ()

+
void                nm_ip_address_unref                 (NMIPAddress *address);
+

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed. +

+
++++ + + + + +

address :

the NMIPAddress +
+
+
+
+

nm_ip_address_equal ()

+
gboolean            nm_ip_address_equal                 (NMIPAddress *address,
+                                                         NMIPAddress *other);
+

+Determines if two NMIPAddress objects contain the same address and prefix +(attributes are not compared). +

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

address :

the NMIPAddress +

other :

the NMIPAddress to compare address to.

Returns :

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

nm_ip_address_dup ()

+
NMIPAddress *       nm_ip_address_dup                   (NMIPAddress *address);
+

+Creates a copy of address +

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

address :

the NMIPAddress +

Returns :

a copy of address. [transfer full] +
+
+
+
+

nm_ip_address_get_family ()

+
int                 nm_ip_address_get_family            (NMIPAddress *address);
+

+Gets the IP address family (eg, AF_INET) property of this address +object. +

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

address :

the NMIPAddress +

Returns :

the IP address family
+
+
+
+

nm_ip_address_get_address ()

+
const char *        nm_ip_address_get_address           (NMIPAddress *address);
+

+Gets the IP address property of this address object. +

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

address :

the NMIPAddress +

Returns :

the IP address
+
+
+
+

nm_ip_address_set_address ()

+
void                nm_ip_address_set_address           (NMIPAddress *address,
+                                                         const char *addr);
+

+Sets the IP address property of this address object. +

+

+addr must be a valid address of address's family. If you aren't sure you +have a valid address, use nm_utils_ipaddr_valid() to check it. +

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

address :

the NMIPAddress +

addr :

the IP address, as a string
+
+
+
+

nm_ip_address_get_address_binary ()

+
void                nm_ip_address_get_address_binary    (NMIPAddress *address,
+                                                         gpointer addr);
+

+Gets the IP address property of this address object. +

+

+addr must point to a buffer that is the correct size for address's family. +

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

address :

the NMIPAddress +

addr :

a buffer in which to store the address in binary format.
+
+
+
+

nm_ip_address_set_address_binary ()

+
void                nm_ip_address_set_address_binary    (NMIPAddress *address,
+                                                         gconstpointer addr);
+

+Sets the IP address property of this address object. +

+

+addr must point to a buffer that is the correct size for address's family. +

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

address :

the NMIPAddress +

addr :

the address, in binary format
+
+
+
+

nm_ip_address_get_prefix ()

+
guint               nm_ip_address_get_prefix            (NMIPAddress *address);
+

+Gets the IP address prefix (ie "24" or "30" etc) property of this address +object. +

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

address :

the NMIPAddress +

Returns :

the IP address prefix
+
+
+
+

nm_ip_address_set_prefix ()

+
void                nm_ip_address_set_prefix            (NMIPAddress *address,
+                                                         guint prefix);
+

+Sets the IP address prefix property of this address object. +

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

address :

the NMIPAddress +

prefix :

the IP address prefix
+
+
+
+

nm_ip_address_get_attribute_names ()

+
char **             nm_ip_address_get_attribute_names   (NMIPAddress *address);
+

+Gets an array of attribute names defined on address. +

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

address :

the NMIPAddress +

Returns :

a NULL-terminated array of attribute names,. [transfer full] +
+
+
+
+

nm_ip_address_get_attribute ()

+
GVariant *          nm_ip_address_get_attribute         (NMIPAddress *address,
+                                                         const char *name);
+

+Gets the value of the attribute with name name on address +

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

address :

the NMIPAddress +

name :

the name of an address attribute

Returns :

the value of the attribute with name name on +address, or NULL if address has no such attribute. [transfer none] +
+
+
+
+

nm_ip_address_set_attribute ()

+
void                nm_ip_address_set_attribute         (NMIPAddress *address,
+                                                         const char *name,
+                                                         GVariant *value);
+

+Sets or clears the named attribute on address to the given value. +

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

address :

the NMIPAddress +

name :

the name of an address attribute

value :

the value. [transfer none][allow-none] +
+
+
+
+

NMIPRoute

+
typedef struct NMIPRoute NMIPRoute;
+
+

+

+
+
+
+

nm_ip_route_new ()

+
NMIPRoute *         nm_ip_route_new                     (int family,
+                                                         const char *dest,
+                                                         guint prefix,
+                                                         const char *next_hop,
+                                                         gint64 metric,
+                                                         GError **error);
+

+Creates a new NMIPRoute object. +

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

family :

the IP address family (AF_INET or +AF_INET6)

dest :

the IP address of the route's destination

prefix :

the address prefix length

next_hop :

the IP address of the next hop (or NULL). [allow-none] +

metric :

the route metric (or -1 for "default")

error :

location to store error, or NULL +

Returns :

the new NMIPRoute object, or NULL on error. [transfer full] +
+
+
+
+

nm_ip_route_new_binary ()

+
NMIPRoute *         nm_ip_route_new_binary              (int family,
+                                                         gconstpointer dest,
+                                                         guint prefix,
+                                                         gconstpointer next_hop,
+                                                         gint64 metric,
+                                                         GError **error);
+

+Creates a new NMIPRoute object. dest and next_hop (if non-NULL) must +point to buffers of the correct size for family. +

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

family :

the IP address family (AF_INET or +AF_INET6)

dest :

the IP address of the route's destination

prefix :

the address prefix length

next_hop :

the IP address of the next hop (or NULL). [allow-none] +

metric :

the route metric (or -1 for "default")

error :

location to store error, or NULL +

Returns :

the new NMIPRoute object, or NULL on error. [transfer full] +
+
+
+
+

nm_ip_route_ref ()

+
void                nm_ip_route_ref                     (NMIPRoute *route);
+

+Increases the reference count of the object. +

+
++++ + + + + +

route :

the NMIPRoute +
+
+
+
+

nm_ip_route_unref ()

+
void                nm_ip_route_unref                   (NMIPRoute *route);
+

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed. +

+
++++ + + + + +

route :

the NMIPRoute +
+
+
+
+

nm_ip_route_equal ()

+
gboolean            nm_ip_route_equal                   (NMIPRoute *route,
+                                                         NMIPRoute *other);
+

+Determines if two NMIPRoute objects contain the same destination, prefix, +next hop, and metric. (Attributes are not compared.) +

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

route :

the NMIPRoute +

other :

the NMIPRoute to compare route to.

Returns :

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

nm_ip_route_dup ()

+
NMIPRoute *         nm_ip_route_dup                     (NMIPRoute *route);
+

+Creates a copy of route +

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

route :

the NMIPRoute +

Returns :

a copy of route. [transfer full] +
+
+
+
+

nm_ip_route_get_family ()

+
int                 nm_ip_route_get_family              (NMIPRoute *route);
+

+Gets the IP address family (eg, AF_INET) property of this route +object. +

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

route :

the NMIPRoute +

Returns :

the IP address family
+
+
+
+

nm_ip_route_get_dest ()

+
const char *        nm_ip_route_get_dest                (NMIPRoute *route);
+

+Gets the IP destination address property of this route object. +

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

route :

the NMIPRoute +

Returns :

the IP address of the route's destination
+
+
+
+

nm_ip_route_set_dest ()

+
void                nm_ip_route_set_dest                (NMIPRoute *route,
+                                                         const char *dest);
+

+Sets the destination property of this route object. +

+

+dest must be a valid address of route's family. If you aren't sure you +have a valid address, use nm_utils_ipaddr_valid() to check it. +

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

route :

the NMIPRoute +

dest :

the route's destination, as a string
+
+
+
+

nm_ip_route_get_dest_binary ()

+
void                nm_ip_route_get_dest_binary         (NMIPRoute *route,
+                                                         gpointer dest);
+

+Gets the destination property of this route object. +

+

+dest must point to a buffer that is the correct size for route's family. +

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

route :

the NMIPRoute +

dest :

a buffer in which to store the destination in binary format.
+
+
+
+

nm_ip_route_set_dest_binary ()

+
void                nm_ip_route_set_dest_binary         (NMIPRoute *route,
+                                                         gconstpointer dest);
+

+Sets the destination property of this route object. +

+

+dest must point to a buffer that is the correct size for route's family. +

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

route :

the NMIPRoute +

dest :

the route's destination, in binary format
+
+
+
+

nm_ip_route_get_prefix ()

+
guint               nm_ip_route_get_prefix              (NMIPRoute *route);
+

+Gets the IP prefix (ie "24" or "30" etc) of this route. +

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

route :

the NMIPRoute +

Returns :

the IP prefix
+
+
+
+

nm_ip_route_set_prefix ()

+
void                nm_ip_route_set_prefix              (NMIPRoute *route,
+                                                         guint prefix);
+

+Sets the prefix property of this route object. +

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

route :

the NMIPRoute +

prefix :

the route prefix
+
+
+
+

nm_ip_route_get_next_hop ()

+
const char *        nm_ip_route_get_next_hop            (NMIPRoute *route);
+

+Gets the IP address of the next hop of this route; this will be NULL if the +route has no next hop. +

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

route :

the NMIPRoute +

Returns :

the IP address of the next hop, or NULL if this is a device route.
+
+
+
+

nm_ip_route_set_next_hop ()

+
void                nm_ip_route_set_next_hop            (NMIPRoute *route,
+                                                         const char *next_hop);
+

+Sets the next-hop property of this route object. +

+

+next_hop (if non-NULL) must be a valid address of route's family. If you +aren't sure you have a valid address, use nm_utils_ipaddr_valid() to check +it. +

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

route :

the NMIPRoute +

next_hop :

the route's next hop, as a string. [allow-none] +
+
+
+
+

nm_ip_route_get_next_hop_binary ()

+
gboolean            nm_ip_route_get_next_hop_binary     (NMIPRoute *route,
+                                                         gpointer next_hop);
+

+Gets the next hop property of this route object. +

+

+next_hop must point to a buffer that is the correct size for route's family. +

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

route :

the NMIPRoute +

next_hop :

a buffer in which to store the next hop in binary format.

Returns :

 +TRUE if route has a next hop, FALSE if not (in which case +next_hop will be zeroed out)
+
+
+
+

nm_ip_route_set_next_hop_binary ()

+
void                nm_ip_route_set_next_hop_binary     (NMIPRoute *route,
+                                                         gconstpointer next_hop);
+

+Sets the destination property of this route object. +

+

+next_hop (if non-NULL) must point to a buffer that is the correct size for +route's family. +

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

route :

the NMIPRoute +

next_hop :

the route's next hop, in binary format
+
+
+
+

nm_ip_route_get_metric ()

+
gint64              nm_ip_route_get_metric              (NMIPRoute *route);
+

+Gets the route metric property of this route object; lower values +indicate "better" or more preferred routes; -1 indicates "default" +(meaning NetworkManager will set it appropriately). +

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

route :

the NMIPRoute +

Returns :

the route metric
+
+
+
+

nm_ip_route_set_metric ()

+
void                nm_ip_route_set_metric              (NMIPRoute *route,
+                                                         gint64 metric);
+

+Sets the metric property of this route object. +

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

route :

the NMIPRoute +

metric :

the route metric (or -1 for "default")
+
+
+
+

nm_ip_route_get_attribute_names ()

+
char **             nm_ip_route_get_attribute_names     (NMIPRoute *route);
+

+Gets an array of attribute names defined on route. +

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

route :

the NMIPRoute +

Returns :

a NULL-terminated array of attribute names. [transfer full] +
+
+
+
+

nm_ip_route_get_attribute ()

+
GVariant *          nm_ip_route_get_attribute           (NMIPRoute *route,
+                                                         const char *name);
+

+Gets the value of the attribute with name name on route +

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

route :

the NMIPRoute +

name :

the name of an route attribute

Returns :

the value of the attribute with name name on +route, or NULL if route has no such attribute. [transfer none] +
+
+
+
+

nm_ip_route_set_attribute ()

+
void                nm_ip_route_set_attribute           (NMIPRoute *route,
+                                                         const char *name,
+                                                         GVariant *value);
+

+Sets the named attribute on route to the given value. +

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

route :

the NMIPRoute +

name :

the name of a route attribute

value :

the value. [transfer none][allow-none] +
+
+
+
+

NM_SETTING_IP_CONFIG_METHOD

+
#define NM_SETTING_IP_CONFIG_METHOD             "method"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_DNS

+
#define NM_SETTING_IP_CONFIG_DNS                "dns"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_DNS_SEARCH

+
#define NM_SETTING_IP_CONFIG_DNS_SEARCH         "dns-search"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_ADDRESSES

+
#define NM_SETTING_IP_CONFIG_ADDRESSES          "addresses"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_GATEWAY

+
#define NM_SETTING_IP_CONFIG_GATEWAY            "gateway"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_ROUTES

+
#define NM_SETTING_IP_CONFIG_ROUTES             "routes"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_ROUTE_METRIC

+
#define NM_SETTING_IP_CONFIG_ROUTE_METRIC       "route-metric"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES

+
#define NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS

+
#define NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_DHCP_HOSTNAME

+
#define NM_SETTING_IP_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME

+
#define NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_NEVER_DEFAULT

+
#define NM_SETTING_IP_CONFIG_NEVER_DEFAULT      "never-default"
+
+

+

+
+
+
+

NM_SETTING_IP_CONFIG_MAY_FAIL

+
#define NM_SETTING_IP_CONFIG_MAY_FAIL           "may-fail"
+
+

+

+
+
+
+

struct NMSettingIPConfig

+
struct NMSettingIPConfig;
+

+

+
+
+
+

NMSettingIPConfigClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	gpointer padding[8];
+} NMSettingIPConfigClass;
+
+

+

+
+
+
+

nm_setting_ip_config_get_method ()

+
const char *        nm_setting_ip_config_get_method     (NMSettingIPConfig *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingIPConfig +

Returns :

the "method" property of the setting; see +NMSettingIP4Config and NMSettingIP6Config for details of the +methods available with each type.
+
+
+
+

nm_setting_ip_config_get_num_dns ()

+
guint               nm_setting_ip_config_get_num_dns    (NMSettingIPConfig *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingIPConfig +

Returns :

the number of configured DNS servers
+
+
+
+

nm_setting_ip_config_get_dns ()

+
const char *        nm_setting_ip_config_get_dns        (NMSettingIPConfig *setting,
+                                                         int i);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingIPConfig +

i :

index number of the DNS server to return

Returns :

the IP address of the DNS server at index i +
+
+
+
+

nm_setting_ip_config_add_dns ()

+
gboolean            nm_setting_ip_config_add_dns        (NMSettingIPConfig *setting,
+                                                         const char *dns);
+

+Adds a new DNS server to the setting. +

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

setting :

the NMSettingIPConfig +

dns :

the IP address of the DNS server to add

Returns :

 +TRUE if the DNS server was added; FALSE if the server was already +known
+
+
+
+

nm_setting_ip_config_remove_dns ()

+
void                nm_setting_ip_config_remove_dns     (NMSettingIPConfig *setting,
+                                                         int i);
+

+Removes the DNS server at index i. +

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

setting :

the NMSettingIPConfig +

i :

index number of the DNS server to remove
+
+
+
+

nm_setting_ip_config_remove_dns_by_value ()

+
gboolean            nm_setting_ip_config_remove_dns_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         const char *dns);
+

+Removes the DNS server dns. +

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

setting :

the NMSettingIPConfig +

dns :

the DNS server to remove

Returns :

 +TRUE if the DNS server was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_ip_config_clear_dns ()

+
void                nm_setting_ip_config_clear_dns      (NMSettingIPConfig *setting);
+

+Removes all configured DNS servers. +

+
++++ + + + + +

setting :

the NMSettingIPConfig +
+
+
+
+

nm_setting_ip_config_get_num_dns_searches ()

+
guint               nm_setting_ip_config_get_num_dns_searches
+                                                        (NMSettingIPConfig *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingIPConfig +

Returns :

the number of configured DNS search domains
+
+
+
+

nm_setting_ip_config_get_dns_search ()

+
const char *        nm_setting_ip_config_get_dns_search (NMSettingIPConfig *setting,
+                                                         int i);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingIPConfig +

i :

index number of the DNS search domain to return

Returns :

the DNS search domain at index i +
+
+
+
+

nm_setting_ip_config_add_dns_search ()

+
gboolean            nm_setting_ip_config_add_dns_search (NMSettingIPConfig *setting,
+                                                         const char *dns_search);
+

+Adds a new DNS search domain to the setting. +

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

setting :

the NMSettingIPConfig +

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_ip_config_remove_dns_search ()

+
void                nm_setting_ip_config_remove_dns_search
+                                                        (NMSettingIPConfig *setting,
+                                                         int i);
+

+Removes the DNS search domain at index i. +

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

setting :

the NMSettingIPConfig +

i :

index number of the DNS search domain
+
+
+
+

nm_setting_ip_config_remove_dns_search_by_value ()

+
gboolean            nm_setting_ip_config_remove_dns_search_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         const char *dns_search);
+

+Removes the DNS search domain dns_search. +

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

setting :

the NMSettingIPConfig +

dns_search :

the search domain to remove

Returns :

 +TRUE if the DNS search domain was found and removed; FALSE if it was not. +Since 0.9.10
+
+
+
+

nm_setting_ip_config_clear_dns_searches ()

+
void                nm_setting_ip_config_clear_dns_searches
+                                                        (NMSettingIPConfig *setting);
+

+Removes all configured DNS search domains. +

+
++++ + + + + +

setting :

the NMSettingIPConfig +
+
+
+
+

nm_setting_ip_config_get_num_addresses ()

+
guint               nm_setting_ip_config_get_num_addresses
+                                                        (NMSettingIPConfig *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingIPConfig +

Returns :

the number of configured addresses
+
+
+
+

nm_setting_ip_config_get_address ()

+
NMIPAddress *       nm_setting_ip_config_get_address    (NMSettingIPConfig *setting,
+                                                         int i);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingIPConfig +

i :

index number of the address to return

Returns :

the address at index i +
+
+
+
+

nm_setting_ip_config_add_address ()

+
gboolean            nm_setting_ip_config_add_address    (NMSettingIPConfig *setting,
+                                                         NMIPAddress *address);
+

+Adds a new IP address and associated information to the setting. The +given address is duplicated internally and is not changed by this function. +

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

setting :

the NMSettingIPConfig +

address :

the new address to add

Returns :

 +TRUE if the address was added; FALSE if the address was already +known.
+
+
+
+

nm_setting_ip_config_remove_address ()

+
void                nm_setting_ip_config_remove_address (NMSettingIPConfig *setting,
+                                                         int i);
+

+Removes the address at index i. +

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

setting :

the NMSettingIPConfig +

i :

index number of the address to remove
+
+
+
+

nm_setting_ip_config_remove_address_by_value ()

+
gboolean            nm_setting_ip_config_remove_address_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         NMIPAddress *address);
+

+Removes the address address. +

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

setting :

the NMSettingIPConfig +

address :

the IP address to remove

Returns :

 +TRUE if the address was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_ip_config_clear_addresses ()

+
void                nm_setting_ip_config_clear_addresses
+                                                        (NMSettingIPConfig *setting);
+

+Removes all configured addresses. +

+
++++ + + + + +

setting :

the NMSettingIPConfig +
+
+
+
+

nm_setting_ip_config_get_gateway ()

+
const char *        nm_setting_ip_config_get_gateway    (NMSettingIPConfig *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingIPConfig +

Returns :

the IP address of the gateway associated with this configuration, or +NULL.
+
+
+
+

nm_setting_ip_config_get_num_routes ()

+
guint               nm_setting_ip_config_get_num_routes (NMSettingIPConfig *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingIPConfig +

Returns :

the number of configured routes
+
+
+
+

nm_setting_ip_config_get_route ()

+
NMIPRoute *         nm_setting_ip_config_get_route      (NMSettingIPConfig *setting,
+                                                         int i);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingIPConfig +

i :

index number of the route to return

Returns :

the route at index i +
+
+
+
+

nm_setting_ip_config_add_route ()

+
gboolean            nm_setting_ip_config_add_route      (NMSettingIPConfig *setting,
+                                                         NMIPRoute *route);
+

+Adds a new route and associated information to the setting. The +given route is duplicated internally and is not changed by this function. +

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

setting :

the NMSettingIPConfig +

route :

the route to add

Returns :

 +TRUE if the route was added; FALSE if the route was already known.
+
+
+
+

nm_setting_ip_config_remove_route ()

+
void                nm_setting_ip_config_remove_route   (NMSettingIPConfig *setting,
+                                                         int i);
+

+Removes the route at index i. +

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

setting :

the NMSettingIPConfig +

i :

index number of the route
+
+
+
+

nm_setting_ip_config_remove_route_by_value ()

+
gboolean            nm_setting_ip_config_remove_route_by_value
+                                                        (NMSettingIPConfig *setting,
+                                                         NMIPRoute *route);
+

+Removes the route route. +

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

setting :

the NMSettingIPConfig +

route :

the route to remove

Returns :

 +TRUE if the route was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_ip_config_clear_routes ()

+
void                nm_setting_ip_config_clear_routes   (NMSettingIPConfig *setting);
+

+Removes all configured routes. +

+
++++ + + + + +

setting :

the NMSettingIPConfig +
+
+
+
+

nm_setting_ip_config_get_route_metric ()

+
gint64              nm_setting_ip_config_get_route_metric
+                                                        (NMSettingIPConfig *setting);
+

+Returns the value contained in the "route-metric" +property. +

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

setting :

the NMSettingIPConfig +

Returns :

the route metric that is used for routes that don't explicitly +specify a metric. See "route-metric" for more details.
+
+
+
+

nm_setting_ip_config_get_ignore_auto_routes ()

+
gboolean            nm_setting_ip_config_get_ignore_auto_routes
+                                                        (NMSettingIPConfig *setting);
+

+Returns the value contained in the "ignore-auto-routes" +property. +

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

setting :

the NMSettingIPConfig +

Returns :

 +TRUE if automatically configured (ie via DHCP) routes should be +ignored.
+
+
+
+

nm_setting_ip_config_get_ignore_auto_dns ()

+
gboolean            nm_setting_ip_config_get_ignore_auto_dns
+                                                        (NMSettingIPConfig *setting);
+

+Returns the value contained in the "ignore-auto-dns" +property. +

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

setting :

the NMSettingIPConfig +

Returns :

 +TRUE if automatically configured (ie via DHCP) DNS information +should be ignored.
+
+
+
+

nm_setting_ip_config_get_dhcp_hostname ()

+
const char *        nm_setting_ip_config_get_dhcp_hostname
+                                                        (NMSettingIPConfig *setting);
+

+Returns the value contained in the "dhcp-hostname" +property. +

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

setting :

the NMSettingIPConfig +

Returns :

the configured hostname to send to the DHCP server
+
+
+
+

nm_setting_ip_config_get_dhcp_send_hostname ()

+
gboolean            nm_setting_ip_config_get_dhcp_send_hostname
+                                                        (NMSettingIPConfig *setting);
+

+Returns the value contained in the "dhcp-send-hostname" +property. +

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

setting :

the NMSettingIPConfig +

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_ip_config_get_never_default ()

+
gboolean            nm_setting_ip_config_get_never_default
+                                                        (NMSettingIPConfig *setting);
+

+Returns the value contained in the "never-default" +property. +

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

setting :

the NMSettingIPConfig +

Returns :

 +TRUE if this connection should never be the default +connection
+
+
+
+

nm_setting_ip_config_get_may_fail ()

+
gboolean            nm_setting_ip_config_get_may_fail   (NMSettingIPConfig *setting);
+

+Returns the value contained in the "may-fail" +property. +

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

setting :

the NMSettingIPConfig +

Returns :

 +TRUE if this connection doesn't require this type of IP +addressing to complete for the connection to succeed.
+
+
+
+

Property Details

+
+

The "addresses" property

+
  "addresses"                GPtrArray*            : Read / Write
+

+Array of IP addresses. +

+

+Element-Type: NMIPAddress +

+
+
+
+

The "dhcp-hostname" property

+
  "dhcp-hostname"            gchar*                : Read / Write
+

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

+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 NULL and this property is +TRUE, the current persistent hostname of the computer is sent. +

+

Default value: TRUE

+
+
+
+

The "dns" property

+
  "dns"                      GStrv                 : Read / Write
+

+Array of IP addresses of DNS servers. +

+
+
+
+

The "dns-search" property

+
  "dns-search"               GStrv                 : Read / Write
+

+Array of DNS search domains. +

+
+
+
+

The "gateway" property

+
  "gateway"                  gchar*                : Read / Write
+

+The gateway associated with this configuration. This is only meaningful +if "addresses" is also set. +

+

Default value: NULL

+
+
+
+

The "ignore-auto-dns" property

+
  "ignore-auto-dns"          gboolean              : Read / Write / Construct
+

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

+

Default value: FALSE

+
+
+
+

The "ignore-auto-routes" property

+
  "ignore-auto-routes"       gboolean              : Read / Write / Construct
+

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

+

Default value: FALSE

+
+
+
+

The "may-fail" property

+
  "may-fail"                 gboolean              : Read / Write / Construct
+

+If TRUE, allow overall network configuration to proceed even if the +configuration specified by this property 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 on the NMSettingIP4Config 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
+

+IP configuration method. +

+

+NMSettingIP4Config and NMSettingIP6Config both support "auto", +"manual", and "link-local". See the subclass-specific documentation for +other values. +

+

+In general, for the "auto" method, properties such as +"dns" and "routes" specify information +that is added on to the information returned from automatic +configuration. The "ignore-auto-routes" and +"ignore-auto-dns" properties modify this behavior. +

+

+For methods that imply no upstream network, such as "shared" or +"link-local", these properties must be empty. +

+

Default value: NULL

+
+
+
+

The "never-default" property

+
  "never-default"            gboolean              : Read / Write / Construct
+

+If TRUE, this connection will never be the default connection for this +IP type, meaning it will never be assigned the default route by +NetworkManager. +

+

Default value: FALSE

+
+
+
+

The "route-metric" property

+
  "route-metric"             gint64                : Read / Write / Construct
+

+The default metric for routes that don't explicitly specify a metric. +The default value -1 means that the metric is choosen automatically +based on the device type. +The metric applies to dynamic routes, manual (static) routes that +don't have an explicit metric setting, address prefix routes, and +the default route. +Note that for IPv6, the kernel accepts zero (0) but coerces it to +1024 (user default). Hence, setting this property to zero effectively +mean setting it to 1024. +For IPv4, zero is a regular value for the metric. +

+

Allowed values: [-1,4294967295]

+

Default value: -1

+
+
+
+

The "routes" property

+
  "routes"                   GPtrArray*            : Read / Write
+

+Array of IP routes. +

+

+Element-Type: NMIPRoute +

+
+
+
+

See Also

+NMSettingIP4Config, NMSettingIP6Config +
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingInfiniband.html b/docs/libnm/html/NMSettingInfiniband.html new file mode 100644 index 00000000..42a8063c --- /dev/null +++ b/docs/libnm/html/NMSettingInfiniband.html @@ -0,0 +1,391 @@ + + + + +NMSettingInfiniband + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingInfiniband

+

NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks

+
+
+

Synopsis

+
#define             NM_SETTING_INFINIBAND_SETTING_NAME
+#define             NM_SETTING_INFINIBAND_MAC_ADDRESS
+#define             NM_SETTING_INFINIBAND_MTU
+#define             NM_SETTING_INFINIBAND_TRANSPORT_MODE
+#define             NM_SETTING_INFINIBAND_P_KEY
+#define             NM_SETTING_INFINIBAND_PARENT
+struct              NMSettingInfiniband;
+                    NMSettingInfinibandClass;
+NMSetting *         nm_setting_infiniband_new           (void);
+const char *        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);
+int                 nm_setting_infiniband_get_p_key     (NMSettingInfiniband *setting);
+const char *        nm_setting_infiniband_get_parent    (NMSettingInfiniband *setting);
+const char *        nm_setting_infiniband_get_virtual_interface_name
+                                                        (NMSettingInfiniband *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingInfiniband
+
+
+
+

Properties

+
+  "mac-address"              gchar*                : Read / Write
+  "mtu"                      guint                 : Read / Write / Construct
+  "p-key"                    gint                  : Read / Write / Construct
+  "parent"                   gchar*                : 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"
+
+

+

+
+
+
+

NM_SETTING_INFINIBAND_MAC_ADDRESS

+
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
+
+

+

+
+
+
+

NM_SETTING_INFINIBAND_MTU

+
#define NM_SETTING_INFINIBAND_MTU            "mtu"
+
+

+

+
+
+
+

NM_SETTING_INFINIBAND_TRANSPORT_MODE

+
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
+
+

+

+
+
+
+

NM_SETTING_INFINIBAND_P_KEY

+
#define NM_SETTING_INFINIBAND_P_KEY          "p-key"
+
+

+

+
+
+
+

NM_SETTING_INFINIBAND_PARENT

+
#define NM_SETTING_INFINIBAND_PARENT         "parent"
+
+

+

+
+
+
+

struct NMSettingInfiniband

+
struct NMSettingInfiniband;
+

+

+
+
+
+

NMSettingInfinibandClass

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

+
const char *        nm_setting_infiniband_get_mac_address
+                                                        (NMSettingInfiniband *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingInfiniband +

Returns :

the "mac-address" property of the setting
+
+
+
+

nm_setting_infiniband_get_mtu ()

+
guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingInfiniband +

Returns :

the "mtu" property of the 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'. +

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

setting :

the NMSettingInfiniband +

Returns :

the IPoIB transport mode
+
+
+
+

nm_setting_infiniband_get_p_key ()

+
int                 nm_setting_infiniband_get_p_key     (NMSettingInfiniband *setting);
+

+Returns the P_Key to use for this device. A value of -1 means to +use the default P_Key (aka "the P_Key at index 0"). Otherwise it is +a 16-bit unsigned integer. +

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

setting :

the NMSettingInfiniband +

Returns :

the IPoIB P_Key
+
+
+
+

nm_setting_infiniband_get_parent ()

+
const char *        nm_setting_infiniband_get_parent    (NMSettingInfiniband *setting);
+

+Returns the parent interface name for this device, if set. +

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

setting :

the NMSettingInfiniband +

Returns :

the parent interface name
+
+
+
+

nm_setting_infiniband_get_virtual_interface_name ()

+
const char *        nm_setting_infiniband_get_virtual_interface_name
+                                                        (NMSettingInfiniband *setting);
+

+Returns the interface name created by combining "parent" +and "p-key". (If either property is unset, this will +return NULL.) +

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

setting :

the NMSettingInfiniband +

Returns :

the interface name, or NULL +
+
+
+
+

Property Details

+
+

The "mac-address" property

+
  "mac-address"              gchar*                : Read / Write
+

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

+

Default value: NULL

+
+
+
+

The "mtu" property

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

+If non-zero, only transmit packets of the specified size or smaller, +breaking larger packets up into multiple frames. +

+

Default value: 0

+
+
+
+

The "p-key" property

+
  "p-key"                    gint                  : Read / Write / Construct
+

+The InfiniBand P_Key to use for this device. A value of -1 means to use +the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit +unsigned integer, whose high bit is set if it is a "full membership" +P_Key. +

+

Allowed values: [-1,65535]

+

Default value: -1

+
+
+
+

The "parent" property

+
  "parent"                   gchar*                : Read / Write / Construct
+

+The interface name of the parent device of this device. Normally NULL, +but if the "p_key" property is set, then you must +specify the base device by setting either this property or +"mac-address". +

+

Default value: NULL

+
+
+
+

The "transport-mode" property

+
  "transport-mode"           gchar*                : Read / Write / Construct
+

+The IP-over-InfiniBand transport mode. Either "datagram" or +"connected". +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingOlpcMesh.html b/docs/libnm/html/NMSettingOlpcMesh.html new file mode 100644 index 00000000..0c3eb7bb --- /dev/null +++ b/docs/libnm/html/NMSettingOlpcMesh.html @@ -0,0 +1,213 @@ + + + + +NMSettingOlpcMesh + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingOlpcMesh

+

NMSettingOlpcMesh

+
+
+

Synopsis

+
#define             NM_SETTING_OLPC_MESH_SETTING_NAME
+#define             NM_SETTING_OLPC_MESH_SSID
+#define             NM_SETTING_OLPC_MESH_CHANNEL
+#define             NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS
+struct              NMSettingOlpcMesh;
+                    NMSettingOlpcMeshClass;
+NMSetting *         nm_setting_olpc_mesh_new            (void);
+GBytes *            nm_setting_olpc_mesh_get_ssid       (NMSettingOlpcMesh *setting);
+guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);
+const char *        nm_setting_olpc_mesh_get_dhcp_anycast_address
+                                                        (NMSettingOlpcMesh *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingOlpcMesh
+
+
+
+

Properties

+
+  "channel"                  guint                 : Read / Write / Construct
+  "dhcp-anycast-address"     gchar*                : Read / Write
+  "ssid"                     GBytes*               : Read / Write
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_SETTING_OLPC_MESH_SETTING_NAME

+
#define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh"
+
+

+

+
+
+
+

NM_SETTING_OLPC_MESH_SSID

+
#define NM_SETTING_OLPC_MESH_SSID                 "ssid"
+
+

+

+
+
+
+

NM_SETTING_OLPC_MESH_CHANNEL

+
#define NM_SETTING_OLPC_MESH_CHANNEL              "channel"
+
+

+

+
+
+
+

NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS

+
#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
+
+

+

+
+
+
+

struct NMSettingOlpcMesh

+
struct NMSettingOlpcMesh;
+

+

+
+
+
+

NMSettingOlpcMeshClass

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

+

+
+
+
+

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_get_ssid ()

+
GBytes *            nm_setting_olpc_mesh_get_ssid       (NMSettingOlpcMesh *setting);
+
++++ + + + + +

Returns :

. [transfer none] +
+
+
+
+

nm_setting_olpc_mesh_get_channel ()

+
guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);
+

+

+
+
+
+

nm_setting_olpc_mesh_get_dhcp_anycast_address ()

+
const char *        nm_setting_olpc_mesh_get_dhcp_anycast_address
+                                                        (NMSettingOlpcMesh *setting);
+

+

+
+
+
+

Property Details

+
+

The "channel" property

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

+Channel on which the mesh network to join is located. +

+

Default value: 0

+
+
+
+

The "dhcp-anycast-address" property

+
  "dhcp-anycast-address"     gchar*                : Read / Write
+

+Anycast DHCP MAC address used when requesting an IP address via DHCP. +The specific anycast address used determines which DHCP server class +answers the request. +

+

Default value: NULL

+
+
+
+

The "ssid" property

+
  "ssid"                     GBytes*               : Read / Write
+

+SSID of the mesh network to join. +

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingPpp.html b/docs/libnm/html/NMSettingPpp.html new file mode 100644 index 00000000..d1752861 --- /dev/null +++ b/docs/libnm/html/NMSettingPpp.html @@ -0,0 +1,905 @@ + + + + +NMSettingPpp + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingPpp

+

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

+
+
+

Synopsis

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

Object Hierarchy

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

Properties

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

Description

+

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

+
+
+

Details

+
+

NM_SETTING_PPP_SETTING_NAME

+
#define NM_SETTING_PPP_SETTING_NAME "ppp"
+
+

+

+
+
+
+

NM_SETTING_PPP_NOAUTH

+
#define NM_SETTING_PPP_NOAUTH            "noauth"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_EAP

+
#define NM_SETTING_PPP_REFUSE_EAP        "refuse-eap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_PAP

+
#define NM_SETTING_PPP_REFUSE_PAP        "refuse-pap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_CHAP

+
#define NM_SETTING_PPP_REFUSE_CHAP       "refuse-chap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_MSCHAP

+
#define NM_SETTING_PPP_REFUSE_MSCHAP     "refuse-mschap"
+
+

+

+
+
+
+

NM_SETTING_PPP_REFUSE_MSCHAPV2

+
#define NM_SETTING_PPP_REFUSE_MSCHAPV2   "refuse-mschapv2"
+
+

+

+
+
+
+

NM_SETTING_PPP_NOBSDCOMP

+
#define NM_SETTING_PPP_NOBSDCOMP         "nobsdcomp"
+
+

+

+
+
+
+

NM_SETTING_PPP_NODEFLATE

+
#define NM_SETTING_PPP_NODEFLATE         "nodeflate"
+
+

+

+
+
+
+

NM_SETTING_PPP_NO_VJ_COMP

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

+

+
+
+
+

NM_SETTING_PPP_REQUIRE_MPPE

+
#define NM_SETTING_PPP_REQUIRE_MPPE      "require-mppe"
+
+

+

+
+
+
+

NM_SETTING_PPP_REQUIRE_MPPE_128

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

+

+
+
+
+

NM_SETTING_PPP_MPPE_STATEFUL

+
#define NM_SETTING_PPP_MPPE_STATEFUL     "mppe-stateful"
+
+

+

+
+
+
+

NM_SETTING_PPP_CRTSCTS

+
#define NM_SETTING_PPP_CRTSCTS           "crtscts"
+
+

+

+
+
+
+

NM_SETTING_PPP_BAUD

+
#define NM_SETTING_PPP_BAUD              "baud"
+
+

+

+
+
+
+

NM_SETTING_PPP_MRU

+
#define NM_SETTING_PPP_MRU               "mru"
+
+

+

+
+
+
+

NM_SETTING_PPP_MTU

+
#define NM_SETTING_PPP_MTU               "mtu"
+
+

+

+
+
+
+

NM_SETTING_PPP_LCP_ECHO_FAILURE

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

+

+
+
+
+

NM_SETTING_PPP_LCP_ECHO_INTERVAL

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

+

+
+
+
+

struct NMSettingPpp

+
struct NMSettingPpp;
+

+

+
+
+
+

NMSettingPppClass

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

+

+
+
+
+

nm_setting_ppp_new ()

+
NMSetting *         nm_setting_ppp_new                  (void);
+

+Creates a new NMSettingPpp object with default values. +

+
++++ + + + + +

Returns :

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

nm_setting_ppp_get_noauth ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_refuse_eap ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_refuse_pap ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_refuse_chap ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_refuse_mschap ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_refuse_mschapv2 ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_nobsdcomp ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_nodeflate ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_no_vj_comp ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_require_mppe ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_require_mppe_128 ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_mppe_stateful ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_crtscts ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_baud ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_mru ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_mtu ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_lcp_echo_failure ()

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

setting :

the NMSettingPpp +

Returns :

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

nm_setting_ppp_get_lcp_echo_interval ()

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

setting :

the NMSettingPpp +

Returns :

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

Property Details

+
+

The "baud" property

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

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

+

Default value: 0

+
+
+
+

The "crtscts" property

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

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

+

Default value: FALSE

+
+
+
+

The "lcp-echo-failure" property

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

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

+

Default value: 0

+
+
+
+

The "lcp-echo-interval" property

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

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

+

Default value: 0

+
+
+
+

The "mppe-stateful" property

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

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

+

Default value: FALSE

+
+
+
+

The "mru" property

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

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

+

Allowed values: <= 16384

+

Default value: 0

+
+
+
+

The "mtu" property

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

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

+

Default value: 0

+
+
+
+

The "no-vj-comp" property

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

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

+

Default value: FALSE

+
+
+
+

The "noauth" property

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

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

+

Default value: TRUE

+
+
+
+

The "nobsdcomp" property

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

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

+

Default value: FALSE

+
+
+
+

The "nodeflate" property

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

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

+

Default value: FALSE

+
+
+
+

The "refuse-chap" property

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

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

+

Default value: FALSE

+
+
+
+

The "refuse-eap" property

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

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

+

Default value: FALSE

+
+
+
+

The "refuse-mschap" property

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

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

+

Default value: FALSE

+
+
+
+

The "refuse-mschapv2" property

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

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

+

Default value: FALSE

+
+
+
+

The "refuse-pap" property

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

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

+

Default value: FALSE

+
+
+
+

The "require-mppe" property

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

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

+

Default value: FALSE

+
+
+
+

The "require-mppe-128" property

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

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

+

Default value: FALSE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingPppoe.html b/docs/libnm/html/NMSettingPppoe.html new file mode 100644 index 00000000..583028d3 --- /dev/null +++ b/docs/libnm/html/NMSettingPppoe.html @@ -0,0 +1,297 @@ + + + + +NMSettingPppoe + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingPppoe

+

NMSettingPppoe — Describes PPPoE connection properties

+
+
+

Synopsis

+
#define             NM_SETTING_PPPOE_SETTING_NAME
+#define             NM_SETTING_PPPOE_SERVICE
+#define             NM_SETTING_PPPOE_USERNAME
+#define             NM_SETTING_PPPOE_PASSWORD
+#define             NM_SETTING_PPPOE_PASSWORD_FLAGS
+struct              NMSettingPppoe;
+                    NMSettingPppoeClass;
+NMSetting *         nm_setting_pppoe_new                (void);
+const char *        nm_setting_pppoe_get_service        (NMSettingPppoe *setting);
+const char *        nm_setting_pppoe_get_username       (NMSettingPppoe *setting);
+const char *        nm_setting_pppoe_get_password       (NMSettingPppoe *setting);
+NMSettingSecretFlags nm_setting_pppoe_get_password_flags
+                                                        (NMSettingPppoe *setting);
+
+
+
+

Object Hierarchy

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

Properties

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

Description

+

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

+
+
+

Details

+
+

NM_SETTING_PPPOE_SETTING_NAME

+
#define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_SERVICE

+
#define NM_SETTING_PPPOE_SERVICE        "service"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_USERNAME

+
#define NM_SETTING_PPPOE_USERNAME       "username"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_PASSWORD

+
#define NM_SETTING_PPPOE_PASSWORD       "password"
+
+

+

+
+
+
+

NM_SETTING_PPPOE_PASSWORD_FLAGS

+
#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags"
+
+

+

+
+
+
+

struct NMSettingPppoe

+
struct NMSettingPppoe;
+

+

+
+
+
+

NMSettingPppoeClass

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

+

+
+
+
+

nm_setting_pppoe_new ()

+
NMSetting *         nm_setting_pppoe_new                (void);
+

+Creates a new NMSettingPppoe object with default values. +

+
++++ + + + + +

Returns :

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

nm_setting_pppoe_get_service ()

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

setting :

the NMSettingPppoe +

Returns :

the "service" property of the setting
+
+
+
+

nm_setting_pppoe_get_username ()

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

setting :

the NMSettingPppoe +

Returns :

the "username" property of the setting
+
+
+
+

nm_setting_pppoe_get_password ()

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

setting :

the NMSettingPppoe +

Returns :

the "password" property of the setting
+
+
+
+

nm_setting_pppoe_get_password_flags ()

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

setting :

the NMSettingPppoe +

Returns :

the NMSettingSecretFlags pertaining to the "password" +
+
+
+
+

Property Details

+
+

The "password" property

+
  "password"                 gchar*                : Read / Write
+

+Password used to authenticate with the PPPoE service. +

+

Default value: NULL

+
+
+
+

The "password-flags" property

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

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

+
+
+
+

The "service" property

+
  "service"                  gchar*                : Read / Write
+

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

+

Default value: NULL

+
+
+
+

The "username" property

+
  "username"                 gchar*                : Read / Write
+

+Username used to authenticate with the PPPoE service. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingSerial.html b/docs/libnm/html/NMSettingSerial.html new file mode 100644 index 00000000..65971e1c --- /dev/null +++ b/docs/libnm/html/NMSettingSerial.html @@ -0,0 +1,381 @@ + + + + +NMSettingSerial + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingSerial

+

NMSettingSerial — Describes connection properties for devices that use +serial communications

+
+
+

Synopsis

+
#define             NM_SETTING_SERIAL_SETTING_NAME
+enum                NMSettingSerialParity;
+#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
+struct              NMSettingSerial;
+                    NMSettingSerialClass;
+NMSetting *         nm_setting_serial_new               (void);
+guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
+guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
+NMSettingSerialParity nm_setting_serial_get_parity      (NMSettingSerial *setting);
+guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
+guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMSettingSerialParity
+
+
+  GObject
+   +----NMSetting
+         +----NMSettingSerial
+
+
+
+

Properties

+
+  "baud"                     guint                 : Read / Write / Construct
+  "bits"                     guint                 : Read / Write / Construct
+  "parity"                   NMSettingSerialParity  : Read / Write / Construct
+  "send-delay"               guint64               : Read / Write / Construct
+  "stopbits"                 guint                 : Read / Write / Construct
+
+
+
+

Description

+

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

+
+
+

Details

+
+

NM_SETTING_SERIAL_SETTING_NAME

+
#define NM_SETTING_SERIAL_SETTING_NAME "serial"
+
+

+

+
+
+
+

enum NMSettingSerialParity

+
typedef enum {
+	NM_SETTING_SERIAL_PARITY_NONE = 0,
+	NM_SETTING_SERIAL_PARITY_EVEN,
+	NM_SETTING_SERIAL_PARITY_ODD
+} NMSettingSerialParity;
+
+

+The parity setting of a serial port. +

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

NM_SETTING_SERIAL_PARITY_NONE

No parity bits (default) +

NM_SETTING_SERIAL_PARITY_EVEN

Even parity +

NM_SETTING_SERIAL_PARITY_ODD

Odd parity +
+
+
+
+

NM_SETTING_SERIAL_BAUD

+
#define NM_SETTING_SERIAL_BAUD "baud"
+
+

+

+
+
+
+

NM_SETTING_SERIAL_BITS

+
#define NM_SETTING_SERIAL_BITS "bits"
+
+

+

+
+
+
+

NM_SETTING_SERIAL_PARITY

+
#define NM_SETTING_SERIAL_PARITY "parity"
+
+

+

+
+
+
+

NM_SETTING_SERIAL_STOPBITS

+
#define NM_SETTING_SERIAL_STOPBITS "stopbits"
+
+

+

+
+
+
+

NM_SETTING_SERIAL_SEND_DELAY

+
#define NM_SETTING_SERIAL_SEND_DELAY "send-delay"
+
+

+

+
+
+
+

struct NMSettingSerial

+
struct NMSettingSerial;
+

+

+
+
+
+

NMSettingSerialClass

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

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

+

Default value: 57600

+
+
+
+

The "bits" property

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

+Byte-width of the serial communication. The 8 in "8n1" for example. +

+

Allowed values: [5,8]

+

Default value: 8

+
+
+
+

The "parity" property

+
  "parity"                   NMSettingSerialParity  : Read / Write / Construct
+

+Parity setting of the serial port. +

+

Default value: NM_SETTING_SERIAL_PARITY_NONE

+
+
+
+

The "send-delay" property

+
  "send-delay"               guint64               : Read / Write / Construct
+

+Time to delay between each byte sent to the modem, in microseconds. +

+

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

+

Allowed values: [1,2]

+

Default value: 1

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingTeam.html b/docs/libnm/html/NMSettingTeam.html new file mode 100644 index 00000000..d8e50195 --- /dev/null +++ b/docs/libnm/html/NMSettingTeam.html @@ -0,0 +1,168 @@ + + + + +NMSettingTeam + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingTeam

+

NMSettingTeam — Describes connection properties for teams

+
+
+

Synopsis

+
#define             NM_SETTING_TEAM_SETTING_NAME
+#define             NM_SETTING_TEAM_CONFIG
+struct              NMSettingTeam;
+                    NMSettingTeamClass;
+NMSetting *         nm_setting_team_new                 (void);
+const char *        nm_setting_team_get_config          (NMSettingTeam *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingTeam
+
+
+
+

Properties

+
+  "config"                   gchar*                : Read / Write
+
+
+
+

Description

+

+The NMSettingTeam object is a NMSetting subclass that describes properties +necessary for team connections. +

+
+
+

Details

+
+

NM_SETTING_TEAM_SETTING_NAME

+
#define NM_SETTING_TEAM_SETTING_NAME "team"
+
+

+

+
+
+
+

NM_SETTING_TEAM_CONFIG

+
#define NM_SETTING_TEAM_CONFIG "config"
+
+

+

+
+
+
+

struct NMSettingTeam

+
struct NMSettingTeam;
+

+

+
+
+
+

NMSettingTeamClass

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

+

+
+
+
+

nm_setting_team_new ()

+
NMSetting *         nm_setting_team_new                 (void);
+

+Creates a new NMSettingTeam object with default values. +

+
++++ + + + + +

Returns :

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

nm_setting_team_get_config ()

+
const char *        nm_setting_team_get_config          (NMSettingTeam *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingTeam +

Returns :

the "config" property of the setting
+
+
+
+

Property Details

+
+

The "config" property

+
  "config"                   gchar*                : Read / Write
+

+The JSON configuration for the team network interface. The property +should contain raw JSON configuration data suitable for teamd, because +the value is passed directly to teamd. If not specified, the default +configuration is used. See man teamd.conf for the format details. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingTeamPort.html b/docs/libnm/html/NMSettingTeamPort.html new file mode 100644 index 00000000..90835aa5 --- /dev/null +++ b/docs/libnm/html/NMSettingTeamPort.html @@ -0,0 +1,168 @@ + + + + +NMSettingTeamPort + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingTeamPort

+

NMSettingTeamPort — Describes connection properties for team ports

+
+
+

Synopsis

+
#define             NM_SETTING_TEAM_PORT_SETTING_NAME
+#define             NM_SETTING_TEAM_PORT_CONFIG
+struct              NMSettingTeamPort;
+                    NMSettingTeamPortClass;
+NMSetting *         nm_setting_team_port_new            (void);
+const char *        nm_setting_team_port_get_config     (NMSettingTeamPort *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingTeamPort
+
+
+
+

Properties

+
+  "config"                   gchar*                : Read / Write
+
+
+
+

Description

+

+The NMSettingTeamPort object is a NMSetting subclass that describes +optional properties that apply to team ports. +

+
+
+

Details

+
+

NM_SETTING_TEAM_PORT_SETTING_NAME

+
#define NM_SETTING_TEAM_PORT_SETTING_NAME "team-port"
+
+

+

+
+
+
+

NM_SETTING_TEAM_PORT_CONFIG

+
#define NM_SETTING_TEAM_PORT_CONFIG     "config"
+
+

+

+
+
+
+

struct NMSettingTeamPort

+
struct NMSettingTeamPort;
+

+

+
+
+
+

NMSettingTeamPortClass

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

+

+
+
+
+

nm_setting_team_port_new ()

+
NMSetting *         nm_setting_team_port_new            (void);
+

+Creates a new NMSettingTeamPort object with default values. +

+
++++ + + + + +

Returns :

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

nm_setting_team_port_get_config ()

+
const char *        nm_setting_team_port_get_config     (NMSettingTeamPort *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingTeamPort +

Returns :

the "config" property of the setting
+
+
+
+

Property Details

+
+

The "config" property

+
  "config"                   gchar*                : Read / Write
+

+The JSON configuration for the team port. The property should contain raw +JSON configuration data suitable for teamd, because the value is passed +directly to teamd. If not specified, the default configuration is +used. See man teamd.conf for the format details. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingVlan.html b/docs/libnm/html/NMSettingVlan.html new file mode 100644 index 00000000..52175ad8 --- /dev/null +++ b/docs/libnm/html/NMSettingVlan.html @@ -0,0 +1,727 @@ + + + + +NMSettingVlan + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingVlan

+

NMSettingVlan — Describes connection properties for VLAN interfaces

+
+
+

Synopsis

+
#define             NM_SETTING_VLAN_SETTING_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
+struct              NMSettingVlan;
+                    NMSettingVlanClass;
+enum                NMVlanPriorityMap;
+enum                NMVlanFlags;
+NMSetting *         nm_setting_vlan_new                 (void);
+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);
+gboolean            nm_setting_vlan_remove_priority_by_value
+                                                        (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         guint32 from,
+                                                         guint32 to);
+gboolean            nm_setting_vlan_remove_priority_str_by_value
+                                                        (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         const char *str);
+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

+
+  GObject
+   +----NMSetting
+         +----NMSettingVlan
+
+
+  GEnum
+   +----NMVlanPriorityMap
+
+
+  GFlags
+   +----NMVlanFlags
+
+
+
+

Properties

+
+  "egress-priority-map"      GStrv                 : Read / Write
+  "flags"                    NMVlanFlags           : Read / Write / Construct
+  "id"                       guint                 : Read / Write / Construct
+  "ingress-priority-map"     GStrv                 : Read / Write
+  "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"
+
+

+

+
+
+
+

NM_SETTING_VLAN_PARENT

+
#define NM_SETTING_VLAN_PARENT               "parent"
+
+

+

+
+
+
+

NM_SETTING_VLAN_ID

+
#define NM_SETTING_VLAN_ID                   "id"
+
+

+

+
+
+
+

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

+

+
+
+
+

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

+
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
+
+

+

+
+
+
+

struct NMSettingVlan

+
struct NMSettingVlan;
+

+

+
+
+
+

NMSettingVlanClass

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

+

+
+
+
+

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_VLAN_INGRESS_MAP

map for incoming data +

NM_VLAN_EGRESS_MAP

map for outgoing data +
+
+
+
+

enum NMVlanFlags

+
typedef enum {
+ /*< flags >*/
+	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_VLAN_FLAG_REORDER_HEADERS

indicates that this interface should reorder + outgoing packet headers to look more like a non-VLAN Ethernet interface +

NM_VLAN_FLAG_GVRP

indicates that this interface should use GVRP to register + itself with it's switch +

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

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_get_parent ()

+
const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingVlan +

Returns :

the "parent" property of the setting
+
+
+
+

nm_setting_vlan_get_id ()

+
guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingVlan +

Returns :

the "id" property of the setting
+
+
+
+

nm_setting_vlan_get_flags ()

+
guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingVlan +

Returns :

the "flags" property of the setting
+
+
+
+

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

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

setting :

the NMSettingVlan +

map :

the type of priority map

Returns :

return the number of ingress/egress priority entries, -1 if error
+
+
+
+

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

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

setting :

the NMSettingVlan +

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

out_to :

on return the value of priority map's 'to' item. [out] +

Returns :

 +TRUE if a priority map was returned, FALSE if error
+
+
+
+

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

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

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

+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_remove_priority_by_value ()

+
gboolean            nm_setting_vlan_remove_priority_by_value
+                                                        (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         guint32 from,
+                                                         guint32 to);
+

+Removes the priority map form:to from the "ingress_priority_map" +or "egress_priority_map" (according to map argument) +properties. +

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

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 priority mapping was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_vlan_remove_priority_str_by_value ()

+
gboolean            nm_setting_vlan_remove_priority_str_by_value
+                                                        (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         const char *str);
+

+Removes the priority map str from the "ingress_priority_map" +or "egress_priority_map" (according to map argument) +properties. +

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

setting :

the NMSettingVlan +

map :

the type of priority map

str :

the string which contains a priority map, like "3:7"

Returns :

 +TRUE if the priority mapping was found and removed; FALSE if it was not.
+
+
+
+

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

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

setting :

the NMSettingVlan +

map :

the type of priority map
+
+
+
+

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

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

setting :

the NMSettingVlan +

map :

the type of priority map

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

Property Details

+
+

The "egress-priority-map" property

+
  "egress-priority-map"      GStrv                 : 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 "flags" property

+
  "flags"                    NMVlanFlags           : Read / Write / Construct
+

+One or more flags which control the behavior and features of the VLAN +interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (reordering of +output packet headers), NM_VLAN_FLAG_GVRP (use of the GVRP protocol), +and NM_VLAN_FLAG_LOOSE_BINDING (loose binding of the interface to its +master device's operating state). +

+
+
+
+

The "id" property

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

+The VLAN identifier that the interface created by this connection should +be assigned. +

+

Allowed values: <= 4095

+

Default value: 0

+
+
+
+

The "ingress-priority-map" property

+
  "ingress-priority-map"     GStrv                 : 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 "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 an NMSettingWired setting +with a "mac-address" property. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingVpn.html b/docs/libnm/html/NMSettingVpn.html new file mode 100644 index 00000000..a83c0145 --- /dev/null +++ b/docs/libnm/html/NMSettingVpn.html @@ -0,0 +1,682 @@ + + + + +NMSettingVpn + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingVpn

+

NMSettingVpn — Describes connection properties for Virtual Private Networks

+
+
+

Synopsis

+
#define             NM_SETTING_VPN_SETTING_NAME
+#define             NM_SETTING_VPN_SERVICE_TYPE
+#define             NM_SETTING_VPN_USER_NAME
+#define             NM_SETTING_VPN_PERSISTENT
+#define             NM_SETTING_VPN_DATA
+#define             NM_SETTING_VPN_SECRETS
+struct              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);
+gboolean            nm_setting_vpn_get_persistent       (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);
+gboolean            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);
+gboolean            nm_setting_vpn_remove_secret        (NMSettingVpn *setting,
+                                                         const char *key);
+void                nm_setting_vpn_foreach_secret       (NMSettingVpn *setting,
+                                                         NMVpnIterFunc func,
+                                                         gpointer user_data);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingVpn
+
+
+
+

Properties

+
+  "data"                     GHashTable*           : Read / Write
+  "persistent"               gboolean              : Read / Write
+  "secrets"                  GHashTable*           : Read / Write
+  "service-type"             gchar*                : Read / Write
+  "user-name"                gchar*                : Read / Write
+
+
+
+

Description

+

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

+
+
+

Details

+
+

NM_SETTING_VPN_SETTING_NAME

+
#define NM_SETTING_VPN_SETTING_NAME "vpn"
+
+

+

+
+
+
+

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_PERSISTENT

+
#define NM_SETTING_VPN_PERSISTENT   "persistent"
+
+

+

+
+
+
+

NM_SETTING_VPN_DATA

+
#define NM_SETTING_VPN_DATA         "data"
+
+

+

+
+
+
+

NM_SETTING_VPN_SECRETS

+
#define NM_SETTING_VPN_SECRETS      "secrets"
+
+

+

+
+
+
+

struct NMSettingVpn

+
struct NMSettingVpn;
+

+

+
+
+
+

NMSettingVpnClass

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

+

+
+
+
+

NMVpnIterFunc ()

+
void                (*NMVpnIterFunc)                    (const char *key,
+                                                         const char *value,
+                                                         gpointer user_data);
+
++++ + + + + + + + + + + + + + + +

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

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

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

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 +

Returns :

the "user-name" property of the setting
+
+
+
+

nm_setting_vpn_get_persistent ()

+
gboolean            nm_setting_vpn_get_persistent       (NMSettingVpn *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingVpn +

Returns :

the "persistent" property of the setting
+
+
+
+

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

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

setting :

the NMSettingVpn +

Returns :

the number of VPN plugin specific configuration data items
+
+
+
+

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

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

setting :

the NMSettingVpn +

key :

a name that uniquely identifies the given value item +

item :

the value to be referenced by key +
+
+
+
+

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

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

setting :

the NMSettingVpn +

key :

the name of the data item to retrieve

Returns :

the data item, if any
+
+
+
+

nm_setting_vpn_remove_data_item ()

+
gboolean            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(). +

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

setting :

the NMSettingVpn +

key :

the name of the data item to remove

Returns :

 +TRUE if the data item was found and removed from the internal list, +FALSE if it was not.
+
+
+
+

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

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

setting :

a NMSettingVpn +

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +
+
+
+
+

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

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

setting :

the NMSettingVpn +

Returns :

the number of VPN plugin specific secrets
+
+
+
+

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

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

setting :

the NMSettingVpn +

key :

a name that uniquely identifies the given secret secret +

secret :

the secret to be referenced by key +
+
+
+
+

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

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

setting :

the NMSettingVpn +

key :

the name of the secret to retrieve

Returns :

the secret, if any
+
+
+
+

nm_setting_vpn_remove_secret ()

+
gboolean            nm_setting_vpn_remove_secret        (NMSettingVpn *setting,
+                                                         const char *key);
+

+Deletes a key/value relationship previously established by +nm_setting_vpn_add_secret(). +

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

setting :

the NMSettingVpn +

key :

the name of the secret to remove

Returns :

 +TRUE if the secret was found and removed from the internal list, +FALSE if it was not.
+
+
+
+

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

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

setting :

a NMSettingVpn +

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +
+
+
+
+

Property Details

+
+

The "data" property

+
  "data"                     GHashTable*           : Read / Write
+

+Dictionary of key/value pairs of VPN plugin specific data. Both keys and +values must be strings. +

+

+Type: GHashTable(utf8,utf8) +

+
+
+
+

The "persistent" property

+
  "persistent"               gboolean              : Read / Write
+

+If the VPN service supports persistence, and this property is TRUE, +the VPN will attempt to stay connected across link changes and outages, +until explicitly disconnected. +

+

Default value: FALSE

+
+
+
+

The "secrets" property

+
  "secrets"                  GHashTable*           : Read / Write
+

+Dictionary of key/value pairs of VPN plugin specific secrets like +passwords or private keys. Both keys and values must be strings. +

+

+Type: GHashTable(utf8,utf8) +

+
+
+
+

The "service-type" property

+
  "service-type"             gchar*                : Read / Write
+

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

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

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingWimax.html b/docs/libnm/html/NMSettingWimax.html new file mode 100644 index 00000000..7b2f64f9 --- /dev/null +++ b/docs/libnm/html/NMSettingWimax.html @@ -0,0 +1,217 @@ + + + + +NMSettingWimax + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingWimax

+

NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties

+
+
+

Synopsis

+
#define             NM_SETTING_WIMAX_SETTING_NAME
+#define             NM_SETTING_WIMAX_NETWORK_NAME
+#define             NM_SETTING_WIMAX_MAC_ADDRESS
+struct              NMSettingWimax;
+                    NMSettingWimaxClass;
+NMSetting *         nm_setting_wimax_new                (void);
+const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
+const char *        nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingWimax
+
+
+
+

Properties

+
+  "mac-address"              gchar*                : 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"
+
+

+

+
+
+
+

NM_SETTING_WIMAX_NETWORK_NAME

+
#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
+
+

+

+
+
+
+

NM_SETTING_WIMAX_MAC_ADDRESS

+
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
+
+

+

+
+
+
+

struct NMSettingWimax

+
struct NMSettingWimax;
+

+

+
+
+
+

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

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

setting :

the NMSettingWimax +

Returns :

the WiMAX NSP name
+
+
+
+

nm_setting_wimax_get_mac_address ()

+
const char *        nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+

+Returns the MAC address of a WiMAX device which this connection is locked +to. +

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

setting :

the NMSettingWimax +

Returns :

the MAC address
+
+
+
+

Property Details

+
+

The "mac-address" property

+
  "mac-address"              gchar*                : Read / Write
+

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

+

Default value: NULL

+
+
+
+

The "network-name" property

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

+Network Service Provider (NSP) name of the WiMAX network this connection +should use. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingWired.html b/docs/libnm/html/NMSettingWired.html new file mode 100644 index 00000000..b9f0ad4b --- /dev/null +++ b/docs/libnm/html/NMSettingWired.html @@ -0,0 +1,1015 @@ + + + + +NMSettingWired + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingWired

+

NMSettingWired — Describes connection properties for Ethernet-based networks

+
+
+

Synopsis

+
#define             NM_SETTING_WIRED_SETTING_NAME
+#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
+struct              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 char *        nm_setting_wired_get_mac_address    (NMSettingWired *setting);
+const char *        nm_setting_wired_get_cloned_mac_address
+                                                        (NMSettingWired *setting);
+const char * const * nm_setting_wired_get_mac_address_blacklist
+                                                        (NMSettingWired *setting);
+guint32             nm_setting_wired_get_num_mac_blacklist_items
+                                                        (NMSettingWired *setting);
+const char *        nm_setting_wired_get_mac_blacklist_item
+                                                        (NMSettingWired *setting,
+                                                         guint32 idx);
+gboolean            nm_setting_wired_add_mac_blacklist_item
+                                                        (NMSettingWired *setting,
+                                                         const char *mac);
+void                nm_setting_wired_remove_mac_blacklist_item
+                                                        (NMSettingWired *setting,
+                                                         guint32 idx);
+gboolean            nm_setting_wired_remove_mac_blacklist_item_by_value
+                                                        (NMSettingWired *setting,
+                                                         const char *mac);
+void                nm_setting_wired_clear_mac_blacklist_items
+                                                        (NMSettingWired *setting);
+guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
+const char * const * 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 *value);
+gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
+                                                         const char *key);
+const char **       nm_setting_wired_get_valid_s390_options
+                                                        (NMSettingWired *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingWired
+
+
+
+

Properties

+
+  "auto-negotiate"           gboolean              : Read / Write / Construct
+  "cloned-mac-address"       gchar*                : Read / Write
+  "duplex"                   gchar*                : Read / Write
+  "mac-address"              gchar*                : Read / Write
+  "mac-address-blacklist"    GStrv                 : Read / Write
+  "mtu"                      guint                 : Read / Write / Construct
+  "port"                     gchar*                : Read / Write
+  "s390-nettype"             gchar*                : Read / Write
+  "s390-options"             GHashTable*           : Read / Write
+  "s390-subchannels"         GStrv                 : 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"
+
+

+

+
+
+
+

NM_SETTING_WIRED_PORT

+
#define NM_SETTING_WIRED_PORT "port"
+
+

+

+
+
+
+

NM_SETTING_WIRED_SPEED

+
#define NM_SETTING_WIRED_SPEED "speed"
+
+

+

+
+
+
+

NM_SETTING_WIRED_DUPLEX

+
#define NM_SETTING_WIRED_DUPLEX "duplex"
+
+

+

+
+
+
+

NM_SETTING_WIRED_AUTO_NEGOTIATE

+
#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
+
+

+

+
+
+
+

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_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_S390_SUBCHANNELS

+
#define NM_SETTING_WIRED_S390_SUBCHANNELS "s390-subchannels"
+
+

+

+
+
+
+

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

+

+
+
+
+

struct NMSettingWired

+
struct NMSettingWired;
+

+

+
+
+
+

NMSettingWiredClass

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

+

+
+
+
+

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_get_port ()

+
const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "port" property of the setting
+
+
+
+

nm_setting_wired_get_speed ()

+
guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "speed" property of the setting
+
+
+
+

nm_setting_wired_get_duplex ()

+
const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "duplex" property of the setting
+
+
+
+

nm_setting_wired_get_auto_negotiate ()

+
gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "auto-negotiate" property of the setting
+
+
+
+

nm_setting_wired_get_mac_address ()

+
const char *        nm_setting_wired_get_mac_address    (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "mac-address" property of the setting
+
+
+
+

nm_setting_wired_get_cloned_mac_address ()

+
const char *        nm_setting_wired_get_cloned_mac_address
+                                                        (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "cloned-mac-address" property of the setting
+
+
+
+

nm_setting_wired_get_mac_address_blacklist ()

+
const char * const * nm_setting_wired_get_mac_address_blacklist
+                                                        (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "mac-address-blacklist" property of the setting
+
+
+
+

nm_setting_wired_get_num_mac_blacklist_items ()

+
guint32             nm_setting_wired_get_num_mac_blacklist_items
+                                                        (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the number of blacklisted MAC addresses
+
+
+
+

nm_setting_wired_get_mac_blacklist_item ()

+
const char *        nm_setting_wired_get_mac_blacklist_item
+                                                        (NMSettingWired *setting,
+                                                         guint32 idx);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingWired +

idx :

the zero-based index of the MAC address entry

Returns :

the blacklisted MAC address string (hex-digits-and-colons notation) +at index idx +
+
+
+
+

nm_setting_wired_add_mac_blacklist_item ()

+
gboolean            nm_setting_wired_add_mac_blacklist_item
+                                                        (NMSettingWired *setting,
+                                                         const char *mac);
+

+Adds a new MAC address to the "mac-address-blacklist" property. +

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

setting :

the NMSettingWired +

mac :

the MAC address string (hex-digits-and-colons notation) to blacklist

Returns :

 +TRUE if the MAC address was added; FALSE if the MAC address +is invalid or was already present
+
+
+
+

nm_setting_wired_remove_mac_blacklist_item ()

+
void                nm_setting_wired_remove_mac_blacklist_item
+                                                        (NMSettingWired *setting,
+                                                         guint32 idx);
+

+Removes the MAC address at index idx from the blacklist. +

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

setting :

the NMSettingWired +

idx :

index number of the MAC address
+
+
+
+

nm_setting_wired_remove_mac_blacklist_item_by_value ()

+
gboolean            nm_setting_wired_remove_mac_blacklist_item_by_value
+                                                        (NMSettingWired *setting,
+                                                         const char *mac);
+

+Removes the MAC address mac from the blacklist. +

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

setting :

the NMSettingWired +

mac :

the MAC address string (hex-digits-and-colons notation) to remove from +the blacklist

Returns :

 +TRUE if the MAC address was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_wired_clear_mac_blacklist_items ()

+
void                nm_setting_wired_clear_mac_blacklist_items
+                                                        (NMSettingWired *setting);
+

+Removes all blacklisted MAC addresses. +

+
++++ + + + + +

setting :

the NMSettingWired +
+
+
+
+

nm_setting_wired_get_mtu ()

+
guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

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

nm_setting_wired_get_s390_subchannels ()

+
const char * const * 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. +

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

setting :

the NMSettingWired +

Returns :

array of strings, each specifying +one subchannel the s390 device uses to communicate to the host. [transfer none][element-type utf8] +
+
+
+
+

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

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

setting :

the NMSettingWired +

Returns :

the s390 device type
+
+
+
+

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

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

setting :

the NMSettingWired +

Returns :

the number of s390-specific device options
+
+
+
+

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

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

setting :

the NMSettingWired +

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][transfer none] +

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][transfer none] +

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

+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 *value);
+

+Add an option to the table. The option is compared to an internal list +of allowed options. Key names may contain only alphanumeric characters +(ie [a-zA-Z0-9]). Adding a new key replaces any existing key/value pair that +may already exist. +

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

setting :

the NMSettingWired +

key :

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

nm_setting_wired_remove_s390_option ()

+
gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
+                                                         const char *key);
+

+Remove the s390-specific option referenced by key from the internal option +list. +

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

setting :

the NMSettingWired +

key :

key name for 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_wired_get_valid_s390_options ()

+
const char **       nm_setting_wired_get_valid_s390_options
+                                                        (NMSettingWired *setting);
+

+Returns a list of valid s390 options. +

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

setting :

the NMSettingWired +

Returns :

a NULL-terminated array of strings of valid s390 options. [transfer none] +
+
+
+
+

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"       gchar*                : Read / Write
+

+If specified, request that the device use this MAC address instead of its +permanent MAC address. This is known as MAC cloning or spoofing. +

+

Default value: NULL

+
+
+
+

The "duplex" property

+
  "duplex"                   gchar*                : Read / Write
+

+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"              gchar*                : Read / Write
+

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

+

Default value: NULL

+
+
+
+

The "mac-address-blacklist" property

+
  "mac-address-blacklist"    GStrv                 : Read / Write
+

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

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

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

+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*           : Read / Write
+

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

+

+Type: GHashTable(utf8,utf8) +

+
+
+
+

The "s390-subchannels" property

+
  "s390-subchannels"         GStrv                 : Read / Write
+

+Identifies specific subchannels that this network device uses for +communication 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. +

+
+
+
+

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

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingWireless.html b/docs/libnm/html/NMSettingWireless.html new file mode 100644 index 00000000..8cc9a471 --- /dev/null +++ b/docs/libnm/html/NMSettingWireless.html @@ -0,0 +1,1053 @@ + + + + +NMSettingWireless + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingWireless

+

NMSettingWireless — Describes connection properties for 802.11 Wi-Fi networks

+
+
+

Synopsis

+
#define             NM_SETTING_WIRELESS_SETTING_NAME
+#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_HIDDEN
+#define             NM_SETTING_WIRELESS_MODE_ADHOC
+#define             NM_SETTING_WIRELESS_MODE_AP
+#define             NM_SETTING_WIRELESS_MODE_INFRA
+struct              NMSettingWireless;
+                    NMSettingWirelessClass;
+NMSetting *         nm_setting_wireless_new             (void);
+GBytes *            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 char *        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 char *        nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_cloned_mac_address
+                                                        (NMSettingWireless *setting);
+const char * const * nm_setting_wireless_get_mac_address_blacklist
+                                                        (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_num_mac_blacklist_items
+                                                        (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_mac_blacklist_item
+                                                        (NMSettingWireless *setting,
+                                                         guint32 idx);
+gboolean            nm_setting_wireless_add_mac_blacklist_item
+                                                        (NMSettingWireless *setting,
+                                                         const char *mac);
+void                nm_setting_wireless_remove_mac_blacklist_item
+                                                        (NMSettingWireless *setting,
+                                                         guint32 idx);
+gboolean            nm_setting_wireless_remove_mac_blacklist_item_by_value
+                                                        (NMSettingWireless *setting,
+                                                         const char *mac);
+void                nm_setting_wireless_clear_mac_blacklist_items
+                                                        (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_mtu         (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

+
+  GObject
+   +----NMSetting
+         +----NMSettingWireless
+
+
+
+

Properties

+
+  "band"                     gchar*                : Read / Write
+  "bssid"                    gchar*                : Read / Write
+  "channel"                  guint                 : Read / Write / Construct
+  "cloned-mac-address"       gchar*                : Read / Write
+  "hidden"                   gboolean              : Read / Write
+  "mac-address"              gchar*                : Read / Write
+  "mac-address-blacklist"    GStrv                 : Read / Write
+  "mode"                     gchar*                : Read / Write
+  "mtu"                      guint                 : Read / Write / Construct
+  "rate"                     guint                 : Read / Write / Construct
+  "seen-bssids"              GStrv                 : Read / Write
+  "ssid"                     GBytes*               : 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 Wi-Fi networks. +

+
+
+

Details

+
+

NM_SETTING_WIRELESS_SETTING_NAME

+
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
+
+

+

+
+
+
+

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

+

+
+
+
+

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_MTU

+
#define NM_SETTING_WIRELESS_MTU         "mtu"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_SEEN_BSSIDS

+
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
+
+

+

+
+
+
+

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_MODE_AP

+
#define NM_SETTING_WIRELESS_MODE_AP     "ap"
+
+

+Indicates AP/master mode where the wireless device is started as an access +point/hotspot. +

+
+
+
+

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

+
+
+
+

struct NMSettingWireless

+
struct NMSettingWireless;
+

+

+
+
+
+

NMSettingWirelessClass

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

+

+
+
+
+

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_get_ssid ()

+
GBytes *            nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "ssid" property of the setting. [transfer none] +
+
+
+
+

nm_setting_wireless_get_mode ()

+
const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "mode" property of the setting
+
+
+
+

nm_setting_wireless_get_band ()

+
const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "band" property of the setting
+
+
+
+

nm_setting_wireless_get_channel ()

+
guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "channel" property of the setting
+
+
+
+

nm_setting_wireless_get_bssid ()

+
const char *        nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "bssid" property of the setting
+
+
+
+

nm_setting_wireless_get_rate ()

+
guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "rate" property of the setting
+
+
+
+

nm_setting_wireless_get_tx_power ()

+
guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "tx-power" property of the setting
+
+
+
+

nm_setting_wireless_get_mac_address ()

+
const char *        nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "mac-address" property of the setting
+
+
+
+

nm_setting_wireless_get_cloned_mac_address ()

+
const char *        nm_setting_wireless_get_cloned_mac_address
+                                                        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "cloned-mac-address" property of the setting
+
+
+
+

nm_setting_wireless_get_mac_address_blacklist ()

+
const char * const * nm_setting_wireless_get_mac_address_blacklist
+                                                        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "mac-address-blacklist" property of the setting
+
+
+
+

nm_setting_wireless_get_num_mac_blacklist_items ()

+
guint32             nm_setting_wireless_get_num_mac_blacklist_items
+                                                        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the number of blacklisted MAC addresses
+
+
+
+

nm_setting_wireless_get_mac_blacklist_item ()

+
const char *        nm_setting_wireless_get_mac_blacklist_item
+                                                        (NMSettingWireless *setting,
+                                                         guint32 idx);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingWireless +

idx :

the zero-based index of the MAC address entry

Returns :

the blacklisted MAC address string (hex-digits-and-colons notation) +at index idx +
+
+
+
+

nm_setting_wireless_add_mac_blacklist_item ()

+
gboolean            nm_setting_wireless_add_mac_blacklist_item
+                                                        (NMSettingWireless *setting,
+                                                         const char *mac);
+

+Adds a new MAC address to the "mac-address-blacklist" property. +

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

setting :

the NMSettingWireless +

mac :

the MAC address string (hex-digits-and-colons notation) to blacklist

Returns :

 +TRUE if the MAC address was added; FALSE if the MAC address +is invalid or was already present
+
+
+
+

nm_setting_wireless_remove_mac_blacklist_item ()

+
void                nm_setting_wireless_remove_mac_blacklist_item
+                                                        (NMSettingWireless *setting,
+                                                         guint32 idx);
+

+Removes the MAC address at index idx from the blacklist. +

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

setting :

the NMSettingWireless +

idx :

index number of the MAC address
+
+
+
+

nm_setting_wireless_remove_mac_blacklist_item_by_value ()

+
gboolean            nm_setting_wireless_remove_mac_blacklist_item_by_value
+                                                        (NMSettingWireless *setting,
+                                                         const char *mac);
+

+Removes the MAC address mac from the blacklist. +

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

setting :

the NMSettingWireless +

mac :

the MAC address string (hex-digits-and-colons notation) to remove from +the blacklist

Returns :

 +TRUE if the MAC address was found and removed; FALSE if it was not.
+
+
+
+

nm_setting_wireless_clear_mac_blacklist_items ()

+
void                nm_setting_wireless_clear_mac_blacklist_items
+                                                        (NMSettingWireless *setting);
+

+Removes all blacklisted MAC addresses. +

+
++++ + + + + +

setting :

the NMSettingWireless +
+
+
+
+

nm_setting_wireless_get_mtu ()

+
guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

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

nm_setting_wireless_get_hidden ()

+
gboolean            nm_setting_wireless_get_hidden      (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "hidden" property of the 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. +

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

setting :

the NMSettingWireless +

bssid :

the new BSSID to add to the list

Returns :

 +TRUE if bssid was already known, FALSE if not
+
+
+
+

nm_setting_wireless_get_num_seen_bssids ()

+
guint32             nm_setting_wireless_get_num_seen_bssids
+                                                        (NMSettingWireless *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the number of BSSIDs in the previously seen BSSID list
+
+
+
+

nm_setting_wireless_get_seen_bssid ()

+
const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
+                                                         guint32 i);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingWireless +

i :

index of a BSSID in the previously seen BSSID list

Returns :

the BSSID at index i +
+
+
+
+

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

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

s_wireless :

a NMSettingWireless +

s_wireless_sec :

a NMSettingWirelessSecurity or NULL +

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

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

Property Details

+
+

The "band" property

+
  "band"                     gchar*                : Read / Write
+

+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 Wi-Fi 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"                    gchar*                : Read / Write
+

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

+

Default value: NULL

+
+
+
+

The "channel" property

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

+Wireless channel to use for the Wi-Fi connection. The device will only +join (or create for Ad-Hoc networks) a Wi-Fi 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"       gchar*                : Read / Write
+

+If specified, request that the Wi-Fi device use this MAC address instead +of its permanent MAC address. This is known as MAC cloning or spoofing. +

+

Default value: NULL

+
+
+
+

The "hidden" property

+
  "hidden"                   gboolean              : Read / Write
+

+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"              gchar*                : Read / Write
+

+If specified, this connection will only apply to the Wi-Fi device whose +permanent MAC address matches. This property does not change the MAC +address of the device (i.e. MAC spoofing). +

+

Default value: NULL

+
+
+
+

The "mac-address-blacklist" property

+
  "mac-address-blacklist"    GStrv                 : Read / Write
+

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

+Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, +infrastructure is assumed. +

+

Default value: NULL

+
+
+
+

The "mtu" property

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

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

+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 "seen-bssids" property

+
  "seen-bssids"              GStrv                 : Read / Write
+

+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 BSSID list of +NetworkManager. The changes you make to this property will not be +preserved. +

+
+
+
+

The "ssid" property

+
  "ssid"                     GBytes*               : Read / Write
+

+SSID of the Wi-Fi network. Must be specified. +

+
+
+
+

The "tx-power" property

+
  "tx-power"                 guint                 : Read / Write / Construct
+

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

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSettingWirelessSecurity.html b/docs/libnm/html/NMSettingWirelessSecurity.html new file mode 100644 index 00000000..b302a113 --- /dev/null +++ b/docs/libnm/html/NMSettingWirelessSecurity.html @@ -0,0 +1,1450 @@ + + + + +NMSettingWirelessSecurity + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingWirelessSecurity

+

NMSettingWirelessSecurity — Describes connection properties for Wi-Fi networks that +use WEP, LEAP, WPA or WPA2/RSN security

+
+
+

Synopsis

+
#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
+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
+struct              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);
+gboolean            nm_setting_wireless_security_remove_proto_by_value
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *proto);
+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);
+gboolean            nm_setting_wireless_security_remove_pairwise_by_value
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *pairwise);
+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);
+gboolean            nm_setting_wireless_security_remove_group_by_value
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *group);
+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
+   +----NMWepKeyType
+
+
+  GObject
+   +----NMSetting
+         +----NMSettingWirelessSecurity
+
+
+
+

Properties

+
+  "auth-alg"                 gchar*                : Read / Write
+  "group"                    GStrv                 : Read / Write
+  "key-mgmt"                 gchar*                : Read / Write
+  "leap-password"            gchar*                : Read / Write
+  "leap-password-flags"      NMSettingSecretFlags  : Read / Write
+  "leap-username"            gchar*                : Read / Write
+  "pairwise"                 GStrv                 : Read / Write
+  "proto"                    GStrv                 : Read / Write
+  "psk"                      gchar*                : Read / Write
+  "psk-flags"                NMSettingSecretFlags  : Read / Write
+  "wep-key-flags"            NMSettingSecretFlags  : Read / Write
+  "wep-key-type"             NMWepKeyType          : 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 Wi-Fi 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 Wi-Fi 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 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. +

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

NM_WEP_KEY_TYPE_UNKNOWN

unknown WEP key type +

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

NM_WEP_KEY_TYPE_LAST

placeholder value for bounds-checking +
+
+
+
+

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

+

+
+
+
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE "wep-key-type"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_SECURITY_PSK

+
#define NM_SETTING_WIRELESS_SECURITY_PSK "psk"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS "psk-flags"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD

+
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD "leap-password"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS "leap-password-flags"
+
+

+

+
+
+
+

struct NMSettingWirelessSecurity

+
struct NMSettingWirelessSecurity;
+

+

+
+
+
+

NMSettingWirelessSecurityClass

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

+

+
+
+
+

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

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

nm_setting_wireless_security_get_num_protos ()

+
guint32             nm_setting_wireless_security_get_num_protos
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

Returns :

the number of security protocols this connection allows when +connecting to secure Wi-Fi networks
+
+
+
+

nm_setting_wireless_security_get_proto ()

+
const char *        nm_setting_wireless_security_get_proto
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 i);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

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

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

setting :

the NMSettingWirelessSecurity +

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

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

setting :

the NMSettingWirelessSecurity +

i :

index of the protocol to remove
+
+
+
+

nm_setting_wireless_security_remove_proto_by_value ()

+
gboolean            nm_setting_wireless_security_remove_proto_by_value
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *proto);
+

+Removes a protocol from the allowed protocol list. +

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

setting :

the NMSettingWirelessSecurity +

proto :

the protocol to remove, one of "wpa" or "rsn"

Returns :

 +TRUE if the protocol was found and removed; FALSE it it was not.
+
+
+
+

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

+
++++ + + + + +

setting :

the NMSettingWirelessSecurity +
+
+
+
+

nm_setting_wireless_security_get_num_pairwise ()

+
guint32             nm_setting_wireless_security_get_num_pairwise
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

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

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

setting :

the NMSettingWirelessSecurity +

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

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

setting :

the NMSettingWirelessSecurity +

pairwise :

the encryption algorithm to add, one of "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. +

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

setting :

the NMSettingWirelessSecurity +

i :

the index of an item in the allowed pairwise encryption algorithm list
+
+
+
+

nm_setting_wireless_security_remove_pairwise_by_value ()

+
gboolean            nm_setting_wireless_security_remove_pairwise_by_value
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *pairwise);
+

+Removes an encryption algorithm from the allowed pairwise encryption +algorithm list. +

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

setting :

the NMSettingWirelessSecurity +

pairwise :

the encryption algorithm to remove, one of "tkip" or "ccmp"

Returns :

 +TRUE if the encryption algorith was found and removed; FALSE it it was not.
+
+
+
+

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

+
++++ + + + + +

setting :

the NMSettingWirelessSecurity +
+
+
+
+

nm_setting_wireless_security_get_num_groups ()

+
guint32             nm_setting_wireless_security_get_num_groups
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

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

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

setting :

the NMSettingWirelessSecurity +

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

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

setting :

the NMSettingWirelessSecurity +

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

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

setting :

the NMSettingWirelessSecurity +

i :

the index of an item in the allowed groupwise encryption algorithm list
+
+
+
+

nm_setting_wireless_security_remove_group_by_value ()

+
gboolean            nm_setting_wireless_security_remove_group_by_value
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *group);
+

+Removes an encryption algorithm from the allowed groupwise encryption +algorithm list. +

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

setting :

the NMSettingWirelessSecurity +

group :

the encryption algorithm to remove, one of "wep40", "wep104", +"tkip", or "ccmp"

Returns :

 +TRUE if the algorithm was found and removed; FALSE it it was not.
+
+
+
+

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

+
++++ + + + + +

setting :

the NMSettingWirelessSecurity +
+
+
+
+

nm_setting_wireless_security_get_psk ()

+
const char *        nm_setting_wireless_security_get_psk
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

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

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

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

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

setting :

the NMSettingWirelessSecurity +

Returns :

the NMSettingSecretFlags pertaining to the +"leap-password" +
+
+
+
+

nm_setting_wireless_security_get_wep_key ()

+
const char *        nm_setting_wireless_security_get_wep_key
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 idx);
+
++++ + + + + + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

idx :

the WEP key index (0..3 inclusive)

Returns :

the WEP key at the given index
+
+
+
+

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

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

setting :

the NMSettingWirelessSecurity +

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_wep_tx_keyidx ()

+
guint32             nm_setting_wireless_security_get_wep_tx_keyidx
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

Returns :

the "wep-tx-keyidx" property of the setting
+
+
+
+

nm_setting_wireless_security_get_auth_alg ()

+
const char *        nm_setting_wireless_security_get_auth_alg
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

Returns :

the "auth-alg" property of the setting
+
+
+
+

nm_setting_wireless_security_get_wep_key_flags ()

+
NMSettingSecretFlags nm_setting_wireless_security_get_wep_key_flags
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

Returns :

the NMSettingSecretFlags pertaining to the all WEP keys
+
+
+
+

nm_setting_wireless_security_get_wep_key_type ()

+
NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

Returns :

the "wep-key-type" property of the setting
+
+
+
+

Property Details

+
+

The "auth-alg" property

+
  "auth-alg"                 gchar*                : Read / Write
+

+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"                    GStrv                 : Read / Write
+

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

+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 Wi-Fi connection that uses security. +

+

Default value: NULL

+
+
+
+

The "leap-password" property

+
  "leap-password"            gchar*                : Read / Write
+

+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"      NMSettingSecretFlags  : Read / Write
+

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

+
+
+
+

The "leap-username" property

+
  "leap-username"            gchar*                : Read / Write
+

+The login username for legacy LEAP connections (ie, key-mgmt = +"ieee8021x" and auth-alg = "leap"). +

+

Default value: NULL

+
+
+
+

The "pairwise" property

+
  "pairwise"                 GStrv                 : Read / Write
+

+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 "tkip" or "ccmp". +

+
+
+
+

The "proto" property

+
  "proto"                    GStrv                 : Read / Write
+

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

+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 Wi-Fi network. +

+

Default value: NULL

+
+
+
+

The "psk-flags" property

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

+Flags indicating how to handle the "psk" +property. +

+
+
+
+

The "wep-key-flags" property

+
  "wep-key-flags"            NMSettingSecretFlags  : Read / Write
+

+Flags indicating how to handle the "wep-key0", +"wep-key1", "wep-key2", +and "wep-key3" properties. +

+
+
+
+

The "wep-key-type" property

+
  "wep-key-type"             NMWepKeyType          : Read / Write / Construct
+

+Controls the interpretation of WEP keys. Allowed values are +NM_WEP_KEY_TYPE_KEY, in which case the key is either a 10- or +26-character hexadecimal string, or a 5- or 13-character ASCII password; +or NM_WEP_KEY_TYPE_PASSPHRASE, in which case the passphrase is provided +as a string and will be hashed using the de-facto MD5 method to derive +the actual WEP key. +

+

Default value: NM_WEP_KEY_TYPE_UNKNOWN

+
+
+
+

The "wep-key0" property

+
  "wep-key0"                 gchar*                : Read / Write
+

+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
+

+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
+

+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
+

+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
+

+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. +

+

Allowed values: <= 3

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMSimpleConnection.html b/docs/libnm/html/NMSimpleConnection.html new file mode 100644 index 00000000..c017881e --- /dev/null +++ b/docs/libnm/html/NMSimpleConnection.html @@ -0,0 +1,175 @@ + + + + +NMSimpleConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSimpleConnection

+

NMSimpleConnection

+
+
+

Synopsis

+
struct              NMSimpleConnection;
+                    NMSimpleConnectionClass;
+NMConnection *      nm_simple_connection_new            (void);
+NMConnection *      nm_simple_connection_new_from_dbus  (GVariant *dict,
+                                                         GError **error);
+NMConnection *      nm_simple_connection_new_clone      (NMConnection *connection);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSimpleConnection
+
+
+
+

Implemented Interfaces

+

+NMSimpleConnection implements + NMConnection.

+
+
+

Description

+

+

+
+
+

Details

+
+

struct NMSimpleConnection

+
struct NMSimpleConnection;
+

+

+
+
+
+

NMSimpleConnectionClass

+
typedef struct {
+	GObjectClass parent_class;
+} NMSimpleConnectionClass;
+
+

+

+
+
+
+

nm_simple_connection_new ()

+
NMConnection *      nm_simple_connection_new            (void);
+

+Creates a new NMSimpleConnection object with no NMSetting objects. An +NMSimpleConnection does not directly represent a D-Bus-exported connection, +but might be used in the process of creating a new one. +

+
++++ + + + + +

Returns :

the new empty NMConnection object. [transfer full] +
+
+
+
+

nm_simple_connection_new_from_dbus ()

+
NMConnection *      nm_simple_connection_new_from_dbus  (GVariant *dict,
+                                                         GError **error);
+

+Creates a new NMSimpleConnection from a hash table describing the +connection. See nm_connection_to_dbus() for a description of the expected +hash table. +

+
++++ + + + + + + + + + + + + + + +

dict :

a GVariant of type NM_VARIANT_TYPE_CONNECTION describing the connection

error :

on unsuccessful return, an error

Returns :

the new NMSimpleConnection object, populated with +settings created from the values in the hash table, or NULL if the +connection failed to validate. [transfer full] +
+
+
+
+

nm_simple_connection_new_clone ()

+
NMConnection *      nm_simple_connection_new_clone      (NMConnection *connection);
+

+Clones an NMConnection as an NMSimpleConnection. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection to clone

Returns :

a new NMConnection containing the same settings +and properties as the source NMConnection. [transfer full] +
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMVpnConnection.html b/docs/libnm/html/NMVpnConnection.html new file mode 100644 index 00000000..33abdad9 --- /dev/null +++ b/docs/libnm/html/NMVpnConnection.html @@ -0,0 +1,233 @@ + + + + +NMVpnConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMVpnConnection

+

NMVpnConnection

+
+
+

Synopsis

+
#define             NM_VPN_CONNECTION_VPN_STATE
+#define             NM_VPN_CONNECTION_BANNER
+struct              NMVpnConnection;
+                    NMVpnConnectionClass;
+NMVpnConnectionState nm_vpn_connection_get_vpn_state    (NMVpnConnection *vpn);
+const char *        nm_vpn_connection_get_banner        (NMVpnConnection *vpn);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMActiveConnection
+               +----NMVpnConnection
+
+
+
+

Implemented Interfaces

+

+NMVpnConnection implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "banner"                   gchar*                : Read
+  "vpn-state"                NMVpnConnectionState  : Read
+
+
+
+

Signals

+
+  "vpn-state-changed"                              : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_VPN_CONNECTION_VPN_STATE

+
#define NM_VPN_CONNECTION_VPN_STATE "vpn-state"
+
+

+

+
+
+
+

NM_VPN_CONNECTION_BANNER

+
#define NM_VPN_CONNECTION_BANNER "banner"
+
+

+

+
+
+
+

struct NMVpnConnection

+
struct NMVpnConnection;
+

+

+
+
+
+

NMVpnConnectionClass

+
typedef struct {
+	NMActiveConnectionClass parent;
+
+	/* Signals */
+	void (*vpn_state_changed) (NMVpnConnection *connection,
+	                           NMVpnConnectionState state,
+	                           NMVpnConnectionStateReason reason);
+} NMVpnConnectionClass;
+
+

+

+
+
+
+

nm_vpn_connection_get_vpn_state ()

+
NMVpnConnectionState nm_vpn_connection_get_vpn_state    (NMVpnConnection *vpn);
+

+Gets the current NMVpnConnection state. +

+
++++ + + + + + + + + + + +

vpn :

a NMVpnConnection +

Returns :

the VPN state of the active VPN connection.
+
+
+
+

nm_vpn_connection_get_banner ()

+
const char *        nm_vpn_connection_get_banner        (NMVpnConnection *vpn);
+

+Gets the VPN login banner of the active NMVpnConnection. +

+
++++ + + + + + + + + + + +

vpn :

a NMVpnConnection +

Returns :

the VPN login banner of the VPN connection. This is the internal +string used by the connection, and must not be modified.
+
+
+
+

Property Details

+
+

The "banner" property

+
  "banner"                   gchar*                : Read
+

+The VPN login banner of the active VPN connection. +

+

Default value: NULL

+
+
+
+

The "vpn-state" property

+
  "vpn-state"                NMVpnConnectionState  : Read
+

+The VPN state of the active VPN connection. +

+

Default value: NM_VPN_CONNECTION_STATE_UNKNOWN

+
+
+
+

Signal Details

+
+

The "vpn-state-changed" signal

+
void                user_function                      (NMVpnConnection *nmvpnconnection,
+                                                        guint            arg1,
+                                                        guint            arg2,
+                                                        gpointer         user_data)            : Run First
+

+

+
++++ + + + + + + + + + + +

nmvpnconnection :

the object which received the signal.

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/NMWimaxNsp.html b/docs/libnm/html/NMWimaxNsp.html new file mode 100644 index 00000000..fa705867 --- /dev/null +++ b/docs/libnm/html/NMWimaxNsp.html @@ -0,0 +1,357 @@ + + + + +NMWimaxNsp + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMWimaxNsp

+

NMWimaxNsp

+
+
+

Synopsis

+
#define             NM_WIMAX_NSP_NAME
+#define             NM_WIMAX_NSP_SIGNAL_QUALITY
+#define             NM_WIMAX_NSP_NETWORK_TYPE
+enum                NMWimaxNspNetworkType;
+struct              NMWimaxNsp;
+                    NMWimaxNspClass;
+const char *        nm_wimax_nsp_get_name               (NMWimaxNsp *nsp);
+guint32             nm_wimax_nsp_get_signal_quality     (NMWimaxNsp *nsp);
+NMWimaxNspNetworkType nm_wimax_nsp_get_network_type     (NMWimaxNsp *nsp);
+GPtrArray *         nm_wimax_nsp_filter_connections     (NMWimaxNsp *nsp,
+                                                         const GPtrArray *connections);
+gboolean            nm_wimax_nsp_connection_valid       (NMWimaxNsp *nsp,
+                                                         NMConnection *connection);
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMWimaxNspNetworkType
+
+
+  GObject
+   +----NMObject
+         +----NMWimaxNsp
+
+
+
+

Implemented Interfaces

+

+NMWimaxNsp implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "name"                     gchar*                : Read
+  "network-type"             NMWimaxNspNetworkType  : Read
+  "signal-quality"           guint                 : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_WIMAX_NSP_NAME

+
#define NM_WIMAX_NSP_NAME           "name"
+
+

+

+
+
+
+

NM_WIMAX_NSP_SIGNAL_QUALITY

+
#define NM_WIMAX_NSP_SIGNAL_QUALITY "signal-quality"
+
+

+

+
+
+
+

NM_WIMAX_NSP_NETWORK_TYPE

+
#define NM_WIMAX_NSP_NETWORK_TYPE   "network-type"
+
+

+

+
+
+
+

enum NMWimaxNspNetworkType

+
typedef enum {
+	NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN         = 0,
+	NM_WIMAX_NSP_NETWORK_TYPE_HOME            = 1,
+	NM_WIMAX_NSP_NETWORK_TYPE_PARTNER         = 2,
+	NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 3
+} NMWimaxNspNetworkType;
+
+

+WiMAX network type. +

+
++++ + + + + + + + + + + + + + + + + + + +

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

unknown network type +

NM_WIMAX_NSP_NETWORK_TYPE_HOME

home network +

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

partner network +

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

roaming partner network +
+
+
+
+

struct NMWimaxNsp

+
struct NMWimaxNsp;
+

+

+
+
+
+

NMWimaxNspClass

+
typedef struct {
+	NMObjectClass parent;
+} NMWimaxNspClass;
+
+

+

+
+
+
+

nm_wimax_nsp_get_name ()

+
const char *        nm_wimax_nsp_get_name               (NMWimaxNsp *nsp);
+

+Gets the name of the wimax NSP +

+
++++ + + + + + + + + + + +

nsp :

a NMWimaxNsp +

Returns :

the name
+
+
+
+

nm_wimax_nsp_get_signal_quality ()

+
guint32             nm_wimax_nsp_get_signal_quality     (NMWimaxNsp *nsp);
+

+Gets the WPA signal quality of the wimax NSP. +

+
++++ + + + + + + + + + + +

nsp :

a NMWimaxNsp +

Returns :

the signal quality
+
+
+
+

nm_wimax_nsp_get_network_type ()

+
NMWimaxNspNetworkType nm_wimax_nsp_get_network_type     (NMWimaxNsp *nsp);
+

+Gets the network type of the wimax NSP. +

+
++++ + + + + + + + + + + +

nsp :

a NMWimaxNsp +

Returns :

the network type
+
+
+
+

nm_wimax_nsp_filter_connections ()

+
GPtrArray *         nm_wimax_nsp_filter_connections     (NMWimaxNsp *nsp,
+                                                         const GPtrArray *connections);
+

+Filters a given array of connections for a given NMWimaxNsp object and +return connections which may be activated with the NSP. Any returned +connections will match the nsp's network name and other attributes. +

+
++++ + + + + + + + + + + + + + + +

nsp :

an NMWimaxNsp to filter connections for

connections :

an array of NMConnections to +filter. [element-type NMConnection] +

Returns :

an array of +NMConnections that could be activated with the given nsp. The array should +be freed with g_ptr_array_unref() when it is no longer required. [transfer container][element-type NMConnection] +
+
+
+
+

nm_wimax_nsp_connection_valid ()

+
gboolean            nm_wimax_nsp_connection_valid       (NMWimaxNsp *nsp,
+                                                         NMConnection *connection);
+

+Validates a given connection against a given WiMAX NSP to ensure that the +connection may be activated with that NSP. The connection must match the +nsp's network name and other attributes. +

+
++++ + + + + + + + + + + + + + + +

nsp :

an NMWimaxNsp to validate connection against

connection :

an NMConnection to validate against nsp +

Returns :

 +TRUE if the connection may be activated with this WiMAX NSP, +FALSE if it cannot be.
+
+
+
+

Property Details

+
+

The "name" property

+
  "name"                     gchar*                : Read
+

+The name of the WiMAX NSP. +

+

Default value: NULL

+
+
+
+

The "network-type" property

+
  "network-type"             NMWimaxNspNetworkType  : Read
+

+The network type of the WiMAX NSP. +

+

Default value: NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

+
+
+
+

The "signal-quality" property

+
  "signal-quality"           guint                 : Read
+

+The signal quality of the WiMAX NSP. +

+

Allowed values: <= 100

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/annotation-glossary.html b/docs/libnm/html/annotation-glossary.html new file mode 100644 index 00000000..11787bca --- /dev/null +++ b/docs/libnm/html/annotation-glossary.html @@ -0,0 +1,77 @@ + + + + +Annotation Glossary + + + + + + + + + + + + + + + + + + +
+

+Annotation Glossary

+

A

+
allow-none
+

NULL is ok, both for passing and for returning.

+
array
+

Parameter points to an array of items.

+

C

+
closure
+

This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.

+

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.

+

S

+
scope async
+

The callback is valid until first called.

+
scope call
+

The callback is valid only during the call to the method.

+

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.

+
type
+

Override the parsed C type with given type.

+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/api-index-full.html b/docs/libnm/html/api-index-full.html new file mode 100644 index 00000000..c0db3a8b --- /dev/null +++ b/docs/libnm/html/api-index-full.html @@ -0,0 +1,7247 @@ + + + + +API Index + + + + + + + + + + + + + + + + + + + +
+

+API Index

+

8

+
+NM80211ApFlags, enum in nm-dbus-interface +
+
+
+NM80211ApSecurityFlags, enum in nm-dbus-interface +
+
+
+NM80211Mode, enum in nm-dbus-interface +
+
+

A

+
+NMAccessPoint, struct in NMAccessPoint +
+
+
+NMAccessPoint:bssid, object property in NMAccessPoint +
+
+
+NMAccessPoint:flags, object property in NMAccessPoint +
+
+
+NMAccessPoint:frequency, object property in NMAccessPoint +
+
+
+NMAccessPoint:hw-address, object property in NMAccessPoint +
+
+
+NMAccessPoint:max-bitrate, object property in NMAccessPoint +
+
+
+NMAccessPoint:mode, object property in NMAccessPoint +
+
+
+NMAccessPoint:rsn-flags, object property in NMAccessPoint +
+
+
+NMAccessPoint:ssid, object property in NMAccessPoint +
+
+
+NMAccessPoint:strength, object property in NMAccessPoint +
+
+
+NMAccessPoint:wpa-flags, object property in NMAccessPoint +
+
+
+NMAccessPointClass, struct in NMAccessPoint +
+
+
+NM_ACCESS_POINT_BSSID, macro in NMAccessPoint +
+
+
+nm_access_point_connection_valid, function in NMAccessPoint +
+
+
+nm_access_point_filter_connections, function in NMAccessPoint +
+
+
+NM_ACCESS_POINT_FLAGS, macro in NMAccessPoint +
+
+
+NM_ACCESS_POINT_FREQUENCY, macro in NMAccessPoint +
+
+
+nm_access_point_get_bssid, function in NMAccessPoint +
+
+
+nm_access_point_get_flags, function in NMAccessPoint +
+
+
+nm_access_point_get_frequency, function in NMAccessPoint +
+
+
+nm_access_point_get_max_bitrate, function in NMAccessPoint +
+
+
+nm_access_point_get_mode, function in NMAccessPoint +
+
+
+nm_access_point_get_rsn_flags, function in NMAccessPoint +
+
+
+nm_access_point_get_ssid, function in NMAccessPoint +
+
+
+nm_access_point_get_strength, function in NMAccessPoint +
+
+
+nm_access_point_get_wpa_flags, function in NMAccessPoint +
+
+
+NM_ACCESS_POINT_HW_ADDRESS, macro in NMAccessPoint +
+
+
+NM_ACCESS_POINT_MAX_BITRATE, macro in NMAccessPoint +
+
+
+NM_ACCESS_POINT_MODE, macro in NMAccessPoint +
+
+
+NM_ACCESS_POINT_RSN_FLAGS, macro in NMAccessPoint +
+
+
+NM_ACCESS_POINT_SSID, macro in NMAccessPoint +
+
+
+NM_ACCESS_POINT_STRENGTH, macro in NMAccessPoint +
+
+
+NM_ACCESS_POINT_WPA_FLAGS, macro in NMAccessPoint +
+
+
+NMActiveConnection, struct in NMActiveConnection +
+
+
+NMActiveConnection:connection, object property in NMActiveConnection +
+
+
+NMActiveConnection:default, object property in NMActiveConnection +
+
+
+NMActiveConnection:default6, object property in NMActiveConnection +
+
+
+NMActiveConnection:devices, object property in NMActiveConnection +
+
+
+NMActiveConnection:dhcp4-config, object property in NMActiveConnection +
+
+
+NMActiveConnection:dhcp6-config, object property in NMActiveConnection +
+
+
+NMActiveConnection:id, object property in NMActiveConnection +
+
+
+NMActiveConnection:ip4-config, object property in NMActiveConnection +
+
+
+NMActiveConnection:ip6-config, object property in NMActiveConnection +
+
+
+NMActiveConnection:master, object property in NMActiveConnection +
+
+
+NMActiveConnection:specific-object-path, object property in NMActiveConnection +
+
+
+NMActiveConnection:state, object property in NMActiveConnection +
+
+
+NMActiveConnection:type, object property in NMActiveConnection +
+
+
+NMActiveConnection:uuid, object property in NMActiveConnection +
+
+
+NMActiveConnection:vpn, object property in NMActiveConnection +
+
+
+NMActiveConnectionClass, struct in NMActiveConnection +
+
+
+NMActiveConnectionState, enum in nm-dbus-interface +
+
+
+NM_ACTIVE_CONNECTION_CONNECTION, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_DEFAULT, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_DEFAULT6, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_DEVICES, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_DHCP4_CONFIG, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_DHCP6_CONFIG, macro in NMActiveConnection +
+
+
+nm_active_connection_get_connection, function in NMActiveConnection +
+
+
+nm_active_connection_get_connection_type, function in NMActiveConnection +
+
+
+nm_active_connection_get_default, function in NMActiveConnection +
+
+
+nm_active_connection_get_default6, function in NMActiveConnection +
+
+
+nm_active_connection_get_devices, function in NMActiveConnection +
+
+
+nm_active_connection_get_dhcp4_config, function in NMActiveConnection +
+
+
+nm_active_connection_get_dhcp6_config, function in NMActiveConnection +
+
+
+nm_active_connection_get_id, function in NMActiveConnection +
+
+
+nm_active_connection_get_ip4_config, function in NMActiveConnection +
+
+
+nm_active_connection_get_ip6_config, function in NMActiveConnection +
+
+
+nm_active_connection_get_master, function in NMActiveConnection +
+
+
+nm_active_connection_get_specific_object_path, function in NMActiveConnection +
+
+
+nm_active_connection_get_state, function in NMActiveConnection +
+
+
+nm_active_connection_get_uuid, function in NMActiveConnection +
+
+
+nm_active_connection_get_vpn, function in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_ID, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_IP4_CONFIG, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_IP6_CONFIG, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_MASTER, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_STATE, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_TYPE, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_UUID, macro in NMActiveConnection +
+
+
+NM_ACTIVE_CONNECTION_VPN, macro in NMActiveConnection +
+
+
+NMAgentManagerError, enum in nm-errors +
+
+
+NM_AGENT_MANAGER_ERROR, macro in nm-errors +
+
+
+nm_agent_manager_error_quark, function in nm-errors +
+
+
+NM_AVAILABLE_IN_0_9_10, macro in nm-version +
+
+
+NM_AVAILABLE_IN_1_0, macro in nm-version +
+
+

B

+
+NMBluetoothCapabilities, enum in nm-dbus-interface +
+
+

C

+
+NM_CHECK_VERSION, macro in nm-version +
+
+
+NMClient, struct in NMClient +
+
+
+NMClient::connection-added, object signal in NMClient +
+
+
+NMClient::connection-removed, object signal in NMClient +
+
+
+NMClient::device-added, object signal in NMClient +
+
+
+NMClient::device-removed, object signal in NMClient +
+
+
+NMClient::permission-changed, object signal in NMClient +
+
+
+NMClient:activating-connection, object property in NMClient +
+
+
+NMClient:active-connections, object property in NMClient +
+
+
+NMClient:can-modify, object property in NMClient +
+
+
+NMClient:connections, object property in NMClient +
+
+
+NMClient:connectivity, object property in NMClient +
+
+
+NMClient:devices, object property in NMClient +
+
+
+NMClient:hostname, object property in NMClient +
+
+
+NMClient:networking-enabled, object property in NMClient +
+
+
+NMClient:nm-running, object property in NMClient +
+
+
+NMClient:primary-connection, object property in NMClient +
+
+
+NMClient:startup, object property in NMClient +
+
+
+NMClient:state, object property in NMClient +
+
+
+NMClient:version, object property in NMClient +
+
+
+NMClient:wimax-enabled, object property in NMClient +
+
+
+NMClient:wimax-hardware-enabled, object property in NMClient +
+
+
+NMClient:wireless-enabled, object property in NMClient +
+
+
+NMClient:wireless-hardware-enabled, object property in NMClient +
+
+
+NMClient:wwan-enabled, object property in NMClient +
+
+
+NMClient:wwan-hardware-enabled, object property in NMClient +
+
+
+NMClientClass, struct in NMClient +
+
+
+NMClientError, enum in NMClient +
+
+
+NMClientPermission, enum in NMClient +
+
+
+NMClientPermissionResult, enum in NMClient +
+
+
+nm_client_activate_connection_async, function in NMClient +
+
+
+nm_client_activate_connection_finish, function in NMClient +
+
+
+NM_CLIENT_ACTIVATING_CONNECTION, macro in NMClient +
+
+
+NM_CLIENT_ACTIVE_CONNECTIONS, macro in NMClient +
+
+
+nm_client_add_and_activate_connection_async, function in NMClient +
+
+
+nm_client_add_and_activate_connection_finish, function in NMClient +
+
+
+nm_client_add_connection_async, function in NMClient +
+
+
+nm_client_add_connection_finish, function in NMClient +
+
+
+NM_CLIENT_CAN_MODIFY, macro in NMClient +
+
+
+nm_client_check_connectivity, function in NMClient +
+
+
+nm_client_check_connectivity_async, function in NMClient +
+
+
+nm_client_check_connectivity_finish, function in NMClient +
+
+
+NM_CLIENT_CONNECTIONS, macro in NMClient +
+
+
+NM_CLIENT_CONNECTION_ADDED, macro in NMClient +
+
+
+NM_CLIENT_CONNECTION_REMOVED, macro in NMClient +
+
+
+NM_CLIENT_CONNECTIVITY, macro in NMClient +
+
+
+nm_client_deactivate_connection, function in NMClient +
+
+
+nm_client_deactivate_connection_async, function in NMClient +
+
+
+nm_client_deactivate_connection_finish, function in NMClient +
+
+
+NM_CLIENT_DEVICES, macro in NMClient +
+
+
+NM_CLIENT_DEVICE_ADDED, macro in NMClient +
+
+
+NM_CLIENT_DEVICE_REMOVED, macro in NMClient +
+
+
+NM_CLIENT_ERROR, macro in NMClient +
+
+
+nm_client_error_quark, function in NMClient +
+
+
+nm_client_get_activating_connection, function in NMClient +
+
+
+nm_client_get_active_connections, function in NMClient +
+
+
+nm_client_get_connections, function in NMClient +
+
+
+nm_client_get_connection_by_id, function in NMClient +
+
+
+nm_client_get_connection_by_path, function in NMClient +
+
+
+nm_client_get_connection_by_uuid, function in NMClient +
+
+
+nm_client_get_connectivity, function in NMClient +
+
+
+nm_client_get_devices, function in NMClient +
+
+
+nm_client_get_device_by_iface, function in NMClient +
+
+
+nm_client_get_device_by_path, function in NMClient +
+
+
+nm_client_get_logging, function in NMClient +
+
+
+nm_client_get_nm_running, function in NMClient +
+
+
+nm_client_get_permission_result, function in NMClient +
+
+
+nm_client_get_primary_connection, function in NMClient +
+
+
+nm_client_get_startup, function in NMClient +
+
+
+nm_client_get_state, function in NMClient +
+
+
+nm_client_get_version, function in NMClient +
+
+
+NM_CLIENT_HOSTNAME, macro in NMClient +
+
+
+nm_client_load_connections, function in NMClient +
+
+
+nm_client_load_connections_async, function in NMClient +
+
+
+nm_client_load_connections_finish, function in NMClient +
+
+
+NM_CLIENT_NETWORKING_ENABLED, macro in NMClient +
+
+
+nm_client_networking_get_enabled, function in NMClient +
+
+
+nm_client_networking_set_enabled, function in NMClient +
+
+
+nm_client_new, function in NMClient +
+
+
+nm_client_new_async, function in NMClient +
+
+
+nm_client_new_finish, function in NMClient +
+
+
+NM_CLIENT_NM_RUNNING, macro in NMClient +
+
+
+NM_CLIENT_PERMISSION_CHANGED, macro in NMClient +
+
+
+NM_CLIENT_PRIMARY_CONNECTION, macro in NMClient +
+
+
+nm_client_reload_connections, function in NMClient +
+
+
+nm_client_reload_connections_async, function in NMClient +
+
+
+nm_client_reload_connections_finish, function in NMClient +
+
+
+nm_client_save_hostname, function in NMClient +
+
+
+nm_client_save_hostname_async, function in NMClient +
+
+
+nm_client_save_hostname_finish, function in NMClient +
+
+
+nm_client_set_logging, function in NMClient +
+
+
+NM_CLIENT_STARTUP, macro in NMClient +
+
+
+NM_CLIENT_STATE, macro in NMClient +
+
+
+NM_CLIENT_VERSION, macro in NMClient +
+
+
+NM_CLIENT_WIMAX_ENABLED, macro in NMClient +
+
+
+nm_client_wimax_get_enabled, function in NMClient +
+
+
+NM_CLIENT_WIMAX_HARDWARE_ENABLED, macro in NMClient +
+
+
+nm_client_wimax_hardware_get_enabled, function in NMClient +
+
+
+nm_client_wimax_set_enabled, function in NMClient +
+
+
+NM_CLIENT_WIRELESS_ENABLED, macro in NMClient +
+
+
+nm_client_wireless_get_enabled, function in NMClient +
+
+
+NM_CLIENT_WIRELESS_HARDWARE_ENABLED, macro in NMClient +
+
+
+nm_client_wireless_hardware_get_enabled, function in NMClient +
+
+
+nm_client_wireless_set_enabled, function in NMClient +
+
+
+NM_CLIENT_WWAN_ENABLED, macro in NMClient +
+
+
+nm_client_wwan_get_enabled, function in NMClient +
+
+
+NM_CLIENT_WWAN_HARDWARE_ENABLED, macro in NMClient +
+
+
+nm_client_wwan_hardware_get_enabled, function in NMClient +
+
+
+nm_client_wwan_set_enabled, function in NMClient +
+
+
+NMConnectionError, enum in nm-errors +
+
+
+NMConnectionInterface, struct in NMConnection +
+
+
+NMConnectionSerializationFlags, enum in NMConnection +
+
+
+nm_connection_add_setting, function in NMConnection +
+
+
+NM_CONNECTION_CHANGED, macro in NMConnection +
+
+
+nm_connection_clear_secrets, function in NMConnection +
+
+
+nm_connection_clear_secrets_with_flags, function in NMConnection +
+
+
+nm_connection_clear_settings, function in NMConnection +
+
+
+nm_connection_compare, function in NMConnection +
+
+
+nm_connection_diff, function in NMConnection +
+
+
+nm_connection_dump, function in NMConnection +
+
+
+NM_CONNECTION_ERROR, macro in nm-errors +
+
+
+nm_connection_error_quark, function in nm-errors +
+
+
+nm_connection_for_each_setting_value, function in NMConnection +
+
+
+nm_connection_get_connection_type, function in NMConnection +
+
+
+nm_connection_get_id, function in NMConnection +
+
+
+nm_connection_get_interface_name, function in NMConnection +
+
+
+nm_connection_get_path, function in NMConnection +
+
+
+nm_connection_get_setting, function in NMConnection +
+
+
+nm_connection_get_setting_802_1x, function in NMConnection +
+
+
+nm_connection_get_setting_adsl, function in NMConnection +
+
+
+nm_connection_get_setting_bluetooth, function in NMConnection +
+
+
+nm_connection_get_setting_bond, function in NMConnection +
+
+
+nm_connection_get_setting_bridge, 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_cdma, function in NMConnection +
+
+
+nm_connection_get_setting_connection, function in NMConnection +
+
+
+nm_connection_get_setting_dcb, function in NMConnection +
+
+
+nm_connection_get_setting_generic, function in NMConnection +
+
+
+nm_connection_get_setting_gsm, function in NMConnection +
+
+
+nm_connection_get_setting_infiniband, 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_olpc_mesh, function in NMConnection +
+
+
+nm_connection_get_setting_ppp, function in NMConnection +
+
+
+nm_connection_get_setting_pppoe, function in NMConnection +
+
+
+nm_connection_get_setting_serial, function in NMConnection +
+
+
+nm_connection_get_setting_team, function in NMConnection +
+
+
+nm_connection_get_setting_team_port, function in NMConnection +
+
+
+nm_connection_get_setting_vlan, function in NMConnection +
+
+
+nm_connection_get_setting_vpn, function in NMConnection +
+
+
+nm_connection_get_setting_wimax, function in NMConnection +
+
+
+nm_connection_get_setting_wired, function in NMConnection +
+
+
+nm_connection_get_setting_wireless, function in NMConnection +
+
+
+nm_connection_get_setting_wireless_security, function in NMConnection +
+
+
+nm_connection_get_uuid, function in NMConnection +
+
+
+nm_connection_get_virtual_device_description, function in NMConnection +
+
+
+nm_connection_is_type, function in NMConnection +
+
+
+nm_connection_is_virtual, function in NMConnection +
+
+
+nm_connection_need_secrets, function in NMConnection +
+
+
+nm_connection_normalize, function in NMConnection +
+
+
+NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD, macro in NMConnection +
+
+
+nm_connection_remove_setting, function in NMConnection +
+
+
+nm_connection_replace_settings, function in NMConnection +
+
+
+nm_connection_replace_settings_from_connection, function in NMConnection +
+
+
+NM_CONNECTION_SECRETS_CLEARED, macro in NMConnection +
+
+
+NM_CONNECTION_SECRETS_UPDATED, macro in NMConnection +
+
+
+nm_connection_set_path, function in NMConnection +
+
+
+nm_connection_to_dbus, function in NMConnection +
+
+
+nm_connection_update_secrets, function in NMConnection +
+
+
+nm_connection_verify, function in NMConnection +
+
+
+NMConnectivityState, enum in nm-dbus-interface +
+
+
+NMCryptoError, enum in nm-errors +
+
+
+NM_CRYPTO_ERROR, macro in nm-errors +
+
+
+nm_crypto_error_quark, function in nm-errors +
+
+

D

+
+NM_DBUS_INTERFACE, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_ACCESS_POINT, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_ACTIVE_CONNECTION, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_AGENT_MANAGER, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_ADSL, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_BLUETOOTH, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_BOND, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_BRIDGE, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_GENERIC, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_GRE, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_INFINIBAND, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_MACVLAN, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_MODEM, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_OLPC_MESH, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_TEAM, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_TUN, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_VETH, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_VLAN, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_VXLAN, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_WIMAX, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_WIRED, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DEVICE_WIRELESS, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DHCP4_CONFIG, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_DHCP6_CONFIG, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_IP4_CONFIG, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_IP6_CONFIG, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_SECRET_AGENT, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_SETTINGS, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_SETTINGS_CONNECTION, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_SETTINGS_CONNECTION_SECRETS, macro in nm-dbus-interface +
+
+
+NM_DBUS_INTERFACE_VPN, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_INTERFACE_VPN_CONNECTION, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_INTERFACE_WIMAX_NSP, macro in nm-dbus-interface +
+
+
+NM_DBUS_INVALID_VPN_CONNECTION, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_NO_ACTIVE_VPN_CONNECTION, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_NO_VPN_CONNECTIONS, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_PATH, macro in nm-dbus-interface +
+
+
+NM_DBUS_PATH_ACCESS_POINT, macro in nm-dbus-interface +
+
+
+NM_DBUS_PATH_AGENT_MANAGER, macro in nm-dbus-interface +
+
+
+NM_DBUS_PATH_SECRET_AGENT, macro in nm-dbus-interface +
+
+
+NM_DBUS_PATH_SETTINGS, macro in nm-dbus-interface +
+
+
+NM_DBUS_PATH_SETTINGS_CONNECTION, macro in nm-dbus-interface +
+
+
+NM_DBUS_PATH_VPN, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_PATH_VPN_CONNECTION, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_PATH_WIMAX_NSP, macro in nm-dbus-interface +
+
+
+NM_DBUS_SERVICE, macro in nm-dbus-interface +
+
+
+NM_DBUS_VPN_ALREADY_STARTED, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_ALREADY_STOPPED, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_BAD_ARGUMENTS, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_ERROR_PREFIX, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_INTERACTIVE_NOT_SUPPORTED, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_CONNECT_FAILED, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_IP4_CONFIG, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_IP_CONFIG_BAD, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_LAUNCH_FAILED, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_LOGIN_BANNER, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_LOGIN_FAILED, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_STATE_CHANGE, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_SIGNAL_VPN_CONFIG_BAD, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_STARTING_IN_PROGRESS, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_STOPPING_IN_PROGRESS, macro in nm-vpn-dbus-interface +
+
+
+NM_DBUS_VPN_WRONG_STATE, macro in nm-vpn-dbus-interface +
+
+
+NM_DEPRECATED_IN_0_9_10, macro in nm-version +
+
+
+NM_DEPRECATED_IN_0_9_10_FOR, macro in nm-version +
+
+
+NM_DEPRECATED_IN_1_0, macro in nm-version +
+
+
+NM_DEPRECATED_IN_1_0_FOR, macro in nm-version +
+
+
+NMDevice, struct in NMDevice +
+
+
+NMDevice::state-changed, object signal in NMDevice +
+
+
+NMDevice:active-connection, object property in NMDevice +
+
+
+NMDevice:autoconnect, object property in NMDevice +
+
+
+NMDevice:available-connections, object property in NMDevice +
+
+
+NMDevice:capabilities, object property in NMDevice +
+
+
+NMDevice:device-type, object property in NMDevice +
+
+
+NMDevice:dhcp4-config, object property in NMDevice +
+
+
+NMDevice:dhcp6-config, object property in NMDevice +
+
+
+NMDevice:driver, object property in NMDevice +
+
+
+NMDevice:driver-version, object property in NMDevice +
+
+
+NMDevice:firmware-missing, object property in NMDevice +
+
+
+NMDevice:firmware-version, object property in NMDevice +
+
+
+NMDevice:interface, object property in NMDevice +
+
+
+NMDevice:ip-interface, object property in NMDevice +
+
+
+NMDevice:ip4-config, object property in NMDevice +
+
+
+NMDevice:ip6-config, object property in NMDevice +
+
+
+NMDevice:managed, object property in NMDevice +
+
+
+NMDevice:mtu, object property in NMDevice +
+
+
+NMDevice:physical-port-id, object property in NMDevice +
+
+
+NMDevice:product, object property in NMDevice +
+
+
+NMDevice:state, object property in NMDevice +
+
+
+NMDevice:state-reason, object property in NMDevice +
+
+
+NMDevice:udi, object property in NMDevice +
+
+
+NMDevice:vendor, object property in NMDevice +
+
+
+NMDeviceAdsl, struct in NMDeviceAdsl +
+
+
+NMDeviceAdsl:carrier, object property in NMDeviceAdsl +
+
+
+NMDeviceAdslClass, struct in NMDeviceAdsl +
+
+
+NMDeviceBond, struct in NMDeviceBond +
+
+
+NMDeviceBond:carrier, object property in NMDeviceBond +
+
+
+NMDeviceBond:hw-address, object property in NMDeviceBond +
+
+
+NMDeviceBond:slaves, object property in NMDeviceBond +
+
+
+NMDeviceBondClass, struct in NMDeviceBond +
+
+
+NMDeviceBridge, struct in NMDeviceBridge +
+
+
+NMDeviceBridge:carrier, object property in NMDeviceBridge +
+
+
+NMDeviceBridge:hw-address, object property in NMDeviceBridge +
+
+
+NMDeviceBridge:slaves, object property in NMDeviceBridge +
+
+
+NMDeviceBridgeClass, struct in NMDeviceBridge +
+
+
+NMDeviceBt, struct in NMDeviceBt +
+
+
+NMDeviceBt:bt-capabilities, object property in NMDeviceBt +
+
+
+NMDeviceBt:hw-address, object property in NMDeviceBt +
+
+
+NMDeviceBt:name, object property in NMDeviceBt +
+
+
+NMDeviceBtClass, struct in NMDeviceBt +
+
+
+NMDeviceCapabilities, enum in nm-dbus-interface +
+
+
+NMDeviceClass, struct in NMDevice +
+
+
+NMDeviceError, enum in nm-errors +
+
+
+NMDeviceEthernet, struct in NMDeviceEthernet +
+
+
+NMDeviceEthernet:carrier, object property in NMDeviceEthernet +
+
+
+NMDeviceEthernet:hw-address, object property in NMDeviceEthernet +
+
+
+NMDeviceEthernet:perm-hw-address, object property in NMDeviceEthernet +
+
+
+NMDeviceEthernet:speed, object property in NMDeviceEthernet +
+
+
+NMDeviceEthernetClass, struct in NMDeviceEthernet +
+
+
+NMDeviceGeneric, struct in NMDeviceGeneric +
+
+
+NMDeviceGeneric:hw-address, object property in NMDeviceGeneric +
+
+
+NMDeviceGeneric:type-description, object property in NMDeviceGeneric +
+
+
+NMDeviceGenericClass, struct in NMDeviceGeneric +
+
+
+NMDeviceInfiniband, struct in NMDeviceInfiniband +
+
+
+NMDeviceInfiniband:carrier, object property in NMDeviceInfiniband +
+
+
+NMDeviceInfiniband:hw-address, object property in NMDeviceInfiniband +
+
+
+NMDeviceInfinibandClass, struct in NMDeviceInfiniband +
+
+
+NMDeviceModem, struct in NMDeviceModem +
+
+
+NMDeviceModem:current-capabilities, object property in NMDeviceModem +
+
+
+NMDeviceModem:modem-capabilities, object property in NMDeviceModem +
+
+
+NMDeviceModemCapabilities, enum in nm-dbus-interface +
+
+
+NMDeviceModemClass, struct in NMDeviceModem +
+
+
+NMDeviceOlpcMesh, struct in NMDeviceOlpcMesh +
+
+
+NMDeviceOlpcMesh:active-channel, object property in NMDeviceOlpcMesh +
+
+
+NMDeviceOlpcMesh:companion, object property in NMDeviceOlpcMesh +
+
+
+NMDeviceOlpcMesh:hw-address, object property in NMDeviceOlpcMesh +
+
+
+NMDeviceOlpcMeshClass, struct in NMDeviceOlpcMesh +
+
+
+NMDeviceState, enum in nm-dbus-interface +
+
+
+NMDeviceStateReason, enum in nm-dbus-interface +
+
+
+NMDeviceTeam, struct in NMDeviceTeam +
+
+
+NMDeviceTeam:carrier, object property in NMDeviceTeam +
+
+
+NMDeviceTeam:hw-address, object property in NMDeviceTeam +
+
+
+NMDeviceTeam:slaves, object property in NMDeviceTeam +
+
+
+NMDeviceTeamClass, struct in NMDeviceTeam +
+
+
+NMDeviceType, enum in nm-dbus-interface +
+
+
+NMDeviceVlan, struct in NMDeviceVlan +
+
+
+NMDeviceVlan:carrier, object property in NMDeviceVlan +
+
+
+NMDeviceVlan:hw-address, object property in NMDeviceVlan +
+
+
+NMDeviceVlan:parent, object property in NMDeviceVlan +
+
+
+NMDeviceVlan:vlan-id, object property in NMDeviceVlan +
+
+
+NMDeviceVlanClass, struct in NMDeviceVlan +
+
+
+NMDeviceWifi, struct in NMDeviceWifi +
+
+
+NMDeviceWifi::access-point-added, object signal in NMDeviceWifi +
+
+
+NMDeviceWifi::access-point-removed, object signal in NMDeviceWifi +
+
+
+NMDeviceWifi:access-points, object property in NMDeviceWifi +
+
+
+NMDeviceWifi:active-access-point, object property in NMDeviceWifi +
+
+
+NMDeviceWifi:bitrate, object property in NMDeviceWifi +
+
+
+NMDeviceWifi:hw-address, object property in NMDeviceWifi +
+
+
+NMDeviceWifi:mode, object property in NMDeviceWifi +
+
+
+NMDeviceWifi:perm-hw-address, object property in NMDeviceWifi +
+
+
+NMDeviceWifi:wireless-capabilities, object property in NMDeviceWifi +
+
+
+NMDeviceWifiCapabilities, enum in nm-dbus-interface +
+
+
+NMDeviceWifiClass, struct in NMDeviceWifi +
+
+
+NMDeviceWimax, struct in NMDeviceWimax +
+
+
+NMDeviceWimax::nsp-added, object signal in NMDeviceWimax +
+
+
+NMDeviceWimax::nsp-removed, object signal in NMDeviceWimax +
+
+
+NMDeviceWimax:active-nsp, object property in NMDeviceWimax +
+
+
+NMDeviceWimax:bsid, object property in NMDeviceWimax +
+
+
+NMDeviceWimax:center-frequency, object property in NMDeviceWimax +
+
+
+NMDeviceWimax:cinr, object property in NMDeviceWimax +
+
+
+NMDeviceWimax:hw-address, object property in NMDeviceWimax +
+
+
+NMDeviceWimax:nsps, object property in NMDeviceWimax +
+
+
+NMDeviceWimax:rssi, object property in NMDeviceWimax +
+
+
+NMDeviceWimax:tx-power, object property in NMDeviceWimax +
+
+
+NMDeviceWimaxClass, struct in NMDeviceWimax +
+
+
+NM_DEVICE_ACTIVE_CONNECTION, macro in NMDevice +
+
+
+NM_DEVICE_ADSL_CARRIER, macro in NMDeviceAdsl +
+
+
+nm_device_adsl_get_carrier, function in NMDeviceAdsl +
+
+
+NM_DEVICE_AUTOCONNECT, macro in NMDevice +
+
+
+NM_DEVICE_AVAILABLE_CONNECTIONS, macro in NMDevice +
+
+
+NM_DEVICE_BOND_CARRIER, macro in NMDeviceBond +
+
+
+nm_device_bond_get_carrier, function in NMDeviceBond +
+
+
+nm_device_bond_get_hw_address, function in NMDeviceBond +
+
+
+nm_device_bond_get_slaves, function in NMDeviceBond +
+
+
+NM_DEVICE_BOND_HW_ADDRESS, macro in NMDeviceBond +
+
+
+NM_DEVICE_BOND_SLAVES, macro in NMDeviceBond +
+
+
+NM_DEVICE_BRIDGE_CARRIER, macro in NMDeviceBridge +
+
+
+nm_device_bridge_get_carrier, function in NMDeviceBridge +
+
+
+nm_device_bridge_get_hw_address, function in NMDeviceBridge +
+
+
+nm_device_bridge_get_slaves, function in NMDeviceBridge +
+
+
+NM_DEVICE_BRIDGE_HW_ADDRESS, macro in NMDeviceBridge +
+
+
+NM_DEVICE_BRIDGE_SLAVES, macro in NMDeviceBridge +
+
+
+NM_DEVICE_BT_CAPABILITIES, macro in NMDeviceBt +
+
+
+nm_device_bt_get_capabilities, function in NMDeviceBt +
+
+
+nm_device_bt_get_hw_address, function in NMDeviceBt +
+
+
+nm_device_bt_get_name, function in NMDeviceBt +
+
+
+NM_DEVICE_BT_HW_ADDRESS, macro in NMDeviceBt +
+
+
+NM_DEVICE_BT_NAME, macro in NMDeviceBt +
+
+
+NM_DEVICE_CAPABILITIES, macro in NMDevice +
+
+
+nm_device_connection_compatible, function in NMDevice +
+
+
+nm_device_connection_valid, function in NMDevice +
+
+
+nm_device_delete, function in NMDevice +
+
+
+nm_device_delete_async, function in NMDevice +
+
+
+nm_device_delete_finish, function in NMDevice +
+
+
+NM_DEVICE_DEVICE_TYPE, macro in NMDevice +
+
+
+NM_DEVICE_DHCP4_CONFIG, macro in NMDevice +
+
+
+NM_DEVICE_DHCP6_CONFIG, macro in NMDevice +
+
+
+nm_device_disambiguate_names, function in NMDevice +
+
+
+nm_device_disconnect, function in NMDevice +
+
+
+nm_device_disconnect_async, function in NMDevice +
+
+
+nm_device_disconnect_finish, function in NMDevice +
+
+
+NM_DEVICE_DRIVER, macro in NMDevice +
+
+
+NM_DEVICE_DRIVER_VERSION, macro in NMDevice +
+
+
+NM_DEVICE_ERROR, macro in nm-errors +
+
+
+nm_device_error_quark, function in nm-errors +
+
+
+NM_DEVICE_ETHERNET_CARRIER, macro in NMDeviceEthernet +
+
+
+nm_device_ethernet_get_carrier, function in NMDeviceEthernet +
+
+
+nm_device_ethernet_get_hw_address, function in NMDeviceEthernet +
+
+
+nm_device_ethernet_get_permanent_hw_address, function in NMDeviceEthernet +
+
+
+nm_device_ethernet_get_speed, function in NMDeviceEthernet +
+
+
+NM_DEVICE_ETHERNET_HW_ADDRESS, macro in NMDeviceEthernet +
+
+
+NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS, macro in NMDeviceEthernet +
+
+
+NM_DEVICE_ETHERNET_SPEED, macro in NMDeviceEthernet +
+
+
+nm_device_filter_connections, function in NMDevice +
+
+
+NM_DEVICE_FIRMWARE_MISSING, macro in NMDevice +
+
+
+NM_DEVICE_FIRMWARE_VERSION, macro in NMDevice +
+
+
+nm_device_generic_get_hw_address, function in NMDeviceGeneric +
+
+
+NM_DEVICE_GENERIC_HW_ADDRESS, macro in NMDeviceGeneric +
+
+
+NM_DEVICE_GENERIC_TYPE_DESCRIPTION, macro in NMDeviceGeneric +
+
+
+nm_device_get_active_connection, function in NMDevice +
+
+
+nm_device_get_autoconnect, function in NMDevice +
+
+
+nm_device_get_available_connections, function in NMDevice +
+
+
+nm_device_get_capabilities, function in NMDevice +
+
+
+nm_device_get_description, function in NMDevice +
+
+
+nm_device_get_device_type, function in NMDevice +
+
+
+nm_device_get_dhcp4_config, function in NMDevice +
+
+
+nm_device_get_dhcp6_config, function in NMDevice +
+
+
+nm_device_get_driver, function in NMDevice +
+
+
+nm_device_get_driver_version, function in NMDevice +
+
+
+nm_device_get_firmware_missing, function in NMDevice +
+
+
+nm_device_get_firmware_version, function in NMDevice +
+
+
+nm_device_get_hw_address, function in NMDevice +
+
+
+nm_device_get_iface, function in NMDevice +
+
+
+nm_device_get_ip4_config, function in NMDevice +
+
+
+nm_device_get_ip6_config, function in NMDevice +
+
+
+nm_device_get_ip_iface, function in NMDevice +
+
+
+nm_device_get_managed, function in NMDevice +
+
+
+nm_device_get_mtu, function in NMDevice +
+
+
+nm_device_get_physical_port_id, function in NMDevice +
+
+
+nm_device_get_product, function in NMDevice +
+
+
+nm_device_get_setting_type, function in NMDevice +
+
+
+nm_device_get_state, function in NMDevice +
+
+
+nm_device_get_state_reason, function in NMDevice +
+
+
+nm_device_get_type_description, function in NMDevice +
+
+
+nm_device_get_udi, function in NMDevice +
+
+
+nm_device_get_vendor, function in NMDevice +
+
+
+NM_DEVICE_INFINIBAND_CARRIER, macro in NMDeviceInfiniband +
+
+
+nm_device_infiniband_get_carrier, function in NMDeviceInfiniband +
+
+
+nm_device_infiniband_get_hw_address, function in NMDeviceInfiniband +
+
+
+NM_DEVICE_INFINIBAND_HW_ADDRESS, macro in NMDeviceInfiniband +
+
+
+NM_DEVICE_INTERFACE, macro in NMDevice +
+
+
+NM_DEVICE_IP4_CONFIG, macro in NMDevice +
+
+
+NM_DEVICE_IP6_CONFIG, macro in NMDevice +
+
+
+NM_DEVICE_IP_INTERFACE, macro in NMDevice +
+
+
+nm_device_is_software, function in NMDevice +
+
+
+NM_DEVICE_MANAGED, macro in NMDevice +
+
+
+NM_DEVICE_MODEM_CURRENT_CAPABILITIES, macro in NMDeviceModem +
+
+
+nm_device_modem_get_current_capabilities, function in NMDeviceModem +
+
+
+nm_device_modem_get_modem_capabilities, function in NMDeviceModem +
+
+
+NM_DEVICE_MODEM_MODEM_CAPABILITIES, macro in NMDeviceModem +
+
+
+NM_DEVICE_MTU, macro in NMDevice +
+
+
+NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL, macro in NMDeviceOlpcMesh +
+
+
+NM_DEVICE_OLPC_MESH_COMPANION, macro in NMDeviceOlpcMesh +
+
+
+nm_device_olpc_mesh_get_active_channel, function in NMDeviceOlpcMesh +
+
+
+nm_device_olpc_mesh_get_companion, function in NMDeviceOlpcMesh +
+
+
+nm_device_olpc_mesh_get_hw_address, function in NMDeviceOlpcMesh +
+
+
+NM_DEVICE_OLPC_MESH_HW_ADDRESS, macro in NMDeviceOlpcMesh +
+
+
+NM_DEVICE_PHYSICAL_PORT_ID, macro in NMDevice +
+
+
+NM_DEVICE_PRODUCT, macro in NMDevice +
+
+
+nm_device_set_autoconnect, function in NMDevice +
+
+
+NM_DEVICE_STATE, macro in NMDevice +
+
+
+NM_DEVICE_STATE_REASON, macro in NMDevice +
+
+
+NM_DEVICE_TEAM_CARRIER, macro in NMDeviceTeam +
+
+
+nm_device_team_get_carrier, function in NMDeviceTeam +
+
+
+nm_device_team_get_hw_address, function in NMDeviceTeam +
+
+
+nm_device_team_get_slaves, function in NMDeviceTeam +
+
+
+NM_DEVICE_TEAM_HW_ADDRESS, macro in NMDeviceTeam +
+
+
+NM_DEVICE_TEAM_SLAVES, macro in NMDeviceTeam +
+
+
+NM_DEVICE_UDI, macro in NMDevice +
+
+
+NM_DEVICE_VENDOR, macro in NMDevice +
+
+
+NM_DEVICE_VLAN_CARRIER, macro in NMDeviceVlan +
+
+
+nm_device_vlan_get_carrier, function in NMDeviceVlan +
+
+
+nm_device_vlan_get_hw_address, function in NMDeviceVlan +
+
+
+nm_device_vlan_get_parent, function in NMDeviceVlan +
+
+
+nm_device_vlan_get_vlan_id, function in NMDeviceVlan +
+
+
+NM_DEVICE_VLAN_HW_ADDRESS, macro in NMDeviceVlan +
+
+
+NM_DEVICE_VLAN_PARENT, macro in NMDeviceVlan +
+
+
+NM_DEVICE_VLAN_VLAN_ID, macro in NMDeviceVlan +
+
+
+NM_DEVICE_WIFI_ACCESS_POINTS, macro in NMDeviceWifi +
+
+
+NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT, macro in NMDeviceWifi +
+
+
+NM_DEVICE_WIFI_BITRATE, macro in NMDeviceWifi +
+
+
+NM_DEVICE_WIFI_CAPABILITIES, macro in NMDeviceWifi +
+
+
+nm_device_wifi_get_access_points, function in NMDeviceWifi +
+
+
+nm_device_wifi_get_access_point_by_path, function in NMDeviceWifi +
+
+
+nm_device_wifi_get_active_access_point, function in NMDeviceWifi +
+
+
+nm_device_wifi_get_bitrate, function in NMDeviceWifi +
+
+
+nm_device_wifi_get_capabilities, function in NMDeviceWifi +
+
+
+nm_device_wifi_get_hw_address, function in NMDeviceWifi +
+
+
+nm_device_wifi_get_mode, function in NMDeviceWifi +
+
+
+nm_device_wifi_get_permanent_hw_address, function in NMDeviceWifi +
+
+
+NM_DEVICE_WIFI_HW_ADDRESS, macro in NMDeviceWifi +
+
+
+NM_DEVICE_WIFI_MODE, macro in NMDeviceWifi +
+
+
+NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS, macro in NMDeviceWifi +
+
+
+nm_device_wifi_request_scan, function in NMDeviceWifi +
+
+
+nm_device_wifi_request_scan_async, function in NMDeviceWifi +
+
+
+nm_device_wifi_request_scan_finish, function in NMDeviceWifi +
+
+
+NM_DEVICE_WIMAX_ACTIVE_NSP, macro in NMDeviceWimax +
+
+
+NM_DEVICE_WIMAX_BSID, macro in NMDeviceWimax +
+
+
+NM_DEVICE_WIMAX_CENTER_FREQUENCY, macro in NMDeviceWimax +
+
+
+NM_DEVICE_WIMAX_CINR, macro in NMDeviceWimax +
+
+
+nm_device_wimax_get_active_nsp, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_bsid, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_center_frequency, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_cinr, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_hw_address, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_nsps, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_nsp_by_path, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_rssi, function in NMDeviceWimax +
+
+
+nm_device_wimax_get_tx_power, function in NMDeviceWimax +
+
+
+NM_DEVICE_WIMAX_HW_ADDRESS, macro in NMDeviceWimax +
+
+
+NM_DEVICE_WIMAX_NSPS, macro in NMDeviceWimax +
+
+
+NM_DEVICE_WIMAX_RSSI, macro in NMDeviceWimax +
+
+
+NM_DEVICE_WIMAX_TX_POWER, macro in NMDeviceWimax +
+
+
+NMDhcpConfig, struct in NMDhcpConfig +
+
+
+NMDhcpConfig:family, object property in NMDhcpConfig +
+
+
+NMDhcpConfig:options, object property in NMDhcpConfig +
+
+
+NMDhcpConfigClass, struct in NMDhcpConfig +
+
+
+NM_DHCP_CONFIG_FAMILY, macro in NMDhcpConfig +
+
+
+nm_dhcp_config_get_family, function in NMDhcpConfig +
+
+
+nm_dhcp_config_get_one_option, function in NMDhcpConfig +
+
+
+nm_dhcp_config_get_options, function in NMDhcpConfig +
+
+
+NM_DHCP_CONFIG_OPTIONS, macro in NMDhcpConfig +
+
+

E

+
+NM_ENCODE_VERSION, macro in nm-version +
+
+

I

+
+NMIPAddress, typedef in NMSettingIPConfig +
+
+
+NMIPConfig, struct in NMIPConfig +
+
+
+NMIPConfig:addresses, object property in NMIPConfig +
+
+
+NMIPConfig:domains, object property in NMIPConfig +
+
+
+NMIPConfig:family, object property in NMIPConfig +
+
+
+NMIPConfig:gateway, object property in NMIPConfig +
+
+
+NMIPConfig:nameservers, object property in NMIPConfig +
+
+
+NMIPConfig:routes, object property in NMIPConfig +
+
+
+NMIPConfig:searches, object property in NMIPConfig +
+
+
+NMIPConfig:wins-servers, object property in NMIPConfig +
+
+
+NMIPConfigClass, struct in NMIPConfig +
+
+
+NMIPRoute, typedef in NMSettingIPConfig +
+
+
+nm_ip_address_dup, function in NMSettingIPConfig +
+
+
+nm_ip_address_equal, function in NMSettingIPConfig +
+
+
+nm_ip_address_get_address, function in NMSettingIPConfig +
+
+
+nm_ip_address_get_address_binary, function in NMSettingIPConfig +
+
+
+nm_ip_address_get_attribute, function in NMSettingIPConfig +
+
+
+nm_ip_address_get_attribute_names, function in NMSettingIPConfig +
+
+
+nm_ip_address_get_family, function in NMSettingIPConfig +
+
+
+nm_ip_address_get_prefix, function in NMSettingIPConfig +
+
+
+nm_ip_address_new, function in NMSettingIPConfig +
+
+
+nm_ip_address_new_binary, function in NMSettingIPConfig +
+
+
+nm_ip_address_ref, function in NMSettingIPConfig +
+
+
+nm_ip_address_set_address, function in NMSettingIPConfig +
+
+
+nm_ip_address_set_address_binary, function in NMSettingIPConfig +
+
+
+nm_ip_address_set_attribute, function in NMSettingIPConfig +
+
+
+nm_ip_address_set_prefix, function in NMSettingIPConfig +
+
+
+nm_ip_address_unref, function in NMSettingIPConfig +
+
+
+NM_IP_CONFIG_ADDRESSES, macro in NMIPConfig +
+
+
+NM_IP_CONFIG_DOMAINS, macro in NMIPConfig +
+
+
+NM_IP_CONFIG_FAMILY, macro in NMIPConfig +
+
+
+NM_IP_CONFIG_GATEWAY, macro in NMIPConfig +
+
+
+nm_ip_config_get_addresses, function in NMIPConfig +
+
+
+nm_ip_config_get_domains, function in NMIPConfig +
+
+
+nm_ip_config_get_family, function in NMIPConfig +
+
+
+nm_ip_config_get_gateway, function in NMIPConfig +
+
+
+nm_ip_config_get_nameservers, function in NMIPConfig +
+
+
+nm_ip_config_get_routes, function in NMIPConfig +
+
+
+nm_ip_config_get_searches, function in NMIPConfig +
+
+
+nm_ip_config_get_wins_servers, function in NMIPConfig +
+
+
+NM_IP_CONFIG_NAMESERVERS, macro in NMIPConfig +
+
+
+NM_IP_CONFIG_ROUTES, macro in NMIPConfig +
+
+
+NM_IP_CONFIG_SEARCHES, macro in NMIPConfig +
+
+
+NM_IP_CONFIG_WINS_SERVERS, macro in NMIPConfig +
+
+
+nm_ip_route_dup, function in NMSettingIPConfig +
+
+
+nm_ip_route_equal, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_attribute, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_attribute_names, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_dest, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_dest_binary, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_family, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_metric, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_next_hop, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_next_hop_binary, function in NMSettingIPConfig +
+
+
+nm_ip_route_get_prefix, function in NMSettingIPConfig +
+
+
+nm_ip_route_new, function in NMSettingIPConfig +
+
+
+nm_ip_route_new_binary, function in NMSettingIPConfig +
+
+
+nm_ip_route_ref, function in NMSettingIPConfig +
+
+
+nm_ip_route_set_attribute, function in NMSettingIPConfig +
+
+
+nm_ip_route_set_dest, function in NMSettingIPConfig +
+
+
+nm_ip_route_set_dest_binary, function in NMSettingIPConfig +
+
+
+nm_ip_route_set_metric, function in NMSettingIPConfig +
+
+
+nm_ip_route_set_next_hop, function in NMSettingIPConfig +
+
+
+nm_ip_route_set_next_hop_binary, function in NMSettingIPConfig +
+
+
+nm_ip_route_set_prefix, function in NMSettingIPConfig +
+
+
+nm_ip_route_unref, function in NMSettingIPConfig +
+
+

M

+
+NM_MAJOR_VERSION, macro in nm-version +
+
+
+NMManagerError, enum in nm-errors +
+
+
+NM_MANAGER_ERROR, macro in nm-errors +
+
+
+nm_manager_error_quark, function in nm-errors +
+
+
+NM_MICRO_VERSION, macro in nm-version +
+
+
+NM_MINOR_VERSION, macro in nm-version +
+
+

O

+
+NMObject, struct in NMObject +
+
+
+NMObject:dbus-connection, object property in NMObject +
+
+
+NMObject:nm-running-internal, object property in NMObject +
+
+
+NMObject:path, object property in NMObject +
+
+
+NMObjectClass, struct in NMObject +
+
+
+NM_OBJECT_DBUS_CONNECTION, macro in NMObject +
+
+
+nm_object_get_path, function in NMObject +
+
+
+NM_OBJECT_PATH, macro in NMObject +
+
+

R

+
+NMRemoteConnection, struct in NMRemoteConnection +
+
+
+NMRemoteConnection:unsaved, object property in NMRemoteConnection +
+
+
+NMRemoteConnection:visible, object property in NMRemoteConnection +
+
+
+NMRemoteConnectionClass, struct in NMRemoteConnection +
+
+
+nm_remote_connection_commit_changes, function in NMRemoteConnection +
+
+
+nm_remote_connection_commit_changes_async, function in NMRemoteConnection +
+
+
+nm_remote_connection_commit_changes_finish, function in NMRemoteConnection +
+
+
+NM_REMOTE_CONNECTION_DBUS_CONNECTION, macro in NMRemoteConnection +
+
+
+nm_remote_connection_delete, function in NMRemoteConnection +
+
+
+nm_remote_connection_delete_async, function in NMRemoteConnection +
+
+
+nm_remote_connection_delete_finish, function in NMRemoteConnection +
+
+
+nm_remote_connection_get_secrets, function in NMRemoteConnection +
+
+
+nm_remote_connection_get_secrets_async, function in NMRemoteConnection +
+
+
+nm_remote_connection_get_secrets_finish, function in NMRemoteConnection +
+
+
+nm_remote_connection_get_unsaved, function in NMRemoteConnection +
+
+
+nm_remote_connection_get_visible, function in NMRemoteConnection +
+
+
+NM_REMOTE_CONNECTION_PATH, macro in NMRemoteConnection +
+
+
+nm_remote_connection_save, function in NMRemoteConnection +
+
+
+nm_remote_connection_save_async, function in NMRemoteConnection +
+
+
+nm_remote_connection_save_finish, function in NMRemoteConnection +
+
+
+NM_REMOTE_CONNECTION_UNSAVED, macro in NMRemoteConnection +
+
+
+NM_REMOTE_CONNECTION_VISIBLE, macro in NMRemoteConnection +
+
+

S

+
+NMSecretAgentCapabilities, enum in nm-dbus-interface +
+
+
+NMSecretAgentError, enum in nm-errors +
+
+
+NMSecretAgentGetSecretsFlags, enum in nm-dbus-interface +
+
+
+NMSecretAgentOld, struct in NMSecretAgentOld +
+
+
+NMSecretAgentOld:auto-register, object property in NMSecretAgentOld +
+
+
+NMSecretAgentOld:capabilities, object property in NMSecretAgentOld +
+
+
+NMSecretAgentOld:identifier, object property in NMSecretAgentOld +
+
+
+NMSecretAgentOld:registered, object property in NMSecretAgentOld +
+
+
+NMSecretAgentOldClass, struct in NMSecretAgentOld +
+
+
+NMSecretAgentOldDeleteSecretsFunc, user_function in NMSecretAgentOld +
+
+
+NMSecretAgentOldGetSecretsFunc, user_function in NMSecretAgentOld +
+
+
+NMSecretAgentOldSaveSecretsFunc, user_function in NMSecretAgentOld +
+
+
+NM_SECRET_AGENT_ERROR, macro in nm-errors +
+
+
+nm_secret_agent_error_quark, function in nm-errors +
+
+
+NM_SECRET_AGENT_OLD_AUTO_REGISTER, macro in NMSecretAgentOld +
+
+
+NM_SECRET_AGENT_OLD_CAPABILITIES, macro in NMSecretAgentOld +
+
+
+nm_secret_agent_old_delete_secrets, function in NMSecretAgentOld +
+
+
+nm_secret_agent_old_get_registered, function in NMSecretAgentOld +
+
+
+nm_secret_agent_old_get_secrets, function in NMSecretAgentOld +
+
+
+NM_SECRET_AGENT_OLD_IDENTIFIER, macro in NMSecretAgentOld +
+
+
+nm_secret_agent_old_register, function in NMSecretAgentOld +
+
+
+NM_SECRET_AGENT_OLD_REGISTERED, macro in NMSecretAgentOld +
+
+
+nm_secret_agent_old_register_async, function in NMSecretAgentOld +
+
+
+nm_secret_agent_old_register_finish, function in NMSecretAgentOld +
+
+
+nm_secret_agent_old_save_secrets, function in NMSecretAgentOld +
+
+
+nm_secret_agent_old_unregister, function in NMSecretAgentOld +
+
+
+nm_secret_agent_old_unregister_async, function in NMSecretAgentOld +
+
+
+nm_secret_agent_old_unregister_finish, function in NMSecretAgentOld +
+
+
+NMSetting, struct in NMSetting +
+
+
+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:password-flags, object property in NMSetting8021x +
+
+
+NMSetting8021x:password-raw, object property in NMSetting8021x +
+
+
+NMSetting8021x:password-raw-flags, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase1-fast-provisioning, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase1-peaplabel, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase1-peapver, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-altsubject-matches, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-auth, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-autheap, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-ca-cert, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-ca-path, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-client-cert, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-private-key, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-private-key-password, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-private-key-password-flags, object property in NMSetting8021x +
+
+
+NMSetting8021x:phase2-subject-match, object property in NMSetting8021x +
+
+
+NMSetting8021x:pin, object property in NMSetting8021x +
+
+
+NMSetting8021x:pin-flags, object property in NMSetting8021x +
+
+
+NMSetting8021x:private-key, object property in NMSetting8021x +
+
+
+NMSetting8021x:private-key-password, object property in NMSetting8021x +
+
+
+NMSetting8021x:private-key-password-flags, object property in NMSetting8021x +
+
+
+NMSetting8021x:subject-match, object property in NMSetting8021x +
+
+
+NMSetting8021x:system-ca-certs, object property in NMSetting8021x +
+
+
+NMSetting8021xCKFormat, enum in NMSetting8021x +
+
+
+NMSetting8021xCKScheme, enum in NMSetting8021x +
+
+
+NMSetting8021xClass, struct in NMSetting8021x +
+
+
+NMSetting:name, object property in NMSetting +
+
+
+NMSettingAdsl, struct in NMSettingAdsl +
+
+
+NMSettingAdsl:encapsulation, object property in NMSettingAdsl +
+
+
+NMSettingAdsl:password, object property in NMSettingAdsl +
+
+
+NMSettingAdsl:password-flags, object property in NMSettingAdsl +
+
+
+NMSettingAdsl:protocol, object property in NMSettingAdsl +
+
+
+NMSettingAdsl:username, object property in NMSettingAdsl +
+
+
+NMSettingAdsl:vci, object property in NMSettingAdsl +
+
+
+NMSettingAdsl:vpi, object property in NMSettingAdsl +
+
+
+NMSettingAdslClass, struct in NMSettingAdsl +
+
+
+NMSettingBluetooth, struct in NMSettingBluetooth +
+
+
+NMSettingBluetooth:bdaddr, object property in NMSettingBluetooth +
+
+
+NMSettingBluetooth:type, object property in NMSettingBluetooth +
+
+
+NMSettingBluetoothClass, struct in NMSettingBluetooth +
+
+
+NMSettingBond, struct in NMSettingBond +
+
+
+NMSettingBond:options, object property in NMSettingBond +
+
+
+NMSettingBondClass, struct in NMSettingBond +
+
+
+NMSettingBridge, struct in NMSettingBridge +
+
+
+NMSettingBridge:ageing-time, object property in NMSettingBridge +
+
+
+NMSettingBridge:forward-delay, object property in NMSettingBridge +
+
+
+NMSettingBridge:hello-time, object property in NMSettingBridge +
+
+
+NMSettingBridge:mac-address, object property in NMSettingBridge +
+
+
+NMSettingBridge:max-age, object property in NMSettingBridge +
+
+
+NMSettingBridge:priority, object property in NMSettingBridge +
+
+
+NMSettingBridge:stp, object property in NMSettingBridge +
+
+
+NMSettingBridgeClass, struct in NMSettingBridge +
+
+
+NMSettingBridgePort, struct in NMSettingBridgePort +
+
+
+NMSettingBridgePort:hairpin-mode, object property in NMSettingBridgePort +
+
+
+NMSettingBridgePort:path-cost, object property in NMSettingBridgePort +
+
+
+NMSettingBridgePort:priority, object property in NMSettingBridgePort +
+
+
+NMSettingBridgePortClass, struct in NMSettingBridgePort +
+
+
+NMSettingCdma, struct in NMSettingCdma +
+
+
+NMSettingCdma:number, object property in NMSettingCdma +
+
+
+NMSettingCdma:password, object property in NMSettingCdma +
+
+
+NMSettingCdma:password-flags, object property in NMSettingCdma +
+
+
+NMSettingCdma:username, object property in NMSettingCdma +
+
+
+NMSettingCdmaClass, struct in NMSettingCdma +
+
+
+NMSettingClass, struct in NMSetting +
+
+
+NMSettingClearSecretsWithFlagsFn, user_function in NMSetting +
+
+
+NMSettingCompareFlags, enum in NMSetting +
+
+
+NMSettingConnection, struct in NMSettingConnection +
+
+
+NMSettingConnection:autoconnect, object property in NMSettingConnection +
+
+
+NMSettingConnection:autoconnect-priority, object property in NMSettingConnection +
+
+
+NMSettingConnection:gateway-ping-timeout, object property in NMSettingConnection +
+
+
+NMSettingConnection:id, object property in NMSettingConnection +
+
+
+NMSettingConnection:interface-name, 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 +
+
+
+NMSettingDcb, struct in NMSettingDcb +
+
+
+NMSettingDcb:app-fcoe-flags, object property in NMSettingDcb +
+
+
+NMSettingDcb:app-fcoe-mode, object property in NMSettingDcb +
+
+
+NMSettingDcb:app-fcoe-priority, object property in NMSettingDcb +
+
+
+NMSettingDcb:app-fip-flags, object property in NMSettingDcb +
+
+
+NMSettingDcb:app-fip-priority, object property in NMSettingDcb +
+
+
+NMSettingDcb:app-iscsi-flags, object property in NMSettingDcb +
+
+
+NMSettingDcb:app-iscsi-priority, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-bandwidth, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-flow-control, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-flow-control-flags, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-group-bandwidth, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-group-flags, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-group-id, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-strict-bandwidth, object property in NMSettingDcb +
+
+
+NMSettingDcb:priority-traffic-class, object property in NMSettingDcb +
+
+
+NMSettingDcbClass, struct in NMSettingDcb +
+
+
+NMSettingDcbFlags, enum in NMSettingDcb +
+
+
+NMSettingDiffResult, enum in NMSetting +
+
+
+NMSettingGeneric, struct in NMSettingGeneric +
+
+
+NMSettingGenericClass, struct in NMSettingGeneric +
+
+
+NMSettingGsm, struct in NMSettingGsm +
+
+
+NMSettingGsm:apn, object property in NMSettingGsm +
+
+
+NMSettingGsm:home-only, object property in NMSettingGsm +
+
+
+NMSettingGsm:network-id, 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 +
+
+
+NMSettingInfiniband, struct in NMSettingInfiniband +
+
+
+NMSettingInfiniband:mac-address, object property in NMSettingInfiniband +
+
+
+NMSettingInfiniband:mtu, object property in NMSettingInfiniband +
+
+
+NMSettingInfiniband:p-key, object property in NMSettingInfiniband +
+
+
+NMSettingInfiniband:parent, object property in NMSettingInfiniband +
+
+
+NMSettingInfiniband:transport-mode, object property in NMSettingInfiniband +
+
+
+NMSettingInfinibandClass, struct in NMSettingInfiniband +
+
+
+NMSettingIP4Config, struct in NMSettingIP4Config +
+
+
+NMSettingIP4Config:dhcp-client-id, object property in NMSettingIP4Config +
+
+
+NMSettingIP4ConfigClass, struct in NMSettingIP4Config +
+
+
+NMSettingIP6Config, struct in NMSettingIP6Config +
+
+
+NMSettingIP6Config:ip6-privacy, object property in NMSettingIP6Config +
+
+
+NMSettingIP6ConfigClass, struct in NMSettingIP6Config +
+
+
+NMSettingIP6ConfigPrivacy, enum in NMSettingIP6Config +
+
+
+NMSettingIPConfig, struct in NMSettingIPConfig +
+
+
+NMSettingIPConfig:addresses, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:dhcp-hostname, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:dhcp-send-hostname, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:dns, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:dns-search, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:gateway, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:ignore-auto-dns, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:ignore-auto-routes, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:may-fail, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:method, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:never-default, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:route-metric, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfig:routes, object property in NMSettingIPConfig +
+
+
+NMSettingIPConfigClass, struct in NMSettingIPConfig +
+
+
+NMSettingOlpcMesh, struct in NMSettingOlpcMesh +
+
+
+NMSettingOlpcMesh:channel, object property in NMSettingOlpcMesh +
+
+
+NMSettingOlpcMesh:dhcp-anycast-address, object property in NMSettingOlpcMesh +
+
+
+NMSettingOlpcMesh:ssid, object property in NMSettingOlpcMesh +
+
+
+NMSettingOlpcMeshClass, struct in NMSettingOlpcMesh +
+
+
+NMSettingPpp, struct in NMSettingPpp +
+
+
+NMSettingPpp:baud, object property in NMSettingPpp +
+
+
+NMSettingPpp:crtscts, object property in NMSettingPpp +
+
+
+NMSettingPpp:lcp-echo-failure, object property in NMSettingPpp +
+
+
+NMSettingPpp:lcp-echo-interval, object property in NMSettingPpp +
+
+
+NMSettingPpp:mppe-stateful, object property in NMSettingPpp +
+
+
+NMSettingPpp:mru, object property in NMSettingPpp +
+
+
+NMSettingPpp:mtu, object property in NMSettingPpp +
+
+
+NMSettingPpp:no-vj-comp, object property in NMSettingPpp +
+
+
+NMSettingPpp:noauth, object property in NMSettingPpp +
+
+
+NMSettingPpp:nobsdcomp, object property in NMSettingPpp +
+
+
+NMSettingPpp:nodeflate, object property in NMSettingPpp +
+
+
+NMSettingPpp:refuse-chap, object property in NMSettingPpp +
+
+
+NMSettingPpp:refuse-eap, object property in NMSettingPpp +
+
+
+NMSettingPpp:refuse-mschap, object property in NMSettingPpp +
+
+
+NMSettingPpp:refuse-mschapv2, object property in NMSettingPpp +
+
+
+NMSettingPpp:refuse-pap, object property in NMSettingPpp +
+
+
+NMSettingPpp:require-mppe, object property in NMSettingPpp +
+
+
+NMSettingPpp:require-mppe-128, object property in NMSettingPpp +
+
+
+NMSettingPppClass, struct in NMSettingPpp +
+
+
+NMSettingPppoe, struct in NMSettingPppoe +
+
+
+NMSettingPppoe:password, object property in NMSettingPppoe +
+
+
+NMSettingPppoe:password-flags, object property in NMSettingPppoe +
+
+
+NMSettingPppoe:service, object property in NMSettingPppoe +
+
+
+NMSettingPppoe:username, object property in NMSettingPppoe +
+
+
+NMSettingPppoeClass, struct in NMSettingPppoe +
+
+
+NMSettingSecretFlags, enum in NMSetting +
+
+
+NMSettingSerial, struct in NMSettingSerial +
+
+
+NMSettingSerial:baud, object property in NMSettingSerial +
+
+
+NMSettingSerial:bits, object property in NMSettingSerial +
+
+
+NMSettingSerial:parity, object property in NMSettingSerial +
+
+
+NMSettingSerial:send-delay, object property in NMSettingSerial +
+
+
+NMSettingSerial:stopbits, object property in NMSettingSerial +
+
+
+NMSettingSerialClass, struct in NMSettingSerial +
+
+
+NMSettingSerialParity, enum in NMSettingSerial +
+
+
+NMSettingsError, enum in nm-errors +
+
+
+NM_SETTINGS_ERROR, macro in nm-errors +
+
+
+nm_settings_error_quark, function in nm-errors +
+
+
+NMSettingTeam, struct in NMSettingTeam +
+
+
+NMSettingTeam:config, object property in NMSettingTeam +
+
+
+NMSettingTeamClass, struct in NMSettingTeam +
+
+
+NMSettingTeamPort, struct in NMSettingTeamPort +
+
+
+NMSettingTeamPort:config, object property in NMSettingTeamPort +
+
+
+NMSettingTeamPortClass, struct in NMSettingTeamPort +
+
+
+NMSettingValueIterFn, user_function in NMSetting +
+
+
+NMSettingVlan, struct in NMSettingVlan +
+
+
+NMSettingVlan:egress-priority-map, object property in NMSettingVlan +
+
+
+NMSettingVlan:flags, object property in NMSettingVlan +
+
+
+NMSettingVlan:id, object property in NMSettingVlan +
+
+
+NMSettingVlan:ingress-priority-map, object property in NMSettingVlan +
+
+
+NMSettingVlan:parent, object property in NMSettingVlan +
+
+
+NMSettingVlanClass, struct in NMSettingVlan +
+
+
+NMSettingVpn, struct in NMSettingVpn +
+
+
+NMSettingVpn:data, object property in NMSettingVpn +
+
+
+NMSettingVpn:persistent, object property in NMSettingVpn +
+
+
+NMSettingVpn:secrets, object property in NMSettingVpn +
+
+
+NMSettingVpn:service-type, object property in NMSettingVpn +
+
+
+NMSettingVpn:user-name, object property in NMSettingVpn +
+
+
+NMSettingVpnClass, struct in NMSettingVpn +
+
+
+NMSettingWimax, struct in NMSettingWimax +
+
+
+NMSettingWimax:mac-address, object property in NMSettingWimax +
+
+
+NMSettingWimax:network-name, object property in NMSettingWimax +
+
+
+NMSettingWimaxClass, struct in NMSettingWimax +
+
+
+NMSettingWired, struct in NMSettingWired +
+
+
+NMSettingWired:auto-negotiate, object property in NMSettingWired +
+
+
+NMSettingWired:cloned-mac-address, object property in NMSettingWired +
+
+
+NMSettingWired:duplex, object property in NMSettingWired +
+
+
+NMSettingWired:mac-address, object property in NMSettingWired +
+
+
+NMSettingWired:mac-address-blacklist, object property in NMSettingWired +
+
+
+NMSettingWired:mtu, object property in NMSettingWired +
+
+
+NMSettingWired:port, object property in NMSettingWired +
+
+
+NMSettingWired:s390-nettype, object property in NMSettingWired +
+
+
+NMSettingWired:s390-options, object property in NMSettingWired +
+
+
+NMSettingWired:s390-subchannels, object property in NMSettingWired +
+
+
+NMSettingWired:speed, object property in NMSettingWired +
+
+
+NMSettingWiredClass, struct in NMSettingWired +
+
+
+NMSettingWireless, struct in NMSettingWireless +
+
+
+NMSettingWireless:band, object property in NMSettingWireless +
+
+
+NMSettingWireless:bssid, object property in NMSettingWireless +
+
+
+NMSettingWireless:channel, object property in NMSettingWireless +
+
+
+NMSettingWireless:cloned-mac-address, object property in NMSettingWireless +
+
+
+NMSettingWireless:hidden, object property in NMSettingWireless +
+
+
+NMSettingWireless:mac-address, object property in NMSettingWireless +
+
+
+NMSettingWireless:mac-address-blacklist, object property in NMSettingWireless +
+
+
+NMSettingWireless:mode, object property in NMSettingWireless +
+
+
+NMSettingWireless:mtu, object property in NMSettingWireless +
+
+
+NMSettingWireless:rate, object property in NMSettingWireless +
+
+
+NMSettingWireless:seen-bssids, object property in NMSettingWireless +
+
+
+NMSettingWireless:ssid, object property in NMSettingWireless +
+
+
+NMSettingWireless:tx-power, object property in NMSettingWireless +
+
+
+NMSettingWirelessClass, struct in NMSettingWireless +
+
+
+NMSettingWirelessSecurity, struct in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:auth-alg, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:group, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:key-mgmt, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:leap-password, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:leap-password-flags, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:leap-username, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:pairwise, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:proto, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:psk, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:psk-flags, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:wep-key-flags, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:wep-key-type, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:wep-key0, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:wep-key1, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:wep-key2, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:wep-key3, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurity:wep-tx-keyidx, object property in NMSettingWirelessSecurity +
+
+
+NMSettingWirelessSecurityClass, struct in NMSettingWirelessSecurity +
+
+
+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_phase2_altsubject_match, function in NMSetting8021x +
+
+
+NM_SETTING_802_1X_ALTSUBJECT_MATCHES, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_ANONYMOUS_IDENTITY, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_CA_CERT, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_CA_PATH, macro 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_phase2_altsubject_matches, function in NMSetting8021x +
+
+
+NM_SETTING_802_1X_CLIENT_CERT, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_EAP, macro 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_ca_cert_blob, 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_path, 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_scheme, 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_num_altsubject_matches, 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_pac_file, 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_raw, 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_peaplabel, 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_auth, 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_path, 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_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_scheme, 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_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_path, 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_pin, 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_format, 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_path, 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_system_ca_certs, function in NMSetting8021x +
+
+
+NM_SETTING_802_1X_IDENTITY, macro in NMSetting8021x +
+
+
+nm_setting_802_1x_new, function in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PAC_FILE, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PASSWORD, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PASSWORD_FLAGS, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PASSWORD_RAW, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PASSWORD_RAW_FLAGS, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE1_PEAPLABEL, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE1_PEAPVER, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_AUTH, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_AUTHEAP, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_CA_CERT, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_CA_PATH, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_CLIENT_CERT, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_PRIVATE_KEY, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PIN, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PIN_FLAGS, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PRIVATE_KEY, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS, macro in NMSetting8021x +
+
+
+nm_setting_802_1x_remove_altsubject_match, function in NMSetting8021x +
+
+
+nm_setting_802_1x_remove_altsubject_match_by_value, function in NMSetting8021x +
+
+
+nm_setting_802_1x_remove_eap_method, function in NMSetting8021x +
+
+
+nm_setting_802_1x_remove_eap_method_by_value, function in NMSetting8021x +
+
+
+nm_setting_802_1x_remove_phase2_altsubject_match, function in NMSetting8021x +
+
+
+nm_setting_802_1x_remove_phase2_altsubject_match_by_value, function in NMSetting8021x +
+
+
+NM_SETTING_802_1X_SETTING_NAME, macro 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_phase2_ca_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_private_key, function in NMSetting8021x +
+
+
+NM_SETTING_802_1X_SUBJECT_MATCH, macro in NMSetting8021x +
+
+
+NM_SETTING_802_1X_SYSTEM_CA_CERTS, macro in NMSetting8021x +
+
+
+NM_SETTING_ADSL_ENCAPSULATION, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_ENCAPSULATION_LLC, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_ENCAPSULATION_VCMUX, macro in NMSettingAdsl +
+
+
+nm_setting_adsl_get_encapsulation, function in NMSettingAdsl +
+
+
+nm_setting_adsl_get_password, function in NMSettingAdsl +
+
+
+nm_setting_adsl_get_password_flags, function in NMSettingAdsl +
+
+
+nm_setting_adsl_get_protocol, function in NMSettingAdsl +
+
+
+nm_setting_adsl_get_username, function in NMSettingAdsl +
+
+
+nm_setting_adsl_get_vci, function in NMSettingAdsl +
+
+
+nm_setting_adsl_get_vpi, function in NMSettingAdsl +
+
+
+nm_setting_adsl_new, function in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_PASSWORD, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_PASSWORD_FLAGS, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_PROTOCOL, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_PROTOCOL_IPOATM, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_PROTOCOL_PPPOA, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_PROTOCOL_PPPOE, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_SETTING_NAME, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_USERNAME, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_VCI, macro in NMSettingAdsl +
+
+
+NM_SETTING_ADSL_VPI, macro in NMSettingAdsl +
+
+
+NM_SETTING_BLUETOOTH_BDADDR, macro in NMSettingBluetooth +
+
+
+nm_setting_bluetooth_get_bdaddr, function in NMSettingBluetooth +
+
+
+nm_setting_bluetooth_get_connection_type, function in NMSettingBluetooth +
+
+
+nm_setting_bluetooth_new, function in NMSettingBluetooth +
+
+
+NM_SETTING_BLUETOOTH_SETTING_NAME, macro in NMSettingBluetooth +
+
+
+NM_SETTING_BLUETOOTH_TYPE, macro in NMSettingBluetooth +
+
+
+NM_SETTING_BLUETOOTH_TYPE_DUN, macro in NMSettingBluetooth +
+
+
+NM_SETTING_BLUETOOTH_TYPE_PANU, macro in NMSettingBluetooth +
+
+
+nm_setting_bond_add_option, 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_by_name, function in NMSettingBond +
+
+
+nm_setting_bond_get_option_default, function in NMSettingBond +
+
+
+nm_setting_bond_get_valid_options, function in NMSettingBond +
+
+
+nm_setting_bond_new, function in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTIONS, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_AD_SELECT, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_ARP_INTERVAL, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_ARP_IP_TARGET, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_ARP_VALIDATE, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_DOWNDELAY, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_FAIL_OVER_MAC, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_LACP_RATE, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_MIIMON, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_MODE, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_PRIMARY, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_PRIMARY_RESELECT, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_RESEND_IGMP, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_UPDELAY, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_USE_CARRIER, macro in NMSettingBond +
+
+
+NM_SETTING_BOND_OPTION_XMIT_HASH_POLICY, macro in NMSettingBond +
+
+
+nm_setting_bond_remove_option, function in NMSettingBond +
+
+
+NM_SETTING_BOND_SETTING_NAME, macro in NMSettingBond +
+
+
+nm_setting_bond_validate_option, function in NMSettingBond +
+
+
+NM_SETTING_BRIDGE_AGEING_TIME, macro in NMSettingBridge +
+
+
+NM_SETTING_BRIDGE_FORWARD_DELAY, macro in NMSettingBridge +
+
+
+nm_setting_bridge_get_ageing_time, 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_mac_address, function in NMSettingBridge +
+
+
+nm_setting_bridge_get_max_age, function in NMSettingBridge +
+
+
+nm_setting_bridge_get_priority, function in NMSettingBridge +
+
+
+nm_setting_bridge_get_stp, function in NMSettingBridge +
+
+
+NM_SETTING_BRIDGE_HELLO_TIME, macro in NMSettingBridge +
+
+
+NM_SETTING_BRIDGE_MAC_ADDRESS, macro in NMSettingBridge +
+
+
+NM_SETTING_BRIDGE_MAX_AGE, macro in NMSettingBridge +
+
+
+nm_setting_bridge_new, function in NMSettingBridge +
+
+
+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_priority, function in NMSettingBridgePort +
+
+
+NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE, macro in NMSettingBridgePort +
+
+
+nm_setting_bridge_port_new, function in NMSettingBridgePort +
+
+
+NM_SETTING_BRIDGE_PORT_PATH_COST, macro in NMSettingBridgePort +
+
+
+NM_SETTING_BRIDGE_PORT_PRIORITY, macro in NMSettingBridgePort +
+
+
+NM_SETTING_BRIDGE_PORT_SETTING_NAME, macro in NMSettingBridgePort +
+
+
+NM_SETTING_BRIDGE_PRIORITY, macro in NMSettingBridge +
+
+
+NM_SETTING_BRIDGE_SETTING_NAME, macro in NMSettingBridge +
+
+
+NM_SETTING_BRIDGE_STP, macro in NMSettingBridge +
+
+
+nm_setting_cdma_get_number, function in NMSettingCdma +
+
+
+nm_setting_cdma_get_password, function in NMSettingCdma +
+
+
+nm_setting_cdma_get_password_flags, function in NMSettingCdma +
+
+
+nm_setting_cdma_get_username, function in NMSettingCdma +
+
+
+nm_setting_cdma_new, function in NMSettingCdma +
+
+
+NM_SETTING_CDMA_NUMBER, macro in NMSettingCdma +
+
+
+NM_SETTING_CDMA_PASSWORD, macro in NMSettingCdma +
+
+
+NM_SETTING_CDMA_PASSWORD_FLAGS, macro in NMSettingCdma +
+
+
+NM_SETTING_CDMA_SETTING_NAME, macro in NMSettingCdma +
+
+
+NM_SETTING_CDMA_USERNAME, macro in NMSettingCdma +
+
+
+nm_setting_compare, function in NMSetting +
+
+
+nm_setting_connection_add_permission, function in NMSettingConnection +
+
+
+nm_setting_connection_add_secondary, function in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_AUTOCONNECT, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT, macro in NMSettingConnection +
+
+
+nm_setting_connection_get_autoconnect, function in NMSettingConnection +
+
+
+nm_setting_connection_get_autoconnect_priority, function in NMSettingConnection +
+
+
+nm_setting_connection_get_connection_type, function in NMSettingConnection +
+
+
+nm_setting_connection_get_gateway_ping_timeout, function in NMSettingConnection +
+
+
+nm_setting_connection_get_id, function in NMSettingConnection +
+
+
+nm_setting_connection_get_interface_name, 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_secondaries, function in NMSettingConnection +
+
+
+nm_setting_connection_get_permission, function in NMSettingConnection +
+
+
+nm_setting_connection_get_read_only, function in NMSettingConnection +
+
+
+nm_setting_connection_get_secondary, function in NMSettingConnection +
+
+
+nm_setting_connection_get_slave_type, function in NMSettingConnection +
+
+
+nm_setting_connection_get_timestamp, function in NMSettingConnection +
+
+
+nm_setting_connection_get_uuid, function in NMSettingConnection +
+
+
+nm_setting_connection_get_zone, function in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_ID, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_INTERFACE_NAME, macro in NMSettingConnection +
+
+
+nm_setting_connection_is_slave_type, function in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_MASTER, macro in NMSettingConnection +
+
+
+nm_setting_connection_new, function in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_PERMISSIONS, macro in NMSettingConnection +
+
+
+nm_setting_connection_permissions_user_allowed, function in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_READ_ONLY, macro in NMSettingConnection +
+
+
+nm_setting_connection_remove_permission, function in NMSettingConnection +
+
+
+nm_setting_connection_remove_permission_by_value, function in NMSettingConnection +
+
+
+nm_setting_connection_remove_secondary, function in NMSettingConnection +
+
+
+nm_setting_connection_remove_secondary_by_value, function in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_SECONDARIES, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_SETTING_NAME, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_SLAVE_TYPE, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_TIMESTAMP, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_TYPE, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_UUID, macro in NMSettingConnection +
+
+
+NM_SETTING_CONNECTION_ZONE, macro in NMSettingConnection +
+
+
+NM_SETTING_DCB_APP_FCOE_FLAGS, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_APP_FCOE_MODE, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_APP_FCOE_PRIORITY, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_APP_FIP_FLAGS, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_APP_FIP_PRIORITY, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_APP_ISCSI_FLAGS, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_APP_ISCSI_PRIORITY, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_FCOE_MODE_FABRIC, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_FCOE_MODE_VN2VN, macro in NMSettingDcb +
+
+
+nm_setting_dcb_get_app_fcoe_flags, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_app_fcoe_mode, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_app_fcoe_priority, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_app_fip_flags, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_app_fip_priority, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_app_iscsi_flags, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_app_iscsi_priority, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_bandwidth, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_flow_control, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_flow_control_flags, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_group_bandwidth, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_group_flags, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_group_id, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_strict_bandwidth, function in NMSettingDcb +
+
+
+nm_setting_dcb_get_priority_traffic_class, function in NMSettingDcb +
+
+
+nm_setting_dcb_new, function in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_BANDWIDTH, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_FLOW_CONTROL, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_GROUP_FLAGS, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_GROUP_ID, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS, macro in NMSettingDcb +
+
+
+NM_SETTING_DCB_SETTING_NAME, macro in NMSettingDcb +
+
+
+nm_setting_dcb_set_priority_bandwidth, function in NMSettingDcb +
+
+
+nm_setting_dcb_set_priority_flow_control, function in NMSettingDcb +
+
+
+nm_setting_dcb_set_priority_group_bandwidth, function in NMSettingDcb +
+
+
+nm_setting_dcb_set_priority_group_id, function in NMSettingDcb +
+
+
+nm_setting_dcb_set_priority_strict_bandwidth, function in NMSettingDcb +
+
+
+nm_setting_dcb_set_priority_traffic_class, function in NMSettingDcb +
+
+
+nm_setting_diff, function in NMSetting +
+
+
+nm_setting_duplicate, function in NMSetting +
+
+
+nm_setting_enumerate_values, function in NMSetting +
+
+
+nm_setting_generic_new, function in NMSettingGeneric +
+
+
+NM_SETTING_GENERIC_SETTING_NAME, macro in NMSettingGeneric +
+
+
+nm_setting_get_dbus_property_type, function in NMSetting +
+
+
+nm_setting_get_name, function in NMSetting +
+
+
+nm_setting_get_secret_flags, function in NMSetting +
+
+
+NM_SETTING_GSM_APN, macro in NMSettingGsm +
+
+
+nm_setting_gsm_get_apn, 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_number, function in NMSettingGsm +
+
+
+nm_setting_gsm_get_password, 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_flags, function in NMSettingGsm +
+
+
+nm_setting_gsm_get_username, function in NMSettingGsm +
+
+
+NM_SETTING_GSM_HOME_ONLY, macro in NMSettingGsm +
+
+
+NM_SETTING_GSM_NETWORK_ID, macro in NMSettingGsm +
+
+
+nm_setting_gsm_new, function in NMSettingGsm +
+
+
+NM_SETTING_GSM_NUMBER, macro in NMSettingGsm +
+
+
+NM_SETTING_GSM_PASSWORD, macro in NMSettingGsm +
+
+
+NM_SETTING_GSM_PASSWORD_FLAGS, macro in NMSettingGsm +
+
+
+NM_SETTING_GSM_PIN, macro in NMSettingGsm +
+
+
+NM_SETTING_GSM_PIN_FLAGS, macro in NMSettingGsm +
+
+
+NM_SETTING_GSM_SETTING_NAME, macro in NMSettingGsm +
+
+
+NM_SETTING_GSM_USERNAME, macro in NMSettingGsm +
+
+
+nm_setting_infiniband_get_mac_address, function in NMSettingInfiniband +
+
+
+nm_setting_infiniband_get_mtu, function in NMSettingInfiniband +
+
+
+nm_setting_infiniband_get_parent, function in NMSettingInfiniband +
+
+
+nm_setting_infiniband_get_p_key, function in NMSettingInfiniband +
+
+
+nm_setting_infiniband_get_transport_mode, function in NMSettingInfiniband +
+
+
+nm_setting_infiniband_get_virtual_interface_name, function in NMSettingInfiniband +
+
+
+NM_SETTING_INFINIBAND_MAC_ADDRESS, macro in NMSettingInfiniband +
+
+
+NM_SETTING_INFINIBAND_MTU, macro in NMSettingInfiniband +
+
+
+nm_setting_infiniband_new, function in NMSettingInfiniband +
+
+
+NM_SETTING_INFINIBAND_PARENT, macro in NMSettingInfiniband +
+
+
+NM_SETTING_INFINIBAND_P_KEY, macro in NMSettingInfiniband +
+
+
+NM_SETTING_INFINIBAND_SETTING_NAME, macro in NMSettingInfiniband +
+
+
+NM_SETTING_INFINIBAND_TRANSPORT_MODE, macro in NMSettingInfiniband +
+
+
+NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID, macro in NMSettingIP4Config +
+
+
+nm_setting_ip4_config_get_dhcp_client_id, function in NMSettingIP4Config +
+
+
+NM_SETTING_IP4_CONFIG_METHOD_AUTO, macro in NMSettingIP4Config +
+
+
+NM_SETTING_IP4_CONFIG_METHOD_DISABLED, macro in NMSettingIP4Config +
+
+
+NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL, macro in NMSettingIP4Config +
+
+
+NM_SETTING_IP4_CONFIG_METHOD_MANUAL, macro in NMSettingIP4Config +
+
+
+NM_SETTING_IP4_CONFIG_METHOD_SHARED, macro in NMSettingIP4Config +
+
+
+nm_setting_ip4_config_new, function in NMSettingIP4Config +
+
+
+NM_SETTING_IP4_CONFIG_SETTING_NAME, macro in NMSettingIP4Config +
+
+
+nm_setting_ip6_config_get_ip6_privacy, function in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_IP6_PRIVACY, macro in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_METHOD_AUTO, macro in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_METHOD_DHCP, macro in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_METHOD_IGNORE, macro in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL, macro in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_METHOD_MANUAL, macro in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_METHOD_SHARED, macro in NMSettingIP6Config +
+
+
+nm_setting_ip6_config_new, function in NMSettingIP6Config +
+
+
+NM_SETTING_IP6_CONFIG_SETTING_NAME, macro in NMSettingIP6Config +
+
+
+NM_SETTING_IP_CONFIG_ADDRESSES, macro in NMSettingIPConfig +
+
+
+nm_setting_ip_config_add_address, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_add_dns, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_add_dns_search, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_add_route, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_clear_addresses, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_clear_dns, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_clear_dns_searches, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_clear_routes, function in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_DHCP_HOSTNAME, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_DNS, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_DNS_SEARCH, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_GATEWAY, macro in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_address, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_dhcp_hostname, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_dhcp_send_hostname, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_dns, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_dns_search, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_gateway, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_ignore_auto_dns, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_ignore_auto_routes, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_may_fail, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_method, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_never_default, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_num_addresses, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_num_dns, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_num_dns_searches, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_num_routes, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_route, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_get_route_metric, function in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_MAY_FAIL, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_METHOD, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_NEVER_DEFAULT, macro in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_address, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_address_by_value, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_dns, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_dns_by_value, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_dns_search, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_dns_search_by_value, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_route, function in NMSettingIPConfig +
+
+
+nm_setting_ip_config_remove_route_by_value, function in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_ROUTES, macro in NMSettingIPConfig +
+
+
+NM_SETTING_IP_CONFIG_ROUTE_METRIC, macro in NMSettingIPConfig +
+
+
+nm_setting_lookup_type, function in NMSetting +
+
+
+NM_SETTING_NAME, macro in NMSetting +
+
+
+NM_SETTING_OLPC_MESH_CHANNEL, macro in NMSettingOlpcMesh +
+
+
+NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS, macro 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_ssid, function in NMSettingOlpcMesh +
+
+
+nm_setting_olpc_mesh_new, function in NMSettingOlpcMesh +
+
+
+NM_SETTING_OLPC_MESH_SETTING_NAME, macro in NMSettingOlpcMesh +
+
+
+NM_SETTING_OLPC_MESH_SSID, macro in NMSettingOlpcMesh +
+
+
+NM_SETTING_PARAM_FUZZY_IGNORE, macro in NMSetting +
+
+
+NM_SETTING_PARAM_REQUIRED, macro in NMSetting +
+
+
+NM_SETTING_PARAM_SECRET, macro in NMSetting +
+
+
+nm_setting_pppoe_get_password, function in NMSettingPppoe +
+
+
+nm_setting_pppoe_get_password_flags, function in NMSettingPppoe +
+
+
+nm_setting_pppoe_get_service, function in NMSettingPppoe +
+
+
+nm_setting_pppoe_get_username, function in NMSettingPppoe +
+
+
+nm_setting_pppoe_new, function in NMSettingPppoe +
+
+
+NM_SETTING_PPPOE_PASSWORD, macro in NMSettingPppoe +
+
+
+NM_SETTING_PPPOE_PASSWORD_FLAGS, macro in NMSettingPppoe +
+
+
+NM_SETTING_PPPOE_SERVICE, macro in NMSettingPppoe +
+
+
+NM_SETTING_PPPOE_SETTING_NAME, macro in NMSettingPppoe +
+
+
+NM_SETTING_PPPOE_USERNAME, macro in NMSettingPppoe +
+
+
+NM_SETTING_PPP_BAUD, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_CRTSCTS, macro in NMSettingPpp +
+
+
+nm_setting_ppp_get_baud, 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_interval, function in NMSettingPpp +
+
+
+nm_setting_ppp_get_mppe_stateful, function in NMSettingPpp +
+
+
+nm_setting_ppp_get_mru, function in NMSettingPpp +
+
+
+nm_setting_ppp_get_mtu, function in NMSettingPpp +
+
+
+nm_setting_ppp_get_noauth, function in NMSettingPpp +
+
+
+nm_setting_ppp_get_nobsdcomp, 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_refuse_chap, 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_mschapv2, 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_128, function in NMSettingPpp +
+
+
+NM_SETTING_PPP_LCP_ECHO_FAILURE, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_LCP_ECHO_INTERVAL, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_MPPE_STATEFUL, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_MRU, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_MTU, macro in NMSettingPpp +
+
+
+nm_setting_ppp_new, function in NMSettingPpp +
+
+
+NM_SETTING_PPP_NOAUTH, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_NOBSDCOMP, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_NODEFLATE, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_NO_VJ_COMP, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_REFUSE_CHAP, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_REFUSE_EAP, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_REFUSE_MSCHAP, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_REFUSE_MSCHAPV2, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_REFUSE_PAP, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_REQUIRE_MPPE, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_REQUIRE_MPPE_128, macro in NMSettingPpp +
+
+
+NM_SETTING_PPP_SETTING_NAME, macro in NMSettingPpp +
+
+
+NM_SETTING_SERIAL_BAUD, macro in NMSettingSerial +
+
+
+NM_SETTING_SERIAL_BITS, macro in NMSettingSerial +
+
+
+nm_setting_serial_get_baud, function in NMSettingSerial +
+
+
+nm_setting_serial_get_bits, function in NMSettingSerial +
+
+
+nm_setting_serial_get_parity, function in NMSettingSerial +
+
+
+nm_setting_serial_get_send_delay, function in NMSettingSerial +
+
+
+nm_setting_serial_get_stopbits, function in NMSettingSerial +
+
+
+nm_setting_serial_new, function in NMSettingSerial +
+
+
+NM_SETTING_SERIAL_PARITY, macro in NMSettingSerial +
+
+
+NM_SETTING_SERIAL_SEND_DELAY, macro in NMSettingSerial +
+
+
+NM_SETTING_SERIAL_SETTING_NAME, macro in NMSettingSerial +
+
+
+NM_SETTING_SERIAL_STOPBITS, macro in NMSettingSerial +
+
+
+nm_setting_set_secret_flags, function in NMSetting +
+
+
+NM_SETTING_TEAM_CONFIG, macro in NMSettingTeam +
+
+
+nm_setting_team_get_config, function in NMSettingTeam +
+
+
+nm_setting_team_new, function in NMSettingTeam +
+
+
+NM_SETTING_TEAM_PORT_CONFIG, macro in NMSettingTeamPort +
+
+
+nm_setting_team_port_get_config, function in NMSettingTeamPort +
+
+
+nm_setting_team_port_new, function in NMSettingTeamPort +
+
+
+NM_SETTING_TEAM_PORT_SETTING_NAME, macro in NMSettingTeamPort +
+
+
+NM_SETTING_TEAM_SETTING_NAME, macro in NMSettingTeam +
+
+
+nm_setting_to_string, function in NMSetting +
+
+
+nm_setting_verify, function in NMSetting +
+
+
+nm_setting_vlan_add_priority, function in NMSettingVlan +
+
+
+nm_setting_vlan_add_priority_str, function in NMSettingVlan +
+
+
+nm_setting_vlan_clear_priorities, function in NMSettingVlan +
+
+
+NM_SETTING_VLAN_EGRESS_PRIORITY_MAP, macro in NMSettingVlan +
+
+
+NM_SETTING_VLAN_FLAGS, macro in NMSettingVlan +
+
+
+nm_setting_vlan_get_flags, function in NMSettingVlan +
+
+
+nm_setting_vlan_get_id, function in NMSettingVlan +
+
+
+nm_setting_vlan_get_num_priorities, function in NMSettingVlan +
+
+
+nm_setting_vlan_get_parent, function in NMSettingVlan +
+
+
+nm_setting_vlan_get_priority, function in NMSettingVlan +
+
+
+NM_SETTING_VLAN_ID, macro in NMSettingVlan +
+
+
+NM_SETTING_VLAN_INGRESS_PRIORITY_MAP, macro in NMSettingVlan +
+
+
+nm_setting_vlan_new, function in NMSettingVlan +
+
+
+NM_SETTING_VLAN_PARENT, macro in NMSettingVlan +
+
+
+nm_setting_vlan_remove_priority, function in NMSettingVlan +
+
+
+nm_setting_vlan_remove_priority_by_value, function in NMSettingVlan +
+
+
+nm_setting_vlan_remove_priority_str_by_value, function in NMSettingVlan +
+
+
+NM_SETTING_VLAN_SETTING_NAME, macro in NMSettingVlan +
+
+
+nm_setting_vpn_add_data_item, function in NMSettingVpn +
+
+
+nm_setting_vpn_add_secret, function in NMSettingVpn +
+
+
+NM_SETTING_VPN_DATA, macro in NMSettingVpn +
+
+
+nm_setting_vpn_foreach_data_item, function in NMSettingVpn +
+
+
+nm_setting_vpn_foreach_secret, 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_secrets, function in NMSettingVpn +
+
+
+nm_setting_vpn_get_persistent, function in NMSettingVpn +
+
+
+nm_setting_vpn_get_secret, function in NMSettingVpn +
+
+
+nm_setting_vpn_get_service_type, function in NMSettingVpn +
+
+
+nm_setting_vpn_get_user_name, function in NMSettingVpn +
+
+
+nm_setting_vpn_new, function in NMSettingVpn +
+
+
+NM_SETTING_VPN_PERSISTENT, macro in NMSettingVpn +
+
+
+nm_setting_vpn_remove_data_item, function in NMSettingVpn +
+
+
+nm_setting_vpn_remove_secret, function in NMSettingVpn +
+
+
+NM_SETTING_VPN_SECRETS, macro in NMSettingVpn +
+
+
+NM_SETTING_VPN_SERVICE_TYPE, macro in NMSettingVpn +
+
+
+NM_SETTING_VPN_SETTING_NAME, macro in NMSettingVpn +
+
+
+NM_SETTING_VPN_USER_NAME, macro in NMSettingVpn +
+
+
+nm_setting_wimax_get_mac_address, function in NMSettingWimax +
+
+
+nm_setting_wimax_get_network_name, function in NMSettingWimax +
+
+
+NM_SETTING_WIMAX_MAC_ADDRESS, macro in NMSettingWimax +
+
+
+NM_SETTING_WIMAX_NETWORK_NAME, macro in NMSettingWimax +
+
+
+nm_setting_wimax_new, function in NMSettingWimax +
+
+
+NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax +
+
+
+nm_setting_wired_add_mac_blacklist_item, function in NMSettingWired +
+
+
+nm_setting_wired_add_s390_option, function in NMSettingWired +
+
+
+NM_SETTING_WIRED_AUTO_NEGOTIATE, macro in NMSettingWired +
+
+
+nm_setting_wired_clear_mac_blacklist_items, function in NMSettingWired +
+
+
+NM_SETTING_WIRED_CLONED_MAC_ADDRESS, macro in NMSettingWired +
+
+
+NM_SETTING_WIRED_DUPLEX, macro 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_duplex, 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_blacklist_item, function in NMSettingWired +
+
+
+nm_setting_wired_get_mtu, function in NMSettingWired +
+
+
+nm_setting_wired_get_num_mac_blacklist_items, 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_s390_nettype, 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_subchannels, function in NMSettingWired +
+
+
+nm_setting_wired_get_speed, function in NMSettingWired +
+
+
+nm_setting_wired_get_valid_s390_options, function in NMSettingWired +
+
+
+NM_SETTING_WIRED_MAC_ADDRESS, macro in NMSettingWired +
+
+
+NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST, macro in NMSettingWired +
+
+
+NM_SETTING_WIRED_MTU, macro in NMSettingWired +
+
+
+nm_setting_wired_new, function in NMSettingWired +
+
+
+NM_SETTING_WIRED_PORT, macro in NMSettingWired +
+
+
+nm_setting_wired_remove_mac_blacklist_item, function in NMSettingWired +
+
+
+nm_setting_wired_remove_mac_blacklist_item_by_value, function in NMSettingWired +
+
+
+nm_setting_wired_remove_s390_option, function in NMSettingWired +
+
+
+NM_SETTING_WIRED_S390_NETTYPE, macro in NMSettingWired +
+
+
+NM_SETTING_WIRED_S390_OPTIONS, macro in NMSettingWired +
+
+
+NM_SETTING_WIRED_S390_SUBCHANNELS, macro in NMSettingWired +
+
+
+NM_SETTING_WIRED_SETTING_NAME, macro in NMSettingWired +
+
+
+NM_SETTING_WIRED_SPEED, macro in NMSettingWired +
+
+
+nm_setting_wireless_add_mac_blacklist_item, function in NMSettingWireless +
+
+
+nm_setting_wireless_add_seen_bssid, function in NMSettingWireless +
+
+
+nm_setting_wireless_ap_security_compatible, function in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_BAND, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_BSSID, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_CHANNEL, macro in NMSettingWireless +
+
+
+nm_setting_wireless_clear_mac_blacklist_items, function in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS, macro in NMSettingWireless +
+
+
+nm_setting_wireless_get_band, function in NMSettingWireless +
+
+
+nm_setting_wireless_get_bssid, 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_hidden, 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_blacklist_item, function in NMSettingWireless +
+
+
+nm_setting_wireless_get_mode, function in NMSettingWireless +
+
+
+nm_setting_wireless_get_mtu, function in NMSettingWireless +
+
+
+nm_setting_wireless_get_num_mac_blacklist_items, 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_seen_bssid, function in NMSettingWireless +
+
+
+nm_setting_wireless_get_ssid, function in NMSettingWireless +
+
+
+nm_setting_wireless_get_tx_power, function in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_HIDDEN, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_MAC_ADDRESS, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_MODE, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_MODE_ADHOC, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_MODE_AP, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_MODE_INFRA, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_MTU, macro in NMSettingWireless +
+
+
+nm_setting_wireless_new, function in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_RATE, macro in NMSettingWireless +
+
+
+nm_setting_wireless_remove_mac_blacklist_item, function in NMSettingWireless +
+
+
+nm_setting_wireless_remove_mac_blacklist_item_by_value, function in NMSettingWireless +
+
+
+nm_setting_wireless_security_add_group, 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_AUTH_ALG, macro 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_protos, 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_key_mgmt, 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_username, 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_protos, 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_psk, 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_flags, 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_GROUP, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_KEY_MGMT, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME, macro in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_new, function in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_PAIRWISE, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_PROTO, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_PSK, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS, macro in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_remove_group, function in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_remove_group_by_value, function in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_remove_pairwise, function in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_remove_pairwise_by_value, function in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_remove_proto, function in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_remove_proto_by_value, function in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_SETTING_NAME, macro in NMSettingWirelessSecurity +
+
+
+nm_setting_wireless_security_set_wep_key, function in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_WEP_KEY0, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_WEP_KEY1, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_WEP_KEY2, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_WEP_KEY3, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX, macro in NMSettingWirelessSecurity +
+
+
+NM_SETTING_WIRELESS_SEEN_BSSIDS, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_SETTING_NAME, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_SSID, macro in NMSettingWireless +
+
+
+NM_SETTING_WIRELESS_TX_POWER, macro in NMSettingWireless +
+
+
+NMSimpleConnection, struct in NMSimpleConnection +
+
+
+NMSimpleConnectionClass, struct in NMSimpleConnection +
+
+
+nm_simple_connection_new, function in NMSimpleConnection +
+
+
+nm_simple_connection_new_clone, function in NMSimpleConnection +
+
+
+nm_simple_connection_new_from_dbus, function in NMSimpleConnection +
+
+
+NMState, enum in nm-dbus-interface +
+
+

U

+
+NMUtilsFileSearchInPathsPredicate, user_function in nm-utils +
+
+
+NMUtilsSecurityType, enum in nm-utils +
+
+
+nm_utils_ap_mode_security_valid, function in nm-utils +
+
+
+nm_utils_bin2hexstr, function in nm-utils +
+
+
+nm_utils_check_virtual_device_compatibility, function in nm-utils +
+
+
+nm_utils_escape_ssid, function in nm-utils +
+
+
+nm_utils_file_is_certificate, function in nm-utils +
+
+
+nm_utils_file_is_pkcs12, function in nm-utils +
+
+
+nm_utils_file_is_private_key, function in nm-utils +
+
+
+nm_utils_file_search_in_paths, function in nm-utils +
+
+
+nm_utils_hexstr2bin, function in nm-utils +
+
+
+nm_utils_hwaddr_atoba, function in nm-utils +
+
+
+nm_utils_hwaddr_aton, function in nm-utils +
+
+
+nm_utils_hwaddr_canonical, function in nm-utils +
+
+
+nm_utils_hwaddr_len, function in nm-utils +
+
+
+NM_UTILS_HWADDR_LEN_MAX, macro in nm-utils +
+
+
+nm_utils_hwaddr_matches, function in nm-utils +
+
+
+nm_utils_hwaddr_ntoa, function in nm-utils +
+
+
+nm_utils_hwaddr_valid, function in nm-utils +
+
+
+nm_utils_iface_valid_name, function in nm-utils +
+
+
+nm_utils_inet4_ntop, function in nm-utils +
+
+
+nm_utils_inet6_ntop, function in nm-utils +
+
+
+NM_UTILS_INET_ADDRSTRLEN, macro in nm-utils +
+
+
+nm_utils_ip4_addresses_from_variant, function in nm-utils +
+
+
+nm_utils_ip4_addresses_to_variant, function in nm-utils +
+
+
+nm_utils_ip4_dns_from_variant, function in nm-utils +
+
+
+nm_utils_ip4_dns_to_variant, 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_prefix_to_netmask, function in nm-utils +
+
+
+nm_utils_ip4_routes_from_variant, function in nm-utils +
+
+
+nm_utils_ip4_routes_to_variant, function in nm-utils +
+
+
+nm_utils_ip6_addresses_from_variant, function in nm-utils +
+
+
+nm_utils_ip6_addresses_to_variant, function in nm-utils +
+
+
+nm_utils_ip6_dns_from_variant, function in nm-utils +
+
+
+nm_utils_ip6_dns_to_variant, function in nm-utils +
+
+
+nm_utils_ip6_routes_from_variant, function in nm-utils +
+
+
+nm_utils_ip6_routes_to_variant, function in nm-utils +
+
+
+nm_utils_ipaddr_valid, function in nm-utils +
+
+
+nm_utils_ip_addresses_from_variant, function in nm-utils +
+
+
+nm_utils_ip_addresses_to_variant, function in nm-utils +
+
+
+nm_utils_ip_routes_from_variant, function in nm-utils +
+
+
+nm_utils_ip_routes_to_variant, function in nm-utils +
+
+
+nm_utils_is_empty_ssid, function in nm-utils +
+
+
+nm_utils_is_uuid, function in nm-utils +
+
+
+nm_utils_same_ssid, function in nm-utils +
+
+
+nm_utils_security_valid, function in nm-utils +
+
+
+nm_utils_ssid_to_utf8, function in nm-utils +
+
+
+nm_utils_uuid_generate, 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_find_next_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_strength_bars, function in nm-utils +
+
+
+nm_utils_wpa_psk_valid, function in nm-utils +
+
+

V

+
+NM_VARIANT_TYPE_SETTING, macro in NMConnection +
+
+
+NM_VERSION_0_9_10, macro in nm-version +
+
+
+NM_VERSION_0_9_8, macro in nm-version +
+
+
+NM_VERSION_1_0, macro in nm-version +
+
+
+NM_VERSION_CUR_STABLE, macro in nm-version +
+
+
+NM_VERSION_MAX_ALLOWED, macro in nm-version +
+
+
+NM_VERSION_MIN_REQUIRED, macro in nm-version +
+
+
+NM_VERSION_NEXT_STABLE, macro in nm-version +
+
+
+NMVlanFlags, enum in NMSettingVlan +
+
+
+NMVlanPriorityMap, enum in NMSettingVlan +
+
+
+NMVpnConnection, struct in NMVpnConnection +
+
+
+NMVpnConnection::vpn-state-changed, object signal in NMVpnConnection +
+
+
+NMVpnConnection:banner, object property in NMVpnConnection +
+
+
+NMVpnConnection:vpn-state, object property in NMVpnConnection +
+
+
+NMVpnConnectionClass, struct in NMVpnConnection +
+
+
+NMVpnConnectionState, enum in nm-vpn-dbus-interface +
+
+
+NMVpnConnectionStateReason, enum in nm-vpn-dbus-interface +
+
+
+NMVpnEditorInterface, struct in NMVpnEditorPlugin +
+
+
+NMVpnEditorPluginCapability, enum in NMVpnEditorPlugin +
+
+
+NMVpnEditorPluginFactory, user_function in NMVpnEditorPlugin +
+
+
+NMVpnEditorPluginInterface, struct in NMVpnEditorPlugin +
+
+
+NMVpnIterFunc, user_function in NMSettingVpn +
+
+
+NMVpnPluginError, enum in nm-errors +
+
+
+NMVpnPluginFailure, enum in nm-vpn-dbus-interface +
+
+
+NMVpnServiceState, enum in nm-vpn-dbus-interface +
+
+
+NM_VPN_CONNECTION_BANNER, macro in NMVpnConnection +
+
+
+nm_vpn_connection_get_banner, function in NMVpnConnection +
+
+
+nm_vpn_connection_get_vpn_state, function in NMVpnConnection +
+
+
+NM_VPN_CONNECTION_VPN_STATE, macro in NMVpnConnection +
+
+
+NM_VPN_DBUS_PLUGIN_INTERFACE, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_DBUS_PLUGIN_PATH, macro in nm-vpn-dbus-interface +
+
+
+nm_vpn_editor_get_widget, function in NMVpnEditorPlugin +
+
+
+NM_VPN_EDITOR_PLUGIN_DESCRIPTION, macro in NMVpnEditorPlugin +
+
+
+nm_vpn_editor_plugin_export, function in NMVpnEditorPlugin +
+
+
+nm_vpn_editor_plugin_factory, function in NMVpnEditorPlugin +
+
+
+nm_vpn_editor_plugin_get_capabilities, function in NMVpnEditorPlugin +
+
+
+nm_vpn_editor_plugin_get_editor, function in NMVpnEditorPlugin +
+
+
+nm_vpn_editor_plugin_get_suggested_filename, function in NMVpnEditorPlugin +
+
+
+nm_vpn_editor_plugin_import, function in NMVpnEditorPlugin +
+
+
+NM_VPN_EDITOR_PLUGIN_NAME, macro in NMVpnEditorPlugin +
+
+
+NM_VPN_EDITOR_PLUGIN_SERVICE, macro in NMVpnEditorPlugin +
+
+
+nm_vpn_editor_update_connection, function in NMVpnEditorPlugin +
+
+
+NM_VPN_PLUGIN_CAN_PERSIST, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_CONFIG_BANNER, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_CONFIG_HAS_IP4, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_CONFIG_HAS_IP6, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_CONFIG_MTU, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_CONFIG_TUNDEV, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_ERROR, macro in nm-errors +
+
+
+nm_vpn_plugin_error_quark, function in nm-errors +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_BANNER, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_DNS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_DOMAINS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_MSS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_MTU, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_NBNS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_PREFIX, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_PTP, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_ROUTES, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_ADDRESS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_DNS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_DOMAIN, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_DOMAINS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_INT_GATEWAY, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_MSS, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_NEVER_DEFAULT, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_PREFIX, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_PTP, macro in nm-vpn-dbus-interface +
+
+
+NM_VPN_PLUGIN_IP6_CONFIG_ROUTES, macro in nm-vpn-dbus-interface +
+
+

W

+
+NMWepKeyType, enum in NMSettingWirelessSecurity +
+
+
+NMWimaxNsp, struct in NMWimaxNsp +
+
+
+NMWimaxNsp:name, object property in NMWimaxNsp +
+
+
+NMWimaxNsp:network-type, object property in NMWimaxNsp +
+
+
+NMWimaxNsp:signal-quality, object property in NMWimaxNsp +
+
+
+NMWimaxNspClass, struct in NMWimaxNsp +
+
+
+NMWimaxNspNetworkType, enum in NMWimaxNsp +
+
+
+nm_wimax_nsp_connection_valid, function in NMWimaxNsp +
+
+
+nm_wimax_nsp_filter_connections, function in NMWimaxNsp +
+
+
+nm_wimax_nsp_get_name, function in NMWimaxNsp +
+
+
+nm_wimax_nsp_get_network_type, function in NMWimaxNsp +
+
+
+nm_wimax_nsp_get_signal_quality, function in NMWimaxNsp +
+
+
+NM_WIMAX_NSP_NAME, macro in NMWimaxNsp +
+
+
+NM_WIMAX_NSP_NETWORK_TYPE, macro in NMWimaxNsp +
+
+
+NM_WIMAX_NSP_SIGNAL_QUALITY, macro in NMWimaxNsp +
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/ch02.html b/docs/libnm/html/ch02.html new file mode 100644 index 00000000..ba5f8372 --- /dev/null +++ b/docs/libnm/html/ch02.html @@ -0,0 +1,47 @@ + + + + +Client Object API Reference + + + + + + + + + + + + + + + + +
+

+Client Object API Reference

+
+
+NMClient +
+
+NMSecretAgentOld +
+
+NMObject +
+
+nm-errors +
+
+nm-dbus-interface +
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/ch03.html b/docs/libnm/html/ch03.html new file mode 100644 index 00000000..022ba785 --- /dev/null +++ b/docs/libnm/html/ch03.html @@ -0,0 +1,126 @@ + + + + +Connection and Setting API Reference + + + + + + + + + + + + + + + + +
+

+Connection and Setting API Reference

+
+
+NMConnection — Describes a connection to specific network or provider +
+
+NMSimpleConnection +
+
+NMSetting — Describes related configuration information +
+
+NMSettingConnection — Describes general connection properties +
+
+NMSetting8021x — Describes 802.1x-authenticated connection properties +
+
+NMSettingAdsl — Describes ADSL-based properties +
+
+NMSettingBluetooth — Describes Bluetooth connection properties +
+
+NMSettingBond — Describes connection properties for bonds +
+
+NMSettingBridge — Describes connection properties for bridges +
+
+NMSettingBridgePort — Describes connection properties for bridge ports +
+
+NMSettingCdma — Describes CDMA-based mobile broadband properties +
+
+NMSettingDcb — Connection properties for Data Center Bridging +
+
+NMSettingGeneric — Describes connection properties for generic devices +
+
+NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties +
+
+NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks +
+
+NMSettingIPConfig — Abstract base class for IPv4 and IPv6 + addressing, routing, and name service properties +
+
+NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties +
+
+NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties +
+
+NMSettingOlpcMesh +
+
+NMSettingPpp — Describes connection properties for devices/networks +that require PPP to deliver IP capability +
+
+NMSettingPppoe — Describes PPPoE connection properties +
+
+NMSettingSerial — Describes connection properties for devices that use +serial communications +
+
+NMSettingTeam — Describes connection properties for teams +
+
+NMSettingTeamPort — Describes connection properties for team ports +
+
+NMSettingVlan — Describes connection properties for VLAN interfaces +
+
+NMSettingVpn — Describes connection properties for Virtual Private Networks +
+
+NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties +
+
+NMSettingWired — Describes connection properties for Ethernet-based networks +
+
+NMSettingWireless — Describes connection properties for 802.11 Wi-Fi networks +
+
+NMSettingWirelessSecurity — Describes connection properties for Wi-Fi networks that +use WEP, LEAP, WPA or WPA2/RSN security +
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/ch04.html b/docs/libnm/html/ch04.html new file mode 100644 index 00000000..0053b1bd --- /dev/null +++ b/docs/libnm/html/ch04.html @@ -0,0 +1,95 @@ + + + + +Device and Runtime Configuration API Reference + + + + + + + + + + + + + + + + +
+

+Device and Runtime Configuration API Reference

+
+
+NMDevice +
+
+NMDeviceAdsl +
+
+NMDeviceBond +
+
+NMDeviceBridge +
+
+NMDeviceBt +
+
+NMDeviceEthernet +
+
+NMDeviceGeneric +
+
+NMDeviceInfiniband +
+
+NMDeviceModem +
+
+NMDeviceOlpcMesh +
+
+NMDeviceTeam +
+
+NMDeviceVlan +
+
+NMDeviceWifi +
+
+NMDeviceWimax +
+
+NMActiveConnection +
+
+NMVpnConnection +
+
+NMRemoteConnection +
+
+NMAccessPoint +
+
+NMWimaxNsp +
+
+NMIPConfig +
+
+NMDhcpConfig +
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/ch05.html b/docs/libnm/html/ch05.html new file mode 100644 index 00000000..e54a51fe --- /dev/null +++ b/docs/libnm/html/ch05.html @@ -0,0 +1,38 @@ + + + + +Utility API Reference + + + + + + + + + + + + + + + + +
+

+Utility API Reference

+
+
+nm-utils — Utility functions +
+
+nm-version +
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/ch06.html b/docs/libnm/html/ch06.html new file mode 100644 index 00000000..e8925722 --- /dev/null +++ b/docs/libnm/html/ch06.html @@ -0,0 +1,38 @@ + + + + +VPN Plugin API Reference + + + + + + + + + + + + + + + + +
+

+VPN Plugin API Reference

+
+
+nm-vpn-dbus-interface +
+
+NMVpnEditorPlugin +
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/home.png b/docs/libnm/html/home.png new file mode 100644 index 00000000..17003611 Binary files /dev/null and b/docs/libnm/html/home.png differ diff --git a/docs/libnm/html/index.html b/docs/libnm/html/index.html new file mode 100644 index 00000000..8597a0f8 --- /dev/null +++ b/docs/libnm/html/index.html @@ -0,0 +1,259 @@ + + + + +libnm Reference Manual + + + + + + + +
+
+
+
+

+ for libnm 1.0.0 + + The latest version of this documentation can be found on-line at + https://developer.gnome.org/libnm/1.0/. +

+

Copyright © 2012-2014 The NetworkManager Authors

+
+

+ Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free + Documentation License, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: + +

+


+   The Free Software Foundation, Inc.,
+   51 Franklin Street - Fifth Floor,
+   Boston, MA 02110-1301,
+   USA
+

+

+

+
+
+
+
+
+
Overview
+
Client Object API Reference
+
+
+NMClient +
+
+NMSecretAgentOld +
+
+NMObject +
+
+nm-errors +
+
+nm-dbus-interface +
+
+
Connection and Setting API Reference
+
+
+NMConnection — Describes a connection to specific network or provider +
+
+NMSimpleConnection +
+
+NMSetting — Describes related configuration information +
+
+NMSettingConnection — Describes general connection properties +
+
+NMSetting8021x — Describes 802.1x-authenticated connection properties +
+
+NMSettingAdsl — Describes ADSL-based properties +
+
+NMSettingBluetooth — Describes Bluetooth connection properties +
+
+NMSettingBond — Describes connection properties for bonds +
+
+NMSettingBridge — Describes connection properties for bridges +
+
+NMSettingBridgePort — Describes connection properties for bridge ports +
+
+NMSettingCdma — Describes CDMA-based mobile broadband properties +
+
+NMSettingDcb — Connection properties for Data Center Bridging +
+
+NMSettingGeneric — Describes connection properties for generic devices +
+
+NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties +
+
+NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks +
+
+NMSettingIPConfig — Abstract base class for IPv4 and IPv6 + addressing, routing, and name service properties +
+
+NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties +
+
+NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties +
+
+NMSettingOlpcMesh +
+
+NMSettingPpp — Describes connection properties for devices/networks +that require PPP to deliver IP capability +
+
+NMSettingPppoe — Describes PPPoE connection properties +
+
+NMSettingSerial — Describes connection properties for devices that use +serial communications +
+
+NMSettingTeam — Describes connection properties for teams +
+
+NMSettingTeamPort — Describes connection properties for team ports +
+
+NMSettingVlan — Describes connection properties for VLAN interfaces +
+
+NMSettingVpn — Describes connection properties for Virtual Private Networks +
+
+NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties +
+
+NMSettingWired — Describes connection properties for Ethernet-based networks +
+
+NMSettingWireless — Describes connection properties for 802.11 Wi-Fi networks +
+
+NMSettingWirelessSecurity — Describes connection properties for Wi-Fi networks that +use WEP, LEAP, WPA or WPA2/RSN security +
+
+
Device and Runtime Configuration API Reference
+
+
+NMDevice +
+
+NMDeviceAdsl +
+
+NMDeviceBond +
+
+NMDeviceBridge +
+
+NMDeviceBt +
+
+NMDeviceEthernet +
+
+NMDeviceGeneric +
+
+NMDeviceInfiniband +
+
+NMDeviceModem +
+
+NMDeviceOlpcMesh +
+
+NMDeviceTeam +
+
+NMDeviceVlan +
+
+NMDeviceWifi +
+
+NMDeviceWimax +
+
+NMActiveConnection +
+
+NMVpnConnection +
+
+NMRemoteConnection +
+
+NMAccessPoint +
+
+NMWimaxNsp +
+
+NMIPConfig +
+
+NMDhcpConfig +
+
+
Utility API Reference
+
+
+nm-utils — Utility functions +
+
+nm-version +
+
+
VPN Plugin API Reference
+
+
+nm-vpn-dbus-interface +
+
+NMVpnEditorPlugin +
+
+
Object Hierarchy
+
API Index
+
Annotation Glossary
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/index.sgml b/docs/libnm/html/index.sgml new file mode 100644 index 00000000..20ed7794 --- /dev/null +++ b/docs/libnm/html/index.sgml @@ -0,0 +1,2622 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/libnm/html/left.png b/docs/libnm/html/left.png new file mode 100644 index 00000000..2d05b3d5 Binary files /dev/null and b/docs/libnm/html/left.png differ diff --git a/docs/libnm/html/libnm-NMConnection.html b/docs/libnm/html/libnm-NMConnection.html new file mode 100644 index 00000000..46e2ba75 --- /dev/null +++ b/docs/libnm/html/libnm-NMConnection.html @@ -0,0 +1,1868 @@ + + + + +NMConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMConnection

+

NMConnection — Describes a connection to specific network or provider

+
+
+

Synopsis

+
#define             NM_CONNECTION_SECRETS_UPDATED
+#define             NM_CONNECTION_SECRETS_CLEARED
+#define             NM_CONNECTION_CHANGED
+#define             NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD
+                    NMConnectionInterface;
+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);
+#define             NM_VARIANT_TYPE_SETTING
+enum                NMConnectionSerializationFlags;
+GVariant *          nm_connection_to_dbus               (NMConnection *connection,
+                                                         NMConnectionSerializationFlags flags);
+gboolean            nm_connection_replace_settings      (NMConnection *connection,
+                                                         GVariant *new_settings,
+                                                         GError **error);
+void                nm_connection_replace_settings_from_connection
+                                                        (NMConnection *connection,
+                                                         NMConnection *new_connection);
+void                nm_connection_clear_settings        (NMConnection *connection);
+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);
+gboolean            nm_connection_normalize             (NMConnection *connection,
+                                                         GHashTable *parameters,
+                                                         gboolean *modified,
+                                                         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,
+                                                         GVariant *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_interface_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);
+void                nm_connection_dump                  (NMConnection *connection);
+const char *        nm_connection_get_uuid              (NMConnection *connection);
+const char *        nm_connection_get_id                (NMConnection *connection);
+const char *        nm_connection_get_connection_type   (NMConnection *connection);
+gboolean            nm_connection_is_virtual            (NMConnection *connection);
+char *              nm_connection_get_virtual_device_description
+                                                        (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);
+NMSettingTeam *     nm_connection_get_setting_team      (NMConnection *connection);
+NMSettingTeamPort * nm_connection_get_setting_team_port (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);
+NMSettingDcb *      nm_connection_get_setting_dcb       (NMConnection *connection);
+NMSettingGeneric *  nm_connection_get_setting_generic   (NMConnection *connection);
+NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);
+NMSettingInfiniband * nm_connection_get_setting_infiniband
+                                                        (NMConnection *connection);
+NMSettingIPConfig * nm_connection_get_setting_ip4_config
+                                                        (NMConnection *connection);
+NMSettingIPConfig * 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

+
+  GFlags
+   +----NMConnectionSerializationFlags
+
+
+
+

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

+
+

NM_CONNECTION_SECRETS_UPDATED

+
#define NM_CONNECTION_SECRETS_UPDATED "secrets-updated"
+
+

+

+
+
+
+

NM_CONNECTION_SECRETS_CLEARED

+
#define NM_CONNECTION_SECRETS_CLEARED "secrets-cleared"
+
+

+

+
+
+
+

NM_CONNECTION_CHANGED

+
#define NM_CONNECTION_CHANGED         "changed"
+
+

+

+
+
+
+

NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD

+
#define NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD "ip6-config-method"
+
+

+

+
+
+
+

NMConnectionInterface

+
typedef struct {
+	GTypeInterface parent;
+
+	/* Signals */
+	void (*secrets_updated) (NMConnection *connection,
+	                         const char   *setting);
+	void (*secrets_cleared) (NMConnection *connection);
+	void (*changed)         (NMConnection *connection);
+} NMConnectionInterface;
+
+
++++ + + + + + + + + + + + + + + + + + + +

GTypeInterface parent;

the parent interace struct

secrets_updated ()

emitted when the connection's secrets are updated

secrets_cleared ()

emitted when the connection's secrets are cleared

changed ()

emitted when any change to the connection's settings occurs
+
+
+
+

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. +

+
++++ + + + + + + + + + + +

connection :

a NMConnection +

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. +

+
++++ + + + + + + + + + + +

connection :

a NMConnection +

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. +

+
++++ + + + + + + + + + + + + + + +

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] +
+
+
+
+

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 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] +
+
+
+
+

NM_VARIANT_TYPE_SETTING

+
#define NM_VARIANT_TYPE_SETTING G_VARIANT_TYPE_VARDICT
+
+

+GVariantType for a dictionary mapping from property names to values. This is +an alias for G_VARIANT_TYPE_VARDICT, and is the type of each element of +an NM_VARIANT_TYPE_CONNECTION dictionary. +

+
+
+
+

enum NMConnectionSerializationFlags

+
typedef enum {
+ /*< flags >*/
+	NM_CONNECTION_SERIALIZE_ALL = 0x00000000,
+	NM_CONNECTION_SERIALIZE_NO_SECRETS = 0x00000001,
+	NM_CONNECTION_SERIALIZE_ONLY_SECRETS = 0x00000002,
+} NMConnectionSerializationFlags;
+
+

+These flags determine which properties are serialized when calling when +calling nm_connection_to_dbus(). +

+
++++ + + + + + + + + + + + + + + +

NM_CONNECTION_SERIALIZE_ALL

serialize all properties (including secrets) +

NM_CONNECTION_SERIALIZE_NO_SECRETS

do not include secrets +

NM_CONNECTION_SERIALIZE_ONLY_SECRETS

only serialize secrets +
+
+
+
+

nm_connection_to_dbus ()

+
GVariant *          nm_connection_to_dbus               (NMConnection *connection,
+                                                         NMConnectionSerializationFlags flags);
+

+Converts the NMConnection into a GVariant of type +NM_VARIANT_TYPE_CONNECTION describing the connection, suitable for +marshalling over D-Bus or otherwise serializing. +

+
++++ + + + + + + + + + + + + + + +

connection :

the NMConnection +

flags :

serialization flags, e.g. NM_CONNECTION_SERIALIZE_ALL +

Returns :

a new floating GVariant describing the connection, +its settings, and each setting's properties. [transfer none] +
+
+
+
+

nm_connection_replace_settings ()

+
gboolean            nm_connection_replace_settings      (NMConnection *connection,
+                                                         GVariant *new_settings,
+                                                         GError **error);
+

+Replaces connection's settings with new_settings (which must be +syntactically valid, and describe a known type of connection, but does not +need to result in a connection that passes nm_connection_verify()). +

+
++++ + + + + + + + + + + + + + + + + + + +

connection :

a NMConnection +

new_settings :

a GVariant of type NM_VARIANT_TYPE_CONNECTION, with the new settings

error :

location to store error, or NULL +

Returns :

 +TRUE if connection was updated, FALSE if new_settings could not +be deserialized (in which case connection will be unchanged).
+
+
+
+

nm_connection_replace_settings_from_connection ()

+
void                nm_connection_replace_settings_from_connection
+                                                        (NMConnection *connection,
+                                                         NMConnection *new_connection);
+

+Deep-copies the settings of new_connection and replaces the settings of connection +with the copied settings. +

+
++++ + + + + + + + + + + +

connection :

a NMConnection +

new_connection :

a NMConnection to replace the settings of connection with
+
+
+
+

nm_connection_clear_settings ()

+
void                nm_connection_clear_settings        (NMConnection *connection);
+

+Deletes all of connection's settings. +

+
++++ + + + + +

connection :

a NMConnection +
+
+
+
+

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. +

+
++++ + + + + + + + + + + + + + + + + + + +

a :

a NMConnection +

b :

a second NMConnection 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
+
+
+
+

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. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

a :

a NMConnection +

b :

a second NMConnection to compare with the first

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT +

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
+
+
+
+

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 Wi-Fi connection is security enabled, the NMSettingWireless +setting object's 'security' property must contain the setting name of the +NMSettingWirelessSecurity object, which must also be present in 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. +

+
++++ + + + + + + + + + + + + + + +

connection :

the NMConnection to verify

error :

location to store error, or NULL +

Returns :

 +TRUE if the connection is valid, FALSE if it is not
+
+
+
+

nm_connection_normalize ()

+
gboolean            nm_connection_normalize             (NMConnection *connection,
+                                                         GHashTable *parameters,
+                                                         gboolean *modified,
+                                                         GError **error);
+

+Does some basic normalization and fixup of well known inconsistencies +and deprecated fields. If the connection was modified in any way, +the output parameter modified is set TRUE. +

+

+Finally the connection will be verified and TRUE returns if the connection +is valid. As this function only performs some specific normalization steps +it cannot repair all connections. If the connection has errors that +cannot be normalized, the connection will not be modified. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

connection :

the NMConnection to normalize

parameters :

a GHashTable with +normalization parameters to allow customization of the normalization by providing +specific arguments. Unknown arguments will be ignored and the default will be +used. The keys must be strings, hashed by g_str_hash() and g_str_equal() functions. +The values are opaque and depend on the parameter name. [allow-none][element-type utf8 gpointer] +

modified :

outputs whether any settings were modified. [out][allow-none] +

error :

location to store error, or NULL. Contains the reason, +why the connection is invalid, if the function returns an error.

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 +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. +

+
++++ + + + + + + + + + + + + + + +

connection :

the NMConnection +

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
+
+
+
+

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. +

+
++++ + + + + +

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. +

+
++++ + + + + + + + + + + + + + + +

connection :

the NMConnection +

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 +
+
+
+
+

nm_connection_update_secrets ()

+
gboolean            nm_connection_update_secrets        (NMConnection *connection,
+                                                         const char *setting_name,
+                                                         GVariant *secrets,
+                                                         GError **error);
+

+Update the specified setting's secrets, given a dictionary of secrets +intended for that setting (deserialized from D-Bus for example). Will also +extract the given setting's secrets hash if given a connection dictionary. +If setting_name is NULL, expects a fully serialized NMConnection as +returned by nm_connection_to_dbus() and will update all secrets from all +settings contained in secrets. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

connection :

the NMConnection +

setting_name :

the setting object name to which the secrets apply

secrets :

a GVariant of secrets, of type NM_VARIANT_TYPE_CONNECTION +or NM_VARIANT_TYPE_SETTING +

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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

the D-Bus path of the connection, previously set by a call to +nm_connection_set_path().
+
+
+
+

nm_connection_get_interface_name ()

+
const char *        nm_connection_get_interface_name    (NMConnection *connection);
+

+Returns the interface name as stored in NMSettingConnection:interface_name. +If the connection contains no NMSettingConnection, it will return NULL. +

+

+For hardware devices and software devices created outside of NetworkManager, +this name is used to match the device. for software devices created by +NetworkManager, this is the name of the created interface. +

+
++++ + + + + + + + + + + +

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, Wi-Fi, ppp, etc). Checks the "type" +property of the connection and matches that against type. +

+
++++ + + + + + + + + + + + + + + +

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)

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. +

+
++++ + + + + + + + + + + + + + + +

connection :

the NMConnection +

func :

user-supplied function called for each setting's property. [scope call] +

user_data :

user data passed to func at each invocation
+
+
+
+

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. +

+
++++ + + + + +

connection :

the NMConnection +
+
+
+
+

nm_connection_get_uuid ()

+
const char *        nm_connection_get_uuid              (NMConnection *connection);
+

+A shortcut to return the UUID from the connection's NMSettingConnection. +

+
++++ + + + + + + + + + + +

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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

the ID from the connection's 'connection' setting
+
+
+
+

nm_connection_get_connection_type ()

+
const char *        nm_connection_get_connection_type   (NMConnection *connection);
+

+A shortcut to return the type from the connection's NMSettingConnection. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

the type from the connection's 'connection' setting
+
+
+
+

nm_connection_is_virtual ()

+
gboolean            nm_connection_is_virtual            (NMConnection *connection);
+

+Checks if connection refers to a virtual device (and thus can potentially be +activated even if the device it refers to doesn't exist). +

+
++++ + + + + + + + + + + +

connection :

an NMConnection +

Returns :

whether connection refers to a virtual device
+
+
+
+

nm_connection_get_virtual_device_description ()

+
char *              nm_connection_get_virtual_device_description
+                                                        (NMConnection *connection);
+

+Returns the name that nm_device_disambiguate_names() would +return for the virtual device that would be created for connection. +Eg, "VLAN (eth1.1)". +

+
++++ + + + + + + + + + + +

connection :

an NMConnection for a virtual device type

Returns :

the name of connection's device, +or NULL if connection is not a virtual connection type. [transfer full] +
+
+
+
+

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. +

+
++++ + + + + + + + + + + +

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. +

+
++++ + + + + + + + + + + +

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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingBond if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

nm_connection_get_setting_team ()

+
NMSettingTeam *     nm_connection_get_setting_team      (NMConnection *connection);
+

+A shortcut to return any NMSettingTeam the connection might contain. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingTeam if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

nm_connection_get_setting_team_port ()

+
NMSettingTeamPort * nm_connection_get_setting_team_port (NMConnection *connection);
+

+A shortcut to return any NMSettingTeamPort the connection might contain. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingTeamPort 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. +

+
++++ + + + + + + + + + + +

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. +

+
++++ + + + + + + + + + + +

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. +

+
++++ + + + + + + + + + + +

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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

nm_connection_get_setting_dcb ()

+
NMSettingDcb *      nm_connection_get_setting_dcb       (NMConnection *connection);
+

+A shortcut to return any NMSettingDcb the connection might contain. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingDcb if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

nm_connection_get_setting_generic ()

+
NMSettingGeneric *  nm_connection_get_setting_generic   (NMConnection *connection);
+

+A shortcut to return any NMSettingGeneric the connection might contain. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingGeneric 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingGsm 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingInfiniband if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

nm_connection_get_setting_ip4_config ()

+
NMSettingIPConfig * nm_connection_get_setting_ip4_config
+                                                        (NMConnection *connection);
+

+A shortcut to return any NMSettingIP4Config the connection might contain. +

+

+Note that it returns the value as type NMSettingIPConfig, since the vast +majority of IPv4-setting-related methods are on that type, not +NMSettingIP4Config. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingIP4Config if the +connection contains one, otherwise NULL. [type NMSettingIP4Config][transfer none] +
+
+
+
+

nm_connection_get_setting_ip6_config ()

+
NMSettingIPConfig * nm_connection_get_setting_ip6_config
+                                                        (NMConnection *connection);
+

+A shortcut to return any NMSettingIP6Config the connection might contain. +

+

+Note that it returns the value as type NMSettingIPConfig, since the vast +majority of IPv6-setting-related methods are on that type, not +NMSettingIP6Config. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingIP6Config if the +connection contains one, otherwise NULL. [type NMSettingIP6Config][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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingOlpcMesh 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingPpp 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingPppoe 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingSerial 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingVpn 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingWimax 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. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingAdsl if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

nm_connection_get_setting_wired ()

+
NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);
+

+A shortcut to return any NMSettingWired the connection might contain. +

+
++++ + + + + + + + + + + +

connection :

the NMConnection +

Returns :

an NMSettingWired if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

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 +

Returns :

an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none] +
+
+
+
+

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. +

+
++++ + + + + + + + + + + +

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);
+

+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] +
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/libnm-NMVpnEditorPlugin.html b/docs/libnm/html/libnm-NMVpnEditorPlugin.html new file mode 100644 index 00000000..1cfdb8e6 --- /dev/null +++ b/docs/libnm/html/libnm-NMVpnEditorPlugin.html @@ -0,0 +1,382 @@ + + + + +NMVpnEditorPlugin + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMVpnEditorPlugin

+

NMVpnEditorPlugin

+
+
+

Synopsis

+
NMVpnEditorPlugin * (*NMVpnEditorPluginFactory)         (GError **error);
+NMVpnEditorPlugin * nm_vpn_editor_plugin_factory        (GError **error);
+enum                NMVpnEditorPluginCapability;
+#define             NM_VPN_EDITOR_PLUGIN_NAME
+#define             NM_VPN_EDITOR_PLUGIN_DESCRIPTION
+#define             NM_VPN_EDITOR_PLUGIN_SERVICE
+                    NMVpnEditorPluginInterface;
+NMVpnEditor *       nm_vpn_editor_plugin_get_editor     (NMVpnEditorPlugin *plugin,
+                                                         NMConnection *connection,
+                                                         GError **error);
+NMVpnEditorPluginCapability nm_vpn_editor_plugin_get_capabilities
+                                                        (NMVpnEditorPlugin *plugin);
+NMConnection *      nm_vpn_editor_plugin_import         (NMVpnEditorPlugin *plugin,
+                                                         const char *path,
+                                                         GError **error);
+gboolean            nm_vpn_editor_plugin_export         (NMVpnEditorPlugin *plugin,
+                                                         const char *path,
+                                                         NMConnection *connection,
+                                                         GError **error);
+char *              nm_vpn_editor_plugin_get_suggested_filename
+                                                        (NMVpnEditorPlugin *plugin,
+                                                         NMConnection *connection);
+                    NMVpnEditorInterface;
+GObject *           nm_vpn_editor_get_widget            (NMVpnEditor *editor);
+gboolean            nm_vpn_editor_update_connection     (NMVpnEditor *editor,
+                                                         NMConnection *connection,
+                                                         GError **error);
+
+
+
+

Object Hierarchy

+
+  GFlags
+   +----NMVpnEditorPluginCapability
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMVpnEditorPluginFactory ()

+
NMVpnEditorPlugin * (*NMVpnEditorPluginFactory)         (GError **error);
+

+

+
+
+
+

nm_vpn_editor_plugin_factory ()

+
NMVpnEditorPlugin * nm_vpn_editor_plugin_factory        (GError **error);
+

+

+
+
+
+

enum NMVpnEditorPluginCapability

+
typedef enum {
+	NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE   = 0x00,
+	NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT = 0x01,
+	NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT = 0x02,
+	NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6   = 0x04
+} NMVpnEditorPluginCapability;
+
+

+Flags that indicate certain capabilities of the plugin to editor programs. +

+
++++ + + + + + + + + + + + + + + + + + + +

NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE

unknown or no capability +

NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT

the plugin can import new connections +

NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT

the plugin can export connections +

NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6

the plugin supports IPv6 addressing +
+
+
+
+

NM_VPN_EDITOR_PLUGIN_NAME

+
#define NM_VPN_EDITOR_PLUGIN_NAME "name"
+
+

+

+
+
+
+

NM_VPN_EDITOR_PLUGIN_DESCRIPTION

+
#define NM_VPN_EDITOR_PLUGIN_DESCRIPTION "description"
+
+

+

+
+
+
+

NM_VPN_EDITOR_PLUGIN_SERVICE

+
#define NM_VPN_EDITOR_PLUGIN_SERVICE "service"
+
+

+

+
+
+
+

NMVpnEditorPluginInterface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	NMVpnEditor * (*get_editor) (NMVpnEditorPlugin *plugin,
+	                             NMConnection *connection,
+	                             GError **error);
+
+	NMVpnEditorPluginCapability (*get_capabilities) (NMVpnEditorPlugin *plugin);
+
+	NMConnection * (*import_from_file) (NMVpnEditorPlugin *plugin,
+	                                    const char *path,
+	                                    GError **error);
+
+	gboolean (*export_to_file) (NMVpnEditorPlugin *plugin,
+	                            const char *path,
+	                            NMConnection *connection,
+	                            GError **error);
+
+	char * (*get_suggested_filename) (NMVpnEditorPlugin *plugin, NMConnection *connection);
+} NMVpnEditorPluginInterface;
+
+

+Interface for VPN editor plugins. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

GTypeInterface g_iface;

the parent interface

get_editor ()

returns an NMVpnEditor, pre-filled with values from connection +if non-NULL.

get_capabilities ()

returns a bitmask of capabilities.

import_from_file ()

Try to import a connection from the specified path. On +success, return a partial NMConnection object. On error, return NULL and +set error with additional information. Note that error can be NULL, in +which case no additional error information should be provided.

export_to_file ()

Export the given connection to the specified path. Return +TRUE on success. On error, return FALSE and set error with additional +error information. Note that error can be NULL, in which case no +additional error information should be provided.

get_suggested_filename ()

For a given connection, return a suggested file +name. Returned value will be NULL or a suggested file name to be freed by +the caller.
+
+
+
+

nm_vpn_editor_plugin_get_editor ()

+
NMVpnEditor *       nm_vpn_editor_plugin_get_editor     (NMVpnEditorPlugin *plugin,
+                                                         NMConnection *connection,
+                                                         GError **error);
+
++++ + + + + +

Returns :

. [transfer full] +
+
+
+
+

nm_vpn_editor_plugin_get_capabilities ()

+
NMVpnEditorPluginCapability nm_vpn_editor_plugin_get_capabilities
+                                                        (NMVpnEditorPlugin *plugin);
+

+

+
+
+
+

nm_vpn_editor_plugin_import ()

+
NMConnection *      nm_vpn_editor_plugin_import         (NMVpnEditorPlugin *plugin,
+                                                         const char *path,
+                                                         GError **error);
+
++++ + + + + +

Returns :

. [transfer full] +
+
+
+
+

nm_vpn_editor_plugin_export ()

+
gboolean            nm_vpn_editor_plugin_export         (NMVpnEditorPlugin *plugin,
+                                                         const char *path,
+                                                         NMConnection *connection,
+                                                         GError **error);
+

+

+
+
+
+

nm_vpn_editor_plugin_get_suggested_filename ()

+
char *              nm_vpn_editor_plugin_get_suggested_filename
+                                                        (NMVpnEditorPlugin *plugin,
+                                                         NMConnection *connection);
+

+

+
+
+
+

NMVpnEditorInterface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	GObject * (*get_widget) (NMVpnEditor *editor);
+
+	void (*placeholder) (void);
+
+	gboolean (*update_connection) (NMVpnEditor *editor,
+	                               NMConnection *connection,
+	                               GError **error);
+
+	void (*changed) (NMVpnEditor *editor);
+} NMVpnEditorInterface;
+
+

+Interface for editing a specific NMConnection +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

GTypeInterface g_iface;

the parent interface

get_widget ()

return the GtkWidget for the VPN editor's UI

placeholder ()

not currently used

update_connection ()

called to save the user-entered options to the connection +object. Should return FALSE and set error if the current options are +invalid. error should contain enough information for the plugin to +determine which UI widget is invalid at a later point in time. For +example, creating unique error codes for what error occurred and populating +the message field of error with the name of the invalid property.

changed ()

emitted when the value of a UI widget changes. May trigger a +validity check via update_connection to write values to the connection.
+
+
+
+

nm_vpn_editor_get_widget ()

+
GObject *           nm_vpn_editor_get_widget            (NMVpnEditor *editor);
+
++++ + + + + +

Returns :

. [transfer none] +
+
+
+
+

nm_vpn_editor_update_connection ()

+
gboolean            nm_vpn_editor_update_connection     (NMVpnEditor *editor,
+                                                         NMConnection *connection,
+                                                         GError **error);
+

+

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/libnm-nm-dbus-interface.html b/docs/libnm/html/libnm-nm-dbus-interface.html new file mode 100644 index 00000000..f2e00fe2 --- /dev/null +++ b/docs/libnm/html/libnm-nm-dbus-interface.html @@ -0,0 +1,1806 @@ + + + + +nm-dbus-interface + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-dbus-interface

+

nm-dbus-interface

+
+
+

Synopsis

+
#define             NM_DBUS_SERVICE
+#define             NM_DBUS_PATH
+#define             NM_DBUS_INTERFACE
+#define             NM_DBUS_INTERFACE_DEVICE
+#define             NM_DBUS_INTERFACE_DEVICE_WIRED
+#define             NM_DBUS_INTERFACE_DEVICE_ADSL
+#define             NM_DBUS_INTERFACE_DEVICE_WIRELESS
+#define             NM_DBUS_INTERFACE_DEVICE_BLUETOOTH
+#define             NM_DBUS_INTERFACE_DEVICE_OLPC_MESH
+#define             NM_DBUS_PATH_ACCESS_POINT
+#define             NM_DBUS_INTERFACE_ACCESS_POINT
+#define             NM_DBUS_INTERFACE_DEVICE_MODEM
+#define             NM_DBUS_INTERFACE_DEVICE_WIMAX
+#define             NM_DBUS_INTERFACE_WIMAX_NSP
+#define             NM_DBUS_PATH_WIMAX_NSP
+#define             NM_DBUS_INTERFACE_ACTIVE_CONNECTION
+#define             NM_DBUS_INTERFACE_IP4_CONFIG
+#define             NM_DBUS_INTERFACE_DHCP4_CONFIG
+#define             NM_DBUS_INTERFACE_IP6_CONFIG
+#define             NM_DBUS_INTERFACE_DHCP6_CONFIG
+#define             NM_DBUS_INTERFACE_DEVICE_INFINIBAND
+#define             NM_DBUS_INTERFACE_DEVICE_BOND
+#define             NM_DBUS_INTERFACE_DEVICE_TEAM
+#define             NM_DBUS_INTERFACE_DEVICE_VLAN
+#define             NM_DBUS_INTERFACE_DEVICE_BRIDGE
+#define             NM_DBUS_INTERFACE_DEVICE_GENERIC
+#define             NM_DBUS_INTERFACE_DEVICE_VETH
+#define             NM_DBUS_INTERFACE_DEVICE_TUN
+#define             NM_DBUS_INTERFACE_DEVICE_MACVLAN
+#define             NM_DBUS_INTERFACE_DEVICE_VXLAN
+#define             NM_DBUS_INTERFACE_DEVICE_GRE
+#define             NM_DBUS_INTERFACE_SETTINGS
+#define             NM_DBUS_PATH_SETTINGS
+#define             NM_DBUS_INTERFACE_SETTINGS_CONNECTION
+#define             NM_DBUS_PATH_SETTINGS_CONNECTION
+#define             NM_DBUS_INTERFACE_SETTINGS_CONNECTION_SECRETS
+#define             NM_DBUS_INTERFACE_AGENT_MANAGER
+#define             NM_DBUS_PATH_AGENT_MANAGER
+#define             NM_DBUS_INTERFACE_SECRET_AGENT
+#define             NM_DBUS_PATH_SECRET_AGENT
+enum                NMState;
+enum                NMConnectivityState;
+enum                NMDeviceType;
+enum                NMDeviceCapabilities;
+enum                NMDeviceWifiCapabilities;
+enum                NM80211ApFlags;
+enum                NM80211ApSecurityFlags;
+enum                NM80211Mode;
+enum                NMBluetoothCapabilities;
+enum                NMDeviceModemCapabilities;
+enum                NMDeviceState;
+enum                NMDeviceStateReason;
+enum                NMActiveConnectionState;
+enum                NMSecretAgentGetSecretsFlags;
+enum                NMSecretAgentCapabilities;
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMState
+
+
+  GEnum
+   +----NMConnectivityState
+
+
+  GEnum
+   +----NMDeviceType
+
+
+  GFlags
+   +----NMDeviceCapabilities
+
+
+  GFlags
+   +----NMDeviceWifiCapabilities
+
+
+  GFlags
+   +----NM80211ApFlags
+
+
+  GFlags
+   +----NM80211ApSecurityFlags
+
+
+  GEnum
+   +----NM80211Mode
+
+
+  GFlags
+   +----NMBluetoothCapabilities
+
+
+  GFlags
+   +----NMDeviceModemCapabilities
+
+
+  GEnum
+   +----NMDeviceState
+
+
+  GEnum
+   +----NMDeviceStateReason
+
+
+  GEnum
+   +----NMActiveConnectionState
+
+
+  GFlags
+   +----NMSecretAgentGetSecretsFlags
+
+
+  GFlags
+   +----NMSecretAgentCapabilities
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DBUS_SERVICE

+
#define NM_DBUS_SERVICE                     "org.freedesktop.NetworkManager"
+
+

+

+
+
+
+

NM_DBUS_PATH

+
#define NM_DBUS_PATH                        "/org/freedesktop/NetworkManager"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE

+
#define NM_DBUS_INTERFACE                   "org.freedesktop.NetworkManager"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE

+
#define NM_DBUS_INTERFACE_DEVICE            NM_DBUS_INTERFACE ".Device"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_WIRED

+
#define NM_DBUS_INTERFACE_DEVICE_WIRED      NM_DBUS_INTERFACE_DEVICE ".Wired"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_ADSL

+
#define NM_DBUS_INTERFACE_DEVICE_ADSL       NM_DBUS_INTERFACE_DEVICE ".Adsl"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_WIRELESS

+
#define NM_DBUS_INTERFACE_DEVICE_WIRELESS   NM_DBUS_INTERFACE_DEVICE ".Wireless"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_BLUETOOTH

+
#define NM_DBUS_INTERFACE_DEVICE_BLUETOOTH  NM_DBUS_INTERFACE_DEVICE ".Bluetooth"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_OLPC_MESH

+
#define NM_DBUS_INTERFACE_DEVICE_OLPC_MESH  NM_DBUS_INTERFACE_DEVICE ".OlpcMesh"
+
+

+

+
+
+
+

NM_DBUS_PATH_ACCESS_POINT

+
#define NM_DBUS_PATH_ACCESS_POINT           NM_DBUS_PATH "/AccessPoint"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_ACCESS_POINT

+
#define NM_DBUS_INTERFACE_ACCESS_POINT      NM_DBUS_INTERFACE ".AccessPoint"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_MODEM

+
#define NM_DBUS_INTERFACE_DEVICE_MODEM      NM_DBUS_INTERFACE_DEVICE ".Modem"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_WIMAX

+
#define NM_DBUS_INTERFACE_DEVICE_WIMAX      NM_DBUS_INTERFACE_DEVICE ".WiMax"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_WIMAX_NSP

+
#define NM_DBUS_INTERFACE_WIMAX_NSP         NM_DBUS_INTERFACE ".WiMax.Nsp"
+
+

+

+
+
+
+

NM_DBUS_PATH_WIMAX_NSP

+
#define NM_DBUS_PATH_WIMAX_NSP              NM_DBUS_PATH "/Nsp"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_ACTIVE_CONNECTION

+
#define NM_DBUS_INTERFACE_ACTIVE_CONNECTION NM_DBUS_INTERFACE ".Connection.Active"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_IP4_CONFIG

+
#define NM_DBUS_INTERFACE_IP4_CONFIG        NM_DBUS_INTERFACE ".IP4Config"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DHCP4_CONFIG

+
#define NM_DBUS_INTERFACE_DHCP4_CONFIG      NM_DBUS_INTERFACE ".DHCP4Config"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_IP6_CONFIG

+
#define NM_DBUS_INTERFACE_IP6_CONFIG        NM_DBUS_INTERFACE ".IP6Config"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DHCP6_CONFIG

+
#define NM_DBUS_INTERFACE_DHCP6_CONFIG      NM_DBUS_INTERFACE ".DHCP6Config"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_INFINIBAND

+
#define NM_DBUS_INTERFACE_DEVICE_INFINIBAND NM_DBUS_INTERFACE_DEVICE ".Infiniband"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_BOND

+
#define NM_DBUS_INTERFACE_DEVICE_BOND       NM_DBUS_INTERFACE_DEVICE ".Bond"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_TEAM

+
#define NM_DBUS_INTERFACE_DEVICE_TEAM       NM_DBUS_INTERFACE_DEVICE ".Team"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_VLAN

+
#define NM_DBUS_INTERFACE_DEVICE_VLAN       NM_DBUS_INTERFACE_DEVICE ".Vlan"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_BRIDGE

+
#define NM_DBUS_INTERFACE_DEVICE_BRIDGE     NM_DBUS_INTERFACE_DEVICE ".Bridge"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_GENERIC

+
#define NM_DBUS_INTERFACE_DEVICE_GENERIC    NM_DBUS_INTERFACE_DEVICE ".Generic"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_VETH

+
#define NM_DBUS_INTERFACE_DEVICE_VETH       NM_DBUS_INTERFACE_DEVICE ".Veth"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_TUN

+
#define NM_DBUS_INTERFACE_DEVICE_TUN        NM_DBUS_INTERFACE_DEVICE ".Tun"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_MACVLAN

+
#define NM_DBUS_INTERFACE_DEVICE_MACVLAN    NM_DBUS_INTERFACE_DEVICE ".Macvlan"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_VXLAN

+
#define NM_DBUS_INTERFACE_DEVICE_VXLAN      NM_DBUS_INTERFACE_DEVICE ".Vxlan"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_DEVICE_GRE

+
#define NM_DBUS_INTERFACE_DEVICE_GRE        NM_DBUS_INTERFACE_DEVICE ".Gre"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_SETTINGS

+
#define NM_DBUS_INTERFACE_SETTINGS        "org.freedesktop.NetworkManager.Settings"
+
+

+

+
+
+
+

NM_DBUS_PATH_SETTINGS

+
#define NM_DBUS_PATH_SETTINGS             "/org/freedesktop/NetworkManager/Settings"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_SETTINGS_CONNECTION

+
#define NM_DBUS_INTERFACE_SETTINGS_CONNECTION "org.freedesktop.NetworkManager.Settings.Connection"
+
+

+

+
+
+
+

NM_DBUS_PATH_SETTINGS_CONNECTION

+
#define NM_DBUS_PATH_SETTINGS_CONNECTION  "/org/freedesktop/NetworkManager/Settings/Connection"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_SETTINGS_CONNECTION_SECRETS

+
#define NM_DBUS_INTERFACE_SETTINGS_CONNECTION_SECRETS "org.freedesktop.NetworkManager.Settings.Connection.Secrets"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_AGENT_MANAGER

+
#define NM_DBUS_INTERFACE_AGENT_MANAGER   NM_DBUS_INTERFACE ".AgentManager"
+
+

+

+
+
+
+

NM_DBUS_PATH_AGENT_MANAGER

+
#define NM_DBUS_PATH_AGENT_MANAGER        "/org/freedesktop/NetworkManager/AgentManager"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_SECRET_AGENT

+
#define NM_DBUS_INTERFACE_SECRET_AGENT    NM_DBUS_INTERFACE ".SecretAgent"
+
+

+

+
+
+
+

NM_DBUS_PATH_SECRET_AGENT

+
#define NM_DBUS_PATH_SECRET_AGENT         "/org/freedesktop/NetworkManager/SecretAgent"
+
+

+

+
+
+
+

enum NMState

+
typedef enum {
+	NM_STATE_UNKNOWN          = 0,
+	NM_STATE_ASLEEP           = 10,
+	NM_STATE_DISCONNECTED     = 20,
+	NM_STATE_DISCONNECTING    = 30,
+	NM_STATE_CONNECTING       = 40,
+	NM_STATE_CONNECTED_LOCAL  = 50,
+	NM_STATE_CONNECTED_SITE   = 60,
+	NM_STATE_CONNECTED_GLOBAL = 70
+} NMState;
+
+

+NMState values indicate the current overall networking state. +

+

+(Corresponds to the NM_STATE type in nm-manager.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_STATE_UNKNOWN

networking state is unknown +

NM_STATE_ASLEEP

networking is not enabled +

NM_STATE_DISCONNECTED

there is no active network connection +

NM_STATE_DISCONNECTING

network connections are being cleaned up +

NM_STATE_CONNECTING

a network connection is being started +

NM_STATE_CONNECTED_LOCAL

there is only local IPv4 and/or IPv6 connectivity +

NM_STATE_CONNECTED_SITE

there is only site-wide IPv4 and/or IPv6 connectivity +

NM_STATE_CONNECTED_GLOBAL

there is global IPv4 and/or IPv6 Internet connectivity +
+
+
+
+

enum NMConnectivityState

+
typedef enum {
+	NM_CONNECTIVITY_UNKNOWN,
+	NM_CONNECTIVITY_NONE,
+	NM_CONNECTIVITY_PORTAL,
+	NM_CONNECTIVITY_LIMITED,
+	NM_CONNECTIVITY_FULL
+} NMConnectivityState;
+
+

+(Corresponds to the NM_CONNECTIVITY type in nm-manager.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

NM_CONNECTIVITY_UNKNOWN

Network connectivity is unknown. +

NM_CONNECTIVITY_NONE

The host is not connected to any network. +

NM_CONNECTIVITY_PORTAL

The host is behind a captive portal and + cannot reach the full Internet. +

NM_CONNECTIVITY_LIMITED

The host is connected to a network, but + does not appear to be able to reach the full Internet. +

NM_CONNECTIVITY_FULL

The host is connected to a network, and + appears to be able to reach the full Internet. +
+
+
+
+

enum NMDeviceType

+
typedef enum {
+	NM_DEVICE_TYPE_UNKNOWN    = 0,
+	NM_DEVICE_TYPE_ETHERNET   = 1,
+	NM_DEVICE_TYPE_WIFI       = 2,
+	NM_DEVICE_TYPE_UNUSED1    = 3,
+	NM_DEVICE_TYPE_UNUSED2    = 4,
+	NM_DEVICE_TYPE_BT         = 5,  /* Bluetooth */
+	NM_DEVICE_TYPE_OLPC_MESH  = 6,
+	NM_DEVICE_TYPE_WIMAX      = 7,
+	NM_DEVICE_TYPE_MODEM      = 8,
+	NM_DEVICE_TYPE_INFINIBAND = 9,
+	NM_DEVICE_TYPE_BOND       = 10,
+	NM_DEVICE_TYPE_VLAN       = 11,
+	NM_DEVICE_TYPE_ADSL       = 12,
+	NM_DEVICE_TYPE_BRIDGE     = 13,
+	NM_DEVICE_TYPE_GENERIC    = 14,
+	NM_DEVICE_TYPE_TEAM       = 15,
+} NMDeviceType;
+
+

+NMDeviceType values indicate the type of hardware represented by +an NMDevice. +

+

+(Corresponds to the NM_DEVICE_TYPE type in nm-device.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_DEVICE_TYPE_UNKNOWN

unknown device +

NM_DEVICE_TYPE_ETHERNET

a wired ethernet device +

NM_DEVICE_TYPE_WIFI

an 802.11 WiFi device +

NM_DEVICE_TYPE_UNUSED1

not used +

NM_DEVICE_TYPE_UNUSED2

not used +

NM_DEVICE_TYPE_BT

a Bluetooth device supporting PAN or DUN access protocols +

NM_DEVICE_TYPE_OLPC_MESH

an OLPC XO mesh networking device +

NM_DEVICE_TYPE_WIMAX

an 802.16e Mobile WiMAX broadband device +

NM_DEVICE_TYPE_MODEM

a modem supporting analog telephone, CDMA/EVDO, +GSM/UMTS, or LTE network access protocols +

NM_DEVICE_TYPE_INFINIBAND

an IP-over-InfiniBand device +

NM_DEVICE_TYPE_BOND

a bond master interface +

NM_DEVICE_TYPE_VLAN

an 802.1Q VLAN interface +

NM_DEVICE_TYPE_ADSL

ADSL modem +

NM_DEVICE_TYPE_BRIDGE

a bridge master interface +

NM_DEVICE_TYPE_GENERIC

generic support for unrecognized device types +

NM_DEVICE_TYPE_TEAM

a team master interface +
+
+
+
+

enum NMDeviceCapabilities

+
typedef enum {
+ /*< flags >*/
+	NM_DEVICE_CAP_NONE           = 0x00000000,
+	NM_DEVICE_CAP_NM_SUPPORTED   = 0x00000001,
+	NM_DEVICE_CAP_CARRIER_DETECT = 0x00000002,
+	NM_DEVICE_CAP_IS_SOFTWARE    = 0x00000004,
+} NMDeviceCapabilities;
+
+

+General device capability flags. +

+

+(Corresponds to the NM_DEVICE_CAP type in nm-device-wifi.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + +

NM_DEVICE_CAP_NONE

device has no special capabilities +

NM_DEVICE_CAP_NM_SUPPORTED

NetworkManager supports this device +

NM_DEVICE_CAP_CARRIER_DETECT

this device can indicate carrier status +

NM_DEVICE_CAP_IS_SOFTWARE

this device is a software device +
+
+
+
+

enum NMDeviceWifiCapabilities

+
typedef enum {
+ /*< flags >*/
+	NM_WIFI_DEVICE_CAP_NONE          = 0x00000000,
+	NM_WIFI_DEVICE_CAP_CIPHER_WEP40  = 0x00000001,
+	NM_WIFI_DEVICE_CAP_CIPHER_WEP104 = 0x00000002,
+	NM_WIFI_DEVICE_CAP_CIPHER_TKIP   = 0x00000004,
+	NM_WIFI_DEVICE_CAP_CIPHER_CCMP   = 0x00000008,
+	NM_WIFI_DEVICE_CAP_WPA           = 0x00000010,
+	NM_WIFI_DEVICE_CAP_RSN           = 0x00000020,
+	NM_WIFI_DEVICE_CAP_AP            = 0x00000040,
+	NM_WIFI_DEVICE_CAP_ADHOC         = 0x00000080
+} NMDeviceWifiCapabilities;
+
+

+802.11 specific device encryption and authentication capabilities. +

+

+(Corresponds to the NM_802_11_DEVICE_CAP type in nm-device-wifi.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_WIFI_DEVICE_CAP_NONE

device has no encryption/authentication capabilities +

NM_WIFI_DEVICE_CAP_CIPHER_WEP40

device supports 40/64-bit WEP encryption +

NM_WIFI_DEVICE_CAP_CIPHER_WEP104

device supports 104/128-bit WEP encryption +

NM_WIFI_DEVICE_CAP_CIPHER_TKIP

device supports TKIP encryption +

NM_WIFI_DEVICE_CAP_CIPHER_CCMP

device supports AES/CCMP encryption +

NM_WIFI_DEVICE_CAP_WPA

device supports WPA1 authentication +

NM_WIFI_DEVICE_CAP_RSN

device supports WPA2/RSN authentication +

NM_WIFI_DEVICE_CAP_AP

device supports Access Point mode +

NM_WIFI_DEVICE_CAP_ADHOC

device supports Ad-Hoc mode +
+
+
+
+

enum NM80211ApFlags

+
typedef enum {
+ /*< underscore_name=nm_802_11_ap_flags, flags >*/
+	NM_802_11_AP_FLAGS_NONE    = 0x00000000,
+	NM_802_11_AP_FLAGS_PRIVACY = 0x00000001
+} NM80211ApFlags;
+
+

+802.11 access point flags. +

+

+(Corresponds to the NM_802_11_AP_FLAGS type in nm-access-point.xml.) +

+
++++ + + + + + + + + + + +

NM_802_11_AP_FLAGS_NONE

access point has no special capabilities +

NM_802_11_AP_FLAGS_PRIVACY

access point requires authentication and +encryption (usually means WEP) +
+
+
+
+

enum NM80211ApSecurityFlags

+
typedef enum {
+ /*< underscore_name=nm_802_11_ap_security_flags, flags >*/
+	NM_802_11_AP_SEC_NONE            = 0x00000000,
+	NM_802_11_AP_SEC_PAIR_WEP40      = 0x00000001,
+	NM_802_11_AP_SEC_PAIR_WEP104     = 0x00000002,
+	NM_802_11_AP_SEC_PAIR_TKIP       = 0x00000004,
+	NM_802_11_AP_SEC_PAIR_CCMP       = 0x00000008,
+	NM_802_11_AP_SEC_GROUP_WEP40     = 0x00000010,
+	NM_802_11_AP_SEC_GROUP_WEP104    = 0x00000020,
+	NM_802_11_AP_SEC_GROUP_TKIP      = 0x00000040,
+	NM_802_11_AP_SEC_GROUP_CCMP      = 0x00000080,
+	NM_802_11_AP_SEC_KEY_MGMT_PSK    = 0x00000100,
+	NM_802_11_AP_SEC_KEY_MGMT_802_1X = 0x00000200
+} NM80211ApSecurityFlags;
+
+

+802.11 access point security and authentication flags. These flags describe +the current security requirements of an access point as determined from the +access point's beacon. +

+

+(Corresponds to the NM_802_11_AP_SEC type in nm-access-point.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_802_11_AP_SEC_NONE

the access point has no special security requirements +

NM_802_11_AP_SEC_PAIR_WEP40

40/64-bit WEP is supported for +pairwise/unicast encryption +

NM_802_11_AP_SEC_PAIR_WEP104

104/128-bit WEP is supported for +pairwise/unicast encryption +

NM_802_11_AP_SEC_PAIR_TKIP

TKIP is supported for pairwise/unicast encryption +

NM_802_11_AP_SEC_PAIR_CCMP

AES/CCMP is supported for pairwise/unicast encryption +

NM_802_11_AP_SEC_GROUP_WEP40

40/64-bit WEP is supported for group/broadcast +encryption +

NM_802_11_AP_SEC_GROUP_WEP104

104/128-bit WEP is supported for +group/broadcast encryption +

NM_802_11_AP_SEC_GROUP_TKIP

TKIP is supported for group/broadcast encryption +

NM_802_11_AP_SEC_GROUP_CCMP

AES/CCMP is supported for group/broadcast +encryption +

NM_802_11_AP_SEC_KEY_MGMT_PSK

WPA/RSN Pre-Shared Key encryption is +supported +

NM_802_11_AP_SEC_KEY_MGMT_802_1X

802.1x authentication and key management +is supported +
+
+
+
+

enum NM80211Mode

+
typedef enum {
+ /*< underscore_name=nm_802_11_mode >*/
+	NM_802_11_MODE_UNKNOWN = 0,
+	NM_802_11_MODE_ADHOC,
+	NM_802_11_MODE_INFRA,
+	NM_802_11_MODE_AP
+} NM80211Mode;
+
+

+Indicates the 802.11 mode an access point or device is currently in. +

+

+(Corresponds to the NM_802_11_MODE type in generic-types.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + +

NM_802_11_MODE_UNKNOWN

the device or access point mode is unknown +

NM_802_11_MODE_ADHOC

for both devices and access point objects, indicates + the object is part of an Ad-Hoc 802.11 network without a central + coordinating access point. +

NM_802_11_MODE_INFRA

the device or access point is in infrastructure mode. + For devices, this indicates the device is an 802.11 client/station. For + access point objects, this indicates the object is an access point that + provides connectivity to clients. +

NM_802_11_MODE_AP

the device is an access point/hotspot. Not valid for + access point objects; used only for hotspot mode on the local machine. +
+
+
+
+

enum NMBluetoothCapabilities

+
typedef enum {
+ /*< flags >*/
+	NM_BT_CAPABILITY_NONE = 0x00000000,
+	NM_BT_CAPABILITY_DUN  = 0x00000001,
+	NM_BT_CAPABILITY_NAP  = 0x00000002,
+} NMBluetoothCapabilities;
+
+

+NMBluetoothCapabilities values indicate the usable capabilities of a +Bluetooth device. +

+

+(Corresponds to the NM_BT_CAPABILITY type in nm-device-bt.xml.) +

+
++++ + + + + + + + + + + + + + + +

NM_BT_CAPABILITY_NONE

device has no usable capabilities +

NM_BT_CAPABILITY_DUN

device provides Dial-Up Networking capability +

NM_BT_CAPABILITY_NAP

device provides Network Access Point capability +
+
+
+
+

enum NMDeviceModemCapabilities

+
typedef enum {
+ /*< flags >*/
+	NM_DEVICE_MODEM_CAPABILITY_NONE      = 0x00000000,
+	NM_DEVICE_MODEM_CAPABILITY_POTS      = 0x00000001,
+	NM_DEVICE_MODEM_CAPABILITY_CDMA_EVDO = 0x00000002,
+	NM_DEVICE_MODEM_CAPABILITY_GSM_UMTS  = 0x00000004,
+	NM_DEVICE_MODEM_CAPABILITY_LTE       = 0x00000008,
+} NMDeviceModemCapabilities;
+
+

+NMDeviceModemCapabilities values indicate the generic radio access +technology families a modem device supports. For more information on the +specific access technologies the device supports use the ModemManager D-Bus +API. +

+

+(Corresponds to the NM_DEVICE_MODEM_CAPABILITY type in nm-device-modem.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

NM_DEVICE_MODEM_CAPABILITY_NONE

modem has no usable capabilities +

NM_DEVICE_MODEM_CAPABILITY_POTS

modem uses the analog wired telephone +network and is not a wireless/cellular device +

NM_DEVICE_MODEM_CAPABILITY_CDMA_EVDO

modem supports at least one of CDMA +1xRTT, EVDO revision 0, EVDO revision A, or EVDO revision B +

NM_DEVICE_MODEM_CAPABILITY_GSM_UMTS

modem supports at least one of GSM, +GPRS, EDGE, UMTS, HSDPA, HSUPA, or HSPA+ packet switched data capability +

NM_DEVICE_MODEM_CAPABILITY_LTE

modem has LTE data capability +
+
+
+
+

enum NMDeviceState

+
typedef enum {
+	NM_DEVICE_STATE_UNKNOWN      = 0,
+	NM_DEVICE_STATE_UNMANAGED    = 10,
+	NM_DEVICE_STATE_UNAVAILABLE  = 20,
+	NM_DEVICE_STATE_DISCONNECTED = 30,
+	NM_DEVICE_STATE_PREPARE      = 40,
+	NM_DEVICE_STATE_CONFIG       = 50,
+	NM_DEVICE_STATE_NEED_AUTH    = 60,
+	NM_DEVICE_STATE_IP_CONFIG    = 70,
+	NM_DEVICE_STATE_IP_CHECK     = 80,
+	NM_DEVICE_STATE_SECONDARIES  = 90,
+	NM_DEVICE_STATE_ACTIVATED    = 100,
+	NM_DEVICE_STATE_DEACTIVATING = 110,
+	NM_DEVICE_STATE_FAILED       = 120
+} NMDeviceState;
+
+

+(Corresponds to the NM_DEVICE_STATE type in nm-device.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_DEVICE_STATE_UNKNOWN

the device's state is unknown +

NM_DEVICE_STATE_UNMANAGED

the device is recognized, but not managed by + NetworkManager +

NM_DEVICE_STATE_UNAVAILABLE

the device is managed by NetworkManager, but + is not available for use. Reasons may include the wireless switched off, + missing firmware, no ethernet carrier, missing supplicant or modem manager, + etc. +

NM_DEVICE_STATE_DISCONNECTED

the device can be activated, but is currently + idle and not connected to a network. +

NM_DEVICE_STATE_PREPARE

the device is preparing the connection to the + network. This may include operations like changing the MAC address, + setting physical link properties, and anything else required to connect + to the requested network. +

NM_DEVICE_STATE_CONFIG

the device is connecting to the requested network. + This may include operations like associating with the WiFi AP, dialing + the modem, connecting to the remote Bluetooth device, etc. +

NM_DEVICE_STATE_NEED_AUTH

the device requires more information to continue + connecting to the requested network. This includes secrets like WiFi + passphrases, login passwords, PIN codes, etc. +

NM_DEVICE_STATE_IP_CONFIG

the device is requesting IPv4 and/or IPv6 + addresses and routing information from the network. +

NM_DEVICE_STATE_IP_CHECK

the device is checking whether further action is + required for the requested network connection. This may include checking + whether only local network access is available, whether a captive portal + is blocking access to the Internet, etc. +

NM_DEVICE_STATE_SECONDARIES

the device is waiting for a secondary + connection (like a VPN) which must activated before the device can be + activated +

NM_DEVICE_STATE_ACTIVATED

the device has a network connection, either local + or global. +

NM_DEVICE_STATE_DEACTIVATING

a disconnection from the current network + connection was requested, and the device is cleaning up resources used for + that connection. The network connection may still be valid. +

NM_DEVICE_STATE_FAILED

the device failed to connect to the requested + network and is cleaning up the connection request +
+
+
+
+

enum NMDeviceStateReason

+
typedef enum {
+	NM_DEVICE_STATE_REASON_NONE = 0,
+	NM_DEVICE_STATE_REASON_UNKNOWN = 1,
+	NM_DEVICE_STATE_REASON_NOW_MANAGED = 2,
+	NM_DEVICE_STATE_REASON_NOW_UNMANAGED = 3,
+	NM_DEVICE_STATE_REASON_CONFIG_FAILED = 4,
+	NM_DEVICE_STATE_REASON_IP_CONFIG_UNAVAILABLE = 5,
+	NM_DEVICE_STATE_REASON_IP_CONFIG_EXPIRED = 6,
+	NM_DEVICE_STATE_REASON_NO_SECRETS = 7,
+	NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT = 8,
+	NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED = 9,
+	NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED = 10,
+	NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT = 11,
+	NM_DEVICE_STATE_REASON_PPP_START_FAILED = 12,
+	NM_DEVICE_STATE_REASON_PPP_DISCONNECT = 13,
+	NM_DEVICE_STATE_REASON_PPP_FAILED = 14,
+	NM_DEVICE_STATE_REASON_DHCP_START_FAILED = 15,
+	NM_DEVICE_STATE_REASON_DHCP_ERROR = 16,
+	NM_DEVICE_STATE_REASON_DHCP_FAILED = 17,
+	NM_DEVICE_STATE_REASON_SHARED_START_FAILED = 18,
+	NM_DEVICE_STATE_REASON_SHARED_FAILED = 19,
+	NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED = 20,
+	NM_DEVICE_STATE_REASON_AUTOIP_ERROR = 21,
+	NM_DEVICE_STATE_REASON_AUTOIP_FAILED = 22,
+	NM_DEVICE_STATE_REASON_MODEM_BUSY = 23,
+	NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE = 24,
+	NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER = 25,
+	NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT = 26,
+	NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED = 27,
+	NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED = 28,
+	NM_DEVICE_STATE_REASON_GSM_APN_FAILED = 29,
+	NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING = 30,
+	NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED = 31,
+	NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT = 32,
+	NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED = 33,
+	NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED = 34,
+	NM_DEVICE_STATE_REASON_FIRMWARE_MISSING = 35,
+	NM_DEVICE_STATE_REASON_REMOVED = 36,
+	NM_DEVICE_STATE_REASON_SLEEPING = 37,
+	NM_DEVICE_STATE_REASON_CONNECTION_REMOVED = 38,
+	NM_DEVICE_STATE_REASON_USER_REQUESTED = 39,
+	NM_DEVICE_STATE_REASON_CARRIER = 40,
+	NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED = 41,
+	NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE = 42,
+	NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND = 43,
+	NM_DEVICE_STATE_REASON_BT_FAILED = 44,
+	NM_DEVICE_STATE_REASON_GSM_SIM_NOT_INSERTED = 45,
+	NM_DEVICE_STATE_REASON_GSM_SIM_PIN_REQUIRED = 46,
+	NM_DEVICE_STATE_REASON_GSM_SIM_PUK_REQUIRED = 47,
+	NM_DEVICE_STATE_REASON_GSM_SIM_WRONG = 48,
+	NM_DEVICE_STATE_REASON_INFINIBAND_MODE = 49,
+	NM_DEVICE_STATE_REASON_DEPENDENCY_FAILED = 50,
+	NM_DEVICE_STATE_REASON_BR2684_FAILED = 51,
+	NM_DEVICE_STATE_REASON_MODEM_MANAGER_UNAVAILABLE = 52,
+	NM_DEVICE_STATE_REASON_SSID_NOT_FOUND = 53,
+	NM_DEVICE_STATE_REASON_SECONDARY_CONNECTION_FAILED = 54,
+	NM_DEVICE_STATE_REASON_DCB_FCOE_FAILED = 55,
+	NM_DEVICE_STATE_REASON_TEAMD_CONTROL_FAILED = 56,
+	NM_DEVICE_STATE_REASON_MODEM_FAILED = 57,
+	NM_DEVICE_STATE_REASON_MODEM_AVAILABLE = 58,
+	NM_DEVICE_STATE_REASON_SIM_PIN_INCORRECT = 59,
+} NMDeviceStateReason;
+
+

+Device state change reason codes +

+

+(Corresponds to the NM_DEVICE_STATE_REASON type in nm-device.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_DEVICE_STATE_REASON_NONE

No reason given +

NM_DEVICE_STATE_REASON_UNKNOWN

Unknown error +

NM_DEVICE_STATE_REASON_NOW_MANAGED

Device is now managed +

NM_DEVICE_STATE_REASON_NOW_UNMANAGED

Device is now unmanaged +

NM_DEVICE_STATE_REASON_CONFIG_FAILED

The device could not be readied for configuration +

NM_DEVICE_STATE_REASON_IP_CONFIG_UNAVAILABLE

IP configuration could not be reserved (no available address, timeout, etc) +

NM_DEVICE_STATE_REASON_IP_CONFIG_EXPIRED

The IP config is no longer valid +

NM_DEVICE_STATE_REASON_NO_SECRETS

Secrets were required, but not provided +

NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT

802.1x supplicant disconnected +

NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED

802.1x supplicant configuration failed +

NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED

802.1x supplicant failed +

NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT

802.1x supplicant took too long to authenticate +

NM_DEVICE_STATE_REASON_PPP_START_FAILED

PPP service failed to start +

NM_DEVICE_STATE_REASON_PPP_DISCONNECT

PPP service disconnected +

NM_DEVICE_STATE_REASON_PPP_FAILED

PPP failed +

NM_DEVICE_STATE_REASON_DHCP_START_FAILED

DHCP client failed to start +

NM_DEVICE_STATE_REASON_DHCP_ERROR

DHCP client error +

NM_DEVICE_STATE_REASON_DHCP_FAILED

DHCP client failed +

NM_DEVICE_STATE_REASON_SHARED_START_FAILED

Shared connection service failed to start +

NM_DEVICE_STATE_REASON_SHARED_FAILED

Shared connection service failed +

NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED

AutoIP service failed to start +

NM_DEVICE_STATE_REASON_AUTOIP_ERROR

AutoIP service error +

NM_DEVICE_STATE_REASON_AUTOIP_FAILED

AutoIP service failed +

NM_DEVICE_STATE_REASON_MODEM_BUSY

The line is busy +

NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE

No dial tone +

NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER

No carrier could be established +

NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT

The dialing request timed out +

NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED

The dialing attempt failed +

NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED

Modem initialization failed +

NM_DEVICE_STATE_REASON_GSM_APN_FAILED

Failed to select the specified APN +

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING

Not searching for networks +

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED

Network registration denied +

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT

Network registration timed out +

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED

Failed to register with the requested network +

NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED

PIN check failed +

NM_DEVICE_STATE_REASON_FIRMWARE_MISSING

Necessary firmware for the device may be missing +

NM_DEVICE_STATE_REASON_REMOVED

The device was removed +

NM_DEVICE_STATE_REASON_SLEEPING

NetworkManager went to sleep +

NM_DEVICE_STATE_REASON_CONNECTION_REMOVED

The device's active connection disappeared +

NM_DEVICE_STATE_REASON_USER_REQUESTED

Device disconnected by user or client +

NM_DEVICE_STATE_REASON_CARRIER

Carrier/link changed +

NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED

The device's existing connection was assumed +

NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE

The supplicant is now available +

NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND

The modem could not be found +

NM_DEVICE_STATE_REASON_BT_FAILED

The Bluetooth connection failed or timed out +

NM_DEVICE_STATE_REASON_GSM_SIM_NOT_INSERTED

GSM Modem's SIM Card not inserted +

NM_DEVICE_STATE_REASON_GSM_SIM_PIN_REQUIRED

GSM Modem's SIM Pin required +

NM_DEVICE_STATE_REASON_GSM_SIM_PUK_REQUIRED

GSM Modem's SIM Puk required +

NM_DEVICE_STATE_REASON_GSM_SIM_WRONG

GSM Modem's SIM wrong +

NM_DEVICE_STATE_REASON_INFINIBAND_MODE

InfiniBand device does not support connected mode +

NM_DEVICE_STATE_REASON_DEPENDENCY_FAILED

A dependency of the connection failed +

NM_DEVICE_STATE_REASON_BR2684_FAILED

Problem with the RFC 2684 Ethernet over ADSL bridge +

NM_DEVICE_STATE_REASON_MODEM_MANAGER_UNAVAILABLE

ModemManager not running +

NM_DEVICE_STATE_REASON_SSID_NOT_FOUND

The WiFi network could not be found +

NM_DEVICE_STATE_REASON_SECONDARY_CONNECTION_FAILED

A secondary connection of the base connection failed +

NM_DEVICE_STATE_REASON_DCB_FCOE_FAILED

DCB or FCoE setup failed +

NM_DEVICE_STATE_REASON_TEAMD_CONTROL_FAILED

teamd control failed +

NM_DEVICE_STATE_REASON_MODEM_FAILED

Modem failed or no longer available +

NM_DEVICE_STATE_REASON_MODEM_AVAILABLE

Modem now ready and available +

NM_DEVICE_STATE_REASON_SIM_PIN_INCORRECT

SIM PIN was incorrect +
+
+
+
+

enum NMActiveConnectionState

+
typedef enum {
+	NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0,
+	NM_ACTIVE_CONNECTION_STATE_ACTIVATING,
+	NM_ACTIVE_CONNECTION_STATE_ACTIVATED,
+	NM_ACTIVE_CONNECTION_STATE_DEACTIVATING,
+	NM_ACTIVE_CONNECTION_STATE_DEACTIVATED
+} NMActiveConnectionState;
+
+

+NMActiveConnectionState values indicate the state of a connection to a +specific network while it is starting, connected, or disconnecting from that +network. +

+

+(Corresponds to the NM_ACTIVE_CONNECTION_STATE type in nm-active-connection.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

NM_ACTIVE_CONNECTION_STATE_UNKNOWN

the state of the connection is unknown +

NM_ACTIVE_CONNECTION_STATE_ACTIVATING

a network connection is being prepared +

NM_ACTIVE_CONNECTION_STATE_ACTIVATED

there is a connection to the network +

NM_ACTIVE_CONNECTION_STATE_DEACTIVATING

the network connection is being + torn down and cleaned up +

NM_ACTIVE_CONNECTION_STATE_DEACTIVATED

the network connection is disconnected + and will be removed +
+
+
+
+

enum NMSecretAgentGetSecretsFlags

+
typedef enum {
+ /*< flags >*/
+	NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0,
+	NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION = 0x1,
+	NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW = 0x2,
+	NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED = 0x4,
+
+	/* Internal to NM; not part of the D-Bus API */
+	NM_SECRET_AGENT_GET_SECRETS_FLAG_ONLY_SYSTEM = 0x80000000,
+	NM_SECRET_AGENT_GET_SECRETS_FLAG_NO_ERRORS = 0x40000000,
+} NMSecretAgentGetSecretsFlags;
+
+

+NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request. +

+

+(Corresponds to the NM_SECRET_AGENT_GET_SECRETS_FLAGS type in nm-secret-agent.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE

no special behavior; by default no + user interaction is allowed and requests for secrets are fulfilled from + persistent storage, or if no secrets are available an error is returned. +

NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION

allows the request to + interact with the user, possibly prompting via UI for secrets if any are + required, or if none are found in persistent storage. +

NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW

explicitly prompt for new + secrets from the user. This flag signals that NetworkManager thinks any + existing secrets are invalid or wrong. This flag implies that interaction + is allowed. +

NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED

set if the request was + initiated by user-requested action via the D-Bus interface, as opposed to + automatically initiated by NetworkManager in response to (for example) scan + results or carrier changes. +

NM_SECRET_AGENT_GET_SECRETS_FLAG_ONLY_SYSTEM

Internal flag, not part of + the D-Bus API. +

NM_SECRET_AGENT_GET_SECRETS_FLAG_NO_ERRORS

Internal flag, not part of + the D-Bus API. +
+
+
+
+

enum NMSecretAgentCapabilities

+
typedef enum {
+	NM_SECRET_AGENT_CAPABILITY_NONE = 0x0,
+	NM_SECRET_AGENT_CAPABILITY_VPN_HINTS = 0x1,
+
+	/* boundary value */
+	NM_SECRET_AGENT_CAPABILITY_LAST = NM_SECRET_AGENT_CAPABILITY_VPN_HINTS
+} NMSecretAgentCapabilities;
+
+

+NMSecretAgentCapabilities indicate various capabilities of the agent. +

+

+(Corresponds to the NM_SECRET_AGENT_CAPABILITIES type in nm-secret-agent.xml.) +

+
++++ + + + + + + + + + + + + + + +

NM_SECRET_AGENT_CAPABILITY_NONE

the agent supports no special capabilities +

NM_SECRET_AGENT_CAPABILITY_VPN_HINTS

the agent supports passing hints to +VPN plugin authentication dialogs. +

NM_SECRET_AGENT_CAPABILITY_LAST

bounds checking value; should not be used. +
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/libnm-nm-errors.html b/docs/libnm/html/libnm-nm-errors.html new file mode 100644 index 00000000..79a6365c --- /dev/null +++ b/docs/libnm/html/libnm-nm-errors.html @@ -0,0 +1,844 @@ + + + + +nm-errors + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-errors

+

nm-errors

+
+
+

Synopsis

+
enum                NMAgentManagerError;
+GQuark              nm_agent_manager_error_quark        (void);
+#define             NM_AGENT_MANAGER_ERROR
+enum                NMConnectionError;
+#define             NM_CONNECTION_ERROR
+GQuark              nm_connection_error_quark           (void);
+enum                NMCryptoError;
+#define             NM_CRYPTO_ERROR
+GQuark              nm_crypto_error_quark               (void);
+enum                NMDeviceError;
+#define             NM_DEVICE_ERROR
+GQuark              nm_device_error_quark               (void);
+enum                NMManagerError;
+GQuark              nm_manager_error_quark              (void);
+#define             NM_MANAGER_ERROR
+enum                NMSecretAgentError;
+GQuark              nm_secret_agent_error_quark         (void);
+#define             NM_SECRET_AGENT_ERROR
+enum                NMSettingsError;
+GQuark              nm_settings_error_quark             (void);
+#define             NM_SETTINGS_ERROR
+enum                NMVpnPluginError;
+#define             NM_VPN_PLUGIN_ERROR
+GQuark              nm_vpn_plugin_error_quark           (void);
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMAgentManagerError
+
+
+  GEnum
+   +----NMConnectionError
+
+
+  GEnum
+   +----NMCryptoError
+
+
+  GEnum
+   +----NMDeviceError
+
+
+  GEnum
+   +----NMManagerError
+
+
+  GEnum
+   +----NMSecretAgentError
+
+
+  GEnum
+   +----NMSettingsError
+
+
+  GEnum
+   +----NMVpnPluginError
+
+
+
+

Description

+

+

+
+
+

Details

+
+

enum NMAgentManagerError

+
typedef enum {
+	NM_AGENT_MANAGER_ERROR_FAILED = 0,         /*< nick=Failed >*/
+	NM_AGENT_MANAGER_ERROR_PERMISSION_DENIED,  /*< nick=PermissionDenied >*/
+	NM_AGENT_MANAGER_ERROR_INVALID_IDENTIFIER, /*< nick=InvalidIdentifier >*/
+	NM_AGENT_MANAGER_ERROR_NOT_REGISTERED,     /*< nick=NotRegistered >*/
+	NM_AGENT_MANAGER_ERROR_NO_SECRETS,         /*< nick=NoSecrets >*/
+	NM_AGENT_MANAGER_ERROR_USER_CANCELED,      /*< nick=UserCanceled >*/
+} NMAgentManagerError;
+
+

+Errors returned from the secret-agent manager. +

+

+These errors may be returned from operations that could cause secrets to be +requested (such as nm_client_activate_connection()), and correspond to D-Bus +errors in the "org.freedesktop.NetworkManager.AgentManager" namespace. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_AGENT_MANAGER_ERROR_FAILED

unknown or unspecified error +

NM_AGENT_MANAGER_ERROR_PERMISSION_DENIED

The caller does not have permission + to register a secret agent, or is trying to register the same secret agent + twice. +

NM_AGENT_MANAGER_ERROR_INVALID_IDENTIFIER

The identifier is not a valid + secret agent identifier. +

NM_AGENT_MANAGER_ERROR_NOT_REGISTERED

The caller tried to unregister an agent + that was not registered. +

NM_AGENT_MANAGER_ERROR_NO_SECRETS

No secret agent returned secrets for this + request +

NM_AGENT_MANAGER_ERROR_USER_CANCELED

The user canceled the secrets request. +
+
+
+
+

nm_agent_manager_error_quark ()

+
GQuark              nm_agent_manager_error_quark        (void);
+

+

+
+
+
+

NM_AGENT_MANAGER_ERROR

+
#define NM_AGENT_MANAGER_ERROR (nm_agent_manager_error_quark ())
+
+

+

+
+
+
+

enum NMConnectionError

+
typedef enum {
+	NM_CONNECTION_ERROR_FAILED = 0,                   /*< nick=Failed >*/
+	NM_CONNECTION_ERROR_SETTING_NOT_FOUND,            /*< nick=SettingNotFound >*/
+	NM_CONNECTION_ERROR_PROPERTY_NOT_FOUND,           /*< nick=PropertyNotFound >*/
+	NM_CONNECTION_ERROR_PROPERTY_NOT_SECRET,          /*< nick=PropertyNotSecret >*/
+	NM_CONNECTION_ERROR_MISSING_SETTING,              /*< nick=MissingSetting >*/
+	NM_CONNECTION_ERROR_INVALID_SETTING,              /*< nick=InvalidSetting >*/
+	NM_CONNECTION_ERROR_MISSING_PROPERTY,             /*< nick=MissingProperty >*/
+	NM_CONNECTION_ERROR_INVALID_PROPERTY,             /*< nick=InvalidProperty >*/
+} NMConnectionError;
+
+

+Describes errors that may result from operations involving a NMConnection +or its NMSettings. +

+

+These errors may be returned directly from NMConnection and NMSetting +methods, or may be returned from D-Bus operations (eg on NMClient or +NMDevice), where they correspond to errors in the +"org.freedesktop.NetworkManager.Settings.Connection" namespace. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_CONNECTION_ERROR_FAILED

unknown or unclassified error +

NM_CONNECTION_ERROR_SETTING_NOT_FOUND

the NMConnection object + did not contain the specified NMSetting object +

NM_CONNECTION_ERROR_PROPERTY_NOT_FOUND

the NMConnection did not contain the + requested NMSetting property +

NM_CONNECTION_ERROR_PROPERTY_NOT_SECRET

an operation which requires a secret + was attempted on a non-secret property +

NM_CONNECTION_ERROR_MISSING_SETTING

the NMConnection object is missing an + NMSetting which is required for its configuration. The error message will + always be prefixed with "<setting-name>: ", where "<setting-name>" is the + name of the setting that is missing. +

NM_CONNECTION_ERROR_INVALID_SETTING

the NMConnection object contains an + invalid or inappropriate NMSetting. The error message will always be + prefixed with "<setting-name>: ", where "<setting-name>" is the name of the + setting that is invalid. +

NM_CONNECTION_ERROR_MISSING_PROPERTY

the NMConnection object is invalid + because it is missing a required property. The error message will always be + prefixed with "<setting-name>.<property-name>: ", where "<setting-name>" is + the name of the setting with the missing property, and "<property-name>" is + the property that is missing. +

NM_CONNECTION_ERROR_INVALID_PROPERTY

the NMConnection object is invalid + because a property has an invalid value. The error message will always be + prefixed with "<setting-name>.<property-name>: ", where "<setting-name>" is + the name of the setting with the invalid property, and "<property-name>" is + the property that is invalid. +
+
+
+
+

NM_CONNECTION_ERROR

+
#define NM_CONNECTION_ERROR nm_connection_error_quark ()
+
+

+

+
+
+
+

nm_connection_error_quark ()

+
GQuark              nm_connection_error_quark           (void);
+

+

+
+
+
+

enum NMCryptoError

+
typedef enum {
+	NM_CRYPTO_ERROR_FAILED = 0,
+	NM_CRYPTO_ERROR_INVALID_DATA,
+	NM_CRYPTO_ERROR_INVALID_PASSWORD,
+	NM_CRYPTO_ERROR_UNKNOWN_CIPHER,
+	NM_CRYPTO_ERROR_DECRYPTION_FAILED,
+	NM_CRYPTO_ERROR_ENCRYPTION_FAILED,
+} NMCryptoError;
+
+

+Cryptography-related errors that can be returned from some nm-utils methods, +and some NMSetting8021x operations. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_CRYPTO_ERROR_FAILED

generic failure +

NM_CRYPTO_ERROR_INVALID_DATA

the certificate or key data provided + was invalid +

NM_CRYPTO_ERROR_INVALID_PASSWORD

the password was invalid +

NM_CRYPTO_ERROR_UNKNOWN_CIPHER

the data uses an unknown cipher +

NM_CRYPTO_ERROR_DECRYPTION_FAILED

decryption failed +

NM_CRYPTO_ERROR_ENCRYPTION_FAILED

encryption failed +
+
+
+
+

NM_CRYPTO_ERROR

+
#define NM_CRYPTO_ERROR nm_crypto_error_quark ()
+
+

+

+
+
+
+

nm_crypto_error_quark ()

+
GQuark              nm_crypto_error_quark               (void);
+

+

+
+
+
+

enum NMDeviceError

+
typedef enum {
+	NM_DEVICE_ERROR_FAILED = 0,                /*< nick=Failed >*/
+	NM_DEVICE_ERROR_CREATION_FAILED,           /*< nick=CreationFailed >*/
+	NM_DEVICE_ERROR_INVALID_CONNECTION,        /*< nick=InvalidConnection >*/
+	NM_DEVICE_ERROR_INCOMPATIBLE_CONNECTION,   /*< nick=IncompatibleConnection >*/
+	NM_DEVICE_ERROR_NOT_ACTIVE,                /*< nick=NotActive >*/
+	NM_DEVICE_ERROR_NOT_SOFTWARE,              /*< nick=NotSoftware >*/
+	NM_DEVICE_ERROR_NOT_ALLOWED,               /*< nick=NotAllowed >*/
+	NM_DEVICE_ERROR_SPECIFIC_OBJECT_NOT_FOUND, /*< nick=SpecificObjectNotFound >*/
+} NMDeviceError;
+
+

+Device-related errors. +

+

+These errors may be returned directly from NMDevice methods, or may be +returned from D-Bus operations (where they correspond to errors in the +"org.freedesktop.NetworkManager.Device" namespace). +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_DEVICE_ERROR_FAILED

unknown or unclassified error +

NM_DEVICE_ERROR_CREATION_FAILED

NetworkManager failed to create the device +

NM_DEVICE_ERROR_INVALID_CONNECTION

the specified connection is not valid +

NM_DEVICE_ERROR_INCOMPATIBLE_CONNECTION

the specified connection is not + compatible with this device. +

NM_DEVICE_ERROR_NOT_ACTIVE

the device does not have an active connection +

NM_DEVICE_ERROR_NOT_SOFTWARE

the requested operation is only valid on + software devices. +

NM_DEVICE_ERROR_NOT_ALLOWED

the requested operation is not allowed at + this time. +

NM_DEVICE_ERROR_SPECIFIC_OBJECT_NOT_FOUND

the "specific object" in the + activation request (eg, the NMAccessPoint or NMWimaxNsp) was not + found. +
+
+
+
+

NM_DEVICE_ERROR

+
#define NM_DEVICE_ERROR nm_device_error_quark ()
+
+

+

+
+
+
+

nm_device_error_quark ()

+
GQuark              nm_device_error_quark               (void);
+

+

+
+
+
+

enum NMManagerError

+
typedef enum {
+	NM_MANAGER_ERROR_FAILED = 0,                  /*< nick=Failed >*/
+	NM_MANAGER_ERROR_PERMISSION_DENIED,           /*< nick=PermissionDenied >*/
+	NM_MANAGER_ERROR_UNKNOWN_CONNECTION,          /*< nick=UnknownConnection >*/
+	NM_MANAGER_ERROR_UNKNOWN_DEVICE,              /*< nick=UnknownDevice >*/
+	NM_MANAGER_ERROR_CONNECTION_NOT_AVAILABLE,    /*< nick=ConnectionNotAvailable >*/
+	NM_MANAGER_ERROR_CONNECTION_NOT_ACTIVE,       /*< nick=ConnectionNotActive >*/
+	NM_MANAGER_ERROR_CONNECTION_ALREADY_ACTIVE,   /*< nick=ConnectionAlreadyActive >*/
+	NM_MANAGER_ERROR_DEPENDENCY_FAILED,           /*< nick=DependencyFailed >*/
+	NM_MANAGER_ERROR_ALREADY_ASLEEP_OR_AWAKE,     /*< nick=AlreadyAsleepOrAwake >*/
+	NM_MANAGER_ERROR_ALREADY_ENABLED_OR_DISABLED, /*< nick=AlreadyEnabledOrDisabled >*/
+	NM_MANAGER_ERROR_UNKNOWN_LOG_LEVEL,           /*< nick=UnknownLogLevel >*/
+	NM_MANAGER_ERROR_UNKNOWN_LOG_DOMAIN,          /*< nick=UnknownLogDomain >*/
+} NMManagerError;
+
+

+Errors related to the main "network management" interface of NetworkManager. +These may be returned from NMClient methods that invoke D-Bus operations on +the "org.freedesktop.NetworkManager" interface, and correspond to D-Bus +errors in that namespace. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_MANAGER_ERROR_FAILED

unknown or unclassified error +

NM_MANAGER_ERROR_PERMISSION_DENIED

Permission denied. +

NM_MANAGER_ERROR_UNKNOWN_CONNECTION

The requested connection is not known. +

NM_MANAGER_ERROR_UNKNOWN_DEVICE

The requested device is not known. +

NM_MANAGER_ERROR_CONNECTION_NOT_AVAILABLE

The requested connection cannot be + activated at this time. +

NM_MANAGER_ERROR_CONNECTION_NOT_ACTIVE

The request could not be completed + because a required connection is not active. +

NM_MANAGER_ERROR_CONNECTION_ALREADY_ACTIVE

The connection to be activated was + already active on another device. +

NM_MANAGER_ERROR_DEPENDENCY_FAILED

An activation request failed due to a + dependency being unavailable. +

NM_MANAGER_ERROR_ALREADY_ASLEEP_OR_AWAKE

The manager is already in the requested + sleep/wake state. +

NM_MANAGER_ERROR_ALREADY_ENABLED_OR_DISABLED

The network is already + enabled/disabled. +

NM_MANAGER_ERROR_UNKNOWN_LOG_LEVEL

Unknown log level in SetLogging +

NM_MANAGER_ERROR_UNKNOWN_LOG_DOMAIN

Unknown log domain in SetLogging +
+
+
+
+

nm_manager_error_quark ()

+
GQuark              nm_manager_error_quark              (void);
+

+

+
+
+
+

NM_MANAGER_ERROR

+
#define NM_MANAGER_ERROR (nm_manager_error_quark ())
+
+

+

+
+
+
+

enum NMSecretAgentError

+
typedef enum {
+	NM_SECRET_AGENT_ERROR_FAILED = 0,         /*< nick=Failed >*/
+	NM_SECRET_AGENT_ERROR_PERMISSION_DENIED,  /*< nick=PermissionDenied >*/
+	NM_SECRET_AGENT_ERROR_INVALID_CONNECTION, /*< nick=InvalidConnection >*/
+	NM_SECRET_AGENT_ERROR_USER_CANCELED,      /*< nick=UserCanceled >*/
+	NM_SECRET_AGENT_ERROR_AGENT_CANCELED,     /*< nick=AgentCanceled >*/
+	NM_SECRET_AGENT_ERROR_NO_SECRETS,         /*< nick=NoSecrets >*/
+} NMSecretAgentError;
+
+

+NMSecretAgentError values are passed by secret agents back to NetworkManager +when they encounter problems retrieving secrets on behalf of NM. They +correspond to errors in the "org.freedesktop.NetworkManager.SecretManager" +namespace. +

+

+Client APIs such as nm_client_activate_connection() will not see these error +codes; instead, the secret agent manager will translate them to the +corresponding NMAgentManagerError codes. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_SECRET_AGENT_ERROR_FAILED

unknown or unclassified error +

NM_SECRET_AGENT_ERROR_PERMISSION_DENIED

the caller (ie, NetworkManager) is + not authorized to make this request +

NM_SECRET_AGENT_ERROR_INVALID_CONNECTION

the connection for which secrets + were requested is invalid +

NM_SECRET_AGENT_ERROR_USER_CANCELED

the request was canceled by the user +

NM_SECRET_AGENT_ERROR_AGENT_CANCELED

the agent canceled the request + because it was requested to do so by NetworkManager +

NM_SECRET_AGENT_ERROR_NO_SECRETS

the agent cannot find any secrets for this + connection +
+
+
+
+

nm_secret_agent_error_quark ()

+
GQuark              nm_secret_agent_error_quark         (void);
+

+

+
+
+
+

NM_SECRET_AGENT_ERROR

+
#define NM_SECRET_AGENT_ERROR         (nm_secret_agent_error_quark ())
+
+

+

+
+
+
+

enum NMSettingsError

+
typedef enum {
+	NM_SETTINGS_ERROR_FAILED = 0,           /*< nick=Failed >*/
+	NM_SETTINGS_ERROR_PERMISSION_DENIED,    /*< nick=PermissionDenied >*/
+	NM_SETTINGS_ERROR_NOT_SUPPORTED,        /*< nick=NotSupported >*/
+	NM_SETTINGS_ERROR_INVALID_CONNECTION,   /*< nick=InvalidConnection >*/
+	NM_SETTINGS_ERROR_READ_ONLY_CONNECTION, /*< nick=ReadOnlyConnection >*/
+	NM_SETTINGS_ERROR_UUID_EXISTS,          /*< nick=UuidExists >*/
+	NM_SETTINGS_ERROR_INVALID_HOSTNAME,     /*< nick=InvalidHostname >*/
+} NMSettingsError;
+
+

+Errors related to the settings/persistent configuration interface of +NetworkManager. +

+

+These may be returned from NMClient methods that invoke D-Bus operations on +the "org.freedesktop.NetworkManager.Settings" interface, and correspond to +D-Bus errors in that namespace. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_SETTINGS_ERROR_FAILED

unknown or unclassified error +

NM_SETTINGS_ERROR_PERMISSION_DENIED

permission denied +

NM_SETTINGS_ERROR_NOT_SUPPORTED

the requested operation is not supported by any + active settings backend +

NM_SETTINGS_ERROR_INVALID_CONNECTION

the connection was invalid +

NM_SETTINGS_ERROR_READ_ONLY_CONNECTION

attempted to modify a read-only connection +

NM_SETTINGS_ERROR_UUID_EXISTS

a connection with that UUID already exists +

NM_SETTINGS_ERROR_INVALID_HOSTNAME

attempted to set an invalid hostname +
+
+
+
+

nm_settings_error_quark ()

+
GQuark              nm_settings_error_quark             (void);
+

+

+
+
+
+

NM_SETTINGS_ERROR

+
#define NM_SETTINGS_ERROR (nm_settings_error_quark ())
+
+

+

+
+
+
+

enum NMVpnPluginError

+
typedef enum {
+	NM_VPN_PLUGIN_ERROR_FAILED,                    /*< nick=Failed >*/
+	NM_VPN_PLUGIN_ERROR_STARTING_IN_PROGRESS,      /*< nick=StartingInProgress >*/
+	NM_VPN_PLUGIN_ERROR_ALREADY_STARTED,           /*< nick=AlreadyStarted >*/
+	NM_VPN_PLUGIN_ERROR_STOPPING_IN_PROGRESS,      /*< nick=StoppingInProgress >*/
+	NM_VPN_PLUGIN_ERROR_ALREADY_STOPPED,           /*< nick=AlreadyStopped >*/
+	NM_VPN_PLUGIN_ERROR_WRONG_STATE,               /*< nick=WrongState >*/
+	NM_VPN_PLUGIN_ERROR_BAD_ARGUMENTS,             /*< nick=BadArguments >*/
+	NM_VPN_PLUGIN_ERROR_LAUNCH_FAILED,             /*< nick=LaunchFailed >*/
+	NM_VPN_PLUGIN_ERROR_INVALID_CONNECTION,        /*< nick=InvalidConnection >*/
+	NM_VPN_PLUGIN_ERROR_INTERACTIVE_NOT_SUPPORTED, /*< nick=InteractiveNotSupported >*/
+} NMVpnPluginError;
+
+

+Returned by the VPN service plugin to indicate errors. These codes correspond +to errors in the "org.freedesktop.NetworkManager.VPN.Error" namespace. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_VPN_PLUGIN_ERROR_FAILED

unknown or unclassified error +

NM_VPN_PLUGIN_ERROR_STARTING_IN_PROGRESS

the plugin is already starting, + and another connect request was received +

NM_VPN_PLUGIN_ERROR_ALREADY_STARTED

the plugin is already connected, and + another connect request was received +

NM_VPN_PLUGIN_ERROR_STOPPING_IN_PROGRESS

the plugin is already stopping, + and another stop request was received +

NM_VPN_PLUGIN_ERROR_ALREADY_STOPPED

the plugin is already stopped, and + another disconnect request was received +

NM_VPN_PLUGIN_ERROR_WRONG_STATE

the operation could not be performed in + this state +

NM_VPN_PLUGIN_ERROR_BAD_ARGUMENTS

the operation could not be performed as + the request contained malformed arguments, or arguments of unexpected type. + Usually means that one of the VPN setting data items or secrets was not of + the expected type (ie int, string, bool, etc). +

NM_VPN_PLUGIN_ERROR_LAUNCH_FAILED

a child process failed to launch +

NM_VPN_PLUGIN_ERROR_INVALID_CONNECTION

the operation could not be performed + because the connection was invalid. Usually means that the connection's + VPN setting was missing some required data item or secret. +

NM_VPN_PLUGIN_ERROR_INTERACTIVE_NOT_SUPPORTED

the operation could not be + performed as the plugin does not support interactive operations, such as + ConnectInteractive() or NewSecrets() +
+
+
+
+

NM_VPN_PLUGIN_ERROR

+
#define NM_VPN_PLUGIN_ERROR      (nm_vpn_plugin_error_quark ())
+
+

+

+
+
+
+

nm_vpn_plugin_error_quark ()

+
GQuark              nm_vpn_plugin_error_quark           (void);
+

+

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/libnm-nm-utils.html b/docs/libnm/html/libnm-nm-utils.html new file mode 100644 index 00000000..4985188b --- /dev/null +++ b/docs/libnm/html/libnm-nm-utils.html @@ -0,0 +1,2042 @@ + + + + +nm-utils + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-utils

+

nm-utils — Utility functions

+
+
+

Synopsis

+
gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
+                                                         gsize len);
+const char *        nm_utils_escape_ssid                (const guint8 *ssid,
+                                                         gsize len);
+gboolean            nm_utils_same_ssid                  (const guint8 *ssid1,
+                                                         gsize len1,
+                                                         const guint8 *ssid2,
+                                                         gsize len2,
+                                                         gboolean ignore_trailing_null);
+char *              nm_utils_ssid_to_utf8               (const guint8 *ssid,
+                                                         gsize len);
+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);
+GVariant *          nm_utils_ip4_dns_to_variant         (char **dns);
+char **             nm_utils_ip4_dns_from_variant       (GVariant *value);
+GVariant *          nm_utils_ip4_addresses_to_variant   (GPtrArray *addresses,
+                                                         const char *gateway);
+GPtrArray *         nm_utils_ip4_addresses_from_variant (GVariant *value,
+                                                         char **out_gateway);
+GVariant *          nm_utils_ip4_routes_to_variant      (GPtrArray *routes);
+GPtrArray *         nm_utils_ip4_routes_from_variant    (GVariant *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);
+GVariant *          nm_utils_ip6_dns_to_variant         (char **dns);
+char **             nm_utils_ip6_dns_from_variant       (GVariant *value);
+GVariant *          nm_utils_ip6_addresses_to_variant   (GPtrArray *addresses,
+                                                         const char *gateway);
+GPtrArray *         nm_utils_ip6_addresses_from_variant (GVariant *value,
+                                                         char **out_gateway);
+GVariant *          nm_utils_ip6_routes_to_variant      (GPtrArray *routes);
+GPtrArray *         nm_utils_ip6_routes_from_variant    (GVariant *value);
+GVariant *          nm_utils_ip_addresses_to_variant    (GPtrArray *addresses);
+GPtrArray *         nm_utils_ip_addresses_from_variant  (GVariant *value,
+                                                         int family);
+GVariant *          nm_utils_ip_routes_to_variant       (GPtrArray *routes);
+GPtrArray *         nm_utils_ip_routes_from_variant     (GVariant *value,
+                                                         int family);
+char *              nm_utils_uuid_generate              (void);
+gboolean            nm_utils_file_is_certificate        (const char *filename);
+gboolean            nm_utils_file_is_private_key        (const char *filename,
+                                                         gboolean *out_encrypted);
+gboolean            nm_utils_file_is_pkcs12             (const char *filename);
+gboolean            (*NMUtilsFileSearchInPathsPredicate)
+                                                        (const char *filename,
+                                                         gpointer user_data);
+const char *        nm_utils_file_search_in_paths       (const char *progname,
+                                                         const char *try_first,
+                                                         const char *const *paths,
+                                                         GFileTest file_test_flags,
+                                                         NMUtilsFileSearchInPathsPredicate predicate,
+                                                         gpointer user_data,
+                                                         GError **error);
+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);
+const char *        nm_utils_wifi_strength_bars         (guint8 strength);
+#define             NM_UTILS_HWADDR_LEN_MAX
+gsize               nm_utils_hwaddr_len                 (int type);
+char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
+                                                         gsize length);
+GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
+                                                         gsize length);
+guint8 *            nm_utils_hwaddr_aton                (const char *asc,
+                                                         gpointer buffer,
+                                                         gsize length);
+gboolean            nm_utils_hwaddr_valid               (const char *asc,
+                                                         gssize length);
+char *              nm_utils_hwaddr_canonical           (const char *asc,
+                                                         gssize length);
+gboolean            nm_utils_hwaddr_matches             (gconstpointer hwaddr1,
+                                                         gssize hwaddr1_len,
+                                                         gconstpointer hwaddr2,
+                                                         gssize hwaddr2_len);
+char *              nm_utils_bin2hexstr                 (gconstpointer src,
+                                                         gsize len,
+                                                         int final_len);
+GBytes *            nm_utils_hexstr2bin                 (const char *hex);
+gboolean            nm_utils_iface_valid_name           (const char *name);
+gboolean            nm_utils_is_uuid                    (const char *str);
+#define             NM_UTILS_INET_ADDRSTRLEN
+const char *        nm_utils_inet4_ntop                 (in_addr_t inaddr,
+                                                         char *dst);
+const char *        nm_utils_inet6_ntop                 (const struct in6_addr *in6addr,
+                                                         char *dst);
+gboolean            nm_utils_ipaddr_valid               (int family,
+                                                         const char *ip);
+gboolean            nm_utils_check_virtual_device_compatibility
+                                                        (GType virtual_type,
+                                                         GType other_type);
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMUtilsSecurityType
+
+
+
+

Description

+

+A collection of utility functions for working with SSIDs, IP addresses, Wi-Fi +access points and devices, among other things. +

+
+
+

Details

+
+

nm_utils_is_empty_ssid ()

+
gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
+                                                         gsize 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. +

+
++++ + + + + + + + + + + + + + + +

ssid :

pointer to a buffer containing the SSID data. [array length=len] +

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,
+                                                         gsize 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. +

+
++++ + + + + + + + + + + + + + + +

ssid :

pointer to a buffer containing the SSID data. [array length=len] +

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 guint8 *ssid1,
+                                                         gsize len1,
+                                                         const guint8 *ssid2,
+                                                         gsize len2,
+                                                         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. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

ssid1 :

the first SSID to compare. [array length=len1] +

len1 :

length of the SSID data in ssid1 +

ssid2 :

the second SSID to compare. [array length=len2] +

len2 :

length of the SSID data in ssid2 +

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 guint8 *ssid,
+                                                         gsize len);
+

+Wi-Fi 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 +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 + the ISO-8859-2 encoding, and if that fails, try the Windows-1250 encoding. + 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_. +

+
++++ + + + + + + + + + + + + + + +

ssid :

pointer to a buffer containing the SSID data. [array length=len] +

len :

length of the SSID data in ssid +

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] +
+
+
+
+

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. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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) +

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 +
+
+
+
+

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 :

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 Wi-Fi device, e.g. +NM_WIFI_DEVICE_CAP_CIPHER_WEP40 +

have_ap :

whether the ap_flags, ap_wpa, and ap_rsn arguments are valid

adhoc :

whether the capabilities being tested are from an Ad-Hoc AP (IBSS)

ap_flags :

bitfield of AP capabilities, e.g. NM_802_11_AP_FLAGS_PRIVACY +

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_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 +against, determines whether the combination of device capabilities and +desired security type are valid for AP/Hotspot connections. +

+
++++ + + + + + + + + + + + + + + +

type :

the security type to check device capabilties against, +e.g. NMU_SEC_STATIC_WEP +

wifi_caps :

bitfield of the capabilities of the specific Wi-Fi 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.
+
+
+
+

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 +

+
++++ + + + + + + + + + + + + + + +

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
+
+
+
+

nm_utils_wpa_psk_valid ()

+
gboolean            nm_utils_wpa_psk_valid              (const char *psk);
+

+Checks if psk is a valid WPA PSK +

+
++++ + + + + + + + + + + +

psk :

a string that might be a WPA PSK

Returns :

 +TRUE if psk is a WPA PSK, FALSE if not
+
+
+
+

nm_utils_ip4_dns_to_variant ()

+
GVariant *          nm_utils_ip4_dns_to_variant         (char **dns);
+

+Utility function to convert an array of IP address strings int a GVariant of +type 'au' representing an array of IPv4 addresses. +

+
++++ + + + + + + + + + + +

dns :

an array of IP address strings. [type utf8] +

Returns :

a new floating GVariant representing dns. [transfer none] +
+
+
+
+

nm_utils_ip4_dns_from_variant ()

+
char **             nm_utils_ip4_dns_from_variant       (GVariant *value);
+

+Utility function to convert a GVariant of type 'au' representing a list of +IPv4 addresses into an array of IP address strings. +

+
++++ + + + + + + + + + + +

value :

a GVariant of type 'au'

Returns :

a NULL-terminated array of IP address strings. [transfer full][type utf8] +
+
+
+
+

nm_utils_ip4_addresses_to_variant ()

+
GVariant *          nm_utils_ip4_addresses_to_variant   (GPtrArray *addresses,
+                                                         const char *gateway);
+

+Utility function to convert a GPtrArray of NMIPAddress objects representing +IPv4 addresses into a GVariant of type 'aau' representing an array of +NetworkManager IPv4 addresses (which are tuples of address, prefix, and +gateway). The "gateway" field of the first address will get the value of +gateway (if non-NULL). In all of the other addresses, that field will be 0. +

+
++++ + + + + + + + + + + + + + + +

addresses :

an array of NMIPAddress objects. [element-type NMIPAddress] +

gateway :

the gateway IP address. [allow-none] +

Returns :

a new floating GVariant representing addresses. [transfer none] +
+
+
+
+

nm_utils_ip4_addresses_from_variant ()

+
GPtrArray *         nm_utils_ip4_addresses_from_variant (GVariant *value,
+                                                         char **out_gateway);
+

+Utility function to convert a GVariant of type 'aau' representing a list of +NetworkManager IPv4 addresses (which are tuples of address, prefix, and +gateway) into a GPtrArray of NMIPAddress objects. The "gateway" field of +the first address (if set) will be returned in out_gateway; the "gateway" fields +of the other addresses are ignored. +

+
++++ + + + + + + + + + + + + + + +

value :

a GVariant of type 'aau'

out_gateway :

on return, will contain the IP gateway. [out][allow-none][transfer full] +

Returns :

a newly allocated +GPtrArray of NMIPAddress objects. [transfer full][element-type NMIPAddress] +
+
+
+
+

nm_utils_ip4_routes_to_variant ()

+
GVariant *          nm_utils_ip4_routes_to_variant      (GPtrArray *routes);
+

+Utility function to convert a GPtrArray of NMIPRoute objects representing +IPv4 routes into a GVariant of type 'aau' representing an array of +NetworkManager IPv4 routes (which are tuples of route, prefix, next hop, and +metric). +

+
++++ + + + + + + + + + + +

routes :

an array of NMIP4Route objects. [element-type NMIPRoute] +

Returns :

a new floating GVariant representing routes. [transfer none] +
+
+
+
+

nm_utils_ip4_routes_from_variant ()

+
GPtrArray *         nm_utils_ip4_routes_from_variant    (GVariant *value);
+

+Utility function to convert a GVariant of type 'aau' representing an array +of NetworkManager IPv4 routes (which are tuples of route, prefix, next hop, +and metric) into a GPtrArray of NMIPRoute objects. +

+
++++ + + + + + + + + + + +

value :

 +GVariant of type 'aau'

Returns :

a newly allocated +GPtrArray of NMIPRoute objects. [transfer full][element-type NMIPRoute] +
+
+
+
+

nm_utils_ip4_netmask_to_prefix ()

+
guint32             nm_utils_ip4_netmask_to_prefix      (guint32 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);
+
++++ + + + + + + + + + + +

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 +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. +

+
++++ + + + + + + + + + + +

ip :

an IPv4 address (in network byte order)

Returns :

the default class prefix for the given IP
+
+
+
+

nm_utils_ip6_dns_to_variant ()

+
GVariant *          nm_utils_ip6_dns_to_variant         (char **dns);
+

+Utility function to convert an array of IP address strings int a GVariant of +type 'aay' representing an array of IPv6 addresses. +

+
++++ + + + + + + + + + + +

dns :

an array of IP address strings. [type utf8] +

Returns :

a new floating GVariant representing dns. [transfer none] +
+
+
+
+

nm_utils_ip6_dns_from_variant ()

+
char **             nm_utils_ip6_dns_from_variant       (GVariant *value);
+

+Utility function to convert a GVariant of type 'aay' representing a list of +IPv6 addresses into an array of IP address strings. +

+
++++ + + + + + + + + + + +

value :

a GVariant of type 'aay'

Returns :

a NULL-terminated array of IP address strings. [transfer full][type utf8] +
+
+
+
+

nm_utils_ip6_addresses_to_variant ()

+
GVariant *          nm_utils_ip6_addresses_to_variant   (GPtrArray *addresses,
+                                                         const char *gateway);
+

+Utility function to convert a GPtrArray of NMIPAddress objects representing +IPv6 addresses into a GVariant of type 'a(ayuay)' representing an array of +NetworkManager IPv6 addresses (which are tuples of address, prefix, and +gateway). The "gateway" field of the first address will get the value of +gateway (if non-NULL). In all of the other addresses, that field will be +all 0s. +

+
++++ + + + + + + + + + + + + + + +

addresses :

an array of NMIPAddress objects. [element-type NMIPAddress] +

gateway :

the gateway IP address. [allow-none] +

Returns :

a new floating GVariant representing addresses. [transfer none] +
+
+
+
+

nm_utils_ip6_addresses_from_variant ()

+
GPtrArray *         nm_utils_ip6_addresses_from_variant (GVariant *value,
+                                                         char **out_gateway);
+

+Utility function to convert a GVariant of type 'a(ayuay)' representing a +list of NetworkManager IPv6 addresses (which are tuples of address, prefix, +and gateway) into a GPtrArray of NMIPAddress objects. The "gateway" field +of the first address (if set) will be returned in out_gateway; the "gateway" +fields of the other addresses are ignored. +

+
++++ + + + + + + + + + + + + + + +

value :

a GVariant of type 'a(ayuay)'

out_gateway :

on return, will contain the IP gateway. [out][allow-none][transfer full] +

Returns :

a newly allocated +GPtrArray of NMIPAddress objects. [transfer full][element-type NMIPAddress] +
+
+
+
+

nm_utils_ip6_routes_to_variant ()

+
GVariant *          nm_utils_ip6_routes_to_variant      (GPtrArray *routes);
+

+Utility function to convert a GPtrArray of NMIPRoute objects representing +IPv6 routes into a GVariant of type 'a(ayuayu)' representing an array of +NetworkManager IPv6 routes (which are tuples of route, prefix, next hop, and +metric). +

+
++++ + + + + + + + + + + +

routes :

an array of NMIPRoute objects. [element-type NMIPRoute] +

Returns :

a new floating GVariant representing routes. [transfer none] +
+
+
+
+

nm_utils_ip6_routes_from_variant ()

+
GPtrArray *         nm_utils_ip6_routes_from_variant    (GVariant *value);
+

+Utility function to convert a GVariant of type 'a(ayuayu)' representing an +array of NetworkManager IPv6 routes (which are tuples of route, prefix, next +hop, and metric) into a GPtrArray of NMIPRoute objects. +

+
++++ + + + + + + + + + + +

value :

 +GVariant of type 'a(ayuayu)'

Returns :

a newly allocated +GPtrArray of NMIPRoute objects. [transfer full][element-type NMIPRoute] +
+
+
+
+

nm_utils_ip_addresses_to_variant ()

+
GVariant *          nm_utils_ip_addresses_to_variant    (GPtrArray *addresses);
+

+Utility function to convert a GPtrArray of NMIPAddress objects representing +IPv4 or IPv6 addresses into a GVariant of type 'aa{sv}' representing an +array of new-style NetworkManager IP addresses. All addresses will include +"address" (an IP address string), and "prefix" (a uint). Some addresses may +include additional attributes. +

+
++++ + + + + + + + + + + +

addresses :

an array of NMIPAddress objects. [element-type NMIPAddress] +

Returns :

a new floating GVariant representing addresses. [transfer none] +
+
+
+
+

nm_utils_ip_addresses_from_variant ()

+
GPtrArray *         nm_utils_ip_addresses_from_variant  (GVariant *value,
+                                                         int family);
+

+Utility function to convert a GVariant representing a list of new-style +NetworkManager IPv4 or IPv6 addresses (as described in the documentation for +nm_utils_ip_addresses_to_variant()) into a GPtrArray of NMIPAddress +objects. +

+
++++ + + + + + + + + + + + + + + +

value :

a GVariant of type 'aa{sv}'

family :

an IP address family

Returns :

a newly allocated +GPtrArray of NMIPAddress objects. [transfer full][element-type NMIPAddress] +
+
+
+
+

nm_utils_ip_routes_to_variant ()

+
GVariant *          nm_utils_ip_routes_to_variant       (GPtrArray *routes);
+

+Utility function to convert a GPtrArray of NMIPRoute objects representing +IPv4 or IPv6 routes into a GVariant of type 'aa{sv}' representing an array +of new-style NetworkManager IP routes (which are tuples of destination, +prefix, next hop, metric, and additional attributes). +

+
++++ + + + + + + + + + + +

routes :

an array of NMIPRoute objects. [element-type NMIPRoute] +

Returns :

a new floating GVariant representing routes. [transfer none] +
+
+
+
+

nm_utils_ip_routes_from_variant ()

+
GPtrArray *         nm_utils_ip_routes_from_variant     (GVariant *value,
+                                                         int family);
+

+Utility function to convert a GVariant representing a list of new-style +NetworkManager IPv4 or IPv6 addresses (which are tuples of destination, +prefix, next hop, metric, and additional attributes) into a GPtrArray of +NMIPRoute objects. +

+
++++ + + + + + + + + + + + + + + +

value :

a GVariant of type 'aa{sv}'

family :

an IP address family

Returns :

a newly allocated +GPtrArray of NMIPRoute objects. [transfer full][element-type NMIPRoute] +
+
+
+
+

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_file_is_certificate ()

+
gboolean            nm_utils_file_is_certificate        (const char *filename);
+

+Tests if filename has a valid extension for an X.509 certificate file +(".cer", ".crt", ".der", or ".pem"), and contains a certificate in a format +recognized by NetworkManager. +

+
++++ + + + + + + + + + + +

filename :

name of the file to test

Returns :

 +TRUE if the file is a certificate, FALSE if it is not
+
+
+
+

nm_utils_file_is_private_key ()

+
gboolean            nm_utils_file_is_private_key        (const char *filename,
+                                                         gboolean *out_encrypted);
+

+Tests if filename has a valid extension for an X.509 private key file +(".der", ".key", ".pem", or ".p12"), and contains a private key in a format +recognized by NetworkManager. +

+
++++ + + + + + + + + + + + + + + +

filename :

name of the file to test

out_encrypted :

on return, whether the file is encrypted. [out] +

Returns :

 +TRUE if the file is a private key, FALSE if it is not
+
+
+
+

nm_utils_file_is_pkcs12 ()

+
gboolean            nm_utils_file_is_pkcs12             (const char *filename);
+

+Tests if filename is a PKCS#12 file. +

+
++++ + + + + + + + + + + +

filename :

name of the file to test

Returns :

 +TRUE if the file is PKCS#12, FALSE if it is not
+
+
+
+

NMUtilsFileSearchInPathsPredicate ()

+
gboolean            (*NMUtilsFileSearchInPathsPredicate)
+                                                        (const char *filename,
+                                                         gpointer user_data);
+

+

+
+
+
+

nm_utils_file_search_in_paths ()

+
const char *        nm_utils_file_search_in_paths       (const char *progname,
+                                                         const char *try_first,
+                                                         const char *const *paths,
+                                                         GFileTest file_test_flags,
+                                                         NMUtilsFileSearchInPathsPredicate predicate,
+                                                         gpointer user_data,
+                                                         GError **error);
+

+Searches for a progname file in a list of search paths. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

progname :

the helper program name, like "iptables" +Must be a non-empty string, without path separator (/).

try_first :

a custom path to try first before searching. +It is silently ignored if it is empty or not an absolute path. [allow-none] +

paths :

a NULL terminated list of search paths. +Can be empty or NULL, in which case only try_first is checked. [allow-none] +

file_test_flags :

the flags passed to g_file_test() when searching +for progname. Set it to 0 to skip the g_file_test().

predicate :

if given, pass the file name to this function +for additional checks. This check is performed after the check for +file_test_flags. You cannot omit both file_test_flags and predicate. [scope call] +

user_data :

(allow-none): user data for predicate function. [closure] +

error :

on failure, a "not found" error using error_domain and error_code +

Returns :

the full path to the helper, if found, or NULL if not found. +The returned string is not owned by the caller, but later +invocations of the function might overwrite it. [transfer none] +
+
+
+
+

nm_utils_wifi_freq_to_channel ()

+
guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);
+

+Utility function to translate a Wi-Fi frequency to its corresponding channel. +

+
++++ + + + + + + + + + + +

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 Wi-Fi channel to its corresponding frequency. +

+
++++ + + + + + + + + + + + + + + +

channel :

channel

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 Wi-Fi channel for a channel. +

+
++++ + + + + + + + + + + + + + + + + + + +

channel :

current channel

direction :

whether going downward (0 or less) or upward (1 or more)

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 Wi-Fi channel validity. +

+
++++ + + + + + + + + + + + + + + +

channel :

channel

band :

frequency band for wireless ("a" or "bg")

Returns :

 +TRUE or FALSE +
+
+
+
+

nm_utils_wifi_strength_bars ()

+
const char *        nm_utils_wifi_strength_bars         (guint8 strength);
+

+Converts strength into a 4-character-wide graphical representation of +strength suitable for printing to stdout. If the current locale and terminal +support it, this will use unicode graphics characters to represent +"bars". Otherwise it will use 0 to 4 asterisks. +

+
++++ + + + + + + + + + + +

strength :

the access point strength, from 0 to 100

Returns :

the graphical representation of the access point strength
+
+
+
+

NM_UTILS_HWADDR_LEN_MAX

+
#define NM_UTILS_HWADDR_LEN_MAX 20 /* INFINIBAND_ALEN */
+
+

+The maximum length of hardware addresses handled by NetworkManager itself, +nm_utils_hwaddr_len(), and nm_utils_hwaddr_aton(). +

+
+
+
+

nm_utils_hwaddr_len ()

+
gsize               nm_utils_hwaddr_len                 (int type);
+

+Returns the length in octets of a hardware address of type type. +

+

+It is an error to call this function with any value other than +ARPHRD_ETHER or ARPHRD_INFINIBAND. +

+
++++ + + + + + + + + + + +

type :

the type of address; either ARPHRD_ETHER or +ARPHRD_INFINIBAND +

Returns :

the length.
+
+
+
+

nm_utils_hwaddr_ntoa ()

+
char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
+                                                         gsize length);
+

+Converts addr to textual form. +

+
++++ + + + + + + + + + + + + + + +

addr :

a binary hardware address. [type guint8][array length=length] +

length :

the length of addr +

Returns :

the textual form of addr. [transfer full] +
+
+
+
+

nm_utils_hwaddr_atoba ()

+
GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
+                                                         gsize length);
+

+Parses asc and converts it to binary form in a GByteArray. See +nm_utils_hwaddr_aton() if you don't want a GByteArray. +

+
++++ + + + + + + + + + + + + + + +

asc :

the ASCII representation of a hardware address

length :

the expected length in bytes of the result

Returns :

a new GByteArray, or NULL if asc couldn't +be parsed. [transfer full] +
+
+
+
+

nm_utils_hwaddr_aton ()

+
guint8 *            nm_utils_hwaddr_aton                (const char *asc,
+                                                         gpointer buffer,
+                                                         gsize length);
+

+Parses asc and converts it to binary form in buffer. +Bytes in asc can be sepatared by colons (:), or hyphens (-), but not mixed. +

+
++++ + + + + + + + + + + + + + + + + + + +

asc :

the ASCII representation of a hardware address

buffer :

buffer to store the result into

length :

the expected length in bytes of the result and +the size of the buffer in bytes.

Returns :

 +buffer, or NULL if asc couldn't be parsed +or would be shorter or longer than length.
+
+
+
+

nm_utils_hwaddr_valid ()

+
gboolean            nm_utils_hwaddr_valid               (const char *asc,
+                                                         gssize length);
+

+Parses asc to see if it is a valid hardware address of the given +length. +

+
++++ + + + + + + + + + + + + + + +

asc :

the ASCII representation of a hardware address

length :

the length of address that asc is expected to convert to +(or -1 to accept any length up to NM_UTILS_HWADDR_LEN_MAX)

Returns :

 +TRUE if asc appears to be a valid hardware address +of the indicated length, FALSE if not.
+
+
+
+

nm_utils_hwaddr_canonical ()

+
char *              nm_utils_hwaddr_canonical           (const char *asc,
+                                                         gssize length);
+

+Parses asc to see if it is a valid hardware address of the given +length, and if so, returns it in canonical form (uppercase, with +leading 0s as needed, and with colons rather than hyphens). +

+
++++ + + + + + + + + + + + + + + +

asc :

the ASCII representation of a hardware address

length :

the length of address that asc is expected to convert to +(or -1 to accept any length up to NM_UTILS_HWADDR_LEN_MAX)

Returns :

the canonicalized address if asc appears to +be a valid hardware address of the indicated length, NULL if not. [transfer full] +
+
+
+
+

nm_utils_hwaddr_matches ()

+
gboolean            nm_utils_hwaddr_matches             (gconstpointer hwaddr1,
+                                                         gssize hwaddr1_len,
+                                                         gconstpointer hwaddr2,
+                                                         gssize hwaddr2_len);
+

+Generalized hardware address comparison function. Tests if hwaddr1 and +hwaddr2 "equal" (or more precisely, "equivalent"), with several advantages +over a simple memcmp(): +

+

+ 1. If hwaddr1_len or hwaddr2_len is -1, then the corresponding address is + assumed to be ASCII rather than binary, and will be converted to binary + before being compared. +

+

+ 2. If hwaddr1 or hwaddr2 is NULL, it is treated instead as though it was + a zero-filled buffer hwaddr1_len or hwaddr2_len bytes long. +

+

+ 3. If hwaddr1 and hwaddr2 are InfiniBand hardware addresses (that is, if + they are INFINIBAND_ALEN bytes long in binary form) + then only the last 8 bytes are compared, since those are the only bytes + that actually identify the hardware. (The other 12 bytes will change + depending on the configuration of the InfiniBand fabric that the device + is connected to.) +

+

+If a passed-in ASCII hardware address cannot be parsed, or would parse to an +address larger than NM_UTILS_HWADDR_LEN_MAX, then it will silently fail to +match. (This means that externally-provided address strings do not need to be +sanity-checked before comparing them against known good addresses; they are +guaranteed to not match if they are invalid.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

hwaddr1 :

pointer to a binary or ASCII hardware address, or NULL +

hwaddr1_len :

size of hwaddr1, or -1 if hwaddr1 is ASCII

hwaddr2 :

pointer to a binary or ASCII hardware address, or NULL +

hwaddr2_len :

size of hwaddr2, or -1 if hwaddr2 is ASCII

Returns :

 +TRUE if hwaddr1 and hwaddr2 are equivalent, FALSE if they are +different (or either of them is invalid).
+
+
+
+

nm_utils_bin2hexstr ()

+
char *              nm_utils_bin2hexstr                 (gconstpointer src,
+                                                         gsize len,
+                                                         int final_len);
+

+Converts the byte array src into a hexadecimal string. If final_len is +greater than -1, the returned string is terminated at that index +(returned_string[final_len] == '\0'), +

+
++++ + + + + + + + + + + + + + + + + + + +

src :

an array of bytes. [type guint8][array length=len] +

len :

the length of the src array

final_len :

an index where to cut off the returned string, or -1

Returns :

the textual form of bytes. [transfer full] +
+
+
+
+

nm_utils_hexstr2bin ()

+
GBytes *            nm_utils_hexstr2bin                 (const char *hex);
+

+Converts a hexadecimal string hex into an array of bytes. The optional +separator ':' may be used between single or pairs of hexadecimal characters, +eg "00:11" or "0:1". Any "0x" at the beginning of hex is ignored. hex +may not start or end with ':'. +

+
++++ + + + + + + + + + + +

hex :

a string of hexadecimal characters with optional ':' separators

Returns :

the converted bytes, or NULL on error. [transfer full] +
+
+
+
+

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

Returns :

 +TRUE if interface name is valid, otherwise FALSE is returned.
+
+
+
+

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
+
+
+
+

NM_UTILS_INET_ADDRSTRLEN

+
#define NM_UTILS_INET_ADDRSTRLEN     INET6_ADDRSTRLEN
+
+

+Defines the minimal length for a char buffer that is suitable as dst argument +for both nm_utils_inet4_ntop() and nm_utils_inet6_ntop(). +

+
+
+
+

nm_utils_inet4_ntop ()

+
const char *        nm_utils_inet4_ntop                 (in_addr_t inaddr,
+                                                         char *dst);
+

+Wrapper for inet_ntop. +

+
++++ + + + + + + + + + + + + + + +

inaddr :

the address that should be converted to string.

dst :

the destination buffer, it must contain at least +INET_ADDRSTRLEN or NM_UTILS_INET_ADDRSTRLEN +characters. If set to NULL, it will return a pointer to an internal, static +buffer (shared with nm_utils_inet6_ntop()). Beware, that the internal +buffer will be overwritten with ever new call of nm_utils_inet4_ntop() or +nm_utils_inet6_ntop() that does not provied it's own dst buffer. Also, +using the internal buffer is not thread safe. When in doubt, pass your own +dst buffer to avoid these issues.

Returns :

the input buffer dst, or a pointer to an +internal, static buffer. This function cannot fail.
+
+
+
+

nm_utils_inet6_ntop ()

+
const char *        nm_utils_inet6_ntop                 (const struct in6_addr *in6addr,
+                                                         char *dst);
+

+Wrapper for inet_ntop. +

+
++++ + + + + + + + + + + + + + + +

in6addr :

the address that should be converted to string.

dst :

the destination buffer, it must contain at least +INET6_ADDRSTRLEN or NM_UTILS_INET_ADDRSTRLEN +characters. If set to NULL, it will return a pointer to an internal, static +buffer (shared with nm_utils_inet4_ntop()). Beware, that the internal +buffer will be overwritten with ever new call of nm_utils_inet4_ntop() or +nm_utils_inet6_ntop() that does not provied it's own dst buffer. Also, +using the internal buffer is not thread safe. When in doubt, pass your own +dst buffer to avoid these issues.

Returns :

the input buffer dst, or a pointer to an +internal, static buffer. NULL is not allowed as in6addr, +otherwise, this function cannot fail.
+
+
+
+

nm_utils_ipaddr_valid ()

+
gboolean            nm_utils_ipaddr_valid               (int family,
+                                                         const char *ip);
+

+Checks if ip contains a valid IP address of the given family. +

+
++++ + + + + + + + + + + + + + + +

family :

 +AF_INET or AF_INET6, or +AF_UNSPEC to accept either

ip :

an IP address

Returns :

 +TRUE or FALSE +
+
+
+
+

nm_utils_check_virtual_device_compatibility ()

+
gboolean            nm_utils_check_virtual_device_compatibility
+                                                        (GType virtual_type,
+                                                         GType other_type);
+

+Determines if a connection of type virtual_type can (in the +general case) work with connections of type other_type. +

+

+If virtual_type is NM_TYPE_SETTING_VLAN, then this checks if +other_type is a valid type for the parent of a VLAN. +

+

+If virtual_type is a "master" type (eg, NM_TYPE_SETTING_BRIDGE), +then this checks if other_type is a valid type for a slave of that +master. +

+

+Note that even if this returns TRUE it is not guaranteed that +every connection of type other_type is +compatible with virtual_type; it may depend on the exact +configuration of the two connections, or on the capabilities of an +underlying device driver. +

+
++++ + + + + + + + + + + + + + + +

virtual_type :

a virtual connection type

other_type :

a connection type to test against virtual_type +

Returns :

 +TRUE or FALSE +
+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/libnm-nm-version.html b/docs/libnm/html/libnm-nm-version.html new file mode 100644 index 00000000..a260fbea --- /dev/null +++ b/docs/libnm/html/libnm-nm-version.html @@ -0,0 +1,249 @@ + + + + +nm-version + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-version

+

nm-version

+
+
+

Synopsis

+
#define             NM_MAJOR_VERSION
+#define             NM_MINOR_VERSION
+#define             NM_MICRO_VERSION
+#define             NM_CHECK_VERSION                    (major,
+                                                         minor,
+                                                         micro)
+#define             NM_ENCODE_VERSION                   (major,
+                                                         minor,
+                                                         micro)
+#define             NM_VERSION_0_9_8
+#define             NM_VERSION_0_9_10
+#define             NM_VERSION_1_0
+#define             NM_VERSION_CUR_STABLE
+#define             NM_VERSION_NEXT_STABLE
+#define             NM_VERSION_MIN_REQUIRED
+#define             NM_VERSION_MAX_ALLOWED
+#define             NM_DEPRECATED_IN_0_9_10
+#define             NM_DEPRECATED_IN_0_9_10_FOR         (f)
+#define             NM_DEPRECATED_IN_1_0
+#define             NM_DEPRECATED_IN_1_0_FOR            (f)
+#define             NM_AVAILABLE_IN_0_9_10
+#define             NM_AVAILABLE_IN_1_0
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_MAJOR_VERSION

+
#define NM_MAJOR_VERSION (1)
+
+

+Evaluates to the major version number of NetworkManager which this source +is compiled against. +

+
+
+
+

NM_MINOR_VERSION

+
#define NM_MINOR_VERSION (0)
+
+

+Evaluates to the minor version number of NetworkManager which this source +is compiled against. +

+
+
+
+

NM_MICRO_VERSION

+
#define NM_MICRO_VERSION (0)
+
+

+Evaluates to the micro version number of NetworkManager which this source +compiled against. +

+
+
+
+

NM_CHECK_VERSION()

+
#define             NM_CHECK_VERSION(major,minor,micro)
+
++++ + + + + + + + + + + + + + + + + + + +

major :

major version (e.g. 1 for version 1.2.5)

minor :

minor version (e.g. 2 for version 1.2.5)

micro :

micro version (e.g. 5 for version 1.2.5)

Returns :

 +TRUE if the version of the NetworkManager header files +is the same as or newer than the passed-in version.
+
+
+
+

NM_ENCODE_VERSION()

+
#define NM_ENCODE_VERSION(major,minor,micro) ((major) << 16 | (minor) << 8 | (micro))
+
+

+

+
+
+
+

NM_VERSION_0_9_8

+
#define NM_VERSION_0_9_8  (NM_ENCODE_VERSION (0, 9, 8))
+
+

+

+
+
+
+

NM_VERSION_0_9_10

+
#define NM_VERSION_0_9_10 (NM_ENCODE_VERSION (0, 9, 10))
+
+

+

+
+
+
+

NM_VERSION_1_0

+
#define NM_VERSION_1_0    (NM_ENCODE_VERSION (1, 0, 0))
+
+

+

+
+
+
+

NM_VERSION_CUR_STABLE

+
#define NM_VERSION_CUR_STABLE  NM_VERSION_0_9_10
+
+

+

+
+
+
+

NM_VERSION_NEXT_STABLE

+
#define NM_VERSION_NEXT_STABLE NM_VERSION_1_0
+
+

+

+
+
+
+

NM_VERSION_MIN_REQUIRED

+
# define NM_VERSION_MIN_REQUIRED (NM_VERSION_CUR_STABLE)
+
+

+

+
+
+
+

NM_VERSION_MAX_ALLOWED

+
# define NM_VERSION_MAX_ALLOWED (NM_VERSION_CUR_STABLE)
+
+

+

+
+
+
+

NM_DEPRECATED_IN_0_9_10

+
# define NM_DEPRECATED_IN_0_9_10        G_DEPRECATED
+
+

+

+
+
+
+

NM_DEPRECATED_IN_0_9_10_FOR()

+
# define NM_DEPRECATED_IN_0_9_10_FOR(f) G_DEPRECATED_FOR(f)
+
+

+

+
+
+
+

NM_DEPRECATED_IN_1_0

+
# define NM_DEPRECATED_IN_1_0           G_DEPRECATED
+
+

+

+
+
+
+

NM_DEPRECATED_IN_1_0_FOR()

+
# define NM_DEPRECATED_IN_1_0_FOR(f)    G_DEPRECATED_FOR(f)
+
+

+

+
+
+
+

NM_AVAILABLE_IN_0_9_10

+
# define NM_AVAILABLE_IN_0_9_10         G_UNAVAILABLE(0.9,10)
+
+

+

+
+
+
+

NM_AVAILABLE_IN_1_0

+
# define NM_AVAILABLE_IN_1_0            G_UNAVAILABLE(1,0)
+
+

+

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/libnm-nm-vpn-dbus-interface.html b/docs/libnm/html/libnm-nm-vpn-dbus-interface.html new file mode 100644 index 00000000..3460e107 --- /dev/null +++ b/docs/libnm/html/libnm-nm-vpn-dbus-interface.html @@ -0,0 +1,882 @@ + + + + +nm-vpn-dbus-interface + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-vpn-dbus-interface

+

nm-vpn-dbus-interface

+
+
+

Synopsis

+
#define             NM_DBUS_PATH_VPN
+#define             NM_DBUS_INTERFACE_VPN
+#define             NM_DBUS_PATH_VPN_CONNECTION
+#define             NM_DBUS_INTERFACE_VPN_CONNECTION
+#define             NM_VPN_DBUS_PLUGIN_PATH
+#define             NM_VPN_DBUS_PLUGIN_INTERFACE
+#define             NM_DBUS_NO_ACTIVE_VPN_CONNECTION
+#define             NM_DBUS_NO_VPN_CONNECTIONS
+#define             NM_DBUS_INVALID_VPN_CONNECTION
+#define             NM_DBUS_VPN_ERROR_PREFIX
+#define             NM_DBUS_VPN_STARTING_IN_PROGRESS
+#define             NM_DBUS_VPN_ALREADY_STARTED
+#define             NM_DBUS_VPN_STOPPING_IN_PROGRESS
+#define             NM_DBUS_VPN_ALREADY_STOPPED
+#define             NM_DBUS_VPN_WRONG_STATE
+#define             NM_DBUS_VPN_BAD_ARGUMENTS
+#define             NM_DBUS_VPN_INTERACTIVE_NOT_SUPPORTED
+#define             NM_DBUS_VPN_SIGNAL_LOGIN_BANNER
+#define             NM_DBUS_VPN_SIGNAL_LOGIN_FAILED
+#define             NM_DBUS_VPN_SIGNAL_LAUNCH_FAILED
+#define             NM_DBUS_VPN_SIGNAL_CONNECT_FAILED
+#define             NM_DBUS_VPN_SIGNAL_VPN_CONFIG_BAD
+#define             NM_DBUS_VPN_SIGNAL_IP_CONFIG_BAD
+#define             NM_DBUS_VPN_SIGNAL_STATE_CHANGE
+#define             NM_DBUS_VPN_SIGNAL_IP4_CONFIG
+enum                NMVpnServiceState;
+enum                NMVpnConnectionState;
+enum                NMVpnConnectionStateReason;
+enum                NMVpnPluginFailure;
+#define             NM_VPN_PLUGIN_CONFIG_TUNDEV
+#define             NM_VPN_PLUGIN_CONFIG_BANNER
+#define             NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY
+#define             NM_VPN_PLUGIN_CONFIG_MTU
+#define             NM_VPN_PLUGIN_CONFIG_HAS_IP4
+#define             NM_VPN_PLUGIN_CONFIG_HAS_IP6
+#define             NM_VPN_PLUGIN_CAN_PERSIST
+#define             NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY
+#define             NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS
+#define             NM_VPN_PLUGIN_IP4_CONFIG_PTP
+#define             NM_VPN_PLUGIN_IP4_CONFIG_PREFIX
+#define             NM_VPN_PLUGIN_IP4_CONFIG_DNS
+#define             NM_VPN_PLUGIN_IP4_CONFIG_NBNS
+#define             NM_VPN_PLUGIN_IP4_CONFIG_MSS
+#define             NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN
+#define             NM_VPN_PLUGIN_IP4_CONFIG_DOMAINS
+#define             NM_VPN_PLUGIN_IP4_CONFIG_ROUTES
+#define             NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT
+#define             NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY
+#define             NM_VPN_PLUGIN_IP4_CONFIG_BANNER
+#define             NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY
+#define             NM_VPN_PLUGIN_IP4_CONFIG_MTU
+#define             NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV
+#define             NM_VPN_PLUGIN_IP6_CONFIG_INT_GATEWAY
+#define             NM_VPN_PLUGIN_IP6_CONFIG_ADDRESS
+#define             NM_VPN_PLUGIN_IP6_CONFIG_PTP
+#define             NM_VPN_PLUGIN_IP6_CONFIG_PREFIX
+#define             NM_VPN_PLUGIN_IP6_CONFIG_DNS
+#define             NM_VPN_PLUGIN_IP6_CONFIG_MSS
+#define             NM_VPN_PLUGIN_IP6_CONFIG_DOMAIN
+#define             NM_VPN_PLUGIN_IP6_CONFIG_DOMAINS
+#define             NM_VPN_PLUGIN_IP6_CONFIG_ROUTES
+#define             NM_VPN_PLUGIN_IP6_CONFIG_NEVER_DEFAULT
+
+
+
+

Object Hierarchy

+
+  GEnum
+   +----NMVpnServiceState
+
+
+  GEnum
+   +----NMVpnConnectionState
+
+
+  GEnum
+   +----NMVpnConnectionStateReason
+
+
+  GEnum
+   +----NMVpnPluginFailure
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DBUS_PATH_VPN

+
#define NM_DBUS_PATH_VPN                  "/org/freedesktop/NetworkManager/VPN/Manager"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_VPN

+
#define NM_DBUS_INTERFACE_VPN             "org.freedesktop.NetworkManager.VPN.Manager"
+
+

+

+
+
+
+

NM_DBUS_PATH_VPN_CONNECTION

+
#define NM_DBUS_PATH_VPN_CONNECTION       "/org/freedesktop/NetworkManager/VPN/Connection"
+
+

+

+
+
+
+

NM_DBUS_INTERFACE_VPN_CONNECTION

+
#define NM_DBUS_INTERFACE_VPN_CONNECTION  "org.freedesktop.NetworkManager.VPN.Connection"
+
+

+

+
+
+
+

NM_VPN_DBUS_PLUGIN_PATH

+
#define NM_VPN_DBUS_PLUGIN_PATH           "/org/freedesktop/NetworkManager/VPN/Plugin"
+
+

+

+
+
+
+

NM_VPN_DBUS_PLUGIN_INTERFACE

+
#define NM_VPN_DBUS_PLUGIN_INTERFACE      "org.freedesktop.NetworkManager.VPN.Plugin"
+
+

+

+
+
+
+

NM_DBUS_NO_ACTIVE_VPN_CONNECTION

+
#define NM_DBUS_NO_ACTIVE_VPN_CONNECTION "org.freedesktop.NetworkManager.VPNConnections.NoActiveVPNConnection"
+
+

+

+
+
+
+

NM_DBUS_NO_VPN_CONNECTIONS

+
#define NM_DBUS_NO_VPN_CONNECTIONS       "org.freedesktop.NetworkManager.VPNConnections.NoVPNConnections"
+
+

+

+
+
+
+

NM_DBUS_INVALID_VPN_CONNECTION

+
#define NM_DBUS_INVALID_VPN_CONNECTION   "org.freedesktop.NetworkManager.VPNConnections.InvalidVPNConnection"
+
+

+

+
+
+
+

NM_DBUS_VPN_ERROR_PREFIX

+
#define NM_DBUS_VPN_ERROR_PREFIX              "org.freedesktop.NetworkManager.VPN.Error"
+
+

+

+
+
+
+

NM_DBUS_VPN_STARTING_IN_PROGRESS

+
#define NM_DBUS_VPN_STARTING_IN_PROGRESS      "StartingInProgress"
+
+

+

+
+
+
+

NM_DBUS_VPN_ALREADY_STARTED

+
#define NM_DBUS_VPN_ALREADY_STARTED           "AlreadyStarted"
+
+

+

+
+
+
+

NM_DBUS_VPN_STOPPING_IN_PROGRESS

+
#define NM_DBUS_VPN_STOPPING_IN_PROGRESS      "StoppingInProgress"
+
+

+

+
+
+
+

NM_DBUS_VPN_ALREADY_STOPPED

+
#define NM_DBUS_VPN_ALREADY_STOPPED           "AlreadyStopped"
+
+

+

+
+
+
+

NM_DBUS_VPN_WRONG_STATE

+
#define NM_DBUS_VPN_WRONG_STATE               "WrongState"
+
+

+

+
+
+
+

NM_DBUS_VPN_BAD_ARGUMENTS

+
#define NM_DBUS_VPN_BAD_ARGUMENTS             "BadArguments"
+
+

+

+
+
+
+

NM_DBUS_VPN_INTERACTIVE_NOT_SUPPORTED

+
#define NM_DBUS_VPN_INTERACTIVE_NOT_SUPPORTED "InteractiveNotSupported"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_LOGIN_BANNER

+
#define NM_DBUS_VPN_SIGNAL_LOGIN_BANNER   "LoginBanner"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_LOGIN_FAILED

+
#define NM_DBUS_VPN_SIGNAL_LOGIN_FAILED   "LoginFailed"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_LAUNCH_FAILED

+
#define NM_DBUS_VPN_SIGNAL_LAUNCH_FAILED  "LaunchFailed"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_CONNECT_FAILED

+
#define NM_DBUS_VPN_SIGNAL_CONNECT_FAILED "ConnectFailed"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_VPN_CONFIG_BAD

+
#define NM_DBUS_VPN_SIGNAL_VPN_CONFIG_BAD "VPNConfigBad"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_IP_CONFIG_BAD

+
#define NM_DBUS_VPN_SIGNAL_IP_CONFIG_BAD  "IPConfigBad"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_STATE_CHANGE

+
#define NM_DBUS_VPN_SIGNAL_STATE_CHANGE   "StateChange"
+
+

+

+
+
+
+

NM_DBUS_VPN_SIGNAL_IP4_CONFIG

+
#define NM_DBUS_VPN_SIGNAL_IP4_CONFIG     "IP4Config"
+
+

+

+
+
+
+

enum NMVpnServiceState

+
typedef enum {
+	NM_VPN_SERVICE_STATE_UNKNOWN = 0,
+	NM_VPN_SERVICE_STATE_INIT,
+	NM_VPN_SERVICE_STATE_SHUTDOWN,
+	NM_VPN_SERVICE_STATE_STARTING,
+	NM_VPN_SERVICE_STATE_STARTED,
+	NM_VPN_SERVICE_STATE_STOPPING,
+	NM_VPN_SERVICE_STATE_STOPPED
+} NMVpnServiceState;
+
+

+VPN daemon states +

+

+(Corresponds to the NM_VPN_SERVICE_STATE type in nm-vpn-connection.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_VPN_SERVICE_STATE_UNKNOWN

The state of the VPN plugin is unknown. +

NM_VPN_SERVICE_STATE_INIT

The VPN plugin is initialized. +

NM_VPN_SERVICE_STATE_SHUTDOWN

Not used. +

NM_VPN_SERVICE_STATE_STARTING

The plugin is attempting to connect to a VPN server. +

NM_VPN_SERVICE_STATE_STARTED

The plugin has connected to a VPN server. +

NM_VPN_SERVICE_STATE_STOPPING

The plugin is disconnecting from the VPN server. +

NM_VPN_SERVICE_STATE_STOPPED

The plugin has disconnected from the VPN server. +
+
+
+
+

enum NMVpnConnectionState

+
typedef enum {
+	NM_VPN_CONNECTION_STATE_UNKNOWN = 0,
+	NM_VPN_CONNECTION_STATE_PREPARE,
+	NM_VPN_CONNECTION_STATE_NEED_AUTH,
+	NM_VPN_CONNECTION_STATE_CONNECT,
+	NM_VPN_CONNECTION_STATE_IP_CONFIG_GET,
+	NM_VPN_CONNECTION_STATE_ACTIVATED,
+	NM_VPN_CONNECTION_STATE_FAILED,
+	NM_VPN_CONNECTION_STATE_DISCONNECTED
+} NMVpnConnectionState;
+
+

+VPN connection states +

+

+(Corresponds to the NM_VPN_CONNECTION_STATE type in nm-vpn-connection.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_VPN_CONNECTION_STATE_UNKNOWN

The state of the VPN connection is + unknown. +

NM_VPN_CONNECTION_STATE_PREPARE

The VPN connection is preparing to + connect. +

NM_VPN_CONNECTION_STATE_NEED_AUTH

The VPN connection needs authorization + credentials. +

NM_VPN_CONNECTION_STATE_CONNECT

The VPN connection is being established. +

NM_VPN_CONNECTION_STATE_IP_CONFIG_GET

The VPN connection is getting an IP + address. +

NM_VPN_CONNECTION_STATE_ACTIVATED

The VPN connection is active. +

NM_VPN_CONNECTION_STATE_FAILED

The VPN connection failed. +

NM_VPN_CONNECTION_STATE_DISCONNECTED

The VPN connection is disconnected. +
+
+
+
+

enum NMVpnConnectionStateReason

+
typedef enum {
+	NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0,
+	NM_VPN_CONNECTION_STATE_REASON_NONE,
+	NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED,
+	NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED,
+	NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED,
+	NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID,
+	NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT,
+	NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT,
+	NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED,
+	NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS,
+	NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED,
+	NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED
+} NMVpnConnectionStateReason;
+
+

+VPN connection state reasons +

+

+(Corresponds to the NM_VPN_CONNECTION_STATE_REASON type in nm-vpn-connection.xml.) +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

NM_VPN_CONNECTION_STATE_REASON_UNKNOWN

The reason for the VPN connection + state change is unknown. +

NM_VPN_CONNECTION_STATE_REASON_NONE

No reason was given for the VPN + connection state change. +

NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED

The VPN connection changed + state because the user disconnected it. +

NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED

The VPN connection + changed state because the device it was using was disconnected. +

NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED

The service providing the + VPN connection was stopped. +

NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID

The IP config of the VPN + connection was invalid. +

NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT

The connection attempt to + the VPN service timed out. +

NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT

A timeout occurred + while starting the service providing the VPN connection. +

NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED

Starting the service + starting the service providing the VPN connection failed. +

NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS

Necessary secrets for the VPN + connection were not provided. +

NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED

Authentication to the VPN + server failed. +

NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED

The connection was + deleted from settings. +
+
+
+
+

enum NMVpnPluginFailure

+
typedef enum {
+	NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED,
+	NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED,
+	NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG
+} NMVpnPluginFailure;
+
+

+VPN plugin failure reasons +

+

+(Corresponds to the NM_VPN_PLUGIN_FAILURE type in nm-vpn-plugin.xml.) +

+
++++ + + + + + + + + + + + + + + +

NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED

Login failed. +

NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED

Connect failed. +

NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG

Invalid IP configuration returned from + the VPN plugin. +
+
+
+
+

NM_VPN_PLUGIN_CONFIG_TUNDEV

+
#define NM_VPN_PLUGIN_CONFIG_TUNDEV      "tundev"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_CONFIG_BANNER

+
#define NM_VPN_PLUGIN_CONFIG_BANNER      "banner"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY

+
#define NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY "gateway"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_CONFIG_MTU

+
#define NM_VPN_PLUGIN_CONFIG_MTU         "mtu"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_CONFIG_HAS_IP4

+
#define NM_VPN_PLUGIN_CONFIG_HAS_IP4     "has-ip4"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_CONFIG_HAS_IP6

+
#define NM_VPN_PLUGIN_CONFIG_HAS_IP6     "has-ip6"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_CAN_PERSIST

+
#define NM_VPN_PLUGIN_CAN_PERSIST        "can-persist"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY

+
#define NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY "internal-gateway"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS

+
#define NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS     "address"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_PTP

+
#define NM_VPN_PLUGIN_IP4_CONFIG_PTP         "ptp"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_PREFIX

+
#define NM_VPN_PLUGIN_IP4_CONFIG_PREFIX      "prefix"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_DNS

+
#define NM_VPN_PLUGIN_IP4_CONFIG_DNS         "dns"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_NBNS

+
#define NM_VPN_PLUGIN_IP4_CONFIG_NBNS        "nbns"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_MSS

+
#define NM_VPN_PLUGIN_IP4_CONFIG_MSS         "mss"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN

+
#define NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN      "domain"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_DOMAINS

+
#define NM_VPN_PLUGIN_IP4_CONFIG_DOMAINS     "domains"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_ROUTES

+
#define NM_VPN_PLUGIN_IP4_CONFIG_ROUTES      "routes"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT

+
#define NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT "never-default"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY

+
#define NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY   NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_BANNER

+
#define NM_VPN_PLUGIN_IP4_CONFIG_BANNER      NM_VPN_PLUGIN_CONFIG_BANNER
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY

+
#define NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_MTU

+
#define NM_VPN_PLUGIN_IP4_CONFIG_MTU         NM_VPN_PLUGIN_CONFIG_MTU
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV

+
#define NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV      NM_VPN_PLUGIN_CONFIG_TUNDEV
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_INT_GATEWAY

+
#define NM_VPN_PLUGIN_IP6_CONFIG_INT_GATEWAY "internal-gateway"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_ADDRESS

+
#define NM_VPN_PLUGIN_IP6_CONFIG_ADDRESS     "address"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_PTP

+
#define NM_VPN_PLUGIN_IP6_CONFIG_PTP         "ptp"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_PREFIX

+
#define NM_VPN_PLUGIN_IP6_CONFIG_PREFIX      "prefix"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_DNS

+
#define NM_VPN_PLUGIN_IP6_CONFIG_DNS         "dns"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_MSS

+
#define NM_VPN_PLUGIN_IP6_CONFIG_MSS         "mss"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_DOMAIN

+
#define NM_VPN_PLUGIN_IP6_CONFIG_DOMAIN      "domain"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_DOMAINS

+
#define NM_VPN_PLUGIN_IP6_CONFIG_DOMAINS     "domains"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_ROUTES

+
#define NM_VPN_PLUGIN_IP6_CONFIG_ROUTES      "routes"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_IP6_CONFIG_NEVER_DEFAULT

+
#define NM_VPN_PLUGIN_IP6_CONFIG_NEVER_DEFAULT "never-default"
+
+

+

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/libnm.devhelp2 b/docs/libnm/html/libnm.devhelp2 new file mode 100644 index 00000000..d8530d82 --- /dev/null +++ b/docs/libnm/html/libnm.devhelp2 @@ -0,0 +1,2207 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/libnm/html/libnm.png b/docs/libnm/html/libnm.png new file mode 100644 index 00000000..dc000728 Binary files /dev/null and b/docs/libnm/html/libnm.png differ diff --git a/docs/libnm/html/object-tree.html b/docs/libnm/html/object-tree.html new file mode 100644 index 00000000..8013b082 --- /dev/null +++ b/docs/libnm/html/object-tree.html @@ -0,0 +1,136 @@ + + + + +Object Hierarchy + + + + + + + + + + + + + + + + +
+

+Object Hierarchy

+
+    GObject
+        NMSetting
+            NMSetting8021x
+            NMSettingAdsl
+            NMSettingBluetooth
+            NMSettingBond
+            NMSettingBridgePort
+            NMSettingBridge
+            NMSettingCdma
+            NMSettingConnection
+            NMSettingDcb
+            NMSettingGeneric
+            NMSettingGsm
+            NMSettingInfiniband
+            NMSettingIPConfig
+                NMSettingIP4Config
+                NMSettingIP6Config
+            NMSettingOlpcMesh
+            NMSettingPpp
+            NMSettingPppoe
+            NMSettingSerial
+            NMSettingTeamPort
+            NMSettingTeam
+            NMSettingVlan
+            NMSettingVpn
+            NMSettingWimax
+            NMSettingWired
+            NMSettingWirelessSecurity
+            NMSettingWireless
+        NMObject
+            NMAccessPoint
+            NMActiveConnection
+                NMVpnConnection
+            NMDevice
+                NMDeviceAdsl
+                NMDeviceBond
+                NMDeviceBridge
+                NMDeviceBt
+                NMDeviceEthernet
+                NMDeviceGeneric
+                NMDeviceInfiniband
+                NMDeviceModem
+                NMDeviceOlpcMesh
+                NMDeviceTeam
+                NMDeviceVlan
+                NMDeviceWifi
+                NMDeviceWimax
+            NMDhcpConfig
+            NMIPConfig
+            NMRemoteConnection
+            NMWimaxNsp
+        NMClient
+        NMSecretAgentOld
+        NMSimpleConnection
+    GFlags
+        NM80211ApFlags
+        NM80211ApSecurityFlags
+        NMBluetoothCapabilities
+        NMConnectionSerializationFlags
+        NMDeviceCapabilities
+        NMDeviceModemCapabilities
+        NMDeviceWifiCapabilities
+        NMSecretAgentCapabilities
+        NMSecretAgentGetSecretsFlags
+        NMSettingDcbFlags
+        NMSettingSecretFlags
+        NMVlanFlags
+        NMVpnEditorPluginCapability
+    GEnum
+        NMAgentManagerError
+        NMConnectionError
+        NMDeviceError
+        NMManagerError
+        NMSecretAgentError
+        NMSettingsError
+        NMVpnPluginError
+        NM80211Mode
+        NMActiveConnectionState
+        NMClientError
+        NMClientPermission
+        NMClientPermissionResult
+        NMConnectivityState
+        NMCryptoError
+        NMDeviceState
+        NMDeviceStateReason
+        NMDeviceType
+        NMSetting8021xCKFormat
+        NMSetting8021xCKScheme
+        NMSettingCompareFlags
+        NMSettingDiffResult
+        NMSettingIP6ConfigPrivacy
+        NMSettingSerialParity
+        NMState
+        NMUtilsSecurityType
+        NMVlanPriorityMap
+        NMVpnConnectionState
+        NMVpnConnectionStateReason
+        NMVpnPluginFailure
+        NMVpnServiceState
+        NMWepKeyType
+        NMWimaxNspNetworkType
+    GBoxed
+        NMIPAddress
+        NMIPRoute
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/ref-overview.html b/docs/libnm/html/ref-overview.html new file mode 100644 index 00000000..febd374f --- /dev/null +++ b/docs/libnm/html/ref-overview.html @@ -0,0 +1,48 @@ + + + + +Overview + + + + + + + + + + + + + + + + +
+

+Overview

+

+ libnm maps fairly closely to the actual D-Bus API that NetworkManager + provides, wrapping the remote D-Bus objects as native GObjects, + mapping D-Bus signals and properties to GObject signals and properties, + and providing helpful accessor and utility functions. However, unlike + the old libnm-util/libnm-glib API, the mapping to the D-Bus API is not + exact, and various inconveniences and historical anomolies of the D-Bus + API are papered over. +

+

+ The following is a rough overview of the libnm object structure and + how to use the various parts of it: +

+
+ +
+

+

+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file diff --git a/docs/libnm/html/right.png b/docs/libnm/html/right.png new file mode 100644 index 00000000..92832e3a Binary files /dev/null and b/docs/libnm/html/right.png differ diff --git a/docs/libnm/html/style.css b/docs/libnm/html/style.css new file mode 100644 index 00000000..d6f6c26e --- /dev/null +++ b/docs/libnm/html/style.css @@ -0,0 +1,266 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + 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] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/libnm/html/up.png b/docs/libnm/html/up.png new file mode 100644 index 00000000..85b3e2a2 Binary files /dev/null and b/docs/libnm/html/up.png differ -- cgit 1.3.0-6-gf8a5