[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.237 by root, Tue Jul 30 23:14:32 2013 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
…		…
492	$self->{connect}[0],	537	$self->{connect}[0],
493	$self->{connect}[1],	538	$self->{connect}[1],
494	sub {	539	sub {
495	my ($fh, $host, $port, $retry) = @_;	540	my ($fh, $host, $port, $retry) = @_;
496		541
		542	delete $self->{_connect}; # no longer needed
		543
497	if ($fh) {	544	if ($fh) {
498	$self->{fh} = $fh;	545	$self->{fh} = $fh;
499		546
500	delete $self->{_skip_drain_rbuf};	547	delete $self->{_skip_drain_rbuf};
501	$self->_start;	548	$self->_start;
…		…
508	});	555	});
509		556
510	} else {	557	} else {
511	if ($self->{on_connect_error}) {	558	if ($self->{on_connect_error}) {
512	$self->{on_connect_error}($self, "$!");	559	$self->{on_connect_error}($self, "$!");
513	$self->destroy;	560	$self->destroy if $self;
514	} else {	561	} else {
515	$self->_error ($!, 1);	562	$self->_error ($!, 1);
516	}	563	}
517	}	564	}
518	},	565	},
519	sub {	566	sub {
520	local $self->{fh} = $_[0];	567	local $self->{fh} = $_[0];
521		568
522	$self->{on_prepare}	569	$self->{on_prepare}
523	? $self->{on_prepare}->($self)	570	? $self->{on_prepare}->($self)
524	: ()	571	: ()
525	}	572	}
526	);	573	);
527	}	574	}
528		575
…		…
545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	592	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
546		593
547	$self->{_activity} =	594	$self->{_activity} =
548	$self->{_ractivity} =	595	$self->{_ractivity} =
549	$self->{_wactivity} = AE::now;	596	$self->{_wactivity} = AE::now;
		597
		598	$self->{read_size} \|\|= 2048;
		599	$self->{max_read_size} = $self->{read_size}
		600	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
550		601
551	$self->timeout (delete $self->{timeout} ) if $self->{timeout};	602	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
552	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};	603	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
553	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};	604	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
554		605
…		…
723		774
724	=item $handle->rbuf_max ($max_octets)	775	=item $handle->rbuf_max ($max_octets)
725		776
726	Configures the C<rbuf_max> setting (C<undef> disables it).	777	Configures the C<rbuf_max> setting (C<undef> disables it).
727		778
		779	=item $handle->wbuf_max ($max_octets)
		780
		781	Configures the C<wbuf_max> setting (C<undef> disables it).
		782
728	=cut	783	=cut
729		784
730	sub rbuf_max {	785	sub rbuf_max {
731	$_[0]{rbuf_max} = $_[1];	786	$_[0]{rbuf_max} = $_[1];
732	}	787	}
733		788
		789	sub wbuf_max {
		790	$_[0]{wbuf_max} = $_[1];
		791	}
		792
734	#############################################################################	793	#############################################################################
735		794
736	=item $handle->timeout ($seconds)	795	=item $handle->timeout ($seconds)
737		796
738	=item $handle->rtimeout ($seconds)	797	=item $handle->rtimeout ($seconds)
739		798
740	=item $handle->wtimeout ($seconds)	799	=item $handle->wtimeout ($seconds)
741		800
742	Configures (or disables) the inactivity timeout.	801	Configures (or disables) the inactivity timeout.
		802
		803	The timeout will be checked instantly, so this method might destroy the
		804	handle before it returns.
743		805
744	=item $handle->timeout_reset	806	=item $handle->timeout_reset
745		807
746	=item $handle->rtimeout_reset	808	=item $handle->rtimeout_reset
747		809
…		…
831		893
832	The write queue is very simple: you can add data to its end, and	894	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.	895	AnyEvent::Handle will automatically try to get rid of it for you.
834		896
835	When data could be written and the write buffer is shorter then the low	897	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.	898	water mark, the C<on_drain> callback will be invoked once.
837		899
838	=over 4	900	=over 4
839		901
840	=item $handle->on_drain ($cb)	902	=item $handle->on_drain ($cb)
841		903
…		…
856	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	918	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
857	}	919	}
858		920
859	=item $handle->push_write ($data)	921	=item $handle->push_write ($data)
860		922
861	Queues the given scalar to be written. You can push as much data as you	923	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>	924	you want (only limited by the available memory and C<wbuf_max>), as
863	buffers it independently of the kernel.	925	C<AnyEvent::Handle> buffers it independently of the kernel.
864		926
865	This method may invoke callbacks (and therefore the handle might be	927	This method may invoke callbacks (and therefore the handle might be
866	destroyed after it returns).	928	destroyed after it returns).
867		929
868	=cut	930	=cut
…		…
896	$cb->() unless $self->{autocork};	958	$cb->() unless $self->{autocork};
897		959
898	# if still data left in wbuf, we need to poll	960	# if still data left in wbuf, we need to poll
899	$self->{_ww} = AE::io $self->{fh}, 1, $cb	961	$self->{_ww} = AE::io $self->{fh}, 1, $cb
900	if length $self->{wbuf};	962	if length $self->{wbuf};
		963
		964	if (
		965	defined $self->{wbuf_max}
		966	&& $self->{wbuf_max} < length $self->{wbuf}
		967	) {
		968	$self->_error (Errno::ENOSPC, 1), return;
		969	}
901	};	970	};
902	}	971	}
903		972
904	our %WH;	973	our %WH;
905		974
…		…
1025	=cut	1094	=cut
1026		1095
1027	register_write_type storable => sub {	1096	register_write_type storable => sub {
1028	my ($self, $ref) = @_;	1097	my ($self, $ref) = @_;
1029		1098
1030	require Storable;	1099	require Storable unless $Storable::VERSION;
1031		1100
1032	pack "w/a*", Storable::nfreeze ($ref)	1101	pack "w/a*", Storable::nfreeze ($ref)
1033	};	1102	};
1034		1103
1035	=back	1104	=back
…		…
1040	before it was actually written. One way to do that is to replace your	1109	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	1110	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	1111	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1043	replaces the C<on_drain> callback with:	1112	replaces the C<on_drain> callback with:
1044		1113
1045	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1114	sub { shutdown $_[0]{fh}, 1 }
1046		1115
1047	This simply shuts down the write side and signals an EOF condition to the	1116	This simply shuts down the write side and signals an EOF condition to the
1048	the peer.	1117	the peer.
1049		1118
1050	You can rely on the normal read queue and C<on_eof> handling	1119	You can rely on the normal read queue and C<on_eof> handling
…		…
1072		1141
1073	Whenever the given C<type> is used, C<push_write> will the function with	1142	Whenever the given C<type> is used, C<push_write> will the function with
1074	the handle object and the remaining arguments.	1143	the handle object and the remaining arguments.
1075		1144
1076	The function is supposed to return a single octet string that will be	1145	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	1146	appended to the write buffer, so you can mentally treat this function as a
1078	"arguments to on-the-wire-format" converter.	1147	"arguments to on-the-wire-format" converter.
1079		1148
1080	Example: implement a custom write type C<join> that joins the remaining	1149	Example: implement a custom write type C<join> that joins the remaining
1081	arguments using the first one.	1150	arguments using the first one.
1082		1151
…		…
1376	data.	1445	data.
1377		1446
1378	Example: read 2 bytes.	1447	Example: read 2 bytes.
1379		1448
1380	$handle->push_read (chunk => 2, sub {	1449	$handle->push_read (chunk => 2, sub {
1381	warn "yay ", unpack "H*", $_[1];	1450	say "yay " . unpack "H*", $_[1];
1382	});	1451	});
1383		1452
1384	=cut	1453	=cut
1385		1454
1386	register_read_type chunk => sub {	1455	register_read_type chunk => sub {
…		…
1416		1485
1417	register_read_type line => sub {	1486	register_read_type line => sub {
1418	my ($self, $cb, $eol) = @_;	1487	my ($self, $cb, $eol) = @_;
1419		1488
1420	if (@_ < 3) {	1489	if (@_ < 3) {
1421	# this is more than twice as fast as the generic code below	1490	# this is faster then the generic code below
1422	sub {	1491	sub {
1423	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1492	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1493	or return;
1424		1494
		1495	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1425	$cb->($_[0], $1, $2);	1496	$cb->($_[0], $str, "$1");
1426	1	1497	1
1427	}	1498	}
1428	} else {	1499	} else {
1429	$eol = quotemeta $eol unless ref $eol;	1500	$eol = quotemeta $eol unless ref $eol;
1430	$eol = qr\|^(.*?)($eol)\|s;	1501	$eol = qr\|^(.*?)($eol)\|s;
1431		1502
1432	sub {	1503	sub {
1433	$_[0]{rbuf} =~ s/$eol// or return;	1504	$_[0]{rbuf} =~ s/$eol// or return;
1434		1505
1435	$cb->($_[0], $1, $2);	1506	$cb->($_[0], "$1", "$2");
1436	1	1507	1
1437	}	1508	}
1438	}	1509	}
1439	};	1510	};
1440		1511
…		…
1488		1559
1489	sub {	1560	sub {
1490	# accept	1561	# accept
1491	if ($$rbuf =~ $accept) {	1562	if ($$rbuf =~ $accept) {
1492	$data .= substr $$rbuf, 0, $+[0], "";	1563	$data .= substr $$rbuf, 0, $+[0], "";
1493	$cb->($self, $data);	1564	$cb->($_[0], $data);
1494	return 1;	1565	return 1;
1495	}	1566	}
1496		1567
1497	# reject	1568	# reject
1498	if ($reject && $$rbuf =~ $reject) {	1569	if ($reject && $$rbuf =~ $reject) {
1499	$self->_error (Errno::EBADMSG);	1570	$_[0]->_error (Errno::EBADMSG);
1500	}	1571	}
1501		1572
1502	# skip	1573	# skip
1503	if ($skip && $$rbuf =~ $skip) {	1574	if ($skip && $$rbuf =~ $skip) {
1504	$data .= substr $$rbuf, 0, $+[0], "";	1575	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1520	my ($self, $cb) = @_;	1591	my ($self, $cb) = @_;
1521		1592
1522	sub {	1593	sub {
1523	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1594	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1524	if ($_[0]{rbuf} =~ /[^0-9]/) {	1595	if ($_[0]{rbuf} =~ /[^0-9]/) {
1525	$self->_error (Errno::EBADMSG);	1596	$_[0]->_error (Errno::EBADMSG);
1526	}	1597	}
1527	return;	1598	return;
1528	}	1599	}
1529		1600
1530	my $len = $1;	1601	my $len = $1;
1531		1602
1532	$self->unshift_read (chunk => $len, sub {	1603	$_[0]->unshift_read (chunk => $len, sub {
1533	my $string = $_[1];	1604	my $string = $_[1];
1534	$_[0]->unshift_read (chunk => 1, sub {	1605	$_[0]->unshift_read (chunk => 1, sub {
1535	if ($_[1] eq ",") {	1606	if ($_[1] eq ",") {
1536	$cb->($_[0], $string);	1607	$cb->($_[0], $string);
1537	} else {	1608	} else {
1538	$self->_error (Errno::EBADMSG);	1609	$_[0]->_error (Errno::EBADMSG);
1539	}	1610	}
1540	});	1611	});
1541	});	1612	});
1542		1613
1543	1	1614	1
…		…
1616		1687
1617	my $data;	1688	my $data;
1618	my $rbuf = \$self->{rbuf};	1689	my $rbuf = \$self->{rbuf};
1619		1690
1620	sub {	1691	sub {
1621	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1692	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1622		1693
1623	if ($ref) {	1694	if ($ref) {
1624	$self->{rbuf} = $json->incr_text;	1695	$_[0]{rbuf} = $json->incr_text;
1625	$json->incr_text = "";	1696	$json->incr_text = "";
1626	$cb->($self, $ref);	1697	$cb->($_[0], $ref);
1627		1698
1628	1	1699	1
1629	} elsif ($@) {	1700	} elsif ($@) {
1630	# error case	1701	# error case
1631	$json->incr_skip;	1702	$json->incr_skip;
1632		1703
1633	$self->{rbuf} = $json->incr_text;	1704	$_[0]{rbuf} = $json->incr_text;
1634	$json->incr_text = "";	1705	$json->incr_text = "";
1635		1706
1636	$self->_error (Errno::EBADMSG);	1707	$_[0]->_error (Errno::EBADMSG);
1637		1708
1638	()	1709	()
1639	} else {	1710	} else {
1640	$self->{rbuf} = "";	1711	$_[0]{rbuf} = "";
1641		1712
1642	()	1713	()
1643	}	1714	}
1644	}	1715	}
1645	};	1716	};
…		…
1655	=cut	1726	=cut
1656		1727
1657	register_read_type storable => sub {	1728	register_read_type storable => sub {
1658	my ($self, $cb) = @_;	1729	my ($self, $cb) = @_;
1659		1730
1660	require Storable;	1731	require Storable unless $Storable::VERSION;
1661		1732
1662	sub {	1733	sub {
1663	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1734	# 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} })	1735	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1665	or return;	1736	or return;
…		…
1668		1739
1669	# bypass unshift if we already have the remaining chunk	1740	# bypass unshift if we already have the remaining chunk
1670	if ($format + $len <= length $_[0]{rbuf}) {	1741	if ($format + $len <= length $_[0]{rbuf}) {
1671	my $data = substr $_[0]{rbuf}, $format, $len;	1742	my $data = substr $_[0]{rbuf}, $format, $len;
1672	substr $_[0]{rbuf}, 0, $format + $len, "";	1743	substr $_[0]{rbuf}, 0, $format + $len, "";
		1744
1673	$cb->($_[0], Storable::thaw ($data));	1745	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1746	or return $_[0]->_error (Errno::EBADMSG);
1674	} else {	1747	} else {
1675	# remove prefix	1748	# remove prefix
1676	substr $_[0]{rbuf}, 0, $format, "";	1749	substr $_[0]{rbuf}, 0, $format, "";
1677		1750
1678	# read remaining chunk	1751	# read remaining chunk
1679	$_[0]->unshift_read (chunk => $len, sub {	1752	$_[0]->unshift_read (chunk => $len, sub {
1680	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1753	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1681	$cb->($_[0], $ref);
1682	} else {
1683	$self->_error (Errno::EBADMSG);	1754	or $_[0]->_error (Errno::EBADMSG);
1684	}
1685	});	1755	});
1686	}	1756	}
1687		1757
1688	1	1758	1
1689	}	1759	}
		1760	};
		1761
		1762	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1763
		1764	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1765	record without consuming anything. Only SSL version 3 or higher
		1766	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1767	SSL2-compatible framing is supported).
		1768
		1769	If it detects that the input data is likely TLS, it calls the callback
		1770	with a true value for C<$detect> and the (on-wire) TLS version as second
		1771	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1772	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1773	be definitely not TLS, it calls the callback with a false value for
		1774	C<$detect>.
		1775
		1776	The callback could use this information to decide whether or not to start
		1777	TLS negotiation.
		1778
		1779	In all cases the data read so far is passed to the following read
		1780	handlers.
		1781
		1782	Usually you want to use the C<tls_autostart> read type instead.
		1783
		1784	If you want to design a protocol that works in the presence of TLS
		1785	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1786	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1787	read type does are a bit more strict, but might losen in the future to
		1788	accomodate protocol changes.
		1789
		1790	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1791	L<Net::SSLeay>).
		1792
		1793	=item tls_autostart => $tls[, $tls_ctx]
		1794
		1795	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1796	to start tls by calling C<starttls> with the given arguments.
		1797
		1798	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1799	been configured to accept, as servers do not normally send a handshake on
		1800	their own and ths cannot be detected in this way.
		1801
		1802	See C<tls_detect> above for more details.
		1803
		1804	Example: give the client a chance to start TLS before accepting a text
		1805	line.
		1806
		1807	$hdl->push_read (tls_detect => "accept");
		1808	$hdl->push_read (line => sub {
		1809	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1810	});
		1811
		1812	=cut
		1813
		1814	register_read_type tls_detect => sub {
		1815	my ($self, $cb) = @_;
		1816
		1817	sub {
		1818	# this regex matches a full or partial tls record
		1819	if (
		1820	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1821	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1822	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1823	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1824	) {
		1825	return if 3 != length $1; # partial match, can't decide yet
		1826
		1827	# full match, valid TLS record
		1828	my ($major, $minor) = unpack "CC", $1;
		1829	$cb->($self, "accept", $major + $minor * 0.1);
		1830	} else {
		1831	# mismatch == guaranteed not TLS
		1832	$cb->($self, undef);
		1833	}
		1834
		1835	1
		1836	}
		1837	};
		1838
		1839	register_read_type tls_autostart => sub {
		1840	my ($self, @tls) = @_;
		1841
		1842	$RH{tls_detect}($self, sub {
		1843	return unless $_[1];
		1844	$_[0]->starttls (@tls);
		1845	})
1690	};	1846	};
1691		1847
1692	=back	1848	=back
1693		1849
1694	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1850	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1726	Note that AnyEvent::Handle will automatically C<start_read> for you when	1882	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	1883	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	1884	will automatically C<stop_read> for you when neither C<on_read> is set nor
1729	there are any read requests in the queue.	1885	there are any read requests in the queue.
1730		1886
1731	These methods will have no effect when in TLS mode (as TLS doesn't support	1887	In older versions of this module (<= 5.3), these methods had no effect,
1732	half-duplex connections).	1888	as TLS does not support half-duplex connections. In current versions they
		1889	work as expected, as this behaviour is required to avoid certain resource
		1890	attacks, where the program would be forced to read (and buffer) arbitrary
		1891	amounts of data before being able to send some data. The drawback is that
		1892	some readings of the the SSL/TLS specifications basically require this
		1893	attack to be working, as SSL/TLS implementations might stall sending data
		1894	during a rehandshake.
		1895
		1896	As a guideline, during the initial handshake, you should not stop reading,
		1897	and as a client, it might cause problems, depending on your application.
1733		1898
1734	=cut	1899	=cut
1735		1900
1736	sub stop_read {	1901	sub stop_read {
1737	my ($self) = @_;	1902	my ($self) = @_;
1738		1903
1739	delete $self->{_rw} unless $self->{tls};	1904	delete $self->{_rw};
1740	}	1905	}
1741		1906
1742	sub start_read {	1907	sub start_read {
1743	my ($self) = @_;	1908	my ($self) = @_;
1744		1909
1745	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {	1910	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1746	Scalar::Util::weaken $self;	1911	Scalar::Util::weaken $self;
1747		1912
1748	$self->{_rw} = AE::io $self->{fh}, 0, sub {	1913	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1749	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1914	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1750	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1915	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1751		1916
1752	if ($len > 0) {	1917	if ($len > 0) {
1753	$self->{_activity} = $self->{_ractivity} = AE::now;	1918	$self->{_activity} = $self->{_ractivity} = AE::now;
1754		1919
1755	if ($self->{tls}) {	1920	if ($self->{tls}) {
…		…
1758	&_dotls ($self);	1923	&_dotls ($self);
1759	} else {	1924	} else {
1760	$self->_drain_rbuf;	1925	$self->_drain_rbuf;
1761	}	1926	}
1762		1927
		1928	if ($len == $self->{read_size}) {
		1929	$self->{read_size} *= 2;
		1930	$self->{read_size} = $self->{max_read_size} \|\| MAX_READ_SIZE
		1931	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		1932	}
		1933
1763	} elsif (defined $len) {	1934	} elsif (defined $len) {
1764	delete $self->{_rw};	1935	delete $self->{_rw};
1765	$self->{_eof} = 1;	1936	$self->{_eof} = 1;
1766	$self->_drain_rbuf;	1937	$self->_drain_rbuf;
1767		1938
…		…
1779	my ($self, $err) = @_;	1950	my ($self, $err) = @_;
1780		1951
1781	return $self->_error ($!, 1)	1952	return $self->_error ($!, 1)
1782	if $err == Net::SSLeay::ERROR_SYSCALL ();	1953	if $err == Net::SSLeay::ERROR_SYSCALL ();
1783		1954
1784	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1955	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1785		1956
1786	# reduce error string to look less scary	1957	# reduce error string to look less scary
1787	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1958	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1788		1959
1789	if ($self->{_on_starttls}) {	1960	if ($self->{_on_starttls}) {
…		…
1855		2026
1856	=item $handle->starttls ($tls[, $tls_ctx])	2027	=item $handle->starttls ($tls[, $tls_ctx])
1857		2028
1858	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2029	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	2030	object is created, you can also do that at a later time by calling
1860	C<starttls>.	2031	C<starttls>. See the C<tls> constructor argument for general info.
1861		2032
1862	Starting TLS is currently an asynchronous operation - when you push some	2033	Starting TLS is currently an asynchronous operation - when you push some
1863	write data and then call C<< ->starttls >> then TLS negotiation will start	2034	write data and then call C<< ->starttls >> then TLS negotiation will start
1864	immediately, after which the queued write data is then sent.	2035	immediately, after which the queued write data is then sent. This might
		2036	change in future versions, so best make sure you have no outstanding write
		2037	data when calling this method.
1865		2038
1866	The first argument is the same as the C<tls> constructor argument (either	2039	The first argument is the same as the C<tls> constructor argument (either
1867	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2040	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1868		2041
1869	The second argument is the optional C<AnyEvent::TLS> object that is used	2042	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1891	my ($self, $tls, $ctx) = @_;	2064	my ($self, $tls, $ctx) = @_;
1892		2065
1893	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2066	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1894	if $self->{tls};	2067	if $self->{tls};
1895		2068
		2069	unless (defined $AnyEvent::TLS::VERSION) {
		2070	eval {
		2071	require Net::SSLeay;
		2072	require AnyEvent::TLS;
		2073	1
		2074	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2075	}
		2076
1896	$self->{tls} = $tls;	2077	$self->{tls} = $tls;
1897	$self->{tls_ctx} = $ctx if @_ > 2;	2078	$self->{tls_ctx} = $ctx if @_ > 2;
1898		2079
1899	return unless $self->{fh};	2080	return unless $self->{fh};
1900		2081
1901	require Net::SSLeay;
1902
1903	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2082	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1904	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2083	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1905		2084
1906	$tls = delete $self->{tls};	2085	$tls = delete $self->{tls};
1907	$ctx = $self->{tls_ctx};	2086	$ctx = $self->{tls_ctx};
1908		2087
1909	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2088	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1910		2089
1911	if ("HASH" eq ref $ctx) {	2090	if ("HASH" eq ref $ctx) {
1912	require AnyEvent::TLS;
1913
1914	if ($ctx->{cache}) {	2091	if ($ctx->{cache}) {
1915	my $key = $ctx+0;	2092	my $key = $ctx+0;
1916	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2093	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1917	} else {	2094	} else {
1918	$ctx = new AnyEvent::TLS %$ctx;	2095	$ctx = new AnyEvent::TLS %$ctx;
…		…
1940	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2117	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1941		2118
1942	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2119	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1943	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2120	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1944		2121
1945	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2122	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2123	$self->{rbuf} = "";
1946		2124
1947	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2125	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1948		2126
1949	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2127	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1950	if $self->{on_starttls};	2128	if $self->{on_starttls};
…		…
1987	$self->{tls_ctx}->_put_session (delete $self->{tls})	2165	$self->{tls_ctx}->_put_session (delete $self->{tls})
1988	if $self->{tls} > 0;	2166	if $self->{tls} > 0;
1989		2167
1990	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2168	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1991	}	2169	}
		2170
		2171	=item $handle->resettls
		2172
		2173	This rarely-used method simply resets and TLS state on the handle, usually
		2174	causing data loss.
		2175
		2176	One case where it may be useful is when you want to skip over the data in
		2177	the stream but you are not interested in interpreting it, so data loss is
		2178	no concern.
		2179
		2180	=cut
		2181
		2182	*resettls = \&_freetls;
1992		2183
1993	sub DESTROY {	2184	sub DESTROY {
1994	my ($self) = @_;	2185	my ($self) = @_;
1995		2186
1996	&_freetls;	2187	&_freetls;
…		…
2112		2303
2113	It is only safe to "forget" the reference inside EOF or error callbacks,	2304	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<<	2305	from within all other callbacks, you need to explicitly call the C<<
2115	->destroy >> method.	2306	->destroy >> method.
2116		2307
		2308	=item Why is my C<on_eof> callback never called?
		2309
		2310	Probably because your C<on_error> callback is being called instead: When
		2311	you have outstanding requests in your read queue, then an EOF is
		2312	considered an error as you clearly expected some data.
		2313
		2314	To avoid this, make sure you have an empty read queue whenever your handle
		2315	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2316	an C<on_read> handler that simply pushes the first read requests in the
		2317	queue.
		2318
		2319	See also the next question, which explains this in a bit more detail.
		2320
		2321	=item How can I serve requests in a loop?
		2322
		2323	Most protocols consist of some setup phase (authentication for example)
		2324	followed by a request handling phase, where the server waits for requests
		2325	and handles them, in a loop.
		2326
		2327	There are two important variants: The first (traditional, better) variant
		2328	handles requests until the server gets some QUIT command, causing it to
		2329	close the connection first (highly desirable for a busy TCP server). A
		2330	client dropping the connection is an error, which means this variant can
		2331	detect an unexpected detection close.
		2332
		2333	To handle this case, always make sure you have a non-empty read queue, by
		2334	pushing the "read request start" handler on it:
		2335
		2336	# we assume a request starts with a single line
		2337	my @start_request; @start_request = (line => sub {
		2338	my ($hdl, $line) = @_;
		2339
		2340	... handle request
		2341
		2342	# push next request read, possibly from a nested callback
		2343	$hdl->push_read (@start_request);
		2344	});
		2345
		2346	# auth done, now go into request handling loop
		2347	# now push the first @start_request
		2348	$hdl->push_read (@start_request);
		2349
		2350	By always having an outstanding C<push_read>, the handle always expects
		2351	some data and raises the C<EPIPE> error when the connction is dropped
		2352	unexpectedly.
		2353
		2354	The second variant is a protocol where the client can drop the connection
		2355	at any time. For TCP, this means that the server machine may run out of
		2356	sockets easier, and in general, it means you cannot distinguish a protocl
		2357	failure/client crash from a normal connection close. Nevertheless, these
		2358	kinds of protocols are common (and sometimes even the best solution to the
		2359	problem).
		2360
		2361	Having an outstanding read request at all times is possible if you ignore
		2362	C<EPIPE> errors, but this doesn't help with when the client drops the
		2363	connection during a request, which would still be an error.
		2364
		2365	A better solution is to push the initial request read in an C<on_read>
		2366	callback. This avoids an error, as when the server doesn't expect data
		2367	(i.e. is idly waiting for the next request, an EOF will not raise an
		2368	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2369	and simpler:
		2370
		2371	# auth done, now go into request handling loop
		2372	$hdl->on_read (sub {
		2373	my ($hdl) = @_;
		2374
		2375	# called each time we receive data but the read queue is empty
		2376	# simply start read the request
		2377
		2378	$hdl->push_read (line => sub {
		2379	my ($hdl, $line) = @_;
		2380
		2381	... handle request
		2382
		2383	# do nothing special when the request has been handled, just
		2384	# let the request queue go empty.
		2385	});
		2386	});
		2387
2117	=item I get different callback invocations in TLS mode/Why can't I pause	2388	=item I get different callback invocations in TLS mode/Why can't I pause
2118	reading?	2389	reading?
2119		2390
2120	Unlike, say, TCP, TLS connections do not consist of two independent	2391	Unlike, say, TCP, TLS connections do not consist of two independent
2121	communication channels, one for each direction. Or put differently, the	2392	communication channels, one for each direction. Or put differently, the
…		…
2142	$handle->on_eof (undef);	2413	$handle->on_eof (undef);
2143	$handle->on_error (sub {	2414	$handle->on_error (sub {
2144	my $data = delete $_[0]{rbuf};	2415	my $data = delete $_[0]{rbuf};
2145	});	2416	});
2146		2417
		2418	Note that this example removes the C<rbuf> member from the handle object,
		2419	which is not normally allowed by the API. It is expressly permitted in
		2420	this case only, as the handle object needs to be destroyed afterwards.
		2421
2147	The reason to use C<on_error> is that TCP connections, due to latencies	2422	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	2423	and packets loss, might get closed quite violently with an error, when in
2149	fact all data has been received.	2424	fact all data has been received.
2150		2425
2151	It is usually better to use acknowledgements when transferring data,	2426	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	2436	C<low_water_mark> this will be called precisely when all data has been
2162	written to the socket:	2437	written to the socket:
2163		2438
2164	$handle->push_write (...);	2439	$handle->push_write (...);
2165	$handle->on_drain (sub {	2440	$handle->on_drain (sub {
2166	warn "all data submitted to the kernel\n";	2441	AE::log debug => "All data submitted to the kernel.";
2167	undef $handle;	2442	undef $handle;
2168	});	2443	});
2169		2444
2170	If you just want to queue some data and then signal EOF to the other side,	2445	If you just want to queue some data and then signal EOF to the other side,
2171	consider using C<< ->push_shutdown >> instead.	2446	consider using C<< ->push_shutdown >> instead.
…		…
2255	When you have intermediate CA certificates that your clients might not	2530	When you have intermediate CA certificates that your clients might not
2256	know about, just append them to the C<cert_file>.	2531	know about, just append them to the C<cert_file>.
2257		2532
2258	=back	2533	=back
2259		2534
2260
2261	=head1 SUBCLASSING AnyEvent::Handle	2535	=head1 SUBCLASSING AnyEvent::Handle
2262		2536
2263	In many cases, you might want to subclass AnyEvent::Handle.	2537	In many cases, you might want to subclass AnyEvent::Handle.
2264		2538
2265	To make this easier, a given version of AnyEvent::Handle uses these	2539	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2291		2565
2292	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2566	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2293		2567
2294	=cut	2568	=cut
2295		2569
2296	1; # End of AnyEvent::Handle	2570	1
		2571

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.237 by root, Tue Jul 30 23:14:32 2013 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.237 by root, Tue Jul 30 23:14:32 2013 UTC