From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm/html/NMSettingBridge.html | 701 ++++++++++++++++++++--------------- 1 file changed, 409 insertions(+), 292 deletions(-) (limited to 'docs/libnm/html/NMSettingBridge.html') diff --git a/docs/libnm/html/NMSettingBridge.html b/docs/libnm/html/NMSettingBridge.html index 7248b61b..addccbb4 100644 --- a/docs/libnm/html/NMSettingBridge.html +++ b/docs/libnm/html/NMSettingBridge.html @@ -2,34 +2,28 @@ -NMSettingBridge +libnm Reference Manual: NMSettingBridge - + - - - - - - - - - - + + + + + + +
@@ -37,59 +31,383 @@

NMSettingBridge

NMSettingBridge — Describes connection properties for bridges

- +
-
-

Synopsis

-
#define             NM_SETTING_BRIDGE_SETTING_NAME
-#define             NM_SETTING_BRIDGE_MAC_ADDRESS
-#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
-struct              NMSettingBridge;
-                    NMSettingBridgeClass;
-NMSetting *         nm_setting_bridge_new               (void);
-const char *        nm_setting_bridge_get_mac_address   (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);
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMSetting
-         +----NMSettingBridge
-
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+NMSetting * + +nm_setting_bridge_new () +
const char * + +nm_setting_bridge_get_mac_address () +
+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

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

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





guintageing-timeRead / Write / Construct
guintforward-delayRead / Write / Construct
guinthello-timeRead / Write / Construct

+gchar *mac-addressRead / Write
guintmax-ageRead / Write / Construct
guintpriorityRead / Write / Construct
gbooleanstpRead / Write / Construct

+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_BRIDGE_SETTING_NAME
#defineNM_SETTING_BRIDGE_MAC_ADDRESS
#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

+
    GObject
+    ╰── NMSetting
+        ╰── NMSettingBridge

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

+
NMSetting *
+nm_setting_bridge_new (void);
+

Creates a new NMSettingBridge object with default values.

+
+

Returns

+

the new empty NMSettingBridge object.

+

[transfer full]

+
+
+
+
+

nm_setting_bridge_get_mac_address ()

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

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “mac-address” property of the setting

+

+
+
+
+
+

nm_setting_bridge_get_stp ()

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

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “stp” property of the setting

+

+
+
+
+
+

nm_setting_bridge_get_priority ()

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

Parameters

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

setting

the NMSettingBridge

 
+
+
+

Returns

+

the “priority” property of the setting

+

+
+
+
+
+

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

+

+
+
+
+
+

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

+

+
+
+
+
+

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

+

+
+
+
+
+

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

+

+
+
-

Details

+

Types and Values

NM_SETTING_BRIDGE_SETTING_NAME

#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
@@ -153,274 +471,73 @@ necessary for bridging connections.
-
-
-

struct NMSettingBridge

-
struct NMSettingBridge;
-

-

-
-
-
-

NMSettingBridgeClass

-
typedef struct {
-	NMSettingClass parent;
-} 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] -
-
-
-
-

nm_setting_bridge_get_mac_address ()

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

setting :

the NMSettingBridge -

Returns :

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

nm_setting_bridge_get_stp ()

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

setting :

the NMSettingBridge -

Returns :

the "stp" property of the setting
-
-
-
-

nm_setting_bridge_get_priority ()

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

setting :

the NMSettingBridge -

Returns :

the "priority" property of the setting
-
-
-
-

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

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

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

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
-

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
+

+

Flags: Read / Write / Construct

Allowed values: <= 1000000

Default value: 300

-

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
+

+

Flags: Read / Write / Construct

Allowed values: <= 30

Default value: 15

-

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
+

+

Flags: Read / Write / Construct

Allowed values: <= 10

Default value: 2

-

The "mac-address" property

-
  "mac-address"              gchar*                : Read / Write
-

-If specified, the MAC address of bridge. When creating a new bridge, this -MAC address will be set. When matching an existing (outside -NetworkManager created) bridge, this MAC address must match. -

+

The “mac-address” property

+
  “mac-address”              gchar *
+

+

Flags: Read / Write

Default value: NULL

-

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
+

+

Flags: Read / Write / Construct

Allowed values: <= 40

Default value: 20

-

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
+

+

Flags: Read / Write / Construct

Allowed values: <= 65535

Default value: 32768

-

The "stp" property

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

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

+

The “stp” property

+
  “stp”                      gboolean
+

+

Flags: Read / Write / Construct

Default value: TRUE

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21 \ No newline at end of file -- cgit 1.3.0-6-gf8a5