Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GVirNetwork: Libvirt-gobject Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Libvirt-gobject Reference Manual">
<link rel="up" href="ch01.html" title="Libvirt-gobject">
<link rel="prev" href="GVirNetworkFilter.html" title="GVirNetworkFilter">
<link rel="next" href="GVirNodeDevice.html" title="GVirNodeDevice">
<meta name="generator" content="GTK-Doc V1.29 (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="#GVirNetwork.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GVirNetwork.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GVirNetwork.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GVirNetworkFilter.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GVirNodeDevice.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GVirNetwork"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GVirNetwork.top_of_page"></a>GVirNetwork</span></h2>
<p>GVirNetwork</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GVirNetwork.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GVirNetwork.html#gvir-network-get-name" title="gvir_network_get_name ()">gvir_network_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GVirNetwork.html#gvir-network-get-uuid" title="gvir_network_get_uuid ()">gvir_network_get_uuid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/Libvirt-gconfig/GVirConfigNetwork.html#GVirConfigNetwork-struct"><span class="returnvalue">GVirConfigNetwork</span></a> *
</td>
<td class="function_name">
<a class="link" href="GVirNetwork.html#gvir-network-get-config" title="gvir_network_get_config ()">gvir_network_get_config</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GVirNetwork.html#gvir-network-get-dhcp-leases" title="gvir_network_get_dhcp_leases ()">gvir_network_get_dhcp_leases</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GVirNetwork.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">GVirNetworkHandle</span> *</td>
<td class="property_name"><a class="link" href="GVirNetwork.html#GVirNetwork--handle" title="The “handle” property">handle</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GVirNetwork.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GVirNetwork
</pre>
</div>
<div class="refsect1">
<a name="GVirNetwork.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GVirNetwork.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gvir-network-get-name"></a><h3>gvir_network_get_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gvir_network_get_name (<em class="parameter"><code><a class="link" href="GVirNetwork.html" title="GVirNetwork"><span class="type">GVirNetwork</span></a> *network</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gvir-network-get-uuid"></a><h3>gvir_network_get_uuid ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gvir_network_get_uuid (<em class="parameter"><code><a class="link" href="GVirNetwork.html" title="GVirNetwork"><span class="type">GVirNetwork</span></a> *network</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gvir-network-get-config"></a><h3>gvir_network_get_config ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/Libvirt-gconfig/GVirConfigNetwork.html#GVirConfigNetwork-struct"><span class="returnvalue">GVirConfigNetwork</span></a> *
gvir_network_get_config (<em class="parameter"><code><a class="link" href="GVirNetwork.html" title="GVirNetwork"><span class="type">GVirNetwork</span></a> *network</code></em>,
                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>,
                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<div class="refsect3">
<a name="gvir-network-get-config.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>network</p></td>
<td class="parameter_description"><p>the network</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>the flags</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>Place-holder for possible errors</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gvir-network-get-config.returns"></a><h4>Returns</h4>
<p>the config. The returned object should be
unreffed with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gvir-network-get-dhcp-leases"></a><h3>gvir_network_get_dhcp_leases ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
gvir_network_get_dhcp_leases (<em class="parameter"><code><a class="link" href="GVirNetwork.html" title="GVirNetwork"><span class="type">GVirNetwork</span></a> *network</code></em>,
                              <em class="parameter"><code>const <span class="type">char</span> *mac</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>This function fetches leases info of guests in the specified network. If the
optional parameter <em class="parameter"><code>mac</code></em>
 is specified, the returned list will contain only
lease info about a specific guest interface with <em class="parameter"><code>mac</code></em>
. There can be multiple
leases for a single <em class="parameter"><code>mac</code></em>
 because this API supports DHCPv6 too.</p>
<div class="refsect3">
<a name="gvir-network-get-dhcp-leases.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>network</p></td>
<td class="parameter_description"><p>the network</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mac</p></td>
<td class="parameter_description"><p>The optional ASCII formatted MAC address of an interface. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>placeholder for flags, must be 0</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>Place-holder for possible errors</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gvir-network-get-dhcp-leases.returns"></a><h4>Returns</h4>
<p>the
list of network leases. Each object in the returned list should be unreffed
with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> and the list itself using g_list_free, when no longer
needed. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> LibvirtGObject.NetworkDHCPLease][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GVirNetwork.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="GVirNetwork.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GVirNetwork--handle"></a><h3>The <code class="literal">“handle”</code> property</h3>
<pre class="programlisting">  “handle”                   <span class="type">GVirNetworkHandle</span> *</pre>
<p>The network handle.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>