about summary refs log tree commit diff
path: root/docs/libnm/html/NMDeviceOvsPort.html
blob: e664afb7d6ae9500b305681c1ae17962294025b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NMDeviceOvsPort: libnm Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libnm Reference Manual">
<link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference">
<link rel="prev" href="NMDeviceOvsInterface.html" title="NMDeviceOvsInterface">
<link rel="next" href="NMDevicePpp.html" title="NMDevicePpp">
<meta name="generator" content="GTK-Doc V1.34.0 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#NMDeviceOvsPort.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#NMDeviceOvsPort.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#NMDeviceOvsPort.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="NMDeviceOvsInterface.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="NMDevicePpp.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="NMDeviceOvsPort"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMDeviceOvsPort.top_of_page"></a>NMDeviceOvsPort</span></h2>
<p>NMDeviceOvsPort</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="NMDeviceOvsPort.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">const <span class="returnvalue">GPtrArray</span> *
</td>
<td class="function_name">
<a class="link" href="NMDeviceOvsPort.html#nm-device-ovs-port-get-slaves" title="nm_device_ovs_port_get_slaves ()">nm_device_ovs_port_get_slaves</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NMDeviceOvsPort.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">GPtrArray</span> *</td>
<td class="property_name"><a class="link" href="NMDeviceOvsPort.html#NMDeviceOvsPort--slaves" title="The “slaves” property">slaves</a></td>
<td class="property_flags">Read</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NMDeviceOvsPort.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="NMDeviceOvsPort.html#NM-DEVICE-OVS-PORT-SLAVES:CAPS" title="NM_DEVICE_OVS_PORT_SLAVES">NM_DEVICE_OVS_PORT_SLAVES</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="NMDeviceOvsPort.html#NMDeviceOvsPort-struct" title="NMDeviceOvsPort">NMDeviceOvsPort</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NMDeviceOvsPort.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a>
        <span class="lineart">╰──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a>
            <span class="lineart">╰──</span> NMDeviceOvsPort
</pre>
</div>
<div class="refsect1">
<a name="NMDeviceOvsPort.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="NMDeviceOvsPort.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="nm-device-ovs-port-get-slaves"></a><h3>nm_device_ovs_port_get_slaves ()</h3>
<pre class="programlisting">const <span class="returnvalue">GPtrArray</span> *
nm_device_ovs_port_get_slaves (<em class="parameter"><code><a class="link" href="NMDeviceOvsPort.html" title="NMDeviceOvsPort"><span class="type">NMDeviceOvsPort</span></a> *device</code></em>);</pre>
<div class="warning">
<p><code class="literal">nm_device_ovs_port_get_slaves</code> has been deprecated since version 1.34 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="NMDevice.html#nm-device-get-ports" title="nm_device_get_ports ()"><code class="function">nm_device_get_ports()</code></a> instead.</p>
</div>
<p>Gets the interfaces currently attached as port to <em class="parameter"><code>device</code></em>
.</p>
<div class="refsect3">
<a name="nm-device-ovs-port-get-slaves.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>device</p></td>
<td class="parameter_description"><p>a <a class="link" href="NMDeviceOvsPort.html" title="NMDeviceOvsPort"><span class="type">NMDeviceOvsPort</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nm-device-ovs-port-get-slaves.returns"></a><h4>Returns</h4>
<p>the <span class="type">GPtrArray</span> containing
<span class="type">NMDevices</span> that are ports of <em class="parameter"><code>device</code></em>
. This is the internal
copy used by the device, and must not be modified. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMDevice]</span></p>
</div>
<p class="since">Since: 1.14</p>
</div>
</div>
<div class="refsect1">
<a name="NMDeviceOvsPort.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="NM-DEVICE-OVS-PORT-SLAVES:CAPS"></a><h3>NM_DEVICE_OVS_PORT_SLAVES</h3>
<pre class="programlisting">#define NM_DEVICE_OVS_PORT_SLAVES "slaves"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="NMDeviceOvsPort-struct"></a><h3>NMDeviceOvsPort</h3>
<pre class="programlisting">typedef struct _NMDeviceOvsPort NMDeviceOvsPort;</pre>
<p class="since">Since: 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="NMDeviceOvsPort.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="NMDeviceOvsPort--slaves"></a><h3>The <code class="literal">“slaves”</code> property</h3>
<pre class="programlisting">  “slaves”                   <span class="type">GPtrArray</span> *</pre>
<p>Gets the interfaces currently attached as port to the device.</p>
<p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GPtrArray(NMDevice)]</span></p>
<p>Owner: NMDeviceOvsPort</p>
<p>Flags: Read</p>
<p class="since">Since: 1.22</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>