From 58f8be580039b0575b197b9573a1c92745d96d30 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 17 Jan 2017 20:25:09 +0100 Subject: New upstream version 1.5.90 --- docs/libnm/html/NMConnection.html | 278 ++++++++++++++++++++++++-------------- 1 file changed, 175 insertions(+), 103 deletions(-) (limited to 'docs/libnm/html/NMConnection.html') diff --git a/docs/libnm/html/NMConnection.html b/docs/libnm/html/NMConnection.html index efa99d86..bbc0ffaa 100644 --- a/docs/libnm/html/NMConnection.html +++ b/docs/libnm/html/NMConnection.html @@ -74,7 +74,7 @@ -GVariant * +GVariant * nm_connection_to_dbus () @@ -82,7 +82,7 @@ -gboolean +gboolean nm_connection_replace_settings () @@ -106,7 +106,7 @@ -gboolean +gboolean nm_connection_compare () @@ -114,7 +114,7 @@ -gboolean +gboolean nm_connection_diff () @@ -122,7 +122,7 @@ -gboolean +gboolean nm_connection_verify () @@ -130,7 +130,7 @@ -gboolean +gboolean nm_connection_verify_secrets () @@ -138,7 +138,7 @@ -gboolean +gboolean nm_connection_normalize () @@ -169,7 +169,7 @@ -gboolean +gboolean nm_connection_update_secrets () @@ -199,7 +199,7 @@ -gboolean +gboolean nm_connection_is_type () @@ -244,7 +244,7 @@ -gboolean +gboolean nm_connection_is_virtual () @@ -388,6 +388,14 @@ +NMSettingMacsec * + + +nm_connection_get_setting_macsec () + + + + NMSettingMacvlan * @@ -420,6 +428,14 @@ +NMSettingProxy * + + +nm_connection_get_setting_proxy () + + + + NMSettingSerial * @@ -599,8 +615,8 @@ the setting object's reference count.

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 + GType setting_type); +

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

Parameters

@@ -618,7 +634,7 @@ operation dereferences the

setting_type

-

the GType of the setting object to remove

+

the GType of the setting object to remove

  @@ -630,8 +646,8 @@ operation dereferences the

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 + GType setting_type); +

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

Parameters

@@ -649,7 +665,7 @@ to the

setting_type

-

the GType of the setting object to return

+

the GType of the setting object to return

  @@ -657,7 +673,7 @@ to the

Returns

-

the NMSetting, or NULL if no setting of that type was previously +

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

[transfer none]

@@ -694,7 +710,7 @@ the

Returns

-

the NMSetting, or NULL if no setting with that name was previously +

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

[transfer none]

@@ -702,10 +718,10 @@ added to the

nm_connection_to_dbus ()

-
GVariant *
+
GVariant *
 nm_connection_to_dbus (NMConnection *connection,
                        NMConnectionSerializationFlags flags);

-
Converts the NMConnection into a GVariant of type
+
Converts the NMConnection into a GVariant of type
 NM_VARIANT_TYPE_CONNECTION describing the connection, suitable for
 marshalling over D-Bus or otherwise serializing.

 

@@ -732,7 +748,7 @@ marshalling over D-Bus or otherwise serializing.

 

 

 
Returns

-
 a new floating GVariant describing the connection,
+
 a new floating GVariant describing the connection,
 its settings, and each setting's properties. 

 
[transfer none]

 

@@ -740,10 +756,10 @@ its settings, and each setting's properties. 

 

 

 
nm_connection_replace_settings ()

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

+                                GVariant *new_settings,
+                                GError **error);

 
Replaces connection
 's settings with new_settings
  (which must be
@@ -765,12 +781,12 @@ need to result in a connection that passes 
new_settings

-
a GVariant of type NM_VARIANT_TYPE_CONNECTION, with the new settings

+
a GVariant of type NM_VARIANT_TYPE_CONNECTION, with the new settings

  
 
 
 
error

-
location to store error, or NULL

+
location to store error, or NULL

  
 
 
@@ -778,7 +794,7 @@ need to result in a connection that passes 
 
Returns

-
 TRUE if connection was updated, FALSE if new_settings
+
 TRUE if connection was updated, FALSE if new_settings
 could not
 be deserialized (in which case connection
 will be unchanged).

@@ -845,7 +861,7 @@ nm_connection_clear_settings (
 
nm_connection_compare ()

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

@@ -881,17 +897,17 @@ each flag's behavior.

 

 

 
Returns

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

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

nm_connection_diff ()

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

+                    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 @@ -935,16 +951,16 @@ differ mapped to one or more of

Returns

-

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

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

nm_connection_verify ()

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

+                      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 @@ -952,7 +968,7 @@ 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 +MAC address. The returned GError contains information about which setting and which property failed validation, and how it failed validation.

Parameters

@@ -970,7 +986,7 @@ setting and which property failed validation, and how it failed validation.

error

-

location to store error, or NULL

+

location to store error, or NULL

  @@ -978,15 +994,15 @@ setting and which property failed validation, and how it failed validation.

Returns

-

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

+

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

nm_connection_verify_secrets ()

-
gboolean
+
gboolean
 nm_connection_verify_secrets (NMConnection *connection,
-                              GError **error);

+                              GError **error);

Verifies the secrets in the connection.

Parameters

@@ -1004,7 +1020,7 @@ nm_connection_verify_secrets (

error

-

location to store error, or NULL

+

location to store error, or NULL

  @@ -1012,23 +1028,23 @@ nm_connection_verify_secrets (

Returns

-

TRUE if the secrets are valid, FALSE if they are not

+

TRUE if the secrets are valid, FALSE if they are not

Since: 1.2

nm_connection_normalize ()

-
gboolean
+
gboolean
 nm_connection_normalize (NMConnection *connection,
-                         GHashTable *parameters,
-                         gboolean *modified,
-                         GError **error);

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

@@ -1048,10 +1064,10 @@ cannot be normalized, the connection will not be modified.

parameters

-

a GHashTable with +

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. +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] @@ -1062,7 +1078,7 @@ The values are opaque and depend on the parameter name.

error

-

location to store error, or NULL. Contains the reason, +

location to store error, or NULL. Contains the reason, why the connection is invalid, if the function returns an error.

  @@ -1071,7 +1087,7 @@ why the connection is invalid, if the function returns an error.

Returns

-

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

+

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

@@ -1079,7 +1095,7 @@ why the connection is invalid, if the function returns an error.

nm_connection_need_secrets ()

const char *
 nm_connection_need_secrets (NMConnection *connection,
-                            GPtrArray **hints);
+ 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 @@ -1101,10 +1117,10 @@ secrets are needed.

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 +

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 +and must free the array itself with g_ptr_array_free(), but not free its elements.

[out][element-type utf8][allow-none][transfer container] @@ -1147,7 +1163,7 @@ keeping secret data in memory when not needed.

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

Clears and frees secrets determined by func .

@@ -1183,16 +1199,16 @@ specific secret should be cleared or not.

nm_connection_update_secrets ()

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

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

@@ -1217,13 +1233,13 @@ settings contained in secrets

secrets

-

a GVariant of secrets, of type NM_VARIANT_TYPE_CONNECTION +

a GVariant of secrets, of type NM_VARIANT_TYPE_CONNECTION or NM_VARIANT_TYPE_SETTING

 

error

-

location to store error, or NULL

+

location to store error, or NULL

  @@ -1231,7 +1247,7 @@ or

Returns

-

TRUE if the secrets were successfully updated, FALSE if the update +

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

@@ -1242,7 +1258,7 @@ failed (tried to update secrets for a setting that doesn't exist, etc)

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” +is only for the reference of the caller. Sets the “path” property.

Parameters

@@ -1301,7 +1317,7 @@ nm_connection_get_path (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.

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

@@ -1322,13 +1338,13 @@ NetworkManager, this is the name of the created interface.

Returns

-

Name of the kernel interface or NULL

+

Name of the kernel interface or NULL

nm_connection_is_type ()

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

 
A convenience function to check if the given connection
@@ -1361,8 +1377,8 @@ property of the connection and matches that against

Returns

-

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

+

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

@@ -1371,7 +1387,7 @@ property of the connection and matches that against 
void
 nm_connection_for_each_setting_value (NMConnection *connection,
                                       NMSettingValueIterFn func,
-                                      gpointer user_data);
+ gpointer user_data);

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

@@ -1508,7 +1524,7 @@ nm_connection_get_connection_type (

nm_connection_is_virtual ()

-
gboolean
+
gboolean
 nm_connection_is_virtual (NMConnection *connection);

 
Checks if connection
  refers to a virtual device (and thus can potentially be
@@ -1563,7 +1579,7 @@ Eg, "VLAN (eth1.1)".

 
Returns

 
 the name of connection
 's device,
-or NULL if connection
+or NULL if connection
 is not a virtual connection type. 

 
[transfer full]
@@ -1591,7 +1607,7 @@ nm_connection_get_setting_802_1x (

Returns

-

an NMSetting8021x if the connection contains one, otherwise NULL.

+

an NMSetting8021x if the connection contains one, otherwise NULL.

[transfer none]

@@ -1618,7 +1634,7 @@ nm_connection_get_setting_bluetooth (

Returns

-

an NMSettingBluetooth if the connection contains one, otherwise NULL.

+

an NMSettingBluetooth if the connection contains one, otherwise NULL.

[transfer none]

@@ -1645,7 +1661,7 @@ nm_connection_get_setting_bond (

Returns

-

an NMSettingBond if the connection contains one, otherwise NULL.

+

an NMSettingBond if the connection contains one, otherwise NULL.

[transfer none]

@@ -1672,7 +1688,7 @@ nm_connection_get_setting_team (

Returns

-

an NMSettingTeam if the connection contains one, otherwise NULL.

+

an NMSettingTeam if the connection contains one, otherwise NULL.

[transfer none]

@@ -1699,7 +1715,7 @@ nm_connection_get_setting_team_port (

Returns

-

an NMSettingTeamPort if the connection contains one, otherwise NULL.

+

an NMSettingTeamPort if the connection contains one, otherwise NULL.

[transfer none]

@@ -1726,7 +1742,7 @@ nm_connection_get_setting_bridge (

Returns

-

an NMSettingBridge if the connection contains one, otherwise NULL.

+

an NMSettingBridge if the connection contains one, otherwise NULL.

[transfer none]

@@ -1753,7 +1769,7 @@ nm_connection_get_setting_bridge_port (

Returns

-

an NMSettingBridgePort if the connection contains one, otherwise NULL.

+

an NMSettingBridgePort if the connection contains one, otherwise NULL.

[transfer none]

@@ -1780,7 +1796,7 @@ nm_connection_get_setting_cdma (

Returns

-

an NMSettingCdma if the connection contains one, otherwise NULL.

+

an NMSettingCdma if the connection contains one, otherwise NULL.

[transfer none]

@@ -1807,7 +1823,7 @@ nm_connection_get_setting_connection (

Returns

-

an NMSettingConnection if the connection contains one, otherwise NULL.

+

an NMSettingConnection if the connection contains one, otherwise NULL.

[transfer none]

@@ -1888,7 +1904,7 @@ nm_connection_get_setting_gsm (

Returns

-

an NMSettingGsm if the connection contains one, otherwise NULL.

+

an NMSettingGsm if the connection contains one, otherwise NULL.

[transfer none]

@@ -1915,7 +1931,7 @@ nm_connection_get_setting_infiniband (

Returns

-

an NMSettingInfiniband if the connection contains one, otherwise NULL.

+

an NMSettingInfiniband if the connection contains one, otherwise NULL.

[transfer none]

@@ -1942,7 +1958,7 @@ nm_connection_get_setting_ip_tunnel (

Returns

-

an NMSettingIPTunnel if the connection contains one, otherwise NULL.

+

an NMSettingIPTunnel if the connection contains one, otherwise NULL.

[transfer none]

Since: 1.2

@@ -1974,7 +1990,7 @@ majority of IPv4-setting-related methods are on that type, not

Returns

an NMSettingIP4Config if the -connection contains one, otherwise NULL.

+connection contains one, otherwise NULL.

[type NMSettingIP4Config][transfer none]

@@ -2005,12 +2021,40 @@ majority of IPv6-setting-related methods are on that type, not

Returns

an NMSettingIP6Config if the -connection contains one, otherwise NULL.

+connection contains one, otherwise NULL.

[type NMSettingIP6Config][transfer none]

+

nm_connection_get_setting_macsec ()

+
NMSettingMacsec *
+nm_connection_get_setting_macsec (NMConnection *connection);
+

A shortcut to return any NMSettingMacsec the connection might contain.

+
+

Parameters

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

connection

the NMConnection

 
+
+
+

Returns

+

an NMSettingMacsec if the connection contains one, otherwise NULL.

+

[transfer none]

+
+

Since: 1.6

+
+
+

nm_connection_get_setting_macvlan ()

NMSettingMacvlan *
 nm_connection_get_setting_macvlan (NMConnection *connection);
@@ -2032,7 +2076,7 @@ nm_connection_get_setting_macvlan (

Returns

-

an NMSettingMacvlan if the connection contains one, otherwise NULL.

+

an NMSettingMacvlan if the connection contains one, otherwise NULL.

[transfer none]

Since: 1.2

@@ -2060,7 +2104,7 @@ nm_connection_get_setting_olpc_mesh (

Returns

-

an NMSettingOlpcMesh if the connection contains one, otherwise NULL.

+

an NMSettingOlpcMesh if the connection contains one, otherwise NULL.

[transfer none]

@@ -2087,7 +2131,7 @@ nm_connection_get_setting_ppp (

Returns

-

an NMSettingPpp if the connection contains one, otherwise NULL.

+

an NMSettingPpp if the connection contains one, otherwise NULL.

[transfer none]

@@ -2114,9 +2158,37 @@ nm_connection_get_setting_pppoe (

Returns

-

an NMSettingPppoe if the connection contains one, otherwise NULL.

+

an NMSettingPppoe if the connection contains one, otherwise NULL.

+

[transfer none]

+
+ +
+
+

nm_connection_get_setting_proxy ()

+
NMSettingProxy *
+nm_connection_get_setting_proxy (NMConnection *connection);
+

A shortcut to return any NMSettingProxy the connection might contain.

+
+

Parameters

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

connection

the NMConnection

 
+
+
+

Returns

+

an NMSettingProxy if the connection contains one, otherwise NULL.

[transfer none]

+

Since: 1.6

@@ -2141,7 +2213,7 @@ nm_connection_get_setting_serial (

Returns

-

an NMSettingSerial if the connection contains one, otherwise NULL.

+

an NMSettingSerial if the connection contains one, otherwise NULL.

[transfer none]

@@ -2168,7 +2240,7 @@ nm_connection_get_setting_tun (

Returns

-

an NMSettingTun if the connection contains one, otherwise NULL.

+

an NMSettingTun if the connection contains one, otherwise NULL.

[transfer none]

Since: 1.2

@@ -2196,7 +2268,7 @@ nm_connection_get_setting_vpn (

Returns

-

an NMSettingVpn if the connection contains one, otherwise NULL.

+

an NMSettingVpn if the connection contains one, otherwise NULL.

[transfer none]

@@ -2223,7 +2295,7 @@ nm_connection_get_setting_wimax (

Returns

-

an NMSettingWimax if the connection contains one, otherwise NULL.

+

an NMSettingWimax if the connection contains one, otherwise NULL.

[transfer none]

@@ -2250,7 +2322,7 @@ nm_connection_get_setting_adsl (

Returns

-

an NMSettingAdsl if the connection contains one, otherwise NULL.

+

an NMSettingAdsl if the connection contains one, otherwise NULL.

[transfer none]

@@ -2277,7 +2349,7 @@ nm_connection_get_setting_wired (

Returns

-

an NMSettingWired if the connection contains one, otherwise NULL.

+

an NMSettingWired if the connection contains one, otherwise NULL.

[transfer none]

@@ -2304,7 +2376,7 @@ nm_connection_get_setting_wireless (

Returns

-

an NMSettingWireless if the connection contains one, otherwise NULL.

+

an NMSettingWireless if the connection contains one, otherwise NULL.

[transfer none]

@@ -2332,7 +2404,7 @@ nm_connection_get_setting_wireless_security

Returns

-

an NMSettingWirelessSecurity if the connection contains one, otherwise NULL.

+

an NMSettingWirelessSecurity if the connection contains one, otherwise NULL.

[transfer none]

@@ -2359,7 +2431,7 @@ nm_connection_get_setting_vlan (

Returns

-

an NMSettingVlan if the connection contains one, otherwise NULL.

+

an NMSettingVlan if the connection contains one, otherwise NULL.

[transfer none]

@@ -2386,7 +2458,7 @@ nm_connection_get_setting_vxlan (

Returns

-

an NMSettingVxlan if the connection contains one, otherwise NULL.

+

an NMSettingVxlan if the connection contains one, otherwise NULL.

[transfer none]

Since: 1.2

@@ -2440,7 +2512,7 @@ nm_connection_get_setting_vxlan ( -

GTypeInterface parent;

+

GTypeInterface parent;

the parent interace struct

  @@ -2468,8 +2540,8 @@ nm_connection_get_setting_vxlan (

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 +

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.

-- cgit 1.3.0-6-gf8a5