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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.207 by root, Mon Nov 15 22:29:36 2010 UTC vs.
Revision 1.250 by root, Tue Feb 26 01:35:48 2019 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
…		…
164	with active (but unsatisfiable) 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
…		…
462	callback.	495	callback.
463		496
464	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
465	underlying handle signals EOF.	498	underlying handle signals EOF.
466		499
467	=item json => JSON or JSON::XS object	500	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
468		501
469	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.
470		503
471	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
472	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
473	texts.	516	text.
474		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
475	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
476	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.
477		537
478	=back	538	=back
479		539
480	=cut	540	=cut
481		541
…		…
521	});	581	});
522		582
523	} else {	583	} else {
524	if ($self->{on_connect_error}) {	584	if ($self->{on_connect_error}) {
525	$self->{on_connect_error}($self, "$!");	585	$self->{on_connect_error}($self, "$!");
526	$self->destroy;	586	$self->destroy if $self;
527	} else {	587	} else {
528	$self->_error ($!, 1);	588	$self->_error ($!, 1);
529	}	589	}
530	}	590	}
531	},	591	},
532	sub {	592	sub {
533	local $self->{fh} = $_[0];	593	local $self->{fh} = $_[0];
534		594
535	$self->{on_prepare}	595	$self->{on_prepare}
536	? $self->{on_prepare}->($self)	596	? $self->{on_prepare}->($self)
537	: ()	597	: ()
538	}	598	}
539	);	599	);
540	}	600	}
541		601
…		…
553	# with AnyEvent::Handle, do them a favour.	613	# with AnyEvent::Handle, do them a favour.
554	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();	614	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
555	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!"
556	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;	616	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
557		617
558	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	618	AnyEvent::fh_unblock $self->{fh};
559		619
560	$self->{_activity} =	620	$self->{_activity} =
561	$self->{_ractivity} =	621	$self->{_ractivity} =
562	$self->{_wactivity} = AE::now;	622	$self->{_wactivity} = AE::now;
563		623
…		…
699	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]	759	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
700	if $_[0]{fh};	760	if $_[0]{fh};
701	};	761	};
702	}	762	}
703		763
704	=item $handle->keepalive ($boolean)
705
706	Enables or disables the C<keepalive> setting (see constructor argument of
707	the same name for details).
708
709	=cut
710
711	sub keepalive {
712	$_[0]{keepalive} = $_[1];
713
714	eval {
715	local $SIG{__DIE__};
716	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
717	if $_[0]{fh};
718	};
719	}
720
721	=item $handle->on_starttls ($cb)	764	=item $handle->on_starttls ($cb)
722		765
723	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	766	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
724		767
725	=cut	768	=cut
…		…
740		783
741	=item $handle->rbuf_max ($max_octets)	784	=item $handle->rbuf_max ($max_octets)
742		785
743	Configures the C<rbuf_max> setting (C<undef> disables it).	786	Configures the C<rbuf_max> setting (C<undef> disables it).
744		787
		788	=item $handle->wbuf_max ($max_octets)
		789
		790	Configures the C<wbuf_max> setting (C<undef> disables it).
		791
745	=cut	792	=cut
746		793
747	sub rbuf_max {	794	sub rbuf_max {
748	$_[0]{rbuf_max} = $_[1];	795	$_[0]{rbuf_max} = $_[1];
749	}	796	}
750		797
		798	sub wbuf_max {
		799	$_[0]{wbuf_max} = $_[1];
		800	}
		801
751	#############################################################################	802	#############################################################################
752		803
753	=item $handle->timeout ($seconds)	804	=item $handle->timeout ($seconds)
754		805
755	=item $handle->rtimeout ($seconds)	806	=item $handle->rtimeout ($seconds)
756		807
757	=item $handle->wtimeout ($seconds)	808	=item $handle->wtimeout ($seconds)
758		809
759	Configures (or disables) the inactivity timeout.	810	Configures (or disables) the inactivity timeout.
		811
		812	The timeout will be checked instantly, so this method might destroy the
		813	handle before it returns.
760		814
761	=item $handle->timeout_reset	815	=item $handle->timeout_reset
762		816
763	=item $handle->rtimeout_reset	817	=item $handle->rtimeout_reset
764		818
…		…
848		902
849	The write queue is very simple: you can add data to its end, and	903	The write queue is very simple: you can add data to its end, and
850	AnyEvent::Handle will automatically try to get rid of it for you.	904	AnyEvent::Handle will automatically try to get rid of it for you.
851		905
852	When data could be written and the write buffer is shorter then the low	906	When data could be written and the write buffer is shorter then the low
853	water mark, the C<on_drain> callback will be invoked.	907	water mark, the C<on_drain> callback will be invoked once.
854		908
855	=over 4	909	=over 4
856		910
857	=item $handle->on_drain ($cb)	911	=item $handle->on_drain ($cb)
858		912
…		…
873	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	927	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
874	}	928	}
875		929
876	=item $handle->push_write ($data)	930	=item $handle->push_write ($data)
877		931
878	Queues the given scalar to be written. You can push as much data as you	932	Queues the given scalar to be written. You can push as much data as
879	want (only limited by the available memory), as C<AnyEvent::Handle>	933	you want (only limited by the available memory and C<wbuf_max>), as
880	buffers it independently of the kernel.	934	C<AnyEvent::Handle> buffers it independently of the kernel.
881		935
882	This method may invoke callbacks (and therefore the handle might be	936	This method may invoke callbacks (and therefore the handle might be
883	destroyed after it returns).	937	destroyed after it returns).
884		938
885	=cut	939	=cut
…		…
902	$self->{on_drain}($self)	956	$self->{on_drain}($self)
903	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	957	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
904	&& $self->{on_drain};	958	&& $self->{on_drain};
905		959
906	delete $self->{_ww} unless length $self->{wbuf};	960	delete $self->{_ww} unless length $self->{wbuf};
907	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	961	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
908	$self->_error ($!, 1);	962	$self->_error ($!, 1);
909	}	963	}
910	};	964	};
911		965
912	# try to write data immediately	966	# try to write data immediately
913	$cb->() unless $self->{autocork};	967	$cb->() unless $self->{autocork};
914		968
915	# if still data left in wbuf, we need to poll	969	# if still data left in wbuf, we need to poll
916	$self->{_ww} = AE::io $self->{fh}, 1, $cb	970	$self->{_ww} = AE::io $self->{fh}, 1, $cb
917	if length $self->{wbuf};	971	if length $self->{wbuf};
		972
		973	if (
		974	defined $self->{wbuf_max}
		975	&& $self->{wbuf_max} < length $self->{wbuf}
		976	) {
		977	$self->_error (Errno::ENOSPC, 1), return;
		978	}
918	};	979	};
919	}	980	}
920		981
921	our %WH;	982	our %WH;
922		983
…		…
993		1054
994	Encodes the given hash or array reference into a JSON object. Unless you	1055	Encodes the given hash or array reference into a JSON object. Unless you
995	provide your own JSON object, this means it will be encoded to JSON text	1056	provide your own JSON object, this means it will be encoded to JSON text
996	in UTF-8.	1057	in UTF-8.
997		1058
		1059	The default encoder might or might not handle every type of JSON value -
		1060	it might be limited to arrays and objects for security reasons. See the
		1061	C<json> constructor attribute for more details.
		1062
998	JSON objects (and arrays) are self-delimiting, so you can write JSON at	1063	JSON objects (and arrays) are self-delimiting, so if you only use arrays
999	one end of a handle and read them at the other end without using any	1064	and hashes, you can write JSON at one end of a handle and read them at the
1000	additional framing.	1065	other end without using any additional framing.
1001		1066
1002	The generated JSON text is guaranteed not to contain any newlines: While	1067	The JSON text generated by the default encoder is guaranteed not to
1003	this module doesn't need delimiters after or between JSON texts to be	1068	contain any newlines: While this module doesn't need delimiters after or
1004	able to read them, many other languages depend on that.	1069	between JSON texts to be able to read them, many other languages depend on
		1070	them.
1005		1071
1006	A simple RPC protocol that interoperates easily with others is to send	1072	A simple RPC protocol that interoperates easily with other languages is
1007	JSON arrays (or objects, although arrays are usually the better choice as	1073	to send JSON arrays (or objects, although arrays are usually the better
1008	they mimic how function argument passing works) and a newline after each	1074	choice as they mimic how function argument passing works) and a newline
1009	JSON text:	1075	after each JSON text:
1010		1076
1011	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1077	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1012	$handle->push_write ("\012");	1078	$handle->push_write ("\012");
1013		1079
1014	An AnyEvent::Handle receiver would simply use the C<json> read type and	1080	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
1017	$handle->push_read (json => sub { my $array = $_[1]; ... });	1083	$handle->push_read (json => sub { my $array = $_[1]; ... });
1018		1084
1019	Other languages could read single lines terminated by a newline and pass	1085	Other languages could read single lines terminated by a newline and pass
1020	this line into their JSON decoder of choice.	1086	this line into their JSON decoder of choice.
1021		1087
		1088	=item cbor => $perl_scalar
		1089
		1090	Encodes the given scalar into a CBOR value. Unless you provide your own
		1091	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1092	using any extensions, if possible.
		1093
		1094	CBOR values are self-delimiting, so you can write CBOR at one end of
		1095	a handle and read them at the other end without using any additional
		1096	framing.
		1097
		1098	A simple nd very very fast RPC protocol that interoperates with
		1099	other languages is to send CBOR and receive CBOR values (arrays are
		1100	recommended):
		1101
		1102	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1103
		1104	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1105
		1106	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1107
1022	=cut	1108	=cut
1023		1109
1024	sub json_coder() {	1110	sub json_coder() {
1025	eval { require JSON::XS; JSON::XS->new->utf8 }	1111	eval { require JSON::XS; JSON::XS->new->utf8 }
1026	\|\| do { require JSON; JSON->new->utf8 }	1112	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1027	}	1113	}
1028		1114
1029	register_write_type json => sub {	1115	register_write_type json => sub {
1030	my ($self, $ref) = @_;	1116	my ($self, $ref) = @_;
1031		1117
1032	my $json = $self->{json} \|\|= json_coder;	1118	($self->{json} \|\|= json_coder)
1033
1034	$json->encode ($ref)	1119	->encode ($ref)
		1120	};
		1121
		1122	sub cbor_coder() {
		1123	require CBOR::XS;
		1124	CBOR::XS->new
		1125	}
		1126
		1127	register_write_type cbor => sub {
		1128	my ($self, $scalar) = @_;
		1129
		1130	($self->{cbor} \|\|= cbor_coder)
		1131	->encode ($scalar)
1035	};	1132	};
1036		1133
1037	=item storable => $reference	1134	=item storable => $reference
1038		1135
1039	Freezes the given reference using L<Storable> and writes it to the	1136	Freezes the given reference using L<Storable> and writes it to the
…		…
1042	=cut	1139	=cut
1043		1140
1044	register_write_type storable => sub {	1141	register_write_type storable => sub {
1045	my ($self, $ref) = @_;	1142	my ($self, $ref) = @_;
1046		1143
1047	require Storable;	1144	require Storable unless $Storable::VERSION;
1048		1145
1049	pack "w/a*", Storable::nfreeze ($ref)	1146	pack "w/a*", Storable::nfreeze ($ref)
1050	};	1147	};
1051		1148
1052	=back	1149	=back
…		…
1057	before it was actually written. One way to do that is to replace your	1154	before it was actually written. One way to do that is to replace your
1058	C<on_drain> handler by a callback that shuts down the socket (and set	1155	C<on_drain> handler by a callback that shuts down the socket (and set
1059	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1156	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1060	replaces the C<on_drain> callback with:	1157	replaces the C<on_drain> callback with:
1061		1158
1062	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1159	sub { shutdown $_[0]{fh}, 1 }
1063		1160
1064	This simply shuts down the write side and signals an EOF condition to the	1161	This simply shuts down the write side and signals an EOF condition to the
1065	the peer.	1162	the peer.
1066		1163
1067	You can rely on the normal read queue and C<on_eof> handling	1164	You can rely on the normal read queue and C<on_eof> handling
…		…
1089		1186
1090	Whenever the given C<type> is used, C<push_write> will the function with	1187	Whenever the given C<type> is used, C<push_write> will the function with
1091	the handle object and the remaining arguments.	1188	the handle object and the remaining arguments.
1092		1189
1093	The function is supposed to return a single octet string that will be	1190	The function is supposed to return a single octet string that will be
1094	appended to the write buffer, so you cna mentally treat this function as a	1191	appended to the write buffer, so you can mentally treat this function as a
1095	"arguments to on-the-wire-format" converter.	1192	"arguments to on-the-wire-format" converter.
1096		1193
1097	Example: implement a custom write type C<join> that joins the remaining	1194	Example: implement a custom write type C<join> that joins the remaining
1098	arguments using the first one.	1195	arguments using the first one.
1099		1196
…		…
1393	data.	1490	data.
1394		1491
1395	Example: read 2 bytes.	1492	Example: read 2 bytes.
1396		1493
1397	$handle->push_read (chunk => 2, sub {	1494	$handle->push_read (chunk => 2, sub {
1398	warn "yay ", unpack "H*", $_[1];	1495	say "yay " . unpack "H*", $_[1];
1399	});	1496	});
1400		1497
1401	=cut	1498	=cut
1402		1499
1403	register_read_type chunk => sub {	1500	register_read_type chunk => sub {
…		…
1433		1530
1434	register_read_type line => sub {	1531	register_read_type line => sub {
1435	my ($self, $cb, $eol) = @_;	1532	my ($self, $cb, $eol) = @_;
1436		1533
1437	if (@_ < 3) {	1534	if (@_ < 3) {
1438	# this is more than twice as fast as the generic code below	1535	# this is faster then the generic code below
1439	sub {	1536	sub {
1440	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1537	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1538	or return;
1441		1539
		1540	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1442	$cb->($_[0], $1, $2);	1541	$cb->($_[0], $str, "$1");
1443	1	1542	1
1444	}	1543	}
1445	} else {	1544	} else {
1446	$eol = quotemeta $eol unless ref $eol;	1545	$eol = quotemeta $eol unless ref $eol;
1447	$eol = qr\|^(.*?)($eol)\|s;	1546	$eol = qr\|^(.*?)($eol)\|s;
1448		1547
1449	sub {	1548	sub {
1450	$_[0]{rbuf} =~ s/$eol// or return;	1549	$_[0]{rbuf} =~ s/$eol// or return;
1451		1550
1452	$cb->($_[0], $1, $2);	1551	$cb->($_[0], "$1", "$2");
1453	1	1552	1
1454	}	1553	}
1455	}	1554	}
1456	};	1555	};
1457		1556
1458	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1557	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1459		1558
1460	Makes a regex match against the regex object C<$accept> and returns	1559	Makes a regex match against the regex object C<$accept> and returns
1461	everything up to and including the match.	1560	everything up to and including the match. All the usual regex variables
		1561	($1, %+ etc.) from the regex match are available in the callback.
1462		1562
1463	Example: read a single line terminated by '\n'.	1563	Example: read a single line terminated by '\n'.
1464		1564
1465	$handle->push_read (regex => qr<\n>, sub { ... });	1565	$handle->push_read (regex => qr<\n>, sub { ... });
1466		1566
…		…
1505		1605
1506	sub {	1606	sub {
1507	# accept	1607	# accept
1508	if ($$rbuf =~ $accept) {	1608	if ($$rbuf =~ $accept) {
1509	$data .= substr $$rbuf, 0, $+[0], "";	1609	$data .= substr $$rbuf, 0, $+[0], "";
1510	$cb->($self, $data);	1610	$cb->($_[0], $data);
1511	return 1;	1611	return 1;
1512	}	1612	}
1513		1613
1514	# reject	1614	# reject
1515	if ($reject && $$rbuf =~ $reject) {	1615	if ($reject && $$rbuf =~ $reject) {
1516	$self->_error (Errno::EBADMSG);	1616	$_[0]->_error (Errno::EBADMSG);
1517	}	1617	}
1518		1618
1519	# skip	1619	# skip
1520	if ($skip && $$rbuf =~ $skip) {	1620	if ($skip && $$rbuf =~ $skip) {
1521	$data .= substr $$rbuf, 0, $+[0], "";	1621	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1537	my ($self, $cb) = @_;	1637	my ($self, $cb) = @_;
1538		1638
1539	sub {	1639	sub {
1540	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1640	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1541	if ($_[0]{rbuf} =~ /[^0-9]/) {	1641	if ($_[0]{rbuf} =~ /[^0-9]/) {
1542	$self->_error (Errno::EBADMSG);	1642	$_[0]->_error (Errno::EBADMSG);
1543	}	1643	}
1544	return;	1644	return;
1545	}	1645	}
1546		1646
1547	my $len = $1;	1647	my $len = $1;
1548		1648
1549	$self->unshift_read (chunk => $len, sub {	1649	$_[0]->unshift_read (chunk => $len, sub {
1550	my $string = $_[1];	1650	my $string = $_[1];
1551	$_[0]->unshift_read (chunk => 1, sub {	1651	$_[0]->unshift_read (chunk => 1, sub {
1552	if ($_[1] eq ",") {	1652	if ($_[1] eq ",") {
1553	$cb->($_[0], $string);	1653	$cb->($_[0], $string);
1554	} else {	1654	} else {
1555	$self->_error (Errno::EBADMSG);	1655	$_[0]->_error (Errno::EBADMSG);
1556	}	1656	}
1557	});	1657	});
1558	});	1658	});
1559		1659
1560	1	1660	1
…		…
1610	=item json => $cb->($handle, $hash_or_arrayref)	1710	=item json => $cb->($handle, $hash_or_arrayref)
1611		1711
1612	Reads a JSON object or array, decodes it and passes it to the	1712	Reads a JSON object or array, decodes it and passes it to the
1613	callback. When a parse error occurs, an C<EBADMSG> error will be raised.	1713	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1614		1714
1615	If a C<json> object was passed to the constructor, then that will be used	1715	If a C<json> object was passed to the constructor, then that will be
1616	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1716	used for the final decode, otherwise it will create a L<JSON::XS> or
		1717	L<JSON::PP> coder object expecting UTF-8.
1617		1718
1618	This read type uses the incremental parser available with JSON version	1719	This read type uses the incremental parser available with JSON version
1619	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1720	2.09 (and JSON::XS version 2.2) and above.
1620	dependency on your own: this module will load the JSON module, but
1621	AnyEvent does not depend on it itself.
1622		1721
1623	Since JSON texts are fully self-delimiting, the C<json> read and write	1722	Since JSON texts are fully self-delimiting, the C<json> read and write
1624	types are an ideal simple RPC protocol: just exchange JSON datagrams. See	1723	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
1625	the C<json> write type description, above, for an actual example.	1724	the C<json> write type description, above, for an actual example.
1626		1725
…		…
1630	my ($self, $cb) = @_;	1729	my ($self, $cb) = @_;
1631		1730
1632	my $json = $self->{json} \|\|= json_coder;	1731	my $json = $self->{json} \|\|= json_coder;
1633		1732
1634	my $data;	1733	my $data;
1635	my $rbuf = \$self->{rbuf};
1636		1734
1637	sub {	1735	sub {
1638	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1736	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1639		1737
1640	if ($ref) {	1738	if ($ref) {
1641	$self->{rbuf} = $json->incr_text;	1739	$_[0]{rbuf} = $json->incr_text;
1642	$json->incr_text = "";	1740	$json->incr_text = "";
1643	$cb->($self, $ref);	1741	$cb->($_[0], $ref);
1644		1742
1645	1	1743	1
1646	} elsif ($@) {	1744	} elsif ($@) {
1647	# error case	1745	# error case
1648	$json->incr_skip;	1746	$json->incr_skip;
1649		1747
1650	$self->{rbuf} = $json->incr_text;	1748	$_[0]{rbuf} = $json->incr_text;
1651	$json->incr_text = "";	1749	$json->incr_text = "";
1652		1750
1653	$self->_error (Errno::EBADMSG);	1751	$_[0]->_error (Errno::EBADMSG);
1654		1752
1655	()	1753	()
1656	} else {	1754	} else {
1657	$self->{rbuf} = "";	1755	$_[0]{rbuf} = "";
1658		1756
		1757	()
		1758	}
		1759	}
		1760	};
		1761
		1762	=item cbor => $cb->($handle, $scalar)
		1763
		1764	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1765	error occurs, an C<EBADMSG> error will be raised.
		1766
		1767	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1768	used for the final decode, otherwise it will create a CBOR coder without
		1769	enabling any options.
		1770
		1771	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1772	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1773	itself.
		1774
		1775	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1776	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1777	the C<cbor> write type description, above, for an actual example.
		1778
		1779	=cut
		1780
		1781	register_read_type cbor => sub {
		1782	my ($self, $cb) = @_;
		1783
		1784	my $cbor = $self->{cbor} \|\|= cbor_coder;
		1785
		1786	my $data;
		1787
		1788	sub {
		1789	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1790
		1791	if (@value) {
		1792	$cb->($_[0], @value);
		1793
		1794	1
		1795	} elsif ($@) {
		1796	# error case
		1797	$cbor->incr_reset;
		1798
		1799	$_[0]->_error (Errno::EBADMSG);
		1800
		1801	()
		1802	} else {
1659	()	1803	()
1660	}	1804	}
1661	}	1805	}
1662	};	1806	};
1663		1807
…		…
1672	=cut	1816	=cut
1673		1817
1674	register_read_type storable => sub {	1818	register_read_type storable => sub {
1675	my ($self, $cb) = @_;	1819	my ($self, $cb) = @_;
1676		1820
1677	require Storable;	1821	require Storable unless $Storable::VERSION;
1678		1822
1679	sub {	1823	sub {
1680	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1824	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1681	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1825	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1682	or return;	1826	or return;
…		…
1685		1829
1686	# bypass unshift if we already have the remaining chunk	1830	# bypass unshift if we already have the remaining chunk
1687	if ($format + $len <= length $_[0]{rbuf}) {	1831	if ($format + $len <= length $_[0]{rbuf}) {
1688	my $data = substr $_[0]{rbuf}, $format, $len;	1832	my $data = substr $_[0]{rbuf}, $format, $len;
1689	substr $_[0]{rbuf}, 0, $format + $len, "";	1833	substr $_[0]{rbuf}, 0, $format + $len, "";
		1834
1690	$cb->($_[0], Storable::thaw ($data));	1835	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1836	or return $_[0]->_error (Errno::EBADMSG);
1691	} else {	1837	} else {
1692	# remove prefix	1838	# remove prefix
1693	substr $_[0]{rbuf}, 0, $format, "";	1839	substr $_[0]{rbuf}, 0, $format, "";
1694		1840
1695	# read remaining chunk	1841	# read remaining chunk
1696	$_[0]->unshift_read (chunk => $len, sub {	1842	$_[0]->unshift_read (chunk => $len, sub {
1697	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1843	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1698	$cb->($_[0], $ref);
1699	} else {
1700	$self->_error (Errno::EBADMSG);	1844	or $_[0]->_error (Errno::EBADMSG);
1701	}
1702	});	1845	});
1703	}	1846	}
1704		1847
1705	1	1848	1
1706	}	1849	}
		1850	};
		1851
		1852	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1853
		1854	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1855	record without consuming anything. Only SSL version 3 or higher
		1856	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1857	SSL2-compatible framing is supported).
		1858
		1859	If it detects that the input data is likely TLS, it calls the callback
		1860	with a true value for C<$detect> and the (on-wire) TLS version as second
		1861	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1862	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1863	be definitely not TLS, it calls the callback with a false value for
		1864	C<$detect>.
		1865
		1866	The callback could use this information to decide whether or not to start
		1867	TLS negotiation.
		1868
		1869	In all cases the data read so far is passed to the following read
		1870	handlers.
		1871
		1872	Usually you want to use the C<tls_autostart> read type instead.
		1873
		1874	If you want to design a protocol that works in the presence of TLS
		1875	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1876	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1877	read type does are a bit more strict, but might losen in the future to
		1878	accomodate protocol changes.
		1879
		1880	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1881	L<Net::SSLeay>).
		1882
		1883	=item tls_autostart => [$tls_ctx, ]$tls
		1884
		1885	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1886	to start tls by calling C<starttls> with the given arguments.
		1887
		1888	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1889	been configured to accept, as servers do not normally send a handshake on
		1890	their own and ths cannot be detected in this way.
		1891
		1892	See C<tls_detect> above for more details.
		1893
		1894	Example: give the client a chance to start TLS before accepting a text
		1895	line.
		1896
		1897	$hdl->push_read (tls_autostart => "accept");
		1898	$hdl->push_read (line => sub {
		1899	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1900	});
		1901
		1902	=cut
		1903
		1904	register_read_type tls_detect => sub {
		1905	my ($self, $cb) = @_;
		1906
		1907	sub {
		1908	# this regex matches a full or partial tls record
		1909	if (
		1910	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1911	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1912	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1913	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1914	) {
		1915	return if 3 != length $1; # partial match, can't decide yet
		1916
		1917	# full match, valid TLS record
		1918	my ($major, $minor) = unpack "CC", $1;
		1919	$cb->($self, "accept", $major, $minor);
		1920	} else {
		1921	# mismatch == guaranteed not TLS
		1922	$cb->($self, undef);
		1923	}
		1924
		1925	1
		1926	}
		1927	};
		1928
		1929	register_read_type tls_autostart => sub {
		1930	my ($self, @tls) = @_;
		1931
		1932	$RH{tls_detect}($self, sub {
		1933	return unless $_[1];
		1934	$_[0]->starttls (@tls);
		1935	})
1707	};	1936	};
1708		1937
1709	=back	1938	=back
1710		1939
1711	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1940	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1743	Note that AnyEvent::Handle will automatically C<start_read> for you when	1972	Note that AnyEvent::Handle will automatically C<start_read> for you when
1744	you change the C<on_read> callback or push/unshift a read callback, and it	1973	you change the C<on_read> callback or push/unshift a read callback, and it
1745	will automatically C<stop_read> for you when neither C<on_read> is set nor	1974	will automatically C<stop_read> for you when neither C<on_read> is set nor
1746	there are any read requests in the queue.	1975	there are any read requests in the queue.
1747		1976
1748	These methods will have no effect when in TLS mode (as TLS doesn't support	1977	In older versions of this module (<= 5.3), these methods had no effect,
1749	half-duplex connections).	1978	as TLS does not support half-duplex connections. In current versions they
		1979	work as expected, as this behaviour is required to avoid certain resource
		1980	attacks, where the program would be forced to read (and buffer) arbitrary
		1981	amounts of data before being able to send some data. The drawback is that
		1982	some readings of the the SSL/TLS specifications basically require this
		1983	attack to be working, as SSL/TLS implementations might stall sending data
		1984	during a rehandshake.
		1985
		1986	As a guideline, during the initial handshake, you should not stop reading,
		1987	and as a client, it might cause problems, depending on your application.
1750		1988
1751	=cut	1989	=cut
1752		1990
1753	sub stop_read {	1991	sub stop_read {
1754	my ($self) = @_;	1992	my ($self) = @_;
1755		1993
1756	delete $self->{_rw} unless $self->{tls};	1994	delete $self->{_rw};
1757	}	1995	}
1758		1996
1759	sub start_read {	1997	sub start_read {
1760	my ($self) = @_;	1998	my ($self) = @_;
1761		1999
…		…
1786	} elsif (defined $len) {	2024	} elsif (defined $len) {
1787	delete $self->{_rw};	2025	delete $self->{_rw};
1788	$self->{_eof} = 1;	2026	$self->{_eof} = 1;
1789	$self->_drain_rbuf;	2027	$self->_drain_rbuf;
1790		2028
1791	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2029	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1792	return $self->_error ($!, 1);	2030	return $self->_error ($!, 1);
1793	}	2031	}
1794	};	2032	};
1795	}	2033	}
1796	}	2034	}
…		…
1802	my ($self, $err) = @_;	2040	my ($self, $err) = @_;
1803		2041
1804	return $self->_error ($!, 1)	2042	return $self->_error ($!, 1)
1805	if $err == Net::SSLeay::ERROR_SYSCALL ();	2043	if $err == Net::SSLeay::ERROR_SYSCALL ();
1806		2044
1807	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2045	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1808		2046
1809	# reduce error string to look less scary	2047	# reduce error string to look less scary
1810	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2048	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1811		2049
1812	if ($self->{_on_starttls}) {	2050	if ($self->{_on_starttls}) {
…		…
1826	sub _dotls {	2064	sub _dotls {
1827	my ($self) = @_;	2065	my ($self) = @_;
1828		2066
1829	my $tmp;	2067	my $tmp;
1830		2068
1831	if (length $self->{_tls_wbuf}) {	2069	while (length $self->{_tls_wbuf}) {
1832	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2070	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1833	substr $self->{_tls_wbuf}, 0, $tmp, "";	2071	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2072
		2073	return $self->_tls_error ($tmp)
		2074	if $tmp != $ERROR_WANT_READ
		2075	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		2076
		2077	last;
1834	}	2078	}
1835		2079
1836	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2080	substr $self->{_tls_wbuf}, 0, $tmp, "";
1837	return $self->_tls_error ($tmp)
1838	if $tmp != $ERROR_WANT_READ
1839	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1840	}	2081	}
1841		2082
1842	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2083	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1843	unless (length $tmp) {	2084	unless (length $tmp) {
1844	$self->{_on_starttls}	2085	$self->{_on_starttls}
…		…
1858	$self->{_tls_rbuf} .= $tmp;	2099	$self->{_tls_rbuf} .= $tmp;
1859	$self->_drain_rbuf;	2100	$self->_drain_rbuf;
1860	$self->{tls} or return; # tls session might have gone away in callback	2101	$self->{tls} or return; # tls session might have gone away in callback
1861	}	2102	}
1862		2103
1863	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	2104	$tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us
1864	return $self->_tls_error ($tmp)	2105	return $self->_tls_error ($tmp)
1865	if $tmp != $ERROR_WANT_READ	2106	if $tmp != $ERROR_WANT_READ
1866	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2107	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1867		2108
1868	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2109	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1878		2119
1879	=item $handle->starttls ($tls[, $tls_ctx])	2120	=item $handle->starttls ($tls[, $tls_ctx])
1880		2121
1881	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2122	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1882	object is created, you can also do that at a later time by calling	2123	object is created, you can also do that at a later time by calling
1883	C<starttls>.	2124	C<starttls>. See the C<tls> constructor argument for general info.
1884		2125
1885	Starting TLS is currently an asynchronous operation - when you push some	2126	Starting TLS is currently an asynchronous operation - when you push some
1886	write data and then call C<< ->starttls >> then TLS negotiation will start	2127	write data and then call C<< ->starttls >> then TLS negotiation will start
1887	immediately, after which the queued write data is then sent.	2128	immediately, after which the queued write data is then sent. This might
		2129	change in future versions, so best make sure you have no outstanding write
		2130	data when calling this method.
1888		2131
1889	The first argument is the same as the C<tls> constructor argument (either	2132	The first argument is the same as the C<tls> constructor argument (either
1890	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2133	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1891		2134
1892	The second argument is the optional C<AnyEvent::TLS> object that is used	2135	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1914	my ($self, $tls, $ctx) = @_;	2157	my ($self, $tls, $ctx) = @_;
1915		2158
1916	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2159	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1917	if $self->{tls};	2160	if $self->{tls};
1918		2161
		2162	unless (defined $AnyEvent::TLS::VERSION) {
		2163	eval {
		2164	require Net::SSLeay;
		2165	require AnyEvent::TLS;
		2166	1
		2167	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2168	}
		2169
1919	$self->{tls} = $tls;	2170	$self->{tls} = $tls;
1920	$self->{tls_ctx} = $ctx if @_ > 2;	2171	$self->{tls_ctx} = $ctx if @_ > 2;
1921		2172
1922	return unless $self->{fh};	2173	return unless $self->{fh};
1923		2174
1924	require Net::SSLeay;
1925
1926	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2175	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1927	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2176	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1928		2177
1929	$tls = delete $self->{tls};	2178	$tls = delete $self->{tls};
1930	$ctx = $self->{tls_ctx};	2179	$ctx = $self->{tls_ctx};
1931		2180
1932	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2181	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1933		2182
1934	if ("HASH" eq ref $ctx) {	2183	if ("HASH" eq ref $ctx) {
1935	require AnyEvent::TLS;
1936
1937	if ($ctx->{cache}) {	2184	if ($ctx->{cache}) {
1938	my $key = $ctx+0;	2185	my $key = $ctx+0;
1939	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2186	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1940	} else {	2187	} else {
1941	$ctx = new AnyEvent::TLS %$ctx;	2188	$ctx = new AnyEvent::TLS %$ctx;
…		…
1946	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});	2193	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1947		2194
1948	# basically, this is deep magic (because SSL_read should have the same issues)	2195	# basically, this is deep magic (because SSL_read should have the same issues)
1949	# but the openssl maintainers basically said: "trust us, it just works".	2196	# but the openssl maintainers basically said: "trust us, it just works".
1950	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2197	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1951	# and mismaintained ssleay-module doesn't even offer them).	2198	# and mismaintained ssleay-module didn't offer them for a decade or so).
1952	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2199	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1953	#	2200	#
1954	# in short: this is a mess.	2201	# in short: this is a mess.
1955	#	2202	#
1956	# note that we do not try to keep the length constant between writes as we are required to do.	2203	# note that we do not try to keep the length constant between writes as we are required to do.
1957	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	2204	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1958	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	2205	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1959	# have identity issues in that area.	2206	# have identity issues in that area.
1960	# Net::SSLeay::CTX_set_mode ($ssl,	2207	# Net::SSLeay::set_mode ($ssl,
1961	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	2208	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1962	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	2209	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1963	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2210	Net::SSLeay::set_mode ($tls, 1\|2);
1964		2211
1965	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2212	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1966	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2213	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1967		2214
1968	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2215	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2216	$self->{rbuf} = "";
1969		2217
1970	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2218	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1971		2219
1972	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2220	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1973	if $self->{on_starttls};	2221	if $self->{on_starttls};
…		…
2011	if $self->{tls} > 0;	2259	if $self->{tls} > 0;
2012		2260
2013	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2261	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2014	}	2262	}
2015		2263
		2264	=item $handle->resettls
		2265
		2266	This rarely-used method simply resets and TLS state on the handle, usually
		2267	causing data loss.
		2268
		2269	One case where it may be useful is when you want to skip over the data in
		2270	the stream but you are not interested in interpreting it, so data loss is
		2271	no concern.
		2272
		2273	=cut
		2274
		2275	*resettls = \&_freetls;
		2276
2016	sub DESTROY {	2277	sub DESTROY {
2017	my ($self) = @_;	2278	my ($self) = @_;
2018		2279
2019	&_freetls;	2280	&_freetls;
2020		2281
…		…
2029	push @linger, AE::io $fh, 1, sub {	2290	push @linger, AE::io $fh, 1, sub {
2030	my $len = syswrite $fh, $wbuf, length $wbuf;	2291	my $len = syswrite $fh, $wbuf, length $wbuf;
2031		2292
2032	if ($len > 0) {	2293	if ($len > 0) {
2033	substr $wbuf, 0, $len, "";	2294	substr $wbuf, 0, $len, "";
2034	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2295	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2035	@linger = (); # end	2296	@linger = (); # end
2036	}	2297	}
2037	};	2298	};
2038	push @linger, AE::timer $linger, 0, sub {	2299	push @linger, AE::timer $linger, 0, sub {
2039	@linger = ();	2300	@linger = ();
…		…
2135		2396
2136	It is only safe to "forget" the reference inside EOF or error callbacks,	2397	It is only safe to "forget" the reference inside EOF or error callbacks,
2137	from within all other callbacks, you need to explicitly call the C<<	2398	from within all other callbacks, you need to explicitly call the C<<
2138	->destroy >> method.	2399	->destroy >> method.
2139		2400
		2401	=item Why is my C<on_eof> callback never called?
		2402
		2403	Probably because your C<on_error> callback is being called instead: When
		2404	you have outstanding requests in your read queue, then an EOF is
		2405	considered an error as you clearly expected some data.
		2406
		2407	To avoid this, make sure you have an empty read queue whenever your handle
		2408	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2409	an C<on_read> handler that simply pushes the first read requests in the
		2410	queue.
		2411
		2412	See also the next question, which explains this in a bit more detail.
		2413
		2414	=item How can I serve requests in a loop?
		2415
		2416	Most protocols consist of some setup phase (authentication for example)
		2417	followed by a request handling phase, where the server waits for requests
		2418	and handles them, in a loop.
		2419
		2420	There are two important variants: The first (traditional, better) variant
		2421	handles requests until the server gets some QUIT command, causing it to
		2422	close the connection first (highly desirable for a busy TCP server). A
		2423	client dropping the connection is an error, which means this variant can
		2424	detect an unexpected detection close.
		2425
		2426	To handle this case, always make sure you have a non-empty read queue, by
		2427	pushing the "read request start" handler on it:
		2428
		2429	# we assume a request starts with a single line
		2430	my @start_request; @start_request = (line => sub {
		2431	my ($hdl, $line) = @_;
		2432
		2433	... handle request
		2434
		2435	# push next request read, possibly from a nested callback
		2436	$hdl->push_read (@start_request);
		2437	});
		2438
		2439	# auth done, now go into request handling loop
		2440	# now push the first @start_request
		2441	$hdl->push_read (@start_request);
		2442
		2443	By always having an outstanding C<push_read>, the handle always expects
		2444	some data and raises the C<EPIPE> error when the connction is dropped
		2445	unexpectedly.
		2446
		2447	The second variant is a protocol where the client can drop the connection
		2448	at any time. For TCP, this means that the server machine may run out of
		2449	sockets easier, and in general, it means you cannot distinguish a protocl
		2450	failure/client crash from a normal connection close. Nevertheless, these
		2451	kinds of protocols are common (and sometimes even the best solution to the
		2452	problem).
		2453
		2454	Having an outstanding read request at all times is possible if you ignore
		2455	C<EPIPE> errors, but this doesn't help with when the client drops the
		2456	connection during a request, which would still be an error.
		2457
		2458	A better solution is to push the initial request read in an C<on_read>
		2459	callback. This avoids an error, as when the server doesn't expect data
		2460	(i.e. is idly waiting for the next request, an EOF will not raise an
		2461	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2462	and simpler:
		2463
		2464	# auth done, now go into request handling loop
		2465	$hdl->on_read (sub {
		2466	my ($hdl) = @_;
		2467
		2468	# called each time we receive data but the read queue is empty
		2469	# simply start read the request
		2470
		2471	$hdl->push_read (line => sub {
		2472	my ($hdl, $line) = @_;
		2473
		2474	... handle request
		2475
		2476	# do nothing special when the request has been handled, just
		2477	# let the request queue go empty.
		2478	});
		2479	});
		2480
2140	=item I get different callback invocations in TLS mode/Why can't I pause	2481	=item I get different callback invocations in TLS mode/Why can't I pause
2141	reading?	2482	reading?
2142		2483
2143	Unlike, say, TCP, TLS connections do not consist of two independent	2484	Unlike, say, TCP, TLS connections do not consist of two independent
2144	communication channels, one for each direction. Or put differently, the	2485	communication channels, one for each direction. Or put differently, the
…		…
2165	$handle->on_eof (undef);	2506	$handle->on_eof (undef);
2166	$handle->on_error (sub {	2507	$handle->on_error (sub {
2167	my $data = delete $_[0]{rbuf};	2508	my $data = delete $_[0]{rbuf};
2168	});	2509	});
2169		2510
		2511	Note that this example removes the C<rbuf> member from the handle object,
		2512	which is not normally allowed by the API. It is expressly permitted in
		2513	this case only, as the handle object needs to be destroyed afterwards.
		2514
2170	The reason to use C<on_error> is that TCP connections, due to latencies	2515	The reason to use C<on_error> is that TCP connections, due to latencies
2171	and packets loss, might get closed quite violently with an error, when in	2516	and packets loss, might get closed quite violently with an error, when in
2172	fact all data has been received.	2517	fact all data has been received.
2173		2518
2174	It is usually better to use acknowledgements when transferring data,	2519	It is usually better to use acknowledgements when transferring data,
…		…
2184	C<low_water_mark> this will be called precisely when all data has been	2529	C<low_water_mark> this will be called precisely when all data has been
2185	written to the socket:	2530	written to the socket:
2186		2531
2187	$handle->push_write (...);	2532	$handle->push_write (...);
2188	$handle->on_drain (sub {	2533	$handle->on_drain (sub {
2189	warn "all data submitted to the kernel\n";	2534	AE::log debug => "All data submitted to the kernel.";
2190	undef $handle;	2535	undef $handle;
2191	});	2536	});
2192		2537
2193	If you just want to queue some data and then signal EOF to the other side,	2538	If you just want to queue some data and then signal EOF to the other side,
2194	consider using C<< ->push_shutdown >> instead.	2539	consider using C<< ->push_shutdown >> instead.
…		…
2278	When you have intermediate CA certificates that your clients might not	2623	When you have intermediate CA certificates that your clients might not
2279	know about, just append them to the C<cert_file>.	2624	know about, just append them to the C<cert_file>.
2280		2625
2281	=back	2626	=back
2282		2627
2283
2284	=head1 SUBCLASSING AnyEvent::Handle	2628	=head1 SUBCLASSING AnyEvent::Handle
2285		2629
2286	In many cases, you might want to subclass AnyEvent::Handle.	2630	In many cases, you might want to subclass AnyEvent::Handle.
2287		2631
2288	To make this easier, a given version of AnyEvent::Handle uses these	2632	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2314		2658
2315	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2659	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2316		2660
2317	=cut	2661	=cut
2318		2662
2319	1; # End of AnyEvent::Handle	2663	1
		2664

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.207 by root, Mon Nov 15 22:29:36 2010 UTC vs. Revision 1.250 by root, Tue Feb 26 01:35:48 2019 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.207 by root, Mon Nov 15 22:29:36 2010 UTC vs.
Revision 1.250 by root, Tue Feb 26 01:35:48 2019 UTC