From 33491bc4279481db8ae47213e34a6d695a0e8830 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 6 Jul 2014 02:16:10 +0200 Subject: Imported Upstream version 0.9.10.0 --- docs/libnm-util/html/NMSettingBridgePort.html | 511 ++++++++++++-------------- 1 file changed, 229 insertions(+), 282 deletions(-) (limited to 'docs/libnm-util/html/NMSettingBridgePort.html') diff --git a/docs/libnm-util/html/NMSettingBridgePort.html b/docs/libnm-util/html/NMSettingBridgePort.html index 146e4a64..9f3cdb36 100644 --- a/docs/libnm-util/html/NMSettingBridgePort.html +++ b/docs/libnm-util/html/NMSettingBridgePort.html @@ -2,28 +2,34 @@ -libnm-util Reference Manual: NMSettingBridgePort +NMSettingBridgePort - - + + - - - - - - - + + + + + + + + + +
@@ -31,252 +37,59 @@

NMSettingBridgePort

NMSettingBridgePort — Describes connection properties for bridge ports

- +
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - -
-GQuark - -nm_setting_bridge_port_error_quark () -
-NMSetting * - -nm_setting_bridge_port_new () -
-guint16 - -nm_setting_bridge_port_get_priority () -
-guint16 - -nm_setting_bridge_port_get_path_cost () -
-gboolean - -nm_setting_bridge_port_get_hairpin_mode () -
-
-
-

Properties

-
----- - - - - - - - - - - - - - - - - - -
gbooleanhairpin-modeRead / Write
guintpath-costRead / Write / Construct
guintpriorityRead / Write / Construct
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineNM_SETTING_BRIDGE_PORT_SETTING_NAME
enumNMSettingBridgePortError
#defineNM_SETTING_BRIDGE_PORT_ERROR
#defineNM_SETTING_BRIDGE_PORT_PRIORITY
#defineNM_SETTING_BRIDGE_PORT_PATH_COST
#defineNM_SETTING_BRIDGE_PORT_HAIRPIN_MODE
+
+

Synopsis

+
+#include <nm-setting-bridge-port.h>
+
+#define             NM_SETTING_BRIDGE_PORT_SETTING_NAME
+enum                NMSettingBridgePortError;
+#define             NM_SETTING_BRIDGE_PORT_ERROR
+GQuark              nm_setting_bridge_port_error_quark  (void);
+#define             NM_SETTING_BRIDGE_PORT_PRIORITY
+#define             NM_SETTING_BRIDGE_PORT_PATH_COST
+#define             NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE
+                    NMSettingBridgePort;
+                    NMSettingBridgePortClass;
+NMSetting *         nm_setting_bridge_port_new          (void);
+guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
+guint16             nm_setting_bridge_port_get_path_cost
+                                                        (NMSettingBridgePort *setting);
+gboolean            nm_setting_bridge_port_get_hairpin_mode
+                                                        (NMSettingBridgePort *setting);
+

Object Hierarchy

-
    GEnum
-    ╰── NMSettingBridgePortError
-    GObject
-    ╰── NMSetting
-        ╰── NMSettingBridgePort
+
+  GEnum
+   +----NMSettingBridgePortError
+

+
+  GObject
+   +----NMSetting
+         +----NMSettingBridgePort
-

Includes

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

+
+  "hairpin-mode"             gboolean              : Read / Write
+  "path-cost"                guint                 : Read / Write / Construct
+  "priority"                 guint                 : Read / Write / Construct

Description

-

The NMSettingBridgePort object is a NMSetting subclass that describes -optional properties that apply to bridge ports.

-
-
-

Functions

-
-

nm_setting_bridge_port_error_quark ()

-
GQuark
-nm_setting_bridge_port_error_quark (void);
-

Registers an error quark for NMSettingBridgePort if necessary.

-
-

Returns

-

the error quark used for NMSettingBridgePort errors.

-

-
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_port_new ()

-
NMSetting *
-nm_setting_bridge_port_new (void);
-

Creates a new NMSettingBridgePort object with default values.

-
-

Returns

-

the new empty NMSettingBridgePort object.

-

[transfer full]

-
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_port_get_priority ()

-
guint16
-nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
-
-

Parameters

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

setting

the NMSettingBridgePort

 
-
-
-

Returns

-

the “priority” property of the setting

-

-
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_port_get_path_cost ()

-
guint16
-nm_setting_bridge_port_get_path_cost (NMSettingBridgePort *setting);
-
-

Parameters

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

setting

the NMSettingBridgePort

 
-
-
-

Returns

-

the “path-cost” property of the setting

-

-
-

Since 0.9.8

-
-
-
-

nm_setting_bridge_port_get_hairpin_mode ()

-
gboolean
-nm_setting_bridge_port_get_hairpin_mode
-                               (NMSettingBridgePort *setting);
-
-

Parameters

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

setting

the NMSettingBridgePort

 
-
-
-

Returns

-

the “hairpin-mode” property of the setting

-

-
-

Since 0.9.8

-
+

+The NMSettingBridgePort object is a NMSetting subclass that describes +optional properties that apply to bridge ports. +

-

Types and Values

+

Details

NM_SETTING_BRIDGE_PORT_SETTING_NAME

#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port"
@@ -286,41 +99,37 @@ nm_setting_bridge_port_get_hairpin_mode
-

enum NMSettingBridgePortError

-
-

Members

-
+

enum NMSettingBridgePortError

+
typedef enum {
+	NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
+	NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
+	NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
+} NMSettingBridgePortError;
+
+
---++ - - + - - - + - - - + -

NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN

 -

unknown or unclassified error

+

NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN

unknown or unclassified error  

NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY

 -

the property was invalid

+

NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY

the property was invalid  

NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY

 -

the property was missing and -is required

+

NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY

the property was missing and +is required  
-

Since 0.9.8

@@ -333,6 +142,25 @@ is required

+

nm_setting_bridge_port_error_quark ()

+
GQuark              nm_setting_bridge_port_error_quark  (void);
+

+Registers an error quark for NMSettingBridgePort if necessary. +

+
++++ + + + + +

Returns :

the error quark used for NMSettingBridgePort errors.
+

Since 0.9.8

+
+
+

NM_SETTING_BRIDGE_PORT_PRIORITY

#define NM_SETTING_BRIDGE_PORT_PRIORITY     "priority"
@@ -355,33 +183,152 @@ is required

+
+
+

NMSettingBridgePort

+
typedef struct _NMSettingBridgePort NMSettingBridgePort;
+

+

+
+
+
+

NMSettingBridgePortClass

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

+

+
+
+
+

nm_setting_bridge_port_new ()

+
NMSetting *         nm_setting_bridge_port_new          (void);
+

+Creates a new NMSettingBridgePort object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingBridgePort object. [transfer full] +
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_port_get_priority ()

+
guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingBridgePort +

Returns :

the "priority" property of the setting
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_port_get_path_cost ()

+
guint16             nm_setting_bridge_port_get_path_cost
+                                                        (NMSettingBridgePort *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingBridgePort +

Returns :

the "path-cost" property of the setting
+

Since 0.9.8

+
+
+
+

nm_setting_bridge_port_get_hairpin_mode ()

+
gboolean            nm_setting_bridge_port_get_hairpin_mode
+                                                        (NMSettingBridgePort *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingBridgePort +

Returns :

the "hairpin-mode" property of the setting
+

Since 0.9.8

+

Property Details

-

The “hairpin-mode” property

-
  “hairpin-mode”             gboolean
-

Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.

-

Flags: Read / Write

+

The "hairpin-mode" property

+
  "hairpin-mode"             gboolean              : Read / Write
+

+Enables or disabled "hairpin mode" for the port, which allows frames to +be sent back out through the port the frame was received on. +

Default value: FALSE

Since 0.9.8

-

The “path-cost” property

-
  “path-cost”                guint
-

The Spanning Tree Protocol (STP) port cost for destinations via this port.

-

Flags: Read / Write / Construct

+

The "path-cost" property

+
  "path-cost"                guint                 : Read / Write / Construct
+

+The Spanning Tree Protocol (STP) port cost for destinations via this +port. +

Allowed values: <= 65535

Default value: 100

Since 0.9.8

-

The “priority” property

-
  “priority”                 guint
-

The Spanning Tree Protocol (STP) priority of this bridge port.

-

Flags: Read / Write / Construct

+

The "priority" property

+
  "priority"                 guint                 : Read / Write / Construct
+

+The Spanning Tree Protocol (STP) priority of this bridge port. +

Allowed values: <= 63

Default value: 32

Since 0.9.8

@@ -390,6 +337,6 @@ is required

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