diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingTeam.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingTeam.html | 290 |
1 files changed, 290 insertions, 0 deletions
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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingTeam</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libnm-util Reference Manual"> +<link rel="up" href="ch01.html" title="libnm-util API Reference"> +<link rel="prev" href="NMSettingBridgePort.html" title="NMSettingBridgePort"> +<link rel="next" href="NMSettingTeamPort.html" title="NMSettingTeamPort"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="NMSettingBridgePort.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libnm-util Reference Manual</th> +<td><a accesskey="n" href="NMSettingTeamPort.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingTeam.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingTeam.description" class="shortcut">Description</a> + | + <a href="#NMSettingTeam.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingTeam.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingTeam"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingTeam.top_of_page"></a>NMSettingTeam</span></h2> +<p>NMSettingTeam — Describes connection properties for teams</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingTeam.synopsis"></a><h2>Synopsis</h2> +<a name="NMSettingTeamError"></a><pre class="synopsis"> +#include <nm-setting-team.h> + +#define <a class="link" href="NMSettingTeam.html#NM-SETTING-TEAM-SETTING-NAME:CAPS" title="NM_SETTING_TEAM_SETTING_NAME">NM_SETTING_TEAM_SETTING_NAME</a> +enum <a class="link" href="NMSettingTeam.html#NMSettingTeamError-enum" title="enum NMSettingTeamError">NMSettingTeamError</a>; +#define <a class="link" href="NMSettingTeam.html#NM-SETTING-TEAM-ERROR:CAPS" title="NM_SETTING_TEAM_ERROR">NM_SETTING_TEAM_ERROR</a> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMSettingTeam.html#nm-setting-team-error-quark" title="nm_setting_team_error_quark ()">nm_setting_team_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +#define <a class="link" href="NMSettingTeam.html#NM-SETTING-TEAM-INTERFACE-NAME:CAPS" title="NM_SETTING_TEAM_INTERFACE_NAME">NM_SETTING_TEAM_INTERFACE_NAME</a> +#define <a class="link" href="NMSettingTeam.html#NM-SETTING-TEAM-CONFIG:CAPS" title="NM_SETTING_TEAM_CONFIG">NM_SETTING_TEAM_CONFIG</a> + <a class="link" href="NMSettingTeam.html#NMSettingTeam-struct" title="NMSettingTeam">NMSettingTeam</a>; + <a class="link" href="NMSettingTeam.html#NMSettingTeamClass" title="NMSettingTeamClass">NMSettingTeamClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingTeam.html#nm-setting-team-new" title="nm_setting_team_new ()">nm_setting_team_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingTeam.html#nm-setting-team-get-interface-name" title="nm_setting_team_get_interface_name ()">nm_setting_team_get_interface_name</a> (<em class="parameter"><code><a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingTeam.html#nm-setting-team-get-config" title="nm_setting_team_get_config ()">nm_setting_team_get_config</a> (<em class="parameter"><code><a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> *setting</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingTeam.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GEnum + +----NMSettingTeamError +</pre> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> + +----NMSettingTeam +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingTeam.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingTeam.html#NMSettingTeam--config" title='The "config" property'>config</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="NMSettingTeam.html#NMSettingTeam--interface-name" title='The "interface-name" property'>interface-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingTeam.description"></a><h2>Description</h2> +<p> +The <a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties +necessary for team connections. +</p> +</div> +<div class="refsect1"> +<a name="NMSettingTeam.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NM-SETTING-TEAM-SETTING-NAME:CAPS"></a><h3>NM_SETTING_TEAM_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_TEAM_SETTING_NAME "team" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingTeamError-enum"></a><h3>enum NMSettingTeamError</h3> +<pre class="programlisting">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; +</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><a name="NM-SETTING-TEAM-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_TEAM_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-TEAM-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_TEAM_ERROR_INVALID_PROPERTY</code></span></p></td> +<td>the property was invalid +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-TEAM-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_TEAM_ERROR_MISSING_PROPERTY</code></span></p></td> +<td>the property was missing and is +required +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-TEAM-ERROR:CAPS"></a><h3>NM_SETTING_TEAM_ERROR</h3> +<pre class="programlisting">#define NM_SETTING_TEAM_ERROR nm_setting_team_error_quark () +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-team-error-quark"></a><h3>nm_setting_team_error_quark ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_team_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> if necessary. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the error quark used for <a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> errors.</td> +</tr></tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-TEAM-INTERFACE-NAME:CAPS"></a><h3>NM_SETTING_TEAM_INTERFACE_NAME</h3> +<pre class="programlisting">#define NM_SETTING_TEAM_INTERFACE_NAME "interface-name" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-TEAM-CONFIG:CAPS"></a><h3>NM_SETTING_TEAM_CONFIG</h3> +<pre class="programlisting">#define NM_SETTING_TEAM_CONFIG "config" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingTeam-struct"></a><h3>NMSettingTeam</h3> +<pre class="programlisting">typedef struct _NMSettingTeam NMSettingTeam;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingTeamClass"></a><h3>NMSettingTeamClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingTeamClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-team-new"></a><h3>nm_setting_team_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_team_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> object with default values. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the new empty <a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-team-get-interface-name"></a><h3>nm_setting_team_get_interface_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_team_get_interface_name (<em class="parameter"><code><a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingTeam.html#NMSettingTeam--interface-name" title='The "interface-name" property'><span class="type">"interface-name"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-team-get-config"></a><h3>nm_setting_team_get_config ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_team_get_config (<em class="parameter"><code><a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingTeam.html" title="NMSettingTeam"><span class="type">NMSettingTeam</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingTeam.html#NMSettingTeam--config" title='The "config" property'><span class="type">"config"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingTeam.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMSettingTeam--config"></a><h3>The <code class="literal">"config"</code> property</h3> +<pre class="programlisting"> "config" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +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. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingTeam--interface-name"></a><h3>The <code class="literal">"interface-name"</code> property</h3> +<pre class="programlisting"> "interface-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +The name of the virtual in-kernel team network interface +</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |