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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.201 by root, Wed Oct 13 01:15:57 2010 UTC vs. Revision 1.245 by root, Tue Jun 16 03:22:20 2015 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.201 by root, Wed Oct 13 01:15:57 2010 UTC vs.
Revision 1.245 by root, Tue Jun 16 03:22:20 2015 UTC