From 45cb5bb3c0e6edb887cf69b417fcaf7053814a9b Mon Sep 17 00:00:00 2001 From: Aron Xu Date: Tue, 20 Dec 2016 20:06:37 +0800 Subject: Imported Upstream version 1.4.4 --- docs/libnm/html/NMSettingConnection.html | 238 +++++++++++++++---------------- 1 file changed, 119 insertions(+), 119 deletions(-) (limited to 'docs/libnm/html/NMSettingConnection.html') diff --git a/docs/libnm/html/NMSettingConnection.html b/docs/libnm/html/NMSettingConnection.html index 6b327d52..db4ce45d 100644 --- a/docs/libnm/html/NMSettingConnection.html +++ b/docs/libnm/html/NMSettingConnection.html @@ -3,7 +3,7 @@ NMSettingConnection: libnm Reference Manual - + @@ -35,7 +35,7 @@

Functions

-
+
@@ -86,7 +86,7 @@
-gboolean +gboolean nm_setting_connection_get_autoconnect () @@ -94,7 +94,7 @@
-gint +gint nm_setting_connection_get_autoconnect_priority () @@ -102,7 +102,7 @@
-guint64 +guint64 nm_setting_connection_get_timestamp () @@ -110,7 +110,7 @@
-gboolean +gboolean nm_setting_connection_get_read_only () @@ -118,7 +118,7 @@
-guint32 +guint32 nm_setting_connection_get_num_permissions () @@ -126,7 +126,7 @@
-gboolean +gboolean nm_setting_connection_get_permission () @@ -141,7 +141,7 @@
-gboolean +gboolean nm_setting_connection_permissions_user_allowed () @@ -149,7 +149,7 @@
-gboolean +gboolean nm_setting_connection_add_permission () @@ -165,7 +165,7 @@
-gboolean +gboolean nm_setting_connection_remove_permission_by_value () @@ -180,7 +180,7 @@
-gboolean +gboolean nm_setting_connection_is_slave_type () @@ -203,7 +203,7 @@
-guint32 +guint32 nm_setting_connection_get_num_secondaries () @@ -218,7 +218,7 @@
-gboolean +gboolean nm_setting_connection_add_secondary () @@ -234,7 +234,7 @@
-gboolean +gboolean nm_setting_connection_remove_secondary_by_value () @@ -242,7 +242,7 @@
-guint32 +guint32 nm_setting_connection_get_gateway_ping_timeout () @@ -269,7 +269,7 @@

Properties

-
+
@@ -277,12 +277,12 @@ - + - + @@ -292,30 +292,30 @@ - + +gchar * +gchar * - + +gchar * @@ -325,52 +325,52 @@ - + - + - + +gchar * +gchar * - + +gchar * +gchar * +gchar * @@ -379,7 +379,7 @@

Types and Values

-
gbooleangboolean autoconnect Read / Write / Construct
gintgint autoconnect-priority Read / Write / Construct
Read / Write / Construct
guintguint gateway-ping-timeout Read / Write / Construct
-gchar * id Read / Write
-gchar * interface-name Read / Write
gintgint lldp Read / Write / Construct
-gchar * master Read / Write
Read / Write
GStrvGStrv permissions Read / Write
gbooleangboolean read-only Read / Write / Construct
GStrvGStrv secondaries Read / Write
-gchar * slave-type Read / Write
-gchar * stable-id Read / Write
guint64guint64 timestamp Read / Write / Construct
-gchar * type Read / Write
-gchar * uuid Read / Write
-gchar * zone Read / Write / Construct
+
@@ -493,7 +493,7 @@ 
    GEnum
     ├── NMSettingConnectionAutoconnectSlaves
     ╰── NMSettingConnectionLldp
-    GObject
+    GObject
     ╰── NMSetting
         ╰── NMSettingConnection
@@ -525,7 +525,7 @@ nm_setting_connection_get_id (“id” property of the connection.

Parameters

-
+
@@ -551,7 +551,7 @@ nm_setting_connection_get_uuid (Returns the “uuid” property of the connection.

Parameters

-
+
@@ -577,7 +577,7 @@ nm_setting_connection_get_stable_id (Returns the “stable_id” property of the connection.

Parameters

-
+
@@ -605,7 +605,7 @@ nm_setting_connection_get_interface_name

Returns the “interface-name” property of the connection.

Parameters

-
+
@@ -632,7 +632,7 @@ nm_setting_connection_get_connection_type

Returns the “type” property of the connection.

Parameters

-
+
@@ -653,12 +653,12 @@ nm_setting_connection_get_connection_type

nm_setting_connection_get_autoconnect ()

-
gboolean
+
gboolean
 nm_setting_connection_get_autoconnect (NMSettingConnection *setting);

 
Returns the “autoconnect” property of the connection.

 

 
Parameters

-
+
@@ -679,14 +679,14 @@ nm_setting_connection_get_autoconnect (

nm_setting_connection_get_autoconnect_priority ()

-
gint
+
gint
 nm_setting_connection_get_autoconnect_priority
                                (NMSettingConnection *setting);

 
Returns the “autoconnect-priority” property of the connection.
 The higher number, the higher priority.

 

 
Parameters

-
+
@@ -707,12 +707,12 @@ The higher number, the higher priority.

nm_setting_connection_get_timestamp ()

-
guint64
+
guint64
 nm_setting_connection_get_timestamp (NMSettingConnection *setting);

 
Returns the “timestamp” property of the connection.

 

 
Parameters

-
+
@@ -733,12 +733,12 @@ nm_setting_connection_get_timestamp (

nm_setting_connection_get_read_only ()

-
gboolean
+
gboolean
 nm_setting_connection_get_read_only (NMSettingConnection *setting);

 
Returns the “read-only” property of the connection.

 

 
Parameters

-
+
@@ -753,20 +753,20 @@ nm_setting_connection_get_read_only (

Returns

-

TRUE if the connection is read-only, FALSE if it is not

+

TRUE if the connection is read-only, FALSE if it is not

nm_setting_connection_get_num_permissions ()

-
guint32
+
guint32
 nm_setting_connection_get_num_permissions
                                (NMSettingConnection *setting);

 
Returns the number of entires in the “permissions”
 property of this setting.

 

 
Parameters

-
+
@@ -787,9 +787,9 @@ property of this setting.

nm_setting_connection_get_permission ()

-
gboolean
+
gboolean
 nm_setting_connection_get_permission (NMSettingConnection *setting,
-                                      guint32 idx,
+                                      guint32 idx,
                                       const char **out_ptype,
                                       const char **out_pitem,
                                       const char **out_detail);

@@ -797,7 +797,7 @@ nm_setting_connection_get_permission (
 
Parameters

-
+
@@ -828,7 +828,7 @@ of this setting.

 - + @@ -836,7 +836,7 @@ of this setting.

Returns

-

TRUE if a permission was returned, FALSE if idx +

TRUE if a permission was returned, FALSE if idx was invalid

@@ -848,7 +848,7 @@ nm_setting_connection_get_zone (Returns the “zone” property of the connection.

Parameters

-

out_detail

on return, the permission detail (at this time, always NULL)

on return, the permission detail (at this time, always NULL)

  
+
@@ -869,14 +869,14 @@ nm_setting_connection_get_zone (

nm_setting_connection_permissions_user_allowed ()

-
gboolean
+
gboolean
 nm_setting_connection_permissions_user_allowed
                                (NMSettingConnection *setting,
                                 const char *uname);

 
Checks whether the given username is allowed to view/access this connection.

 

 
Parameters

-
+
@@ -898,14 +898,14 @@ nm_setting_connection_permissions_user_allowed

Returns

-

TRUE if the requested user is allowed to view this connection, -FALSE if the given user is not allowed to view this connection

+

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
+
gboolean
 nm_setting_connection_add_permission (NMSettingConnection *setting,
                                       const char *ptype,
                                       const char *pitem,
@@ -916,7 +916,7 @@ the "user" permission type is supported, and pitem“permissions”: for more details.

 

 
Parameters

-
+
@@ -941,7 +941,7 @@ the "user" permission type is supported, and pitem - + @@ -949,8 +949,8 @@ the "user" permission type is supported, and pitem

Returns

-

TRUE if the permission was unique and was successfully added to the -list, FALSE if ptype +

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

@@ -962,12 +962,12 @@ present in the list

void
 nm_setting_connection_remove_permission
                                (NMSettingConnection *setting,
-                                guint32 idx);
+ guint32 idx);

Removes the permission at index idx from the connection.

Parameters

-

detail

unused at this time; must be NULL.

unused at this time; must be NULL.

[allow-none]
+
@@ -991,7 +991,7 @@ nm_setting_connection_remove_permission

nm_setting_connection_remove_permission_by_value ()

-
gboolean
+
gboolean
 nm_setting_connection_remove_permission_by_value
                                (NMSettingConnection *setting,
                                 const char *ptype,
@@ -1003,7 +1003,7 @@ At this time, only the "user" permission type is supported, and “permissions”: for more details.

 

 
Parameters

-
+
@@ -1028,7 +1028,7 @@ be a username. See

detail

- + @@ -1036,7 +1036,7 @@ be a username. See

Returns

-

TRUE if the permission was found and removed; FALSE if it was not.

+

TRUE if the permission was found and removed; FALSE if it was not.

@@ -1047,7 +1047,7 @@ nm_setting_connection_get_master (Returns the “master” property of the connection.

Parameters

-

unused at this time; must be NULL.

unused at this time; must be NULL.

[allow-none]
+
@@ -1069,12 +1069,12 @@ connection.

nm_setting_connection_is_slave_type ()

-
gboolean
+
gboolean
 nm_setting_connection_is_slave_type (NMSettingConnection *setting,
                                      const char *type);

 

 
Parameters

-
+
@@ -1098,7 +1098,7 @@ against setting

Returns

-

TRUE if connection is of the given slave type +

TRUE if connection is of the given slave type

@@ -1110,7 +1110,7 @@ nm_setting_connection_get_slave_type (“slave-type” property of the connection.

Parameters

-
+
@@ -1137,7 +1137,7 @@ nm_setting_connection_get_autoconnect_slaves

Returns the “autoconnect-slaves” property of the connection.

Parameters

-
+
@@ -1160,12 +1160,12 @@ with the connection.

nm_setting_connection_get_num_secondaries ()

-
guint32
+
guint32
 nm_setting_connection_get_num_secondaries
                                (NMSettingConnection *setting);

 

 
Parameters

-
+
@@ -1188,10 +1188,10 @@ nm_setting_connection_get_num_secondaries

nm_setting_connection_get_secondary ()

const char *
 nm_setting_connection_get_secondary (NMSettingConnection *setting,
-                                     guint32 idx);
+ guint32 idx);

Parameters

-
+
@@ -1220,13 +1220,13 @@ nm_setting_connection_get_secondary (

nm_setting_connection_add_secondary ()

-
gboolean
+
gboolean
 nm_setting_connection_add_secondary (NMSettingConnection *setting,
                                      const char *sec_uuid);

 
Adds a new secondary connetion UUID to the setting.

 

 
Parameters

-
+
@@ -1248,7 +1248,7 @@ nm_setting_connection_add_secondary (

Returns

-

TRUE if the secondary connection UUID was added; FALSE if the UUID +

TRUE if the secondary connection UUID was added; FALSE if the UUID was already present

@@ -1258,12 +1258,12 @@ was already present

void
 nm_setting_connection_remove_secondary
                                (NMSettingConnection *setting,
-                                guint32 idx);
+ guint32 idx);

Removes the secondary coonnection UUID at index idx .

Parameters

-
+
@@ -1287,7 +1287,7 @@ nm_setting_connection_remove_secondary

nm_setting_connection_remove_secondary_by_value ()

-
gboolean
+
gboolean
 nm_setting_connection_remove_secondary_by_value
                                (NMSettingConnection *setting,
                                 const char *sec_uuid);

@@ -1295,7 +1295,7 @@ nm_setting_connection_remove_secondary_by_value
 .

 

 
Parameters

-
+
@@ -1317,18 +1317,18 @@ nm_setting_connection_remove_secondary_by_value

Returns

-

TRUE if the secondary connection UUID was found and removed; FALSE if it was not.

+

TRUE if the secondary connection UUID was found and removed; FALSE if it was not.

nm_setting_connection_get_gateway_ping_timeout ()

-
guint32
+
guint32
 nm_setting_connection_get_gateway_ping_timeout
                                (NMSettingConnection *setting);

 

 
Parameters

-
+
@@ -1354,7 +1354,7 @@ property.

nm_setting_connection_get_metered (NMSettingConnection *setting);

Parameters

-
+
@@ -1381,7 +1381,7 @@ nm_setting_connection_get_lldp (Returns the “lldp” property of the connection.

Parameters

-
+
@@ -1542,7 +1542,7 @@ enabled for the connection.

should be activated when master is activated.

Members

-
+
@@ -1582,7 +1582,7 @@ should be activated when master is activated.

NMSettingConnectionLldp values indicate whether LLDP should be enabled.

Members

-
+
@@ -1626,10 +1626,10 @@ It should only be accessed through the functions described below.

Property Details

The “autoconnect” property

-
  “autoconnect”              gboolean
+
  “autoconnect”              gboolean

Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. -TRUE to automatically activate the connection, FALSE to require manual +TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.

Flags: Read / Write / Construct

Default value: TRUE

@@ -1637,7 +1637,7 @@ intervention to activate the connection.

The “autoconnect-priority” property

-
  “autoconnect-priority”     gint
+
  “autoconnect-priority”     gint

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.

@@ -1663,7 +1663,7 @@ determine the real value. If it is default as well, this fallbacks to 0.

The “gateway-ping-timeout” property

-
  “gateway-ping-timeout”     guint
+
  “gateway-ping-timeout”     guint

If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.

Flags: Read / Write / Construct

@@ -1673,7 +1673,7 @@ timeout is reached, or an IP gateway replies to a ping.

The “id” property

-
  “id”                       gchar *
+
  “id”                       gchar *

A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".

Flags: Read / Write

@@ -1682,7 +1682,7 @@ or "T-Mobile 3G".

The “interface-name” property

-
  “interface-name”           gchar *
+
  “interface-name”           gchar *

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

@@ -1698,7 +1698,7 @@ connection may be applied to the wrong interface.

The “lldp” property

-
  “lldp”                     gint
+
  “lldp”                     gint

Whether LLDP is enabled for the connection.

Flags: Read / Write / Construct

Default value: -1

@@ -1707,7 +1707,7 @@ connection may be applied to the wrong interface.

The “master” property

-
  “master”                   gchar *
+
  “master”                   gchar *

Interface name of the master device or UUID of the master connection.

Flags: Read / Write

Default value: NULL

@@ -1726,9 +1726,9 @@ the change takes effect immediately.

The “permissions” property

-
  “permissions”              GStrv
+
  “permissions”              GStrv

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

@@ -1742,9 +1742,9 @@ use. All of [type], [id], and [reserved] must be valid UTF-8.

The “read-only” property

-
  “read-only”                gboolean
-

FALSE if the connection can be modified using the provided settings -service's D-Bus interface with the right privileges, or TRUE if the +

  “read-only”                gboolean
+

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.

Flags: Read / Write / Construct

Default value: FALSE

@@ -1752,7 +1752,7 @@ connection is read-only and cannot be modified.

The “secondaries” property

-
  “secondaries”              GStrv
+
  “secondaries”              GStrv

List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.

@@ -1761,9 +1761,9 @@ supported.

The “slave-type” property

-
  “slave-type”               gchar *
+
  “slave-type”               gchar *

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 +NM_SETTING_BOND_SETTING_NAME), or NULL if this connection is not a slave.

Flags: Read / Write

Default value: NULL

@@ -1771,7 +1771,7 @@ slave.

The “stable-id” property

-
  “stable-id”                gchar *
+
  “stable-id”                gchar *

This token to generate stable IDs for the connection. If unset, the UUID will be used instead.

The stable-id is used instead of the connection UUID for generating @@ -1785,7 +1785,7 @@ ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable.

The “timestamp” property

-
  “timestamp”                guint64
+
  “timestamp”                guint64

The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.

NetworkManager updates the connection timestamp periodically when the @@ -1798,7 +1798,7 @@ property will not be preserved).

The “type” property

-
  “type”                     gchar *
+
  “type”                     gchar *

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 @@ -1810,7 +1810,7 @@ the setting name of that setting type (ie, "vpn" or "bridge", etc).

The “uuid” property

-
  “uuid”                     gchar *
+
  “uuid”                     gchar *

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 @@ -1821,16 +1821,16 @@ provider, or nm_utils_uuid_generate() or -nm_utils_uuid_generate_from_string().

+nm_utils_uuid_generate_from_string().

Flags: Read / Write

Default value: NULL

The “zone” property

-
  “zone”                     gchar *
+
  “zone”                     gchar *

The trust level of a the connection. Free form case-insensitive string -(for example "Home", "Work", "Public"). NULL or unspecified zone means +(for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.

When updating this property on a currently activated connection, -- cgit 1.3.0-6-gf8a5