From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-util/html/NMSettingBridge.html | 824 +++++++++++++++++------------- 1 file changed, 473 insertions(+), 351 deletions(-) (limited to 'docs/libnm-util/html/NMSettingBridge.html') diff --git a/docs/libnm-util/html/NMSettingBridge.html b/docs/libnm-util/html/NMSettingBridge.html index b5a9742c..8be803d6 100644 --- a/docs/libnm-util/html/NMSettingBridge.html +++ b/docs/libnm-util/html/NMSettingBridge.html @@ -2,34 +2,28 @@ -NMSettingBridge +libnm-util Reference Manual: NMSettingBridge - + - - - - - - - - - - + + + + + + +
@@ -37,70 +31,427 @@

NMSettingBridge

NMSettingBridge — Describes connection properties for bridges

- +
-
-

Synopsis

-
-#include <nm-setting-bridge.h>
-
-#define             NM_SETTING_BRIDGE_SETTING_NAME
-enum                NMSettingBridgeError;
-#define             NM_SETTING_BRIDGE_ERROR
-GQuark              nm_setting_bridge_error_quark       (void);
-#define             NM_SETTING_BRIDGE_INTERFACE_NAME
-#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
-                    NMSettingBridge;
-                    NMSettingBridgeClass;
-NMSetting *         nm_setting_bridge_new               (void);
-const char *        nm_setting_bridge_get_interface_name
-                                                        (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);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_bridge_error_quark () +
+NMSetting * + +nm_setting_bridge_new () +
const char * + +nm_setting_bridge_get_interface_name () +
+gboolean + +nm_setting_bridge_get_stp () +
+guint16 + +nm_setting_bridge_get_priority () +
+guint16 + +nm_setting_bridge_get_forward_delay () +
+guint16 + +nm_setting_bridge_get_hello_time () +
+guint16 + +nm_setting_bridge_get_max_age () +
+guint32 + +nm_setting_bridge_get_ageing_time () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
guintageing-timeRead / Write / Construct
guintforward-delayRead / Write / Construct
guinthello-timeRead / Write / Construct
+gchar *interface-nameRead / Write
guintmax-ageRead / Write / Construct
guintpriorityRead / Write / Construct
gbooleanstpRead / Write / Construct
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_BRIDGE_SETTING_NAME
enumNMSettingBridgeError
#defineNM_SETTING_BRIDGE_ERROR
#defineNM_SETTING_BRIDGE_INTERFACE_NAME
#defineNM_SETTING_BRIDGE_STP
#defineNM_SETTING_BRIDGE_PRIORITY
#defineNM_SETTING_BRIDGE_FORWARD_DELAY
#defineNM_SETTING_BRIDGE_HELLO_TIME
#defineNM_SETTING_BRIDGE_MAX_AGE
#defineNM_SETTING_BRIDGE_AGEING_TIME

Object Hierarchy

-
-  GEnum
-   +----NMSettingBridgeError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingBridge
+
    GEnum
+    ╰── NMSettingBridgeError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingBridge
-

Properties

-
-  "ageing-time"              guint                 : Read / Write / Construct
-  "forward-delay"            guint                 : Read / Write / Construct
-  "hello-time"               guint                 : Read / Write / Construct
-  "interface-name"           gchar*                : Read / Write
-  "max-age"                  guint                 : Read / Write / Construct
-  "priority"                 guint                 : Read / Write / Construct
-  "stp"                      gboolean              : Read / Write / Construct
+
Includes

+
#include <nm-setting-bridge.h>

Description

-

-The NMSettingBridge object is a NMSetting subclass that describes properties -necessary for bridging connections. -

+

The NMSettingBridge object is a NMSetting subclass that describes properties +necessary for bridging connections.

+
+
+

Functions

+
+

nm_setting_bridge_error_quark ()

+
GQuark
+nm_setting_bridge_error_quark (void);
+

Registers an error quark for NMSettingBridge if necessary.

+
+

Returns

+

the error quark used for NMSettingBridge errors.

+

+
+

Since 0.9.8

+
+
+
+

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]

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_interface_name ()

+
const char *
+nm_setting_bridge_get_interface_name (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “interface-name” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_stp ()

+
gboolean
+nm_setting_bridge_get_stp (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “stp” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_priority ()

+
guint16
+nm_setting_bridge_get_priority (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “priority” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_forward_delay ()

+
guint16
+nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “forward-delay” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_hello_time ()

+
guint16
+nm_setting_bridge_get_hello_time (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “hello-time” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_max_age ()

+
guint16
+nm_setting_bridge_get_max_age (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “max-age” property of the setting

+

+
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_get_ageing_time ()

+
guint32
+nm_setting_bridge_get_ageing_time (NMSettingBridge *setting);
+
+

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “ageing-time” property of the setting

+

+
+

Since 0.9.8

+
-

Details

+

Types and Values

NM_SETTING_BRIDGE_SETTING_NAME

#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
@@ -110,37 +461,41 @@ necessary for bridging connections.
-

enum NMSettingBridgeError

-
typedef enum {
-	NM_SETTING_BRIDGE_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-} NMSettingBridgeError;
-
-
+

enum NMSettingBridgeError

+
+

Members

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

NM_SETTING_BRIDGE_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_BRIDGE_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 
+

Since 0.9.8

@@ -153,25 +508,6 @@ required
-

nm_setting_bridge_error_quark ()

-
GQuark              nm_setting_bridge_error_quark       (void);
-

-Registers an error quark for NMSettingBridge if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingBridge errors.
-

Since 0.9.8

-
-
-

NM_SETTING_BRIDGE_INTERFACE_NAME

#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"
@@ -226,287 +562,73 @@ Registers an error quark for -

NMSettingBridge

-
typedef struct _NMSettingBridge NMSettingBridge;
-

-

-
-
-
-

NMSettingBridgeClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} 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] -
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_interface_name ()

-
const char *        nm_setting_bridge_get_interface_name
-                                                        (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "interface-name" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_stp ()

-
gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "stp" property of the setting
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_get_priority ()

-
guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingBridge -

Returns :

the "priority" property of the setting
-

Since 0.9.8

-
-
-
-

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
-

Since 0.9.8

-
-
-
-

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
-

Since 0.9.8

-
-
-
-

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
-

Since 0.9.8

-
-
-
-

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
-

Since 0.9.8

-

Property Details

-

The "ageing-time" property

-
  "ageing-time"              guint                 : Read / Write / Construct
-

-The ethernet MAC address aging time, in seconds. -

+

The “ageing-time” property

+
  “ageing-time”              guint
+

The ethernet MAC address aging time, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 1000000

Default value: 300

Since 0.9.8

-

The "forward-delay" property

-
  "forward-delay"            guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) forwarding delay, in seconds. -

+

The “forward-delay” property

+
  “forward-delay”            guint
+

The Spanning Tree Protocol (STP) forwarding delay, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 30

Default value: 15

Since 0.9.8

-

The "hello-time" property

-
  "hello-time"               guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) hello time, in seconds. -

+

The “hello-time” property

+
  “hello-time”               guint
+

The Spanning Tree Protocol (STP) hello time, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 10

Default value: 2

Since 0.9.8

-

The "interface-name" property

-
  "interface-name"           gchar*                : Read / Write
-

-The name of the virtual in-kernel briding network interface -

+

The “interface-name” property

+
  “interface-name”           gchar *
+

The name of the virtual in-kernel bridging network interface.

+

Flags: Read / Write

Default value: NULL

Since 0.9.8

-

The "max-age" property

-
  "max-age"                  guint                 : Read / Write / Construct
-

-The Spanning Tree Protocol (STP) maximum message age, in seconds. -

+

The “max-age” property

+
  “max-age”                  guint
+

The Spanning Tree Protocol (STP) maximum message age, in seconds.

+

Flags: Read / Write / Construct

Allowed values: <= 40

Default value: 20

Since 0.9.8

-

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

+

The “priority” property

+
  “priority”                 guint
+

Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are 'better'; the lowest priority bridge will be elected the root bridge.

+

Flags: Read / Write / Construct

Allowed values: <= 65535

-

Default value: 128

+

Default value: 32768

Since 0.9.8

-

The "stp" property

-
  "stp"                      gboolean              : Read / Write / Construct
-

-Controls whether Spanning Tree Protocol (STP) is enabled for this bridge. -

+

The “stp” property

+
  “stp”                      gboolean
+

Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.

+

Flags: Read / Write / Construct

Default value: TRUE

Since 0.9.8

@@ -514,6 +636,6 @@ Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file -- cgit 1.3.0-6-gf8a5