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.9 by root, Fri May 2 16:07:46 2008 UTC vs.
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC

1package AnyEvent::Handle; 1package AnyEvent::Handle;
2 2
3no warnings; 3no warnings;
4use strict; 4use strict qw(subs vars);
5 5
6use AnyEvent (); 6use AnyEvent ();
7use AnyEvent::Util (); 7use AnyEvent::Util qw(WSAEWOULDBLOCK);
8use Scalar::Util (); 8use Scalar::Util ();
9use Carp (); 9use Carp ();
10use Fcntl (); 10use Fcntl ();
11use Errno qw/EAGAIN EINTR/; 11use Errno qw(EAGAIN EINTR);
12 12
13=head1 NAME 13=head1 NAME
14 14
15AnyEvent::Handle - non-blocking I/O on filehandles via AnyEvent 15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 16
17=cut 17=cut
18 18
19our $VERSION = '0.02'; 19our $VERSION = 4.82;
20 20
21=head1 SYNOPSIS 21=head1 SYNOPSIS
22 22
23 use AnyEvent; 23 use AnyEvent;
24 use AnyEvent::Handle; 24 use AnyEvent::Handle;
25 25
26 my $cv = AnyEvent->condvar; 26 my $cv = AnyEvent->condvar;
27 27
28 my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); 28 my $hdl; $hdl = new AnyEvent::Handle
29
30 #TODO
31
32 # or use the constructor to pass the callback:
33
34 my $ae_fh2 =
35 AnyEvent::Handle->new (
36 fh => \*STDIN, 29 fh => \*STDIN,
37 on_eof => sub { 30 on_error => sub {
38 $cv->broadcast; 31 warn "got error $_[2]\n";
39 }, 32 $cv->send;
40 #TODO
41 ); 33 );
42 34
43 $cv->wait; 35 # send some request line
36 $hdl->push_write ("getinfo\015\012");
37
38 # read the response line
39 $hdl->push_read (line => sub {
40 my ($hdl, $line) = @_;
41 warn "got line <$line>\n";
42 $cv->send;
43 });
44
45 $cv->recv;
44 46
45=head1 DESCRIPTION 47=head1 DESCRIPTION
46 48
47This module is a helper module to make it easier to do event-based I/O on 49This module is a helper module to make it easier to do event-based I/O on
48filehandles (and sockets, see L<AnyEvent::Socket> for an easy way to make 50filehandles. For utility functions for doing non-blocking connects and accepts
49non-blocking resolves and connects). 51on sockets see L<AnyEvent::Util>.
52
53The L<AnyEvent::Intro> tutorial contains some well-documented
54AnyEvent::Handle examples.
50 55
51In the following, when the documentation refers to of "bytes" then this 56In the following, when the documentation refers to of "bytes" then this
52means characters. As sysread and syswrite are used for all I/O, their 57means characters. As sysread and syswrite are used for all I/O, their
53treatment of characters applies to this module as well. 58treatment of characters applies to this module as well.
54 59
57 62
58=head1 METHODS 63=head1 METHODS
59 64
60=over 4 65=over 4
61 66
62=item B<new (%args)> 67=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
63 68
64The constructor supports these arguments (all as key => value pairs). 69The constructor supports these arguments (all as C<< key => value >> pairs).
65 70
66=over 4 71=over 4
67 72
68=item fh => $filehandle [MANDATORY] 73=item fh => $filehandle [MANDATORY]
69 74
70The filehandle this L<AnyEvent::Handle> object will operate on. 75The filehandle this L<AnyEvent::Handle> object will operate on.
71 76
72NOTE: The filehandle will be set to non-blocking (using 77NOTE: The filehandle will be set to non-blocking mode (using
73AnyEvent::Util::fh_nonblocking). 78C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
79that mode.
74 80
75=item on_error => $cb->($self) [MANDATORY] 81=item on_eof => $cb->($handle)
76 82
77This is the fatal error callback, that is called when a fatal error ocurs, 83Set the callback to be called when an end-of-file condition is detected,
84i.e. in the case of a socket, when the other side has closed the
85connection cleanly, and there are no outstanding read requests in the
86queue (if there are read requests, then an EOF counts as an unexpected
87connection close and will be flagged as an error).
88
89For sockets, this just means that the other side has stopped sending data,
90you can still try to write data, and, in fact, one can return from the EOF
91callback and continue writing data, as only the read part has been shut
92down.
93
94If an EOF condition has been detected but no C<on_eof> callback has been
95set, then a fatal error will be raised with C<$!> set to <0>.
96
97=item on_error => $cb->($handle, $fatal, $message)
98
99This is the error callback, which is called when, well, some error
78such as not being able to resolve the hostname, failure to connect or a 100occured, such as not being able to resolve the hostname, failure to
79read error. 101connect or a read error.
80 102
81The object will not be in a usable state when this callback has been 103Some errors are fatal (which is indicated by C<$fatal> being true). On
82called. 104fatal errors the handle object will be destroyed (by a call to C<< ->
105destroy >>) after invoking the error callback (which means you are free to
106examine the handle object). Examples of fatal errors are an EOF condition
107with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
83 108
109AnyEvent::Handle tries to find an appropriate error code for you to check
110against, but in some cases (TLS errors), this does not work well. It is
111recommended to always output the C<$message> argument in human-readable
112error messages (it's usually the same as C<"$!">).
113
114Non-fatal errors can be retried by simply returning, but it is recommended
115to simply ignore this parameter and instead abondon the handle object
116when this callback is invoked. Examples of non-fatal errors are timeouts
117C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
118
84On callback entrance, the value of C<$!> contains the opertaing system 119On callback entrance, the value of C<$!> contains the operating system
85error (or C<ENOSPC> or C<EPIPE>). 120error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
121C<EPROTO>).
86 122
87=item on_eof => $cb->($self) [MANDATORY] 123While not mandatory, it is I<highly> recommended to set this callback, as
124you will not be notified of errors otherwise. The default simply calls
125C<croak>.
88 126
89Set the callback to be called on EOF.
90
91=item on_read => $cb->($self) 127=item on_read => $cb->($handle)
92 128
93This sets the default read callback, which is called when data arrives 129This sets the default read callback, which is called when data arrives
94and no read request is in the queue. If the read callback is C<undef> 130and no read request is in the queue (unlike read queue callbacks, this
95or has never been set, than AnyEvent::Handle will cease reading from the 131callback will only be called when at least one octet of data is in the
96filehandle. 132read buffer).
97 133
98To access (and remove data from) the read buffer, use the C<< ->rbuf >> 134To access (and remove data from) the read buffer, use the C<< ->rbuf >>
99method or acces sthe C<$self->{rbuf}> member directly. 135method or access the C<< $handle->{rbuf} >> member directly. Note that you
136must not enlarge or modify the read buffer, you can only remove data at
137the beginning from it.
100 138
101When an EOF condition is detected then AnyEvent::Handle will first try to 139When an EOF condition is detected then AnyEvent::Handle will first try to
102feed all the remaining data to the queued callbacks and C<on_read> before 140feed all the remaining data to the queued callbacks and C<on_read> before
103calling the C<on_eof> callback. If no progress can be made, then a fatal 141calling the C<on_eof> callback. If no progress can be made, then a fatal
104error will be raised (with C<$!> set to C<EPIPE>). 142error will be raised (with C<$!> set to C<EPIPE>).
105 143
144Note that, unlike requests in the read queue, an C<on_read> callback
145doesn't mean you I<require> some data: if there is an EOF and there
146are outstanding read requests then an error will be flagged. With an
147C<on_read> callback, the C<on_eof> callback will be invoked.
148
106=item on_drain => $cb->() 149=item on_drain => $cb->($handle)
107 150
108This sets the callback that is called when the write buffer becomes empty 151This sets the callback that is called when the write buffer becomes empty
109(or when the callback is set and the buffer is empty already). 152(or when the callback is set and the buffer is empty already).
110 153
111To append to the write buffer, use the C<< ->push_write >> method. 154To append to the write buffer, use the C<< ->push_write >> method.
112 155
156This callback is useful when you don't want to put all of your write data
157into the queue at once, for example, when you want to write the contents
158of some file to the socket you might not want to read the whole file into
159memory and push it into the queue, but instead only read more data from
160the file when the write queue becomes empty.
161
162=item timeout => $fractional_seconds
163
164If non-zero, then this enables an "inactivity" timeout: whenever this many
165seconds pass without a successful read or write on the underlying file
166handle, the C<on_timeout> callback will be invoked (and if that one is
167missing, a non-fatal C<ETIMEDOUT> error will be raised).
168
169Note that timeout processing is also active when you currently do not have
170any outstanding read or write requests: If you plan to keep the connection
171idle then you should disable the timout temporarily or ignore the timeout
172in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
173restart the timeout.
174
175Zero (the default) disables this timeout.
176
177=item on_timeout => $cb->($handle)
178
179Called whenever the inactivity timeout passes. If you return from this
180callback, then the timeout will be reset as if some activity had happened,
181so this condition is not fatal in any way.
182
113=item rbuf_max => <bytes> 183=item rbuf_max => <bytes>
114 184
115If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) 185If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
116when the read buffer ever (strictly) exceeds this size. This is useful to 186when the read buffer ever (strictly) exceeds this size. This is useful to
117avoid denial-of-service attacks. 187avoid some forms of denial-of-service attacks.
118 188
119For example, a server accepting connections from untrusted sources should 189For example, a server accepting connections from untrusted sources should
120be configured to accept only so-and-so much data that it cannot act on 190be configured to accept only so-and-so much data that it cannot act on
121(for example, when expecting a line, an attacker could send an unlimited 191(for example, when expecting a line, an attacker could send an unlimited
122amount of data without a callback ever being called as long as the line 192amount of data without a callback ever being called as long as the line
123isn't finished). 193isn't finished).
124 194
195=item autocork => <boolean>
196
197When disabled (the default), then C<push_write> will try to immediately
198write the data to the handle, if possible. This avoids having to register
199a write watcher and wait for the next event loop iteration, but can
200be inefficient if you write multiple small chunks (on the wire, this
201disadvantage is usually avoided by your kernel's nagle algorithm, see
202C<no_delay>, but this option can save costly syscalls).
203
204When enabled, then writes will always be queued till the next event loop
205iteration. This is efficient when you do many small writes per iteration,
206but less efficient when you do a single write only per iteration (or when
207the write buffer often is full). It also increases write latency.
208
209=item no_delay => <boolean>
210
211When doing small writes on sockets, your operating system kernel might
212wait a bit for more data before actually sending it out. This is called
213the Nagle algorithm, and usually it is beneficial.
214
215In some situations you want as low a delay as possible, which can be
216accomplishd by setting this option to a true value.
217
218The default is your opertaing system's default behaviour (most likely
219enabled), this option explicitly enables or disables it, if possible.
220
125=item read_size => <bytes> 221=item read_size => <bytes>
126 222
127The default read block size (the amount of bytes this module will try to read 223The default read block size (the amount of bytes this module will
128on each [loop iteration). Default: C<4096>. 224try to read during each loop iteration, which affects memory
225requirements). Default: C<8192>.
129 226
130=item low_water_mark => <bytes> 227=item low_water_mark => <bytes>
131 228
132Sets the amount of bytes (default: C<0>) that make up an "empty" write 229Sets the amount of bytes (default: C<0>) that make up an "empty" write
133buffer: If the write reaches this size or gets even samller it is 230buffer: If the write reaches this size or gets even samller it is
134considered empty. 231considered empty.
135 232
233Sometimes it can be beneficial (for performance reasons) to add data to
234the write buffer before it is fully drained, but this is a rare case, as
235the operating system kernel usually buffers data as well, so the default
236is good in almost all cases.
237
238=item linger => <seconds>
239
240If non-zero (default: C<3600>), then the destructor of the
241AnyEvent::Handle object will check whether there is still outstanding
242write data and will install a watcher that will write this data to the
243socket. No errors will be reported (this mostly matches how the operating
244system treats outstanding data at socket close time).
245
246This will not work for partial TLS data that could not be encoded
247yet. This data will be lost. Calling the C<stoptls> method in time might
248help.
249
250=item peername => $string
251
252A string used to identify the remote site - usually the DNS hostname
253(I<not> IDN!) used to create the connection, rarely the IP address.
254
255Apart from being useful in error messages, this string is also used in TLS
256peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
257verification will be skipped when C<peername> is not specified or
258C<undef>.
259
260=item tls => "accept" | "connect" | Net::SSLeay::SSL object
261
262When this parameter is given, it enables TLS (SSL) mode, that means
263AnyEvent will start a TLS handshake as soon as the conenction has been
264established and will transparently encrypt/decrypt data afterwards.
265
266All TLS protocol errors will be signalled as C<EPROTO>, with an
267appropriate error message.
268
269TLS mode requires Net::SSLeay to be installed (it will be loaded
270automatically when you try to create a TLS handle): this module doesn't
271have a dependency on that module, so if your module requires it, you have
272to add the dependency yourself.
273
274Unlike TCP, TLS has a server and client side: for the TLS server side, use
275C<accept>, and for the TLS client side of a connection, use C<connect>
276mode.
277
278You can also provide your own TLS connection object, but you have
279to make sure that you call either C<Net::SSLeay::set_connect_state>
280or C<Net::SSLeay::set_accept_state> on it before you pass it to
281AnyEvent::Handle. Also, this module will take ownership of this connection
282object.
283
284At some future point, AnyEvent::Handle might switch to another TLS
285implementation, then the option to use your own session object will go
286away.
287
288B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
289passing in the wrong integer will lead to certain crash. This most often
290happens when one uses a stylish C<< tls => 1 >> and is surprised about the
291segmentation fault.
292
293See the C<< ->starttls >> method for when need to start TLS negotiation later.
294
295=item tls_ctx => $anyevent_tls
296
297Use the given C<AnyEvent::TLS> object to create the new TLS connection
298(unless a connection object was specified directly). If this parameter is
299missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
300
301Instead of an object, you can also specify a hash reference with C<< key
302=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
303new TLS context object.
304
305=item on_starttls => $cb->($handle, $success[, $error_message])
306
307This callback will be invoked when the TLS/SSL handshake has finished. If
308C<$success> is true, then the TLS handshake succeeded, otherwise it failed
309(C<on_stoptls> will not be called in this case).
310
311The session in C<< $handle->{tls} >> can still be examined in this
312callback, even when the handshake was not successful.
313
314TLS handshake failures will not cause C<on_error> to be invoked when this
315callback is in effect, instead, the error message will be passed to C<on_starttls>.
316
317Without this callback, handshake failures lead to C<on_error> being
318called, as normal.
319
320Note that you cannot call C<starttls> right again in this callback. If you
321need to do that, start an zero-second timer instead whose callback can
322then call C<< ->starttls >> again.
323
324=item on_stoptls => $cb->($handle)
325
326When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
327set, then it will be invoked after freeing the TLS session. If it is not,
328then a TLS shutdown condition will be treated like a normal EOF condition
329on the handle.
330
331The session in C<< $handle->{tls} >> can still be examined in this
332callback.
333
334This callback will only be called on TLS shutdowns, not when the
335underlying handle signals EOF.
336
337=item json => JSON or JSON::XS object
338
339This is the json coder object used by the C<json> read and write types.
340
341If you don't supply it, then AnyEvent::Handle will create and use a
342suitable one (on demand), which will write and expect UTF-8 encoded JSON
343texts.
344
345Note that you are responsible to depend on the JSON module if you want to
346use this functionality, as AnyEvent does not have a dependency itself.
347
136=back 348=back
137 349
138=cut 350=cut
139 351
140sub new { 352sub new {
141 my $class = shift; 353 my $class = shift;
142
143 my $self = bless { @_ }, $class; 354 my $self = bless { @_ }, $class;
144 355
145 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 356 $self->{fh} or Carp::croak "mandatory argument fh is missing";
146 357
147 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 358 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
148 359
149 $self->on_error ((delete $self->{on_error}) or Carp::croak "mandatory argument on_error is missing"); 360 $self->{_activity} = AnyEvent->now;
150 $self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing"); 361 $self->_timeout;
362
363 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
364
365 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
366 if $self->{tls};
151 367
152 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 368 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
153 $self->on_read (delete $self->{on_read} ) if $self->{on_read};
154 369
155 $self 370 $self->start_read
156} 371 if $self->{on_read};
157 372
373 $self->{fh} && $self
374}
375
158sub _shutdown { 376#sub _shutdown {
159 my ($self) = @_; 377# my ($self) = @_;
378#
379# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
380# $self->{_eof} = 1; # tell starttls et. al to stop trying
381#
382# &_freetls;
383#}
160 384
161 delete $self->{rw};
162 delete $self->{ww};
163 delete $self->{fh};
164}
165
166sub error { 385sub _error {
167 my ($self) = @_; 386 my ($self, $errno, $fatal, $message) = @_;
168 387
169 { 388 $! = $errno;
170 local $!; 389 $message ||= "$!";
390
391 if ($self->{on_error}) {
392 $self->{on_error}($self, $fatal, $message);
171 $self->_shutdown; 393 $self->destroy;
394 } elsif ($self->{fh}) {
395 $self->destroy;
396 Carp::croak "AnyEvent::Handle uncaught error: $message";
172 } 397 }
173
174 $self->{on_error}($self);
175} 398}
176 399
177=item $fh = $handle->fh 400=item $fh = $handle->fh
178 401
179This method returns the filehandle of the L<AnyEvent::Handle> object. 402This method returns the file handle used to create the L<AnyEvent::Handle> object.
180 403
181=cut 404=cut
182 405
183sub fh { $_[0]->{fh} } 406sub fh { $_[0]{fh} }
184 407
185=item $handle->on_error ($cb) 408=item $handle->on_error ($cb)
186 409
187Replace the current C<on_error> callback (see the C<on_error> constructor argument). 410Replace the current C<on_error> callback (see the C<on_error> constructor argument).
188 411
200 423
201sub on_eof { 424sub on_eof {
202 $_[0]{on_eof} = $_[1]; 425 $_[0]{on_eof} = $_[1];
203} 426}
204 427
428=item $handle->on_timeout ($cb)
429
430Replace the current C<on_timeout> callback, or disables the callback (but
431not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
432argument and method.
433
434=cut
435
436sub on_timeout {
437 $_[0]{on_timeout} = $_[1];
438}
439
440=item $handle->autocork ($boolean)
441
442Enables or disables the current autocork behaviour (see C<autocork>
443constructor argument). Changes will only take effect on the next write.
444
445=cut
446
447sub autocork {
448 $_[0]{autocork} = $_[1];
449}
450
451=item $handle->no_delay ($boolean)
452
453Enables or disables the C<no_delay> setting (see constructor argument of
454the same name for details).
455
456=cut
457
458sub no_delay {
459 $_[0]{no_delay} = $_[1];
460
461 eval {
462 local $SIG{__DIE__};
463 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
464 };
465}
466
467=item $handle->on_starttls ($cb)
468
469Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
470
471=cut
472
473sub on_starttls {
474 $_[0]{on_starttls} = $_[1];
475}
476
477=item $handle->on_stoptls ($cb)
478
479Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
480
481=cut
482
483sub on_starttls {
484 $_[0]{on_stoptls} = $_[1];
485}
486
487#############################################################################
488
489=item $handle->timeout ($seconds)
490
491Configures (or disables) the inactivity timeout.
492
493=cut
494
495sub timeout {
496 my ($self, $timeout) = @_;
497
498 $self->{timeout} = $timeout;
499 $self->_timeout;
500}
501
502# reset the timeout watcher, as neccessary
503# also check for time-outs
504sub _timeout {
505 my ($self) = @_;
506
507 if ($self->{timeout}) {
508 my $NOW = AnyEvent->now;
509
510 # when would the timeout trigger?
511 my $after = $self->{_activity} + $self->{timeout} - $NOW;
512
513 # now or in the past already?
514 if ($after <= 0) {
515 $self->{_activity} = $NOW;
516
517 if ($self->{on_timeout}) {
518 $self->{on_timeout}($self);
519 } else {
520 $self->_error (Errno::ETIMEDOUT);
521 }
522
523 # callback could have changed timeout value, optimise
524 return unless $self->{timeout};
525
526 # calculate new after
527 $after = $self->{timeout};
528 }
529
530 Scalar::Util::weaken $self;
531 return unless $self; # ->error could have destroyed $self
532
533 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
534 delete $self->{_tw};
535 $self->_timeout;
536 });
537 } else {
538 delete $self->{_tw};
539 }
540}
541
205############################################################################# 542#############################################################################
206 543
207=back 544=back
208 545
209=head2 WRITE QUEUE 546=head2 WRITE QUEUE
212for reading. 549for reading.
213 550
214The write queue is very simple: you can add data to its end, and 551The write queue is very simple: you can add data to its end, and
215AnyEvent::Handle will automatically try to get rid of it for you. 552AnyEvent::Handle will automatically try to get rid of it for you.
216 553
217When data could be writtena nd the write buffer is shorter then the low 554When data could be written and the write buffer is shorter then the low
218water mark, the C<on_drain> callback will be invoked. 555water mark, the C<on_drain> callback will be invoked.
219 556
220=over 4 557=over 4
221 558
222=item $handle->on_drain ($cb) 559=item $handle->on_drain ($cb)
230 my ($self, $cb) = @_; 567 my ($self, $cb) = @_;
231 568
232 $self->{on_drain} = $cb; 569 $self->{on_drain} = $cb;
233 570
234 $cb->($self) 571 $cb->($self)
235 if $cb && $self->{low_water_mark} >= length $self->{wbuf}; 572 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
236} 573}
237 574
238=item $handle->push_write ($data) 575=item $handle->push_write ($data)
239 576
240Queues the given scalar to be written. You can push as much data as you 577Queues the given scalar to be written. You can push as much data as you
241want (only limited by the available memory), as C<AnyEvent::Handle> 578want (only limited by the available memory), as C<AnyEvent::Handle>
242buffers it independently of the kernel. 579buffers it independently of the kernel.
243 580
244=cut 581=cut
245 582
246sub push_write { 583sub _drain_wbuf {
247 my ($self, $data) = @_; 584 my ($self) = @_;
248 585
249 $self->{wbuf} .= $data; 586 if (!$self->{_ww} && length $self->{wbuf}) {
250 587
251 unless ($self->{ww}) {
252 Scalar::Util::weaken $self; 588 Scalar::Util::weaken $self;
589
253 my $cb = sub { 590 my $cb = sub {
254 my $len = syswrite $self->{fh}, $self->{wbuf}; 591 my $len = syswrite $self->{fh}, $self->{wbuf};
255 592
256 if ($len > 0) { 593 if (defined $len) {
257 substr $self->{wbuf}, 0, $len, ""; 594 substr $self->{wbuf}, 0, $len, "";
258 595
596 $self->{_activity} = AnyEvent->now;
259 597
260 $self->{on_drain}($self) 598 $self->{on_drain}($self)
261 if $self->{low_water_mark} >= length $self->{wbuf} 599 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
262 && $self->{on_drain}; 600 && $self->{on_drain};
263 601
264 delete $self->{ww} unless length $self->{wbuf}; 602 delete $self->{_ww} unless length $self->{wbuf};
265 } elsif ($! != EAGAIN && $! != EINTR) { 603 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
266 $self->error; 604 $self->_error ($!, 1);
267 } 605 }
268 }; 606 };
269 607
608 # try to write data immediately
609 $cb->() unless $self->{autocork};
610
611 # if still data left in wbuf, we need to poll
270 $self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); 612 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
271 613 if length $self->{wbuf};
272 $cb->($self);
273 }; 614 };
274} 615}
616
617our %WH;
618
619sub register_write_type($$) {
620 $WH{$_[0]} = $_[1];
621}
622
623sub push_write {
624 my $self = shift;
625
626 if (@_ > 1) {
627 my $type = shift;
628
629 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
630 ->($self, @_);
631 }
632
633 if ($self->{tls}) {
634 $self->{_tls_wbuf} .= $_[0];
635
636 &_dotls ($self);
637 } else {
638 $self->{wbuf} .= $_[0];
639 $self->_drain_wbuf;
640 }
641}
642
643=item $handle->push_write (type => @args)
644
645Instead of formatting your data yourself, you can also let this module do
646the job by specifying a type and type-specific arguments.
647
648Predefined types are (if you have ideas for additional types, feel free to
649drop by and tell us):
650
651=over 4
652
653=item netstring => $string
654
655Formats the given value as netstring
656(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
657
658=cut
659
660register_write_type netstring => sub {
661 my ($self, $string) = @_;
662
663 (length $string) . ":$string,"
664};
665
666=item packstring => $format, $data
667
668An octet string prefixed with an encoded length. The encoding C<$format>
669uses the same format as a Perl C<pack> format, but must specify a single
670integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
671optional C<!>, C<< < >> or C<< > >> modifier).
672
673=cut
674
675register_write_type packstring => sub {
676 my ($self, $format, $string) = @_;
677
678 pack "$format/a*", $string
679};
680
681=item json => $array_or_hashref
682
683Encodes the given hash or array reference into a JSON object. Unless you
684provide your own JSON object, this means it will be encoded to JSON text
685in UTF-8.
686
687JSON objects (and arrays) are self-delimiting, so you can write JSON at
688one end of a handle and read them at the other end without using any
689additional framing.
690
691The generated JSON text is guaranteed not to contain any newlines: While
692this module doesn't need delimiters after or between JSON texts to be
693able to read them, many other languages depend on that.
694
695A simple RPC protocol that interoperates easily with others is to send
696JSON arrays (or objects, although arrays are usually the better choice as
697they mimic how function argument passing works) and a newline after each
698JSON text:
699
700 $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
701 $handle->push_write ("\012");
702
703An AnyEvent::Handle receiver would simply use the C<json> read type and
704rely on the fact that the newline will be skipped as leading whitespace:
705
706 $handle->push_read (json => sub { my $array = $_[1]; ... });
707
708Other languages could read single lines terminated by a newline and pass
709this line into their JSON decoder of choice.
710
711=cut
712
713register_write_type json => sub {
714 my ($self, $ref) = @_;
715
716 require JSON;
717
718 $self->{json} ? $self->{json}->encode ($ref)
719 : JSON::encode_json ($ref)
720};
721
722=item storable => $reference
723
724Freezes the given reference using L<Storable> and writes it to the
725handle. Uses the C<nfreeze> format.
726
727=cut
728
729register_write_type storable => sub {
730 my ($self, $ref) = @_;
731
732 require Storable;
733
734 pack "w/a*", Storable::nfreeze ($ref)
735};
736
737=back
738
739=item $handle->push_shutdown
740
741Sometimes you know you want to close the socket after writing your data
742before it was actually written. One way to do that is to replace your
743C<on_drain> handler by a callback that shuts down the socket (and set
744C<low_water_mark> to C<0>). This method is a shorthand for just that, and
745replaces the C<on_drain> callback with:
746
747 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
748
749This simply shuts down the write side and signals an EOF condition to the
750the peer.
751
752You can rely on the normal read queue and C<on_eof> handling
753afterwards. This is the cleanest way to close a connection.
754
755=cut
756
757sub push_shutdown {
758 my ($self) = @_;
759
760 delete $self->{low_water_mark};
761 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
762}
763
764=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
765
766This function (not method) lets you add your own types to C<push_write>.
767Whenever the given C<type> is used, C<push_write> will invoke the code
768reference with the handle object and the remaining arguments.
769
770The code reference is supposed to return a single octet string that will
771be appended to the write buffer.
772
773Note that this is a function, and all types registered this way will be
774global, so try to use unique names.
775
776=cut
275 777
276############################################################################# 778#############################################################################
277 779
278=back 780=back
279 781
286ways, the "simple" way, using only C<on_read> and the "complex" way, using 788ways, the "simple" way, using only C<on_read> and the "complex" way, using
287a queue. 789a queue.
288 790
289In the simple case, you just install an C<on_read> callback and whenever 791In the simple case, you just install an C<on_read> callback and whenever
290new data arrives, it will be called. You can then remove some data (if 792new data arrives, it will be called. You can then remove some data (if
291enough is there) from the read buffer (C<< $handle->rbuf >>) if you want 793enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
292or not. 794leave the data there if you want to accumulate more (e.g. when only a
795partial message has been received so far).
293 796
294In the more complex case, you want to queue multiple callbacks. In this 797In the more complex case, you want to queue multiple callbacks. In this
295case, AnyEvent::Handle will call the first queued callback each time new 798case, AnyEvent::Handle will call the first queued callback each time new
296data arrives and removes it when it has done its job (see C<push_read>, 799data arrives (also the first time it is queued) and removes it when it has
297below). 800done its job (see C<push_read>, below).
298 801
299This way you can, for example, push three line-reads, followed by reading 802This way you can, for example, push three line-reads, followed by reading
300a chunk of data, and AnyEvent::Handle will execute them in order. 803a chunk of data, and AnyEvent::Handle will execute them in order.
301 804
302Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by 805Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
303the specified number of bytes which give an XML datagram. 806the specified number of bytes which give an XML datagram.
304 807
305 # in the default state, expect some header bytes 808 # in the default state, expect some header bytes
306 $handle->on_read (sub { 809 $handle->on_read (sub {
307 # some data is here, now queue the length-header-read (4 octets) 810 # some data is here, now queue the length-header-read (4 octets)
308 shift->unshift_read_chunk (4, sub { 811 shift->unshift_read (chunk => 4, sub {
309 # header arrived, decode 812 # header arrived, decode
310 my $len = unpack "N", $_[1]; 813 my $len = unpack "N", $_[1];
311 814
312 # now read the payload 815 # now read the payload
313 shift->unshift_read_chunk ($len, sub { 816 shift->unshift_read (chunk => $len, sub {
314 my $xml = $_[1]; 817 my $xml = $_[1];
315 # handle xml 818 # handle xml
316 }); 819 });
317 }); 820 });
318 }); 821 });
319 822
320Example 2: Implement a client for a protocol that replies either with 823Example 2: Implement a client for a protocol that replies either with "OK"
321"OK" and another line or "ERROR" for one request, and 64 bytes for the 824and another line or "ERROR" for the first request that is sent, and 64
322second request. Due tot he availability of a full queue, we can just 825bytes for the second request. Due to the availability of a queue, we can
323pipeline sending both requests and manipulate the queue as necessary in 826just pipeline sending both requests and manipulate the queue as necessary
324the callbacks: 827in the callbacks.
325 828
326 # request one 829When the first callback is called and sees an "OK" response, it will
830C<unshift> another line-read. This line-read will be queued I<before> the
83164-byte chunk callback.
832
833 # request one, returns either "OK + extra line" or "ERROR"
327 $handle->push_write ("request 1\015\012"); 834 $handle->push_write ("request 1\015\012");
328 835
329 # we expect "ERROR" or "OK" as response, so push a line read 836 # we expect "ERROR" or "OK" as response, so push a line read
330 $handle->push_read_line (sub { 837 $handle->push_read (line => sub {
331 # if we got an "OK", we have to _prepend_ another line, 838 # if we got an "OK", we have to _prepend_ another line,
332 # so it will be read before the second request reads its 64 bytes 839 # so it will be read before the second request reads its 64 bytes
333 # which are already in the queue when this callback is called 840 # which are already in the queue when this callback is called
334 # we don't do this in case we got an error 841 # we don't do this in case we got an error
335 if ($_[1] eq "OK") { 842 if ($_[1] eq "OK") {
336 $_[0]->unshift_read_line (sub { 843 $_[0]->unshift_read (line => sub {
337 my $response = $_[1]; 844 my $response = $_[1];
338 ... 845 ...
339 }); 846 });
340 } 847 }
341 }); 848 });
342 849
343 # request two 850 # request two, simply returns 64 octets
344 $handle->push_write ("request 2\015\012"); 851 $handle->push_write ("request 2\015\012");
345 852
346 # simply read 64 bytes, always 853 # simply read 64 bytes, always
347 $handle->push_read_chunk (64, sub { 854 $handle->push_read (chunk => 64, sub {
348 my $response = $_[1]; 855 my $response = $_[1];
349 ... 856 ...
350 }); 857 });
351 858
352=over 4 859=over 4
353 860
861=cut
862
354sub _drain_rbuf { 863sub _drain_rbuf {
355 my ($self) = @_; 864 my ($self) = @_;
356 865
357 return if exists $self->{in_drain};
358 local $self->{in_drain} = 1; 866 local $self->{_in_drain} = 1;
359 867
868 if (
869 defined $self->{rbuf_max}
870 && $self->{rbuf_max} < length $self->{rbuf}
871 ) {
872 $self->_error (Errno::ENOSPC, 1), return;
873 }
874
875 while () {
876 # we need to use a separate tls read buffer, as we must not receive data while
877 # we are draining the buffer, and this can only happen with TLS.
878 $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
879
360 while (my $len = length $self->{rbuf}) { 880 my $len = length $self->{rbuf};
361 no strict 'refs'; 881
362 if (@{ $self->{queue} }) { 882 if (my $cb = shift @{ $self->{_queue} }) {
363 if ($self->{queue}[0]($self)) { 883 unless ($cb->($self)) {
364 shift @{ $self->{queue} };
365 } elsif ($self->{eof}) { 884 if ($self->{_eof}) {
366 # no progress can be made (not enough data and no data forthcoming) 885 # no progress can be made (not enough data and no data forthcoming)
367 $! = &Errno::EPIPE; return $self->error; 886 $self->_error (Errno::EPIPE, 1), return;
368 } else { 887 }
888
889 unshift @{ $self->{_queue} }, $cb;
369 return; 890 last;
370 } 891 }
371 } elsif ($self->{on_read}) { 892 } elsif ($self->{on_read}) {
893 last unless $len;
894
372 $self->{on_read}($self); 895 $self->{on_read}($self);
373 896
374 if ( 897 if (
375 $self->{eof} # if no further data will arrive
376 && $len == length $self->{rbuf} # and no data has been consumed 898 $len == length $self->{rbuf} # if no data has been consumed
377 && !@{ $self->{queue} } # and the queue is still empty 899 && !@{ $self->{_queue} } # and the queue is still empty
378 && $self->{on_read} # and we still want to read data 900 && $self->{on_read} # but we still have on_read
379 ) { 901 ) {
902 # no further data will arrive
380 # then no progress can be made 903 # so no progress can be made
381 $! = &Errno::EPIPE; return $self->error; 904 $self->_error (Errno::EPIPE, 1), return
905 if $self->{_eof};
906
907 last; # more data might arrive
382 } 908 }
383 } else { 909 } else {
384 # read side becomes idle 910 # read side becomes idle
385 delete $self->{rw}; 911 delete $self->{_rw} unless $self->{tls};
386 return; 912 last;
387 } 913 }
388 } 914 }
389 915
390 if ($self->{eof}) { 916 if ($self->{_eof}) {
391 $self->_shutdown; 917 if ($self->{on_eof}) {
392 $self->{on_eof}($self); 918 $self->{on_eof}($self)
919 } else {
920 $self->_error (0, 1, "Unexpected end-of-file");
921 }
922 }
923
924 # may need to restart read watcher
925 unless ($self->{_rw}) {
926 $self->start_read
927 if $self->{on_read} || @{ $self->{_queue} };
393 } 928 }
394} 929}
395 930
396=item $handle->on_read ($cb) 931=item $handle->on_read ($cb)
397 932
403 938
404sub on_read { 939sub on_read {
405 my ($self, $cb) = @_; 940 my ($self, $cb) = @_;
406 941
407 $self->{on_read} = $cb; 942 $self->{on_read} = $cb;
408 943 $self->_drain_rbuf if $cb && !$self->{_in_drain};
409 unless ($self->{rw} || $self->{eof}) {
410 Scalar::Util::weaken $self;
411
412 $self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
413 my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} || 8192, length $self->{rbuf};
414
415 if ($len > 0) {
416 if (exists $self->{rbuf_max}) {
417 if ($self->{rbuf_max} < length $self->{rbuf}) {
418 $! = &Errno::ENOSPC; return $self->error;
419 }
420 }
421
422 } elsif (defined $len) {
423 $self->{eof} = 1;
424 delete $self->{rw};
425
426 } elsif ($! != EAGAIN && $! != EINTR) {
427 return $self->error;
428 }
429
430 $self->_drain_rbuf;
431 });
432 }
433} 944}
434 945
435=item $handle->rbuf 946=item $handle->rbuf
436 947
437Returns the read buffer (as a modifiable lvalue). 948Returns the read buffer (as a modifiable lvalue).
438 949
439You can access the read buffer directly as the C<< ->{rbuf} >> member, if 950You can access the read buffer directly as the C<< ->{rbuf} >>
440you want. 951member, if you want. However, the only operation allowed on the
952read buffer (apart from looking at it) is removing data from its
953beginning. Otherwise modifying or appending to it is not allowed and will
954lead to hard-to-track-down bugs.
441 955
442NOTE: The read buffer should only be used or modified if the C<on_read>, 956NOTE: The read buffer should only be used or modified if the C<on_read>,
443C<push_read> or C<unshift_read> methods are used. The other read methods 957C<push_read> or C<unshift_read> methods are used. The other read methods
444automatically manage the read buffer. 958automatically manage the read buffer.
445 959
456Append the given callback to the end of the queue (C<push_read>) or 970Append the given callback to the end of the queue (C<push_read>) or
457prepend it (C<unshift_read>). 971prepend it (C<unshift_read>).
458 972
459The callback is called each time some additional read data arrives. 973The callback is called each time some additional read data arrives.
460 974
461It must check wether enough data is in the read buffer already. 975It must check whether enough data is in the read buffer already.
462 976
463If not enough data is available, it must return the empty list or a false 977If not enough data is available, it must return the empty list or a false
464value, in which case it will be called repeatedly until enough data is 978value, in which case it will be called repeatedly until enough data is
465available (or an error condition is detected). 979available (or an error condition is detected).
466 980
468interested in (which can be none at all) and return a true value. After returning 982interested in (which can be none at all) and return a true value. After returning
469true, it will be removed from the queue. 983true, it will be removed from the queue.
470 984
471=cut 985=cut
472 986
987our %RH;
988
989sub register_read_type($$) {
990 $RH{$_[0]} = $_[1];
991}
992
473sub push_read { 993sub push_read {
474 my ($self, $cb) = @_; 994 my $self = shift;
995 my $cb = pop;
475 996
997 if (@_) {
998 my $type = shift;
999
1000 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1001 ->($self, $cb, @_);
1002 }
1003
476 push @{ $self->{queue} }, $cb; 1004 push @{ $self->{_queue} }, $cb;
477 $self->_drain_rbuf; 1005 $self->_drain_rbuf unless $self->{_in_drain};
478} 1006}
479 1007
480sub unshift_read { 1008sub unshift_read {
481 my ($self, $cb) = @_; 1009 my $self = shift;
1010 my $cb = pop;
482 1011
1012 if (@_) {
1013 my $type = shift;
1014
1015 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1016 ->($self, $cb, @_);
1017 }
1018
1019
483 push @{ $self->{queue} }, $cb; 1020 unshift @{ $self->{_queue} }, $cb;
484 $self->_drain_rbuf; 1021 $self->_drain_rbuf unless $self->{_in_drain};
485} 1022}
486 1023
487=item $handle->push_read_chunk ($len, $cb->($self, $data)) 1024=item $handle->push_read (type => @args, $cb)
488 1025
489=item $handle->unshift_read_chunk ($len, $cb->($self, $data)) 1026=item $handle->unshift_read (type => @args, $cb)
490 1027
491Append the given callback to the end of the queue (C<push_read_chunk>) or 1028Instead of providing a callback that parses the data itself you can chose
492prepend it (C<unshift_read_chunk>). 1029between a number of predefined parsing formats, for chunks of data, lines
1030etc.
493 1031
494The callback will be called only once C<$len> bytes have been read, and 1032Predefined types are (if you have ideas for additional types, feel free to
495these C<$len> bytes will be passed to the callback. 1033drop by and tell us):
496 1034
497=cut 1035=over 4
498 1036
499sub _read_chunk($$) { 1037=item chunk => $octets, $cb->($handle, $data)
500 my ($len, $cb) = @_; 1038
1039Invoke the callback only once C<$octets> bytes have been read. Pass the
1040data read to the callback. The callback will never be called with less
1041data.
1042
1043Example: read 2 bytes.
1044
1045 $handle->push_read (chunk => 2, sub {
1046 warn "yay ", unpack "H*", $_[1];
1047 });
1048
1049=cut
1050
1051register_read_type chunk => sub {
1052 my ($self, $cb, $len) = @_;
501 1053
502 sub { 1054 sub {
503 $len <= length $_[0]{rbuf} or return; 1055 $len <= length $_[0]{rbuf} or return;
504 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); 1056 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
505 1 1057 1
506 } 1058 }
507} 1059};
508 1060
509sub push_read_chunk { 1061=item line => [$eol, ]$cb->($handle, $line, $eol)
510 my ($self, $len, $cb) = @_;
511
512 $self->push_read (_read_chunk $len, $cb);
513}
514
515
516sub unshift_read_chunk {
517 my ($self, $len, $cb) = @_;
518
519 $self->unshift_read (_read_chunk $len, $cb);
520}
521
522=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))
523
524=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
525
526Append the given callback to the end of the queue (C<push_read_line>) or
527prepend it (C<unshift_read_line>).
528 1062
529The callback will be called only once a full line (including the end of 1063The callback will be called only once a full line (including the end of
530line marker, C<$eol>) has been read. This line (excluding the end of line 1064line marker, C<$eol>) has been read. This line (excluding the end of line
531marker) will be passed to the callback as second argument (C<$line>), and 1065marker) will be passed to the callback as second argument (C<$line>), and
532the end of line marker as the third argument (C<$eol>). 1066the end of line marker as the third argument (C<$eol>).
543Partial lines at the end of the stream will never be returned, as they are 1077Partial lines at the end of the stream will never be returned, as they are
544not marked by the end of line marker. 1078not marked by the end of line marker.
545 1079
546=cut 1080=cut
547 1081
548sub _read_line($$) { 1082register_read_type line => sub {
549 my $cb = pop; 1083 my ($self, $cb, $eol) = @_;
550 my $eol = @_ ? shift : qr|(\015?\012)|;
551 my $pos;
552 1084
1085 if (@_ < 3) {
1086 # this is more than twice as fast as the generic code below
1087 sub {
1088 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
1089
1090 $cb->($_[0], $1, $2);
1091 1
1092 }
1093 } else {
553 $eol = qr|(\Q$eol\E)| unless ref $eol; 1094 $eol = quotemeta $eol unless ref $eol;
554 $eol = qr|^(.*?)($eol)|; 1095 $eol = qr|^(.*?)($eol)|s;
1096
1097 sub {
1098 $_[0]{rbuf} =~ s/$eol// or return;
1099
1100 $cb->($_[0], $1, $2);
1101 1
1102 }
1103 }
1104};
1105
1106=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1107
1108Makes a regex match against the regex object C<$accept> and returns
1109everything up to and including the match.
1110
1111Example: read a single line terminated by '\n'.
1112
1113 $handle->push_read (regex => qr<\n>, sub { ... });
1114
1115If C<$reject> is given and not undef, then it determines when the data is
1116to be rejected: it is matched against the data when the C<$accept> regex
1117does not match and generates an C<EBADMSG> error when it matches. This is
1118useful to quickly reject wrong data (to avoid waiting for a timeout or a
1119receive buffer overflow).
1120
1121Example: expect a single decimal number followed by whitespace, reject
1122anything else (not the use of an anchor).
1123
1124 $handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
1125
1126If C<$skip> is given and not C<undef>, then it will be matched against
1127the receive buffer when neither C<$accept> nor C<$reject> match,
1128and everything preceding and including the match will be accepted
1129unconditionally. This is useful to skip large amounts of data that you
1130know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1131have to start matching from the beginning. This is purely an optimisation
1132and is usually worth only when you expect more than a few kilobytes.
1133
1134Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1135expect the header to be very large (it isn't in practise, but...), we use
1136a skip regex to skip initial portions. The skip regex is tricky in that
1137it only accepts something not ending in either \015 or \012, as these are
1138required for the accept regex.
1139
1140 $handle->push_read (regex =>
1141 qr<\015\012\015\012>,
1142 undef, # no reject
1143 qr<^.*[^\015\012]>,
1144 sub { ... });
1145
1146=cut
1147
1148register_read_type regex => sub {
1149 my ($self, $cb, $accept, $reject, $skip) = @_;
1150
1151 my $data;
1152 my $rbuf = \$self->{rbuf};
555 1153
556 sub { 1154 sub {
557 $_[0]{rbuf} =~ s/$eol// or return; 1155 # accept
1156 if ($$rbuf =~ $accept) {
1157 $data .= substr $$rbuf, 0, $+[0], "";
1158 $cb->($self, $data);
1159 return 1;
1160 }
1161
1162 # reject
1163 if ($reject && $$rbuf =~ $reject) {
1164 $self->_error (Errno::EBADMSG);
1165 }
558 1166
559 $cb->($1, $2); 1167 # skip
1168 if ($skip && $$rbuf =~ $skip) {
1169 $data .= substr $$rbuf, 0, $+[0], "";
1170 }
1171
1172 ()
1173 }
1174};
1175
1176=item netstring => $cb->($handle, $string)
1177
1178A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
1179
1180Throws an error with C<$!> set to EBADMSG on format violations.
1181
1182=cut
1183
1184register_read_type netstring => sub {
1185 my ($self, $cb) = @_;
1186
1187 sub {
1188 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1189 if ($_[0]{rbuf} =~ /[^0-9]/) {
1190 $self->_error (Errno::EBADMSG);
1191 }
1192 return;
1193 }
1194
1195 my $len = $1;
1196
1197 $self->unshift_read (chunk => $len, sub {
1198 my $string = $_[1];
1199 $_[0]->unshift_read (chunk => 1, sub {
1200 if ($_[1] eq ",") {
1201 $cb->($_[0], $string);
1202 } else {
1203 $self->_error (Errno::EBADMSG);
1204 }
1205 });
1206 });
1207
560 1 1208 1
561 } 1209 }
562} 1210};
563 1211
564sub push_read_line { 1212=item packstring => $format, $cb->($handle, $string)
565 my $self = shift;
566 1213
567 $self->push_read (&_read_line); 1214An octet string prefixed with an encoded length. The encoding C<$format>
568} 1215uses the same format as a Perl C<pack> format, but must specify a single
1216integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1217optional C<!>, C<< < >> or C<< > >> modifier).
569 1218
570sub unshift_read_line { 1219For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
571 my $self = shift; 1220EPP uses a prefix of C<N> (4 octtes).
572 1221
573 $self->unshift_read (&_read_line); 1222Example: read a block of data prefixed by its length in BER-encoded
574} 1223format (very efficient).
1224
1225 $handle->push_read (packstring => "w", sub {
1226 my ($handle, $data) = @_;
1227 });
1228
1229=cut
1230
1231register_read_type packstring => sub {
1232 my ($self, $cb, $format) = @_;
1233
1234 sub {
1235 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1236 defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1237 or return;
1238
1239 $format = length pack $format, $len;
1240
1241 # bypass unshift if we already have the remaining chunk
1242 if ($format + $len <= length $_[0]{rbuf}) {
1243 my $data = substr $_[0]{rbuf}, $format, $len;
1244 substr $_[0]{rbuf}, 0, $format + $len, "";
1245 $cb->($_[0], $data);
1246 } else {
1247 # remove prefix
1248 substr $_[0]{rbuf}, 0, $format, "";
1249
1250 # read remaining chunk
1251 $_[0]->unshift_read (chunk => $len, $cb);
1252 }
1253
1254 1
1255 }
1256};
1257
1258=item json => $cb->($handle, $hash_or_arrayref)
1259
1260Reads a JSON object or array, decodes it and passes it to the
1261callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1262
1263If a C<json> object was passed to the constructor, then that will be used
1264for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1265
1266This read type uses the incremental parser available with JSON version
12672.09 (and JSON::XS version 2.2) and above. You have to provide a
1268dependency on your own: this module will load the JSON module, but
1269AnyEvent does not depend on it itself.
1270
1271Since JSON texts are fully self-delimiting, the C<json> read and write
1272types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1273the C<json> write type description, above, for an actual example.
1274
1275=cut
1276
1277register_read_type json => sub {
1278 my ($self, $cb) = @_;
1279
1280 my $json = $self->{json} ||=
1281 eval { require JSON::XS; JSON::XS->new->utf8 }
1282 || do { require JSON; JSON->new->utf8 };
1283
1284 my $data;
1285 my $rbuf = \$self->{rbuf};
1286
1287 sub {
1288 my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1289
1290 if ($ref) {
1291 $self->{rbuf} = $json->incr_text;
1292 $json->incr_text = "";
1293 $cb->($self, $ref);
1294
1295 1
1296 } elsif ($@) {
1297 # error case
1298 $json->incr_skip;
1299
1300 $self->{rbuf} = $json->incr_text;
1301 $json->incr_text = "";
1302
1303 $self->_error (Errno::EBADMSG);
1304
1305 ()
1306 } else {
1307 $self->{rbuf} = "";
1308
1309 ()
1310 }
1311 }
1312};
1313
1314=item storable => $cb->($handle, $ref)
1315
1316Deserialises a L<Storable> frozen representation as written by the
1317C<storable> write type (BER-encoded length prefix followed by nfreeze'd
1318data).
1319
1320Raises C<EBADMSG> error if the data could not be decoded.
1321
1322=cut
1323
1324register_read_type storable => sub {
1325 my ($self, $cb) = @_;
1326
1327 require Storable;
1328
1329 sub {
1330 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1331 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1332 or return;
1333
1334 my $format = length pack "w", $len;
1335
1336 # bypass unshift if we already have the remaining chunk
1337 if ($format + $len <= length $_[0]{rbuf}) {
1338 my $data = substr $_[0]{rbuf}, $format, $len;
1339 substr $_[0]{rbuf}, 0, $format + $len, "";
1340 $cb->($_[0], Storable::thaw ($data));
1341 } else {
1342 # remove prefix
1343 substr $_[0]{rbuf}, 0, $format, "";
1344
1345 # read remaining chunk
1346 $_[0]->unshift_read (chunk => $len, sub {
1347 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1348 $cb->($_[0], $ref);
1349 } else {
1350 $self->_error (Errno::EBADMSG);
1351 }
1352 });
1353 }
1354
1355 1
1356 }
1357};
575 1358
576=back 1359=back
577 1360
1361=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1362
1363This function (not method) lets you add your own types to C<push_read>.
1364
1365Whenever the given C<type> is used, C<push_read> will invoke the code
1366reference with the handle object, the callback and the remaining
1367arguments.
1368
1369The code reference is supposed to return a callback (usually a closure)
1370that works as a plain read callback (see C<< ->push_read ($cb) >>).
1371
1372It should invoke the passed callback when it is done reading (remember to
1373pass C<$handle> as first argument as all other callbacks do that).
1374
1375Note that this is a function, and all types registered this way will be
1376global, so try to use unique names.
1377
1378For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
1379search for C<register_read_type>)).
1380
1381=item $handle->stop_read
1382
1383=item $handle->start_read
1384
1385In rare cases you actually do not want to read anything from the
1386socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1387any queued callbacks will be executed then. To start reading again, call
1388C<start_read>.
1389
1390Note that AnyEvent::Handle will automatically C<start_read> for you when
1391you change the C<on_read> callback or push/unshift a read callback, and it
1392will automatically C<stop_read> for you when neither C<on_read> is set nor
1393there are any read requests in the queue.
1394
1395These methods will have no effect when in TLS mode (as TLS doesn't support
1396half-duplex connections).
1397
1398=cut
1399
1400sub stop_read {
1401 my ($self) = @_;
1402
1403 delete $self->{_rw} unless $self->{tls};
1404}
1405
1406sub start_read {
1407 my ($self) = @_;
1408
1409 unless ($self->{_rw} || $self->{_eof}) {
1410 Scalar::Util::weaken $self;
1411
1412 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1413 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1414 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1415
1416 if ($len > 0) {
1417 $self->{_activity} = AnyEvent->now;
1418
1419 if ($self->{tls}) {
1420 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421
1422 &_dotls ($self);
1423 } else {
1424 $self->_drain_rbuf unless $self->{_in_drain};
1425 }
1426
1427 } elsif (defined $len) {
1428 delete $self->{_rw};
1429 $self->{_eof} = 1;
1430 $self->_drain_rbuf unless $self->{_in_drain};
1431
1432 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433 return $self->_error ($!, 1);
1434 }
1435 });
1436 }
1437}
1438
1439our $ERROR_SYSCALL;
1440our $ERROR_WANT_READ;
1441
1442sub _tls_error {
1443 my ($self, $err) = @_;
1444
1445 return $self->_error ($!, 1)
1446 if $err == Net::SSLeay::ERROR_SYSCALL ();
1447
1448 my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1449
1450 # reduce error string to look less scary
1451 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1452
1453 if ($self->{_on_starttls}) {
1454 (delete $self->{_on_starttls})->($self, undef, $err);
1455 &_freetls;
1456 } else {
1457 &_freetls;
1458 $self->_error (Errno::EPROTO, 1, $err);
1459 }
1460}
1461
1462# poll the write BIO and send the data if applicable
1463# also decode read data if possible
1464# this is basiclaly our TLS state machine
1465# more efficient implementations are possible with openssl,
1466# but not with the buggy and incomplete Net::SSLeay.
1467sub _dotls {
1468 my ($self) = @_;
1469
1470 my $tmp;
1471
1472 if (length $self->{_tls_wbuf}) {
1473 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1474 substr $self->{_tls_wbuf}, 0, $tmp, "";
1475 }
1476
1477 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1478 return $self->_tls_error ($tmp)
1479 if $tmp != $ERROR_WANT_READ
1480 && ($tmp != $ERROR_SYSCALL || $!);
1481 }
1482
1483 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1484 unless (length $tmp) {
1485 $self->{_on_starttls}
1486 and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1487 &_freetls;
1488
1489 if ($self->{on_stoptls}) {
1490 $self->{on_stoptls}($self);
1491 return;
1492 } else {
1493 # let's treat SSL-eof as we treat normal EOF
1494 delete $self->{_rw};
1495 $self->{_eof} = 1;
1496 }
1497 }
1498
1499 $self->{_tls_rbuf} .= $tmp;
1500 $self->_drain_rbuf unless $self->{_in_drain};
1501 $self->{tls} or return; # tls session might have gone away in callback
1502 }
1503
1504 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505 return $self->_tls_error ($tmp)
1506 if $tmp != $ERROR_WANT_READ
1507 && ($tmp != $ERROR_SYSCALL || $!);
1508
1509 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1510 $self->{wbuf} .= $tmp;
1511 $self->_drain_wbuf;
1512 }
1513
1514 $self->{_on_starttls}
1515 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1516 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1517}
1518
1519=item $handle->starttls ($tls[, $tls_ctx])
1520
1521Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1522object is created, you can also do that at a later time by calling
1523C<starttls>.
1524
1525The first argument is the same as the C<tls> constructor argument (either
1526C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527
1528The second argument is the optional C<AnyEvent::TLS> object that is used
1529when AnyEvent::Handle has to create its own TLS connection object, or
1530a hash reference with C<< key => value >> pairs that will be used to
1531construct a new context.
1532
1533The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1534context in C<< $handle->{tls_ctx} >> after this call and can be used or
1535changed to your liking. Note that the handshake might have already started
1536when this function returns.
1537
1538If it an error to start a TLS handshake more than once per
1539AnyEvent::Handle object (this is due to bugs in OpenSSL).
1540
1541=cut
1542
1543our %TLS_CACHE; #TODO not yet documented, should we?
1544
1545sub starttls {
1546 my ($self, $ssl, $ctx) = @_;
1547
1548 require Net::SSLeay;
1549
1550 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1551 if $self->{tls};
1552
1553 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555
1556 $ctx ||= $self->{tls_ctx};
1557
1558 if ("HASH" eq ref $ctx) {
1559 require AnyEvent::TLS;
1560
1561 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562
1563 if ($ctx->{cache}) {
1564 my $key = $ctx+0;
1565 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1566 } else {
1567 $ctx = new AnyEvent::TLS %$ctx;
1568 }
1569 }
1570
1571 $self->{tls_ctx} = $ctx || TLS_CTX ();
1572 $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1573
1574 # basically, this is deep magic (because SSL_read should have the same issues)
1575 # but the openssl maintainers basically said: "trust us, it just works".
1576 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577 # and mismaintained ssleay-module doesn't even offer them).
1578 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1579 #
1580 # in short: this is a mess.
1581 #
1582 # note that we do not try to keep the length constant between writes as we are required to do.
1583 # we assume that most (but not all) of this insanity only applies to non-blocking cases,
1584 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1585 # have identity issues in that area.
1586# Net::SSLeay::CTX_set_mode ($ssl,
1587# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1588# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1589 Net::SSLeay::CTX_set_mode ($ssl, 1|2);
1590
1591 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593
1594 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1595
1596 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597 if $self->{on_starttls};
1598
1599 &_dotls; # need to trigger the initial handshake
1600 $self->start_read; # make sure we actually do read
1601}
1602
1603=item $handle->stoptls
1604
1605Shuts down the SSL connection - this makes a proper EOF handshake by
1606sending a close notify to the other side, but since OpenSSL doesn't
1607support non-blocking shut downs, it is not possible to re-use the stream
1608afterwards.
1609
1610=cut
1611
1612sub stoptls {
1613 my ($self) = @_;
1614
1615 if ($self->{tls}) {
1616 Net::SSLeay::shutdown ($self->{tls});
1617
1618 &_dotls;
1619
1620# # we don't give a shit. no, we do, but we can't. no...#d#
1621# # we, we... have to use openssl :/#d#
1622# &_freetls;#d#
1623 }
1624}
1625
1626sub _freetls {
1627 my ($self) = @_;
1628
1629 return unless $self->{tls};
1630
1631 $self->{tls_ctx}->_put_session (delete $self->{tls});
1632
1633 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634}
1635
1636sub DESTROY {
1637 my ($self) = @_;
1638
1639 &_freetls;
1640
1641 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642
1643 if ($linger && length $self->{wbuf}) {
1644 my $fh = delete $self->{fh};
1645 my $wbuf = delete $self->{wbuf};
1646
1647 my @linger;
1648
1649 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
1650 my $len = syswrite $fh, $wbuf, length $wbuf;
1651
1652 if ($len > 0) {
1653 substr $wbuf, 0, $len, "";
1654 } else {
1655 @linger = (); # end
1656 }
1657 });
1658 push @linger, AnyEvent->timer (after => $linger, cb => sub {
1659 @linger = ();
1660 });
1661 }
1662}
1663
1664=item $handle->destroy
1665
1666Shuts down the handle object as much as possible - this call ensures that
1667no further callbacks will be invoked and as many resources as possible
1668will be freed. You must not call any methods on the object afterwards.
1669
1670Normally, you can just "forget" any references to an AnyEvent::Handle
1671object and it will simply shut down. This works in fatal error and EOF
1672callbacks, as well as code outside. It does I<NOT> work in a read or write
1673callback, so when you want to destroy the AnyEvent::Handle object from
1674within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1675that case.
1676
1677Destroying the handle object in this way has the advantage that callbacks
1678will be removed as well, so if those are the only reference holders (as
1679is common), then one doesn't need to do anything special to break any
1680reference cycles.
1681
1682The handle might still linger in the background and write out remaining
1683data, as specified by the C<linger> option, however.
1684
1685=cut
1686
1687sub destroy {
1688 my ($self) = @_;
1689
1690 $self->DESTROY;
1691 %$self = ();
1692}
1693
1694=item AnyEvent::Handle::TLS_CTX
1695
1696This function creates and returns the AnyEvent::TLS object used by default
1697for TLS mode.
1698
1699The context is created by calling L<AnyEvent::TLS> without any arguments.
1700
1701=cut
1702
1703our $TLS_CTX;
1704
1705sub TLS_CTX() {
1706 $TLS_CTX ||= do {
1707 require AnyEvent::TLS;
1708
1709 new AnyEvent::TLS
1710 }
1711}
1712
1713=back
1714
1715
1716=head1 NONFREQUENTLY ASKED QUESTIONS
1717
1718=over 4
1719
1720=item I C<undef> the AnyEvent::Handle reference inside my callback and
1721still get further invocations!
1722
1723That's because AnyEvent::Handle keeps a reference to itself when handling
1724read or write callbacks.
1725
1726It is only safe to "forget" the reference inside EOF or error callbacks,
1727from within all other callbacks, you need to explicitly call the C<<
1728->destroy >> method.
1729
1730=item I get different callback invocations in TLS mode/Why can't I pause
1731reading?
1732
1733Unlike, say, TCP, TLS connections do not consist of two independent
1734communication channels, one for each direction. Or put differently. The
1735read and write directions are not independent of each other: you cannot
1736write data unless you are also prepared to read, and vice versa.
1737
1738This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
1739callback invocations when you are not expecting any read data - the reason
1740is that AnyEvent::Handle always reads in TLS mode.
1741
1742During the connection, you have to make sure that you always have a
1743non-empty read-queue, or an C<on_read> watcher. At the end of the
1744connection (or when you no longer want to use it) you can call the
1745C<destroy> method.
1746
1747=item How do I read data until the other side closes the connection?
1748
1749If you just want to read your data into a perl scalar, the easiest way
1750to achieve this is by setting an C<on_read> callback that does nothing,
1751clearing the C<on_eof> callback and in the C<on_error> callback, the data
1752will be in C<$_[0]{rbuf}>:
1753
1754 $handle->on_read (sub { });
1755 $handle->on_eof (undef);
1756 $handle->on_error (sub {
1757 my $data = delete $_[0]{rbuf};
1758 });
1759
1760The reason to use C<on_error> is that TCP connections, due to latencies
1761and packets loss, might get closed quite violently with an error, when in
1762fact, all data has been received.
1763
1764It is usually better to use acknowledgements when transferring data,
1765to make sure the other side hasn't just died and you got the data
1766intact. This is also one reason why so many internet protocols have an
1767explicit QUIT command.
1768
1769=item I don't want to destroy the handle too early - how do I wait until
1770all data has been written?
1771
1772After writing your last bits of data, set the C<on_drain> callback
1773and destroy the handle in there - with the default setting of
1774C<low_water_mark> this will be called precisely when all data has been
1775written to the socket:
1776
1777 $handle->push_write (...);
1778 $handle->on_drain (sub {
1779 warn "all data submitted to the kernel\n";
1780 undef $handle;
1781 });
1782
1783If you just want to queue some data and then signal EOF to the other side,
1784consider using C<< ->push_shutdown >> instead.
1785
1786=item I want to contact a TLS/SSL server, I don't care about security.
1787
1788If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1789simply connect to it and then create the AnyEvent::Handle with the C<tls>
1790parameter:
1791
1792 tcp_connect $host, $port, sub {
1793 my ($fh) = @_;
1794
1795 my $handle = new AnyEvent::Handle
1796 fh => $fh,
1797 tls => "connect",
1798 on_error => sub { ... };
1799
1800 $handle->push_write (...);
1801 };
1802
1803=item I want to contact a TLS/SSL server, I do care about security.
1804
1805Then you should additionally enable certificate verification, including
1806peername verification, if the protocol you use supports it (see
1807L<AnyEvent::TLS>, C<verify_peername>).
1808
1809E.g. for HTTPS:
1810
1811 tcp_connect $host, $port, sub {
1812 my ($fh) = @_;
1813
1814 my $handle = new AnyEvent::Handle
1815 fh => $fh,
1816 peername => $host,
1817 tls => "connect",
1818 tls_ctx => { verify => 1, verify_peername => "https" },
1819 ...
1820
1821Note that you must specify the hostname you connected to (or whatever
1822"peername" the protocol needs) as the C<peername> argument, otherwise no
1823peername verification will be done.
1824
1825The above will use the system-dependent default set of trusted CA
1826certificates. If you want to check against a specific CA, add the
1827C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
1828
1829 tls_ctx => {
1830 verify => 1,
1831 verify_peername => "https",
1832 ca_file => "my-ca-cert.pem",
1833 },
1834
1835=item I want to create a TLS/SSL server, how do I do that?
1836
1837Well, you first need to get a server certificate and key. You have
1838three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
1839self-signed certificate (cheap. check the search engine of your choice,
1840there are many tutorials on the net) or c) make your own CA (tinyca2 is a
1841nice program for that purpose).
1842
1843Then create a file with your private key (in PEM format, see
1844L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
1845file should then look like this:
1846
1847 -----BEGIN RSA PRIVATE KEY-----
1848 ...header data
1849 ... lots of base64'y-stuff
1850 -----END RSA PRIVATE KEY-----
1851
1852 -----BEGIN CERTIFICATE-----
1853 ... lots of base64'y-stuff
1854 -----END CERTIFICATE-----
1855
1856The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
1857specify this file as C<cert_file>:
1858
1859 tcp_server undef, $port, sub {
1860 my ($fh) = @_;
1861
1862 my $handle = new AnyEvent::Handle
1863 fh => $fh,
1864 tls => "accept",
1865 tls_ctx => { cert_file => "my-server-keycert.pem" },
1866 ...
1867
1868When you have intermediate CA certificates that your clients might not
1869know about, just append them to the C<cert_file>.
1870
1871=back
1872
1873
1874=head1 SUBCLASSING AnyEvent::Handle
1875
1876In many cases, you might want to subclass AnyEvent::Handle.
1877
1878To make this easier, a given version of AnyEvent::Handle uses these
1879conventions:
1880
1881=over 4
1882
1883=item * all constructor arguments become object members.
1884
1885At least initially, when you pass a C<tls>-argument to the constructor it
1886will end up in C<< $handle->{tls} >>. Those members might be changed or
1887mutated later on (for example C<tls> will hold the TLS connection object).
1888
1889=item * other object member names are prefixed with an C<_>.
1890
1891All object members not explicitly documented (internal use) are prefixed
1892with an underscore character, so the remaining non-C<_>-namespace is free
1893for use for subclasses.
1894
1895=item * all members not documented here and not prefixed with an underscore
1896are free to use in subclasses.
1897
1898Of course, new versions of AnyEvent::Handle may introduce more "public"
1899member variables, but thats just life, at least it is documented.
1900
1901=back
1902
578=head1 AUTHOR 1903=head1 AUTHOR
579 1904
580Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. 1905Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
581 1906
582=cut 1907=cut

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines