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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC vs.
Revision 1.157 by root, Wed Jul 22 23:07:13 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
59	treatment of characters applies to this module as well.	57	treatment of characters applies to this module as well.
60		58
61	All callbacks will be invoked with the handle object as their first	59	All callbacks will be invoked with the handle object as their first
62	argument.	60	argument.
63		61
64	=head2 SIGPIPE is not handled by this module
65
66	SIGPIPE is not handled by this module, so one of the practical
67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
68	'IGNORE'>). At least, this is highly recommend in a networked program: If
69	you use AnyEvent::Handle in a filter program (like sort), exiting on
70	SIGPIPE is probably the right thing to do.
71
72	=head1 METHODS	62	=head1 METHODS
73		63
74	=over 4	64	=over 4
75		65
76	=item B<new (%args)>	66	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
77		67
78	The constructor supports these arguments (all as key => value pairs).	68	The constructor supports these arguments (all as C<< key => value >> pairs).
79		69
80	=over 4	70	=over 4
81		71
82	=item fh => $filehandle [MANDATORY]	72	=item fh => $filehandle [MANDATORY]
83		73
…		…
89		79
90	=item on_eof => $cb->($handle)	80	=item on_eof => $cb->($handle)
91		81
92	Set the callback to be called when an end-of-file condition is detected,	82	Set the callback to be called when an end-of-file condition is detected,
93	i.e. in the case of a socket, when the other side has closed the	83	i.e. in the case of a socket, when the other side has closed the
94	connection cleanly.	84	connection cleanly, and there are no outstanding read requests in the
		85	queue (if there are read requests, then an EOF counts as an unexpected
		86	connection close and will be flagged as an error).
95		87
96	For sockets, this just means that the other side has stopped sending data,	88	For sockets, this just means that the other side has stopped sending data,
97	you can still try to write data, and, in fact, one can return from the eof	89	you can still try to write data, and, in fact, one can return from the EOF
98	callback and continue writing data, as only the read part has been shut	90	callback and continue writing data, as only the read part has been shut
99	down.	91	down.
100		92
101	While not mandatory, it is I<highly> recommended to set an eof callback,
102	otherwise you might end up with a closed socket while you are still
103	waiting for data.
104
105	If an EOF condition has been detected but no C<on_eof> callback has been	93	If an EOF condition has been detected but no C<on_eof> callback has been
106	set, then a fatal error will be raised with C<$!> set to <0>.	94	set, then a fatal error will be raised with C<$!> set to <0>.
107		95
108	=item on_error => $cb->($handle, $fatal)	96	=item on_error => $cb->($handle, $fatal, $message)
109		97
110	This is the error callback, which is called when, well, some error	98	This is the error callback, which is called when, well, some error
111	occured, such as not being able to resolve the hostname, failure to	99	occured, such as not being able to resolve the hostname, failure to
112	connect or a read error.	100	connect or a read error.
113		101
114	Some errors are fatal (which is indicated by C<$fatal> being true). On	102	Some errors are fatal (which is indicated by C<$fatal> being true). On
115	fatal errors the handle object will be shut down and will not be usable	103	fatal errors the handle object will be destroyed (by a call to C<< ->
116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	104	destroy >>) after invoking the error callback (which means you are free to
117	errors are an EOF condition with active (but unsatisifable) read watchers	105	examine the handle object). Examples of fatal errors are an EOF condition
118	(C<EPIPE>) or I/O errors.	106	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		107
		108	AnyEvent::Handle tries to find an appropriate error code for you to check
		109	against, but in some cases (TLS errors), this does not work well. It is
		110	recommended to always output the C<$message> argument in human-readable
		111	error messages (it's usually the same as C<"$!">).
119		112
120	Non-fatal errors can be retried by simply returning, but it is recommended	113	Non-fatal errors can be retried by simply returning, but it is recommended
121	to simply ignore this parameter and instead abondon the handle object	114	to simply ignore this parameter and instead abondon the handle object
122	when this callback is invoked. Examples of non-fatal errors are timeouts	115	when this callback is invoked. Examples of non-fatal errors are timeouts
123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	116	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
124		117
125	On callback entrance, the value of C<$!> contains the operating system	118	On callback entrance, the value of C<$!> contains the operating system
126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	119	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		120	C<EPROTO>).
127		121
128	While not mandatory, it is I<highly> recommended to set this callback, as	122	While not mandatory, it is I<highly> recommended to set this callback, as
129	you will not be notified of errors otherwise. The default simply calls	123	you will not be notified of errors otherwise. The default simply calls
130	C<croak>.	124	C<croak>.
131		125
…		…
135	and no read request is in the queue (unlike read queue callbacks, this	129	and no read request is in the queue (unlike read queue callbacks, this
136	callback will only be called when at least one octet of data is in the	130	callback will only be called when at least one octet of data is in the
137	read buffer).	131	read buffer).
138		132
139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	133	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
140	method or access the C<$handle->{rbuf}> member directly.	134	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		135	must not enlarge or modify the read buffer, you can only remove data at
		136	the beginning from it.
141		137
142	When an EOF condition is detected then AnyEvent::Handle will first try to	138	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	139	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	140	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>).	141	error will be raised (with C<$!> set to C<EPIPE>).
		142
		143	Note that, unlike requests in the read queue, an C<on_read> callback
		144	doesn't mean you I<require> some data: if there is an EOF and there
		145	are outstanding read requests then an error will be flagged. With an
		146	C<on_read> callback, the C<on_eof> callback will be invoked.
146		147
147	=item on_drain => $cb->($handle)	148	=item on_drain => $cb->($handle)
148		149
149	This sets the callback that is called when the write buffer becomes empty	150	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).	151	(or when the callback is set and the buffer is empty already).
…		…
243		244
244	This will not work for partial TLS data that could not be encoded	245	This will not work for partial TLS data that could not be encoded
245	yet. This data will be lost. Calling the C<stoptls> method in time might	246	yet. This data will be lost. Calling the C<stoptls> method in time might
246	help.	247	help.
247		248
		249	=item peername => $string
		250
		251	A string used to identify the remote site - usually the DNS hostname
		252	(I<not> IDN!) used to create the connection, rarely the IP address.
		253
		254	Apart from being useful in error messages, this string is also used in TLS
		255	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		256	verification will be skipped when C<peername> is not specified or
		257	C<undef>.
		258
248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	259	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
249		260
250	When this parameter is given, it enables TLS (SSL) mode, that means	261	When this parameter is given, it enables TLS (SSL) mode, that means
251	AnyEvent will start a TLS handshake as soon as the conenction has been	262	AnyEvent will start a TLS handshake as soon as the conenction has been
252	established and will transparently encrypt/decrypt data afterwards.	263	established and will transparently encrypt/decrypt data afterwards.
		264
		265	All TLS protocol errors will be signalled as C<EPROTO>, with an
		266	appropriate error message.
253		267
254	TLS mode requires Net::SSLeay to be installed (it will be loaded	268	TLS mode requires Net::SSLeay to be installed (it will be loaded
255	automatically when you try to create a TLS handle): this module doesn't	269	automatically when you try to create a TLS handle): this module doesn't
256	have a dependency on that module, so if your module requires it, you have	270	have a dependency on that module, so if your module requires it, you have
257	to add the dependency yourself.	271	to add the dependency yourself.
…		…
261	mode.	275	mode.
262		276
263	You can also provide your own TLS connection object, but you have	277	You can also provide your own TLS connection object, but you have
264	to make sure that you call either C<Net::SSLeay::set_connect_state>	278	to make sure that you call either C<Net::SSLeay::set_connect_state>
265	or C<Net::SSLeay::set_accept_state> on it before you pass it to	279	or C<Net::SSLeay::set_accept_state> on it before you pass it to
266	AnyEvent::Handle.	280	AnyEvent::Handle. Also, this module will take ownership of this connection
		281	object.
		282
		283	At some future point, AnyEvent::Handle might switch to another TLS
		284	implementation, then the option to use your own session object will go
		285	away.
		286
		287	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		288	passing in the wrong integer will lead to certain crash. This most often
		289	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		290	segmentation fault.
267		291
268	See the C<< ->starttls >> method for when need to start TLS negotiation later.	292	See the C<< ->starttls >> method for when need to start TLS negotiation later.
269		293
270	=item tls_ctx => $ssl_ctx	294	=item tls_ctx => $anyevent_tls
271		295
272	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	296	Use the given C<AnyEvent::TLS> object to create the new TLS connection
273	(unless a connection object was specified directly). If this parameter is	297	(unless a connection object was specified directly). If this parameter is
274	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	298	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		299
		300	Instead of an object, you can also specify a hash reference with C<< key
		301	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		302	new TLS context object.
		303
		304	=item on_starttls => $cb->($handle, $success[, $error_message])
		305
		306	This callback will be invoked when the TLS/SSL handshake has finished. If
		307	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		308	(C<on_stoptls> will not be called in this case).
		309
		310	The session in C<< $handle->{tls} >> can still be examined in this
		311	callback, even when the handshake was not successful.
		312
		313	TLS handshake failures will not cause C<on_error> to be invoked when this
		314	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		315
		316	Without this callback, handshake failures lead to C<on_error> being
		317	called, as normal.
		318
		319	Note that you cannot call C<starttls> right again in this callback. If you
		320	need to do that, start an zero-second timer instead whose callback can
		321	then call C<< ->starttls >> again.
		322
		323	=item on_stoptls => $cb->($handle)
		324
		325	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		326	set, then it will be invoked after freeing the TLS session. If it is not,
		327	then a TLS shutdown condition will be treated like a normal EOF condition
		328	on the handle.
		329
		330	The session in C<< $handle->{tls} >> can still be examined in this
		331	callback.
		332
		333	This callback will only be called on TLS shutdowns, not when the
		334	underlying handle signals EOF.
275		335
276	=item json => JSON or JSON::XS object	336	=item json => JSON or JSON::XS object
277		337
278	This is the json coder object used by the C<json> read and write types.	338	This is the json coder object used by the C<json> read and write types.
279		339
…		…
288		348
289	=cut	349	=cut
290		350
291	sub new {	351	sub new {
292	my $class = shift;	352	my $class = shift;
293
294	my $self = bless { @_ }, $class;	353	my $self = bless { @_ }, $class;
295		354
296	$self->{fh} or Carp::croak "mandatory argument fh is missing";	355	$self->{fh} or Carp::croak "mandatory argument fh is missing";
297		356
298	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	357	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		358
		359	$self->{_activity} = AnyEvent->now;
		360	$self->_timeout;
		361
		362	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
299		363
300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	364	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
301	if $self->{tls};	365	if $self->{tls};
302		366
303	$self->{_activity} = AnyEvent->now;
304	$self->_timeout;
305
306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	367	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
308		368
309	$self->start_read	369	$self->start_read
310	if $self->{on_read};	370	if $self->{on_read};
311		371
312	$self	372	$self->{fh} && $self
313	}	373	}
314		374
315	sub _shutdown {	375	#sub _shutdown {
316	my ($self) = @_;	376	# my ($self) = @_;
317		377	#
318	delete $self->{_tw};	378	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
319	delete $self->{_rw};	379	# $self->{_eof} = 1; # tell starttls et. al to stop trying
320	delete $self->{_ww};	380	#
321	delete $self->{fh};
322
323	&_freetls;	381	# &_freetls;
324		382	#}
325	delete $self->{on_read};
326	delete $self->{_queue};
327	}
328		383
329	sub _error {	384	sub _error {
330	my ($self, $errno, $fatal) = @_;	385	my ($self, $errno, $fatal, $message) = @_;
331
332	$self->_shutdown
333	if $fatal;
334		386
335	$! = $errno;	387	$! = $errno;
		388	$message \|\|= "$!";
336		389
337	if ($self->{on_error}) {	390	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	391	$self->{on_error}($self, $fatal, $message);
339	} else {	392	$self->destroy if $fatal;
		393	} elsif ($self->{fh}) {
		394	$self->destroy;
340	Carp::croak "AnyEvent::Handle uncaught error: $!";	395	Carp::croak "AnyEvent::Handle uncaught error: $message";
341	}	396	}
342	}	397	}
343		398
344	=item $fh = $handle->fh	399	=item $fh = $handle->fh
345		400
…		…
382	}	437	}
383		438
384	=item $handle->autocork ($boolean)	439	=item $handle->autocork ($boolean)
385		440
386	Enables or disables the current autocork behaviour (see C<autocork>	441	Enables or disables the current autocork behaviour (see C<autocork>
387	constructor argument).	442	constructor argument). Changes will only take effect on the next write.
388		443
389	=cut	444	=cut
		445
		446	sub autocork {
		447	$_[0]{autocork} = $_[1];
		448	}
390		449
391	=item $handle->no_delay ($boolean)	450	=item $handle->no_delay ($boolean)
392		451
393	Enables or disables the C<no_delay> setting (see constructor argument of	452	Enables or disables the C<no_delay> setting (see constructor argument of
394	the same name for details).	453	the same name for details).
…		…
402	local $SIG{__DIE__};	461	local $SIG{__DIE__};
403	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
404	};	463	};
405	}	464	}
406		465
		466	=item $handle->on_starttls ($cb)
		467
		468	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		469
		470	=cut
		471
		472	sub on_starttls {
		473	$_[0]{on_starttls} = $_[1];
		474	}
		475
		476	=item $handle->on_stoptls ($cb)
		477
		478	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		479
		480	=cut
		481
		482	sub on_starttls {
		483	$_[0]{on_stoptls} = $_[1];
		484	}
		485
407	#############################################################################	486	#############################################################################
408		487
409	=item $handle->timeout ($seconds)	488	=item $handle->timeout ($seconds)
410		489
411	Configures (or disables) the inactivity timeout.	490	Configures (or disables) the inactivity timeout.
…		…
435	$self->{_activity} = $NOW;	514	$self->{_activity} = $NOW;
436		515
437	if ($self->{on_timeout}) {	516	if ($self->{on_timeout}) {
438	$self->{on_timeout}($self);	517	$self->{on_timeout}($self);
439	} else {	518	} else {
440	$self->_error (&Errno::ETIMEDOUT);	519	$self->_error (Errno::ETIMEDOUT);
441	}	520	}
442		521
443	# callback could have changed timeout value, optimise	522	# callback could have changed timeout value, optimise
444	return unless $self->{timeout};	523	return unless $self->{timeout};
445		524
…		…
508	Scalar::Util::weaken $self;	587	Scalar::Util::weaken $self;
509		588
510	my $cb = sub {	589	my $cb = sub {
511	my $len = syswrite $self->{fh}, $self->{wbuf};	590	my $len = syswrite $self->{fh}, $self->{wbuf};
512		591
513	if ($len >= 0) {	592	if (defined $len) {
514	substr $self->{wbuf}, 0, $len, "";	593	substr $self->{wbuf}, 0, $len, "";
515		594
516	$self->{_activity} = AnyEvent->now;	595	$self->{_activity} = AnyEvent->now;
517		596
518	$self->{on_drain}($self)	597	$self->{on_drain}($self)
…		…
653		732
654	pack "w/a*", Storable::nfreeze ($ref)	733	pack "w/a*", Storable::nfreeze ($ref)
655	};	734	};
656		735
657	=back	736	=back
		737
		738	=item $handle->push_shutdown
		739
		740	Sometimes you know you want to close the socket after writing your data
		741	before it was actually written. One way to do that is to replace your
		742	C<on_drain> handler by a callback that shuts down the socket (and set
		743	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		744	replaces the C<on_drain> callback with:
		745
		746	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		747
		748	This simply shuts down the write side and signals an EOF condition to the
		749	the peer.
		750
		751	You can rely on the normal read queue and C<on_eof> handling
		752	afterwards. This is the cleanest way to close a connection.
		753
		754	=cut
		755
		756	sub push_shutdown {
		757	my ($self) = @_;
		758
		759	delete $self->{low_water_mark};
		760	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		761	}
658		762
659	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	763	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
660		764
661	This function (not method) lets you add your own types to C<push_write>.	765	This function (not method) lets you add your own types to C<push_write>.
662	Whenever the given C<type> is used, C<push_write> will invoke the code	766	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
762		866
763	if (	867	if (
764	defined $self->{rbuf_max}	868	defined $self->{rbuf_max}
765	&& $self->{rbuf_max} < length $self->{rbuf}	869	&& $self->{rbuf_max} < length $self->{rbuf}
766	) {	870	) {
767	$self->_error (&Errno::ENOSPC, 1), return;	871	$self->_error (Errno::ENOSPC, 1), return;
768	}	872	}
769		873
770	while () {	874	while () {
		875	# we need to use a separate tls read buffer, as we must not receive data while
		876	# we are draining the buffer, and this can only happen with TLS.
		877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		878
771	my $len = length $self->{rbuf};	879	my $len = length $self->{rbuf};
772		880
773	if (my $cb = shift @{ $self->{_queue} }) {	881	if (my $cb = shift @{ $self->{_queue} }) {
774	unless ($cb->($self)) {	882	unless ($cb->($self)) {
775	if ($self->{_eof}) {	883	if ($self->{_eof}) {
776	# no progress can be made (not enough data and no data forthcoming)	884	# no progress can be made (not enough data and no data forthcoming)
777	$self->_error (&Errno::EPIPE, 1), return;	885	$self->_error (Errno::EPIPE, 1), return;
778	}	886	}
779		887
780	unshift @{ $self->{_queue} }, $cb;	888	unshift @{ $self->{_queue} }, $cb;
781	last;	889	last;
782	}	890	}
…		…
790	&& !@{ $self->{_queue} } # and the queue is still empty	898	&& !@{ $self->{_queue} } # and the queue is still empty
791	&& $self->{on_read} # but we still have on_read	899	&& $self->{on_read} # but we still have on_read
792	) {	900	) {
793	# no further data will arrive	901	# no further data will arrive
794	# so no progress can be made	902	# so no progress can be made
795	$self->_error (&Errno::EPIPE, 1), return	903	$self->_error (Errno::EPIPE, 1), return
796	if $self->{_eof};	904	if $self->{_eof};
797		905
798	last; # more data might arrive	906	last; # more data might arrive
799	}	907	}
800	} else {	908	} else {
…		…
806		914
807	if ($self->{_eof}) {	915	if ($self->{_eof}) {
808	if ($self->{on_eof}) {	916	if ($self->{on_eof}) {
809	$self->{on_eof}($self)	917	$self->{on_eof}($self)
810	} else {	918	} else {
811	$self->_error (0, 1);	919	$self->_error (0, 1, "Unexpected end-of-file");
812	}	920	}
813	}	921	}
814		922
815	# may need to restart read watcher	923	# may need to restart read watcher
816	unless ($self->{_rw}) {	924	unless ($self->{_rw}) {
…		…
836		944
837	=item $handle->rbuf	945	=item $handle->rbuf
838		946
839	Returns the read buffer (as a modifiable lvalue).	947	Returns the read buffer (as a modifiable lvalue).
840		948
841	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	949	You can access the read buffer directly as the C<< ->{rbuf} >>
842	you want.	950	member, if you want. However, the only operation allowed on the
		951	read buffer (apart from looking at it) is removing data from its
		952	beginning. Otherwise modifying or appending to it is not allowed and will
		953	lead to hard-to-track-down bugs.
843		954
844	NOTE: The read buffer should only be used or modified if the C<on_read>,	955	NOTE: The read buffer should only be used or modified if the C<on_read>,
845	C<push_read> or C<unshift_read> methods are used. The other read methods	956	C<push_read> or C<unshift_read> methods are used. The other read methods
846	automatically manage the read buffer.	957	automatically manage the read buffer.
847		958
…		…
1047	return 1;	1158	return 1;
1048	}	1159	}
1049		1160
1050	# reject	1161	# reject
1051	if ($reject && $$rbuf =~ $reject) {	1162	if ($reject && $$rbuf =~ $reject) {
1052	$self->_error (&Errno::EBADMSG);	1163	$self->_error (Errno::EBADMSG);
1053	}	1164	}
1054		1165
1055	# skip	1166	# skip
1056	if ($skip && $$rbuf =~ $skip) {	1167	if ($skip && $$rbuf =~ $skip) {
1057	$data .= substr $$rbuf, 0, $+[0], "";	1168	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1073	my ($self, $cb) = @_;	1184	my ($self, $cb) = @_;
1074		1185
1075	sub {	1186	sub {
1076	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1187	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1077	if ($_[0]{rbuf} =~ /[^0-9]/) {	1188	if ($_[0]{rbuf} =~ /[^0-9]/) {
1078	$self->_error (&Errno::EBADMSG);	1189	$self->_error (Errno::EBADMSG);
1079	}	1190	}
1080	return;	1191	return;
1081	}	1192	}
1082		1193
1083	my $len = $1;	1194	my $len = $1;
…		…
1086	my $string = $_[1];	1197	my $string = $_[1];
1087	$_[0]->unshift_read (chunk => 1, sub {	1198	$_[0]->unshift_read (chunk => 1, sub {
1088	if ($_[1] eq ",") {	1199	if ($_[1] eq ",") {
1089	$cb->($_[0], $string);	1200	$cb->($_[0], $string);
1090	} else {	1201	} else {
1091	$self->_error (&Errno::EBADMSG);	1202	$self->_error (Errno::EBADMSG);
1092	}	1203	}
1093	});	1204	});
1094	});	1205	});
1095		1206
1096	1	1207	1
…		…
1143	}	1254	}
1144	};	1255	};
1145		1256
1146	=item json => $cb->($handle, $hash_or_arrayref)	1257	=item json => $cb->($handle, $hash_or_arrayref)
1147		1258
1148	Reads a JSON object or array, decodes it and passes it to the callback.	1259	Reads a JSON object or array, decodes it and passes it to the
		1260	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1149		1261
1150	If a C<json> object was passed to the constructor, then that will be used	1262	If a C<json> object was passed to the constructor, then that will be used
1151	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1263	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1152		1264
1153	This read type uses the incremental parser available with JSON version	1265	This read type uses the incremental parser available with JSON version
…		…
1162	=cut	1274	=cut
1163		1275
1164	register_read_type json => sub {	1276	register_read_type json => sub {
1165	my ($self, $cb) = @_;	1277	my ($self, $cb) = @_;
1166		1278
1167	require JSON;	1279	my $json = $self->{json} \|\|=
		1280	eval { require JSON::XS; JSON::XS->new->utf8 }
		1281	\|\| do { require JSON; JSON->new->utf8 };
1168		1282
1169	my $data;	1283	my $data;
1170	my $rbuf = \$self->{rbuf};	1284	my $rbuf = \$self->{rbuf};
1171		1285
1172	my $json = $self->{json} \|\|= JSON->new->utf8;
1173
1174	sub {	1286	sub {
1175	my $ref = $json->incr_parse ($self->{rbuf});	1287	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1176		1288
1177	if ($ref) {	1289	if ($ref) {
1178	$self->{rbuf} = $json->incr_text;	1290	$self->{rbuf} = $json->incr_text;
1179	$json->incr_text = "";	1291	$json->incr_text = "";
1180	$cb->($self, $ref);	1292	$cb->($self, $ref);
1181		1293
1182	1	1294	1
		1295	} elsif ($@) {
		1296	# error case
		1297	$json->incr_skip;
		1298
		1299	$self->{rbuf} = $json->incr_text;
		1300	$json->incr_text = "";
		1301
		1302	$self->_error (Errno::EBADMSG);
		1303
		1304	()
1183	} else {	1305	} else {
1184	$self->{rbuf} = "";	1306	$self->{rbuf} = "";
		1307
1185	()	1308	()
1186	}	1309	}
1187	}	1310	}
1188	};	1311	};
1189		1312
…		…
1221	# read remaining chunk	1344	# read remaining chunk
1222	$_[0]->unshift_read (chunk => $len, sub {	1345	$_[0]->unshift_read (chunk => $len, sub {
1223	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1224	$cb->($_[0], $ref);	1347	$cb->($_[0], $ref);
1225	} else {	1348	} else {
1226	$self->_error (&Errno::EBADMSG);	1349	$self->_error (Errno::EBADMSG);
1227	}	1350	}
1228	});	1351	});
1229	}	1352	}
1230		1353
1231	1	1354	1
…		…
1310	}	1433	}
1311	});	1434	});
1312	}	1435	}
1313	}	1436	}
1314		1437
		1438	our $ERROR_SYSCALL;
		1439	our $ERROR_WANT_READ;
		1440
		1441	sub _tls_error {
		1442	my ($self, $err) = @_;
		1443
		1444	return $self->_error ($!, 1)
		1445	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1446
		1447	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1448
		1449	# reduce error string to look less scary
		1450	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1451
		1452	if ($self->{_on_starttls}) {
		1453	(delete $self->{_on_starttls})->($self, undef, $err);
		1454	&_freetls;
		1455	} else {
		1456	&_freetls;
		1457	$self->_error (Errno::EPROTO, 1, $err);
		1458	}
		1459	}
		1460
1315	# poll the write BIO and send the data if applicable	1461	# poll the write BIO and send the data if applicable
		1462	# also decode read data if possible
		1463	# this is basiclaly our TLS state machine
		1464	# more efficient implementations are possible with openssl,
		1465	# but not with the buggy and incomplete Net::SSLeay.
1316	sub _dotls {	1466	sub _dotls {
1317	my ($self) = @_;	1467	my ($self) = @_;
1318		1468
1319	my $tmp;	1469	my $tmp;
1320		1470
1321	if (length $self->{_tls_wbuf}) {	1471	if (length $self->{_tls_wbuf}) {
1322	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1472	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1323	substr $self->{_tls_wbuf}, 0, $tmp, "";	1473	substr $self->{_tls_wbuf}, 0, $tmp, "";
1324	}	1474	}
		1475
		1476	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1477	return $self->_tls_error ($tmp)
		1478	if $tmp != $ERROR_WANT_READ
		1479	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1325	}	1480	}
1326		1481
1327	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1482	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1328	unless (length $tmp) {	1483	unless (length $tmp) {
1329	# let's treat SSL-eof as we treat normal EOF	1484	$self->{_on_starttls}
1330	delete $self->{_rw};	1485	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1331	$self->{_eof} = 1;
1332	&_freetls;	1486	&_freetls;
		1487
		1488	if ($self->{on_stoptls}) {
		1489	$self->{on_stoptls}($self);
		1490	return;
		1491	} else {
		1492	# let's treat SSL-eof as we treat normal EOF
		1493	delete $self->{_rw};
		1494	$self->{_eof} = 1;
		1495	}
1333	}	1496	}
1334		1497
1335	$self->{rbuf} .= $tmp;	1498	$self->{_tls_rbuf} .= $tmp;
1336	$self->_drain_rbuf unless $self->{_in_drain};	1499	$self->_drain_rbuf unless $self->{_in_drain};
1337	$self->{tls} or return; # tls session might have gone away in callback	1500	$self->{tls} or return; # tls session might have gone away in callback
1338	}	1501	}
1339		1502
1340	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1341
1342	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1343	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1344	return $self->_error ($!, 1);	1504	return $self->_tls_error ($tmp)
1345	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1505	if $tmp != $ERROR_WANT_READ
1346	return $self->_error (&Errno::EIO, 1);	1506	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1347	}
1348
1349	# all other errors are fine for our purposes
1350	}
1351		1507
1352	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1508	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1353	$self->{wbuf} .= $tmp;	1509	$self->{wbuf} .= $tmp;
1354	$self->_drain_wbuf;	1510	$self->_drain_wbuf;
1355	}	1511	}
		1512
		1513	$self->{_on_starttls}
		1514	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1515	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1356	}	1516	}
1357		1517
1358	=item $handle->starttls ($tls[, $tls_ctx])	1518	=item $handle->starttls ($tls[, $tls_ctx])
1359		1519
1360	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1361	object is created, you can also do that at a later time by calling	1521	object is created, you can also do that at a later time by calling
1362	C<starttls>.	1522	C<starttls>.
1363		1523
		1524	Starting TLS is currently an asynchronous operation - when you push some
		1525	write data and then call C<< ->starttls >> then TLS negotiation will start
		1526	immediately, after which the queued write data is then sent.
		1527
1364	The first argument is the same as the C<tls> constructor argument (either	1528	The first argument is the same as the C<tls> constructor argument (either
1365	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1529	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1366		1530
1367	The second argument is the optional C<Net::SSLeay::CTX> object that is	1531	The second argument is the optional C<AnyEvent::TLS> object that is used
1368	used when AnyEvent::Handle has to create its own TLS connection object.	1532	when AnyEvent::Handle has to create its own TLS connection object, or
		1533	a hash reference with C<< key => value >> pairs that will be used to
		1534	construct a new context.
1369		1535
1370	The TLS connection object will end up in C<< $handle->{tls} >> after this	1536	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1371	call and can be used or changed to your liking. Note that the handshake	1537	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1372	might have already started when this function returns.	1538	changed to your liking. Note that the handshake might have already started
		1539	when this function returns.
1373		1540
1374	If it an error to start a TLS handshake more than once per	1541	If it an error to start a TLS handshake more than once per
1375	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1542	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1376		1543
1377	=cut	1544	=cut
1378		1545
		1546	our %TLS_CACHE; #TODO not yet documented, should we?
		1547
1379	sub starttls {	1548	sub starttls {
1380	my ($self, $ssl, $ctx) = @_;	1549	my ($self, $ssl, $ctx) = @_;
1381		1550
1382	require Net::SSLeay;	1551	require Net::SSLeay;
1383		1552
1384	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1553	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1385	if $self->{tls};	1554	if $self->{tls};
		1555
		1556	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1557	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1558
		1559	$ctx \|\|= $self->{tls_ctx};
		1560
		1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1562
		1563	if ("HASH" eq ref $ctx) {
		1564	require AnyEvent::TLS;
		1565
		1566	if ($ctx->{cache}) {
		1567	my $key = $ctx+0;
		1568	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1569	} else {
		1570	$ctx = new AnyEvent::TLS %$ctx;
		1571	}
		1572	}
1386		1573
1387	if ($ssl eq "accept") {	1574	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1388	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1575	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1389	Net::SSLeay::set_accept_state ($ssl);
1390	} elsif ($ssl eq "connect") {
1391	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1392	Net::SSLeay::set_connect_state ($ssl);
1393	}
1394
1395	$self->{tls} = $ssl;
1396		1576
1397	# basically, this is deep magic (because SSL_read should have the same issues)	1577	# basically, this is deep magic (because SSL_read should have the same issues)
1398	# but the openssl maintainers basically said: "trust us, it just works".	1578	# but the openssl maintainers basically said: "trust us, it just works".
1399	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1579	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1400	# and mismaintained ssleay-module doesn't even offer them).	1580	# and mismaintained ssleay-module doesn't even offer them).
…		…
1404	#	1584	#
1405	# note that we do not try to keep the length constant between writes as we are required to do.	1585	# note that we do not try to keep the length constant between writes as we are required to do.
1406	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1586	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1407	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1587	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1408	# have identity issues in that area.	1588	# have identity issues in that area.
1409	Net::SSLeay::CTX_set_mode ($self->{tls},	1589	# Net::SSLeay::CTX_set_mode ($ssl,
1410	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1590	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1411	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1591	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1592	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1412		1593
1413	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1594	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1414	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1595	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1415		1596
1416	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1597	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
		1598
		1599	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1600	if $self->{on_starttls};
1417		1601
1418	&_dotls; # need to trigger the initial handshake	1602	&_dotls; # need to trigger the initial handshake
1419	$self->start_read; # make sure we actually do read	1603	$self->start_read; # make sure we actually do read
1420	}	1604	}
1421		1605
…		…
1434	if ($self->{tls}) {	1618	if ($self->{tls}) {
1435	Net::SSLeay::shutdown ($self->{tls});	1619	Net::SSLeay::shutdown ($self->{tls});
1436		1620
1437	&_dotls;	1621	&_dotls;
1438		1622
1439	# we don't give a shit. no, we do, but we can't. no...	1623	# # we don't give a shit. no, we do, but we can't. no...#d#
1440	# we, we... have to use openssl :/	1624	# # we, we... have to use openssl :/#d#
1441	&_freetls;	1625	# &_freetls;#d#
1442	}	1626	}
1443	}	1627	}
1444		1628
1445	sub _freetls {	1629	sub _freetls {
1446	my ($self) = @_;	1630	my ($self) = @_;
1447		1631
1448	return unless $self->{tls};	1632	return unless $self->{tls};
1449		1633
1450	Net::SSLeay::free (delete $self->{tls});	1634	$self->{tls_ctx}->_put_session (delete $self->{tls});
1451		1635
1452	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1636	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1453	}	1637	}
1454		1638
1455	sub DESTROY {	1639	sub DESTROY {
1456	my $self = shift;	1640	my ($self) = @_;
1457		1641
1458	&_freetls;	1642	&_freetls;
1459		1643
1460	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1644	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1461		1645
1462	if ($linger && length $self->{wbuf}) {	1646	if ($linger && length $self->{wbuf} && $self->{fh}) {
1463	my $fh = delete $self->{fh};	1647	my $fh = delete $self->{fh};
1464	my $wbuf = delete $self->{wbuf};	1648	my $wbuf = delete $self->{wbuf};
1465		1649
1466	my @linger;	1650	my @linger;
1467		1651
…		…
1478	@linger = ();	1662	@linger = ();
1479	});	1663	});
1480	}	1664	}
1481	}	1665	}
1482		1666
		1667	=item $handle->destroy
		1668
		1669	Shuts down the handle object as much as possible - this call ensures that
		1670	no further callbacks will be invoked and as many resources as possible
		1671	will be freed. You must not call any methods on the object afterwards.
		1672
		1673	Normally, you can just "forget" any references to an AnyEvent::Handle
		1674	object and it will simply shut down. This works in fatal error and EOF
		1675	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1676	callback, so when you want to destroy the AnyEvent::Handle object from
		1677	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1678	that case.
		1679
		1680	Destroying the handle object in this way has the advantage that callbacks
		1681	will be removed as well, so if those are the only reference holders (as
		1682	is common), then one doesn't need to do anything special to break any
		1683	reference cycles.
		1684
		1685	The handle might still linger in the background and write out remaining
		1686	data, as specified by the C<linger> option, however.
		1687
		1688	=cut
		1689
		1690	sub destroy {
		1691	my ($self) = @_;
		1692
		1693	$self->DESTROY;
		1694	%$self = ();
		1695	}
		1696
1483	=item AnyEvent::Handle::TLS_CTX	1697	=item AnyEvent::Handle::TLS_CTX
1484		1698
1485	This function creates and returns the Net::SSLeay::CTX object used by	1699	This function creates and returns the AnyEvent::TLS object used by default
1486	default for TLS mode.	1700	for TLS mode.
1487		1701
1488	The context is created like this:	1702	The context is created by calling L<AnyEvent::TLS> without any arguments.
1489
1490	Net::SSLeay::load_error_strings;
1491	Net::SSLeay::SSLeay_add_ssl_algorithms;
1492	Net::SSLeay::randomize;
1493
1494	my $CTX = Net::SSLeay::CTX_new;
1495
1496	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1497		1703
1498	=cut	1704	=cut
1499		1705
1500	our $TLS_CTX;	1706	our $TLS_CTX;
1501		1707
1502	sub TLS_CTX() {	1708	sub TLS_CTX() {
1503	$TLS_CTX \|\| do {	1709	$TLS_CTX \|\|= do {
1504	require Net::SSLeay;	1710	require AnyEvent::TLS;
1505		1711
1506	Net::SSLeay::load_error_strings ();	1712	new AnyEvent::TLS
1507	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1508	Net::SSLeay::randomize ();
1509
1510	$TLS_CTX = Net::SSLeay::CTX_new ();
1511
1512	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1513
1514	$TLS_CTX
1515	}	1713	}
1516	}	1714	}
1517		1715
1518	=back	1716	=back
1519		1717
1520		1718
1521	=head1 NONFREQUENTLY ASKED QUESTIONS	1719	=head1 NONFREQUENTLY ASKED QUESTIONS
1522		1720
1523	=over 4	1721	=over 4
		1722
		1723	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1724	still get further invocations!
		1725
		1726	That's because AnyEvent::Handle keeps a reference to itself when handling
		1727	read or write callbacks.
		1728
		1729	It is only safe to "forget" the reference inside EOF or error callbacks,
		1730	from within all other callbacks, you need to explicitly call the C<<
		1731	->destroy >> method.
		1732
		1733	=item I get different callback invocations in TLS mode/Why can't I pause
		1734	reading?
		1735
		1736	Unlike, say, TCP, TLS connections do not consist of two independent
		1737	communication channels, one for each direction. Or put differently. The
		1738	read and write directions are not independent of each other: you cannot
		1739	write data unless you are also prepared to read, and vice versa.
		1740
		1741	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1742	callback invocations when you are not expecting any read data - the reason
		1743	is that AnyEvent::Handle always reads in TLS mode.
		1744
		1745	During the connection, you have to make sure that you always have a
		1746	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1747	connection (or when you no longer want to use it) you can call the
		1748	C<destroy> method.
1524		1749
1525	=item How do I read data until the other side closes the connection?	1750	=item How do I read data until the other side closes the connection?
1526		1751
1527	If you just want to read your data into a perl scalar, the easiest way	1752	If you just want to read your data into a perl scalar, the easiest way
1528	to achieve this is by setting an C<on_read> callback that does nothing,	1753	to achieve this is by setting an C<on_read> callback that does nothing,
…		…
1531		1756
1532	$handle->on_read (sub { });	1757	$handle->on_read (sub { });
1533	$handle->on_eof (undef);	1758	$handle->on_eof (undef);
1534	$handle->on_error (sub {	1759	$handle->on_error (sub {
1535	my $data = delete $_[0]{rbuf};	1760	my $data = delete $_[0]{rbuf};
1536	undef $handle;
1537	});	1761	});
1538		1762
1539	The reason to use C<on_error> is that TCP connections, due to latencies	1763	The reason to use C<on_error> is that TCP connections, due to latencies
1540	and packets loss, might get closed quite violently with an error, when in	1764	and packets loss, might get closed quite violently with an error, when in
1541	fact, all data has been received.	1765	fact, all data has been received.
1542		1766
1543	It is usually better to use acknowledgements when transfering data,	1767	It is usually better to use acknowledgements when transferring data,
1544	to make sure the other side hasn't just died and you got the data	1768	to make sure the other side hasn't just died and you got the data
1545	intact. This is also one reason why so many internet protocols have an	1769	intact. This is also one reason why so many internet protocols have an
1546	explicit QUIT command.	1770	explicit QUIT command.
1547
1548		1771
1549	=item I don't want to destroy the handle too early - how do I wait until	1772	=item I don't want to destroy the handle too early - how do I wait until
1550	all data has been written?	1773	all data has been written?
1551		1774
1552	After writing your last bits of data, set the C<on_drain> callback	1775	After writing your last bits of data, set the C<on_drain> callback
…		…
1558	$handle->on_drain (sub {	1781	$handle->on_drain (sub {
1559	warn "all data submitted to the kernel\n";	1782	warn "all data submitted to the kernel\n";
1560	undef $handle;	1783	undef $handle;
1561	});	1784	});
1562		1785
		1786	If you just want to queue some data and then signal EOF to the other side,
		1787	consider using C<< ->push_shutdown >> instead.
		1788
		1789	=item I want to contact a TLS/SSL server, I don't care about security.
		1790
		1791	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1792	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1793	parameter:
		1794
		1795	tcp_connect $host, $port, sub {
		1796	my ($fh) = @_;
		1797
		1798	my $handle = new AnyEvent::Handle
		1799	fh => $fh,
		1800	tls => "connect",
		1801	on_error => sub { ... };
		1802
		1803	$handle->push_write (...);
		1804	};
		1805
		1806	=item I want to contact a TLS/SSL server, I do care about security.
		1807
		1808	Then you should additionally enable certificate verification, including
		1809	peername verification, if the protocol you use supports it (see
		1810	L<AnyEvent::TLS>, C<verify_peername>).
		1811
		1812	E.g. for HTTPS:
		1813
		1814	tcp_connect $host, $port, sub {
		1815	my ($fh) = @_;
		1816
		1817	my $handle = new AnyEvent::Handle
		1818	fh => $fh,
		1819	peername => $host,
		1820	tls => "connect",
		1821	tls_ctx => { verify => 1, verify_peername => "https" },
		1822	...
		1823
		1824	Note that you must specify the hostname you connected to (or whatever
		1825	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1826	peername verification will be done.
		1827
		1828	The above will use the system-dependent default set of trusted CA
		1829	certificates. If you want to check against a specific CA, add the
		1830	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1831
		1832	tls_ctx => {
		1833	verify => 1,
		1834	verify_peername => "https",
		1835	ca_file => "my-ca-cert.pem",
		1836	},
		1837
		1838	=item I want to create a TLS/SSL server, how do I do that?
		1839
		1840	Well, you first need to get a server certificate and key. You have
		1841	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1842	self-signed certificate (cheap. check the search engine of your choice,
		1843	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1844	nice program for that purpose).
		1845
		1846	Then create a file with your private key (in PEM format, see
		1847	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1848	file should then look like this:
		1849
		1850	-----BEGIN RSA PRIVATE KEY-----
		1851	...header data
		1852	... lots of base64'y-stuff
		1853	-----END RSA PRIVATE KEY-----
		1854
		1855	-----BEGIN CERTIFICATE-----
		1856	... lots of base64'y-stuff
		1857	-----END CERTIFICATE-----
		1858
		1859	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1860	specify this file as C<cert_file>:
		1861
		1862	tcp_server undef, $port, sub {
		1863	my ($fh) = @_;
		1864
		1865	my $handle = new AnyEvent::Handle
		1866	fh => $fh,
		1867	tls => "accept",
		1868	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1869	...
		1870
		1871	When you have intermediate CA certificates that your clients might not
		1872	know about, just append them to the C<cert_file>.
		1873
1563	=back	1874	=back
1564		1875
1565		1876
1566	=head1 SUBCLASSING AnyEvent::Handle	1877	=head1 SUBCLASSING AnyEvent::Handle
1567		1878

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC vs. Revision 1.157 by root, Wed Jul 22 23:07:13 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC vs.
Revision 1.157 by root, Wed Jul 22 23:07:13 2009 UTC