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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs.
Revision 1.145 by root, Mon Jul 6 21:47:14 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.233;	19	our $VERSION = 4.8;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
66	=over 4	66	=over 4
67		67
68	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		69
70	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
75		75
…		…
84	Set the callback to be called when an end-of-file condition is detected,	84	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	86	connection cleanly.
87		87
88	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,
89	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
90	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
91	down.	91	down.
92		92
93	While not mandatory, it is I<highly> recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
95	waiting for data.	95	waiting for data.
96		96
97	If an EOF condition has been detected but no C<on_eof> callback has been	97	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	98	set, then a fatal error will be raised with C<$!> set to <0>.
99		99
100	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal, $message)
101		101
102	This is the error callback, which is called when, well, some error	102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	104	connect or a read error.
105		105
…		…
107	fatal errors the handle object will be shut down and will not be usable	107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers	109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.	110	(C<EPIPE>) or I/O errors.
111		111
		112	AnyEvent::Handle tries to find an appropriate error code for you to check
		113	against, but in some cases (TLS errors), this does not work well. It is
		114	recommended to always output the C<$message> argument in human-readable
		115	error messages (it's usually the same as C<"$!">).
		116
112	Non-fatal errors can be retried by simply returning, but it is recommended	117	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	118	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	119	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		121
117	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		124	C<EPROTO>).
119		125
120	While not mandatory, it is I<highly> recommended to set this callback, as	126	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls	127	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.	128	C<croak>.
123		129
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	133	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the	134	callback will only be called when at least one octet of data is in the
129	read buffer).	135	read buffer).
130		136
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.	138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		139	must not enlarge or modify the read buffer, you can only remove data at
		140	the beginning from it.
133		141
134	When an EOF condition is detected then AnyEvent::Handle will first try to	142	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before	143	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal	144	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
232	write data and will install a watcher that will write this data to the	240	write data and will install a watcher that will write this data to the
233	socket. No errors will be reported (this mostly matches how the operating	241	socket. No errors will be reported (this mostly matches how the operating
234	system treats outstanding data at socket close time).	242	system treats outstanding data at socket close time).
235		243
236	This will not work for partial TLS data that could not be encoded	244	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost.	245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
		247
		248	=item peername => $string
		249
		250	A string used to identify the remote site - usually the DNS hostname
		251	(I<not> IDN!) used to create the connection, rarely the IP address.
		252
		253	Apart from being useful in error messages, this string is also used in TLS
		254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		255	verification will be skipped when C<peername> is not specified or
		256	C<undef>.
238		257
239	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	258	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
240		259
241	When this parameter is given, it enables TLS (SSL) mode, that means	260	When this parameter is given, it enables TLS (SSL) mode, that means
242	AnyEvent will start a TLS handshake as soon as the conenction has been	261	AnyEvent will start a TLS handshake as soon as the conenction has been
243	established and will transparently encrypt/decrypt data afterwards.	262	established and will transparently encrypt/decrypt data afterwards.
		263
		264	All TLS protocol errors will be signalled as C<EPROTO>, with an
		265	appropriate error message.
244		266
245	TLS mode requires Net::SSLeay to be installed (it will be loaded	267	TLS mode requires Net::SSLeay to be installed (it will be loaded
246	automatically when you try to create a TLS handle): this module doesn't	268	automatically when you try to create a TLS handle): this module doesn't
247	have a dependency on that module, so if your module requires it, you have	269	have a dependency on that module, so if your module requires it, you have
248	to add the dependency yourself.	270	to add the dependency yourself.
…		…
252	mode.	274	mode.
253		275
254	You can also provide your own TLS connection object, but you have	276	You can also provide your own TLS connection object, but you have
255	to make sure that you call either C<Net::SSLeay::set_connect_state>	277	to make sure that you call either C<Net::SSLeay::set_connect_state>
256	or C<Net::SSLeay::set_accept_state> on it before you pass it to	278	or C<Net::SSLeay::set_accept_state> on it before you pass it to
257	AnyEvent::Handle.	279	AnyEvent::Handle. Also, this module will take ownership of this connection
		280	object.
		281
		282	At some future point, AnyEvent::Handle might switch to another TLS
		283	implementation, then the option to use your own session object will go
		284	away.
		285
		286	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		287	passing in the wrong integer will lead to certain crash. This most often
		288	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		289	segmentation fault.
258		290
259	See the C<< ->starttls >> method for when need to start TLS negotiation later.	291	See the C<< ->starttls >> method for when need to start TLS negotiation later.
260		292
261	=item tls_ctx => $ssl_ctx	293	=item tls_ctx => $anyevent_tls
262		294
263	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	295	Use the given C<AnyEvent::TLS> object to create the new TLS connection
264	(unless a connection object was specified directly). If this parameter is	296	(unless a connection object was specified directly). If this parameter is
265	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	297	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		298
		299	Instead of an object, you can also specify a hash reference with C<< key
		300	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		301	new TLS context object.
		302
		303	=item on_starttls => $cb->($handle, $success[, $error_message])
		304
		305	This callback will be invoked when the TLS/SSL handshake has finished. If
		306	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		307	(C<on_stoptls> will not be called in this case).
		308
		309	The session in C<< $handle->{tls} >> can still be examined in this
		310	callback, even when the handshake was not successful.
		311
		312	TLS handshake failures will not cause C<on_error> to be invoked when this
		313	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		314
		315	Without this callback, handshake failures lead to C<on_error> being
		316	called, as normal.
		317
		318	Note that you cannot call C<starttls> right again in this callback. If you
		319	need to do that, start an zero-second timer instead whose callback can
		320	then call C<< ->starttls >> again.
		321
		322	=item on_stoptls => $cb->($handle)
		323
		324	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		325	set, then it will be invoked after freeing the TLS session. If it is not,
		326	then a TLS shutdown condition will be treated like a normal EOF condition
		327	on the handle.
		328
		329	The session in C<< $handle->{tls} >> can still be examined in this
		330	callback.
		331
		332	This callback will only be called on TLS shutdowns, not when the
		333	underlying handle signals EOF.
266		334
267	=item json => JSON or JSON::XS object	335	=item json => JSON or JSON::XS object
268		336
269	This is the json coder object used by the C<json> read and write types.	337	This is the json coder object used by the C<json> read and write types.
270		338
…		…
273	texts.	341	texts.
274		342
275	Note that you are responsible to depend on the JSON module if you want to	343	Note that you are responsible to depend on the JSON module if you want to
276	use this functionality, as AnyEvent does not have a dependency itself.	344	use this functionality, as AnyEvent does not have a dependency itself.
277		345
278	=item filter_r => $cb
279
280	=item filter_w => $cb
281
282	These exist, but are undocumented at this time. (They are used internally
283	by the TLS code).
284
285	=back	346	=back
286		347
287	=cut	348	=cut
288		349
289	sub new {	350	sub new {
290	my $class = shift;	351	my $class = shift;
291
292	my $self = bless { @_ }, $class;	352	my $self = bless { @_ }, $class;
293		353
294	$self->{fh} or Carp::croak "mandatory argument fh is missing";	354	$self->{fh} or Carp::croak "mandatory argument fh is missing";
295		355
296	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
297
298	if ($self->{tls}) {
299	require Net::SSLeay;
300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
301	}
302		357
303	$self->{_activity} = AnyEvent->now;	358	$self->{_activity} = AnyEvent->now;
304	$self->_timeout;	359	$self->_timeout;
305		360
306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	361	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		362
		363	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		364	if $self->{tls};
		365
		366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
308		367
309	$self->start_read	368	$self->start_read
310	if $self->{on_read};	369	if $self->{on_read};
311		370
312	$self	371	$self->{fh} && $self
313	}	372	}
314		373
315	sub _shutdown {	374	sub _shutdown {
316	my ($self) = @_;	375	my ($self) = @_;
317		376
318	delete $self->{_tw};	377	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
319	delete $self->{_rw};	378	$self->{_eof} = 1; # tell starttls et. al to stop trying
320	delete $self->{_ww};
321	delete $self->{fh};
322		379
323	$self->stoptls;	380	&_freetls;
324
325	delete $self->{on_read};
326	delete $self->{_queue};
327	}	381	}
328		382
329	sub _error {	383	sub _error {
330	my ($self, $errno, $fatal) = @_;	384	my ($self, $errno, $fatal, $message) = @_;
331		385
332	$self->_shutdown	386	$self->_shutdown
333	if $fatal;	387	if $fatal;
334		388
335	$! = $errno;	389	$! = $errno;
		390	$message \|\|= "$!";
336		391
337	if ($self->{on_error}) {	392	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	393	$self->{on_error}($self, $fatal, $message);
339	} else {	394	} elsif ($self->{fh}) {
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).
…		…
400		459
401	eval {	460	eval {
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	};
		464	}
		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];
405	}	484	}
406		485
407	#############################################################################	486	#############################################################################
408		487
409	=item $handle->timeout ($seconds)	488	=item $handle->timeout ($seconds)
…		…
487	my ($self, $cb) = @_;	566	my ($self, $cb) = @_;
488		567
489	$self->{on_drain} = $cb;	568	$self->{on_drain} = $cb;
490		569
491	$cb->($self)	570	$cb->($self)
492	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	571	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
493	}	572	}
494		573
495	=item $handle->push_write ($data)	574	=item $handle->push_write ($data)
496		575
497	Queues the given scalar to be written. You can push as much data as you	576	Queues the given scalar to be written. You can push as much data as you
…		…
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)
519	if $self->{low_water_mark} >= length $self->{wbuf}	598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
520	&& $self->{on_drain};	599	&& $self->{on_drain};
521		600
522	delete $self->{_ww} unless length $self->{wbuf};	601	delete $self->{_ww} unless length $self->{wbuf};
523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	602	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
524	$self->_error ($!, 1);	603	$self->_error ($!, 1);
…		…
548		627
549	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	628	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
550	->($self, @_);	629	->($self, @_);
551	}	630	}
552		631
553	if ($self->{filter_w}) {	632	if ($self->{tls}) {
554	$self->{filter_w}($self, \$_[0]);	633	$self->{_tls_wbuf} .= $_[0];
		634
		635	&_dotls ($self);
555	} else {	636	} else {
556	$self->{wbuf} .= $_[0];	637	$self->{wbuf} .= $_[0];
557	$self->_drain_wbuf;	638	$self->_drain_wbuf;
558	}	639	}
559	}	640	}
…		…
576	=cut	657	=cut
577		658
578	register_write_type netstring => sub {	659	register_write_type netstring => sub {
579	my ($self, $string) = @_;	660	my ($self, $string) = @_;
580		661
581	sprintf "%d:%s,", (length $string), $string	662	(length $string) . ":$string,"
582	};	663	};
583		664
584	=item packstring => $format, $data	665	=item packstring => $format, $data
585		666
586	An octet string prefixed with an encoded length. The encoding C<$format>	667	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
651		732
652	pack "w/a*", Storable::nfreeze ($ref)	733	pack "w/a*", Storable::nfreeze ($ref)
653	};	734	};
654		735
655	=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	}
656		762
657	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	763	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
658		764
659	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>.
660	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
…		…
764	) {	870	) {
765	$self->_error (&Errno::ENOSPC, 1), return;	871	$self->_error (&Errno::ENOSPC, 1), return;
766	}	872	}
767		873
768	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
769	my $len = length $self->{rbuf};	879	my $len = length $self->{rbuf};
770		880
771	if (my $cb = shift @{ $self->{_queue} }) {	881	if (my $cb = shift @{ $self->{_queue} }) {
772	unless ($cb->($self)) {	882	unless ($cb->($self)) {
773	if ($self->{_eof}) {	883	if ($self->{_eof}) {
…		…
795		905
796	last; # more data might arrive	906	last; # more data might arrive
797	}	907	}
798	} else {	908	} else {
799	# read side becomes idle	909	# read side becomes idle
800	delete $self->{_rw};	910	delete $self->{_rw} unless $self->{tls};
801	last;	911	last;
802	}	912	}
803	}	913	}
804		914
805	if ($self->{_eof}) {	915	if ($self->{_eof}) {
806	if ($self->{on_eof}) {	916	if ($self->{on_eof}) {
807	$self->{on_eof}($self)	917	$self->{on_eof}($self)
808	} else {	918	} else {
809	$self->_error (0, 1);	919	$self->_error (0, 1, "Unexpected end-of-file");
810	}	920	}
811	}	921	}
812		922
813	# may need to restart read watcher	923	# may need to restart read watcher
814	unless ($self->{_rw}) {	924	unless ($self->{_rw}) {
…		…
834		944
835	=item $handle->rbuf	945	=item $handle->rbuf
836		946
837	Returns the read buffer (as a modifiable lvalue).	947	Returns the read buffer (as a modifiable lvalue).
838		948
839	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} >>
840	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.
841		954
842	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>,
843	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
844	automatically manage the read buffer.	957	automatically manage the read buffer.
845		958
…		…
1100	An octet string prefixed with an encoded length. The encoding C<$format>	1213	An octet string prefixed with an encoded length. The encoding C<$format>
1101	uses the same format as a Perl C<pack> format, but must specify a single	1214	uses the same format as a Perl C<pack> format, but must specify a single
1102	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1215	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1103	optional C<!>, C<< < >> or C<< > >> modifier).	1216	optional C<!>, C<< < >> or C<< > >> modifier).
1104		1217
1105	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1218	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1219	EPP uses a prefix of C<N> (4 octtes).
1106		1220
1107	Example: read a block of data prefixed by its length in BER-encoded	1221	Example: read a block of data prefixed by its length in BER-encoded
1108	format (very efficient).	1222	format (very efficient).
1109		1223
1110	$handle->push_read (packstring => "w", sub {	1224	$handle->push_read (packstring => "w", sub {
…		…
1140	}	1254	}
1141	};	1255	};
1142		1256
1143	=item json => $cb->($handle, $hash_or_arrayref)	1257	=item json => $cb->($handle, $hash_or_arrayref)
1144		1258
1145	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.
1146		1261
1147	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
1148	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.
1149		1264
1150	This read type uses the incremental parser available with JSON version	1265	This read type uses the incremental parser available with JSON version
…		…
1159	=cut	1274	=cut
1160		1275
1161	register_read_type json => sub {	1276	register_read_type json => sub {
1162	my ($self, $cb) = @_;	1277	my ($self, $cb) = @_;
1163		1278
1164	require JSON;	1279	my $json = $self->{json} \|\|=
		1280	eval { require JSON::XS; JSON::XS->new->utf8 }
		1281	\|\| do { require JSON; JSON->new->utf8 };
1165		1282
1166	my $data;	1283	my $data;
1167	my $rbuf = \$self->{rbuf};	1284	my $rbuf = \$self->{rbuf};
1168		1285
1169	my $json = $self->{json} \|\|= JSON->new->utf8;
1170
1171	sub {	1286	sub {
1172	my $ref = $json->incr_parse ($self->{rbuf});	1287	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1173		1288
1174	if ($ref) {	1289	if ($ref) {
1175	$self->{rbuf} = $json->incr_text;	1290	$self->{rbuf} = $json->incr_text;
1176	$json->incr_text = "";	1291	$json->incr_text = "";
1177	$cb->($self, $ref);	1292	$cb->($self, $ref);
1178		1293
1179	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	()
1180	} else {	1305	} else {
1181	$self->{rbuf} = "";	1306	$self->{rbuf} = "";
		1307
1182	()	1308	()
1183	}	1309	}
1184	}	1310	}
1185	};	1311	};
1186		1312
…		…
1263	Note that AnyEvent::Handle will automatically C<start_read> for you when	1389	Note that AnyEvent::Handle will automatically C<start_read> for you when
1264	you change the C<on_read> callback or push/unshift a read callback, and it	1390	you change the C<on_read> callback or push/unshift a read callback, and it
1265	will automatically C<stop_read> for you when neither C<on_read> is set nor	1391	will automatically C<stop_read> for you when neither C<on_read> is set nor
1266	there are any read requests in the queue.	1392	there are any read requests in the queue.
1267		1393
		1394	These methods will have no effect when in TLS mode (as TLS doesn't support
		1395	half-duplex connections).
		1396
1268	=cut	1397	=cut
1269		1398
1270	sub stop_read {	1399	sub stop_read {
1271	my ($self) = @_;	1400	my ($self) = @_;
1272		1401
1273	delete $self->{_rw};	1402	delete $self->{_rw} unless $self->{tls};
1274	}	1403	}
1275		1404
1276	sub start_read {	1405	sub start_read {
1277	my ($self) = @_;	1406	my ($self) = @_;
1278		1407
1279	unless ($self->{_rw} \|\| $self->{_eof}) {	1408	unless ($self->{_rw} \|\| $self->{_eof}) {
1280	Scalar::Util::weaken $self;	1409	Scalar::Util::weaken $self;
1281		1410
1282	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1283	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1284	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1285		1414
1286	if ($len > 0) {	1415	if ($len > 0) {
1287	$self->{_activity} = AnyEvent->now;	1416	$self->{_activity} = AnyEvent->now;
1288		1417
1289	$self->{filter_r}	1418	if ($self->{tls}) {
1290	? $self->{filter_r}($self, $rbuf)	1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1291	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1420
		1421	&_dotls ($self);
		1422	} else {
		1423	$self->_drain_rbuf unless $self->{_in_drain};
		1424	}
1292		1425
1293	} elsif (defined $len) {	1426	} elsif (defined $len) {
1294	delete $self->{_rw};	1427	delete $self->{_rw};
1295	$self->{_eof} = 1;	1428	$self->{_eof} = 1;
1296	$self->_drain_rbuf unless $self->{_in_drain};	1429	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1300	}	1433	}
1301	});	1434	});
1302	}	1435	}
1303	}	1436	}
1304		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
		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.
1305	sub _dotls {	1466	sub _dotls {
1306	my ($self) = @_;	1467	my ($self) = @_;
1307		1468
1308	my $buf;	1469	my $tmp;
1309		1470
1310	if (length $self->{_tls_wbuf}) {	1471	if (length $self->{_tls_wbuf}) {
1311	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1472	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1312	substr $self->{_tls_wbuf}, 0, $len, "";	1473	substr $self->{_tls_wbuf}, 0, $tmp, "";
1313	}	1474	}
1314	}
1315		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 \|\| $!);
		1480	}
		1481
		1482	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1483	unless (length $tmp) {
		1484	$self->{_on_starttls}
		1485	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		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	}
		1496	}
		1497
		1498	$self->{_tls_rbuf} .= $tmp;
		1499	$self->_drain_rbuf unless $self->{_in_drain};
		1500	$self->{tls} or return; # tls session might have gone away in callback
		1501	}
		1502
		1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1504	return $self->_tls_error ($tmp)
		1505	if $tmp != $ERROR_WANT_READ
		1506	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1507
1316	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1508	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1317	$self->{wbuf} .= $buf;	1509	$self->{wbuf} .= $tmp;
1318	$self->_drain_wbuf;	1510	$self->_drain_wbuf;
1319	}	1511	}
1320		1512
1321	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1513	$self->{_on_starttls}
1322	if (length $buf) {	1514	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1323	$self->{rbuf} .= $buf;	1515	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1324	$self->_drain_rbuf unless $self->{_in_drain};
1325	} else {
1326	# let's treat SSL-eof as we treat normal EOF
1327	$self->{_eof} = 1;
1328	$self->_shutdown;
1329	return;
1330	}
1331	}
1332
1333	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1334
1335	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1336	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1337	return $self->_error ($!, 1);
1338	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1339	return $self->_error (&Errno::EIO, 1);
1340	}
1341
1342	# all others are fine for our purposes
1343	}
1344	}	1516	}
1345		1517
1346	=item $handle->starttls ($tls[, $tls_ctx])	1518	=item $handle->starttls ($tls[, $tls_ctx])
1347		1519
1348	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1350	C<starttls>.	1522	C<starttls>.
1351		1523
1352	The first argument is the same as the C<tls> constructor argument (either	1524	The first argument is the same as the C<tls> constructor argument (either
1353	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1354		1526
1355	The second argument is the optional C<Net::SSLeay::CTX> object that is	1527	The second argument is the optional C<AnyEvent::TLS> object that is used
1356	used when AnyEvent::Handle has to create its own TLS connection object.	1528	when AnyEvent::Handle has to create its own TLS connection object, or
		1529	a hash reference with C<< key => value >> pairs that will be used to
		1530	construct a new context.
1357		1531
1358	The TLS connection object will end up in C<< $handle->{tls} >> after this	1532	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1359	call and can be used or changed to your liking. Note that the handshake	1533	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1360	might have already started when this function returns.	1534	changed to your liking. Note that the handshake might have already started
		1535	when this function returns.
1361		1536
		1537	If it an error to start a TLS handshake more than once per
		1538	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1539
1362	=cut	1540	=cut
		1541
		1542	our %TLS_CACHE; #TODO not yet documented, should we?
1363		1543
1364	sub starttls {	1544	sub starttls {
1365	my ($self, $ssl, $ctx) = @_;	1545	my ($self, $ssl, $ctx) = @_;
1366		1546
1367	$self->stoptls;	1547	require Net::SSLeay;
1368		1548
1369	if ($ssl eq "accept") {	1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1370	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1550	if $self->{tls};
1371	Net::SSLeay::set_accept_state ($ssl);	1551
1372	} elsif ($ssl eq "connect") {	1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1373	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1374	Net::SSLeay::set_connect_state ($ssl);	1554
		1555	$ctx \|\|= $self->{tls_ctx};
		1556
		1557	if ("HASH" eq ref $ctx) {
		1558	require AnyEvent::TLS;
		1559
		1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1561
		1562	if ($ctx->{cache}) {
		1563	my $key = $ctx+0;
		1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1565	} else {
		1566	$ctx = new AnyEvent::TLS %$ctx;
		1567	}
		1568	}
1375	}	1569
1376		1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1377	$self->{tls} = $ssl;	1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1378		1572
1379	# basically, this is deep magic (because SSL_read should have the same issues)	1573	# basically, this is deep magic (because SSL_read should have the same issues)
1380	# but the openssl maintainers basically said: "trust us, it just works".	1574	# but the openssl maintainers basically said: "trust us, it just works".
1381	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1382	# and mismaintained ssleay-module doesn't even offer them).	1576	# and mismaintained ssleay-module doesn't even offer them).
1383	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1577	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1384	#	1578	#
1385	# in short: this is a mess.	1579	# in short: this is a mess.
1386	#	1580	#
1387	# note that we do not try to kepe the length constant between writes as we are required to do.	1581	# note that we do not try to keep the length constant between writes as we are required to do.
1388	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1582	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1389	# and we drive openssl fully in blocking mode here.	1583	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1584	# have identity issues in that area.
1390	Net::SSLeay::CTX_set_mode ($self->{tls},	1585	# Net::SSLeay::CTX_set_mode ($ssl,
1391	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1392	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1587	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1393		1589
1394	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1395	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1396		1592
1397	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1398		1594
1399	$self->{filter_w} = sub {	1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1400	$_[0]{_tls_wbuf} .= ${$_[1]};	1596	if $self->{on_starttls};
1401	&_dotls;	1597
1402	};	1598	&_dotls; # need to trigger the initial handshake
1403	$self->{filter_r} = sub {	1599	$self->start_read; # make sure we actually do read
1404	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1405	&_dotls;
1406	};
1407	}	1600	}
1408		1601
1409	=item $handle->stoptls	1602	=item $handle->stoptls
1410		1603
1411	Destroys the SSL connection, if any. Partial read or write data will be	1604	Shuts down the SSL connection - this makes a proper EOF handshake by
1412	lost.	1605	sending a close notify to the other side, but since OpenSSL doesn't
		1606	support non-blocking shut downs, it is not possible to re-use the stream
		1607	afterwards.
1413		1608
1414	=cut	1609	=cut
1415		1610
1416	sub stoptls {	1611	sub stoptls {
1417	my ($self) = @_;	1612	my ($self) = @_;
1418		1613
1419	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1614	if ($self->{tls}) {
		1615	Net::SSLeay::shutdown ($self->{tls});
1420		1616
1421	delete $self->{_rbio};	1617	&_dotls;
1422	delete $self->{_wbio};	1618
1423	delete $self->{_tls_wbuf};	1619	# # we don't give a shit. no, we do, but we can't. no...#d#
1424	delete $self->{filter_r};	1620	# # we, we... have to use openssl :/#d#
1425	delete $self->{filter_w};	1621	# &_freetls;#d#
		1622	}
		1623	}
		1624
		1625	sub _freetls {
		1626	my ($self) = @_;
		1627
		1628	return unless $self->{tls};
		1629
		1630	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1631
		1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1426	}	1633	}
1427		1634
1428	sub DESTROY {	1635	sub DESTROY {
1429	my $self = shift;	1636	my ($self) = @_;
1430		1637
1431	$self->stoptls;	1638	&_freetls;
1432		1639
1433	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1434		1641
1435	if ($linger && length $self->{wbuf}) {	1642	if ($linger && length $self->{wbuf}) {
1436	my $fh = delete $self->{fh};	1643	my $fh = delete $self->{fh};
…		…
1451	@linger = ();	1658	@linger = ();
1452	});	1659	});
1453	}	1660	}
1454	}	1661	}
1455		1662
		1663	=item $handle->destroy
		1664
		1665	Shuts down the handle object as much as possible - this call ensures that
		1666	no further callbacks will be invoked and as many resources as possible
		1667	will be freed. You must not call any methods on the object afterwards.
		1668
		1669	Normally, you can just "forget" any references to an AnyEvent::Handle
		1670	object and it will simply shut down. This works in fatal error and EOF
		1671	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1672	callback, so when you want to destroy the AnyEvent::Handle object from
		1673	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1674	that case.
		1675
		1676	The handle might still linger in the background and write out remaining
		1677	data, as specified by the C<linger> option, however.
		1678
		1679	=cut
		1680
		1681	sub destroy {
		1682	my ($self) = @_;
		1683
		1684	$self->DESTROY;
		1685	%$self = ();
		1686	}
		1687
1456	=item AnyEvent::Handle::TLS_CTX	1688	=item AnyEvent::Handle::TLS_CTX
1457		1689
1458	This function creates and returns the Net::SSLeay::CTX object used by	1690	This function creates and returns the AnyEvent::TLS object used by default
1459	default for TLS mode.	1691	for TLS mode.
1460		1692
1461	The context is created like this:	1693	The context is created by calling L<AnyEvent::TLS> without any arguments.
1462
1463	Net::SSLeay::load_error_strings;
1464	Net::SSLeay::SSLeay_add_ssl_algorithms;
1465	Net::SSLeay::randomize;
1466
1467	my $CTX = Net::SSLeay::CTX_new;
1468
1469	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1470		1694
1471	=cut	1695	=cut
1472		1696
1473	our $TLS_CTX;	1697	our $TLS_CTX;
1474		1698
1475	sub TLS_CTX() {	1699	sub TLS_CTX() {
1476	$TLS_CTX \|\| do {	1700	$TLS_CTX \|\|= do {
1477	require Net::SSLeay;	1701	require AnyEvent::TLS;
1478		1702
1479	Net::SSLeay::load_error_strings ();	1703	new AnyEvent::TLS
1480	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1481	Net::SSLeay::randomize ();
1482
1483	$TLS_CTX = Net::SSLeay::CTX_new ();
1484
1485	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1486
1487	$TLS_CTX
1488	}	1704	}
1489	}	1705	}
1490		1706
1491	=back	1707	=back
		1708
		1709
		1710	=head1 NONFREQUENTLY ASKED QUESTIONS
		1711
		1712	=over 4
		1713
		1714	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1715	still get further invocations!
		1716
		1717	That's because AnyEvent::Handle keeps a reference to itself when handling
		1718	read or write callbacks.
		1719
		1720	It is only safe to "forget" the reference inside EOF or error callbacks,
		1721	from within all other callbacks, you need to explicitly call the C<<
		1722	->destroy >> method.
		1723
		1724	=item I get different callback invocations in TLS mode/Why can't I pause
		1725	reading?
		1726
		1727	Unlike, say, TCP, TLS connections do not consist of two independent
		1728	communication channels, one for each direction. Or put differently. The
		1729	read and write directions are not independent of each other: you cannot
		1730	write data unless you are also prepared to read, and vice versa.
		1731
		1732	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1733	callback invocations when you are not expecting any read data - the reason
		1734	is that AnyEvent::Handle always reads in TLS mode.
		1735
		1736	During the connection, you have to make sure that you always have a
		1737	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1738	connection (or when you no longer want to use it) you can call the
		1739	C<destroy> method.
		1740
		1741	=item How do I read data until the other side closes the connection?
		1742
		1743	If you just want to read your data into a perl scalar, the easiest way
		1744	to achieve this is by setting an C<on_read> callback that does nothing,
		1745	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1746	will be in C<$_[0]{rbuf}>:
		1747
		1748	$handle->on_read (sub { });
		1749	$handle->on_eof (undef);
		1750	$handle->on_error (sub {
		1751	my $data = delete $_[0]{rbuf};
		1752	undef $handle;
		1753	});
		1754
		1755	The reason to use C<on_error> is that TCP connections, due to latencies
		1756	and packets loss, might get closed quite violently with an error, when in
		1757	fact, all data has been received.
		1758
		1759	It is usually better to use acknowledgements when transferring data,
		1760	to make sure the other side hasn't just died and you got the data
		1761	intact. This is also one reason why so many internet protocols have an
		1762	explicit QUIT command.
		1763
		1764	=item I don't want to destroy the handle too early - how do I wait until
		1765	all data has been written?
		1766
		1767	After writing your last bits of data, set the C<on_drain> callback
		1768	and destroy the handle in there - with the default setting of
		1769	C<low_water_mark> this will be called precisely when all data has been
		1770	written to the socket:
		1771
		1772	$handle->push_write (...);
		1773	$handle->on_drain (sub {
		1774	warn "all data submitted to the kernel\n";
		1775	undef $handle;
		1776	});
		1777
		1778	If you just want to queue some data and then signal EOF to the other side,
		1779	consider using C<< ->push_shutdown >> instead.
		1780
		1781	=item I want to contact a TLS/SSL server, I don't care about security.
		1782
		1783	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1784	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1785	parameter:
		1786
		1787	tcp_connect $host, $port, sub {
		1788	my ($fh) = @_;
		1789
		1790	my $handle = new AnyEvent::Handle
		1791	fh => $fh,
		1792	tls => "connect",
		1793	on_error => sub { ... };
		1794
		1795	$handle->push_write (...);
		1796	};
		1797
		1798	=item I want to contact a TLS/SSL server, I do care about security.
		1799
		1800	Then you should additionally enable certificate verification, including
		1801	peername verification, if the protocol you use supports it (see
		1802	L<AnyEvent::TLS>, C<verify_peername>).
		1803
		1804	E.g. for HTTPS:
		1805
		1806	tcp_connect $host, $port, sub {
		1807	my ($fh) = @_;
		1808
		1809	my $handle = new AnyEvent::Handle
		1810	fh => $fh,
		1811	peername => $host,
		1812	tls => "connect",
		1813	tls_ctx => { verify => 1, verify_peername => "https" },
		1814	...
		1815
		1816	Note that you must specify the hostname you connected to (or whatever
		1817	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1818	peername verification will be done.
		1819
		1820	The above will use the system-dependent default set of trusted CA
		1821	certificates. If you want to check against a specific CA, add the
		1822	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1823
		1824	tls_ctx => {
		1825	verify => 1,
		1826	verify_peername => "https",
		1827	ca_file => "my-ca-cert.pem",
		1828	},
		1829
		1830	=item I want to create a TLS/SSL server, how do I do that?
		1831
		1832	Well, you first need to get a server certificate and key. You have
		1833	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1834	self-signed certificate (cheap. check the search engine of your choice,
		1835	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1836	nice program for that purpose).
		1837
		1838	Then create a file with your private key (in PEM format, see
		1839	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1840	file should then look like this:
		1841
		1842	-----BEGIN RSA PRIVATE KEY-----
		1843	...header data
		1844	... lots of base64'y-stuff
		1845	-----END RSA PRIVATE KEY-----
		1846
		1847	-----BEGIN CERTIFICATE-----
		1848	... lots of base64'y-stuff
		1849	-----END CERTIFICATE-----
		1850
		1851	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1852	specify this file as C<cert_file>:
		1853
		1854	tcp_server undef, $port, sub {
		1855	my ($fh) = @_;
		1856
		1857	my $handle = new AnyEvent::Handle
		1858	fh => $fh,
		1859	tls => "accept",
		1860	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1861	...
		1862
		1863	When you have intermediate CA certificates that your clients might not
		1864	know about, just append them to the C<cert_file>.
		1865
		1866	=back
		1867
1492		1868
1493	=head1 SUBCLASSING AnyEvent::Handle	1869	=head1 SUBCLASSING AnyEvent::Handle
1494		1870
1495	In many cases, you might want to subclass AnyEvent::Handle.	1871	In many cases, you might want to subclass AnyEvent::Handle.
1496		1872

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs. Revision 1.145 by root, Mon Jul 6 21:47:14 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs.
Revision 1.145 by root, Mon Jul 6 21:47:14 2009 UTC