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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC vs. Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC