Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "IO::Socket::INET 3" | |
132 | .TH IO::Socket::INET 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | IO::Socket::INET \- Object interface for AF_INET domain sockets | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 1 | |
138 | \& use IO::Socket::INET; | |
139 | .Ve | |
140 | .SH "DESCRIPTION" | |
141 | .IX Header "DESCRIPTION" | |
142 | \&\f(CW\*(C`IO::Socket::INET\*(C'\fR provides an object interface to creating and using sockets | |
143 | in the \s-1AF_INET\s0 domain. It is built upon the IO::Socket interface and | |
144 | inherits all the methods defined by IO::Socket. | |
145 | .SH "CONSTRUCTOR" | |
146 | .IX Header "CONSTRUCTOR" | |
147 | .IP "new ( [\s-1ARGS\s0] )" 4 | |
148 | .IX Item "new ( [ARGS] )" | |
149 | Creates an \f(CW\*(C`IO::Socket::INET\*(C'\fR object, which is a reference to a | |
150 | newly created symbol (see the \f(CW\*(C`Symbol\*(C'\fR package). \f(CW\*(C`new\*(C'\fR | |
151 | optionally takes arguments, these arguments are in key-value pairs. | |
152 | .Sp | |
153 | In addition to the key-value pairs accepted by IO::Socket, | |
154 | \&\f(CW\*(C`IO::Socket::INET\*(C'\fR provides. | |
155 | .Sp | |
156 | .Vb 16 | |
157 | \& PeerAddr Remote host address <hostname>[:<port>] | |
158 | \& PeerHost Synonym for PeerAddr | |
159 | \& PeerPort Remote port or service <service>[(<no>)] | <no> | |
160 | \& LocalAddr Local host bind address hostname[:port] | |
161 | \& LocalHost Synonym for LocalAddr | |
162 | \& LocalPort Local host bind port <service>[(<no>)] | <no> | |
163 | \& Proto Protocol name (or number) "tcp" | "udp" | ... | |
164 | \& Type Socket type SOCK_STREAM | SOCK_DGRAM | ... | |
165 | \& Listen Queue size for listen | |
166 | \& ReuseAddr Set SO_REUSEADDR before binding | |
167 | \& Reuse Set SO_REUSEADDR before binding (deprecated, prefer ReuseAddr) | |
168 | \& ReusePort Set SO_REUSEPORT before binding | |
169 | \& Broadcast Set SO_BROADCAST before binding | |
170 | \& Timeout Timeout value for various operations | |
171 | \& MultiHomed Try all addresses for multi-homed hosts | |
172 | \& Blocking Determine if connection will be blocking mode | |
173 | .Ve | |
174 | .Sp | |
175 | If \f(CW\*(C`Listen\*(C'\fR is defined then a listen socket is created, else if the | |
176 | socket type, which is derived from the protocol, is \s-1SOCK_STREAM\s0 then | |
177 | \&\fIconnect()\fR is called. | |
178 | .Sp | |
179 | Although it is not illegal, the use of \f(CW\*(C`MultiHomed\*(C'\fR on a socket | |
180 | which is in non-blocking mode is of little use. This is because the | |
181 | first connect will never fail with a timeout as the connect call | |
182 | will not block. | |
183 | .Sp | |
184 | The \f(CW\*(C`PeerAddr\*(C'\fR can be a hostname or the IP-address on the | |
185 | \&\*(L"xx.xx.xx.xx\*(R" form. The \f(CW\*(C`PeerPort\*(C'\fR can be a number or a symbolic | |
186 | service name. The service name might be followed by a number in | |
187 | parenthesis which is used if the service is not known by the system. | |
188 | The \f(CW\*(C`PeerPort\*(C'\fR specification can also be embedded in the \f(CW\*(C`PeerAddr\*(C'\fR | |
189 | by preceding it with a \*(L":\*(R". | |
190 | .Sp | |
191 | If \f(CW\*(C`Proto\*(C'\fR is not given and you specify a symbolic \f(CW\*(C`PeerPort\*(C'\fR port, | |
192 | then the constructor will try to derive \f(CW\*(C`Proto\*(C'\fR from the service | |
193 | name. As a last resort \f(CW\*(C`Proto\*(C'\fR \*(L"tcp\*(R" is assumed. The \f(CW\*(C`Type\*(C'\fR | |
194 | parameter will be deduced from \f(CW\*(C`Proto\*(C'\fR if not specified. | |
195 | .Sp | |
196 | If the constructor is only passed a single argument, it is assumed to | |
197 | be a \f(CW\*(C`PeerAddr\*(C'\fR specification. | |
198 | .Sp | |
199 | If \f(CW\*(C`Blocking\*(C'\fR is set to 0, the connection will be in nonblocking mode. | |
200 | If not specified it defaults to 1 (blocking mode). | |
201 | .Sp | |
202 | Examples: | |
203 | .Sp | |
204 | .Vb 3 | |
205 | \& $sock = IO::Socket::INET->new(PeerAddr => 'www.perl.org', | |
206 | \& PeerPort => 'http(80)', | |
207 | \& Proto => 'tcp'); | |
208 | .Ve | |
209 | .Sp | |
210 | .Vb 1 | |
211 | \& $sock = IO::Socket::INET->new(PeerAddr => 'localhost:smtp(25)'); | |
212 | .Ve | |
213 | .Sp | |
214 | .Vb 4 | |
215 | \& $sock = IO::Socket::INET->new(Listen => 5, | |
216 | \& LocalAddr => 'localhost', | |
217 | \& LocalPort => 9000, | |
218 | \& Proto => 'tcp'); | |
219 | .Ve | |
220 | .Sp | |
221 | .Vb 1 | |
222 | \& $sock = IO::Socket::INET->new('127.0.0.1:25'); | |
223 | .Ve | |
224 | .Sp | |
225 | .Vb 6 | |
226 | \& $sock = IO::Socket::INET->new(PeerPort => 9999, | |
227 | \& PeerAddr => inet_ntoa(INADDR_BROADCAST), | |
228 | \& Proto => udp, | |
229 | \& LocalAddr => 'localhost', | |
230 | \& Broadcast => 1 ) | |
231 | \& or die "Can't bind : $@\en"; | |
232 | .Ve | |
233 | .Sp | |
234 | .Vb 1 | |
235 | \& NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE | |
236 | .Ve | |
237 | .Sp | |
238 | As of \s-1VERSION\s0 1.18 all IO::Socket objects have autoflush turned on | |
239 | by default. This was not the case with earlier releases. | |
240 | .Sp | |
241 | .Vb 1 | |
242 | \& NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE | |
243 | .Ve | |
244 | .Sh "\s-1METHODS\s0" | |
245 | .IX Subsection "METHODS" | |
246 | .IP "sockaddr ()" 4 | |
247 | .IX Item "sockaddr ()" | |
248 | Return the address part of the sockaddr structure for the socket | |
249 | .IP "sockport ()" 4 | |
250 | .IX Item "sockport ()" | |
251 | Return the port number that the socket is using on the local host | |
252 | .IP "sockhost ()" 4 | |
253 | .IX Item "sockhost ()" | |
254 | Return the address part of the sockaddr structure for the socket in a | |
255 | text form xx.xx.xx.xx | |
256 | .IP "peeraddr ()" 4 | |
257 | .IX Item "peeraddr ()" | |
258 | Return the address part of the sockaddr structure for the socket on | |
259 | the peer host | |
260 | .IP "peerport ()" 4 | |
261 | .IX Item "peerport ()" | |
262 | Return the port number for the socket on the peer host. | |
263 | .IP "peerhost ()" 4 | |
264 | .IX Item "peerhost ()" | |
265 | Return the address part of the sockaddr structure for the socket on the | |
266 | peer host in a text form xx.xx.xx.xx | |
267 | .SH "SEE ALSO" | |
268 | .IX Header "SEE ALSO" | |
269 | Socket, IO::Socket | |
270 | .SH "AUTHOR" | |
271 | .IX Header "AUTHOR" | |
272 | Graham Barr. Currently maintained by the Perl Porters. Please report all | |
273 | bugs to <perl5\-porters@perl.org>. | |
274 | .SH "COPYRIGHT" | |
275 | .IX Header "COPYRIGHT" | |
276 | Copyright (c) 1996\-8 Graham Barr <gbarr@pobox.com>. All rights reserved. | |
277 | This program is free software; you can redistribute it and/or | |
278 | modify it under the same terms as Perl itself. |