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/NMSettingTeam.html | 426 +++++++++++++++++--------------- 1 file changed, 232 insertions(+), 194 deletions(-) (limited to 'docs/libnm-util/html/NMSettingTeam.html') diff --git a/docs/libnm-util/html/NMSettingTeam.html b/docs/libnm-util/html/NMSettingTeam.html index 024575eb..fb7ee6a7 100644 --- a/docs/libnm-util/html/NMSettingTeam.html +++ b/docs/libnm-util/html/NMSettingTeam.html @@ -2,34 +2,28 @@ -NMSettingTeam +libnm-util Reference Manual: NMSettingTeam - + - - - - - - - - - - + + + + + + +
@@ -37,254 +31,298 @@

NMSettingTeam

NMSettingTeam — Describes connection properties for teams

- +
-
-

Synopsis

-
-#include <nm-setting-team.h>
-
-#define             NM_SETTING_TEAM_SETTING_NAME
-enum                NMSettingTeamError;
-#define             NM_SETTING_TEAM_ERROR
-GQuark              nm_setting_team_error_quark         (void);
-#define             NM_SETTING_TEAM_INTERFACE_NAME
-#define             NM_SETTING_TEAM_CONFIG
-                    NMSettingTeam;
-                    NMSettingTeamClass;
-NMSetting *         nm_setting_team_new                 (void);
-const char *        nm_setting_team_get_interface_name  (NMSettingTeam *setting);
-const char *        nm_setting_team_get_config          (NMSettingTeam *setting);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingTeamError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingTeam
-
-
-
-

Properties

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

Description

-

-The NMSettingTeam object is a NMSetting subclass that describes properties -necessary for team connections. -

-
-

Details

-
-

NM_SETTING_TEAM_SETTING_NAME

-
#define NM_SETTING_TEAM_SETTING_NAME "team"
-
-

-

-
-
-
-

enum NMSettingTeamError

-
typedef enum {
-	NM_SETTING_TEAM_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_TEAM_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_TEAM_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-} NMSettingTeamError;
-
-
+

Functions

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

NM_SETTING_TEAM_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_team_error_quark () +
+NMSetting * + +nm_setting_team_new ()

NM_SETTING_TEAM_ERROR_INVALID_PROPERTY

the property was invalid +const char * + +nm_setting_team_get_interface_name ()

NM_SETTING_TEAM_ERROR_MISSING_PROPERTY

the property was missing and is -required +const char * + +nm_setting_team_get_config ()
-
-
-

NM_SETTING_TEAM_ERROR

-
#define NM_SETTING_TEAM_ERROR nm_setting_team_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + +
+gchar *configRead / Write
+gchar *interface-nameRead / Write
-
-
-

nm_setting_team_error_quark ()

-
GQuark              nm_setting_team_error_quark         (void);
-

-Registers an error quark for NMSettingTeam if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingTeam errors.
#defineNM_SETTING_TEAM_SETTING_NAME
enumNMSettingTeamError
#defineNM_SETTING_TEAM_ERROR
#defineNM_SETTING_TEAM_INTERFACE_NAME
#defineNM_SETTING_TEAM_CONFIG
-

Since 0.9.10

-
-
-

NM_SETTING_TEAM_INTERFACE_NAME

-
#define NM_SETTING_TEAM_INTERFACE_NAME "interface-name"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingTeamError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingTeam
 

-

-

 

-

-

-
NM_SETTING_TEAM_CONFIG

-
#define NM_SETTING_TEAM_CONFIG "config"
+

+
Includes

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

-

-

 

-

+

+
Description

+
The NMSettingTeam object is a NMSetting subclass that describes properties
+necessary for team connections.

+

+

+
Functions

 

-
NMSettingTeam

-
typedef struct _NMSettingTeam NMSettingTeam;

-

-

+
nm_setting_team_error_quark ()

+
GQuark
+nm_setting_team_error_quark (void);

+
Registers an error quark for NMSettingTeam if necessary.

+

+
Returns

+
 the error quark used for NMSettingTeam errors.

+

+

+
Since 0.9.10

 

 

 

-
NMSettingTeamClass

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

-

-

+
nm_setting_team_new ()

+
NMSetting *
+nm_setting_team_new (void);

+
Creates a new NMSettingTeam object with default values.

+

+
Returns

+
 the new empty NMSettingTeam object. 

+
[transfer full]

+

+
Since 0.9.10

 

 

 

-
nm_setting_team_new ()

-
NMSetting *         nm_setting_team_new                 (void);

-

-Creates a new NMSettingTeam object with default values.
-

-

+
nm_setting_team_get_interface_name ()

+
const char *
+nm_setting_team_get_interface_name (NMSettingTeam *setting);

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingTeam object. [transfer full]
-
setting
the NMSettingTeam
 
 

 

+

+

+
Returns

+
 the “interface-name” property of the setting

+

+

 
Since 0.9.10

 

 

 

-
nm_setting_team_get_interface_name ()

-
const char *        nm_setting_team_get_interface_name  (NMSettingTeam *setting);

-

+
nm_setting_team_get_config ()

+
const char *
+nm_setting_team_get_config (NMSettingTeam *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingTeam
-
Returns :
the "interface-name" property of the setting
setting
the NMSettingTeam
 

 

+

+

+
Returns

+
 the “config” property of the setting

+

+

 
Since 0.9.10

 

+
+
+

Types and Values

+
+

NM_SETTING_TEAM_SETTING_NAME

+
#define NM_SETTING_TEAM_SETTING_NAME "team"
+
+

+

+
-

nm_setting_team_get_config ()

-
const char *        nm_setting_team_get_config          (NMSettingTeam *setting);
-
+

enum NMSettingTeamError

+
+

Members

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

setting :

the NMSettingTeam +

NM_SETTING_TEAM_ERROR_UNKNOWN

 +

unknown or unclassified error

+		 

NM_SETTING_TEAM_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

Returns :

the "config" property of the setting

NM_SETTING_TEAM_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 
-

Since 0.9.10

-
-

Property Details

+
-

The "config" property

-
  "config"                   gchar*                : Read / Write
+

NM_SETTING_TEAM_ERROR

+
#define NM_SETTING_TEAM_ERROR nm_setting_team_error_quark ()
+

-The JSON configuration for the team network interface. The property -should contain raw JSON configuration data suitable for teamd, because -the value is passed directly to teamd. If not specified, the default -configuration is used. See man teamd.conf for the format details.

-

Default value: NULL

-

The "interface-name" property

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

NM_SETTING_TEAM_INTERFACE_NAME

+
#define NM_SETTING_TEAM_INTERFACE_NAME "interface-name"
+
+

+

+
+
+
+

NM_SETTING_TEAM_CONFIG

+
#define NM_SETTING_TEAM_CONFIG "config"
+

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

+
+
+
+

Property Details

+
+

The “config” property

+
  “config”                   gchar *
+

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “interface-name” property

+
  “interface-name”           gchar *
+

+

Flags: Read / Write

Default value: NULL

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