1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
<HTML>
<HEAD>
<TITLE>class SocketAddr</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class SocketAddr</h1>
</TD>
<TD valign="top" align="right" colspan="1">A socket address holder. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::SocketAddr</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="yateclass_h.html">yateclass.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__GenObject.html">TelEngine::GenObject</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SocketAddr.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI>inline <b><A HREF="#ref1">SocketAddr</A></b> ()
</LI>
<LI>inline <b><A HREF="#ref2">SocketAddr</A></b> (const SocketAddr& value)
</LI>
<LI> <b><A HREF="#ref3">SocketAddr</A></b> (int family)
</LI>
<LI> <b><A HREF="#ref4">SocketAddr</A></b> (const struct sockaddr* addr, <A HREF="#socklen_t">socklen_t</A> len = 0)
</LI>
<LI>virtual <b><A HREF="#ref5">~SocketAddr</A></b> ()
</LI>
<LI>inline SocketAddr& <b><A HREF="#ref6">operator=</A></b> (const SocketAddr& value)
</LI>
<LI>bool <b><A HREF="#ref7">operator==</A></b> (const SocketAddr& other) const
</LI>
<LI>inline bool <b><A HREF="#ref8">operator!=</A></b> (const SocketAddr& other) const
</LI>
<LI>void <b><A HREF="#ref9">clear</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref10">assign</A></b> (int family)
</LI>
<LI>void <b><A HREF="#ref11">assign</A></b> (const struct sockaddr* addr, <A HREF="#socklen_t">socklen_t</A> len = 0)
</LI>
<LI>bool <b><A HREF="#ref12">local</A></b> (const SocketAddr& remote)
</LI>
<LI>inline bool <b><A HREF="#ref13">valid</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref14">null</A></b> () const
</LI>
<LI>inline int <b><A HREF="#ref15">family</A></b> () const
</LI>
<LI>inline const String& <b><A HREF="#ref16">host</A></b> () const
</LI>
<LI>virtual bool <b><A HREF="#ref17">host</A></b> (const String& name)
</LI>
<LI>int <b><A HREF="#ref18">port</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref19">port</A></b> (int newport)
</LI>
<LI>inline struct sockaddr* <b><A HREF="#ref20">address</A></b> () const
</LI>
<LI>inline <A HREF="#socklen_t">socklen_t</A> <b><A HREF="#ref21">length</A></b> () const
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static bool <b><A HREF="#ref22">supports</A></b> (int family)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref23">stringify</A></b> ()
</LI>
</ul><h4>Protected Members</h4><ul><LI>struct sockaddr* <b><A HREF="#ref24">m_address</A></b></LI>
<LI>socklen_t <b><A HREF="#ref25">m_length</A></b></LI>
<LI>String <b><A HREF="#ref26">m_host</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Wrapper class to keep a socket address
</p>
<A NAME="SocketAddr"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>SocketAddr</strong> ()
<br></td><td align="right"><h3><strong>SocketAddr</strong></h3></td></tr></table><p></p><p>
Default constructor of an empty address
</p>
<A NAME="SocketAddr"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>SocketAddr</strong> (const SocketAddr& value)
<br></td><td align="right"><h3><strong>SocketAddr</strong></h3></td></tr></table><p></p><p>
Copy constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>value</i></TD><TD align="left" valign="top">Address to copy
</TD></TR>
</TABLE></P>
<A NAME="SocketAddr"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SocketAddr</strong> (int family)
<br></td><td align="right"><h3><strong>SocketAddr</strong></h3></td></tr></table><p></p><p>
Constructor of a null address
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>family</i></TD><TD align="left" valign="top">Family of the address to create
</TD></TR>
</TABLE></P>
<A NAME="SocketAddr"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SocketAddr</strong> (const struct sockaddr* addr, <A HREF="#socklen_t">socklen_t</A> len = 0)
<br></td><td align="right"><h3><strong>SocketAddr</strong></h3></td></tr></table><p></p><p>
Constructor that stores a copy of an address
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>addr</i></TD><TD align="left" valign="top">Pointer to the address to store
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the stored address, zero to use default
</TD></TR>
</TABLE></P>
<A NAME="~SocketAddr"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~SocketAddr</strong> ()
<br></td><td align="right"><h3><strong>~SocketAddr</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor that frees and zeroes out everything
</p>
<A NAME="operator="></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SocketAddr& <strong>operator=</strong> (const SocketAddr& value)
<br></td><td align="right"><h3><strong>operator=</strong></h3></td></tr></table><p></p><p>
Assignment operator
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>value</i></TD><TD align="left" valign="top">Address to copy
</TD></TR>
</TABLE></P>
<A NAME="operator=="></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>operator==</strong> (const SocketAddr& other)
<br></td><td align="right"><h3><strong>operator==</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Equality comparation operator
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Address to compare to
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the addresses are equal
</p>
<A NAME="operator!="></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>operator!=</strong> (const SocketAddr& other)
<br></td><td align="right"><h3><strong>operator!=</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Inequality comparation operator
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Address to compare to
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the addresses are different
</p>
<A NAME="clear"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>clear</strong> ()
<br></td><td align="right"><h3><strong>clear</strong></h3></td></tr></table><p></p><p>
Clears up the address, frees the memory
</p>
<A NAME="assign"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>assign</strong> (int family)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assigns an empty address of a specific type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>family</i></TD><TD align="left" valign="top">Family of the address to create
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the address family is supported
</p>
<A NAME="assign"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>assign</strong> (const struct sockaddr* addr, <A HREF="#socklen_t">socklen_t</A> len = 0)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assigns a new address
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>addr</i></TD><TD align="left" valign="top">Pointer to the address to store
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the stored address, zero to use default
</TD></TR>
</TABLE></P>
<A NAME="local"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>local</strong> (const SocketAddr& remote)
<br></td><td align="right"><h3><strong>local</strong></h3></td></tr></table><p></p><p>
Attempt to guess a local address that will be used to reach a remote one
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>remote</i></TD><TD align="left" valign="top">Remote address to reach
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if guessed an address, false if failed
</p>
<A NAME="valid"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>valid</strong> ()
<br></td><td align="right"><h3><strong>valid</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if a non-null address is held
</p>
<p><b>Returns</b>: True if a valid address is held, false if null
</p>
<A NAME="null"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>null</strong> ()
<br></td><td align="right"><h3><strong>null</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if a null address is held
</p>
<p><b>Returns</b>: True if a null address is held
</p>
<A NAME="family"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>family</strong> ()
<br></td><td align="right"><h3><strong>family</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the family of the stored address
</p>
<p><b>Returns</b>: Address family of the stored address or zero (AF_UNSPEC)
</p>
<A NAME="host"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>host</strong> ()
<br></td><td align="right"><h3><strong>host</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the host of this address
</p>
<p><b>Returns</b>: Host name as String
</p>
<A NAME="host"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>host</strong> (const String& name)
<br></td><td align="right"><h3><strong>host</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Set the hostname of this address
</p>
<p><b>Returns</b>: True if new host set, false if name could not be parsed
</p>
<A NAME="port"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>port</strong> ()
<br></td><td align="right"><h3><strong>port</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the port of the stored address (if supported)
</p>
<p><b>Returns</b>: Port number of the socket address or zero
</p>
<A NAME="port"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>port</strong> (int newport)
<br></td><td align="right"><h3><strong>port</strong></h3></td></tr></table><p></p><p>
Set the port of the stored address (if supported)
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>newport</i></TD><TD align="left" valign="top">Port number to set in the socket address
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if new port set, false if not supported
</p>
<A NAME="address"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline struct sockaddr* <strong>address</strong> ()
<br></td><td align="right"><h3><strong>address</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the contained socket address
</p>
<p><b>Returns</b>: A pointer to the socket address
</p>
<A NAME="length"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#socklen_t">socklen_t</A> <strong>length</strong> ()
<br></td><td align="right"><h3><strong>length</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the length of the address
</p>
<p><b>Returns</b>: Length of the stored address
</p>
<A NAME="supports"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>supports</strong> (int family)
<br></td><td align="right"><h3><strong>supports</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Check if an address family is supported by the library
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>family</i></TD><TD align="left" valign="top">Family of the address to check
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the address family is supported
</p>
<A NAME="stringify"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>stringify</strong> ()
<br></td><td align="right"><h3><strong>stringify</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Convert the host address to a String stored in m_host
</p>
<A NAME="m_address"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>struct sockaddr* <strong>m_address</strong>
</td><td align="right"><h3><strong>m_address</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_length"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#socklen_t">socklen_t</A> <strong>m_length</strong>
</td><td align="right"><h3><strong>m_length</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_host"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_host</strong>
</td><td align="right"><h3><strong>m_host</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
