1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>NMDeviceEthernet</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
<link rel="home" href="index.html" title="libnm-glib Reference Manual">
8
<link rel="up" href="ch02.html" title="libnm-glib API Reference">
9
<link rel="prev" href="NMDevice.html" title="NMDevice">
10
<link rel="next" href="NMDeviceWifi.html" title="NMDeviceWifi">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="NMDevice.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">libnm-glib Reference Manual</th>
21
<td><a accesskey="n" href="NMDeviceWifi.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#NMDeviceEthernet.synopsis" class="shortcut">Top</a>
26
<a href="#NMDeviceEthernet.description" class="shortcut">Description</a>
28
<a href="#NMDeviceEthernet.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#NMDeviceEthernet.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#NMDeviceEthernet.properties" class="shortcut">Properties</a>
35
<div class="refentry">
36
<a name="NMDeviceEthernet"></a><div class="titlepage"></div>
37
<div class="refnamediv"><table width="100%"><tr>
39
<h2><span class="refentrytitle"><a name="NMDeviceEthernet.top_of_page"></a>NMDeviceEthernet</span></h2>
40
<p>NMDeviceEthernet</p>
42
<td valign="top" align="right"></td>
44
<div class="refsynopsisdiv">
45
<a name="NMDeviceEthernet.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis"> <a class="link" href="NMDeviceEthernet.html#NMDeviceEthernet-struct" title="NMDeviceEthernet">NMDeviceEthernet</a>;
47
<a class="link" href="NMDeviceEthernet.html#NMDeviceEthernetClass" title="NMDeviceEthernetClass">NMDeviceEthernetClass</a>;
48
enum <a class="link" href="NMDeviceEthernet.html#NMDeviceEthernetError" title="enum NMDeviceEthernetError">NMDeviceEthernetError</a>;
49
#define <a class="link" href="NMDeviceEthernet.html#NM-DEVICE-ETHERNET-CARRIER:CAPS" title="NM_DEVICE_ETHERNET_CARRIER">NM_DEVICE_ETHERNET_CARRIER</a>
50
#define <a class="link" href="NMDeviceEthernet.html#NM-DEVICE-ETHERNET-ERROR:CAPS" title="NM_DEVICE_ETHERNET_ERROR">NM_DEVICE_ETHERNET_ERROR</a>
51
#define <a class="link" href="NMDeviceEthernet.html#NM-DEVICE-ETHERNET-HW-ADDRESS:CAPS" title="NM_DEVICE_ETHERNET_HW_ADDRESS">NM_DEVICE_ETHERNET_HW_ADDRESS</a>
52
#define <a class="link" href="NMDeviceEthernet.html#NM-DEVICE-ETHERNET-PERMANENT-HW-ADDRESS:CAPS" title="NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS">NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS</a>
53
#define <a class="link" href="NMDeviceEthernet.html#NM-DEVICE-ETHERNET-SPEED:CAPS" title="NM_DEVICE_ETHERNET_SPEED">NM_DEVICE_ETHERNET_SPEED</a>
54
<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMDeviceEthernet.html#nm-device-ethernet-error-quark" title="nm_device_ethernet_error_quark ()">nm_device_ethernet_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMDeviceEthernet.html#nm-device-ethernet-get-carrier" title="nm_device_ethernet_get_carrier ()">nm_device_ethernet_get_carrier</a> (<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);
56
const <span class="returnvalue">char</span> * <a class="link" href="NMDeviceEthernet.html#nm-device-ethernet-get-hw-address" title="nm_device_ethernet_get_hw_address ()">nm_device_ethernet_get_hw_address</a> (<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);
57
const <span class="returnvalue">char</span> * <a class="link" href="NMDeviceEthernet.html#nm-device-ethernet-get-permanent-hw-address" title="nm_device_ethernet_get_permanent_hw_address ()">nm_device_ethernet_get_permanent_hw_address</a>
58
(<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMDeviceEthernet.html#nm-device-ethernet-get-speed" title="nm_device_ethernet_get_speed ()">nm_device_ethernet_get_speed</a> (<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);
60
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="NMDeviceEthernet.html#nm-device-ethernet-new" title="nm_device_ethernet_new ()">nm_device_ethernet_new</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>,
61
<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
64
<div class="refsect1">
65
<a name="NMDeviceEthernet.object-hierarchy"></a><h2>Object Hierarchy</h2>
66
<pre class="synopsis">
67
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
68
+----<a class="link" href="NMObject.html" title="NMObject">NMObject</a>
69
+----<a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a>
73
<div class="refsect1">
74
<a name="NMDeviceEthernet.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
76
NMDeviceEthernet implements
77
<a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p>
79
<div class="refsect1">
80
<a name="NMDeviceEthernet.properties"></a><h2>Properties</h2>
81
<pre class="synopsis">
82
"<a class="link" href="NMDeviceEthernet.html#NMDeviceEthernet--carrier" title='The "carrier" property'>carrier</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
83
"<a class="link" href="NMDeviceEthernet.html#NMDeviceEthernet--hw-address" title='The "hw-address" property'>hw-address</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
84
"<a class="link" href="NMDeviceEthernet.html#NMDeviceEthernet--perm-hw-address" title='The "perm-hw-address" property'>perm-hw-address</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
85
"<a class="link" href="NMDeviceEthernet.html#NMDeviceEthernet--speed" title='The "speed" property'>speed</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
88
<div class="refsect1">
89
<a name="NMDeviceEthernet.description"></a><h2>Description</h2>
93
<div class="refsect1">
94
<a name="NMDeviceEthernet.details"></a><h2>Details</h2>
95
<div class="refsect2">
96
<a name="NMDeviceEthernet-struct"></a><h3>NMDeviceEthernet</h3>
97
<pre class="programlisting">typedef struct _NMDeviceEthernet NMDeviceEthernet;</pre>
102
<div class="refsect2">
103
<a name="NMDeviceEthernetClass"></a><h3>NMDeviceEthernetClass</h3>
104
<pre class="programlisting">typedef struct {
105
NMDeviceClass parent;
107
/* Padding for future expansion */
108
void (*_reserved1) (void);
109
void (*_reserved2) (void);
110
void (*_reserved3) (void);
111
void (*_reserved4) (void);
112
void (*_reserved5) (void);
113
void (*_reserved6) (void);
114
} NMDeviceEthernetClass;
120
<div class="refsect2">
121
<a name="NMDeviceEthernetError"></a><h3>enum NMDeviceEthernetError</h3>
122
<pre class="programlisting">typedef enum {
123
NM_DEVICE_ETHERNET_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/
124
NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION, /*< nick=NotEthernetConnection >*/
125
NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION, /*< nick=InvalidEthernetConnection >*/
126
NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC, /*< nick=InvalidDeviceMac >*/
127
NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH, /*< nick=MacMismatch >*/
128
} NMDeviceEthernetError;
130
<div class="variablelist"><table border="0">
131
<col align="left" valign="top">
134
<td><p><a name="NM-DEVICE-ETHERNET-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_ETHERNET_ERROR_UNKNOWN</code></span></p></td>
135
<td>unknown or unclassified error
139
<td><p><a name="NM-DEVICE-ETHERNET-ERROR-NOT-ETHERNET-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION</code></span></p></td>
140
<td>the connection was not of ethernet or PPPoE type
144
<td><p><a name="NM-DEVICE-ETHERNET-ERROR-INVALID-ETHERNET-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION</code></span></p></td>
145
<td>the ethernet connection was invalid
149
<td><p><a name="NM-DEVICE-ETHERNET-ERROR-INVALID-DEVICE-MAC:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC</code></span></p></td>
150
<td>the device's MAC was invalid
154
<td><p><a name="NM-DEVICE-ETHERNET-ERROR-MAC-MISMATCH:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH</code></span></p></td>
155
<td>the MACs of the connection and the device mismatched
162
<div class="refsect2">
163
<a name="NM-DEVICE-ETHERNET-CARRIER:CAPS"></a><h3>NM_DEVICE_ETHERNET_CARRIER</h3>
164
<pre class="programlisting">#define NM_DEVICE_ETHERNET_CARRIER "carrier"
170
<div class="refsect2">
171
<a name="NM-DEVICE-ETHERNET-ERROR:CAPS"></a><h3>NM_DEVICE_ETHERNET_ERROR</h3>
172
<pre class="programlisting">#define NM_DEVICE_ETHERNET_ERROR nm_device_ethernet_error_quark ()
178
<div class="refsect2">
179
<a name="NM-DEVICE-ETHERNET-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_ETHERNET_HW_ADDRESS</h3>
180
<pre class="programlisting">#define NM_DEVICE_ETHERNET_HW_ADDRESS "hw-address"
186
<div class="refsect2">
187
<a name="NM-DEVICE-ETHERNET-PERMANENT-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS</h3>
188
<pre class="programlisting">#define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
194
<div class="refsect2">
195
<a name="NM-DEVICE-ETHERNET-SPEED:CAPS"></a><h3>NM_DEVICE_ETHERNET_SPEED</h3>
196
<pre class="programlisting">#define NM_DEVICE_ETHERNET_SPEED "speed"
202
<div class="refsect2">
203
<a name="nm-device-ethernet-error-quark"></a><h3>nm_device_ethernet_error_quark ()</h3>
204
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_device_ethernet_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
206
Registers an error quark for <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> if necessary.
208
<div class="variablelist"><table border="0">
209
<col align="left" valign="top">
211
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
212
<td>the error quark used for <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> errors.</td>
217
<div class="refsect2">
218
<a name="nm-device-ethernet-get-carrier"></a><h3>nm_device_ethernet_get_carrier ()</h3>
219
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_device_ethernet_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);</pre>
221
Whether the device has carrier.
223
<div class="variablelist"><table border="0">
224
<col align="left" valign="top">
227
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
228
<td>a <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>
232
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the device has carrier</td>
240
<div class="refsect2">
241
<a name="nm-device-ethernet-get-hw-address"></a><h3>nm_device_ethernet_get_hw_address ()</h3>
242
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_ethernet_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);</pre>
244
Gets the active hardware (MAC) address of the <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>
246
<div class="variablelist"><table border="0">
247
<col align="left" valign="top">
250
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
251
<td>a <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>
255
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
256
<td>the active hardware address. This is the internal string used by the
257
device, and must not be modified.</td>
263
<div class="refsect2">
264
<a name="nm-device-ethernet-get-permanent-hw-address"></a><h3>nm_device_ethernet_get_permanent_hw_address ()</h3>
265
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_ethernet_get_permanent_hw_address
266
(<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);</pre>
268
Gets the permanent hardware (MAC) address of the <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>
270
<div class="variablelist"><table border="0">
271
<col align="left" valign="top">
274
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
275
<td>a <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>
279
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
280
<td>the permanent hardware address. This is the internal string used by the
281
device, and must not be modified.</td>
287
<div class="refsect2">
288
<a name="nm-device-ethernet-get-speed"></a><h3>nm_device_ethernet_get_speed ()</h3>
289
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_device_ethernet_get_speed (<em class="parameter"><code><a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a> *device</code></em>);</pre>
291
Gets the speed of the <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>.
293
<div class="variablelist"><table border="0">
294
<col align="left" valign="top">
297
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
298
<td>a <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>
302
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
303
<td>the speed of the device</td>
309
<div class="refsect2">
310
<a name="nm-device-ethernet-new"></a><h3>nm_device_ethernet_new ()</h3>
311
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_device_ethernet_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>,
312
<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
314
Creates a new <a class="link" href="NMDeviceEthernet.html" title="NMDeviceEthernet"><span class="type">NMDeviceEthernet</span></a>.
316
<div class="variablelist"><table border="0">
317
<col align="left" valign="top">
320
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
321
<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a>
325
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
326
<td>the DBus object path of the device</td>
329
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
330
<td>a new device. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
337
<div class="refsect1">
338
<a name="NMDeviceEthernet.property-details"></a><h2>Property Details</h2>
339
<div class="refsect2">
340
<a name="NMDeviceEthernet--carrier"></a><h3>The <code class="literal">"carrier"</code> property</h3>
341
<pre class="programlisting"> "carrier" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
343
Whether the device has carrier.
345
<p>Default value: FALSE</p>
348
<div class="refsect2">
349
<a name="NMDeviceEthernet--hw-address"></a><h3>The <code class="literal">"hw-address"</code> property</h3>
350
<pre class="programlisting"> "hw-address" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
352
The active hardware (MAC) address of the device.
354
<p>Default value: NULL</p>
357
<div class="refsect2">
358
<a name="NMDeviceEthernet--perm-hw-address"></a><h3>The <code class="literal">"perm-hw-address"</code> property</h3>
359
<pre class="programlisting"> "perm-hw-address" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
361
The permanent hardware (MAC) address of the device.
363
<p>Default value: NULL</p>
366
<div class="refsect2">
367
<a name="NMDeviceEthernet--speed"></a><h3>The <code class="literal">"speed"</code> property</h3>
368
<pre class="programlisting"> "speed" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre>
370
The speed of the device.
372
<p>Default value: 0</p>
378
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'