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/NMSettingTeam.html | 290 ++++++++++++++++++++++++++++++++ 1 file changed, 290 insertions(+) create mode 100644 docs/libnm-util/html/NMSettingTeam.html (limited to 'docs/libnm-util/html/NMSettingTeam.html') diff --git a/docs/libnm-util/html/NMSettingTeam.html b/docs/libnm-util/html/NMSettingTeam.html new file mode 100644 index 00000000..024575eb --- /dev/null +++ b/docs/libnm-util/html/NMSettingTeam.html @@ -0,0 +1,290 @@ + + + + +NMSettingTeam + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

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

NM_SETTING_TEAM_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_TEAM_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_TEAM_ERROR_MISSING_PROPERTY

the property was missing and is +required +
+
+
+
+

NM_SETTING_TEAM_ERROR

+
#define NM_SETTING_TEAM_ERROR nm_setting_team_error_quark ()
+
+

+

+
+
+
+

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

+
+
+
+

NM_SETTING_TEAM_INTERFACE_NAME

+
#define NM_SETTING_TEAM_INTERFACE_NAME "interface-name"
+
+

+

+
+
+
+

NM_SETTING_TEAM_CONFIG

+
#define NM_SETTING_TEAM_CONFIG "config"
+
+

+

+
+
+
+

NMSettingTeam

+
typedef struct _NMSettingTeam NMSettingTeam;
+

+

+
+
+
+

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

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

setting :

the NMSettingTeam +

Returns :

the "interface-name" property of the setting
+

Since 0.9.10

+
+
+
+

nm_setting_team_get_config ()

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

setting :

the NMSettingTeam +

Returns :

the "config" property of the setting
+

Since 0.9.10

+
+
+
+

Property Details

+
+

The "config" property

+
  "config"                   gchar*                : Read / Write
+

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

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

+

Default value: NULL

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