← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/ginetaddress.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-09 11:28:22 UTC
  • mfrom: (3.4.8 experimental)
  • Revision ID: james.westby@ubuntu.com-20100309112822-j4n0v3xbtsup8s97
Tags: 2.23.5-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler
* debian/rules:
  - don't break build on test suite errors, debian recently activated this but
    the build breaks even when there is no error in the testsuite

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/ginetaddress.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 
5
<!ENTITY version SYSTEM "version.xml">
 
6
]>
 
7
<refentry id="GInetAddress">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="GInetAddress.top_of_page">GInetAddress</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>GIO Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>GInetAddress</refname>
 
16
<refpurpose>An IPv4/IPv6 address</refpurpose>
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv id="GInetAddress.synopsis" role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
 
21
 
 
22
<synopsis>
 
23
                    <link linkend="GInetAddress-struct">GInetAddress</link>;
 
24
<link linkend="GInetAddress">GInetAddress</link> *      <link linkend="g-inet-address-new-from-string">g_inet_address_new_from_string</link>      (const <link linkend="gchar">gchar</link> *string);
 
25
<link linkend="GInetAddress">GInetAddress</link> *      <link linkend="g-inet-address-new-from-bytes">g_inet_address_new_from_bytes</link>       (const <link linkend="guint8">guint8</link> *bytes,
 
26
                                                         <link linkend="GSocketFamily">GSocketFamily</link> family);
 
27
<link linkend="GInetAddress">GInetAddress</link> *      <link linkend="g-inet-address-new-any">g_inet_address_new_any</link>              (<link linkend="GSocketFamily">GSocketFamily</link> family);
 
28
<link linkend="GInetAddress">GInetAddress</link> *      <link linkend="g-inet-address-new-loopback">g_inet_address_new_loopback</link>         (<link linkend="GSocketFamily">GSocketFamily</link> family);
 
29
const <link linkend="guint8">guint8</link> *      <link linkend="g-inet-address-to-bytes">g_inet_address_to_bytes</link>             (<link linkend="GInetAddress">GInetAddress</link> *address);
 
30
<link linkend="gsize">gsize</link>               <link linkend="g-inet-address-get-native-size">g_inet_address_get_native_size</link>      (<link linkend="GInetAddress">GInetAddress</link> *address);
 
31
<link linkend="gchar">gchar</link> *             <link linkend="g-inet-address-to-string">g_inet_address_to_string</link>            (<link linkend="GInetAddress">GInetAddress</link> *address);
 
32
<link linkend="GSocketFamily">GSocketFamily</link>       <link linkend="g-inet-address-get-family">g_inet_address_get_family</link>           (<link linkend="GInetAddress">GInetAddress</link> *address);
 
33
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-any">g_inet_address_get_is_any</link>           (<link linkend="GInetAddress">GInetAddress</link> *address);
 
34
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-loopback">g_inet_address_get_is_loopback</link>      (<link linkend="GInetAddress">GInetAddress</link> *address);
 
35
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-link-local">g_inet_address_get_is_link_local</link>    (<link linkend="GInetAddress">GInetAddress</link> *address);
 
36
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-site-local">g_inet_address_get_is_site_local</link>    (<link linkend="GInetAddress">GInetAddress</link> *address);
 
37
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-multicast">g_inet_address_get_is_multicast</link>     (<link linkend="GInetAddress">GInetAddress</link> *address);
 
38
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-mc-link-local">g_inet_address_get_is_mc_link_local</link> (<link linkend="GInetAddress">GInetAddress</link> *address);
 
39
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-mc-node-local">g_inet_address_get_is_mc_node_local</link> (<link linkend="GInetAddress">GInetAddress</link> *address);
 
40
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-mc-site-local">g_inet_address_get_is_mc_site_local</link> (<link linkend="GInetAddress">GInetAddress</link> *address);
 
41
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-mc-org-local">g_inet_address_get_is_mc_org_local</link>  (<link linkend="GInetAddress">GInetAddress</link> *address);
 
42
<link linkend="gboolean">gboolean</link>            <link linkend="g-inet-address-get-is-mc-global">g_inet_address_get_is_mc_global</link>     (<link linkend="GInetAddress">GInetAddress</link> *address);
 
43
</synopsis>
 
44
</refsynopsisdiv>
 
45
 
 
46
<refsect1 id="GInetAddress.object-hierarchy" role="object_hierarchy">
 
47
<title role="object_hierarchy.title">Object Hierarchy</title>
 
48
<synopsis>
 
49
  <link linkend="GObject">GObject</link>
 
50
   +----GInetAddress
 
51
</synopsis>
 
52
</refsect1>
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
<refsect1 id="GInetAddress.properties" role="properties">
 
59
<title role="properties.title">Properties</title>
 
60
<synopsis>
 
61
  &quot;<link linkend="GInetAddress--bytes">bytes</link>&quot;                    <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
 
62
  &quot;<link linkend="GInetAddress--family">family</link>&quot;                   <link linkend="GSocketFamily">GSocketFamily</link>         : Read / Write / Construct Only
 
63
  &quot;<link linkend="GInetAddress--is-any">is-any</link>&quot;                   <link linkend="gboolean">gboolean</link>              : Read
 
64
  &quot;<link linkend="GInetAddress--is-link-local">is-link-local</link>&quot;            <link linkend="gboolean">gboolean</link>              : Read
 
65
  &quot;<link linkend="GInetAddress--is-loopback">is-loopback</link>&quot;              <link linkend="gboolean">gboolean</link>              : Read
 
66
  &quot;<link linkend="GInetAddress--is-mc-global">is-mc-global</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read
 
67
  &quot;<link linkend="GInetAddress--is-mc-link-local">is-mc-link-local</link>&quot;         <link linkend="gboolean">gboolean</link>              : Read
 
68
  &quot;<link linkend="GInetAddress--is-mc-node-local">is-mc-node-local</link>&quot;         <link linkend="gboolean">gboolean</link>              : Read
 
69
  &quot;<link linkend="GInetAddress--is-mc-org-local">is-mc-org-local</link>&quot;          <link linkend="gboolean">gboolean</link>              : Read
 
70
  &quot;<link linkend="GInetAddress--is-mc-site-local">is-mc-site-local</link>&quot;         <link linkend="gboolean">gboolean</link>              : Read
 
71
  &quot;<link linkend="GInetAddress--is-multicast">is-multicast</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read
 
72
  &quot;<link linkend="GInetAddress--is-site-local">is-site-local</link>&quot;            <link linkend="gboolean">gboolean</link>              : Read
 
73
</synopsis>
 
74
</refsect1>
 
75
 
 
76
 
 
77
 
 
78
<refsect1 id="GInetAddress.description" role="desc">
 
79
<title role="desc.title">Description</title>
 
80
<para>
 
81
<link linkend="GInetAddress"><type>GInetAddress</type></link> represents an IPv4 or IPv6 internet address. Use
 
82
<link linkend="g-resolver-lookup-by-name"><function>g_resolver_lookup_by_name()</function></link> or <link linkend="g-resolver-lookup-by-name-async"><function>g_resolver_lookup_by_name_async()</function></link> to
 
83
look up the <link linkend="GInetAddress"><type>GInetAddress</type></link> for a hostname. Use
 
84
<link linkend="g-resolver-lookup-by-address"><function>g_resolver_lookup_by_address()</function></link> or
 
85
<link linkend="g-resolver-lookup-by-address-async"><function>g_resolver_lookup_by_address_async()</function></link> to look up the hostname for a
 
86
<link linkend="GInetAddress"><type>GInetAddress</type></link>.
 
87
</para>
 
88
<para>
 
89
To actually connect to a remote host, you will need a
 
90
<link linkend="GInetSocketAddress"><type>GInetSocketAddress</type></link> (which includes a <link linkend="GInetAddress"><type>GInetAddress</type></link> as well as a
 
91
port number).</para>
 
92
<para>
 
93
</para>
 
94
</refsect1>
 
95
 
 
96
<refsect1 id="GInetAddress.details" role="details">
 
97
<title role="details.title">Details</title>
 
98
<refsect2 id="GInetAddress-struct" role="struct">
 
99
<title>GInetAddress</title>
 
100
<indexterm zone="GInetAddress-struct"><primary sortas="InetAddress">GInetAddress</primary></indexterm><programlisting>typedef struct _GInetAddress GInetAddress;</programlisting>
 
101
<para>
 
102
An IPv4 or IPv6 internet address.</para>
 
103
<para>
 
104
</para></refsect2>
 
105
<refsect2 id="g-inet-address-new-from-string" role="function" condition="since:2.22">
 
106
<title>g_inet_address_new_from_string ()</title>
 
107
<indexterm zone="g-inet-address-new-from-string" role="2.22"><primary sortas="inet_address_new_from_string">g_inet_address_new_from_string</primary></indexterm><programlisting><link linkend="GInetAddress">GInetAddress</link> *      g_inet_address_new_from_string      (const <link linkend="gchar">gchar</link> *string);</programlisting>
 
108
<para>
 
109
Parses <parameter>string</parameter> as an IP address and creates a new <link linkend="GInetAddress"><type>GInetAddress</type></link>.</para>
 
110
<para>
 
111
</para><variablelist role="params">
 
112
<varlistentry><term><parameter>string</parameter>&#160;:</term>
 
113
<listitem><simpara> a string representation of an IP address
 
114
</simpara></listitem></varlistentry>
 
115
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GInetAddress"><type>GInetAddress</type></link> corresponding to <parameter>string</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if
 
116
<parameter>string</parameter> could not be parsed.
 
117
 
 
118
</simpara></listitem></varlistentry>
 
119
</variablelist><para role="since">Since 2.22</para></refsect2>
 
120
<refsect2 id="g-inet-address-new-from-bytes" role="function" condition="since:2.22">
 
121
<title>g_inet_address_new_from_bytes ()</title>
 
122
<indexterm zone="g-inet-address-new-from-bytes" role="2.22"><primary sortas="inet_address_new_from_bytes">g_inet_address_new_from_bytes</primary></indexterm><programlisting><link linkend="GInetAddress">GInetAddress</link> *      g_inet_address_new_from_bytes       (const <link linkend="guint8">guint8</link> *bytes,
 
123
                                                         <link linkend="GSocketFamily">GSocketFamily</link> family);</programlisting>
 
124
<para>
 
125
Creates a new <link linkend="GInetAddress"><type>GInetAddress</type></link> from the given <parameter>family</parameter> and <parameter>bytes</parameter>.
 
126
<parameter>bytes</parameter> should be 4 bytes for <link linkend="G-INET-ADDRESS-IPV4--CAPS"><literal>G_INET_ADDRESS_IPV4</literal></link> and 16 bytes for
 
127
<link linkend="G-INET-ADDRESS-IPV6--CAPS"><literal>G_INET_ADDRESS_IPV6</literal></link>.</para>
 
128
<para>
 
129
</para><variablelist role="params">
 
130
<varlistentry><term><parameter>bytes</parameter>&#160;:</term>
 
131
<listitem><simpara> raw address data
 
132
</simpara></listitem></varlistentry>
 
133
<varlistentry><term><parameter>family</parameter>&#160;:</term>
 
134
<listitem><simpara> the address family of <parameter>bytes</parameter>
 
135
</simpara></listitem></varlistentry>
 
136
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GInetAddress"><type>GInetAddress</type></link> corresponding to <parameter>family</parameter> and <parameter>bytes</parameter>.
 
137
 
 
138
</simpara></listitem></varlistentry>
 
139
</variablelist><para role="since">Since 2.22</para></refsect2>
 
140
<refsect2 id="g-inet-address-new-any" role="function" condition="since:2.22">
 
141
<title>g_inet_address_new_any ()</title>
 
142
<indexterm zone="g-inet-address-new-any" role="2.22"><primary sortas="inet_address_new_any">g_inet_address_new_any</primary></indexterm><programlisting><link linkend="GInetAddress">GInetAddress</link> *      g_inet_address_new_any              (<link linkend="GSocketFamily">GSocketFamily</link> family);</programlisting>
 
143
<para>
 
144
Creates a <link linkend="GInetAddress"><type>GInetAddress</type></link> for the "any" address (unassigned/"don't
 
145
care") for <parameter>family</parameter>.</para>
 
146
<para>
 
147
</para><variablelist role="params">
 
148
<varlistentry><term><parameter>family</parameter>&#160;:</term>
 
149
<listitem><simpara> the address family
 
150
</simpara></listitem></varlistentry>
 
151
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GInetAddress"><type>GInetAddress</type></link> corresponding to the "any" address
 
152
for <parameter>family</parameter>.
 
153
 
 
154
</simpara></listitem></varlistentry>
 
155
</variablelist><para role="since">Since 2.22</para></refsect2>
 
156
<refsect2 id="g-inet-address-new-loopback" role="function" condition="since:2.22">
 
157
<title>g_inet_address_new_loopback ()</title>
 
158
<indexterm zone="g-inet-address-new-loopback" role="2.22"><primary sortas="inet_address_new_loopback">g_inet_address_new_loopback</primary></indexterm><programlisting><link linkend="GInetAddress">GInetAddress</link> *      g_inet_address_new_loopback         (<link linkend="GSocketFamily">GSocketFamily</link> family);</programlisting>
 
159
<para>
 
160
Creates a <link linkend="GInetAddress"><type>GInetAddress</type></link> for the loopback address for <parameter>family</parameter>.</para>
 
161
<para>
 
162
</para><variablelist role="params">
 
163
<varlistentry><term><parameter>family</parameter>&#160;:</term>
 
164
<listitem><simpara> the address family
 
165
</simpara></listitem></varlistentry>
 
166
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GInetAddress"><type>GInetAddress</type></link> corresponding to the loopback address
 
167
for <parameter>family</parameter>.
 
168
 
 
169
</simpara></listitem></varlistentry>
 
170
</variablelist><para role="since">Since 2.22</para></refsect2>
 
171
<refsect2 id="g-inet-address-to-bytes" role="function" condition="since:2.22">
 
172
<title>g_inet_address_to_bytes ()</title>
 
173
<indexterm zone="g-inet-address-to-bytes" role="2.22"><primary sortas="inet_address_to_bytes">g_inet_address_to_bytes</primary></indexterm><programlisting>const <link linkend="guint8">guint8</link> *      g_inet_address_to_bytes             (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
174
<para>
 
175
Gets the raw binary address data from <parameter>address</parameter>.</para>
 
176
<para>
 
177
</para><variablelist role="params">
 
178
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
179
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
180
</simpara></listitem></varlistentry>
 
181
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to an internal array of the bytes in <parameter>address</parameter>,
 
182
which should not be modified, stored, or freed. The size of this
 
183
array can be gotten with <link linkend="g-inet-address-get-native-size"><function>g_inet_address_get_native_size()</function></link>.
 
184
 
 
185
</simpara></listitem></varlistentry>
 
186
</variablelist><para role="since">Since 2.22</para></refsect2>
 
187
<refsect2 id="g-inet-address-get-native-size" role="function" condition="since:2.22">
 
188
<title>g_inet_address_get_native_size ()</title>
 
189
<indexterm zone="g-inet-address-get-native-size" role="2.22"><primary sortas="inet_address_get_native_size">g_inet_address_get_native_size</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               g_inet_address_get_native_size      (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
190
<para>
 
191
Gets the size of the native raw binary address for <parameter>address</parameter>. This
 
192
is the size of the data that you get from <link linkend="g-inet-address-to-bytes"><function>g_inet_address_to_bytes()</function></link>.</para>
 
193
<para>
 
194
</para><variablelist role="params">
 
195
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
196
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
197
</simpara></listitem></varlistentry>
 
198
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of bytes used for the native version of <parameter>address</parameter>.
 
199
 
 
200
</simpara></listitem></varlistentry>
 
201
</variablelist><para role="since">Since 2.22</para></refsect2>
 
202
<refsect2 id="g-inet-address-to-string" role="function" condition="since:2.22">
 
203
<title>g_inet_address_to_string ()</title>
 
204
<indexterm zone="g-inet-address-to-string" role="2.22"><primary sortas="inet_address_to_string">g_inet_address_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_inet_address_to_string            (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
205
<para>
 
206
Converts <parameter>address</parameter> to string form.</para>
 
207
<para>
 
208
</para><variablelist role="params">
 
209
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
210
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
211
</simpara></listitem></varlistentry>
 
212
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a representation of <parameter>address</parameter> as a string, which should be
 
213
freed after use.
 
214
 
 
215
</simpara></listitem></varlistentry>
 
216
</variablelist><para role="since">Since 2.22</para></refsect2>
 
217
<refsect2 id="g-inet-address-get-family" role="function" condition="since:2.22">
 
218
<title>g_inet_address_get_family ()</title>
 
219
<indexterm zone="g-inet-address-get-family" role="2.22"><primary sortas="inet_address_get_family">g_inet_address_get_family</primary></indexterm><programlisting><link linkend="GSocketFamily">GSocketFamily</link>       g_inet_address_get_family           (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
220
<para>
 
221
Gets <parameter>address</parameter>'s family</para>
 
222
<para>
 
223
</para><variablelist role="params">
 
224
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
225
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
226
</simpara></listitem></varlistentry>
 
227
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <parameter>address</parameter>'s family
 
228
 
 
229
</simpara></listitem></varlistentry>
 
230
</variablelist><para role="since">Since 2.22</para></refsect2>
 
231
<refsect2 id="g-inet-address-get-is-any" role="function" condition="since:2.22">
 
232
<title>g_inet_address_get_is_any ()</title>
 
233
<indexterm zone="g-inet-address-get-is-any" role="2.22"><primary sortas="inet_address_get_is_any">g_inet_address_get_is_any</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_any           (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
234
<para>
 
235
Tests whether <parameter>address</parameter> is the "any" address for its family.</para>
 
236
<para>
 
237
</para><variablelist role="params">
 
238
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
239
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
240
</simpara></listitem></varlistentry>
 
241
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is the "any" address for its family.
 
242
 
 
243
</simpara></listitem></varlistentry>
 
244
</variablelist><para role="since">Since 2.22</para></refsect2>
 
245
<refsect2 id="g-inet-address-get-is-loopback" role="function" condition="since:2.22">
 
246
<title>g_inet_address_get_is_loopback ()</title>
 
247
<indexterm zone="g-inet-address-get-is-loopback" role="2.22"><primary sortas="inet_address_get_is_loopback">g_inet_address_get_is_loopback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_loopback      (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
248
<para>
 
249
Tests whether <parameter>address</parameter> is the loopback address for its family.</para>
 
250
<para>
 
251
</para><variablelist role="params">
 
252
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
253
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
254
</simpara></listitem></varlistentry>
 
255
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is the loopback address for its family.
 
256
 
 
257
</simpara></listitem></varlistentry>
 
258
</variablelist><para role="since">Since 2.22</para></refsect2>
 
259
<refsect2 id="g-inet-address-get-is-link-local" role="function" condition="since:2.22">
 
260
<title>g_inet_address_get_is_link_local ()</title>
 
261
<indexterm zone="g-inet-address-get-is-link-local" role="2.22"><primary sortas="inet_address_get_is_link_local">g_inet_address_get_is_link_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_link_local    (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
262
<para>
 
263
Tests whether <parameter>address</parameter> is a link-local address (that is, if it
 
264
identifies a host on a local network that is not connected to the
 
265
Internet).</para>
 
266
<para>
 
267
</para><variablelist role="params">
 
268
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
269
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
270
</simpara></listitem></varlistentry>
 
271
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is a link-local address.
 
272
 
 
273
</simpara></listitem></varlistentry>
 
274
</variablelist><para role="since">Since 2.22</para></refsect2>
 
275
<refsect2 id="g-inet-address-get-is-site-local" role="function" condition="since:2.22">
 
276
<title>g_inet_address_get_is_site_local ()</title>
 
277
<indexterm zone="g-inet-address-get-is-site-local" role="2.22"><primary sortas="inet_address_get_is_site_local">g_inet_address_get_is_site_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_site_local    (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
278
<para>
 
279
Tests whether <parameter>address</parameter> is a site-local address such as 10.0.0.1
 
280
(that is, the address identifies a host on a local network that can
 
281
not be reached directly from the Internet, but which may have
 
282
outgoing Internet connectivity via a NAT or firewall).</para>
 
283
<para>
 
284
</para><variablelist role="params">
 
285
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
286
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
287
</simpara></listitem></varlistentry>
 
288
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is a site-local address.
 
289
 
 
290
</simpara></listitem></varlistentry>
 
291
</variablelist><para role="since">Since 2.22</para></refsect2>
 
292
<refsect2 id="g-inet-address-get-is-multicast" role="function" condition="since:2.22">
 
293
<title>g_inet_address_get_is_multicast ()</title>
 
294
<indexterm zone="g-inet-address-get-is-multicast" role="2.22"><primary sortas="inet_address_get_is_multicast">g_inet_address_get_is_multicast</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_multicast     (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
295
<para>
 
296
Tests whether <parameter>address</parameter> is a multicast address.</para>
 
297
<para>
 
298
</para><variablelist role="params">
 
299
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
300
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
301
</simpara></listitem></varlistentry>
 
302
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is a multicast address.
 
303
 
 
304
</simpara></listitem></varlistentry>
 
305
</variablelist><para role="since">Since 2.22</para></refsect2>
 
306
<refsect2 id="g-inet-address-get-is-mc-link-local" role="function" condition="since:2.22">
 
307
<title>g_inet_address_get_is_mc_link_local ()</title>
 
308
<indexterm zone="g-inet-address-get-is-mc-link-local" role="2.22"><primary sortas="inet_address_get_is_mc_link_local">g_inet_address_get_is_mc_link_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_mc_link_local (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
309
<para>
 
310
Tests whether <parameter>address</parameter> is a link-local multicast address.</para>
 
311
<para>
 
312
</para><variablelist role="params">
 
313
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
314
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
315
</simpara></listitem></varlistentry>
 
316
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is a link-local multicast address.
 
317
 
 
318
</simpara></listitem></varlistentry>
 
319
</variablelist><para role="since">Since 2.22</para></refsect2>
 
320
<refsect2 id="g-inet-address-get-is-mc-node-local" role="function" condition="since:2.22">
 
321
<title>g_inet_address_get_is_mc_node_local ()</title>
 
322
<indexterm zone="g-inet-address-get-is-mc-node-local" role="2.22"><primary sortas="inet_address_get_is_mc_node_local">g_inet_address_get_is_mc_node_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_mc_node_local (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
323
<para>
 
324
Tests whether <parameter>address</parameter> is a node-local multicast address.</para>
 
325
<para>
 
326
</para><variablelist role="params">
 
327
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
328
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
329
</simpara></listitem></varlistentry>
 
330
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is a node-local multicast address.
 
331
 
 
332
</simpara></listitem></varlistentry>
 
333
</variablelist><para role="since">Since 2.22</para></refsect2>
 
334
<refsect2 id="g-inet-address-get-is-mc-site-local" role="function" condition="since:2.22">
 
335
<title>g_inet_address_get_is_mc_site_local ()</title>
 
336
<indexterm zone="g-inet-address-get-is-mc-site-local" role="2.22"><primary sortas="inet_address_get_is_mc_site_local">g_inet_address_get_is_mc_site_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_mc_site_local (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
337
<para>
 
338
Tests whether <parameter>address</parameter> is a site-local multicast address.</para>
 
339
<para>
 
340
</para><variablelist role="params">
 
341
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
342
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
343
</simpara></listitem></varlistentry>
 
344
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is a site-local multicast address.
 
345
 
 
346
</simpara></listitem></varlistentry>
 
347
</variablelist><para role="since">Since 2.22</para></refsect2>
 
348
<refsect2 id="g-inet-address-get-is-mc-org-local" role="function" condition="since:2.22">
 
349
<title>g_inet_address_get_is_mc_org_local ()</title>
 
350
<indexterm zone="g-inet-address-get-is-mc-org-local" role="2.22"><primary sortas="inet_address_get_is_mc_org_local">g_inet_address_get_is_mc_org_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_mc_org_local  (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
351
<para>
 
352
Tests whether <parameter>address</parameter> is an organization-local multicast address.</para>
 
353
<para>
 
354
</para><variablelist role="params">
 
355
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
356
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
357
</simpara></listitem></varlistentry>
 
358
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is an organization-local multicast address.
 
359
 
 
360
</simpara></listitem></varlistentry>
 
361
</variablelist><para role="since">Since 2.22</para></refsect2>
 
362
<refsect2 id="g-inet-address-get-is-mc-global" role="function" condition="since:2.22">
 
363
<title>g_inet_address_get_is_mc_global ()</title>
 
364
<indexterm zone="g-inet-address-get-is-mc-global" role="2.22"><primary sortas="inet_address_get_is_mc_global">g_inet_address_get_is_mc_global</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_inet_address_get_is_mc_global     (<link linkend="GInetAddress">GInetAddress</link> *address);</programlisting>
 
365
<para>
 
366
Tests whether <parameter>address</parameter> is a global multicast address.</para>
 
367
<para>
 
368
</para><variablelist role="params">
 
369
<varlistentry><term><parameter>address</parameter>&#160;:</term>
 
370
<listitem><simpara> a <link linkend="GInetAddress"><type>GInetAddress</type></link>
 
371
</simpara></listitem></varlistentry>
 
372
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>address</parameter> is a global multicast address.
 
373
 
 
374
</simpara></listitem></varlistentry>
 
375
</variablelist><para role="since">Since 2.22</para></refsect2>
 
376
 
 
377
</refsect1>
 
378
<refsect1 id="GInetAddress.property-details" role="property_details">
 
379
<title role="property_details.title">Property Details</title>
 
380
<refsect2 id="GInetAddress--bytes" role="property"><title>The <literal>&quot;bytes&quot;</literal> property</title>
 
381
<indexterm zone="GInetAddress--bytes"><primary sortas="InetAddress:bytes">GInetAddress:bytes</primary></indexterm><programlisting>  &quot;bytes&quot;                    <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
 
382
<para>The raw address data.</para></refsect2>
 
383
<refsect2 id="GInetAddress--family" role="property"><title>The <literal>&quot;family&quot;</literal> property</title>
 
384
<indexterm zone="GInetAddress--family"><primary sortas="InetAddress:family">GInetAddress:family</primary></indexterm><programlisting>  &quot;family&quot;                   <link linkend="GSocketFamily">GSocketFamily</link>         : Read / Write / Construct Only</programlisting>
 
385
<para>The address family (IPv4 or IPv6).</para><para>Default value: G_SOCKET_FAMILY_INVALID</para>
 
386
</refsect2>
 
387
<refsect2 id="GInetAddress--is-any" role="property"><title>The <literal>&quot;is-any&quot;</literal> property</title>
 
388
<indexterm zone="GInetAddress--is-any" role="2.22"><primary sortas="InetAddress:is-any">GInetAddress:is-any</primary></indexterm><programlisting>  &quot;is-any&quot;                   <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
389
<para>
 
390
Whether this is the "any" address for its family.
 
391
See <link linkend="g-inet-address-get-is-any"><function>g_inet_address_get_is_any()</function></link>.</para>
 
392
<para>
 
393
</para><para>Default value: FALSE</para>
 
394
<para>Since 2.22</para>
 
395
</refsect2>
 
396
<refsect2 id="GInetAddress--is-link-local" role="property"><title>The <literal>&quot;is-link-local&quot;</literal> property</title>
 
397
<indexterm zone="GInetAddress--is-link-local" role="2.22"><primary sortas="InetAddress:is-link-local">GInetAddress:is-link-local</primary></indexterm><programlisting>  &quot;is-link-local&quot;            <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
398
<para>
 
399
Whether this is a link-local address.
 
400
See <link linkend="g-inet-address-get-is-link-local"><function>g_inet_address_get_is_link_local()</function></link>.</para>
 
401
<para>
 
402
</para><para>Default value: FALSE</para>
 
403
<para>Since 2.22</para>
 
404
</refsect2>
 
405
<refsect2 id="GInetAddress--is-loopback" role="property"><title>The <literal>&quot;is-loopback&quot;</literal> property</title>
 
406
<indexterm zone="GInetAddress--is-loopback" role="2.22"><primary sortas="InetAddress:is-loopback">GInetAddress:is-loopback</primary></indexterm><programlisting>  &quot;is-loopback&quot;              <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
407
<para>
 
408
Whether this is the loopback address for its family.
 
409
See <link linkend="g-inet-address-get-is-loopback"><function>g_inet_address_get_is_loopback()</function></link>.</para>
 
410
<para>
 
411
</para><para>Default value: FALSE</para>
 
412
<para>Since 2.22</para>
 
413
</refsect2>
 
414
<refsect2 id="GInetAddress--is-mc-global" role="property"><title>The <literal>&quot;is-mc-global&quot;</literal> property</title>
 
415
<indexterm zone="GInetAddress--is-mc-global" role="2.22"><primary sortas="InetAddress:is-mc-global">GInetAddress:is-mc-global</primary></indexterm><programlisting>  &quot;is-mc-global&quot;             <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
416
<para>
 
417
Whether this is a global multicast address.
 
418
See <link linkend="g-inet-address-get-is-mc-global"><function>g_inet_address_get_is_mc_global()</function></link>.</para>
 
419
<para>
 
420
</para><para>Default value: FALSE</para>
 
421
<para>Since 2.22</para>
 
422
</refsect2>
 
423
<refsect2 id="GInetAddress--is-mc-link-local" role="property"><title>The <literal>&quot;is-mc-link-local&quot;</literal> property</title>
 
424
<indexterm zone="GInetAddress--is-mc-link-local" role="2.22"><primary sortas="InetAddress:is-mc-link-local">GInetAddress:is-mc-link-local</primary></indexterm><programlisting>  &quot;is-mc-link-local&quot;         <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
425
<para>
 
426
Whether this is a link-local multicast address.
 
427
See <link linkend="g-inet-address-get-is-mc-link-local"><function>g_inet_address_get_is_mc_link_local()</function></link>.</para>
 
428
<para>
 
429
</para><para>Default value: FALSE</para>
 
430
<para>Since 2.22</para>
 
431
</refsect2>
 
432
<refsect2 id="GInetAddress--is-mc-node-local" role="property"><title>The <literal>&quot;is-mc-node-local&quot;</literal> property</title>
 
433
<indexterm zone="GInetAddress--is-mc-node-local" role="2.22"><primary sortas="InetAddress:is-mc-node-local">GInetAddress:is-mc-node-local</primary></indexterm><programlisting>  &quot;is-mc-node-local&quot;         <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
434
<para>
 
435
Whether this is a node-local multicast address.
 
436
See <link linkend="g-inet-address-get-is-mc-node-local"><function>g_inet_address_get_is_mc_node_local()</function></link>.</para>
 
437
<para>
 
438
</para><para>Default value: FALSE</para>
 
439
<para>Since 2.22</para>
 
440
</refsect2>
 
441
<refsect2 id="GInetAddress--is-mc-org-local" role="property"><title>The <literal>&quot;is-mc-org-local&quot;</literal> property</title>
 
442
<indexterm zone="GInetAddress--is-mc-org-local" role="2.22"><primary sortas="InetAddress:is-mc-org-local">GInetAddress:is-mc-org-local</primary></indexterm><programlisting>  &quot;is-mc-org-local&quot;          <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
443
<para>
 
444
Whether this is an organization-local multicast address.
 
445
See <link linkend="g-inet-address-get-is-mc-org-local"><function>g_inet_address_get_is_mc_org_local()</function></link>.</para>
 
446
<para>
 
447
</para><para>Default value: FALSE</para>
 
448
<para>Since 2.22</para>
 
449
</refsect2>
 
450
<refsect2 id="GInetAddress--is-mc-site-local" role="property"><title>The <literal>&quot;is-mc-site-local&quot;</literal> property</title>
 
451
<indexterm zone="GInetAddress--is-mc-site-local" role="2.22"><primary sortas="InetAddress:is-mc-site-local">GInetAddress:is-mc-site-local</primary></indexterm><programlisting>  &quot;is-mc-site-local&quot;         <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
452
<para>
 
453
Whether this is a site-local multicast address.
 
454
See <link linkend="g-inet-address-get-is-mc-site-local"><function>g_inet_address_get_is_mc_site_local()</function></link>.</para>
 
455
<para>
 
456
</para><para>Default value: FALSE</para>
 
457
<para>Since 2.22</para>
 
458
</refsect2>
 
459
<refsect2 id="GInetAddress--is-multicast" role="property"><title>The <literal>&quot;is-multicast&quot;</literal> property</title>
 
460
<indexterm zone="GInetAddress--is-multicast" role="2.22"><primary sortas="InetAddress:is-multicast">GInetAddress:is-multicast</primary></indexterm><programlisting>  &quot;is-multicast&quot;             <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
461
<para>
 
462
Whether this is a multicast address.
 
463
See <link linkend="g-inet-address-get-is-multicast"><function>g_inet_address_get_is_multicast()</function></link>.</para>
 
464
<para>
 
465
</para><para>Default value: FALSE</para>
 
466
<para>Since 2.22</para>
 
467
</refsect2>
 
468
<refsect2 id="GInetAddress--is-site-local" role="property"><title>The <literal>&quot;is-site-local&quot;</literal> property</title>
 
469
<indexterm zone="GInetAddress--is-site-local" role="2.22"><primary sortas="InetAddress:is-site-local">GInetAddress:is-site-local</primary></indexterm><programlisting>  &quot;is-site-local&quot;            <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
470
<para>
 
471
Whether this is a site-local address.
 
472
See <link linkend="g-inet-address-get-is-loopback"><function>g_inet_address_get_is_loopback()</function></link>.</para>
 
473
<para>
 
474
</para><para>Default value: FALSE</para>
 
475
<para>Since 2.22</para>
 
476
</refsect2>
 
477
</refsect1>
 
478
 
 
479
 
 
480
 
 
481
 
 
482
</refentry>