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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.98 by root, Thu Oct 2 15:11:01 2008 UTC vs.
Revision 1.158 by root, Fri Jul 24 08:40:35 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.3;	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 {
32	$cv->broadcast;	28	my ($hdl, $fatal, $msg) = @_;
33	},	29	warn "got error $msg\n";
		30	$hdl->destroy;
		31	$cv->send;
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
63		61
64	=head1 METHODS	62	=head1 METHODS
65		63
66	=over 4	64	=over 4
67		65
68	=item B<new (%args)>	66	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		67
70	The constructor supports these arguments (all as key => value pairs).	68	The constructor supports these arguments (all as C<< key => value >> pairs).
71		69
72	=over 4	70	=over 4
73		71
74	=item fh => $filehandle [MANDATORY]	72	=item fh => $filehandle [MANDATORY]
75		73
		74	#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
		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]
		82	#
		83	# You have to specify either this parameter, or C<connect>, below.
		84	#Try to connect to the specified host and service (port), using
		85	#C<AnyEvent::Socket::tcp_connect>.
		86	#
		87	#When this
		88
82	=item on_eof => $cb->($handle)	89	=item on_eof => $cb->($handle)
83		90
84	Set the callback to be called when an end-of-file condition is detected,	91	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	92	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	93	connection cleanly, and there are no outstanding read requests in the
		94	queue (if there are read requests, then an EOF counts as an unexpected
		95	connection close and will be flagged as an error).
87		96
88	For sockets, this just means that the other side has stopped sending data,	97	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	98	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	99	callback and continue writing data, as only the read part has been shut
91	down.	100	down.
92		101
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	102	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>.	103	set, then a fatal error will be raised with C<$!> set to <0>.
99		104
100	=item on_error => $cb->($handle, $fatal)	105	=item on_error => $cb->($handle, $fatal, $message)
101		106
102	This is the error callback, which is called when, well, some error	107	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	108	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	109	connect or a read error.
105		110
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	111	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	112	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	113	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	114	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		116
		117	AnyEvent::Handle tries to find an appropriate error code for you to check
		118	against, but in some cases (TLS errors), this does not work well. It is
		119	recommended to always output the C<$message> argument in human-readable
		120	error messages (it's usually the same as C<"$!">).
111		121
112	Non-fatal errors can be retried by simply returning, but it is recommended	122	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	123	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	124	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	125	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		126
117	On callback entrance, the value of C<$!> contains the operating system	127	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	128	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		129	C<EPROTO>).
119		130
120	While not mandatory, it is I<highly> recommended to set this callback, as	131	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls	132	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.	133	C<croak>.
123		134
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	138	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the	139	callback will only be called when at least one octet of data is in the
129	read buffer).	140	read buffer).
130		141
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	142	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.	143	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		144	must not enlarge or modify the read buffer, you can only remove data at
		145	the beginning from it.
133		146
134	When an EOF condition is detected then AnyEvent::Handle will first try to	147	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before	148	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal	149	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).	150	error will be raised (with C<$!> set to C<EPIPE>).
		151
		152	Note that, unlike requests in the read queue, an C<on_read> callback
		153	doesn't mean you I<require> some data: if there is an EOF and there
		154	are outstanding read requests then an error will be flagged. With an
		155	C<on_read> callback, the C<on_eof> callback will be invoked.
138		156
139	=item on_drain => $cb->($handle)	157	=item on_drain => $cb->($handle)
140		158
141	This sets the callback that is called when the write buffer becomes empty	159	This sets the callback that is called when the write buffer becomes empty
142	(or when the callback is set and the buffer is empty already).	160	(or when the callback is set and the buffer is empty already).
…		…
235		253
236	This will not work for partial TLS data that could not be encoded	254	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost. Calling the C<stoptls> method in time might	255	yet. This data will be lost. Calling the C<stoptls> method in time might
238	help.	256	help.
239		257
		258	=item peername => $string
		259
		260	A string used to identify the remote site - usually the DNS hostname
		261	(I<not> IDN!) used to create the connection, rarely the IP address.
		262
		263	Apart from being useful in error messages, this string is also used in TLS
		264	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		265	verification will be skipped when C<peername> is not specified or
		266	C<undef>.
		267
240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	268	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
241		269
242	When this parameter is given, it enables TLS (SSL) mode, that means	270	When this parameter is given, it enables TLS (SSL) mode, that means
243	AnyEvent will start a TLS handshake as soon as the conenction has been	271	AnyEvent will start a TLS handshake as soon as the conenction has been
244	established and will transparently encrypt/decrypt data afterwards.	272	established and will transparently encrypt/decrypt data afterwards.
		273
		274	All TLS protocol errors will be signalled as C<EPROTO>, with an
		275	appropriate error message.
245		276
246	TLS mode requires Net::SSLeay to be installed (it will be loaded	277	TLS mode requires Net::SSLeay to be installed (it will be loaded
247	automatically when you try to create a TLS handle): this module doesn't	278	automatically when you try to create a TLS handle): this module doesn't
248	have a dependency on that module, so if your module requires it, you have	279	have a dependency on that module, so if your module requires it, you have
249	to add the dependency yourself.	280	to add the dependency yourself.
…		…
253	mode.	284	mode.
254		285
255	You can also provide your own TLS connection object, but you have	286	You can also provide your own TLS connection object, but you have
256	to make sure that you call either C<Net::SSLeay::set_connect_state>	287	to make sure that you call either C<Net::SSLeay::set_connect_state>
257	or C<Net::SSLeay::set_accept_state> on it before you pass it to	288	or C<Net::SSLeay::set_accept_state> on it before you pass it to
258	AnyEvent::Handle.	289	AnyEvent::Handle. Also, this module will take ownership of this connection
		290	object.
		291
		292	At some future point, AnyEvent::Handle might switch to another TLS
		293	implementation, then the option to use your own session object will go
		294	away.
		295
		296	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		297	passing in the wrong integer will lead to certain crash. This most often
		298	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		299	segmentation fault.
259		300
260	See the C<< ->starttls >> method for when need to start TLS negotiation later.	301	See the C<< ->starttls >> method for when need to start TLS negotiation later.
261		302
262	=item tls_ctx => $ssl_ctx	303	=item tls_ctx => $anyevent_tls
263		304
264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	305	Use the given C<AnyEvent::TLS> object to create the new TLS connection
265	(unless a connection object was specified directly). If this parameter is	306	(unless a connection object was specified directly). If this parameter is
266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	307	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		308
		309	Instead of an object, you can also specify a hash reference with C<< key
		310	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		311	new TLS context object.
		312
		313	=item on_starttls => $cb->($handle, $success[, $error_message])
		314
		315	This callback will be invoked when the TLS/SSL handshake has finished. If
		316	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		317	(C<on_stoptls> will not be called in this case).
		318
		319	The session in C<< $handle->{tls} >> can still be examined in this
		320	callback, even when the handshake was not successful.
		321
		322	TLS handshake failures will not cause C<on_error> to be invoked when this
		323	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		324
		325	Without this callback, handshake failures lead to C<on_error> being
		326	called, as normal.
		327
		328	Note that you cannot call C<starttls> right again in this callback. If you
		329	need to do that, start an zero-second timer instead whose callback can
		330	then call C<< ->starttls >> again.
		331
		332	=item on_stoptls => $cb->($handle)
		333
		334	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		335	set, then it will be invoked after freeing the TLS session. If it is not,
		336	then a TLS shutdown condition will be treated like a normal EOF condition
		337	on the handle.
		338
		339	The session in C<< $handle->{tls} >> can still be examined in this
		340	callback.
		341
		342	This callback will only be called on TLS shutdowns, not when the
		343	underlying handle signals EOF.
267		344
268	=item json => JSON or JSON::XS object	345	=item json => JSON or JSON::XS object
269		346
270	This is the json coder object used by the C<json> read and write types.	347	This is the json coder object used by the C<json> read and write types.
271		348
…		…
280		357
281	=cut	358	=cut
282		359
283	sub new {	360	sub new {
284	my $class = shift;	361	my $class = shift;
285
286	my $self = bless { @_ }, $class;	362	my $self = bless { @_ }, $class;
287		363
288	$self->{fh} or Carp::croak "mandatory argument fh is missing";	364	$self->{fh} or Carp::croak "mandatory argument fh is missing";
289		365
290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	366	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		367
		368	$self->{_activity} = AnyEvent->now;
		369	$self->_timeout;
		370
		371	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
291		372
292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	373	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
293	if $self->{tls};	374	if $self->{tls};
294		375
295	$self->{_activity} = AnyEvent->now;
296	$self->_timeout;
297
298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
300		377
301	$self->start_read	378	$self->start_read
302	if $self->{on_read};	379	if $self->{on_read};
303		380
304	$self	381	$self->{fh} && $self
305	}	382	}
306		383
307	sub _shutdown {	384	#sub _shutdown {
308	my ($self) = @_;	385	# my ($self) = @_;
309		386	#
310	delete $self->{_tw};	387	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
311	delete $self->{_rw};	388	# $self->{_eof} = 1; # tell starttls et. al to stop trying
312	delete $self->{_ww};	389	#
313	delete $self->{fh};
314
315	&_freetls;	390	# &_freetls;
316		391	#}
317	delete $self->{on_read};
318	delete $self->{_queue};
319	}
320		392
321	sub _error {	393	sub _error {
322	my ($self, $errno, $fatal) = @_;	394	my ($self, $errno, $fatal, $message) = @_;
323
324	$self->_shutdown
325	if $fatal;
326		395
327	$! = $errno;	396	$! = $errno;
		397	$message \|\|= "$!";
328		398
329	if ($self->{on_error}) {	399	if ($self->{on_error}) {
330	$self->{on_error}($self, $fatal);	400	$self->{on_error}($self, $fatal, $message);
331	} else {	401	$self->destroy if $fatal;
		402	} elsif ($self->{fh}) {
		403	$self->destroy;
332	Carp::croak "AnyEvent::Handle uncaught error: $!";	404	Carp::croak "AnyEvent::Handle uncaught error: $message";
333	}	405	}
334	}	406	}
335		407
336	=item $fh = $handle->fh	408	=item $fh = $handle->fh
337		409
…		…
374	}	446	}
375		447
376	=item $handle->autocork ($boolean)	448	=item $handle->autocork ($boolean)
377		449
378	Enables or disables the current autocork behaviour (see C<autocork>	450	Enables or disables the current autocork behaviour (see C<autocork>
379	constructor argument).	451	constructor argument). Changes will only take effect on the next write.
380		452
381	=cut	453	=cut
		454
		455	sub autocork {
		456	$_[0]{autocork} = $_[1];
		457	}
382		458
383	=item $handle->no_delay ($boolean)	459	=item $handle->no_delay ($boolean)
384		460
385	Enables or disables the C<no_delay> setting (see constructor argument of	461	Enables or disables the C<no_delay> setting (see constructor argument of
386	the same name for details).	462	the same name for details).
…		…
394	local $SIG{__DIE__};	470	local $SIG{__DIE__};
395	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	471	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
396	};	472	};
397	}	473	}
398		474
		475	=item $handle->on_starttls ($cb)
		476
		477	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		478
		479	=cut
		480
		481	sub on_starttls {
		482	$_[0]{on_starttls} = $_[1];
		483	}
		484
		485	=item $handle->on_stoptls ($cb)
		486
		487	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		488
		489	=cut
		490
		491	sub on_starttls {
		492	$_[0]{on_stoptls} = $_[1];
		493	}
		494
399	#############################################################################	495	#############################################################################
400		496
401	=item $handle->timeout ($seconds)	497	=item $handle->timeout ($seconds)
402		498
403	Configures (or disables) the inactivity timeout.	499	Configures (or disables) the inactivity timeout.
…		…
427	$self->{_activity} = $NOW;	523	$self->{_activity} = $NOW;
428		524
429	if ($self->{on_timeout}) {	525	if ($self->{on_timeout}) {
430	$self->{on_timeout}($self);	526	$self->{on_timeout}($self);
431	} else {	527	} else {
432	$self->_error (&Errno::ETIMEDOUT);	528	$self->_error (Errno::ETIMEDOUT);
433	}	529	}
434		530
435	# callback could have changed timeout value, optimise	531	# callback could have changed timeout value, optimise
436	return unless $self->{timeout};	532	return unless $self->{timeout};
437		533
…		…
500	Scalar::Util::weaken $self;	596	Scalar::Util::weaken $self;
501		597
502	my $cb = sub {	598	my $cb = sub {
503	my $len = syswrite $self->{fh}, $self->{wbuf};	599	my $len = syswrite $self->{fh}, $self->{wbuf};
504		600
505	if ($len >= 0) {	601	if (defined $len) {
506	substr $self->{wbuf}, 0, $len, "";	602	substr $self->{wbuf}, 0, $len, "";
507		603
508	$self->{_activity} = AnyEvent->now;	604	$self->{_activity} = AnyEvent->now;
509		605
510	$self->{on_drain}($self)	606	$self->{on_drain}($self)
…		…
645		741
646	pack "w/a*", Storable::nfreeze ($ref)	742	pack "w/a*", Storable::nfreeze ($ref)
647	};	743	};
648		744
649	=back	745	=back
		746
		747	=item $handle->push_shutdown
		748
		749	Sometimes you know you want to close the socket after writing your data
		750	before it was actually written. One way to do that is to replace your
		751	C<on_drain> handler by a callback that shuts down the socket (and set
		752	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		753	replaces the C<on_drain> callback with:
		754
		755	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		756
		757	This simply shuts down the write side and signals an EOF condition to the
		758	the peer.
		759
		760	You can rely on the normal read queue and C<on_eof> handling
		761	afterwards. This is the cleanest way to close a connection.
		762
		763	=cut
		764
		765	sub push_shutdown {
		766	my ($self) = @_;
		767
		768	delete $self->{low_water_mark};
		769	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		770	}
650		771
651	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	772	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
652		773
653	This function (not method) lets you add your own types to C<push_write>.	774	This function (not method) lets you add your own types to C<push_write>.
654	Whenever the given C<type> is used, C<push_write> will invoke the code	775	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
754		875
755	if (	876	if (
756	defined $self->{rbuf_max}	877	defined $self->{rbuf_max}
757	&& $self->{rbuf_max} < length $self->{rbuf}	878	&& $self->{rbuf_max} < length $self->{rbuf}
758	) {	879	) {
759	$self->_error (&Errno::ENOSPC, 1), return;	880	$self->_error (Errno::ENOSPC, 1), return;
760	}	881	}
761		882
762	while () {	883	while () {
		884	# we need to use a separate tls read buffer, as we must not receive data while
		885	# we are draining the buffer, and this can only happen with TLS.
		886	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		887
763	my $len = length $self->{rbuf};	888	my $len = length $self->{rbuf};
764		889
765	if (my $cb = shift @{ $self->{_queue} }) {	890	if (my $cb = shift @{ $self->{_queue} }) {
766	unless ($cb->($self)) {	891	unless ($cb->($self)) {
767	if ($self->{_eof}) {	892	if ($self->{_eof}) {
768	# no progress can be made (not enough data and no data forthcoming)	893	# no progress can be made (not enough data and no data forthcoming)
769	$self->_error (&Errno::EPIPE, 1), return;	894	$self->_error (Errno::EPIPE, 1), return;
770	}	895	}
771		896
772	unshift @{ $self->{_queue} }, $cb;	897	unshift @{ $self->{_queue} }, $cb;
773	last;	898	last;
774	}	899	}
…		…
782	&& !@{ $self->{_queue} } # and the queue is still empty	907	&& !@{ $self->{_queue} } # and the queue is still empty
783	&& $self->{on_read} # but we still have on_read	908	&& $self->{on_read} # but we still have on_read
784	) {	909	) {
785	# no further data will arrive	910	# no further data will arrive
786	# so no progress can be made	911	# so no progress can be made
787	$self->_error (&Errno::EPIPE, 1), return	912	$self->_error (Errno::EPIPE, 1), return
788	if $self->{_eof};	913	if $self->{_eof};
789		914
790	last; # more data might arrive	915	last; # more data might arrive
791	}	916	}
792	} else {	917	} else {
…		…
798		923
799	if ($self->{_eof}) {	924	if ($self->{_eof}) {
800	if ($self->{on_eof}) {	925	if ($self->{on_eof}) {
801	$self->{on_eof}($self)	926	$self->{on_eof}($self)
802	} else {	927	} else {
803	$self->_error (0, 1);	928	$self->_error (0, 1, "Unexpected end-of-file");
804	}	929	}
805	}	930	}
806		931
807	# may need to restart read watcher	932	# may need to restart read watcher
808	unless ($self->{_rw}) {	933	unless ($self->{_rw}) {
…		…
828		953
829	=item $handle->rbuf	954	=item $handle->rbuf
830		955
831	Returns the read buffer (as a modifiable lvalue).	956	Returns the read buffer (as a modifiable lvalue).
832		957
833	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	958	You can access the read buffer directly as the C<< ->{rbuf} >>
834	you want.	959	member, if you want. However, the only operation allowed on the
		960	read buffer (apart from looking at it) is removing data from its
		961	beginning. Otherwise modifying or appending to it is not allowed and will
		962	lead to hard-to-track-down bugs.
835		963
836	NOTE: The read buffer should only be used or modified if the C<on_read>,	964	NOTE: The read buffer should only be used or modified if the C<on_read>,
837	C<push_read> or C<unshift_read> methods are used. The other read methods	965	C<push_read> or C<unshift_read> methods are used. The other read methods
838	automatically manage the read buffer.	966	automatically manage the read buffer.
839		967
…		…
1039	return 1;	1167	return 1;
1040	}	1168	}
1041		1169
1042	# reject	1170	# reject
1043	if ($reject && $$rbuf =~ $reject) {	1171	if ($reject && $$rbuf =~ $reject) {
1044	$self->_error (&Errno::EBADMSG);	1172	$self->_error (Errno::EBADMSG);
1045	}	1173	}
1046		1174
1047	# skip	1175	# skip
1048	if ($skip && $$rbuf =~ $skip) {	1176	if ($skip && $$rbuf =~ $skip) {
1049	$data .= substr $$rbuf, 0, $+[0], "";	1177	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1065	my ($self, $cb) = @_;	1193	my ($self, $cb) = @_;
1066		1194
1067	sub {	1195	sub {
1068	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1196	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1069	if ($_[0]{rbuf} =~ /[^0-9]/) {	1197	if ($_[0]{rbuf} =~ /[^0-9]/) {
1070	$self->_error (&Errno::EBADMSG);	1198	$self->_error (Errno::EBADMSG);
1071	}	1199	}
1072	return;	1200	return;
1073	}	1201	}
1074		1202
1075	my $len = $1;	1203	my $len = $1;
…		…
1078	my $string = $_[1];	1206	my $string = $_[1];
1079	$_[0]->unshift_read (chunk => 1, sub {	1207	$_[0]->unshift_read (chunk => 1, sub {
1080	if ($_[1] eq ",") {	1208	if ($_[1] eq ",") {
1081	$cb->($_[0], $string);	1209	$cb->($_[0], $string);
1082	} else {	1210	} else {
1083	$self->_error (&Errno::EBADMSG);	1211	$self->_error (Errno::EBADMSG);
1084	}	1212	}
1085	});	1213	});
1086	});	1214	});
1087		1215
1088	1	1216	1
…		…
1135	}	1263	}
1136	};	1264	};
1137		1265
1138	=item json => $cb->($handle, $hash_or_arrayref)	1266	=item json => $cb->($handle, $hash_or_arrayref)
1139		1267
1140	Reads a JSON object or array, decodes it and passes it to the callback.	1268	Reads a JSON object or array, decodes it and passes it to the
		1269	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1141		1270
1142	If a C<json> object was passed to the constructor, then that will be used	1271	If a C<json> object was passed to the constructor, then that will be used
1143	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1272	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1144		1273
1145	This read type uses the incremental parser available with JSON version	1274	This read type uses the incremental parser available with JSON version
…		…
1154	=cut	1283	=cut
1155		1284
1156	register_read_type json => sub {	1285	register_read_type json => sub {
1157	my ($self, $cb) = @_;	1286	my ($self, $cb) = @_;
1158		1287
1159	require JSON;	1288	my $json = $self->{json} \|\|=
		1289	eval { require JSON::XS; JSON::XS->new->utf8 }
		1290	\|\| do { require JSON; JSON->new->utf8 };
1160		1291
1161	my $data;	1292	my $data;
1162	my $rbuf = \$self->{rbuf};	1293	my $rbuf = \$self->{rbuf};
1163		1294
1164	my $json = $self->{json} \|\|= JSON->new->utf8;
1165
1166	sub {	1295	sub {
1167	my $ref = $json->incr_parse ($self->{rbuf});	1296	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1168		1297
1169	if ($ref) {	1298	if ($ref) {
1170	$self->{rbuf} = $json->incr_text;	1299	$self->{rbuf} = $json->incr_text;
1171	$json->incr_text = "";	1300	$json->incr_text = "";
1172	$cb->($self, $ref);	1301	$cb->($self, $ref);
1173		1302
1174	1	1303	1
		1304	} elsif ($@) {
		1305	# error case
		1306	$json->incr_skip;
		1307
		1308	$self->{rbuf} = $json->incr_text;
		1309	$json->incr_text = "";
		1310
		1311	$self->_error (Errno::EBADMSG);
		1312
		1313	()
1175	} else {	1314	} else {
1176	$self->{rbuf} = "";	1315	$self->{rbuf} = "";
		1316
1177	()	1317	()
1178	}	1318	}
1179	}	1319	}
1180	};	1320	};
1181		1321
…		…
1213	# read remaining chunk	1353	# read remaining chunk
1214	$_[0]->unshift_read (chunk => $len, sub {	1354	$_[0]->unshift_read (chunk => $len, sub {
1215	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1355	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1216	$cb->($_[0], $ref);	1356	$cb->($_[0], $ref);
1217	} else {	1357	} else {
1218	$self->_error (&Errno::EBADMSG);	1358	$self->_error (Errno::EBADMSG);
1219	}	1359	}
1220	});	1360	});
1221	}	1361	}
1222		1362
1223	1	1363	1
…		…
1302	}	1442	}
1303	});	1443	});
1304	}	1444	}
1305	}	1445	}
1306		1446
		1447	our $ERROR_SYSCALL;
		1448	our $ERROR_WANT_READ;
		1449
		1450	sub _tls_error {
		1451	my ($self, $err) = @_;
		1452
		1453	return $self->_error ($!, 1)
		1454	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1455
		1456	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1457
		1458	# reduce error string to look less scary
		1459	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1460
		1461	if ($self->{_on_starttls}) {
		1462	(delete $self->{_on_starttls})->($self, undef, $err);
		1463	&_freetls;
		1464	} else {
		1465	&_freetls;
		1466	$self->_error (Errno::EPROTO, 1, $err);
		1467	}
		1468	}
		1469
1307	# poll the write BIO and send the data if applicable	1470	# poll the write BIO and send the data if applicable
		1471	# also decode read data if possible
		1472	# this is basiclaly our TLS state machine
		1473	# more efficient implementations are possible with openssl,
		1474	# but not with the buggy and incomplete Net::SSLeay.
1308	sub _dotls {	1475	sub _dotls {
1309	my ($self) = @_;	1476	my ($self) = @_;
1310		1477
1311	my $tmp;	1478	my $tmp;
1312		1479
1313	if (length $self->{_tls_wbuf}) {	1480	if (length $self->{_tls_wbuf}) {
1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1481	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1315	substr $self->{_tls_wbuf}, 0, $tmp, "";	1482	substr $self->{_tls_wbuf}, 0, $tmp, "";
1316	}	1483	}
		1484
		1485	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1486	return $self->_tls_error ($tmp)
		1487	if $tmp != $ERROR_WANT_READ
		1488	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1317	}	1489	}
1318		1490
1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1491	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1320	unless (length $tmp) {	1492	unless (length $tmp) {
1321	# let's treat SSL-eof as we treat normal EOF	1493	$self->{_on_starttls}
1322	delete $self->{_rw};	1494	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1323	$self->{_eof} = 1;
1324	&_freetls;	1495	&_freetls;
		1496
		1497	if ($self->{on_stoptls}) {
		1498	$self->{on_stoptls}($self);
		1499	return;
		1500	} else {
		1501	# let's treat SSL-eof as we treat normal EOF
		1502	delete $self->{_rw};
		1503	$self->{_eof} = 1;
		1504	}
1325	}	1505	}
1326		1506
1327	$self->{rbuf} .= $tmp;	1507	$self->{_tls_rbuf} .= $tmp;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1508	$self->_drain_rbuf unless $self->{_in_drain};
1329	$self->{tls} or return; # tls session might have gone away in callback	1509	$self->{tls} or return; # tls session might have gone away in callback
1330	}	1510	}
1331		1511
1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1333
1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1336	return $self->_error ($!, 1);	1513	return $self->_tls_error ($tmp)
1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1514	if $tmp != $ERROR_WANT_READ
1338	return $self->_error (&Errno::EIO, 1);	1515	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1339	}
1340
1341	# all other errors are fine for our purposes
1342	}
1343		1516
1344	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1517	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1345	$self->{wbuf} .= $tmp;	1518	$self->{wbuf} .= $tmp;
1346	$self->_drain_wbuf;	1519	$self->_drain_wbuf;
1347	}	1520	}
		1521
		1522	$self->{_on_starttls}
		1523	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1524	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1348	}	1525	}
1349		1526
1350	=item $handle->starttls ($tls[, $tls_ctx])	1527	=item $handle->starttls ($tls[, $tls_ctx])
1351		1528
1352	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1529	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1353	object is created, you can also do that at a later time by calling	1530	object is created, you can also do that at a later time by calling
1354	C<starttls>.	1531	C<starttls>.
1355		1532
		1533	Starting TLS is currently an asynchronous operation - when you push some
		1534	write data and then call C<< ->starttls >> then TLS negotiation will start
		1535	immediately, after which the queued write data is then sent.
		1536
1356	The first argument is the same as the C<tls> constructor argument (either	1537	The first argument is the same as the C<tls> constructor argument (either
1357	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1538	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1358		1539
1359	The second argument is the optional C<Net::SSLeay::CTX> object that is	1540	The second argument is the optional C<AnyEvent::TLS> object that is used
1360	used when AnyEvent::Handle has to create its own TLS connection object.	1541	when AnyEvent::Handle has to create its own TLS connection object, or
		1542	a hash reference with C<< key => value >> pairs that will be used to
		1543	construct a new context.
1361		1544
1362	The TLS connection object will end up in C<< $handle->{tls} >> after this	1545	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1363	call and can be used or changed to your liking. Note that the handshake	1546	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1364	might have already started when this function returns.	1547	changed to your liking. Note that the handshake might have already started
		1548	when this function returns.
1365		1549
1366	If it an error to start a TLS handshake more than once per	1550	If it an error to start a TLS handshake more than once per
1367	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1551	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1368		1552
1369	=cut	1553	=cut
1370		1554
		1555	our %TLS_CACHE; #TODO not yet documented, should we?
		1556
1371	sub starttls {	1557	sub starttls {
1372	my ($self, $ssl, $ctx) = @_;	1558	my ($self, $ssl, $ctx) = @_;
1373		1559
1374	require Net::SSLeay;	1560	require Net::SSLeay;
1375		1561
1376	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1377	if $self->{tls};	1563	if $self->{tls};
		1564
		1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1567
		1568	$ctx \|\|= $self->{tls_ctx};
		1569
		1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1571
		1572	if ("HASH" eq ref $ctx) {
		1573	require AnyEvent::TLS;
		1574
		1575	if ($ctx->{cache}) {
		1576	my $key = $ctx+0;
		1577	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1578	} else {
		1579	$ctx = new AnyEvent::TLS %$ctx;
		1580	}
		1581	}
1378		1582
1379	if ($ssl eq "accept") {	1583	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1380	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1584	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1381	Net::SSLeay::set_accept_state ($ssl);
1382	} elsif ($ssl eq "connect") {
1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1384	Net::SSLeay::set_connect_state ($ssl);
1385	}
1386
1387	$self->{tls} = $ssl;
1388		1585
1389	# basically, this is deep magic (because SSL_read should have the same issues)	1586	# basically, this is deep magic (because SSL_read should have the same issues)
1390	# but the openssl maintainers basically said: "trust us, it just works".	1587	# but the openssl maintainers basically said: "trust us, it just works".
1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1588	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1392	# and mismaintained ssleay-module doesn't even offer them).	1589	# and mismaintained ssleay-module doesn't even offer them).
…		…
1396	#	1593	#
1397	# note that we do not try to keep the length constant between writes as we are required to do.	1594	# note that we do not try to keep the length constant between writes as we are required to do.
1398	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1595	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1399	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1596	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1400	# have identity issues in that area.	1597	# have identity issues in that area.
1401	Net::SSLeay::CTX_set_mode ($self->{tls},	1598	# Net::SSLeay::CTX_set_mode ($ssl,
1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1599	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1403	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1600	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1601	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1404		1602
1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1407		1605
1408	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
		1607
		1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1609	if $self->{on_starttls};
1409		1610
1410	&_dotls; # need to trigger the initial handshake	1611	&_dotls; # need to trigger the initial handshake
1411	$self->start_read; # make sure we actually do read	1612	$self->start_read; # make sure we actually do read
1412	}	1613	}
1413		1614
…		…
1426	if ($self->{tls}) {	1627	if ($self->{tls}) {
1427	Net::SSLeay::shutdown ($self->{tls});	1628	Net::SSLeay::shutdown ($self->{tls});
1428		1629
1429	&_dotls;	1630	&_dotls;
1430		1631
1431	# we don't give a shit. no, we do, but we can't. no...	1632	# # we don't give a shit. no, we do, but we can't. no...#d#
1432	# we, we... have to use openssl :/	1633	# # we, we... have to use openssl :/#d#
1433	&_freetls;	1634	# &_freetls;#d#
1434	}	1635	}
1435	}	1636	}
1436		1637
1437	sub _freetls {	1638	sub _freetls {
1438	my ($self) = @_;	1639	my ($self) = @_;
1439		1640
1440	return unless $self->{tls};	1641	return unless $self->{tls};
1441		1642
1442	Net::SSLeay::free (delete $self->{tls});	1643	$self->{tls_ctx}->_put_session (delete $self->{tls});
1443		1644
1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1445	}	1646	}
1446		1647
1447	sub DESTROY {	1648	sub DESTROY {
1448	my $self = shift;	1649	my ($self) = @_;
1449		1650
1450	&_freetls;	1651	&_freetls;
1451		1652
1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1653	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1453		1654
1454	if ($linger && length $self->{wbuf}) {	1655	if ($linger && length $self->{wbuf} && $self->{fh}) {
1455	my $fh = delete $self->{fh};	1656	my $fh = delete $self->{fh};
1456	my $wbuf = delete $self->{wbuf};	1657	my $wbuf = delete $self->{wbuf};
1457		1658
1458	my @linger;	1659	my @linger;
1459		1660
…		…
1470	@linger = ();	1671	@linger = ();
1471	});	1672	});
1472	}	1673	}
1473	}	1674	}
1474		1675
		1676	=item $handle->destroy
		1677
		1678	Shuts down the handle object as much as possible - this call ensures that
		1679	no further callbacks will be invoked and as many resources as possible
		1680	will be freed. You must not call any methods on the object afterwards.
		1681
		1682	Normally, you can just "forget" any references to an AnyEvent::Handle
		1683	object and it will simply shut down. This works in fatal error and EOF
		1684	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1685	callback, so when you want to destroy the AnyEvent::Handle object from
		1686	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1687	that case.
		1688
		1689	Destroying the handle object in this way has the advantage that callbacks
		1690	will be removed as well, so if those are the only reference holders (as
		1691	is common), then one doesn't need to do anything special to break any
		1692	reference cycles.
		1693
		1694	The handle might still linger in the background and write out remaining
		1695	data, as specified by the C<linger> option, however.
		1696
		1697	=cut
		1698
		1699	sub destroy {
		1700	my ($self) = @_;
		1701
		1702	$self->DESTROY;
		1703	%$self = ();
		1704	}
		1705
1475	=item AnyEvent::Handle::TLS_CTX	1706	=item AnyEvent::Handle::TLS_CTX
1476		1707
1477	This function creates and returns the Net::SSLeay::CTX object used by	1708	This function creates and returns the AnyEvent::TLS object used by default
1478	default for TLS mode.	1709	for TLS mode.
1479		1710
1480	The context is created like this:	1711	The context is created by calling L<AnyEvent::TLS> without any arguments.
1481
1482	Net::SSLeay::load_error_strings;
1483	Net::SSLeay::SSLeay_add_ssl_algorithms;
1484	Net::SSLeay::randomize;
1485
1486	my $CTX = Net::SSLeay::CTX_new;
1487
1488	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1489		1712
1490	=cut	1713	=cut
1491		1714
1492	our $TLS_CTX;	1715	our $TLS_CTX;
1493		1716
1494	sub TLS_CTX() {	1717	sub TLS_CTX() {
1495	$TLS_CTX \|\| do {	1718	$TLS_CTX \|\|= do {
1496	require Net::SSLeay;	1719	require AnyEvent::TLS;
1497		1720
1498	Net::SSLeay::load_error_strings ();	1721	new AnyEvent::TLS
1499	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1500	Net::SSLeay::randomize ();
1501
1502	$TLS_CTX = Net::SSLeay::CTX_new ();
1503
1504	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1505
1506	$TLS_CTX
1507	}	1722	}
1508	}	1723	}
1509		1724
1510	=back	1725	=back
1511		1726
1512		1727
1513	=head1 NONFREQUENTLY ASKED QUESTIONS	1728	=head1 NONFREQUENTLY ASKED QUESTIONS
1514		1729
1515	=over 4	1730	=over 4
		1731
		1732	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1733	still get further invocations!
		1734
		1735	That's because AnyEvent::Handle keeps a reference to itself when handling
		1736	read or write callbacks.
		1737
		1738	It is only safe to "forget" the reference inside EOF or error callbacks,
		1739	from within all other callbacks, you need to explicitly call the C<<
		1740	->destroy >> method.
		1741
		1742	=item I get different callback invocations in TLS mode/Why can't I pause
		1743	reading?
		1744
		1745	Unlike, say, TCP, TLS connections do not consist of two independent
		1746	communication channels, one for each direction. Or put differently. The
		1747	read and write directions are not independent of each other: you cannot
		1748	write data unless you are also prepared to read, and vice versa.
		1749
		1750	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1751	callback invocations when you are not expecting any read data - the reason
		1752	is that AnyEvent::Handle always reads in TLS mode.
		1753
		1754	During the connection, you have to make sure that you always have a
		1755	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1756	connection (or when you no longer want to use it) you can call the
		1757	C<destroy> method.
1516		1758
1517	=item How do I read data until the other side closes the connection?	1759	=item How do I read data until the other side closes the connection?
1518		1760
1519	If you just want to read your data into a perl scalar, the easiest way	1761	If you just want to read your data into a perl scalar, the easiest way
1520	to achieve this is by setting an C<on_read> callback that does nothing,	1762	to achieve this is by setting an C<on_read> callback that does nothing,
…		…
1523		1765
1524	$handle->on_read (sub { });	1766	$handle->on_read (sub { });
1525	$handle->on_eof (undef);	1767	$handle->on_eof (undef);
1526	$handle->on_error (sub {	1768	$handle->on_error (sub {
1527	my $data = delete $_[0]{rbuf};	1769	my $data = delete $_[0]{rbuf};
1528	undef $handle;
1529	});	1770	});
1530		1771
1531	The reason to use C<on_error> is that TCP connections, due to latencies	1772	The reason to use C<on_error> is that TCP connections, due to latencies
1532	and packets loss, might get closed quite violently with an error, when in	1773	and packets loss, might get closed quite violently with an error, when in
1533	fact, all data has been received.	1774	fact, all data has been received.
1534		1775
1535	It is usually better to use acknowledgements when transfering data,	1776	It is usually better to use acknowledgements when transferring data,
1536	to make sure the other side hasn't just died and you got the data	1777	to make sure the other side hasn't just died and you got the data
1537	intact. This is also one reason why so many internet protocols have an	1778	intact. This is also one reason why so many internet protocols have an
1538	explicit QUIT command.	1779	explicit QUIT command.
1539
1540		1780
1541	=item I don't want to destroy the handle too early - how do I wait until	1781	=item I don't want to destroy the handle too early - how do I wait until
1542	all data has been written?	1782	all data has been written?
1543		1783
1544	After writing your last bits of data, set the C<on_drain> callback	1784	After writing your last bits of data, set the C<on_drain> callback
…		…
1550	$handle->on_drain (sub {	1790	$handle->on_drain (sub {
1551	warn "all data submitted to the kernel\n";	1791	warn "all data submitted to the kernel\n";
1552	undef $handle;	1792	undef $handle;
1553	});	1793	});
1554		1794
		1795	If you just want to queue some data and then signal EOF to the other side,
		1796	consider using C<< ->push_shutdown >> instead.
		1797
		1798	=item I want to contact a TLS/SSL server, I don't care about security.
		1799
		1800	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1801	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1802	parameter:
		1803
		1804	tcp_connect $host, $port, sub {
		1805	my ($fh) = @_;
		1806
		1807	my $handle = new AnyEvent::Handle
		1808	fh => $fh,
		1809	tls => "connect",
		1810	on_error => sub { ... };
		1811
		1812	$handle->push_write (...);
		1813	};
		1814
		1815	=item I want to contact a TLS/SSL server, I do care about security.
		1816
		1817	Then you should additionally enable certificate verification, including
		1818	peername verification, if the protocol you use supports it (see
		1819	L<AnyEvent::TLS>, C<verify_peername>).
		1820
		1821	E.g. for HTTPS:
		1822
		1823	tcp_connect $host, $port, sub {
		1824	my ($fh) = @_;
		1825
		1826	my $handle = new AnyEvent::Handle
		1827	fh => $fh,
		1828	peername => $host,
		1829	tls => "connect",
		1830	tls_ctx => { verify => 1, verify_peername => "https" },
		1831	...
		1832
		1833	Note that you must specify the hostname you connected to (or whatever
		1834	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1835	peername verification will be done.
		1836
		1837	The above will use the system-dependent default set of trusted CA
		1838	certificates. If you want to check against a specific CA, add the
		1839	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1840
		1841	tls_ctx => {
		1842	verify => 1,
		1843	verify_peername => "https",
		1844	ca_file => "my-ca-cert.pem",
		1845	},
		1846
		1847	=item I want to create a TLS/SSL server, how do I do that?
		1848
		1849	Well, you first need to get a server certificate and key. You have
		1850	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1851	self-signed certificate (cheap. check the search engine of your choice,
		1852	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1853	nice program for that purpose).
		1854
		1855	Then create a file with your private key (in PEM format, see
		1856	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1857	file should then look like this:
		1858
		1859	-----BEGIN RSA PRIVATE KEY-----
		1860	...header data
		1861	... lots of base64'y-stuff
		1862	-----END RSA PRIVATE KEY-----
		1863
		1864	-----BEGIN CERTIFICATE-----
		1865	... lots of base64'y-stuff
		1866	-----END CERTIFICATE-----
		1867
		1868	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1869	specify this file as C<cert_file>:
		1870
		1871	tcp_server undef, $port, sub {
		1872	my ($fh) = @_;
		1873
		1874	my $handle = new AnyEvent::Handle
		1875	fh => $fh,
		1876	tls => "accept",
		1877	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1878	...
		1879
		1880	When you have intermediate CA certificates that your clients might not
		1881	know about, just append them to the C<cert_file>.
		1882
1555	=back	1883	=back
1556		1884
1557		1885
1558	=head1 SUBCLASSING AnyEvent::Handle	1886	=head1 SUBCLASSING AnyEvent::Handle
1559		1887

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.98 by root, Thu Oct 2 15:11:01 2008 UTC vs. Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.98 by root, Thu Oct 2 15:11:01 2008 UTC vs.
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC