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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.202 by root, Sat Oct 16 02:01:54 2010 UTC vs. Revision 1.241 by root, Fri Sep 5 22:17:26 2014 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.202 by root, Sat Oct 16 02:01:54 2010 UTC vs.
Revision 1.241 by root, Fri Sep 5 22:17:26 2014 UTC