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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.203 by root, Sat Oct 16 03:22:10 2010 UTC vs.
Revision 1.247 by root, Thu Jan 7 10:03:46 2016 UTC

…		…
11		11
12	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
13	fh => \*STDIN,	13	fh => \*STDIN,
14	on_error => sub {	14	on_error => sub {
15	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
16	warn "got error $msg\n";	16	AE::log error => $msg;
17	$hdl->destroy;	17	$hdl->destroy;
18	$cv->send;	18	$cv->send;
19	};	19	};
20		20
21	# send some request line	21	# send some request line
22	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
23		23
24	# read the response line	24	# read the response line
25	$hdl->push_read (line => sub {	25	$hdl->push_read (line => sub {
26	my ($hdl, $line) = @_;	26	my ($hdl, $line) = @_;
27	warn "got line <$line>\n";	27	say "got line <$line>";
28	$cv->send;	28	$cv->send;
29	});	29	});
30		30
31	$cv->recv;	31	$cv->recv;
32		32
33	=head1 DESCRIPTION	33	=head1 DESCRIPTION
34		34
35	This is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O
36	stream-based filehandles (sockets, pipes, and other stream things).	36	on stream-based filehandles (sockets, pipes, and other stream
		37	things). Specifically, it doesn't work as expected on files, packet-based
		38	sockets or similar things.
37		39
38	The L<AnyEvent::Intro> tutorial contains some well-documented	40	The L<AnyEvent::Intro> tutorial contains some well-documented
39	AnyEvent::Handle examples.	41	AnyEvent::Handle examples.
40		42
41	In the following, where the documentation refers to "bytes", it means	43	In the following, where the documentation refers to "bytes", it means
…		…
53	package AnyEvent::Handle;	55	package AnyEvent::Handle;
54		56
55	use Scalar::Util ();	57	use Scalar::Util ();
56	use List::Util ();	58	use List::Util ();
57	use Carp ();	59	use Carp ();
58	use Errno qw(EAGAIN EINTR);	60	use Errno qw(EAGAIN EWOULDBLOCK EINTR);
59		61
60	use AnyEvent (); BEGIN { AnyEvent::common_sense }	62	use AnyEvent (); BEGIN { AnyEvent::common_sense }
61	use AnyEvent::Util qw(WSAEWOULDBLOCK);	63	use AnyEvent::Util qw(WSAEWOULDBLOCK);
62		64
63	our $VERSION = $AnyEvent::VERSION;	65	our $VERSION = $AnyEvent::VERSION;
…		…
91		93
92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	94	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
93		95
94	The filehandle this L<AnyEvent::Handle> object will operate on.	96	The filehandle this L<AnyEvent::Handle> object will operate on.
95	NOTE: The filehandle will be set to non-blocking mode (using	97	NOTE: The filehandle will be set to non-blocking mode (using
96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	98	C<AnyEvent::fh_unblock>) by the constructor and needs to stay in
97	that mode.	99	that mode.
98		100
99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]	101	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
100		102
101	Try to connect to the specified host and service (port), using	103	Try to connect to the specified host and service (port), using
…		…
114	=over 4	116	=over 4
115		117
116	=item on_prepare => $cb->($handle)	118	=item on_prepare => $cb->($handle)
117		119
118	This (rarely used) callback is called before a new connection is	120	This (rarely used) callback is called before a new connection is
119	attempted, but after the file handle has been created. It could be used to	121	attempted, but after the file handle has been created (you can access that
		122	file handle via C<< $handle->{fh} >>). It could be used to prepare the
120	prepare the file handle with parameters required for the actual connect	123	file handle with parameters required for the actual connect (as opposed to
121	(as opposed to settings that can be changed when the connection is already	124	settings that can be changed when the connection is already established).
122	established).
123		125
124	The return value of this callback should be the connect timeout value in	126	The return value of this callback should be the connect timeout value in
125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the	127	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
126	default timeout is to be used).	128	default timeout is to be used).
127		129
128	=item on_connect => $cb->($handle, $host, $port, $retry->())	130	=item on_connect => $cb->($handle, $host, $port, $retry->())
129		131
130	This callback is called when a connection has been successfully established.	132	This callback is called when a connection has been successfully established.
131		133
132	The peer's numeric host and port (the socket peername) are passed as	134	The peer's numeric host and port (the socket peername) are passed as
133	parameters, together with a retry callback.	135	parameters, together with a retry callback. At the time it is called the
		136	read and write queues, EOF status, TLS status and similar properties of
		137	the handle will have been reset.
134		138
135	If, for some reason, the handle is not acceptable, calling C<$retry>	139	If, for some reason, the handle is not acceptable, calling C<$retry> will
136	will continue with the next connection target (in case of multi-homed	140	continue with the next connection target (in case of multi-homed hosts or
137	hosts or SRV records there can be multiple connection endpoints). At the	141	SRV records there can be multiple connection endpoints). The C<$retry>
138	time it is called the read and write queues, eof status, tls status and	142	callback can be invoked after the connect callback returns, i.e. one can
139	similar properties of the handle will have been reset.	143	start a handshake and then decide to retry with the next host if the
		144	handshake fails.
140		145
141	In most cases, you should ignore the C<$retry> parameter.	146	In most cases, you should ignore the C<$retry> parameter.
142		147
143	=item on_connect_error => $cb->($handle, $message)	148	=item on_connect_error => $cb->($handle, $message)
144		149
…		…
159		164
160	Some errors are fatal (which is indicated by C<$fatal> being true). On	165	Some errors are fatal (which is indicated by C<$fatal> being true). On
161	fatal errors the handle object will be destroyed (by a call to C<< ->	166	fatal errors the handle object will be destroyed (by a call to C<< ->
162	destroy >>) after invoking the error callback (which means you are free to	167	destroy >>) after invoking the error callback (which means you are free to
163	examine the handle object). Examples of fatal errors are an EOF condition	168	examine the handle object). Examples of fatal errors are an EOF condition
164	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	169	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
165	cases where the other side can close the connection at will, it is	170	cases where the other side can close the connection at will, it is
166	often easiest to not report C<EPIPE> errors in this callback.	171	often easiest to not report C<EPIPE> errors in this callback.
167		172
168	AnyEvent::Handle tries to find an appropriate error code for you to check	173	AnyEvent::Handle tries to find an appropriate error code for you to check
169	against, but in some cases (TLS errors), this does not work well. It is	174	against, but in some cases (TLS errors), this does not work well.
170	recommended to always output the C<$message> argument in human-readable	175
171	error messages (it's usually the same as C<"$!">).	176	If you report the error to the user, it is recommended to always output
		177	the C<$message> argument in human-readable error messages (you don't need
		178	to report C<"$!"> if you report C<$message>).
		179
		180	If you want to react programmatically to the error, then looking at C<$!>
		181	and comparing it against some of the documented C<Errno> values is usually
		182	better than looking at the C<$message>.
172		183
173	Non-fatal errors can be retried by returning, but it is recommended	184	Non-fatal errors can be retried by returning, but it is recommended
174	to simply ignore this parameter and instead abondon the handle object	185	to simply ignore this parameter and instead abondon the handle object
175	when this callback is invoked. Examples of non-fatal errors are timeouts	186	when this callback is invoked. Examples of non-fatal errors are timeouts
176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	187	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
224	If an EOF condition has been detected but no C<on_eof> callback has been	235	If an EOF condition has been detected but no C<on_eof> callback has been
225	set, then a fatal error will be raised with C<$!> set to <0>.	236	set, then a fatal error will be raised with C<$!> set to <0>.
226		237
227	=item on_drain => $cb->($handle)	238	=item on_drain => $cb->($handle)
228		239
229	This sets the callback that is called when the write buffer becomes empty	240	This sets the callback that is called once when the write buffer becomes
230	(or immediately if the buffer is empty already).	241	empty (and immediately when the handle object is created).
231		242
232	To append to the write buffer, use the C<< ->push_write >> method.	243	To append to the write buffer, use the C<< ->push_write >> method.
233		244
234	This callback is useful when you don't want to put all of your write data	245	This callback is useful when you don't want to put all of your write data
235	into the queue at once, for example, when you want to write the contents	246	into the queue at once, for example, when you want to write the contents
…		…
247	many seconds pass without a successful read or write on the underlying	258	many seconds pass without a successful read or write on the underlying
248	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback	259	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
249	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>	260	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250	error will be raised).	261	error will be raised).
251		262
252	There are three variants of the timeouts that work independently	263	There are three variants of the timeouts that work independently of each
253	of each other, for both read and write, just read, and just write:	264	other, for both read and write (triggered when nothing was read I<OR>
		265	written), just read (triggered when nothing was read), and just write:
254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	266	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions	267	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	268	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257		269
258	Note that timeout processing is active even when you do not have	270	Note that timeout processing is active even when you do not have any
259	any outstanding read or write requests: If you plan to keep the connection	271	outstanding read or write requests: If you plan to keep the connection
260	idle then you should disable the timeout temporarily or ignore the timeout	272	idle then you should disable the timeout temporarily or ignore the
261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	273	timeout in the corresponding C<on_timeout> callback, in which case
262	restart the timeout.	274	AnyEvent::Handle will simply restart the timeout.
263		275
264	Zero (the default) disables this timeout.	276	Zero (the default) disables the corresponding timeout.
265		277
266	=item on_timeout => $cb->($handle)	278	=item on_timeout => $cb->($handle)
		279
		280	=item on_rtimeout => $cb->($handle)
		281
		282	=item on_wtimeout => $cb->($handle)
267		283
268	Called whenever the inactivity timeout passes. If you return from this	284	Called whenever the inactivity timeout passes. If you return from this
269	callback, then the timeout will be reset as if some activity had happened,	285	callback, then the timeout will be reset as if some activity had happened,
270	so this condition is not fatal in any way.	286	so this condition is not fatal in any way.
271		287
…		…
278	For example, a server accepting connections from untrusted sources should	294	For example, a server accepting connections from untrusted sources should
279	be configured to accept only so-and-so much data that it cannot act on	295	be configured to accept only so-and-so much data that it cannot act on
280	(for example, when expecting a line, an attacker could send an unlimited	296	(for example, when expecting a line, an attacker could send an unlimited
281	amount of data without a callback ever being called as long as the line	297	amount of data without a callback ever being called as long as the line
282	isn't finished).	298	isn't finished).
		299
		300	=item wbuf_max => <bytes>
		301
		302	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		303	when the write buffer ever (strictly) exceeds this size. This is useful to
		304	avoid some forms of denial-of-service attacks.
		305
		306	Although the units of this parameter is bytes, this is the I<raw> number
		307	of bytes not yet accepted by the kernel. This can make a difference when
		308	you e.g. use TLS, as TLS typically makes your write data larger (but it
		309	can also make it smaller due to compression).
		310
		311	As an example of when this limit is useful, take a chat server that sends
		312	chat messages to a client. If the client does not read those in a timely
		313	manner then the send buffer in the server would grow unbounded.
283		314
284	=item autocork => <boolean>	315	=item autocork => <boolean>
285		316
286	When disabled (the default), C<push_write> will try to immediately	317	When disabled (the default), C<push_write> will try to immediately
287	write the data to the handle if possible. This avoids having to register	318	write the data to the handle if possible. This avoids having to register
…		…
339	already have occured on BSD systems), but at least it will protect you	370	already have occured on BSD systems), but at least it will protect you
340	from most attacks.	371	from most attacks.
341		372
342	=item read_size => <bytes>	373	=item read_size => <bytes>
343		374
344	The initial read block size, the number of bytes this module will try to	375	The initial read block size, the number of bytes this module will try
345	read during each loop iteration. Each handle object will consume at least	376	to read during each loop iteration. Each handle object will consume
346	this amount of memory for the read buffer as well, so when handling many	377	at least this amount of memory for the read buffer as well, so when
347	connections requirements). See also C<max_read_size>. Default: C<2048>.	378	handling many connections watch out for memory requirements). See also
		379	C<max_read_size>. Default: C<2048>.
348		380
349	=item max_read_size => <bytes>	381	=item max_read_size => <bytes>
350		382
351	The maximum read buffer size used by the dynamic adjustment	383	The maximum read buffer size used by the dynamic adjustment
352	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in	384	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
…		…
396	appropriate error message.	428	appropriate error message.
397		429
398	TLS mode requires Net::SSLeay to be installed (it will be loaded	430	TLS mode requires Net::SSLeay to be installed (it will be loaded
399	automatically when you try to create a TLS handle): this module doesn't	431	automatically when you try to create a TLS handle): this module doesn't
400	have a dependency on that module, so if your module requires it, you have	432	have a dependency on that module, so if your module requires it, you have
401	to add the dependency yourself.	433	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		434	old, you get an C<EPROTO> error.
402		435
403	Unlike TCP, TLS has a server and client side: for the TLS server side, use	436	Unlike TCP, TLS has a server and client side: for the TLS server side, use
404	C<accept>, and for the TLS client side of a connection, use C<connect>	437	C<accept>, and for the TLS client side of a connection, use C<connect>
405	mode.	438	mode.
406		439
…		…
422	Use the C<< ->starttls >> method if you need to start TLS negotiation later.	455	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
423		456
424	=item tls_ctx => $anyevent_tls	457	=item tls_ctx => $anyevent_tls
425		458
426	Use the given C<AnyEvent::TLS> object to create the new TLS connection	459	Use the given C<AnyEvent::TLS> object to create the new TLS connection
427	(unless a connection object was specified directly). If this parameter is	460	(unless a connection object was specified directly). If this
428	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	461	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		462	C<AnyEvent::Handle::TLS_CTX>.
429		463
430	Instead of an object, you can also specify a hash reference with C<< key	464	Instead of an object, you can also specify a hash reference with C<< key
431	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	465	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
432	new TLS context object.	466	new TLS context object.
433		467
…		…
461	callback.	495	callback.
462		496
463	This callback will only be called on TLS shutdowns, not when the	497	This callback will only be called on TLS shutdowns, not when the
464	underlying handle signals EOF.	498	underlying handle signals EOF.
465		499
466	=item json => JSON or JSON::XS object	500	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
467		501
468	This is the json coder object used by the C<json> read and write types.	502	This is the json coder object used by the C<json> read and write types.
469		503
470	If you don't supply it, then AnyEvent::Handle will create and use a	504	If you don't supply it, then AnyEvent::Handle will create and use a
471	suitable one (on demand), which will write and expect UTF-8 encoded JSON	505	suitable one (on demand), which will write and expect UTF-8 encoded
		506	JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are
		507	guaranteed not to contain any newline character.
		508
		509	For security reasons, this encoder will likely I<not> handle numbers and
		510	strings, only arrays and objects/hashes. The reason is that originally
		511	JSON was self-delimited, but Dougles Crockford thought it was a splendid
		512	idea to redefine JSON incompatibly, so this is no longer true.
		513
		514	For protocols that used back-to-back JSON texts, this might lead to
		515	run-ins, where two or more JSON texts will be interpreted as one JSON
472	texts.	516	text.
473		517
		518	For this reason, if the default encoder uses L<JSON::XS>, it will default
		519	to not allowing anything but arrays and objects/hashes, at least for the
		520	forseeable future (it will change at some point). This might or might not
		521	be true for the L<JSON> module, so this might cause a security issue.
		522
		523	If you depend on either behaviour, you should create your own json object
		524	and pass it in explicitly.
		525
		526	=item cbor => L<CBOR::XS> object
		527
		528	This is the cbor coder object used by the C<cbor> read and write types.
		529
		530	If you don't supply it, then AnyEvent::Handle will create and use a
		531	suitable one (on demand), which will write CBOR without using extensions,
		532	if possible.
		533
474	Note that you are responsible to depend on the JSON module if you want to	534	Note that you are responsible to depend on the L<CBOR::XS> module if you
475	use this functionality, as AnyEvent does not have a dependency itself.	535	want to use this functionality, as AnyEvent does not have a dependency on
		536	it itself.
476		537
477	=back	538	=back
478		539
479	=cut	540	=cut
480		541
…		…
502	$self->{connect}[0],	563	$self->{connect}[0],
503	$self->{connect}[1],	564	$self->{connect}[1],
504	sub {	565	sub {
505	my ($fh, $host, $port, $retry) = @_;	566	my ($fh, $host, $port, $retry) = @_;
506		567
		568	delete $self->{_connect}; # no longer needed
		569
507	if ($fh) {	570	if ($fh) {
508	$self->{fh} = $fh;	571	$self->{fh} = $fh;
509		572
510	delete $self->{_skip_drain_rbuf};	573	delete $self->{_skip_drain_rbuf};
511	$self->_start;	574	$self->_start;
…		…
518	});	581	});
519		582
520	} else {	583	} else {
521	if ($self->{on_connect_error}) {	584	if ($self->{on_connect_error}) {
522	$self->{on_connect_error}($self, "$!");	585	$self->{on_connect_error}($self, "$!");
523	$self->destroy;	586	$self->destroy if $self;
524	} else {	587	} else {
525	$self->_error ($!, 1);	588	$self->_error ($!, 1);
526	}	589	}
527	}	590	}
528	},	591	},
529	sub {	592	sub {
530	local $self->{fh} = $_[0];	593	local $self->{fh} = $_[0];
531		594
532	$self->{on_prepare}	595	$self->{on_prepare}
533	? $self->{on_prepare}->($self)	596	? $self->{on_prepare}->($self)
534	: ()	597	: ()
535	}	598	}
536	);	599	);
537	}	600	}
538		601
…		…
550	# with AnyEvent::Handle, do them a favour.	613	# with AnyEvent::Handle, do them a favour.
551	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();	614	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
552	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"	615	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
553	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;	616	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
554		617
555	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	618	AnyEvent::fh_unblock $self->{fh};
556		619
557	$self->{_activity} =	620	$self->{_activity} =
558	$self->{_ractivity} =	621	$self->{_ractivity} =
559	$self->{_wactivity} = AE::now;	622	$self->{_wactivity} = AE::now;
560		623
…		…
737		800
738	=item $handle->rbuf_max ($max_octets)	801	=item $handle->rbuf_max ($max_octets)
739		802
740	Configures the C<rbuf_max> setting (C<undef> disables it).	803	Configures the C<rbuf_max> setting (C<undef> disables it).
741		804
		805	=item $handle->wbuf_max ($max_octets)
		806
		807	Configures the C<wbuf_max> setting (C<undef> disables it).
		808
742	=cut	809	=cut
743		810
744	sub rbuf_max {	811	sub rbuf_max {
745	$_[0]{rbuf_max} = $_[1];	812	$_[0]{rbuf_max} = $_[1];
746	}	813	}
747		814
		815	sub wbuf_max {
		816	$_[0]{wbuf_max} = $_[1];
		817	}
		818
748	#############################################################################	819	#############################################################################
749		820
750	=item $handle->timeout ($seconds)	821	=item $handle->timeout ($seconds)
751		822
752	=item $handle->rtimeout ($seconds)	823	=item $handle->rtimeout ($seconds)
753		824
754	=item $handle->wtimeout ($seconds)	825	=item $handle->wtimeout ($seconds)
755		826
756	Configures (or disables) the inactivity timeout.	827	Configures (or disables) the inactivity timeout.
		828
		829	The timeout will be checked instantly, so this method might destroy the
		830	handle before it returns.
757		831
758	=item $handle->timeout_reset	832	=item $handle->timeout_reset
759		833
760	=item $handle->rtimeout_reset	834	=item $handle->rtimeout_reset
761		835
…		…
845		919
846	The write queue is very simple: you can add data to its end, and	920	The write queue is very simple: you can add data to its end, and
847	AnyEvent::Handle will automatically try to get rid of it for you.	921	AnyEvent::Handle will automatically try to get rid of it for you.
848		922
849	When data could be written and the write buffer is shorter then the low	923	When data could be written and the write buffer is shorter then the low
850	water mark, the C<on_drain> callback will be invoked.	924	water mark, the C<on_drain> callback will be invoked once.
851		925
852	=over 4	926	=over 4
853		927
854	=item $handle->on_drain ($cb)	928	=item $handle->on_drain ($cb)
855		929
…		…
870	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	944	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
871	}	945	}
872		946
873	=item $handle->push_write ($data)	947	=item $handle->push_write ($data)
874		948
875	Queues the given scalar to be written. You can push as much data as you	949	Queues the given scalar to be written. You can push as much data as
876	want (only limited by the available memory), as C<AnyEvent::Handle>	950	you want (only limited by the available memory and C<wbuf_max>), as
877	buffers it independently of the kernel.	951	C<AnyEvent::Handle> buffers it independently of the kernel.
878		952
879	This method may invoke callbacks (and therefore the handle might be	953	This method may invoke callbacks (and therefore the handle might be
880	destroyed after it returns).	954	destroyed after it returns).
881		955
882	=cut	956	=cut
…		…
899	$self->{on_drain}($self)	973	$self->{on_drain}($self)
900	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	974	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
901	&& $self->{on_drain};	975	&& $self->{on_drain};
902		976
903	delete $self->{_ww} unless length $self->{wbuf};	977	delete $self->{_ww} unless length $self->{wbuf};
904	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	978	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
905	$self->_error ($!, 1);	979	$self->_error ($!, 1);
906	}	980	}
907	};	981	};
908		982
909	# try to write data immediately	983	# try to write data immediately
910	$cb->() unless $self->{autocork};	984	$cb->() unless $self->{autocork};
911		985
912	# if still data left in wbuf, we need to poll	986	# if still data left in wbuf, we need to poll
913	$self->{_ww} = AE::io $self->{fh}, 1, $cb	987	$self->{_ww} = AE::io $self->{fh}, 1, $cb
914	if length $self->{wbuf};	988	if length $self->{wbuf};
		989
		990	if (
		991	defined $self->{wbuf_max}
		992	&& $self->{wbuf_max} < length $self->{wbuf}
		993	) {
		994	$self->_error (Errno::ENOSPC, 1), return;
		995	}
915	};	996	};
916	}	997	}
917		998
918	our %WH;	999	our %WH;
919		1000
…		…
990		1071
991	Encodes the given hash or array reference into a JSON object. Unless you	1072	Encodes the given hash or array reference into a JSON object. Unless you
992	provide your own JSON object, this means it will be encoded to JSON text	1073	provide your own JSON object, this means it will be encoded to JSON text
993	in UTF-8.	1074	in UTF-8.
994		1075
		1076	The default encoder might or might not handle every type of JSON value -
		1077	it might be limited to arrays and objects for security reasons. See the
		1078	C<json> constructor attribute for more details.
		1079
995	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1080	JSON objects (and arrays) are self-delimiting, so if you only use arrays
996	one end of a handle and read them at the other end without using any	1081	and hashes, you can write JSON at one end of a handle and read them at the
997	additional framing.	1082	other end without using any additional framing.
998		1083
999	The generated JSON text is guaranteed not to contain any newlines: While	1084	The JSON text generated by the default encoder is guaranteed not to
1000	this module doesn't need delimiters after or between JSON texts to be	1085	contain any newlines: While this module doesn't need delimiters after or
1001	able to read them, many other languages depend on that.	1086	between JSON texts to be able to read them, many other languages depend on
		1087	them.
1002		1088
1003	A simple RPC protocol that interoperates easily with others is to send	1089	A simple RPC protocol that interoperates easily with other languages is
1004	JSON arrays (or objects, although arrays are usually the better choice as	1090	to send JSON arrays (or objects, although arrays are usually the better
1005	they mimic how function argument passing works) and a newline after each	1091	choice as they mimic how function argument passing works) and a newline
1006	JSON text:	1092	after each JSON text:
1007		1093
1008	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1094	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1009	$handle->push_write ("\012");	1095	$handle->push_write ("\012");
1010		1096
1011	An AnyEvent::Handle receiver would simply use the C<json> read type and	1097	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1014	$handle->push_read (json => sub { my $array = $_[1]; ... });	1100	$handle->push_read (json => sub { my $array = $_[1]; ... });
1015		1101
1016	Other languages could read single lines terminated by a newline and pass	1102	Other languages could read single lines terminated by a newline and pass
1017	this line into their JSON decoder of choice.	1103	this line into their JSON decoder of choice.
1018		1104
		1105	=item cbor => $perl_scalar
		1106
		1107	Encodes the given scalar into a CBOR value. Unless you provide your own
		1108	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1109	using any extensions, if possible.
		1110
		1111	CBOR values are self-delimiting, so you can write CBOR at one end of
		1112	a handle and read them at the other end without using any additional
		1113	framing.
		1114
		1115	A simple nd very very fast RPC protocol that interoperates with
		1116	other languages is to send CBOR and receive CBOR values (arrays are
		1117	recommended):
		1118
		1119	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1120
		1121	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1122
		1123	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1124
1019	=cut	1125	=cut
1020		1126
1021	sub json_coder() {	1127	sub json_coder() {
1022	eval { require JSON::XS; JSON::XS->new->utf8 }	1128	eval { require JSON::XS; JSON::XS->new->utf8 }
1023	\|\| do { require JSON; JSON->new->utf8 }	1129	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1024	}	1130	}
1025		1131
1026	register_write_type json => sub {	1132	register_write_type json => sub {
1027	my ($self, $ref) = @_;	1133	my ($self, $ref) = @_;
1028		1134
1029	my $json = $self->{json} \|\|= json_coder;	1135	($self->{json} \|\|= json_coder)
1030
1031	$json->encode ($ref)	1136	->encode ($ref)
		1137	};
		1138
		1139	sub cbor_coder() {
		1140	require CBOR::XS;
		1141	CBOR::XS->new
		1142	}
		1143
		1144	register_write_type cbor => sub {
		1145	my ($self, $scalar) = @_;
		1146
		1147	($self->{cbor} \|\|= cbor_coder)
		1148	->encode ($scalar)
1032	};	1149	};
1033		1150
1034	=item storable => $reference	1151	=item storable => $reference
1035		1152
1036	Freezes the given reference using L<Storable> and writes it to the	1153	Freezes the given reference using L<Storable> and writes it to the
…		…
1039	=cut	1156	=cut
1040		1157
1041	register_write_type storable => sub {	1158	register_write_type storable => sub {
1042	my ($self, $ref) = @_;	1159	my ($self, $ref) = @_;
1043		1160
1044	require Storable;	1161	require Storable unless $Storable::VERSION;
1045		1162
1046	pack "w/a*", Storable::nfreeze ($ref)	1163	pack "w/a*", Storable::nfreeze ($ref)
1047	};	1164	};
1048		1165
1049	=back	1166	=back
…		…
1054	before it was actually written. One way to do that is to replace your	1171	before it was actually written. One way to do that is to replace your
1055	C<on_drain> handler by a callback that shuts down the socket (and set	1172	C<on_drain> handler by a callback that shuts down the socket (and set
1056	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1173	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1057	replaces the C<on_drain> callback with:	1174	replaces the C<on_drain> callback with:
1058		1175
1059	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1176	sub { shutdown $_[0]{fh}, 1 }
1060		1177
1061	This simply shuts down the write side and signals an EOF condition to the	1178	This simply shuts down the write side and signals an EOF condition to the
1062	the peer.	1179	the peer.
1063		1180
1064	You can rely on the normal read queue and C<on_eof> handling	1181	You can rely on the normal read queue and C<on_eof> handling
…		…
1086		1203
1087	Whenever the given C<type> is used, C<push_write> will the function with	1204	Whenever the given C<type> is used, C<push_write> will the function with
1088	the handle object and the remaining arguments.	1205	the handle object and the remaining arguments.
1089		1206
1090	The function is supposed to return a single octet string that will be	1207	The function is supposed to return a single octet string that will be
1091	appended to the write buffer, so you cna mentally treat this function as a	1208	appended to the write buffer, so you can mentally treat this function as a
1092	"arguments to on-the-wire-format" converter.	1209	"arguments to on-the-wire-format" converter.
1093		1210
1094	Example: implement a custom write type C<join> that joins the remaining	1211	Example: implement a custom write type C<join> that joins the remaining
1095	arguments using the first one.	1212	arguments using the first one.
1096		1213
…		…
1390	data.	1507	data.
1391		1508
1392	Example: read 2 bytes.	1509	Example: read 2 bytes.
1393		1510
1394	$handle->push_read (chunk => 2, sub {	1511	$handle->push_read (chunk => 2, sub {
1395	warn "yay ", unpack "H*", $_[1];	1512	say "yay " . unpack "H*", $_[1];
1396	});	1513	});
1397		1514
1398	=cut	1515	=cut
1399		1516
1400	register_read_type chunk => sub {	1517	register_read_type chunk => sub {
…		…
1430		1547
1431	register_read_type line => sub {	1548	register_read_type line => sub {
1432	my ($self, $cb, $eol) = @_;	1549	my ($self, $cb, $eol) = @_;
1433		1550
1434	if (@_ < 3) {	1551	if (@_ < 3) {
1435	# this is more than twice as fast as the generic code below	1552	# this is faster then the generic code below
1436	sub {	1553	sub {
1437	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1554	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1555	or return;
1438		1556
		1557	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1439	$cb->($_[0], $1, $2);	1558	$cb->($_[0], $str, "$1");
1440	1	1559	1
1441	}	1560	}
1442	} else {	1561	} else {
1443	$eol = quotemeta $eol unless ref $eol;	1562	$eol = quotemeta $eol unless ref $eol;
1444	$eol = qr\|^(.*?)($eol)\|s;	1563	$eol = qr\|^(.*?)($eol)\|s;
1445		1564
1446	sub {	1565	sub {
1447	$_[0]{rbuf} =~ s/$eol// or return;	1566	$_[0]{rbuf} =~ s/$eol// or return;
1448		1567
1449	$cb->($_[0], $1, $2);	1568	$cb->($_[0], "$1", "$2");
1450	1	1569	1
1451	}	1570	}
1452	}	1571	}
1453	};	1572	};
1454		1573
1455	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1574	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1456		1575
1457	Makes a regex match against the regex object C<$accept> and returns	1576	Makes a regex match against the regex object C<$accept> and returns
1458	everything up to and including the match.	1577	everything up to and including the match. All the usual regex variables
		1578	($1, %+ etc.) from the regex match are available in the callback.
1459		1579
1460	Example: read a single line terminated by '\n'.	1580	Example: read a single line terminated by '\n'.
1461		1581
1462	$handle->push_read (regex => qr<\n>, sub { ... });	1582	$handle->push_read (regex => qr<\n>, sub { ... });
1463		1583
…		…
1502		1622
1503	sub {	1623	sub {
1504	# accept	1624	# accept
1505	if ($$rbuf =~ $accept) {	1625	if ($$rbuf =~ $accept) {
1506	$data .= substr $$rbuf, 0, $+[0], "";	1626	$data .= substr $$rbuf, 0, $+[0], "";
1507	$cb->($self, $data);	1627	$cb->($_[0], $data);
1508	return 1;	1628	return 1;
1509	}	1629	}
1510		1630
1511	# reject	1631	# reject
1512	if ($reject && $$rbuf =~ $reject) {	1632	if ($reject && $$rbuf =~ $reject) {
1513	$self->_error (Errno::EBADMSG);	1633	$_[0]->_error (Errno::EBADMSG);
1514	}	1634	}
1515		1635
1516	# skip	1636	# skip
1517	if ($skip && $$rbuf =~ $skip) {	1637	if ($skip && $$rbuf =~ $skip) {
1518	$data .= substr $$rbuf, 0, $+[0], "";	1638	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1534	my ($self, $cb) = @_;	1654	my ($self, $cb) = @_;
1535		1655
1536	sub {	1656	sub {
1537	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1657	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1538	if ($_[0]{rbuf} =~ /[^0-9]/) {	1658	if ($_[0]{rbuf} =~ /[^0-9]/) {
1539	$self->_error (Errno::EBADMSG);	1659	$_[0]->_error (Errno::EBADMSG);
1540	}	1660	}
1541	return;	1661	return;
1542	}	1662	}
1543		1663
1544	my $len = $1;	1664	my $len = $1;
1545		1665
1546	$self->unshift_read (chunk => $len, sub {	1666	$_[0]->unshift_read (chunk => $len, sub {
1547	my $string = $_[1];	1667	my $string = $_[1];
1548	$_[0]->unshift_read (chunk => 1, sub {	1668	$_[0]->unshift_read (chunk => 1, sub {
1549	if ($_[1] eq ",") {	1669	if ($_[1] eq ",") {
1550	$cb->($_[0], $string);	1670	$cb->($_[0], $string);
1551	} else {	1671	} else {
1552	$self->_error (Errno::EBADMSG);	1672	$_[0]->_error (Errno::EBADMSG);
1553	}	1673	}
1554	});	1674	});
1555	});	1675	});
1556		1676
1557	1	1677	1
…		…
1607	=item json => $cb->($handle, $hash_or_arrayref)	1727	=item json => $cb->($handle, $hash_or_arrayref)
1608		1728
1609	Reads a JSON object or array, decodes it and passes it to the	1729	Reads a JSON object or array, decodes it and passes it to the
1610	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1730	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1611		1731
1612	If a C<json> object was passed to the constructor, then that will be used	1732	If a C<json> object was passed to the constructor, then that will be
1613	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1733	used for the final decode, otherwise it will create a L<JSON::XS> or
		1734	L<JSON::PP> coder object expecting UTF-8.
1614		1735
1615	This read type uses the incremental parser available with JSON version	1736	This read type uses the incremental parser available with JSON version
1616	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1737	2.09 (and JSON::XS version 2.2) and above.
1617	dependency on your own: this module will load the JSON module, but
1618	AnyEvent does not depend on it itself.
1619		1738
1620	Since JSON texts are fully self-delimiting, the C<json> read and write	1739	Since JSON texts are fully self-delimiting, the C<json> read and write
1621	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1740	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1622	the C<json> write type description, above, for an actual example.	1741	the C<json> write type description, above, for an actual example.
1623		1742
…		…
1627	my ($self, $cb) = @_;	1746	my ($self, $cb) = @_;
1628		1747
1629	my $json = $self->{json} \|\|= json_coder;	1748	my $json = $self->{json} \|\|= json_coder;
1630		1749
1631	my $data;	1750	my $data;
1632	my $rbuf = \$self->{rbuf};
1633		1751
1634	sub {	1752	sub {
1635	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1753	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1636		1754
1637	if ($ref) {	1755	if ($ref) {
1638	$self->{rbuf} = $json->incr_text;	1756	$_[0]{rbuf} = $json->incr_text;
1639	$json->incr_text = "";	1757	$json->incr_text = "";
1640	$cb->($self, $ref);	1758	$cb->($_[0], $ref);
1641		1759
1642	1	1760	1
1643	} elsif ($@) {	1761	} elsif ($@) {
1644	# error case	1762	# error case
1645	$json->incr_skip;	1763	$json->incr_skip;
1646		1764
1647	$self->{rbuf} = $json->incr_text;	1765	$_[0]{rbuf} = $json->incr_text;
1648	$json->incr_text = "";	1766	$json->incr_text = "";
1649		1767
1650	$self->_error (Errno::EBADMSG);	1768	$_[0]->_error (Errno::EBADMSG);
1651		1769
1652	()	1770	()
1653	} else {	1771	} else {
1654	$self->{rbuf} = "";	1772	$_[0]{rbuf} = "";
1655		1773
		1774	()
		1775	}
		1776	}
		1777	};
		1778
		1779	=item cbor => $cb->($handle, $scalar)
		1780
		1781	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1782	error occurs, an C<EBADMSG> error will be raised.
		1783
		1784	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1785	used for the final decode, otherwise it will create a CBOR coder without
		1786	enabling any options.
		1787
		1788	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1789	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1790	itself.
		1791
		1792	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1793	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1794	the C<cbor> write type description, above, for an actual example.
		1795
		1796	=cut
		1797
		1798	register_read_type cbor => sub {
		1799	my ($self, $cb) = @_;
		1800
		1801	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1802
		1803	my $data;
		1804
		1805	sub {
		1806	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1807
		1808	if (@value) {
		1809	$cb->($_[0], @value);
		1810
		1811	1
		1812	} elsif ($@) {
		1813	# error case
		1814	$cbor->incr_reset;
		1815
		1816	$_[0]->_error (Errno::EBADMSG);
		1817
		1818	()
		1819	} else {
1656	()	1820	()
1657	}	1821	}
1658	}	1822	}
1659	};	1823	};
1660		1824
…		…
1669	=cut	1833	=cut
1670		1834
1671	register_read_type storable => sub {	1835	register_read_type storable => sub {
1672	my ($self, $cb) = @_;	1836	my ($self, $cb) = @_;
1673		1837
1674	require Storable;	1838	require Storable unless $Storable::VERSION;
1675		1839
1676	sub {	1840	sub {
1677	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1841	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1678	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1842	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1679	or return;	1843	or return;
…		…
1682		1846
1683	# bypass unshift if we already have the remaining chunk	1847	# bypass unshift if we already have the remaining chunk
1684	if ($format + $len <= length $_[0]{rbuf}) {	1848	if ($format + $len <= length $_[0]{rbuf}) {
1685	my $data = substr $_[0]{rbuf}, $format, $len;	1849	my $data = substr $_[0]{rbuf}, $format, $len;
1686	substr $_[0]{rbuf}, 0, $format + $len, "";	1850	substr $_[0]{rbuf}, 0, $format + $len, "";
		1851
1687	$cb->($_[0], Storable::thaw ($data));	1852	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1853	or return $_[0]->_error (Errno::EBADMSG);
1688	} else {	1854	} else {
1689	# remove prefix	1855	# remove prefix
1690	substr $_[0]{rbuf}, 0, $format, "";	1856	substr $_[0]{rbuf}, 0, $format, "";
1691		1857
1692	# read remaining chunk	1858	# read remaining chunk
1693	$_[0]->unshift_read (chunk => $len, sub {	1859	$_[0]->unshift_read (chunk => $len, sub {
1694	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1860	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1695	$cb->($_[0], $ref);
1696	} else {
1697	$self->_error (Errno::EBADMSG);	1861	or $_[0]->_error (Errno::EBADMSG);
1698	}
1699	});	1862	});
1700	}	1863	}
1701		1864
1702	1	1865	1
1703	}	1866	}
		1867	};
		1868
		1869	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1870
		1871	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1872	record without consuming anything. Only SSL version 3 or higher
		1873	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1874	SSL2-compatible framing is supported).
		1875
		1876	If it detects that the input data is likely TLS, it calls the callback
		1877	with a true value for C<$detect> and the (on-wire) TLS version as second
		1878	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1879	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1880	be definitely not TLS, it calls the callback with a false value for
		1881	C<$detect>.
		1882
		1883	The callback could use this information to decide whether or not to start
		1884	TLS negotiation.
		1885
		1886	In all cases the data read so far is passed to the following read
		1887	handlers.
		1888
		1889	Usually you want to use the C<tls_autostart> read type instead.
		1890
		1891	If you want to design a protocol that works in the presence of TLS
		1892	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1893	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1894	read type does are a bit more strict, but might losen in the future to
		1895	accomodate protocol changes.
		1896
		1897	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1898	L<Net::SSLeay>).
		1899
		1900	=item tls_autostart => [$tls_ctx, ]$tls
		1901
		1902	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1903	to start tls by calling C<starttls> with the given arguments.
		1904
		1905	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1906	been configured to accept, as servers do not normally send a handshake on
		1907	their own and ths cannot be detected in this way.
		1908
		1909	See C<tls_detect> above for more details.
		1910
		1911	Example: give the client a chance to start TLS before accepting a text
		1912	line.
		1913
		1914	$hdl->push_read (tls_autostart => "accept");
		1915	$hdl->push_read (line => sub {
		1916	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1917	});
		1918
		1919	=cut
		1920
		1921	register_read_type tls_detect => sub {
		1922	my ($self, $cb) = @_;
		1923
		1924	sub {
		1925	# this regex matches a full or partial tls record
		1926	if (
		1927	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1928	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1929	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1930	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1931	) {
		1932	return if 3 != length $1; # partial match, can't decide yet
		1933
		1934	# full match, valid TLS record
		1935	my ($major, $minor) = unpack "CC", $1;
		1936	$cb->($self, "accept", $major + $minor * 0.1);
		1937	} else {
		1938	# mismatch == guaranteed not TLS
		1939	$cb->($self, undef);
		1940	}
		1941
		1942	1
		1943	}
		1944	};
		1945
		1946	register_read_type tls_autostart => sub {
		1947	my ($self, @tls) = @_;
		1948
		1949	$RH{tls_detect}($self, sub {
		1950	return unless $_[1];
		1951	$_[0]->starttls (@tls);
		1952	})
1704	};	1953	};
1705		1954
1706	=back	1955	=back
1707		1956
1708	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1957	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1740	Note that AnyEvent::Handle will automatically C<start_read> for you when	1989	Note that AnyEvent::Handle will automatically C<start_read> for you when
1741	you change the C<on_read> callback or push/unshift a read callback, and it	1990	you change the C<on_read> callback or push/unshift a read callback, and it
1742	will automatically C<stop_read> for you when neither C<on_read> is set nor	1991	will automatically C<stop_read> for you when neither C<on_read> is set nor
1743	there are any read requests in the queue.	1992	there are any read requests in the queue.
1744		1993
1745	These methods will have no effect when in TLS mode (as TLS doesn't support	1994	In older versions of this module (<= 5.3), these methods had no effect,
1746	half-duplex connections).	1995	as TLS does not support half-duplex connections. In current versions they
		1996	work as expected, as this behaviour is required to avoid certain resource
		1997	attacks, where the program would be forced to read (and buffer) arbitrary
		1998	amounts of data before being able to send some data. The drawback is that
		1999	some readings of the the SSL/TLS specifications basically require this
		2000	attack to be working, as SSL/TLS implementations might stall sending data
		2001	during a rehandshake.
		2002
		2003	As a guideline, during the initial handshake, you should not stop reading,
		2004	and as a client, it might cause problems, depending on your application.
1747		2005
1748	=cut	2006	=cut
1749		2007
1750	sub stop_read {	2008	sub stop_read {
1751	my ($self) = @_;	2009	my ($self) = @_;
1752		2010
1753	delete $self->{_rw} unless $self->{tls};	2011	delete $self->{_rw};
1754	}	2012	}
1755		2013
1756	sub start_read {	2014	sub start_read {
1757	my ($self) = @_;	2015	my ($self) = @_;
1758		2016
…		…
1783	} elsif (defined $len) {	2041	} elsif (defined $len) {
1784	delete $self->{_rw};	2042	delete $self->{_rw};
1785	$self->{_eof} = 1;	2043	$self->{_eof} = 1;
1786	$self->_drain_rbuf;	2044	$self->_drain_rbuf;
1787		2045
1788	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2046	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1789	return $self->_error ($!, 1);	2047	return $self->_error ($!, 1);
1790	}	2048	}
1791	};	2049	};
1792	}	2050	}
1793	}	2051	}
…		…
1799	my ($self, $err) = @_;	2057	my ($self, $err) = @_;
1800		2058
1801	return $self->_error ($!, 1)	2059	return $self->_error ($!, 1)
1802	if $err == Net::SSLeay::ERROR_SYSCALL ();	2060	if $err == Net::SSLeay::ERROR_SYSCALL ();
1803		2061
1804	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2062	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1805		2063
1806	# reduce error string to look less scary	2064	# reduce error string to look less scary
1807	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2065	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1808		2066
1809	if ($self->{_on_starttls}) {	2067	if ($self->{_on_starttls}) {
…		…
1823	sub _dotls {	2081	sub _dotls {
1824	my ($self) = @_;	2082	my ($self) = @_;
1825		2083
1826	my $tmp;	2084	my $tmp;
1827		2085
1828	if (length $self->{_tls_wbuf}) {	2086	while (length $self->{_tls_wbuf}) {
1829	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2087	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1830	substr $self->{_tls_wbuf}, 0, $tmp, "";	2088	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2089
		2090	return $self->_tls_error ($tmp)
		2091	if $tmp != $ERROR_WANT_READ
		2092	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2093
		2094	last;
1831	}	2095	}
1832		2096
1833	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2097	substr $self->{_tls_wbuf}, 0, $tmp, "";
1834	return $self->_tls_error ($tmp)
1835	if $tmp != $ERROR_WANT_READ
1836	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1837	}	2098	}
1838		2099
1839	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2100	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1840	unless (length $tmp) {	2101	unless (length $tmp) {
1841	$self->{_on_starttls}	2102	$self->{_on_starttls}
…		…
1855	$self->{_tls_rbuf} .= $tmp;	2116	$self->{_tls_rbuf} .= $tmp;
1856	$self->_drain_rbuf;	2117	$self->_drain_rbuf;
1857	$self->{tls} or return; # tls session might have gone away in callback	2118	$self->{tls} or return; # tls session might have gone away in callback
1858	}	2119	}
1859		2120
1860	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2121	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1861	return $self->_tls_error ($tmp)	2122	return $self->_tls_error ($tmp)
1862	if $tmp != $ERROR_WANT_READ	2123	if $tmp != $ERROR_WANT_READ
1863	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2124	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1864		2125
1865	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2126	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1875		2136
1876	=item $handle->starttls ($tls[, $tls_ctx])	2137	=item $handle->starttls ($tls[, $tls_ctx])
1877		2138
1878	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2139	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1879	object is created, you can also do that at a later time by calling	2140	object is created, you can also do that at a later time by calling
1880	C<starttls>.	2141	C<starttls>. See the C<tls> constructor argument for general info.
1881		2142
1882	Starting TLS is currently an asynchronous operation - when you push some	2143	Starting TLS is currently an asynchronous operation - when you push some
1883	write data and then call C<< ->starttls >> then TLS negotiation will start	2144	write data and then call C<< ->starttls >> then TLS negotiation will start
1884	immediately, after which the queued write data is then sent.	2145	immediately, after which the queued write data is then sent. This might
		2146	change in future versions, so best make sure you have no outstanding write
		2147	data when calling this method.
1885		2148
1886	The first argument is the same as the C<tls> constructor argument (either	2149	The first argument is the same as the C<tls> constructor argument (either
1887	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2150	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1888		2151
1889	The second argument is the optional C<AnyEvent::TLS> object that is used	2152	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1911	my ($self, $tls, $ctx) = @_;	2174	my ($self, $tls, $ctx) = @_;
1912		2175
1913	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2176	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1914	if $self->{tls};	2177	if $self->{tls};
1915		2178
		2179	unless (defined $AnyEvent::TLS::VERSION) {
		2180	eval {
		2181	require Net::SSLeay;
		2182	require AnyEvent::TLS;
		2183	1
		2184	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2185	}
		2186
1916	$self->{tls} = $tls;	2187	$self->{tls} = $tls;
1917	$self->{tls_ctx} = $ctx if @_ > 2;	2188	$self->{tls_ctx} = $ctx if @_ > 2;
1918		2189
1919	return unless $self->{fh};	2190	return unless $self->{fh};
1920		2191
1921	require Net::SSLeay;
1922
1923	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2192	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1924	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2193	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1925		2194
1926	$tls = delete $self->{tls};	2195	$tls = delete $self->{tls};
1927	$ctx = $self->{tls_ctx};	2196	$ctx = $self->{tls_ctx};
1928		2197
1929	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2198	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1930		2199
1931	if ("HASH" eq ref $ctx) {	2200	if ("HASH" eq ref $ctx) {
1932	require AnyEvent::TLS;
1933
1934	if ($ctx->{cache}) {	2201	if ($ctx->{cache}) {
1935	my $key = $ctx+0;	2202	my $key = $ctx+0;
1936	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2203	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1937	} else {	2204	} else {
1938	$ctx = new AnyEvent::TLS %$ctx;	2205	$ctx = new AnyEvent::TLS %$ctx;
…		…
1960	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2227	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1961		2228
1962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2229	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2230	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1964		2231
1965	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2232	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2233	$self->{rbuf} = "";
1966		2234
1967	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2235	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1968		2236
1969	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2237	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1970	if $self->{on_starttls};	2238	if $self->{on_starttls};
…		…
2008	if $self->{tls} > 0;	2276	if $self->{tls} > 0;
2009		2277
2010	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2278	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2011	}	2279	}
2012		2280
		2281	=item $handle->resettls
		2282
		2283	This rarely-used method simply resets and TLS state on the handle, usually
		2284	causing data loss.
		2285
		2286	One case where it may be useful is when you want to skip over the data in
		2287	the stream but you are not interested in interpreting it, so data loss is
		2288	no concern.
		2289
		2290	=cut
		2291
		2292	*resettls = \&_freetls;
		2293
2013	sub DESTROY {	2294	sub DESTROY {
2014	my ($self) = @_;	2295	my ($self) = @_;
2015		2296
2016	&_freetls;	2297	&_freetls;
2017		2298
…		…
2026	push @linger, AE::io $fh, 1, sub {	2307	push @linger, AE::io $fh, 1, sub {
2027	my $len = syswrite $fh, $wbuf, length $wbuf;	2308	my $len = syswrite $fh, $wbuf, length $wbuf;
2028		2309
2029	if ($len > 0) {	2310	if ($len > 0) {
2030	substr $wbuf, 0, $len, "";	2311	substr $wbuf, 0, $len, "";
2031	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2312	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2032	@linger = (); # end	2313	@linger = (); # end
2033	}	2314	}
2034	};	2315	};
2035	push @linger, AE::timer $linger, 0, sub {	2316	push @linger, AE::timer $linger, 0, sub {
2036	@linger = ();	2317	@linger = ();
…		…
2132		2413
2133	It is only safe to "forget" the reference inside EOF or error callbacks,	2414	It is only safe to "forget" the reference inside EOF or error callbacks,
2134	from within all other callbacks, you need to explicitly call the C<<	2415	from within all other callbacks, you need to explicitly call the C<<
2135	->destroy >> method.	2416	->destroy >> method.
2136		2417
		2418	=item Why is my C<on_eof> callback never called?
		2419
		2420	Probably because your C<on_error> callback is being called instead: When
		2421	you have outstanding requests in your read queue, then an EOF is
		2422	considered an error as you clearly expected some data.
		2423
		2424	To avoid this, make sure you have an empty read queue whenever your handle
		2425	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2426	an C<on_read> handler that simply pushes the first read requests in the
		2427	queue.
		2428
		2429	See also the next question, which explains this in a bit more detail.
		2430
		2431	=item How can I serve requests in a loop?
		2432
		2433	Most protocols consist of some setup phase (authentication for example)
		2434	followed by a request handling phase, where the server waits for requests
		2435	and handles them, in a loop.
		2436
		2437	There are two important variants: The first (traditional, better) variant
		2438	handles requests until the server gets some QUIT command, causing it to
		2439	close the connection first (highly desirable for a busy TCP server). A
		2440	client dropping the connection is an error, which means this variant can
		2441	detect an unexpected detection close.
		2442
		2443	To handle this case, always make sure you have a non-empty read queue, by
		2444	pushing the "read request start" handler on it:
		2445
		2446	# we assume a request starts with a single line
		2447	my @start_request; @start_request = (line => sub {
		2448	my ($hdl, $line) = @_;
		2449
		2450	... handle request
		2451
		2452	# push next request read, possibly from a nested callback
		2453	$hdl->push_read (@start_request);
		2454	});
		2455
		2456	# auth done, now go into request handling loop
		2457	# now push the first @start_request
		2458	$hdl->push_read (@start_request);
		2459
		2460	By always having an outstanding C<push_read>, the handle always expects
		2461	some data and raises the C<EPIPE> error when the connction is dropped
		2462	unexpectedly.
		2463
		2464	The second variant is a protocol where the client can drop the connection
		2465	at any time. For TCP, this means that the server machine may run out of
		2466	sockets easier, and in general, it means you cannot distinguish a protocl
		2467	failure/client crash from a normal connection close. Nevertheless, these
		2468	kinds of protocols are common (and sometimes even the best solution to the
		2469	problem).
		2470
		2471	Having an outstanding read request at all times is possible if you ignore
		2472	C<EPIPE> errors, but this doesn't help with when the client drops the
		2473	connection during a request, which would still be an error.
		2474
		2475	A better solution is to push the initial request read in an C<on_read>
		2476	callback. This avoids an error, as when the server doesn't expect data
		2477	(i.e. is idly waiting for the next request, an EOF will not raise an
		2478	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2479	and simpler:
		2480
		2481	# auth done, now go into request handling loop
		2482	$hdl->on_read (sub {
		2483	my ($hdl) = @_;
		2484
		2485	# called each time we receive data but the read queue is empty
		2486	# simply start read the request
		2487
		2488	$hdl->push_read (line => sub {
		2489	my ($hdl, $line) = @_;
		2490
		2491	... handle request
		2492
		2493	# do nothing special when the request has been handled, just
		2494	# let the request queue go empty.
		2495	});
		2496	});
		2497
2137	=item I get different callback invocations in TLS mode/Why can't I pause	2498	=item I get different callback invocations in TLS mode/Why can't I pause
2138	reading?	2499	reading?
2139		2500
2140	Unlike, say, TCP, TLS connections do not consist of two independent	2501	Unlike, say, TCP, TLS connections do not consist of two independent
2141	communication channels, one for each direction. Or put differently, the	2502	communication channels, one for each direction. Or put differently, the
…		…
2162	$handle->on_eof (undef);	2523	$handle->on_eof (undef);
2163	$handle->on_error (sub {	2524	$handle->on_error (sub {
2164	my $data = delete $_[0]{rbuf};	2525	my $data = delete $_[0]{rbuf};
2165	});	2526	});
2166		2527
		2528	Note that this example removes the C<rbuf> member from the handle object,
		2529	which is not normally allowed by the API. It is expressly permitted in
		2530	this case only, as the handle object needs to be destroyed afterwards.
		2531
2167	The reason to use C<on_error> is that TCP connections, due to latencies	2532	The reason to use C<on_error> is that TCP connections, due to latencies
2168	and packets loss, might get closed quite violently with an error, when in	2533	and packets loss, might get closed quite violently with an error, when in
2169	fact all data has been received.	2534	fact all data has been received.
2170		2535
2171	It is usually better to use acknowledgements when transferring data,	2536	It is usually better to use acknowledgements when transferring data,
…		…
2181	C<low_water_mark> this will be called precisely when all data has been	2546	C<low_water_mark> this will be called precisely when all data has been
2182	written to the socket:	2547	written to the socket:
2183		2548
2184	$handle->push_write (...);	2549	$handle->push_write (...);
2185	$handle->on_drain (sub {	2550	$handle->on_drain (sub {
2186	warn "all data submitted to the kernel\n";	2551	AE::log debug => "All data submitted to the kernel.";
2187	undef $handle;	2552	undef $handle;
2188	});	2553	});
2189		2554
2190	If you just want to queue some data and then signal EOF to the other side,	2555	If you just want to queue some data and then signal EOF to the other side,
2191	consider using C<< ->push_shutdown >> instead.	2556	consider using C<< ->push_shutdown >> instead.
…		…
2275	When you have intermediate CA certificates that your clients might not	2640	When you have intermediate CA certificates that your clients might not
2276	know about, just append them to the C<cert_file>.	2641	know about, just append them to the C<cert_file>.
2277		2642
2278	=back	2643	=back
2279		2644
2280
2281	=head1 SUBCLASSING AnyEvent::Handle	2645	=head1 SUBCLASSING AnyEvent::Handle
2282		2646
2283	In many cases, you might want to subclass AnyEvent::Handle.	2647	In many cases, you might want to subclass AnyEvent::Handle.
2284		2648
2285	To make this easier, a given version of AnyEvent::Handle uses these	2649	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2311		2675
2312	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2676	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2313		2677
2314	=cut	2678	=cut
2315		2679
2316	1; # End of AnyEvent::Handle	2680	1
		2681

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.203 by root, Sat Oct 16 03:22:10 2010 UTC vs. Revision 1.247 by root, Thu Jan 7 10:03:46 2016 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.203 by root, Sat Oct 16 03:22:10 2010 UTC vs.
Revision 1.247 by root, Thu Jan 7 10:03:46 2016 UTC