| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>OobsIfacePlip</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| 7 |
<link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual"> |
| 8 |
<link rel="up" href="ch06.html" title="Network interfaces management"> |
| 9 |
<link rel="prev" href="OobsIfaceIRLan.html" title="OobsIfaceIRLan"> |
| 10 |
<link rel="next" href="OobsIfacePPP.html" title="OobsIfacePPP"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 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"> |
| 16 |
<tr valign="middle"> |
| 17 |
<td><a accesskey="p" href="OobsIfaceIRLan.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| 18 |
<td><a accesskey="u" href="ch06.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">Liboobs (System configuration management) Reference Manual</th> |
| 21 |
<td><a accesskey="n" href="OobsIfacePPP.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| 22 |
</tr> |
| 23 |
<tr><td colspan="5" class="shortcuts"> |
| 24 |
<a href="#OobsIfacePlip.synopsis" class="shortcut">Top</a> |
| 25 |
| |
| 26 |
<a href="#OobsIfacePlip.description" class="shortcut">Description</a> |
| 27 |
| |
| 28 |
<a href="#OobsIfacePlip.object-hierarchy" class="shortcut">Object Hierarchy</a> |
| 29 |
| |
| 30 |
<a href="#OobsIfacePlip.properties" class="shortcut">Properties</a> |
| 31 |
</td></tr> |
| 32 |
</table> |
| 33 |
<div class="refentry" title="OobsIfacePlip"> |
| 34 |
<a name="OobsIfacePlip"></a><div class="titlepage"></div> |
| 35 |
<div class="refnamediv"><table width="100%"><tr> |
| 36 |
<td valign="top"> |
| 37 |
<h2><span class="refentrytitle"><a name="OobsIfacePlip.top_of_page"></a>OobsIfacePlip</span></h2> |
| 38 |
<p>OobsIfacePlip — Object that represents an individual Plip interface</p> |
| 39 |
</td> |
| 40 |
<td valign="top" align="right"></td> |
| 41 |
</tr></table></div> |
| 42 |
<div class="refsynopsisdiv" title="Synopsis"> |
| 43 |
<a name="OobsIfacePlip.synopsis"></a><h2>Synopsis</h2> |
| 44 |
<pre class="synopsis"> <a class="link" href="OobsIfacePlip.html#OobsIfacePlip-struct" title="OobsIfacePlip">OobsIfacePlip</a>; |
| 45 |
<a class="link" href="OobsIfacePlip.html#OobsIfacePlipClass" title="OobsIfacePlipClass">OobsIfacePlipClass</a>; |
| 46 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsIfacePlip.html#oobs-iface-plip-get-address" title="oobs_iface_plip_get_address ()">oobs_iface_plip_get_address</a> (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>); |
| 47 |
<span class="returnvalue">void</span> <a class="link" href="OobsIfacePlip.html#oobs-iface-plip-set-address" title="oobs_iface_plip_set_address ()">oobs_iface_plip_set_address</a> (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>, |
| 48 |
<em class="parameter"><code>const <span class="type">gchar</span> *address</code></em>); |
| 49 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsIfacePlip.html#oobs-iface-plip-get-remote-address" title="oobs_iface_plip_get_remote_address ()">oobs_iface_plip_get_remote_address</a> (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>); |
| 50 |
<span class="returnvalue">void</span> <a class="link" href="OobsIfacePlip.html#oobs-iface-plip-set-remote-address" title="oobs_iface_plip_set_remote_address ()">oobs_iface_plip_set_remote_address</a> (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>, |
| 51 |
<em class="parameter"><code>const <span class="type">gchar</span> *address</code></em>); |
| 52 |
</pre> |
| 53 |
</div> |
| 54 |
<div class="refsect1" title="Object Hierarchy"> |
| 55 |
<a name="OobsIfacePlip.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 56 |
<pre class="synopsis"> |
| 57 |
GObject |
| 58 |
+----<a class="link" href="liboobs-Oobs.html#OobsIface">OobsIface</a> |
| 59 |
+----OobsIfacePlip |
| 60 |
</pre> |
| 61 |
</div> |
| 62 |
<div class="refsect1" title="Properties"> |
| 63 |
<a name="OobsIfacePlip.properties"></a><h2>Properties</h2> |
| 64 |
<pre class="synopsis"> |
| 65 |
"<a class="link" href="OobsIfacePlip.html#OobsIfacePlip--address" title='The "address" property'>address</a>" <span class="type">gchar</span>* : Read / Write |
| 66 |
"<a class="link" href="OobsIfacePlip.html#OobsIfacePlip--remote-address" title='The "remote-address" property'>remote-address</a>" <span class="type">gchar</span>* : Read / Write |
| 67 |
</pre> |
| 68 |
</div> |
| 69 |
<div class="refsect1" title="Description"> |
| 70 |
<a name="OobsIfacePlip.description"></a><h2>Description</h2> |
| 71 |
</div> |
| 72 |
<div class="refsect1" title="Details"> |
| 73 |
<a name="OobsIfacePlip.details"></a><h2>Details</h2> |
| 74 |
<div class="refsect2" title="OobsIfacePlip"> |
| 75 |
<a name="OobsIfacePlip-struct"></a><h3>OobsIfacePlip</h3> |
| 76 |
<pre class="programlisting">typedef struct _OobsIfacePlip OobsIfacePlip;</pre> |
| 77 |
<p> |
| 78 |
</p> |
| 79 |
</div> |
| 80 |
<hr> |
| 81 |
<div class="refsect2" title="OobsIfacePlipClass"> |
| 82 |
<a name="OobsIfacePlipClass"></a><h3>OobsIfacePlipClass</h3> |
| 83 |
<pre class="programlisting">typedef struct { |
| 84 |
OobsIfaceClass parent_class; |
| 85 |
|
| 86 |
void (*_oobs_padding1) (void); |
| 87 |
void (*_oobs_padding2) (void); |
| 88 |
} OobsIfacePlipClass; |
| 89 |
</pre> |
| 90 |
<p> |
| 91 |
</p> |
| 92 |
</div> |
| 93 |
<hr> |
| 94 |
<div class="refsect2" title="oobs_iface_plip_get_address ()"> |
| 95 |
<a name="oobs-iface-plip-get-address"></a><h3>oobs_iface_plip_get_address ()</h3> |
| 96 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_iface_plip_get_address (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>);</pre> |
| 97 |
<p> |
| 98 |
Returns the local IP address for the interface. |
| 99 |
</p> |
| 100 |
<div class="variablelist"><table border="0"> |
| 101 |
<col align="left" valign="top"> |
| 102 |
<tbody> |
| 103 |
<tr> |
| 104 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 105 |
<td>An <a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a>. |
| 106 |
</td> |
| 107 |
</tr> |
| 108 |
<tr> |
| 109 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 110 |
<td> A pointer to the local IP address as a string. This |
| 111 |
string must not be freed, modified or stored. |
| 112 |
</td> |
| 113 |
</tr> |
| 114 |
</tbody> |
| 115 |
</table></div> |
| 116 |
</div> |
| 117 |
<hr> |
| 118 |
<div class="refsect2" title="oobs_iface_plip_set_address ()"> |
| 119 |
<a name="oobs-iface-plip-set-address"></a><h3>oobs_iface_plip_set_address ()</h3> |
| 120 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_plip_set_address (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>, |
| 121 |
<em class="parameter"><code>const <span class="type">gchar</span> *address</code></em>);</pre> |
| 122 |
<p> |
| 123 |
Sets a new local IP address for the interface, |
| 124 |
overwriting the previous one. |
| 125 |
</p> |
| 126 |
<div class="variablelist"><table border="0"> |
| 127 |
<col align="left" valign="top"> |
| 128 |
<tbody> |
| 129 |
<tr> |
| 130 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 131 |
<td>An <a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a>. |
| 132 |
</td> |
| 133 |
</tr> |
| 134 |
<tr> |
| 135 |
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td> |
| 136 |
<td>a new local IP address for the interface. |
| 137 |
</td> |
| 138 |
</tr> |
| 139 |
</tbody> |
| 140 |
</table></div> |
| 141 |
</div> |
| 142 |
<hr> |
| 143 |
<div class="refsect2" title="oobs_iface_plip_get_remote_address ()"> |
| 144 |
<a name="oobs-iface-plip-get-remote-address"></a><h3>oobs_iface_plip_get_remote_address ()</h3> |
| 145 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_iface_plip_get_remote_address (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>);</pre> |
| 146 |
<p> |
| 147 |
Returns the remote IP address for the interface. |
| 148 |
</p> |
| 149 |
<div class="variablelist"><table border="0"> |
| 150 |
<col align="left" valign="top"> |
| 151 |
<tbody> |
| 152 |
<tr> |
| 153 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 154 |
<td>An <a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a>. |
| 155 |
</td> |
| 156 |
</tr> |
| 157 |
<tr> |
| 158 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 159 |
<td> A pointer to the remote IP address as a string. This |
| 160 |
string must not be freed, modified or stored. |
| 161 |
</td> |
| 162 |
</tr> |
| 163 |
</tbody> |
| 164 |
</table></div> |
| 165 |
</div> |
| 166 |
<hr> |
| 167 |
<div class="refsect2" title="oobs_iface_plip_set_remote_address ()"> |
| 168 |
<a name="oobs-iface-plip-set-remote-address"></a><h3>oobs_iface_plip_set_remote_address ()</h3> |
| 169 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_plip_set_remote_address (<em class="parameter"><code><a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a> *iface</code></em>, |
| 170 |
<em class="parameter"><code>const <span class="type">gchar</span> *address</code></em>);</pre> |
| 171 |
<p> |
| 172 |
Sets a new remote IP address for the interface, |
| 173 |
overwriting the previous one. |
| 174 |
</p> |
| 175 |
<div class="variablelist"><table border="0"> |
| 176 |
<col align="left" valign="top"> |
| 177 |
<tbody> |
| 178 |
<tr> |
| 179 |
<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> |
| 180 |
<td>An <a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a>. |
| 181 |
</td> |
| 182 |
</tr> |
| 183 |
<tr> |
| 184 |
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td> |
| 185 |
<td>a new remote IP address for the interface. |
| 186 |
</td> |
| 187 |
</tr> |
| 188 |
</tbody> |
| 189 |
</table></div> |
| 190 |
</div> |
| 191 |
</div> |
| 192 |
<div class="refsect1" title="Property Details"> |
| 193 |
<a name="OobsIfacePlip.property-details"></a><h2>Property Details</h2> |
| 194 |
<div class="refsect2" title='The "address" property'> |
| 195 |
<a name="OobsIfacePlip--address"></a><h3>The <code class="literal">"address"</code> property</h3> |
| 196 |
<pre class="programlisting"> "address" <span class="type">gchar</span>* : Read / Write</pre> |
| 197 |
<p>Address for the iface.</p> |
| 198 |
<p>Default value: NULL</p> |
| 199 |
</div> |
| 200 |
<hr> |
| 201 |
<div class="refsect2" title='The "remote-address" property'> |
| 202 |
<a name="OobsIfacePlip--remote-address"></a><h3>The <code class="literal">"remote-address"</code> property</h3> |
| 203 |
<pre class="programlisting"> "remote-address" <span class="type">gchar</span>* : Read / Write</pre> |
| 204 |
<p>Remote address for the iface.</p> |
| 205 |
<p>Default value: NULL</p> |
| 206 |
</div> |
| 207 |
</div> |
| 208 |
<div class="refsect1" title="See Also"> |
| 209 |
<a name="OobsIfacePlip.see-also"></a><h2>See Also</h2> |
| 210 |
<a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>, <a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a>, <a class="link" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet"><span class="type">OobsIfaceEthernet</span></a>, |
| 211 |
<a class="link" href="OobsIfaceIRLan.html" title="OobsIfaceIRLan"><span class="type">OobsIfaceIRLan</span></a>, <a class="link" href="OobsIfacePPP.html" title="OobsIfacePPP"><span class="type">OobsIfacePPP</span></a>, <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a> |
| 212 |
</div> |
| 213 |
</div> |
| 214 |
<div class="footer"> |
| 215 |
<hr> |
| 216 |
Generated by GTK-Doc V1.15</div> |
| 217 |
</body> |
| 218 |
</html> |