← Back to branch summary

~ubuntu-branches/debian/sid/glibmm2.4/sid

« back to all changes in this revision

Viewing changes to docs/reference/html/classGio_1_1SocketAddress.html

  • Committer: Bazaar Package Importer
  • Author(s): Deng Xiyue
  • Date: 2009-07-20 10:01:53 UTC
  • mfrom: (1.2.36 upstream)
  • Revision ID: james.westby@ubuntu.com-20090720100153-e2e4u4oshubnem3u
* New upstream release.
* Section of libglibmm-2.4-dbg is "debug" now.
* Update debian/copyright to conform to latest DEP 5.
  + Fix incorrect license.
  + Point to versioned license files.
* Update Standard-Version to 3.8.2.  No change required.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/classGio_1_1SocketAddress.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>glibmm 2.4: Gio::SocketAddress Class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
</head>
 
6
<body bgcolor="#ffffff">
 
7
<table border="0" width="100%">
 
8
<tr>
 
9
    <td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
 
10
    <td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
 
11
</tr>
 
12
</table>
 
13
<center>
 
14
  <a class="qindex" href="http://www.gtkmm.org/documentation.shtml">Main Page</a> &nbsp;
 
15
  <a class="qindex" href="namespaces.html">glibmm Namespaces</a> &nbsp;
 
16
  <a href="../../../../gtkmm-2.4/docs/tutorial/html/index.html"> Book</a> &nbsp;
 
17
</center>
 
18
<hr width="100%"/>
 
19
 
 
20
<!-- begin main content -->
 
21
<div id="content">
 
22
<!-- Generated by Doxygen 1.5.6 -->
 
23
  <div class="navpath"><a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1SocketAddress.html">SocketAddress</a>
 
24
  </div>
 
25
<div class="contents">
 
26
<h1>Gio::SocketAddress Class Reference</h1><!-- doxytag: class="Gio::SocketAddress" --><!-- doxytag: inherits="Glib::Object,Gio::SocketConnectable" -->Abstract base class representing endpoints for socket communication.  
 
27
<a href="#_details">More...</a>
 
28
<p>
 
29
<div class="dynheader">
 
30
Inheritance diagram for Gio::SocketAddress:</div>
 
31
<div class="dynsection">
 
32
<p><center><img src="classGio_1_1SocketAddress__inherit__graph.png" border="0" usemap="#Gio_1_1SocketAddress__inherit__map" alt="Inheritance graph"></center>
 
33
<map name="Gio_1_1SocketAddress__inherit__map">
 
34
<area shape="rect" href="classGio_1_1InetSocketAddress.html" title="Internet SocketAddress." alt="" coords="45,379,205,406"><area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,230,96,256"><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="49,80,169,107"><area shape="rect" href="classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="133,155,237,182"><area shape="rect" href="classsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="56,6,163,32"><area shape="rect" href="classGio_1_1SocketConnectable.html" title="Interface for potential socket endpoints." alt="" coords="120,230,283,256"></map>
 
35
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
 
36
 
 
37
<p>
 
38
<a href="classGio_1_1SocketAddress-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 
39
<tr><td></td></tr>
 
40
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#eedceaf982ff7e7dc75d419022bafde1">~SocketAddress</a> ()</td></tr>
 
42
 
 
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">GSocketAddress*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#1f65b6f40eeb9a30eb613345be919eb6">gobj</a> ()</td></tr>
 
44
 
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#1f65b6f40eeb9a30eb613345be919eb6"></a><br></td></tr>
 
46
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GSocketAddress*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#a2c5c7f04c127ad5037814f847ab2d6f">gobj</a> () const </td></tr>
 
47
 
 
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#a2c5c7f04c127ad5037814f847ab2d6f"></a><br></td></tr>
 
49
<tr><td class="memItemLeft" nowrap align="right" valign="top">GSocketAddress*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#fe1a5b0091f024fa725ff31b88d01e7b">gobj_copy</a> ()</td></tr>
 
50
 
 
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.  <a href="#fe1a5b0091f024fa725ff31b88d01e7b"></a><br></td></tr>
 
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">SocketFamily&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#b4fb1e63e629e88e5263e8bf5d095809">get_family</a> () const </td></tr>
 
53
 
 
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the socket family type of <em>address</em>.  <a href="#b4fb1e63e629e88e5263e8bf5d095809"></a><br></td></tr>
 
55
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#dec995b9e46746a5d55b3c5af592ec44">to_native</a> (gpointer dest, gsize destlen)</td></tr>
 
56
 
 
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts a <a class="el" href="classGio_1_1SocketAddress.html" title="Abstract base class representing endpoints for socket communication.">SocketAddress</a> to a native &lt;type&gt;struct sockaddr&lt;/type&gt;, which can be passed to low-level functions like connect() or bind().  <a href="#dec995b9e46746a5d55b3c5af592ec44"></a><br></td></tr>
 
58
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#25fd6c43478da2eef785467f75ba02ec">get_native_size</a> () const </td></tr>
 
59
 
 
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the size of <em>address's</em> native &lt;type&gt;struct sockaddr&lt;/type&gt;.  <a href="#25fd6c43478da2eef785467f75ba02ec"></a><br></td></tr>
 
61
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
 
62
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
 
63
&lt;<a class="el" href="classGio_1_1SocketAddress.html">SocketAddress</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#3d2233d8fc6b47668d38d4b450b5bae2">create</a> (gpointer native, gsize len)</td></tr>
 
64
 
 
65
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
 
66
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
 
67
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1SocketAddress.html">Gio::SocketAddress</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketAddress.html#df0c2a59f4fc452b8b8e81f86ed1dc43">wrap</a> (GSocketAddress* object, bool take_copy=false)</td></tr>
 
68
 
 
69
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.  <a href="#df0c2a59f4fc452b8b8e81f86ed1dc43"></a><br></td></tr>
 
70
</table>
 
71
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
72
Abstract base class representing endpoints for socket communication. 
 
73
<p>
 
74
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
75
<a class="anchor" name="eedceaf982ff7e7dc75d419022bafde1"></a><!-- doxytag: member="Gio::SocketAddress::~SocketAddress" ref="eedceaf982ff7e7dc75d419022bafde1" args="()" -->
 
76
<div class="memitem">
 
77
<div class="memproto">
 
78
      <table class="memname">
 
79
        <tr>
 
80
          <td class="memname">virtual Gio::SocketAddress::~SocketAddress           </td>
 
81
          <td>(</td>
 
82
          <td class="paramname">          </td>
 
83
          <td>&nbsp;)&nbsp;</td>
 
84
          <td><code> [virtual]</code></td>
 
85
        </tr>
 
86
      </table>
 
87
</div>
 
88
<div class="memdoc">
 
89
 
 
90
<p>
 
91
 
 
92
</div>
 
93
</div><p>
 
94
<hr><h2>Member Function Documentation</h2>
 
95
<a class="anchor" name="1f65b6f40eeb9a30eb613345be919eb6"></a><!-- doxytag: member="Gio::SocketAddress::gobj" ref="1f65b6f40eeb9a30eb613345be919eb6" args="()" -->
 
96
<div class="memitem">
 
97
<div class="memproto">
 
98
      <table class="memname">
 
99
        <tr>
 
100
          <td class="memname">GSocketAddress* Gio::SocketAddress::gobj           </td>
 
101
          <td>(</td>
 
102
          <td class="paramname">          </td>
 
103
          <td>&nbsp;)&nbsp;</td>
 
104
          <td><code> [inline]</code></td>
 
105
        </tr>
 
106
      </table>
 
107
</div>
 
108
<div class="memdoc">
 
109
 
 
110
<p>
 
111
Provides access to the underlying C GObject. 
 
112
<p>
 
113
 
 
114
<p>Reimplemented from <a class="el" href="classGio_1_1SocketConnectable.html#25988d9aeb115345500d09b282cf7023">Gio::SocketConnectable</a>.</p>
 
115
 
 
116
<p>Reimplemented in <a class="el" href="classGio_1_1InetSocketAddress.html#2185ff490fa658c11854df16c41910dc">Gio::InetSocketAddress</a>.</p>
 
117
 
 
118
</div>
 
119
</div><p>
 
120
<a class="anchor" name="a2c5c7f04c127ad5037814f847ab2d6f"></a><!-- doxytag: member="Gio::SocketAddress::gobj" ref="a2c5c7f04c127ad5037814f847ab2d6f" args="() const " -->
 
121
<div class="memitem">
 
122
<div class="memproto">
 
123
      <table class="memname">
 
124
        <tr>
 
125
          <td class="memname">const GSocketAddress* Gio::SocketAddress::gobj           </td>
 
126
          <td>(</td>
 
127
          <td class="paramname">          </td>
 
128
          <td>&nbsp;)&nbsp;</td>
 
129
          <td> const<code> [inline]</code></td>
 
130
        </tr>
 
131
      </table>
 
132
</div>
 
133
<div class="memdoc">
 
134
 
 
135
<p>
 
136
Provides access to the underlying C GObject. 
 
137
<p>
 
138
 
 
139
<p>Reimplemented from <a class="el" href="classGio_1_1SocketConnectable.html#5ba8bd26578fa49ce4a6f8fbb544858c">Gio::SocketConnectable</a>.</p>
 
140
 
 
141
<p>Reimplemented in <a class="el" href="classGio_1_1InetSocketAddress.html#d0a057e46b10504010e3e014d3207f4d">Gio::InetSocketAddress</a>.</p>
 
142
 
 
143
</div>
 
144
</div><p>
 
145
<a class="anchor" name="fe1a5b0091f024fa725ff31b88d01e7b"></a><!-- doxytag: member="Gio::SocketAddress::gobj_copy" ref="fe1a5b0091f024fa725ff31b88d01e7b" args="()" -->
 
146
<div class="memitem">
 
147
<div class="memproto">
 
148
      <table class="memname">
 
149
        <tr>
 
150
          <td class="memname">GSocketAddress* Gio::SocketAddress::gobj_copy           </td>
 
151
          <td>(</td>
 
152
          <td class="paramname">          </td>
 
153
          <td>&nbsp;)&nbsp;</td>
 
154
          <td></td>
 
155
        </tr>
 
156
      </table>
 
157
</div>
 
158
<div class="memdoc">
 
159
 
 
160
<p>
 
161
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. 
 
162
<p>
 
163
 
 
164
<p>Reimplemented in <a class="el" href="classGio_1_1InetSocketAddress.html#0d165726f19e26d3c03a184510b6df2b">Gio::InetSocketAddress</a>.</p>
 
165
 
 
166
</div>
 
167
</div><p>
 
168
<a class="anchor" name="3d2233d8fc6b47668d38d4b450b5bae2"></a><!-- doxytag: member="Gio::SocketAddress::create" ref="3d2233d8fc6b47668d38d4b450b5bae2" args="(gpointer native, gsize len)" -->
 
169
<div class="memitem">
 
170
<div class="memproto">
 
171
      <table class="memname">
 
172
        <tr>
 
173
          <td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1SocketAddress.html">SocketAddress</a>&gt; Gio::SocketAddress::create           </td>
 
174
          <td>(</td>
 
175
          <td class="paramtype">gpointer&nbsp;</td>
 
176
          <td class="paramname"> <em>native</em>, </td>
 
177
        </tr>
 
178
        <tr>
 
179
          <td class="paramkey"></td>
 
180
          <td></td>
 
181
          <td class="paramtype">gsize&nbsp;</td>
 
182
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
 
183
        </tr>
 
184
        <tr>
 
185
          <td></td>
 
186
          <td>)</td>
 
187
          <td></td><td></td><td><code> [static]</code></td>
 
188
        </tr>
 
189
      </table>
 
190
</div>
 
191
<div class="memdoc">
 
192
 
 
193
<p>
 
194
 
 
195
</div>
 
196
</div><p>
 
197
<a class="anchor" name="b4fb1e63e629e88e5263e8bf5d095809"></a><!-- doxytag: member="Gio::SocketAddress::get_family" ref="b4fb1e63e629e88e5263e8bf5d095809" args="() const " -->
 
198
<div class="memitem">
 
199
<div class="memproto">
 
200
      <table class="memname">
 
201
        <tr>
 
202
          <td class="memname">SocketFamily Gio::SocketAddress::get_family           </td>
 
203
          <td>(</td>
 
204
          <td class="paramname">          </td>
 
205
          <td>&nbsp;)&nbsp;</td>
 
206
          <td> const</td>
 
207
        </tr>
 
208
      </table>
 
209
</div>
 
210
<div class="memdoc">
 
211
 
 
212
<p>
 
213
Gets the socket family type of <em>address</em>. 
 
214
<p>
 
215
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The socket family type of <em>address</em>.</dd></dl>
 
216
. 
 
217
</div>
 
218
</div><p>
 
219
<a class="anchor" name="dec995b9e46746a5d55b3c5af592ec44"></a><!-- doxytag: member="Gio::SocketAddress::to_native" ref="dec995b9e46746a5d55b3c5af592ec44" args="(gpointer dest, gsize destlen)" -->
 
220
<div class="memitem">
 
221
<div class="memproto">
 
222
      <table class="memname">
 
223
        <tr>
 
224
          <td class="memname">bool Gio::SocketAddress::to_native           </td>
 
225
          <td>(</td>
 
226
          <td class="paramtype">gpointer&nbsp;</td>
 
227
          <td class="paramname"> <em>dest</em>, </td>
 
228
        </tr>
 
229
        <tr>
 
230
          <td class="paramkey"></td>
 
231
          <td></td>
 
232
          <td class="paramtype">gsize&nbsp;</td>
 
233
          <td class="paramname"> <em>destlen</em></td><td>&nbsp;</td>
 
234
        </tr>
 
235
        <tr>
 
236
          <td></td>
 
237
          <td>)</td>
 
238
          <td></td><td></td><td></td>
 
239
        </tr>
 
240
      </table>
 
241
</div>
 
242
<div class="memdoc">
 
243
 
 
244
<p>
 
245
Converts a <a class="el" href="classGio_1_1SocketAddress.html" title="Abstract base class representing endpoints for socket communication.">SocketAddress</a> to a native &lt;type&gt;struct sockaddr&lt;/type&gt;, which can be passed to low-level functions like connect() or bind(). 
 
246
<p>
 
247
<dl compact><dt><b>Parameters:</b></dt><dd>
 
248
  <table border="0" cellspacing="2" cellpadding="0">
 
249
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>A pointer to a memory location that will contain the native &lt;type&gt;struct sockaddr&lt;/type&gt;. </td></tr>
 
250
    <tr><td valign="top"></td><td valign="top"><em>destlen</em>&nbsp;</td><td>The size of <em>dest</em>. Must be at least as large as g_socket_address_get_native_size(). </td></tr>
 
251
  </table>
 
252
</dl>
 
253
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if <em>dest</em> was filled in, <code>false</code> if <em>address</em> is invalid or <em>destlen</em> is too small.</dd></dl>
 
254
. 
 
255
</div>
 
256
</div><p>
 
257
<a class="anchor" name="25fd6c43478da2eef785467f75ba02ec"></a><!-- doxytag: member="Gio::SocketAddress::get_native_size" ref="25fd6c43478da2eef785467f75ba02ec" args="() const " -->
 
258
<div class="memitem">
 
259
<div class="memproto">
 
260
      <table class="memname">
 
261
        <tr>
 
262
          <td class="memname">gssize Gio::SocketAddress::get_native_size           </td>
 
263
          <td>(</td>
 
264
          <td class="paramname">          </td>
 
265
          <td>&nbsp;)&nbsp;</td>
 
266
          <td> const</td>
 
267
        </tr>
 
268
      </table>
 
269
</div>
 
270
<div class="memdoc">
 
271
 
 
272
<p>
 
273
Gets the size of <em>address's</em> native &lt;type&gt;struct sockaddr&lt;/type&gt;. 
 
274
<p>
 
275
You can use this to allocate memory to pass to g_socket_address_to_native(). <dl class="return" compact><dt><b>Returns:</b></dt><dd>The size of the native &lt;type&gt;struct sockaddr&lt;/type&gt; that <em>address</em> represents</dd></dl>
 
276
. 
 
277
</div>
 
278
</div><p>
 
279
<hr><h2>Friends And Related Function Documentation</h2>
 
280
<a class="anchor" name="df0c2a59f4fc452b8b8e81f86ed1dc43"></a><!-- doxytag: member="Gio::SocketAddress::wrap" ref="df0c2a59f4fc452b8b8e81f86ed1dc43" args="(GSocketAddress *object, bool take_copy=false)" -->
 
281
<div class="memitem">
 
282
<div class="memproto">
 
283
      <table class="memname">
 
284
        <tr>
 
285
          <td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGio_1_1SocketAddress.html">Gio::SocketAddress</a>&gt; wrap           </td>
 
286
          <td>(</td>
 
287
          <td class="paramtype">GSocketAddress *&nbsp;</td>
 
288
          <td class="paramname"> <em>object</em>, </td>
 
289
        </tr>
 
290
        <tr>
 
291
          <td class="paramkey"></td>
 
292
          <td></td>
 
293
          <td class="paramtype">bool&nbsp;</td>
 
294
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&nbsp;</td>
 
295
        </tr>
 
296
        <tr>
 
297
          <td></td>
 
298
          <td>)</td>
 
299
          <td></td><td></td><td><code> [related]</code></td>
 
300
        </tr>
 
301
      </table>
 
302
</div>
 
303
<div class="memdoc">
 
304
 
 
305
<p>
 
306
A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. 
 
307
<p>
 
308
<dl compact><dt><b>Parameters:</b></dt><dd>
 
309
  <table border="0" cellspacing="2" cellpadding="0">
 
310
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>The C instance. </td></tr>
 
311
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&nbsp;</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
 
312
  </table>
 
313
</dl>
 
314
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
315
 
 
316
</div>
 
317
</div><p>
 
318
<hr>The documentation for this class was generated from the following file:<ul>
 
319
<li><a class="el" href="socketaddress_8h.html">socketaddress.h</a></ul>
 
320
</div>
 
321
</div> <!-- end main content -->
 
322
 
 
323
<hr><address><small>
 
324
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
 
325
Doxygen</a> 1.5.6 &copy;&nbsp;1997-2001</small></address>
 
326
</body>
 
327
</html>