From a4256940da049f91bbbea5e53e469a59ea9c10f7 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 25 Oct 2013 21:20:58 +0200 Subject: Imported Upstream version 0.9.8.8 --- docs/libnm-util/html/NMSettingWired.html | 391 +++++++++++++++++-------------- 1 file changed, 220 insertions(+), 171 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWired.html') diff --git a/docs/libnm-util/html/NMSettingWired.html b/docs/libnm-util/html/NMSettingWired.html index d56f053f..75d9cf16 100644 --- a/docs/libnm-util/html/NMSettingWired.html +++ b/docs/libnm-util/html/NMSettingWired.html @@ -3,12 +3,12 @@ NMSettingWired - + - + @@ -44,38 +44,39 @@ 
 #include <nm-setting-wired.h>
 
-                    NMSettingWired;
-                    NMSettingWiredClass;
+#define             NM_SETTING_WIRED_SETTING_NAME
 enum                NMSettingWiredError;
-#define             NM_SETTING_WIRED_AUTO_NEGOTIATE
-#define             NM_SETTING_WIRED_CLONED_MAC_ADDRESS
-#define             NM_SETTING_WIRED_DUPLEX
 #define             NM_SETTING_WIRED_ERROR
+GQuark              nm_setting_wired_error_quark        (void);
+#define             NM_SETTING_WIRED_PORT
+#define             NM_SETTING_WIRED_SPEED
+#define             NM_SETTING_WIRED_DUPLEX
+#define             NM_SETTING_WIRED_AUTO_NEGOTIATE
 #define             NM_SETTING_WIRED_MAC_ADDRESS
+#define             NM_SETTING_WIRED_CLONED_MAC_ADDRESS
 #define             NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST
 #define             NM_SETTING_WIRED_MTU
-#define             NM_SETTING_WIRED_PORT
+#define             NM_SETTING_WIRED_S390_SUBCHANNELS
 #define             NM_SETTING_WIRED_S390_NETTYPE
 #define             NM_SETTING_WIRED_S390_OPTIONS
-#define             NM_SETTING_WIRED_S390_SUBCHANNELS
-#define             NM_SETTING_WIRED_SETTING_NAME
-#define             NM_SETTING_WIRED_SPEED
-gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
-                                                         const char *key,
-                                                         const char *item);
-GQuark              nm_setting_wired_error_quark        (void);
+                    NMSettingWired;
+                    NMSettingWiredClass;
+NMSetting *         nm_setting_wired_new                (void);
+const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
+guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
+const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
 gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
+const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
 const GByteArray *  nm_setting_wired_get_cloned_mac_address
                                                         (NMSettingWired *setting);
-const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
-const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
 const GSList *      nm_setting_wired_get_mac_address_blacklist
                                                         (NMSettingWired *setting);
 guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
-guint32             nm_setting_wired_get_num_s390_options
+const GPtrArray *   nm_setting_wired_get_s390_subchannels
                                                         (NMSettingWired *setting);
-const char *        nm_setting_wired_get_port           (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,
@@ -83,25 +84,24 @@ const char *        char *        nm_setting_wired_get_s390_option_by_key
                                                         (NMSettingWired *setting,
                                                          const char *key);
-const GPtrArray *   nm_setting_wired_get_s390_subchannels
-                                                        (NMSettingWired *setting);
-guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
-NMSetting *         nm_setting_wired_new                (void);
+gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
+                                                         const char *key,
+                                                         const char *item);
 gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
                                                          const char *key);

Object Hierarchy

+
+  GEnum
+   +----NMSettingWiredError
+
   GObject
    +----NMSetting
          +----NMSettingWired
-
-  GEnum
-   +----NMSettingWiredError
-

Properties

@@ -129,23 +129,8 @@ necessary for connection to Ethernet networks.

Details

-

NMSettingWired

-
typedef struct _NMSettingWired NMSettingWired;
-

-

-
-
-
-

NMSettingWiredClass

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

+
#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
 

 

 

@@ -159,8 +144,11 @@ necessary for connection to Ethernet networks.
 	NM_SETTING_WIRED_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
 } NMSettingWiredError;
-
+
+++ @@ -183,80 +171,90 @@ required
-

NM_SETTING_WIRED_AUTO_NEGOTIATE

-
#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
+
NM_SETTING_WIRED_ERROR

+
#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
-

NM_SETTING_WIRED_CLONED_MAC_ADDRESS

-
#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
-
+

nm_setting_wired_error_quark ()

+
GQuark              nm_setting_wired_error_quark        (void);

+Registers an error quark for NMSettingWired if necessary.

+

NM_SETTING_WIRED_ERROR_UNKNOWN
++++ + + + + +

Returns :

the error quark used for NMSettingWired errors.
-

NM_SETTING_WIRED_DUPLEX

-
#define NM_SETTING_WIRED_DUPLEX "duplex"
+
NM_SETTING_WIRED_PORT

+
#define NM_SETTING_WIRED_PORT "port"
-

NM_SETTING_WIRED_ERROR

-
#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
+
NM_SETTING_WIRED_SPEED

+
#define NM_SETTING_WIRED_SPEED "speed"
-

NM_SETTING_WIRED_MAC_ADDRESS

-
#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
+
NM_SETTING_WIRED_DUPLEX

+
#define NM_SETTING_WIRED_DUPLEX "duplex"
-

NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

-
#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+
NM_SETTING_WIRED_AUTO_NEGOTIATE

+
#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
-

NM_SETTING_WIRED_MTU

-
#define NM_SETTING_WIRED_MTU "mtu"
+
NM_SETTING_WIRED_MAC_ADDRESS

+
#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
-

NM_SETTING_WIRED_PORT

-
#define NM_SETTING_WIRED_PORT "port"
+
NM_SETTING_WIRED_CLONED_MAC_ADDRESS

+
#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
-

NM_SETTING_WIRED_S390_NETTYPE

-
#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
+
NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
-

NM_SETTING_WIRED_S390_OPTIONS

-
#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
+
NM_SETTING_WIRED_MTU

+
#define NM_SETTING_WIRED_MTU "mtu"
 

 

 

@@ -271,50 +269,71 @@ required
-

NM_SETTING_WIRED_SETTING_NAME

-
#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
+
NM_SETTING_WIRED_S390_NETTYPE

+
#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
-

NM_SETTING_WIRED_SPEED

-
#define NM_SETTING_WIRED_SPEED "speed"
+
NM_SETTING_WIRED_S390_OPTIONS

+
#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
-

nm_setting_wired_add_s390_option ()

-
gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
-                                                         const char *key,
-                                                         const char *item);
+

NMSettingWired

+
typedef struct _NMSettingWired NMSettingWired;

-

nm_setting_wired_error_quark ()

-
GQuark              nm_setting_wired_error_quark        (void);
+

NMSettingWiredClass

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

-Registers an error quark for NMSettingWired if necessary.

-
+ +
+
+

nm_setting_wired_new ()

+
NMSetting *         nm_setting_wired_new                (void);
+

+Creates a new NMSettingWired object with default values. +

+
+++ - +

Returns :

the error quark used for NMSettingWired errors.the new empty NMSettingWired object. [transfer full] +
-

nm_setting_wired_get_auto_negotiate ()

-
gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
-
+

nm_setting_wired_get_port ()

+
const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
+
+++ @@ -323,18 +342,20 @@ Registers an error quark for Returns :

- +

setting :

the "auto-negotiate" property of the settingthe "port" property of the setting
-

nm_setting_wired_get_cloned_mac_address ()

-
const GByteArray *  nm_setting_wired_get_cloned_mac_address
-                                                        (NMSettingWired *setting);
-
+

nm_setting_wired_get_speed ()

+
guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
+
+++ @@ -343,7 +364,7 @@ Registers an error quark for Returns :

- +

setting :

the "cloned-mac-address" property of the settingthe "speed" property of the setting
@@ -352,8 +373,11 @@ Registers an error quark for

nm_setting_wired_get_duplex ()

const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
-
+
+++ @@ -369,10 +393,35 @@ Registers an error quark for +

nm_setting_wired_get_auto_negotiate ()

+
gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
+

setting :

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

setting :

the NMSettingWired +

Returns :

the "auto-negotiate" property of the setting
+
+
+

nm_setting_wired_get_mac_address ()

const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
-
+
+++ @@ -388,11 +437,37 @@ Registers an error quark for +

nm_setting_wired_get_cloned_mac_address ()

+
const GByteArray *  nm_setting_wired_get_cloned_mac_address
+                                                        (NMSettingWired *setting);
+

setting :

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

setting :

the NMSettingWired +

Returns :

the "cloned-mac-address" property of the setting
+
+
+

nm_setting_wired_get_mac_address_blacklist ()

const GSList *      nm_setting_wired_get_mac_address_blacklist
                                                         (NMSettingWired *setting);
-
+
+++ @@ -412,8 +487,11 @@ property of the setting. [

nm_setting_wired_get_mtu ()

guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
-

setting :

+
+++ @@ -429,16 +507,19 @@ property of the setting. [ -

nm_setting_wired_get_num_s390_options ()

-
guint32             nm_setting_wired_get_num_s390_options
+
nm_setting_wired_get_s390_subchannels ()

+
const GPtrArray *   nm_setting_wired_get_s390_subchannels
                                                         (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().
+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 :

+
+++ @@ -447,17 +528,27 @@ option individually using Returns :

- +

setting :

the number of s390-specific device options +GPtrArray of strings, each specifying one +subchannel the s390 device uses to communicate to the host. [element-type utf8] +
-

nm_setting_wired_get_port ()

-
const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
-
+

nm_setting_wired_get_s390_nettype ()

+
const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);
+

+Returns the s390 device type this connection should apply to. Will be one +of 'qeth', 'lcs', or 'ctc'. +

+
+++ @@ -466,21 +557,26 @@ option individually using Returns :

- +

setting :

the "port" property of the settingthe s390 device type
-

nm_setting_wired_get_s390_nettype ()

-
const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);
+

nm_setting_wired_get_num_s390_options ()

+
guint32             nm_setting_wired_get_num_s390_options
+                                                        (NMSettingWired *setting);

-Returns the s390 device type this connection should apply to. Will be one -of 'qeth', 'lcs', or 'ctc'. +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().

-
+
+++ @@ -489,7 +585,7 @@ of 'qeth', 'lcs', or 'ctc'. - +

setting :

Returns :

the s390 device typethe number of s390-specific device options
@@ -508,8 +604,11 @@ are *not* guaranteed to be static across modifications to options done by and should not be used to refer to options except for short periods of time such as during option iteration.

-
+
+++ @@ -553,8 +652,11 @@ currently held by the setting) Returns the value associated with the s390-specific option specified by key, if it exists.

-

setting :

+
+++ @@ -567,7 +669,7 @@ Returns the value associated with the s390-specific option specified by - @@ -575,66 +677,12 @@ setting; the value is owned by the setting and must not be modified
-

nm_setting_wired_get_s390_subchannels ()

-
const GPtrArray *   nm_setting_wired_get_s390_subchannels
-                                                        (NMSettingWired *setting);
-

-Return the list of s390 subchannels that identify the device that this -connection is applicable to. The connection should only be used in -conjunction with that device. -

-

setting :

Returns :

the value, or NULL if the key/value pair was never added to the +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
-- - - - - - - - - - -

setting :

the NMSettingWired -

Returns :

 -GPtrArray of strings, each specifying one -subchannel the s390 device uses to communicate to the host. [element-type utf8] -
-
-
-
-

nm_setting_wired_get_speed ()

-
guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
-
-- - - - - - - - - - -

setting :

the NMSettingWired -

Returns :

the "speed" property of the setting
-
-
-
-

nm_setting_wired_new ()

-
NMSetting *         nm_setting_wired_new                (void);
+

nm_setting_wired_add_s390_option ()

+
gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
+                                                         const char *key,
+                                                         const char *item);

-Creates a new NMSettingWired object with default values.

-
-- - - - -

Returns :

the new empty NMSettingWired object. [transfer full] -
@@ -755,6 +803,7 @@ composed of hexadecimal characters and the period (.) character. 
  "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

@@ -763,6 +812,6 @@ In Mbit/s, ie 100 == 100Mbit/s.
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19
\ No newline at end of file -- cgit 1.3.0-6-gf8a5