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/NMSettingBond.html | 283 ++++++++++++++++++-------------- 1 file changed, 158 insertions(+), 125 deletions(-) (limited to 'docs/libnm-util/html/NMSettingBond.html') diff --git a/docs/libnm-util/html/NMSettingBond.html b/docs/libnm-util/html/NMSettingBond.html index ff77e102..89c6fe25 100644 --- a/docs/libnm-util/html/NMSettingBond.html +++ b/docs/libnm-util/html/NMSettingBond.html @@ -3,12 +3,12 @@ NMSettingBond - + - + @@ -44,23 +44,21 @@ 
 #include <nm-setting-bond.h>
 
-                    NMSettingBond;
-                    NMSettingBondClass;
+#define             NM_SETTING_BOND_SETTING_NAME
 enum                NMSettingBondError;
 #define             NM_SETTING_BOND_ERROR
+GQuark              nm_setting_bond_error_quark         (void);
 #define             NM_SETTING_BOND_INTERFACE_NAME
 #define             NM_SETTING_BOND_OPTIONS
-#define             NM_SETTING_BOND_OPTION_ARP_INTERVAL
-#define             NM_SETTING_BOND_OPTION_ARP_IP_TARGET
-#define             NM_SETTING_BOND_OPTION_DOWNDELAY
-#define             NM_SETTING_BOND_OPTION_MIIMON
 #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_SETTING_NAME
-gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
-                                                         const char *name,
-                                                         const char *value);
-GQuark              nm_setting_bond_error_quark         (void);
+#define             NM_SETTING_BOND_OPTION_ARP_INTERVAL
+#define             NM_SETTING_BOND_OPTION_ARP_IP_TARGET
+                    NMSettingBond;
+                    NMSettingBondClass;
+NMSetting *         nm_setting_bond_new                 (void);
 const char *        nm_setting_bond_get_interface_name  (NMSettingBond *setting);
 guint32             nm_setting_bond_get_num_options     (NMSettingBond *setting);
 gboolean            nm_setting_bond_get_option          (NMSettingBond *setting,
@@ -69,25 +67,27 @@ const char *        const char **out_value);
 const char *        nm_setting_bond_get_option_by_name  (NMSettingBond *setting,
                                                          const char *name);
-const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
+gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
+                                                         const char *name,
+                                                         const char *value);
+gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
                                                          const char *name);
 const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);
-NMSetting *         nm_setting_bond_new                 (void);
-gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
+const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
                                                          const char *name);

Object Hierarchy

+
+  GEnum
+   +----NMSettingBondError
+
   GObject
    +----NMSetting
          +----NMSettingBond
-
-  GEnum
-   +----NMSettingBondError
-

Properties

@@ -106,23 +106,8 @@ necessary for bond connections.

Details

-

NMSettingBond

-
typedef struct _NMSettingBond NMSettingBond;
-

-

-
-
-
-

NMSettingBondClass

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

+
#define NM_SETTING_BOND_SETTING_NAME "bond"
 

 

 

@@ -138,8 +123,11 @@ necessary for bond connections.
 	NM_SETTING_BOND_ERROR_MISSING_OPTION,   /*< nick=MissingOption >*/
 } NMSettingBondError;
-
+
+++ @@ -180,6 +168,24 @@ required
+

nm_setting_bond_error_quark ()

+
GQuark              nm_setting_bond_error_quark         (void);
+

+Registers an error quark for NMSettingBond if necessary. +

+

NM_SETTING_BOND_ERROR_UNKNOWN
++++ + + + + +

Returns :

the error quark used for NMSettingBond errors.
+
+
+

NM_SETTING_BOND_INTERFACE_NAME

#define NM_SETTING_BOND_INTERFACE_NAME "interface-name"
@@ -196,16 +202,16 @@ required
-

NM_SETTING_BOND_OPTION_ARP_INTERVAL

-
#define NM_SETTING_BOND_OPTION_ARP_INTERVAL  "arp_interval"
+
NM_SETTING_BOND_OPTION_MODE

+
#define NM_SETTING_BOND_OPTION_MODE          "mode"
-

NM_SETTING_BOND_OPTION_ARP_IP_TARGET

-
#define NM_SETTING_BOND_OPTION_ARP_IP_TARGET "arp_ip_target"
+
NM_SETTING_BOND_OPTION_MIIMON

+
#define NM_SETTING_BOND_OPTION_MIIMON        "miimon"
 

 

 

@@ -220,85 +226,67 @@ required
-

NM_SETTING_BOND_OPTION_MIIMON

-
#define NM_SETTING_BOND_OPTION_MIIMON        "miimon"
+
NM_SETTING_BOND_OPTION_UPDELAY

+
#define NM_SETTING_BOND_OPTION_UPDELAY       "updelay"
-

NM_SETTING_BOND_OPTION_MODE

-
#define NM_SETTING_BOND_OPTION_MODE          "mode"
+
NM_SETTING_BOND_OPTION_ARP_INTERVAL

+
#define NM_SETTING_BOND_OPTION_ARP_INTERVAL  "arp_interval"
-

NM_SETTING_BOND_OPTION_UPDELAY

-
#define NM_SETTING_BOND_OPTION_UPDELAY       "updelay"
+
NM_SETTING_BOND_OPTION_ARP_IP_TARGET

+
#define NM_SETTING_BOND_OPTION_ARP_IP_TARGET "arp_ip_target"
-

NM_SETTING_BOND_SETTING_NAME

-
#define NM_SETTING_BOND_SETTING_NAME "bond"
-
+

NMSettingBond

+
typedef struct _NMSettingBond NMSettingBond;

-

nm_setting_bond_add_option ()

-
gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
-                                                         const char *name,
-                                                         const char *value);
+

NMSettingBondClass

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

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

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

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_error_quark ()

-
GQuark              nm_setting_bond_error_quark         (void);
+

nm_setting_bond_new ()

+
NMSetting *         nm_setting_bond_new                 (void);

-Registers an error quark for NMSettingBond if necessary. +Creates a new NMSettingBond object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingBond errors.the new empty NMSettingBond object. [transfer full] +
@@ -306,8 +294,11 @@ Registers an error quark for

nm_setting_bond_get_interface_name ()

const char *        nm_setting_bond_get_interface_name  (NMSettingBond *setting);
-
+
+++ @@ -330,8 +321,11 @@ 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 :

+
+++ @@ -359,8 +353,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.

-

setting :

+
+++ @@ -403,8 +400,11 @@ currently held by the setting) Returns the value associated with the bonding option specified by name, if it exists.

-

setting :

+
+++ @@ -417,7 +417,7 @@ Returns the value associated with the bonding option specified by - @@ -425,11 +425,21 @@ setting; the value is owned by the setting and must not be modified
-

nm_setting_bond_get_option_default ()

-
const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
-                                                         const char *name);
-

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
+

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

+
+++ @@ -438,25 +448,35 @@ setting; the value is owned by the setting and must not be modified - + + + + + - +

setting :

name :

the name of the optionname for the option

value :

value for the option

Returns :

the value of the bond option if not overridden by an entry in -the "options" property. +TRUE if the option was valid and was added to the internal option +list, FALSE if it was not.
-

nm_setting_bond_get_valid_options ()

-
const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);
+

nm_setting_bond_remove_option ()

+
gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
+                                                         const char *name);

-Returns a list of valid bond options. +Remove the bonding option referenced by name from the internal option +list.

-
+
+++ @@ -464,40 +484,54 @@ Returns a list of valid bond options. + + + + - +

setting :

name :

name of the option to remove

Returns :

a NULL-terminated array of strings of valid bond options. [transfer none] - +TRUE if the option was found and removed from the internal option +list, FALSE if it was not.
-

nm_setting_bond_new ()

-
NMSetting *         nm_setting_bond_new                 (void);
+

nm_setting_bond_get_valid_options ()

+
const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);

-Creates a new NMSettingBond object with default values. +Returns a list of valid bond options.

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

setting :

the NMSettingBond +

Returns :

the new empty NMSettingBond object. [transfer full] +a NULL-terminated array of strings of valid bond options. [transfer none]
-

nm_setting_bond_remove_option ()

-
gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
+
nm_setting_bond_get_option_default ()

+
const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
                                                          const char *name);

-

-Remove the bonding option referenced by name from the internal option
-list.
-

-

+

+++
@@ -506,13 +540,12 @@ list.
 
-
+
-
+

 


 
 

 
setting :

 

 
name :
name of the option to removethe name of the option
 

 

 
Returns :

-TRUE if the option was found and removed from the internal option
-list, FALSE if it was not.the value of the bond option if not overridden by an entry in
+the "options" property.
 

 
 

@@ -542,6 +575,6 @@ alphanumeric characters (ie, [a-zA-Z0-9]).
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19
\ No newline at end of file -- cgit 1.3.0-6-gf8a5