[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.45;	16	our $VERSION = 4.86;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
		29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	},
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		50
54	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
56		53
57	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
60		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
61	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
62	argument.	62	argument.
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
69		69
70	The constructor supports these arguments (all as C<< key => value >> pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	When this parameter is specified, then the C<on_prepare>,
		90	C<on_connect_error> and C<on_connect> callbacks will be called under the
		91	appropriate circumstances:
		92
		93	=over 4
		94
		95	=item on_prepare => $cb->($handle)
		96
		97	This (rarely used) callback is called before a new connection is
		98	attempted, but after the file handle has been created. It could be used to
		99	prepare the file handle with parameters required for the actual connect
		100	(as opposed to settings that can be changed when the connection is already
		101	established).
		102
		103	=item on_connect => $cb->($handle, $host, $port, $retry->())
		104
		105	This callback is called when a connection has been successfully established.
		106
		107	The actual numeric host and port (the socket peername) are passed as
		108	parameters, together with a retry callback.
		109
		110	When, for some reason, the handle is not acceptable, then calling
		111	C<$retry> will continue with the next conenction target (in case of
		112	multi-homed hosts or SRV records there can be multiple connection
		113	endpoints). When it is called then the read and write queues, eof status,
		114	tls status and similar properties of the handle are being reset.
		115
		116	In most cases, ignoring the C<$retry> parameter is the way to go.
		117
		118	=item on_connect_error => $cb->($handle, $message)
		119
		120	This callback is called when the conenction could not be
		121	established. C<$!> will contain the relevant error code, and C<$message> a
		122	message describing it (usually the same as C<"$!">).
		123
		124	If this callback isn't specified, then C<on_error> will be called with a
		125	fatal error instead.
		126
		127	=back
		128
		129	=item on_error => $cb->($handle, $fatal, $message)
		130
		131	This is the error callback, which is called when, well, some error
		132	occured, such as not being able to resolve the hostname, failure to
		133	connect or a read error.
		134
		135	Some errors are fatal (which is indicated by C<$fatal> being true). On
		136	fatal errors the handle object will be destroyed (by a call to C<< ->
		137	destroy >>) after invoking the error callback (which means you are free to
		138	examine the handle object). Examples of fatal errors are an EOF condition
		139	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		140	cases where the other side can close the connection at their will it is
		141	often easiest to not report C<EPIPE> errors in this callback.
		142
		143	AnyEvent::Handle tries to find an appropriate error code for you to check
		144	against, but in some cases (TLS errors), this does not work well. It is
		145	recommended to always output the C<$message> argument in human-readable
		146	error messages (it's usually the same as C<"$!">).
		147
		148	Non-fatal errors can be retried by simply returning, but it is recommended
		149	to simply ignore this parameter and instead abondon the handle object
		150	when this callback is invoked. Examples of non-fatal errors are timeouts
		151	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		152
		153	On callback entrance, the value of C<$!> contains the operating system
		154	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		155	C<EPROTO>).
		156
		157	While not mandatory, it is I<highly> recommended to set this callback, as
		158	you will not be notified of errors otherwise. The default simply calls
		159	C<croak>.
		160
		161	=item on_read => $cb->($handle)
		162
		163	This sets the default read callback, which is called when data arrives
		164	and no read request is in the queue (unlike read queue callbacks, this
		165	callback will only be called when at least one octet of data is in the
		166	read buffer).
		167
		168	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		169	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		170	must not enlarge or modify the read buffer, you can only remove data at
		171	the beginning from it.
		172
		173	When an EOF condition is detected then AnyEvent::Handle will first try to
		174	feed all the remaining data to the queued callbacks and C<on_read> before
		175	calling the C<on_eof> callback. If no progress can be made, then a fatal
		176	error will be raised (with C<$!> set to C<EPIPE>).
		177
		178	Note that, unlike requests in the read queue, an C<on_read> callback
		179	doesn't mean you I<require> some data: if there is an EOF and there
		180	are outstanding read requests then an error will be flagged. With an
		181	C<on_read> callback, the C<on_eof> callback will be invoked.
		182
82	=item on_eof => $cb->($handle)	183	=item on_eof => $cb->($handle)
83		184
84	Set the callback to be called when an end-of-file condition is detected,	185	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	186	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	187	connection cleanly, and there are no outstanding read requests in the
		188	queue (if there are read requests, then an EOF counts as an unexpected
		189	connection close and will be flagged as an error).
87		190
88	For sockets, this just means that the other side has stopped sending data,	191	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	192	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	193	callback and continue writing data, as only the read part has been shut
91	down.	194	down.
92		195
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	196	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	197	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<$handle->{rbuf}> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		198
147	=item on_drain => $cb->($handle)	199	=item on_drain => $cb->($handle)
148		200
149	This sets the callback that is called when the write buffer becomes empty	201	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	202	(or when the callback is set and the buffer is empty already).
…		…
249		301
250	A string used to identify the remote site - usually the DNS hostname	302	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	303	(I<not> IDN!) used to create the connection, rarely the IP address.
252		304
253	Apart from being useful in error messages, this string is also used in TLS	305	Apart from being useful in error messages, this string is also used in TLS
254	common name verification (see C<verify_cn> in L<AnyEvent::TLS>).	306	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		307	verification will be skipped when C<peername> is not specified or
		308	C<undef>.
255		309
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	310	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		311
258	When this parameter is given, it enables TLS (SSL) mode, that means	312	When this parameter is given, it enables TLS (SSL) mode, that means
259	AnyEvent will start a TLS handshake as soon as the conenction has been	313	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		350
297	Instead of an object, you can also specify a hash reference with C<< key	351	Instead of an object, you can also specify a hash reference with C<< key
298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	352	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	353	new TLS context object.
300		354
		355	=item on_starttls => $cb->($handle, $success[, $error_message])
		356
		357	This callback will be invoked when the TLS/SSL handshake has finished. If
		358	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		359	(C<on_stoptls> will not be called in this case).
		360
		361	The session in C<< $handle->{tls} >> can still be examined in this
		362	callback, even when the handshake was not successful.
		363
		364	TLS handshake failures will not cause C<on_error> to be invoked when this
		365	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		366
		367	Without this callback, handshake failures lead to C<on_error> being
		368	called, as normal.
		369
		370	Note that you cannot call C<starttls> right again in this callback. If you
		371	need to do that, start an zero-second timer instead whose callback can
		372	then call C<< ->starttls >> again.
		373
		374	=item on_stoptls => $cb->($handle)
		375
		376	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		377	set, then it will be invoked after freeing the TLS session. If it is not,
		378	then a TLS shutdown condition will be treated like a normal EOF condition
		379	on the handle.
		380
		381	The session in C<< $handle->{tls} >> can still be examined in this
		382	callback.
		383
		384	This callback will only be called on TLS shutdowns, not when the
		385	underlying handle signals EOF.
		386
301	=item json => JSON or JSON::XS object	387	=item json => JSON or JSON::XS object
302		388
303	This is the json coder object used by the C<json> read and write types.	389	This is the json coder object used by the C<json> read and write types.
304		390
305	If you don't supply it, then AnyEvent::Handle will create and use a	391	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		401
316	sub new {	402	sub new {
317	my $class = shift;	403	my $class = shift;
318	my $self = bless { @_ }, $class;	404	my $self = bless { @_ }, $class;
319		405
320	$self->{fh} or Carp::croak "mandatory argument fh is missing";	406	if ($self->{fh}) {
		407	$self->_start;
		408	return unless $self->{fh}; # could be gone by now
		409
		410	} elsif ($self->{connect}) {
		411	require AnyEvent::Socket;
		412
		413	$self->{peername} = $self->{connect}[0]
		414	unless exists $self->{peername};
		415
		416	$self->{_skip_drain_rbuf} = 1;
		417
		418	{
		419	Scalar::Util::weaken (my $self = $self);
		420
		421	$self->{_connect} =
		422	AnyEvent::Socket::tcp_connect (
		423	$self->{connect}[0],
		424	$self->{connect}[1],
		425	sub {
		426	my ($fh, $host, $port, $retry) = @_;
		427
		428	if ($fh) {
		429	$self->{fh} = $fh;
		430
		431	delete $self->{_skip_drain_rbuf};
		432	$self->_start;
		433
		434	$self->{on_connect}
		435	and $self->{on_connect}($self, $host, $port, sub {
		436	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		437	$self->{_skip_drain_rbuf} = 1;
		438	&$retry;
		439	});
		440
		441	} else {
		442	if ($self->{on_connect_error}) {
		443	$self->{on_connect_error}($self, "$!");
		444	$self->destroy;
		445	} else {
		446	$self->fatal ($!, 1);
		447	}
		448	}
		449	},
		450	sub {
		451	local $self->{fh} = $_[0];
		452
		453	$self->{on_prepare}->($self)
		454	if $self->{on_prepare};
		455	}
		456	);
		457	}
		458
		459	} else {
		460	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		461	}
		462
		463	$self
		464	}
		465
		466	sub _start {
		467	my ($self) = @_;
321		468
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		470
324	$self->{_activity} = AnyEvent->now;	471	$self->{_activity} = AnyEvent->now;
325	$self->_timeout;	472	$self->_timeout;
…		…
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	474	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
328		475
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	477	if $self->{tls};
331		478
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		480
334	$self->start_read	481	$self->start_read
335	if $self->{on_read};	482	if $self->{on_read} \|\| @{ $self->{_queue} };
336
337	$self->{fh} && $self
338	}	483	}
339		484
340	sub _shutdown {	485	#sub _shutdown {
341	my ($self) = @_;	486	# my ($self) = @_;
342		487	#
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	488	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying	489	# $self->{_eof} = 1; # tell starttls et. al to stop trying
345		490	#
346	&_freetls;	491	# &_freetls;
347	}	492	#}
348		493
349	sub _error {	494	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	495	my ($self, $errno, $fatal, $message) = @_;
351		496
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	497	$! = $errno;
356	$message \|\|= "$!";	498	$message \|\|= "$!";
357		499
358	if ($self->{on_error}) {	500	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	501	$self->{on_error}($self, $fatal, $message);
		502	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	503	} elsif ($self->{fh}) {
		504	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	505	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	506	}
363	}	507	}
364		508
365	=item $fh = $handle->fh	509	=item $fh = $handle->fh
…		…
423	sub no_delay {	567	sub no_delay {
424	$_[0]{no_delay} = $_[1];	568	$_[0]{no_delay} = $_[1];
425		569
426	eval {	570	eval {
427	local $SIG{__DIE__};	571	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		573	if $_[0]{fh};
429	};	574	};
		575	}
		576
		577	=item $handle->on_starttls ($cb)
		578
		579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		580
		581	=cut
		582
		583	sub on_starttls {
		584	$_[0]{on_starttls} = $_[1];
		585	}
		586
		587	=item $handle->on_stoptls ($cb)
		588
		589	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		590
		591	=cut
		592
		593	sub on_starttls {
		594	$_[0]{on_stoptls} = $_[1];
430	}	595	}
431		596
432	#############################################################################	597	#############################################################################
433		598
434	=item $handle->timeout ($seconds)	599	=item $handle->timeout ($seconds)
…		…
447	# reset the timeout watcher, as neccessary	612	# reset the timeout watcher, as neccessary
448	# also check for time-outs	613	# also check for time-outs
449	sub _timeout {	614	sub _timeout {
450	my ($self) = @_;	615	my ($self) = @_;
451		616
452	if ($self->{timeout}) {	617	if ($self->{timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	618	my $NOW = AnyEvent->now;
454		619
455	# when would the timeout trigger?	620	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	621	my $after = $self->{_activity} + $self->{timeout} - $NOW;
457		622
…		…
460	$self->{_activity} = $NOW;	625	$self->{_activity} = $NOW;
461		626
462	if ($self->{on_timeout}) {	627	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	628	$self->{on_timeout}($self);
464	} else {	629	} else {
465	$self->_error (&Errno::ETIMEDOUT);	630	$self->_error (Errno::ETIMEDOUT);
466	}	631	}
467		632
468	# callback could have changed timeout value, optimise	633	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	634	return unless $self->{timeout};
470		635
…		…
533	Scalar::Util::weaken $self;	698	Scalar::Util::weaken $self;
534		699
535	my $cb = sub {	700	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	701	my $len = syswrite $self->{fh}, $self->{wbuf};
537		702
538	if ($len >= 0) {	703	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	704	substr $self->{wbuf}, 0, $len, "";
540		705
541	$self->{_activity} = AnyEvent->now;	706	$self->{_activity} = AnyEvent->now;
542		707
543	$self->{on_drain}($self)	708	$self->{on_drain}($self)
…		…
579	$self->{_tls_wbuf} .= $_[0];	744	$self->{_tls_wbuf} .= $_[0];
580		745
581	&_dotls ($self);	746	&_dotls ($self);
582	} else {	747	} else {
583	$self->{wbuf} .= $_[0];	748	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	749	$self->_drain_wbuf if $self->{fh};
585	}	750	}
586	}	751	}
587		752
588	=item $handle->push_write (type => @args)	753	=item $handle->push_write (type => @args)
589		754
…		…
683		848
684	=item $handle->push_shutdown	849	=item $handle->push_shutdown
685		850
686	Sometimes you know you want to close the socket after writing your data	851	Sometimes you know you want to close the socket after writing your data
687	before it was actually written. One way to do that is to replace your	852	before it was actually written. One way to do that is to replace your
688	C<on_drain> handler by a callback that shuts down the socket. This method	853	C<on_drain> handler by a callback that shuts down the socket (and set
689	is a shorthand for just that, and replaces the C<on_drain> callback with:	854	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		855	replaces the C<on_drain> callback with:
690		856
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	857	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		858
693	This simply shuts down the write side and signals an EOF condition to the	859	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	860	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	863	afterwards. This is the cleanest way to close a connection.
698		864
699	=cut	865	=cut
700		866
701	sub push_shutdown {	867	sub push_shutdown {
		868	my ($self) = @_;
		869
		870	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	872	}
704		873
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		875
707	This function (not method) lets you add your own types to C<push_write>.	876	This function (not method) lets you add your own types to C<push_write>.
…		…
802	=cut	971	=cut
803		972
804	sub _drain_rbuf {	973	sub _drain_rbuf {
805	my ($self) = @_;	974	my ($self) = @_;
806		975
		976	# avoid recursion
		977	return if exists $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	978	local $self->{_skip_drain_rbuf} = 1;
808		979
809	if (	980	if (
810	defined $self->{rbuf_max}	981	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}	982	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {	983	) {
813	$self->_error (&Errno::ENOSPC, 1), return;	984	$self->_error (Errno::ENOSPC, 1), return;
814	}	985	}
815		986
816	while () {	987	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	988	# we need to use a separate tls read buffer, as we must not receive data while
818	# we are draining the buffer, and this can only happen with TLS.	989	# we are draining the buffer, and this can only happen with TLS.
…		…
822		993
823	if (my $cb = shift @{ $self->{_queue} }) {	994	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	995	unless ($cb->($self)) {
825	if ($self->{_eof}) {	996	if ($self->{_eof}) {
826	# no progress can be made (not enough data and no data forthcoming)	997	# no progress can be made (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	998	$self->_error (Errno::EPIPE, 1), return;
828	}	999	}
829		1000
830	unshift @{ $self->{_queue} }, $cb;	1001	unshift @{ $self->{_queue} }, $cb;
831	last;	1002	last;
832	}	1003	}
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1011	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1012	&& $self->{on_read} # but we still have on_read
842	) {	1013	) {
843	# no further data will arrive	1014	# no further data will arrive
844	# so no progress can be made	1015	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1016	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1017	if $self->{_eof};
847		1018
848	last; # more data might arrive	1019	last; # more data might arrive
849	}	1020	}
850	} else {	1021	} else {
…		…
856		1027
857	if ($self->{_eof}) {	1028	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1029	if ($self->{on_eof}) {
859	$self->{on_eof}($self)	1030	$self->{on_eof}($self)
860	} else {	1031	} else {
861	$self->_error (0, 1);	1032	$self->_error (0, 1, "Unexpected end-of-file");
862	}	1033	}
863	}	1034	}
864		1035
865	# may need to restart read watcher	1036	# may need to restart read watcher
866	unless ($self->{_rw}) {	1037	unless ($self->{_rw}) {
…		…
879		1050
880	sub on_read {	1051	sub on_read {
881	my ($self, $cb) = @_;	1052	my ($self, $cb) = @_;
882		1053
883	$self->{on_read} = $cb;	1054	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1055	$self->_drain_rbuf if $cb;
885	}	1056	}
886		1057
887	=item $handle->rbuf	1058	=item $handle->rbuf
888		1059
889	Returns the read buffer (as a modifiable lvalue).	1060	Returns the read buffer (as a modifiable lvalue).
…		…
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1112	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1113	->($self, $cb, @_);
943	}	1114	}
944		1115
945	push @{ $self->{_queue} }, $cb;	1116	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1117	$self->_drain_rbuf;
947	}	1118	}
948		1119
949	sub unshift_read {	1120	sub unshift_read {
950	my $self = shift;	1121	my $self = shift;
951	my $cb = pop;	1122	my $cb = pop;
…		…
957	->($self, $cb, @_);	1128	->($self, $cb, @_);
958	}	1129	}
959		1130
960		1131
961	unshift @{ $self->{_queue} }, $cb;	1132	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1133	$self->_drain_rbuf;
963	}	1134	}
964		1135
965	=item $handle->push_read (type => @args, $cb)	1136	=item $handle->push_read (type => @args, $cb)
966		1137
967	=item $handle->unshift_read (type => @args, $cb)	1138	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1271	return 1;
1101	}	1272	}
1102		1273
1103	# reject	1274	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1275	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1276	$self->_error (Errno::EBADMSG);
1106	}	1277	}
1107		1278
1108	# skip	1279	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1280	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1281	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1297	my ($self, $cb) = @_;
1127		1298
1128	sub {	1299	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1300	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1301	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1302	$self->_error (Errno::EBADMSG);
1132	}	1303	}
1133	return;	1304	return;
1134	}	1305	}
1135		1306
1136	my $len = $1;	1307	my $len = $1;
…		…
1139	my $string = $_[1];	1310	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1311	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1312	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1313	$cb->($_[0], $string);
1143	} else {	1314	} else {
1144	$self->_error (&Errno::EBADMSG);	1315	$self->_error (Errno::EBADMSG);
1145	}	1316	}
1146	});	1317	});
1147	});	1318	});
1148		1319
1149	1	1320	1
…		…
1216	=cut	1387	=cut
1217		1388
1218	register_read_type json => sub {	1389	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1390	my ($self, $cb) = @_;
1220		1391
1221	require JSON;	1392	my $json = $self->{json} \|\|=
		1393	eval { require JSON::XS; JSON::XS->new->utf8 }
		1394	\|\| do { require JSON; JSON->new->utf8 };
1222		1395
1223	my $data;	1396	my $data;
1224	my $rbuf = \$self->{rbuf};	1397	my $rbuf = \$self->{rbuf};
1225
1226	my $json = $self->{json} \|\|= JSON->new->utf8;
1227		1398
1228	sub {	1399	sub {
1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1400	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1230		1401
1231	if ($ref) {	1402	if ($ref) {
…		…
1239	$json->incr_skip;	1410	$json->incr_skip;
1240		1411
1241	$self->{rbuf} = $json->incr_text;	1412	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1413	$json->incr_text = "";
1243		1414
1244	$self->_error (&Errno::EBADMSG);	1415	$self->_error (Errno::EBADMSG);
1245		1416
1246	()	1417	()
1247	} else {	1418	} else {
1248	$self->{rbuf} = "";	1419	$self->{rbuf} = "";
1249		1420
…		…
1286	# read remaining chunk	1457	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1458	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1459	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1460	$cb->($_[0], $ref);
1290	} else {	1461	} else {
1291	$self->_error (&Errno::EBADMSG);	1462	$self->_error (Errno::EBADMSG);
1292	}	1463	}
1293	});	1464	});
1294	}	1465	}
1295		1466
1296	1	1467	1
…		…
1360	if ($self->{tls}) {	1531	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1533
1363	&_dotls ($self);	1534	&_dotls ($self);
1364	} else {	1535	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1536	$self->_drain_rbuf;
1366	}	1537	}
1367		1538
1368	} elsif (defined $len) {	1539	} elsif (defined $len) {
1369	delete $self->{_rw};	1540	delete $self->{_rw};
1370	$self->{_eof} = 1;	1541	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1542	$self->_drain_rbuf;
1372		1543
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1545	return $self->_error ($!, 1);
1375	}	1546	}
1376	});	1547	});
1377	}	1548	}
1378	}	1549	}
1379		1550
1380	our $ERROR_SYSCALL;	1551	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1552	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1553
1384	sub _tls_error {	1554	sub _tls_error {
1385	my ($self, $err) = @_;	1555	my ($self, $err) = @_;
1386	warn "$err,$!\n";#d#
1387		1556
1388	return $self->_error ($!, 1)	1557	return $self->_error ($!, 1)
1389	if $err == Net::SSLeay::ERROR_SYSCALL ();	1558	if $err == Net::SSLeay::ERROR_SYSCALL ();
1390		1559
		1560	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1561
		1562	# reduce error string to look less scary
		1563	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1564
		1565	if ($self->{_on_starttls}) {
		1566	(delete $self->{_on_starttls})->($self, undef, $err);
		1567	&_freetls;
		1568	} else {
		1569	&_freetls;
1391	$self->_error (&Errno::EPROTO, 1,	1570	$self->_error (Errno::EPROTO, 1, $err);
1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));	1571	}
1393	}	1572	}
1394		1573
1395	# poll the write BIO and send the data if applicable	1574	# poll the write BIO and send the data if applicable
1396	# also decode read data if possible	1575	# also decode read data if possible
1397	# this is basiclaly our TLS state machine	1576	# this is basiclaly our TLS state machine
…		…
1408	}	1587	}
1409		1588
1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1589	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1411	return $self->_tls_error ($tmp)	1590	return $self->_tls_error ($tmp)
1412	if $tmp != $ERROR_WANT_READ	1591	if $tmp != $ERROR_WANT_READ
1413	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1592	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1414	&& $tmp != $ERROR_ZERO_RETURN;
1415	}	1593	}
1416		1594
1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1595	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1418	unless (length $tmp) {	1596	unless (length $tmp) {
1419	# let's treat SSL-eof as we treat normal EOF	1597	$self->{_on_starttls}
1420	delete $self->{_rw};	1598	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1421	$self->{_eof} = 1;
1422	&_freetls;	1599	&_freetls;
		1600
		1601	if ($self->{on_stoptls}) {
		1602	$self->{on_stoptls}($self);
		1603	return;
		1604	} else {
		1605	# let's treat SSL-eof as we treat normal EOF
		1606	delete $self->{_rw};
		1607	$self->{_eof} = 1;
		1608	}
1423	}	1609	}
1424		1610
1425	$self->{_tls_rbuf} .= $tmp;	1611	$self->{_tls_rbuf} .= $tmp;
1426	$self->_drain_rbuf unless $self->{_in_drain};	1612	$self->_drain_rbuf;
1427	$self->{tls} or return; # tls session might have gone away in callback	1613	$self->{tls} or return; # tls session might have gone away in callback
1428	}	1614	}
1429		1615
1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1616	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1431	return $self->_tls_error ($tmp)	1617	return $self->_tls_error ($tmp)
1432	if $tmp != $ERROR_WANT_READ	1618	if $tmp != $ERROR_WANT_READ
1433	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1619	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1434	&& $tmp != $ERROR_ZERO_RETURN;
1435		1620
1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1437	$self->{wbuf} .= $tmp;	1622	$self->{wbuf} .= $tmp;
1438	$self->_drain_wbuf;	1623	$self->_drain_wbuf;
1439	}	1624	}
		1625
		1626	$self->{_on_starttls}
		1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1440	}	1629	}
1441		1630
1442	=item $handle->starttls ($tls[, $tls_ctx])	1631	=item $handle->starttls ($tls[, $tls_ctx])
1443		1632
1444	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1633	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1445	object is created, you can also do that at a later time by calling	1634	object is created, you can also do that at a later time by calling
1446	C<starttls>.	1635	C<starttls>.
		1636
		1637	Starting TLS is currently an asynchronous operation - when you push some
		1638	write data and then call C<< ->starttls >> then TLS negotiation will start
		1639	immediately, after which the queued write data is then sent.
1447		1640
1448	The first argument is the same as the C<tls> constructor argument (either	1641	The first argument is the same as the C<tls> constructor argument (either
1449	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1642	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1450		1643
1451	The second argument is the optional C<AnyEvent::TLS> object that is used	1644	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1461	If it an error to start a TLS handshake more than once per	1654	If it an error to start a TLS handshake more than once per
1462	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1655	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1463		1656
1464	=cut	1657	=cut
1465		1658
		1659	our %TLS_CACHE; #TODO not yet documented, should we?
		1660
1466	sub starttls {	1661	sub starttls {
1467	my ($self, $ssl, $ctx) = @_;	1662	my ($self, $ssl, $ctx) = @_;
1468		1663
1469	require Net::SSLeay;	1664	require Net::SSLeay;
1470		1665
1471	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1666	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1472	if $self->{tls};	1667	if $self->{tls};
1473		1668
1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1477		1671
1478	$ctx \|\|= $self->{tls_ctx};	1672	$ctx \|\|= $self->{tls_ctx};
		1673
		1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1479		1675
1480	if ("HASH" eq ref $ctx) {	1676	if ("HASH" eq ref $ctx) {
1481	require AnyEvent::TLS;	1677	require AnyEvent::TLS;
1482		1678
1483	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1679	if ($ctx->{cache}) {
		1680	my $key = $ctx+0;
		1681	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1682	} else {
1484	$ctx = new AnyEvent::TLS %$ctx;	1683	$ctx = new AnyEvent::TLS %$ctx;
		1684	}
1485	}	1685	}
1486		1686
1487	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1687	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1688	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1489		1689
…		…
1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1509		1709
1510	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1511		1711
		1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1713	if $self->{on_starttls};
		1714
1512	&_dotls; # need to trigger the initial handshake	1715	&_dotls; # need to trigger the initial handshake
1513	$self->start_read; # make sure we actually do read	1716	$self->start_read; # make sure we actually do read
1514	}	1717	}
1515		1718
1516	=item $handle->stoptls	1719	=item $handle->stoptls
…		…
1528	if ($self->{tls}) {	1731	if ($self->{tls}) {
1529	Net::SSLeay::shutdown ($self->{tls});	1732	Net::SSLeay::shutdown ($self->{tls});
1530		1733
1531	&_dotls;	1734	&_dotls;
1532		1735
1533	# we don't give a shit. no, we do, but we can't. no...	1736	# # we don't give a shit. no, we do, but we can't. no...#d#
1534	# we, we... have to use openssl :/	1737	# # we, we... have to use openssl :/#d#
1535	&_freetls;	1738	# &_freetls;#d#
1536	}	1739	}
1537	}	1740	}
1538		1741
1539	sub _freetls {	1742	sub _freetls {
1540	my ($self) = @_;	1743	my ($self) = @_;
1541		1744
1542	return unless $self->{tls};	1745	return unless $self->{tls};
1543		1746
1544	$self->{tls_ctx}->_put_session (delete $self->{tls});	1747	$self->{tls_ctx}->_put_session (delete $self->{tls});
1545		1748
1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1547	}	1750	}
1548		1751
1549	sub DESTROY {	1752	sub DESTROY {
1550	my ($self) = @_;	1753	my ($self) = @_;
1551		1754
1552	&_freetls;	1755	&_freetls;
1553		1756
1554	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1757	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1555		1758
1556	if ($linger && length $self->{wbuf}) {	1759	if ($linger && length $self->{wbuf} && $self->{fh}) {
1557	my $fh = delete $self->{fh};	1760	my $fh = delete $self->{fh};
1558	my $wbuf = delete $self->{wbuf};	1761	my $wbuf = delete $self->{wbuf};
1559		1762
1560	my @linger;	1763	my @linger;
1561		1764
…		…
1575	}	1778	}
1576		1779
1577	=item $handle->destroy	1780	=item $handle->destroy
1578		1781
1579	Shuts down the handle object as much as possible - this call ensures that	1782	Shuts down the handle object as much as possible - this call ensures that
1580	no further callbacks will be invoked and resources will be freed as much	1783	no further callbacks will be invoked and as many resources as possible
1581	as possible. You must not call any methods on the object afterwards.	1784	will be freed. You must not call any methods on the object afterwards.
1582		1785
1583	Normally, you can just "forget" any references to an AnyEvent::Handle	1786	Normally, you can just "forget" any references to an AnyEvent::Handle
1584	object and it will simply shut down. This works in fatal error and EOF	1787	object and it will simply shut down. This works in fatal error and EOF
1585	callbacks, as well as code outside. It does I<NOT> work in a read or write	1788	callbacks, as well as code outside. It does I<NOT> work in a read or write
1586	callback, so when you want to destroy the AnyEvent::Handle object from	1789	callback, so when you want to destroy the AnyEvent::Handle object from
1587	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1790	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1588	that case.	1791	that case.
1589		1792
		1793	Destroying the handle object in this way has the advantage that callbacks
		1794	will be removed as well, so if those are the only reference holders (as
		1795	is common), then one doesn't need to do anything special to break any
		1796	reference cycles.
		1797
1590	The handle might still linger in the background and write out remaining	1798	The handle might still linger in the background and write out remaining
1591	data, as specified by the C<linger> option, however.	1799	data, as specified by the C<linger> option, however.
1592		1800
1593	=cut	1801	=cut
1594		1802
…		…
1661		1869
1662	$handle->on_read (sub { });	1870	$handle->on_read (sub { });
1663	$handle->on_eof (undef);	1871	$handle->on_eof (undef);
1664	$handle->on_error (sub {	1872	$handle->on_error (sub {
1665	my $data = delete $_[0]{rbuf};	1873	my $data = delete $_[0]{rbuf};
1666	undef $handle;
1667	});	1874	});
1668		1875
1669	The reason to use C<on_error> is that TCP connections, due to latencies	1876	The reason to use C<on_error> is that TCP connections, due to latencies
1670	and packets loss, might get closed quite violently with an error, when in	1877	and packets loss, might get closed quite violently with an error, when in
1671	fact, all data has been received.	1878	fact, all data has been received.
…		…
1687	$handle->on_drain (sub {	1894	$handle->on_drain (sub {
1688	warn "all data submitted to the kernel\n";	1895	warn "all data submitted to the kernel\n";
1689	undef $handle;	1896	undef $handle;
1690	});	1897	});
1691		1898
		1899	If you just want to queue some data and then signal EOF to the other side,
		1900	consider using C<< ->push_shutdown >> instead.
		1901
		1902	=item I want to contact a TLS/SSL server, I don't care about security.
		1903
		1904	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1905	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1906	parameter:
		1907
		1908	tcp_connect $host, $port, sub {
		1909	my ($fh) = @_;
		1910
		1911	my $handle = new AnyEvent::Handle
		1912	fh => $fh,
		1913	tls => "connect",
		1914	on_error => sub { ... };
		1915
		1916	$handle->push_write (...);
		1917	};
		1918
		1919	=item I want to contact a TLS/SSL server, I do care about security.
		1920
		1921	Then you should additionally enable certificate verification, including
		1922	peername verification, if the protocol you use supports it (see
		1923	L<AnyEvent::TLS>, C<verify_peername>).
		1924
		1925	E.g. for HTTPS:
		1926
		1927	tcp_connect $host, $port, sub {
		1928	my ($fh) = @_;
		1929
		1930	my $handle = new AnyEvent::Handle
		1931	fh => $fh,
		1932	peername => $host,
		1933	tls => "connect",
		1934	tls_ctx => { verify => 1, verify_peername => "https" },
		1935	...
		1936
		1937	Note that you must specify the hostname you connected to (or whatever
		1938	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1939	peername verification will be done.
		1940
		1941	The above will use the system-dependent default set of trusted CA
		1942	certificates. If you want to check against a specific CA, add the
		1943	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1944
		1945	tls_ctx => {
		1946	verify => 1,
		1947	verify_peername => "https",
		1948	ca_file => "my-ca-cert.pem",
		1949	},
		1950
		1951	=item I want to create a TLS/SSL server, how do I do that?
		1952
		1953	Well, you first need to get a server certificate and key. You have
		1954	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1955	self-signed certificate (cheap. check the search engine of your choice,
		1956	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1957	nice program for that purpose).
		1958
		1959	Then create a file with your private key (in PEM format, see
		1960	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1961	file should then look like this:
		1962
		1963	-----BEGIN RSA PRIVATE KEY-----
		1964	...header data
		1965	... lots of base64'y-stuff
		1966	-----END RSA PRIVATE KEY-----
		1967
		1968	-----BEGIN CERTIFICATE-----
		1969	... lots of base64'y-stuff
		1970	-----END CERTIFICATE-----
		1971
		1972	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1973	specify this file as C<cert_file>:
		1974
		1975	tcp_server undef, $port, sub {
		1976	my ($fh) = @_;
		1977
		1978	my $handle = new AnyEvent::Handle
		1979	fh => $fh,
		1980	tls => "accept",
		1981	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1982	...
		1983
		1984	When you have intermediate CA certificates that your clients might not
		1985	know about, just append them to the C<cert_file>.
		1986
1692	=back	1987	=back
1693		1988
1694		1989
1695	=head1 SUBCLASSING AnyEvent::Handle	1990	=head1 SUBCLASSING AnyEvent::Handle
1696		1991

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs. Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC