docs/reference/gio/html/gio-GInetAddressMask.html

   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>GInetAddressMask</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="networking.html" title="Low-level network support">
   9 <link rel="prev" href="GInetAddress.html" title="GInetAddress">
  10 <link rel="next" href="GSocketAddress.html" title="GSocketAddress">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="GInetAddress.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="networking.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">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GSocketAddress.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="#gio-GInetAddressMask.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gio-GInetAddressMask.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gio-GInetAddressMask"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gio-GInetAddressMask.top_of_page"></a>GInetAddressMask</span></h2>
  34 <p>GInetAddressMask — An IPv4/IPv6 address mask</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gio-GInetAddressMask.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">                    <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask">GInetAddressMask</a>;
  41 <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="returnvalue">GInetAddressMask</span></a> *  <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-new" title="g_inet_address_mask_new ()">g_inet_address_mask_new</a>             (<em class="parameter"><code><a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a> *addr</code></em>,
  42                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> length</code></em>,
  43                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  44 <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="returnvalue">GInetAddressMask</span></a> *  <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-new-from-string" title="g_inet_address_mask_new_from_string ()">g_inet_address_mask_new_from_string</a> (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mask_string</code></em>,
  45                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  46 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-to-string" title="g_inet_address_mask_to_string ()">g_inet_address_mask_to_string</a>       (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);
  47 <a class="link" href="GSocketAddress.html#GSocketFamily" title="enum GSocketFamily"><span class="returnvalue">GSocketFamily</span></a>       <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-get-family" title="g_inet_address_mask_get_family ()">g_inet_address_mask_get_family</a>      (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);
  48 <a class="link" href="GInetAddress.html" title="GInetAddress"><span class="returnvalue">GInetAddress</span></a> *      <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-get-address" title="g_inet_address_mask_get_address ()">g_inet_address_mask_get_address</a>     (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);
  49 <a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-get-length" title="g_inet_address_mask_get_length ()">g_inet_address_mask_get_length</a>      (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);
  50 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-matches" title="g_inet_address_mask_matches ()">g_inet_address_mask_matches</a>         (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>,
  51                                                          <em class="parameter"><code><a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a> *address</code></em>);
  52 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-GInetAddressMask.html#g-inet-address-mask-equal" title="g_inet_address_mask_equal ()">g_inet_address_mask_equal</a>           (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>,
  53                                                          <em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask2</code></em>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gio-GInetAddressMask.description"></a><h2>Description</h2>
  58 <p>
  59 <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> represents a range of IPv4 or IPv6 addresses
  60 described by a base address and a length indicating how many bits
  61 of the base address are relevant for matching purposes. These are
  62 often given in string form. Eg, "10.0.0.0/8", or "fe80::/10".
  63 </p>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gio-GInetAddressMask.details"></a><h2>Details</h2>
  67 <div class="refsect2">
  68 <a name="GInetAddressMask"></a><h3>GInetAddressMask</h3>
  69 <pre class="programlisting">typedef struct {
  70   GObject parent_instance;
  71 } GInetAddressMask;
  72 </pre>
  73 <p>
  74 A combination of an IPv4 or IPv6 base address and a length,
  75 representing a range of IP addresses.
  76 </p>
  77 <p class="since">Since 2.32</p>
  78 </div>
  79 <hr>
  80 <div class="refsect2">
  81 <a name="g-inet-address-mask-new"></a><h3>g_inet_address_mask_new ()</h3>
  82 <pre class="programlisting"><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="returnvalue">GInetAddressMask</span></a> *  g_inet_address_mask_new             (<em class="parameter"><code><a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a> *addr</code></em>,
  83                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> length</code></em>,
  84                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  85 <p>
  86 Creates a new <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> representing all addresses whose
  87 first <em class="parameter"><code>length</code></em> bits match <em class="parameter"><code>addr</code></em>.
  88 </p>
  89 <div class="variablelist"><table border="0">
  90 <col align="left" valign="top">
  91 <tbody>
  92 <tr>
  93 <td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
  94 <td>a <a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a>
  95 </td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
  99 <td>number of bits of <em class="parameter"><code>addr</code></em> to use</td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 103 <td>return location for <a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 104 </td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 108 <td>a new <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error</td>
 109 </tr>
 110 </tbody>
 111 </table></div>
 112 <p class="since">Since 2.32</p>
 113 </div>
 114 <hr>
 115 <div class="refsect2">
 116 <a name="g-inet-address-mask-new-from-string"></a><h3>g_inet_address_mask_new_from_string ()</h3>
 117 <pre class="programlisting"><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="returnvalue">GInetAddressMask</span></a> *  g_inet_address_mask_new_from_string (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mask_string</code></em>,
 118                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 119 <p>
 120 Parses <em class="parameter"><code>mask_string</code></em> as an IP address and (optional) length, and
 121 creates a new <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>. The length, if present, is
 122 delimited by a "/". If it is not present, then the length is
 123 assumed to be the full length of the address.
 124 </p>
 125 <div class="variablelist"><table border="0">
 126 <col align="left" valign="top">
 127 <tbody>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>mask_string</code></em> :</span></p></td>
 130 <td>an IP address or address/length string</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 134 <td>return location for <a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 135 </td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 139 <td>a new <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> corresponding to <em class="parameter"><code>string</code></em>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 140 on error.</td>
 141 </tr>
 142 </tbody>
 143 </table></div>
 144 <p class="since">Since 2.32</p>
 145 </div>
 146 <hr>
 147 <div class="refsect2">
 148 <a name="g-inet-address-mask-to-string"></a><h3>g_inet_address_mask_to_string ()</h3>
 149 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             g_inet_address_mask_to_string       (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);</pre>
 150 <p>
 151 Converts <em class="parameter"><code>mask</code></em> back to its corresponding string form.
 152 </p>
 153 <div class="variablelist"><table border="0">
 154 <col align="left" valign="top">
 155 <tbody>
 156 <tr>
 157 <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
 158 <td>a <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>
 159 </td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 163 <td>a string corresponding to <em class="parameter"><code>mask</code></em>.</td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 <p class="since">Since 2.32</p>
 168 </div>
 169 <hr>
 170 <div class="refsect2">
 171 <a name="g-inet-address-mask-get-family"></a><h3>g_inet_address_mask_get_family ()</h3>
 172 <pre class="programlisting"><a class="link" href="GSocketAddress.html#GSocketFamily" title="enum GSocketFamily"><span class="returnvalue">GSocketFamily</span></a>       g_inet_address_mask_get_family      (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);</pre>
 173 <p>
 174 Gets the <a class="link" href="GSocketAddress.html#GSocketFamily" title="enum GSocketFamily"><span class="type">GSocketFamily</span></a> of <em class="parameter"><code>mask</code></em>'s address
 175 </p>
 176 <div class="variablelist"><table border="0">
 177 <col align="left" valign="top">
 178 <tbody>
 179 <tr>
 180 <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
 181 <td>a <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>
 182 </td>
 183 </tr>
 184 <tr>
 185 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 186 <td>the <a class="link" href="GSocketAddress.html#GSocketFamily" title="enum GSocketFamily"><span class="type">GSocketFamily</span></a> of <em class="parameter"><code>mask</code></em>'s address</td>
 187 </tr>
 188 </tbody>
 189 </table></div>
 190 <p class="since">Since 2.32</p>
 191 </div>
 192 <hr>
 193 <div class="refsect2">
 194 <a name="g-inet-address-mask-get-address"></a><h3>g_inet_address_mask_get_address ()</h3>
 195 <pre class="programlisting"><a class="link" href="GInetAddress.html" title="GInetAddress"><span class="returnvalue">GInetAddress</span></a> *      g_inet_address_mask_get_address     (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);</pre>
 196 <p>
 197 Gets <em class="parameter"><code>mask</code></em>'s base address
 198 </p>
 199 <div class="variablelist"><table border="0">
 200 <col align="left" valign="top">
 201 <tbody>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
 204 <td>a <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>
 205 </td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 209 <td>
 210 <em class="parameter"><code>mask</code></em>'s base address. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 211 </td>
 212 </tr>
 213 </tbody>
 214 </table></div>
 215 <p class="since">Since 2.32</p>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="g-inet-address-mask-get-length"></a><h3>g_inet_address_mask_get_length ()</h3>
 220 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               g_inet_address_mask_get_length      (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>);</pre>
 221 <p>
 222 Gets <em class="parameter"><code>mask</code></em>'s length
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
 229 <td>a <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>
 230 </td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 234 <td>
 235 <em class="parameter"><code>mask</code></em>'s length</td>
 236 </tr>
 237 </tbody>
 238 </table></div>
 239 <p class="since">Since 2.32</p>
 240 </div>
 241 <hr>
 242 <div class="refsect2">
 243 <a name="g-inet-address-mask-matches"></a><h3>g_inet_address_mask_matches ()</h3>
 244 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_inet_address_mask_matches         (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>,
 245                                                          <em class="parameter"><code><a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a> *address</code></em>);</pre>
 246 <p>
 247 Tests if <em class="parameter"><code>address</code></em> falls within the range described by <em class="parameter"><code>mask</code></em>.
 248 </p>
 249 <div class="variablelist"><table border="0">
 250 <col align="left" valign="top">
 251 <tbody>
 252 <tr>
 253 <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
 254 <td>a <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>
 255 </td>
 256 </tr>
 257 <tr>
 258 <td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td>
 259 <td>a <a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a>
 260 </td>
 261 </tr>
 262 <tr>
 263 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 264 <td>whether <em class="parameter"><code>address</code></em> falls within the range described by
 265 <em class="parameter"><code>mask</code></em>.</td>
 266 </tr>
 267 </tbody>
 268 </table></div>
 269 <p class="since">Since 2.32</p>
 270 </div>
 271 <hr>
 272 <div class="refsect2">
 273 <a name="g-inet-address-mask-equal"></a><h3>g_inet_address_mask_equal ()</h3>
 274 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_inet_address_mask_equal           (<em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask</code></em>,
 275                                                          <em class="parameter"><code><a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a> *mask2</code></em>);</pre>
 276 <p>
 277 Tests if <em class="parameter"><code>mask</code></em> and <em class="parameter"><code>mask2</code></em> are the same mask.
 278 </p>
 279 <div class="variablelist"><table border="0">
 280 <col align="left" valign="top">
 281 <tbody>
 282 <tr>
 283 <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
 284 <td>a <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>
 285 </td>
 286 </tr>
 287 <tr>
 288 <td><p><span class="term"><em class="parameter"><code>mask2</code></em> :</span></p></td>
 289 <td>another <a class="link" href="gio-GInetAddressMask.html#GInetAddressMask" title="GInetAddressMask"><span class="type">GInetAddressMask</span></a>
 290 </td>
 291 </tr>
 292 <tr>
 293 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 294 <td>whether <em class="parameter"><code>mask</code></em> and <em class="parameter"><code>mask2</code></em> are the same mask</td>
 295 </tr>
 296 </tbody>
 297 </table></div>
 298 <p class="since">Since 2.32</p>
 299 </div>
 300 </div>
 301 </div>
 302 <div class="footer">
 303 <hr>
 304           Generated by GTK-Doc V1.18</div>
 305 </body>
 306 </html>