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-util/html/NMSettingBridgePort.html | 509 ++++++++++++++------------ 1 file changed, 281 insertions(+), 228 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 9f3cdb36..00f8ce21 100644 --- a/docs/libnm-util/html/NMSettingBridgePort.html +++ b/docs/libnm-util/html/NMSettingBridgePort.html @@ -2,34 +2,28 @@ -NMSettingBridgePort +libnm-util Reference Manual: NMSettingBridgePort - + - - - - - - - - - - + + + + + + +
@@ -37,59 +31,252 @@

NMSettingBridgePort

NMSettingBridgePort — Describes connection properties for bridge ports

- +
-
-

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);
-
+
+

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

Object Hierarchy

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

Properties

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

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

Description

-

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

+

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

+
-

Details

+

Types and Values

NM_SETTING_BRIDGE_PORT_SETTING_NAME

#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port"
@@ -99,37 +286,41 @@ optional properties that apply to bridge ports.
-

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

enum NMSettingBridgePortError

+
+

Members

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

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

@@ -142,25 +333,6 @@ 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"
@@ -183,152 +355,33 @@ Registers an error quark for

-
-
-

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

+

The “hairpin-mode” property

+
  “hairpin-mode”             gboolean
+

+

Flags: Read / Write

Default value: FALSE

Since 0.9.8

-

The "path-cost" property

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

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

+

The “path-cost” property

+
  “path-cost”                guint
+

+

Flags: Read / Write / Construct

Allowed values: <= 65535

Default value: 100

Since 0.9.8

-

The "priority" property

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

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

+

The “priority” property

+
  “priority”                 guint
+

+

Flags: Read / Write / Construct

Allowed values: <= 63

Default value: 32

Since 0.9.8

@@ -337,6 +390,6 @@ The Spanning Tree Protocol (STP) priority of this bridge port.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21
\ No newline at end of file -- cgit 1.3.0-6-gf8a5