ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.178 by root, Tue Aug 11 01:15:17 2009 UTC vs.
Revision 1.200 by root, Tue Oct 12 06:47:54 2010 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 3AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent; 7 use AnyEvent;
8 use AnyEvent::Handle; 8 use AnyEvent::Handle;
… …
14 on_error => sub { 14 on_error => sub {
15 my ($hdl, $fatal, $msg) = @_; 15 my ($hdl, $fatal, $msg) = @_;
16 warn "got error $msg\n"; 16 warn "got error $msg\n";
17 $hdl->destroy; 17 $hdl->destroy;
18 $cv->send; 18 $cv->send;
19 ); 19 };
20 20
21 # send some request line 21 # send some request line
22 $hdl->push_write ("getinfo\015\012"); 22 $hdl->push_write ("getinfo\015\012");
23 23
24 # read the response line 24 # read the response line
… …
30 30
31 $cv->recv; 31 $cv->recv;
32 32
33=head1 DESCRIPTION 33=head1 DESCRIPTION
34 34
35This module is a helper module to make it easier to do event-based I/O on 35This is a helper module to make it easier to do event-based I/O on
36filehandles. 36stream-based filehandles (sockets, pipes, and other stream things).
37 37
38The L<AnyEvent::Intro> tutorial contains some well-documented 38The L<AnyEvent::Intro> tutorial contains some well-documented
39AnyEvent::Handle examples. 39AnyEvent::Handle examples.
40 40
41In the following, when the documentation refers to of "bytes" then this 41In the following, where the documentation refers to "bytes", it means
42means characters. As sysread and syswrite are used for all I/O, their 42characters. As sysread and syswrite are used for all I/O, their
43treatment of characters applies to this module as well. 43treatment of characters applies to this module as well.
44 44
45At the very minimum, you should specify C<fh> or C<connect>, and the 45At the very minimum, you should specify C<fh> or C<connect>, and the
46C<on_error> callback. 46C<on_error> callback.
47 47
… …
60use AnyEvent (); BEGIN { AnyEvent::common_sense } 60use AnyEvent (); BEGIN { AnyEvent::common_sense }
61use AnyEvent::Util qw(WSAEWOULDBLOCK); 61use AnyEvent::Util qw(WSAEWOULDBLOCK);
62 62
63our $VERSION = $AnyEvent::VERSION; 63our $VERSION = $AnyEvent::VERSION;
64 64
65sub _load_func($) {
66 my $func = $_[0];
67
68 unless (defined &$func) {
69 my $pkg = $func;
70 do {
71 $pkg =~ s/::[^:]+$//
72 or return;
73 eval "require $pkg";
74 } until defined &$func;
75 }
76
77 \&$func
78}
79
65=head1 METHODS 80=head1 METHODS
66 81
67=over 4 82=over 4
68 83
69=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 84=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
70 85
71The constructor supports these arguments (all as C<< key => value >> pairs). 86The constructor supports these arguments (all as C<< key => value >> pairs).
72 87
73=over 4 88=over 4
74 89
… …
103prepare the file handle with parameters required for the actual connect 118prepare the file handle with parameters required for the actual connect
104(as opposed to settings that can be changed when the connection is already 119(as opposed to settings that can be changed when the connection is already
105established). 120established).
106 121
107The return value of this callback should be the connect timeout value in 122The return value of this callback should be the connect timeout value in
108seconds (or C<0>, or C<undef>, or the empty list, to indicate the default 123seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
109timeout is to be used). 124default timeout is to be used).
110 125
111=item on_connect => $cb->($handle, $host, $port, $retry->()) 126=item on_connect => $cb->($handle, $host, $port, $retry->())
112 127
113This callback is called when a connection has been successfully established. 128This callback is called when a connection has been successfully established.
114 129
115The actual numeric host and port (the socket peername) are passed as 130The peer's numeric host and port (the socket peername) are passed as
116parameters, together with a retry callback. 131parameters, together with a retry callback.
117 132
118When, for some reason, the handle is not acceptable, then calling 133If, for some reason, the handle is not acceptable, calling C<$retry>
119C<$retry> will continue with the next conenction target (in case of 134will continue with the next connection target (in case of multi-homed
120multi-homed hosts or SRV records there can be multiple connection 135hosts or SRV records there can be multiple connection endpoints). At the
121endpoints). When it is called then the read and write queues, eof status, 136time it is called the read and write queues, eof status, tls status and
122tls status and similar properties of the handle are being reset. 137similar properties of the handle will have been reset.
123 138
124In most cases, ignoring the C<$retry> parameter is the way to go. 139In most cases, you should ignore the C<$retry> parameter.
125 140
126=item on_connect_error => $cb->($handle, $message) 141=item on_connect_error => $cb->($handle, $message)
127 142
128This callback is called when the conenction could not be 143This callback is called when the connection could not be
129established. C<$!> will contain the relevant error code, and C<$message> a 144established. C<$!> will contain the relevant error code, and C<$message> a
130message describing it (usually the same as C<"$!">). 145message describing it (usually the same as C<"$!">).
131 146
132If this callback isn't specified, then C<on_error> will be called with a 147If this callback isn't specified, then C<on_error> will be called with a
133fatal error instead. 148fatal error instead.
… …
136 151
137=item on_error => $cb->($handle, $fatal, $message) 152=item on_error => $cb->($handle, $fatal, $message)
138 153
139This is the error callback, which is called when, well, some error 154This is the error callback, which is called when, well, some error
140occured, such as not being able to resolve the hostname, failure to 155occured, such as not being able to resolve the hostname, failure to
141connect or a read error. 156connect, or a read error.
142 157
143Some errors are fatal (which is indicated by C<$fatal> being true). On 158Some errors are fatal (which is indicated by C<$fatal> being true). On
144fatal errors the handle object will be destroyed (by a call to C<< -> 159fatal errors the handle object will be destroyed (by a call to C<< ->
145destroy >>) after invoking the error callback (which means you are free to 160destroy >>) after invoking the error callback (which means you are free to
146examine the handle object). Examples of fatal errors are an EOF condition 161examine the handle object). Examples of fatal errors are an EOF condition
147with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 162with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
148cases where the other side can close the connection at their will it is 163cases where the other side can close the connection at will, it is
149often easiest to not report C<EPIPE> errors in this callback. 164often easiest to not report C<EPIPE> errors in this callback.
150 165
151AnyEvent::Handle tries to find an appropriate error code for you to check 166AnyEvent::Handle tries to find an appropriate error code for you to check
152against, but in some cases (TLS errors), this does not work well. It is 167against, but in some cases (TLS errors), this does not work well. It is
153recommended to always output the C<$message> argument in human-readable 168recommended to always output the C<$message> argument in human-readable
154error messages (it's usually the same as C<"$!">). 169error messages (it's usually the same as C<"$!">).
155 170
156Non-fatal errors can be retried by simply returning, but it is recommended 171Non-fatal errors can be retried by returning, but it is recommended
157to simply ignore this parameter and instead abondon the handle object 172to simply ignore this parameter and instead abondon the handle object
158when this callback is invoked. Examples of non-fatal errors are timeouts 173when this callback is invoked. Examples of non-fatal errors are timeouts
159C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 174C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
160 175
161On callback entrance, the value of C<$!> contains the operating system 176On entry to the callback, the value of C<$!> contains the operating
162error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 177system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
163C<EPROTO>). 178C<EPROTO>).
164 179
165While not mandatory, it is I<highly> recommended to set this callback, as 180While not mandatory, it is I<highly> recommended to set this callback, as
166you will not be notified of errors otherwise. The default simply calls 181you will not be notified of errors otherwise. The default just calls
167C<croak>. 182C<croak>.
168 183
169=item on_read => $cb->($handle) 184=item on_read => $cb->($handle)
170 185
171This sets the default read callback, which is called when data arrives 186This sets the default read callback, which is called when data arrives
… …
176To access (and remove data from) the read buffer, use the C<< ->rbuf >> 191To access (and remove data from) the read buffer, use the C<< ->rbuf >>
177method or access the C<< $handle->{rbuf} >> member directly. Note that you 192method or access the C<< $handle->{rbuf} >> member directly. Note that you
178must not enlarge or modify the read buffer, you can only remove data at 193must not enlarge or modify the read buffer, you can only remove data at
179the beginning from it. 194the beginning from it.
180 195
196You can also call C<< ->push_read (...) >> or any other function that
197modifies the read queue. Or do both. Or ...
198
181When an EOF condition is detected then AnyEvent::Handle will first try to 199When an EOF condition is detected, AnyEvent::Handle will first try to
182feed all the remaining data to the queued callbacks and C<on_read> before 200feed all the remaining data to the queued callbacks and C<on_read> before
183calling the C<on_eof> callback. If no progress can be made, then a fatal 201calling the C<on_eof> callback. If no progress can be made, then a fatal
184error will be raised (with C<$!> set to C<EPIPE>). 202error will be raised (with C<$!> set to C<EPIPE>).
185 203
186Note that, unlike requests in the read queue, an C<on_read> callback 204Note that, unlike requests in the read queue, an C<on_read> callback
… …
205set, then a fatal error will be raised with C<$!> set to <0>. 223set, then a fatal error will be raised with C<$!> set to <0>.
206 224
207=item on_drain => $cb->($handle) 225=item on_drain => $cb->($handle)
208 226
209This sets the callback that is called when the write buffer becomes empty 227This sets the callback that is called when the write buffer becomes empty
210(or when the callback is set and the buffer is empty already). 228(or immediately if the buffer is empty already).
211 229
212To append to the write buffer, use the C<< ->push_write >> method. 230To append to the write buffer, use the C<< ->push_write >> method.
213 231
214This callback is useful when you don't want to put all of your write data 232This callback is useful when you don't want to put all of your write data
215into the queue at once, for example, when you want to write the contents 233into the queue at once, for example, when you want to write the contents
… …
227many seconds pass without a successful read or write on the underlying 245many seconds pass without a successful read or write on the underlying
228file handle (or a call to C<timeout_reset>), the C<on_timeout> callback 246file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
229will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> 247will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
230error will be raised). 248error will be raised).
231 249
232There are three variants of the timeouts that work fully independent 250There are three variants of the timeouts that work independently
233of each other, for both read and write, just read, and just write: 251of each other, for both read and write, just read, and just write:
234C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks 252C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
235C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions 253C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
236C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. 254C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
237 255
238Note that timeout processing is also active when you currently do not have 256Note that timeout processing is active even when you do not have
239any outstanding read or write requests: If you plan to keep the connection 257any outstanding read or write requests: If you plan to keep the connection
240idle then you should disable the timout temporarily or ignore the timeout 258idle then you should disable the timeout temporarily or ignore the timeout
241in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 259in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
242restart the timeout. 260restart the timeout.
243 261
244Zero (the default) disables this timeout. 262Zero (the default) disables this timeout.
245 263
… …
261amount of data without a callback ever being called as long as the line 279amount of data without a callback ever being called as long as the line
262isn't finished). 280isn't finished).
263 281
264=item autocork => <boolean> 282=item autocork => <boolean>
265 283
266When disabled (the default), then C<push_write> will try to immediately 284When disabled (the default), C<push_write> will try to immediately
267write the data to the handle, if possible. This avoids having to register 285write the data to the handle if possible. This avoids having to register
268a write watcher and wait for the next event loop iteration, but can 286a write watcher and wait for the next event loop iteration, but can
269be inefficient if you write multiple small chunks (on the wire, this 287be inefficient if you write multiple small chunks (on the wire, this
270disadvantage is usually avoided by your kernel's nagle algorithm, see 288disadvantage is usually avoided by your kernel's nagle algorithm, see
271C<no_delay>, but this option can save costly syscalls). 289C<no_delay>, but this option can save costly syscalls).
272 290
273When enabled, then writes will always be queued till the next event loop 291When enabled, writes will always be queued till the next event loop
274iteration. This is efficient when you do many small writes per iteration, 292iteration. This is efficient when you do many small writes per iteration,
275but less efficient when you do a single write only per iteration (or when 293but less efficient when you do a single write only per iteration (or when
276the write buffer often is full). It also increases write latency. 294the write buffer often is full). It also increases write latency.
277 295
278=item no_delay => <boolean> 296=item no_delay => <boolean>
… …
282the Nagle algorithm, and usually it is beneficial. 300the Nagle algorithm, and usually it is beneficial.
283 301
284In some situations you want as low a delay as possible, which can be 302In some situations you want as low a delay as possible, which can be
285accomplishd by setting this option to a true value. 303accomplishd by setting this option to a true value.
286 304
287The default is your opertaing system's default behaviour (most likely 305The default is your operating system's default behaviour (most likely
288enabled), this option explicitly enables or disables it, if possible. 306enabled). This option explicitly enables or disables it, if possible.
307
308=item keepalive => <boolean>
309
310Enables (default disable) the SO_KEEPALIVE option on the stream socket:
311normally, TCP connections have no time-out once established, so TCP
312connections, once established, can stay alive forever even when the other
313side has long gone. TCP keepalives are a cheap way to take down long-lived
314TCP connections when the other side becomes unreachable. While the default
315is OS-dependent, TCP keepalives usually kick in after around two hours,
316and, if the other side doesn't reply, take down the TCP connection some 10
317to 15 minutes later.
318
319It is harmless to specify this option for file handles that do not support
320keepalives, and enabling it on connections that are potentially long-lived
321is usually a good idea.
322
323=item oobinline => <boolean>
324
325BSD majorly fucked up the implementation of TCP urgent data. The result
326is that almost no OS implements TCP according to the specs, and every OS
327implements it slightly differently.
328
329If you want to handle TCP urgent data, then setting this flag (the default
330is enabled) gives you the most portable way of getting urgent data, by
331putting it into the stream.
332
333Since BSD emulation of OOB data on top of TCP's urgent data can have
334security implications, AnyEvent::Handle sets this flag automatically
335unless explicitly specified. Note that setting this flag after
336establishing a connection I<may> be a bit too late (data loss could
337already have occured on BSD systems), but at least it will protect you
338from most attacks.
289 339
290=item read_size => <bytes> 340=item read_size => <bytes>
291 341
292The default read block size (the amount of bytes this module will 342The default read block size (the number of bytes this module will
293try to read during each loop iteration, which affects memory 343try to read during each loop iteration, which affects memory
294requirements). Default: C<8192>. 344requirements). Default: C<8192>.
295 345
296=item low_water_mark => <bytes> 346=item low_water_mark => <bytes>
297 347
298Sets the amount of bytes (default: C<0>) that make up an "empty" write 348Sets the number of bytes (default: C<0>) that make up an "empty" write
299buffer: If the write reaches this size or gets even samller it is 349buffer: If the buffer reaches this size or gets even samller it is
300considered empty. 350considered empty.
301 351
302Sometimes it can be beneficial (for performance reasons) to add data to 352Sometimes it can be beneficial (for performance reasons) to add data to
303the write buffer before it is fully drained, but this is a rare case, as 353the write buffer before it is fully drained, but this is a rare case, as
304the operating system kernel usually buffers data as well, so the default 354the operating system kernel usually buffers data as well, so the default
305is good in almost all cases. 355is good in almost all cases.
306 356
307=item linger => <seconds> 357=item linger => <seconds>
308 358
309If non-zero (default: C<3600>), then the destructor of the 359If this is non-zero (default: C<3600>), the destructor of the
310AnyEvent::Handle object will check whether there is still outstanding 360AnyEvent::Handle object will check whether there is still outstanding
311write data and will install a watcher that will write this data to the 361write data and will install a watcher that will write this data to the
312socket. No errors will be reported (this mostly matches how the operating 362socket. No errors will be reported (this mostly matches how the operating
313system treats outstanding data at socket close time). 363system treats outstanding data at socket close time).
314 364
… …
321A string used to identify the remote site - usually the DNS hostname 371A string used to identify the remote site - usually the DNS hostname
322(I<not> IDN!) used to create the connection, rarely the IP address. 372(I<not> IDN!) used to create the connection, rarely the IP address.
323 373
324Apart from being useful in error messages, this string is also used in TLS 374Apart from being useful in error messages, this string is also used in TLS
325peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 375peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
326verification will be skipped when C<peername> is not specified or 376verification will be skipped when C<peername> is not specified or is
327C<undef>. 377C<undef>.
328 378
329=item tls => "accept" | "connect" | Net::SSLeay::SSL object 379=item tls => "accept" | "connect" | Net::SSLeay::SSL object
330 380
331When this parameter is given, it enables TLS (SSL) mode, that means 381When this parameter is given, it enables TLS (SSL) mode, that means
332AnyEvent will start a TLS handshake as soon as the conenction has been 382AnyEvent will start a TLS handshake as soon as the connection has been
333established and will transparently encrypt/decrypt data afterwards. 383established and will transparently encrypt/decrypt data afterwards.
334 384
335All TLS protocol errors will be signalled as C<EPROTO>, with an 385All TLS protocol errors will be signalled as C<EPROTO>, with an
336appropriate error message. 386appropriate error message.
337 387
… …
357B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 407B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
358passing in the wrong integer will lead to certain crash. This most often 408passing in the wrong integer will lead to certain crash. This most often
359happens when one uses a stylish C<< tls => 1 >> and is surprised about the 409happens when one uses a stylish C<< tls => 1 >> and is surprised about the
360segmentation fault. 410segmentation fault.
361 411
362See the C<< ->starttls >> method for when need to start TLS negotiation later. 412Use the C<< ->starttls >> method if you need to start TLS negotiation later.
363 413
364=item tls_ctx => $anyevent_tls 414=item tls_ctx => $anyevent_tls
365 415
366Use the given C<AnyEvent::TLS> object to create the new TLS connection 416Use the given C<AnyEvent::TLS> object to create the new TLS connection
367(unless a connection object was specified directly). If this parameter is 417(unless a connection object was specified directly). If this parameter is
… …
382 432
383TLS handshake failures will not cause C<on_error> to be invoked when this 433TLS handshake failures will not cause C<on_error> to be invoked when this
384callback is in effect, instead, the error message will be passed to C<on_starttls>. 434callback is in effect, instead, the error message will be passed to C<on_starttls>.
385 435
386Without this callback, handshake failures lead to C<on_error> being 436Without this callback, handshake failures lead to C<on_error> being
387called, as normal. 437called as usual.
388 438
389Note that you cannot call C<starttls> right again in this callback. If you 439Note that you cannot just call C<starttls> again in this callback. If you
390need to do that, start an zero-second timer instead whose callback can 440need to do that, start an zero-second timer instead whose callback can
391then call C<< ->starttls >> again. 441then call C<< ->starttls >> again.
392 442
393=item on_stoptls => $cb->($handle) 443=item on_stoptls => $cb->($handle)
394 444
… …
484} 534}
485 535
486sub _start { 536sub _start {
487 my ($self) = @_; 537 my ($self) = @_;
488 538
539 # too many clueless people try to use udp and similar sockets
540 # with AnyEvent::Handle, do them a favour.
541 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
542 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
543 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
544
489 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 545 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
490 546
491 $self->{_activity} = 547 $self->{_activity} =
492 $self->{_ractivity} = 548 $self->{_ractivity} =
493 $self->{_wactivity} = AE::now; 549 $self->{_wactivity} = AE::now;
494 550
495 $self->timeout (delete $self->{timeout} ) if $self->{timeout}; 551 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
496 $self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout}; 552 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
497 $self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout}; 553 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
498 554
499 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 555 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
556 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
500 557
558 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
559
501 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 560 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
502 if $self->{tls}; 561 if $self->{tls};
503 562
504 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 563 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
505 564
506 $self->start_read 565 $self->start_read
507 if $self->{on_read} || @{ $self->{_queue} }; 566 if $self->{on_read} || @{ $self->{_queue} };
508 567
509 $self->_drain_wbuf; 568 $self->_drain_wbuf;
… …
516 $message ||= "$!"; 575 $message ||= "$!";
517 576
518 if ($self->{on_error}) { 577 if ($self->{on_error}) {
519 $self->{on_error}($self, $fatal, $message); 578 $self->{on_error}($self, $fatal, $message);
520 $self->destroy if $fatal; 579 $self->destroy if $fatal;
521 } elsif ($self->{fh}) { 580 } elsif ($self->{fh} || $self->{connect}) {
522 $self->destroy; 581 $self->destroy;
523 Carp::croak "AnyEvent::Handle uncaught error: $message"; 582 Carp::croak "AnyEvent::Handle uncaught error: $message";
524 } 583 }
525} 584}
526 585
… …
585=cut 644=cut
586 645
587sub no_delay { 646sub no_delay {
588 $_[0]{no_delay} = $_[1]; 647 $_[0]{no_delay} = $_[1];
589 648
649 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
650 if $_[0]{fh};
651}
652
653=item $handle->keepalive ($boolean)
654
655Enables or disables the C<keepalive> setting (see constructor argument of
656the same name for details).
657
658=cut
659
660sub keepalive {
661 $_[0]{keepalive} = $_[1];
662
590 eval { 663 eval {
591 local $SIG{__DIE__}; 664 local $SIG{__DIE__};
592 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 665 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
593 if $_[0]{fh}; 666 if $_[0]{fh};
594 }; 667 };
595} 668}
596 669
670=item $handle->oobinline ($boolean)
671
672Enables or disables the C<oobinline> setting (see constructor argument of
673the same name for details).
674
675=cut
676
677sub oobinline {
678 $_[0]{oobinline} = $_[1];
679
680 eval {
681 local $SIG{__DIE__};
682 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
683 if $_[0]{fh};
684 };
685}
686
687=item $handle->keepalive ($boolean)
688
689Enables or disables the C<keepalive> setting (see constructor argument of
690the same name for details).
691
692=cut
693
694sub keepalive {
695 $_[0]{keepalive} = $_[1];
696
697 eval {
698 local $SIG{__DIE__};
699 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
700 if $_[0]{fh};
701 };
702}
703
597=item $handle->on_starttls ($cb) 704=item $handle->on_starttls ($cb)
598 705
599Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 706Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
600 707
601=cut 708=cut
… …
608 715
609Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 716Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
610 717
611=cut 718=cut
612 719
613sub on_starttls { 720sub on_stoptls {
614 $_[0]{on_stoptls} = $_[1]; 721 $_[0]{on_stoptls} = $_[1];
615} 722}
616 723
617=item $handle->rbuf_max ($max_octets) 724=item $handle->rbuf_max ($max_octets)
618 725
… …
730=item $handle->on_drain ($cb) 837=item $handle->on_drain ($cb)
731 838
732Sets the C<on_drain> callback or clears it (see the description of 839Sets the C<on_drain> callback or clears it (see the description of
733C<on_drain> in the constructor). 840C<on_drain> in the constructor).
734 841
842This method may invoke callbacks (and therefore the handle might be
843destroyed after it returns).
844
735=cut 845=cut
736 846
737sub on_drain { 847sub on_drain {
738 my ($self, $cb) = @_; 848 my ($self, $cb) = @_;
739 849
… …
746=item $handle->push_write ($data) 856=item $handle->push_write ($data)
747 857
748Queues the given scalar to be written. You can push as much data as you 858Queues the given scalar to be written. You can push as much data as you
749want (only limited by the available memory), as C<AnyEvent::Handle> 859want (only limited by the available memory), as C<AnyEvent::Handle>
750buffers it independently of the kernel. 860buffers it independently of the kernel.
861
862This method may invoke callbacks (and therefore the handle might be
863destroyed after it returns).
751 864
752=cut 865=cut
753 866
754sub _drain_wbuf { 867sub _drain_wbuf {
755 my ($self) = @_; 868 my ($self) = @_;
… …
785 }; 898 };
786} 899}
787 900
788our %WH; 901our %WH;
789 902
903# deprecated
790sub register_write_type($$) { 904sub register_write_type($$) {
791 $WH{$_[0]} = $_[1]; 905 $WH{$_[0]} = $_[1];
792} 906}
793 907
794sub push_write { 908sub push_write {
795 my $self = shift; 909 my $self = shift;
796 910
797 if (@_ > 1) { 911 if (@_ > 1) {
798 my $type = shift; 912 my $type = shift;
799 913
914 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
800 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 915 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
801 ->($self, @_); 916 ->($self, @_);
802 } 917 }
803 918
919 # we downgrade here to avoid hard-to-track-down bugs,
920 # and diagnose the problem earlier and better.
921
804 if ($self->{tls}) { 922 if ($self->{tls}) {
805 $self->{_tls_wbuf} .= $_[0]; 923 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
806 &_dotls ($self) if $self->{fh}; 924 &_dotls ($self) if $self->{fh};
807 } else { 925 } else {
808 $self->{wbuf} .= $_[0]; 926 utf8::downgrade $self->{wbuf} .= $_[0];
809 $self->_drain_wbuf if $self->{fh}; 927 $self->_drain_wbuf if $self->{fh};
810 } 928 }
811} 929}
812 930
813=item $handle->push_write (type => @args) 931=item $handle->push_write (type => @args)
814 932
815Instead of formatting your data yourself, you can also let this module do 933Instead of formatting your data yourself, you can also let this module
816the job by specifying a type and type-specific arguments. 934do the job by specifying a type and type-specific arguments. You
935can also specify the (fully qualified) name of a package, in which
936case AnyEvent tries to load the package and then expects to find the
937C<anyevent_write_type> function inside (see "custom write types", below).
817 938
818Predefined types are (if you have ideas for additional types, feel free to 939Predefined types are (if you have ideas for additional types, feel free to
819drop by and tell us): 940drop by and tell us):
820 941
821=over 4 942=over 4
… …
878Other languages could read single lines terminated by a newline and pass 999Other languages could read single lines terminated by a newline and pass
879this line into their JSON decoder of choice. 1000this line into their JSON decoder of choice.
880 1001
881=cut 1002=cut
882 1003
1004sub json_coder() {
1005 eval { require JSON::XS; JSON::XS->new->utf8 }
1006 || do { require JSON; JSON->new->utf8 }
1007}
1008
883register_write_type json => sub { 1009register_write_type json => sub {
884 my ($self, $ref) = @_; 1010 my ($self, $ref) = @_;
885 1011
886 require JSON; 1012 my $json = $self->{json} ||= json_coder;
887 1013
888 $self->{json} ? $self->{json}->encode ($ref) 1014 $json->encode ($ref)
889 : JSON::encode_json ($ref)
890}; 1015};
891 1016
892=item storable => $reference 1017=item storable => $reference
893 1018
894Freezes the given reference using L<Storable> and writes it to the 1019Freezes the given reference using L<Storable> and writes it to the
… …
920the peer. 1045the peer.
921 1046
922You can rely on the normal read queue and C<on_eof> handling 1047You can rely on the normal read queue and C<on_eof> handling
923afterwards. This is the cleanest way to close a connection. 1048afterwards. This is the cleanest way to close a connection.
924 1049
1050This method may invoke callbacks (and therefore the handle might be
1051destroyed after it returns).
1052
925=cut 1053=cut
926 1054
927sub push_shutdown { 1055sub push_shutdown {
928 my ($self) = @_; 1056 my ($self) = @_;
929 1057
930 delete $self->{low_water_mark}; 1058 delete $self->{low_water_mark};
931 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1059 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
932} 1060}
933 1061
934=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1062=item custom write types - Package::anyevent_write_type $handle, @args
935 1063
936This function (not method) lets you add your own types to C<push_write>. 1064Instead of one of the predefined types, you can also specify the name of
1065a package. AnyEvent will try to load the package and then expects to find
1066a function named C<anyevent_write_type> inside. If it isn't found, it
1067progressively tries to load the parent package until it either finds the
1068function (good) or runs out of packages (bad).
1069
937Whenever the given C<type> is used, C<push_write> will invoke the code 1070Whenever the given C<type> is used, C<push_write> will the function with
938reference with the handle object and the remaining arguments. 1071the handle object and the remaining arguments.
939 1072
940The code reference is supposed to return a single octet string that will 1073The function is supposed to return a single octet string that will be
941be appended to the write buffer. 1074appended to the write buffer, so you cna mentally treat this function as a
1075"arguments to on-the-wire-format" converter.
942 1076
943Note that this is a function, and all types registered this way will be 1077Example: implement a custom write type C<join> that joins the remaining
944global, so try to use unique names. 1078arguments using the first one.
1079
1080 $handle->push_write (My::Type => " ", 1,2,3);
1081
1082 # uses the following package, which can be defined in the "My::Type" or in
1083 # the "My" modules to be auto-loaded, or just about anywhere when the
1084 # My::Type::anyevent_write_type is defined before invoking it.
1085
1086 package My::Type;
1087
1088 sub anyevent_write_type {
1089 my ($handle, $delim, @args) = @_;
1090
1091 join $delim, @args
1092 }
945 1093
946=cut 1094=cut
947 1095
948############################################################################# 1096#############################################################################
949 1097
… …
958ways, the "simple" way, using only C<on_read> and the "complex" way, using 1106ways, the "simple" way, using only C<on_read> and the "complex" way, using
959a queue. 1107a queue.
960 1108
961In the simple case, you just install an C<on_read> callback and whenever 1109In the simple case, you just install an C<on_read> callback and whenever
962new data arrives, it will be called. You can then remove some data (if 1110new data arrives, it will be called. You can then remove some data (if
963enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1111enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
964leave the data there if you want to accumulate more (e.g. when only a 1112leave the data there if you want to accumulate more (e.g. when only a
965partial message has been received so far). 1113partial message has been received so far), or change the read queue with
1114e.g. C<push_read>.
966 1115
967In the more complex case, you want to queue multiple callbacks. In this 1116In the more complex case, you want to queue multiple callbacks. In this
968case, AnyEvent::Handle will call the first queued callback each time new 1117case, AnyEvent::Handle will call the first queued callback each time new
969data arrives (also the first time it is queued) and removes it when it has 1118data arrives (also the first time it is queued) and remove it when it has
970done its job (see C<push_read>, below). 1119done its job (see C<push_read>, below).
971 1120
972This way you can, for example, push three line-reads, followed by reading 1121This way you can, for example, push three line-reads, followed by reading
973a chunk of data, and AnyEvent::Handle will execute them in order. 1122a chunk of data, and AnyEvent::Handle will execute them in order.
974 1123
… …
1105 1254
1106This replaces the currently set C<on_read> callback, or clears it (when 1255This replaces the currently set C<on_read> callback, or clears it (when
1107the new callback is C<undef>). See the description of C<on_read> in the 1256the new callback is C<undef>). See the description of C<on_read> in the
1108constructor. 1257constructor.
1109 1258
1259This method may invoke callbacks (and therefore the handle might be
1260destroyed after it returns).
1261
1110=cut 1262=cut
1111 1263
1112sub on_read { 1264sub on_read {
1113 my ($self, $cb) = @_; 1265 my ($self, $cb) = @_;
1114 1266
… …
1116 $self->_drain_rbuf if $cb; 1268 $self->_drain_rbuf if $cb;
1117} 1269}
1118 1270
1119=item $handle->rbuf 1271=item $handle->rbuf
1120 1272
1121Returns the read buffer (as a modifiable lvalue). 1273Returns the read buffer (as a modifiable lvalue). You can also access the
1274read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1275much faster, and no less clean).
1122 1276
1123You can access the read buffer directly as the C<< ->{rbuf} >> 1277The only operation allowed on the read buffer (apart from looking at it)
1124member, if you want. However, the only operation allowed on the 1278is removing data from its beginning. Otherwise modifying or appending to
1125read buffer (apart from looking at it) is removing data from its 1279it is not allowed and will lead to hard-to-track-down bugs.
1126beginning. Otherwise modifying or appending to it is not allowed and will
1127lead to hard-to-track-down bugs.
1128 1280
1129NOTE: The read buffer should only be used or modified if the C<on_read>, 1281NOTE: The read buffer should only be used or modified in the C<on_read>
1130C<push_read> or C<unshift_read> methods are used. The other read methods 1282callback or when C<push_read> or C<unshift_read> are used with a single
1131automatically manage the read buffer. 1283callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1284will manage the read buffer on their own.
1132 1285
1133=cut 1286=cut
1134 1287
1135sub rbuf : lvalue { 1288sub rbuf : lvalue {
1136 $_[0]{rbuf} 1289 $_[0]{rbuf}
… …
1153 1306
1154If enough data was available, then the callback must remove all data it is 1307If enough data was available, then the callback must remove all data it is
1155interested in (which can be none at all) and return a true value. After returning 1308interested in (which can be none at all) and return a true value. After returning
1156true, it will be removed from the queue. 1309true, it will be removed from the queue.
1157 1310
1311These methods may invoke callbacks (and therefore the handle might be
1312destroyed after it returns).
1313
1158=cut 1314=cut
1159 1315
1160our %RH; 1316our %RH;
1161 1317
1162sub register_read_type($$) { 1318sub register_read_type($$) {
… …
1168 my $cb = pop; 1324 my $cb = pop;
1169 1325
1170 if (@_) { 1326 if (@_) {
1171 my $type = shift; 1327 my $type = shift;
1172 1328
1329 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1173 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1330 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1174 ->($self, $cb, @_); 1331 ->($self, $cb, @_);
1175 } 1332 }
1176 1333
1177 push @{ $self->{_queue} }, $cb; 1334 push @{ $self->{_queue} }, $cb;
1178 $self->_drain_rbuf; 1335 $self->_drain_rbuf;
… …
1183 my $cb = pop; 1340 my $cb = pop;
1184 1341
1185 if (@_) { 1342 if (@_) {
1186 my $type = shift; 1343 my $type = shift;
1187 1344
1345 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1188 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1346 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1189 ->($self, $cb, @_); 1347 ->($self, $cb, @_);
1190 } 1348 }
1191
1192 1349
1193 unshift @{ $self->{_queue} }, $cb; 1350 unshift @{ $self->{_queue} }, $cb;
1194 $self->_drain_rbuf; 1351 $self->_drain_rbuf;
1195} 1352}
1196 1353
… …
1198 1355
1199=item $handle->unshift_read (type => @args, $cb) 1356=item $handle->unshift_read (type => @args, $cb)
1200 1357
1201Instead of providing a callback that parses the data itself you can chose 1358Instead of providing a callback that parses the data itself you can chose
1202between a number of predefined parsing formats, for chunks of data, lines 1359between a number of predefined parsing formats, for chunks of data, lines
1203etc. 1360etc. You can also specify the (fully qualified) name of a package, in
1361which case AnyEvent tries to load the package and then expects to find the
1362C<anyevent_read_type> function inside (see "custom read types", below).
1204 1363
1205Predefined types are (if you have ideas for additional types, feel free to 1364Predefined types are (if you have ideas for additional types, feel free to
1206drop by and tell us): 1365drop by and tell us):
1207 1366
1208=over 4 1367=over 4
… …
1300the receive buffer when neither C<$accept> nor C<$reject> match, 1459the receive buffer when neither C<$accept> nor C<$reject> match,
1301and everything preceding and including the match will be accepted 1460and everything preceding and including the match will be accepted
1302unconditionally. This is useful to skip large amounts of data that you 1461unconditionally. This is useful to skip large amounts of data that you
1303know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1462know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1304have to start matching from the beginning. This is purely an optimisation 1463have to start matching from the beginning. This is purely an optimisation
1305and is usually worth only when you expect more than a few kilobytes. 1464and is usually worth it only when you expect more than a few kilobytes.
1306 1465
1307Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1466Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1308expect the header to be very large (it isn't in practise, but...), we use 1467expect the header to be very large (it isn't in practice, but...), we use
1309a skip regex to skip initial portions. The skip regex is tricky in that 1468a skip regex to skip initial portions. The skip regex is tricky in that
1310it only accepts something not ending in either \015 or \012, as these are 1469it only accepts something not ending in either \015 or \012, as these are
1311required for the accept regex. 1470required for the accept regex.
1312 1471
1313 $handle->push_read (regex => 1472 $handle->push_read (regex =>
… …
1448=cut 1607=cut
1449 1608
1450register_read_type json => sub { 1609register_read_type json => sub {
1451 my ($self, $cb) = @_; 1610 my ($self, $cb) = @_;
1452 1611
1453 my $json = $self->{json} ||= 1612 my $json = $self->{json} ||= json_coder;
1454 eval { require JSON::XS; JSON::XS->new->utf8 }
1455 || do { require JSON; JSON->new->utf8 };
1456 1613
1457 my $data; 1614 my $data;
1458 my $rbuf = \$self->{rbuf}; 1615 my $rbuf = \$self->{rbuf};
1459 1616
1460 sub { 1617 sub {
… …
1529 } 1686 }
1530}; 1687};
1531 1688
1532=back 1689=back
1533 1690
1534=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1691=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1535 1692
1536This function (not method) lets you add your own types to C<push_read>. 1693Instead of one of the predefined types, you can also specify the name
1694of a package. AnyEvent will try to load the package and then expects to
1695find a function named C<anyevent_read_type> inside. If it isn't found, it
1696progressively tries to load the parent package until it either finds the
1697function (good) or runs out of packages (bad).
1537 1698
1538Whenever the given C<type> is used, C<push_read> will invoke the code 1699Whenever this type is used, C<push_read> will invoke the function with the
1539reference with the handle object, the callback and the remaining 1700handle object, the original callback and the remaining arguments.
1540arguments.
1541 1701
1542The code reference is supposed to return a callback (usually a closure) 1702The function is supposed to return a callback (usually a closure) that
1543that works as a plain read callback (see C<< ->push_read ($cb) >>). 1703works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1704mentally treat the function as a "configurable read type to read callback"
1705converter.
1544 1706
1545It should invoke the passed callback when it is done reading (remember to 1707It should invoke the original callback when it is done reading (remember
1546pass C<$handle> as first argument as all other callbacks do that). 1708to pass C<$handle> as first argument as all other callbacks do that,
1709although there is no strict requirement on this).
1547 1710
1548Note that this is a function, and all types registered this way will be
1549global, so try to use unique names.
1550
1551For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1711For examples, see the source of this module (F<perldoc -m
1552search for C<register_read_type>)). 1712AnyEvent::Handle>, search for C<register_read_type>)).
1553 1713
1554=item $handle->stop_read 1714=item $handle->stop_read
1555 1715
1556=item $handle->start_read 1716=item $handle->start_read
1557 1717
… …
1577} 1737}
1578 1738
1579sub start_read { 1739sub start_read {
1580 my ($self) = @_; 1740 my ($self) = @_;
1581 1741
1582 unless ($self->{_rw} || $self->{_eof}) { 1742 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1583 Scalar::Util::weaken $self; 1743 Scalar::Util::weaken $self;
1584 1744
1585 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1745 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1586 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1746 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1587 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1747 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
… …
1680 && ($tmp != $ERROR_SYSCALL || $!); 1840 && ($tmp != $ERROR_SYSCALL || $!);
1681 1841
1682 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1842 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1683 $self->{wbuf} .= $tmp; 1843 $self->{wbuf} .= $tmp;
1684 $self->_drain_wbuf; 1844 $self->_drain_wbuf;
1845 $self->{tls} or return; # tls session might have gone away in callback
1685 } 1846 }
1686 1847
1687 $self->{_on_starttls} 1848 $self->{_on_starttls}
1688 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1849 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1689 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1850 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1711context in C<< $handle->{tls_ctx} >> after this call and can be used or 1872context in C<< $handle->{tls_ctx} >> after this call and can be used or
1712changed to your liking. Note that the handshake might have already started 1873changed to your liking. Note that the handshake might have already started
1713when this function returns. 1874when this function returns.
1714 1875
1715Due to bugs in OpenSSL, it might or might not be possible to do multiple 1876Due to bugs in OpenSSL, it might or might not be possible to do multiple
1716handshakes on the same stream. Best do not attempt to use the stream after 1877handshakes on the same stream. It is best to not attempt to use the
1717stopping TLS. 1878stream after stopping TLS.
1879
1880This method may invoke callbacks (and therefore the handle might be
1881destroyed after it returns).
1718 1882
1719=cut 1883=cut
1720 1884
1721our %TLS_CACHE; #TODO not yet documented, should we? 1885our %TLS_CACHE; #TODO not yet documented, should we?
1722 1886
… …
1734 require Net::SSLeay; 1898 require Net::SSLeay;
1735 1899
1736 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1900 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1737 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1901 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1738 1902
1739 $tls = $self->{tls}; 1903 $tls = delete $self->{tls};
1740 $ctx = $self->{tls_ctx}; 1904 $ctx = $self->{tls_ctx};
1741 1905
1742 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1906 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1743 1907
1744 if ("HASH" eq ref $ctx) { 1908 if ("HASH" eq ref $ctx) {
… …
1788 1952
1789=item $handle->stoptls 1953=item $handle->stoptls
1790 1954
1791Shuts down the SSL connection - this makes a proper EOF handshake by 1955Shuts down the SSL connection - this makes a proper EOF handshake by
1792sending a close notify to the other side, but since OpenSSL doesn't 1956sending a close notify to the other side, but since OpenSSL doesn't
1793support non-blocking shut downs, it is not guarenteed that you can re-use 1957support non-blocking shut downs, it is not guaranteed that you can re-use
1794the stream afterwards. 1958the stream afterwards.
1959
1960This method may invoke callbacks (and therefore the handle might be
1961destroyed after it returns).
1795 1962
1796=cut 1963=cut
1797 1964
1798sub stoptls { 1965sub stoptls {
1799 my ($self) = @_; 1966 my ($self) = @_;
1800 1967
1801 if ($self->{tls}) { 1968 if ($self->{tls} && $self->{fh}) {
1802 Net::SSLeay::shutdown ($self->{tls}); 1969 Net::SSLeay::shutdown ($self->{tls});
1803 1970
1804 &_dotls; 1971 &_dotls;
1805 1972
1806# # we don't give a shit. no, we do, but we can't. no...#d# 1973# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1883 2050
1884sub AnyEvent::Handle::destroyed::AUTOLOAD { 2051sub AnyEvent::Handle::destroyed::AUTOLOAD {
1885 #nop 2052 #nop
1886} 2053}
1887 2054
2055=item $handle->destroyed
2056
2057Returns false as long as the handle hasn't been destroyed by a call to C<<
2058->destroy >>, true otherwise.
2059
2060Can be useful to decide whether the handle is still valid after some
2061callback possibly destroyed the handle. For example, C<< ->push_write >>,
2062C<< ->starttls >> and other methods can call user callbacks, which in turn
2063can destroy the handle, so work can be avoided by checking sometimes:
2064
2065 $hdl->starttls ("accept");
2066 return if $hdl->destroyed;
2067 $hdl->push_write (...
2068
2069Note that the call to C<push_write> will silently be ignored if the handle
2070has been destroyed, so often you can just ignore the possibility of the
2071handle being destroyed.
2072
2073=cut
2074
2075sub destroyed { 0 }
2076sub AnyEvent::Handle::destroyed::destroyed { 1 }
2077
1888=item AnyEvent::Handle::TLS_CTX 2078=item AnyEvent::Handle::TLS_CTX
1889 2079
1890This function creates and returns the AnyEvent::TLS object used by default 2080This function creates and returns the AnyEvent::TLS object used by default
1891for TLS mode. 2081for TLS mode.
1892 2082
… …
1923 2113
1924=item I get different callback invocations in TLS mode/Why can't I pause 2114=item I get different callback invocations in TLS mode/Why can't I pause
1925reading? 2115reading?
1926 2116
1927Unlike, say, TCP, TLS connections do not consist of two independent 2117Unlike, say, TCP, TLS connections do not consist of two independent
1928communication channels, one for each direction. Or put differently. The 2118communication channels, one for each direction. Or put differently, the
1929read and write directions are not independent of each other: you cannot 2119read and write directions are not independent of each other: you cannot
1930write data unless you are also prepared to read, and vice versa. 2120write data unless you are also prepared to read, and vice versa.
1931 2121
1932This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2122This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1933callback invocations when you are not expecting any read data - the reason 2123callback invocations when you are not expecting any read data - the reason
1934is that AnyEvent::Handle always reads in TLS mode. 2124is that AnyEvent::Handle always reads in TLS mode.
1935 2125
1936During the connection, you have to make sure that you always have a 2126During the connection, you have to make sure that you always have a
1937non-empty read-queue, or an C<on_read> watcher. At the end of the 2127non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1951 my $data = delete $_[0]{rbuf}; 2141 my $data = delete $_[0]{rbuf};
1952 }); 2142 });
1953 2143
1954The reason to use C<on_error> is that TCP connections, due to latencies 2144The reason to use C<on_error> is that TCP connections, due to latencies
1955and packets loss, might get closed quite violently with an error, when in 2145and packets loss, might get closed quite violently with an error, when in
1956fact, all data has been received. 2146fact all data has been received.
1957 2147
1958It is usually better to use acknowledgements when transferring data, 2148It is usually better to use acknowledgements when transferring data,
1959to make sure the other side hasn't just died and you got the data 2149to make sure the other side hasn't just died and you got the data
1960intact. This is also one reason why so many internet protocols have an 2150intact. This is also one reason why so many internet protocols have an
1961explicit QUIT command. 2151explicit QUIT command.
… …
1978consider using C<< ->push_shutdown >> instead. 2168consider using C<< ->push_shutdown >> instead.
1979 2169
1980=item I want to contact a TLS/SSL server, I don't care about security. 2170=item I want to contact a TLS/SSL server, I don't care about security.
1981 2171
1982If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2172If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1983simply connect to it and then create the AnyEvent::Handle with the C<tls> 2173connect to it and then create the AnyEvent::Handle with the C<tls>
1984parameter: 2174parameter:
1985 2175
1986 tcp_connect $host, $port, sub { 2176 tcp_connect $host, $port, sub {
1987 my ($fh) = @_; 2177 my ($fh) = @_;
1988 2178
… …
2088 2278
2089=item * all members not documented here and not prefixed with an underscore 2279=item * all members not documented here and not prefixed with an underscore
2090are free to use in subclasses. 2280are free to use in subclasses.
2091 2281
2092Of course, new versions of AnyEvent::Handle may introduce more "public" 2282Of course, new versions of AnyEvent::Handle may introduce more "public"
2093member variables, but thats just life, at least it is documented. 2283member variables, but that's just life. At least it is documented.
2094 2284
2095=back 2285=back
2096 2286
2097=head1 AUTHOR 2287=head1 AUTHOR
2098 2288

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines