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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.204 by root, Mon Nov 15 03:29:17 2010 UTC vs.
Revision 1.236 by root, Sat May 12 23:14:29 2012 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
…		…
114	=over 4	114	=over 4
115		115
116	=item on_prepare => $cb->($handle)	116	=item on_prepare => $cb->($handle)
117		117
118	This (rarely used) callback is called before a new connection is	118	This (rarely used) callback is called before a new connection is
119	attempted, but after the file handle has been created. It could be used to	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
120	prepare the file handle with parameters required for the actual connect	121	file handle with parameters required for the actual connect (as opposed to
121	(as opposed to settings that can be changed when the connection is already	122	settings that can be changed when the connection is already established).
122	established).
123		123
124	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
125	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
126	default timeout is to be used).	126	default timeout is to be used).
127		127
128	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
129		129
130	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
131		131
132	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
133	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.
134		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
135	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
136	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
137	hosts or SRV records there can be multiple connection endpoints). At the	142	SRV records there can be multiple connection endpoints). The C<$retry>
138	time it is called the read and write queues, eof status, tls status and	143	callback can be invoked after the connect callback returns, i.e. one can
139	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.
140		146
141	In most cases, you should ignore the C<$retry> parameter.	147	In most cases, you should ignore the C<$retry> parameter.
142		148
143	=item on_connect_error => $cb->($handle, $message)	149	=item on_connect_error => $cb->($handle, $message)
144		150
…		…
164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In	170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
165	cases where the other side can close the connection at will, it is	171	cases where the other side can close the connection at will, it is
166	often easiest to not report C<EPIPE> errors in this callback.	172	often easiest to not report C<EPIPE> errors in this callback.
167		173
168	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
169	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.
170	recommended to always output the C<$message> argument in human-readable	176
171	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>.
172		184
173	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
174	to simply ignore this parameter and instead abondon the handle object	186	to simply ignore this parameter and instead abondon the handle object
175	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
176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
224	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
225	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>.
226		238
227	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
228		240
229	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
230	(or immediately if the buffer is empty already).	242	empty (and immediately when the handle object is created).
231		243
232	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.
233		245
234	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
235	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
…		…
247	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
248	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
249	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>
250	error will be raised).	262	error will be raised).
251		263
252	There are three variants of the timeouts that work independently	264	There are three variants of the timeouts that work independently of each
253	of each other, for both read and write, just read, and just write:	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:
254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255	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
256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257		270
258	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
259	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
260	idle then you should disable the timeout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	274	timeout in the corresponding C<on_timeout> callback, in which case
262	restart the timeout.	275	AnyEvent::Handle will simply restart the timeout.
263		276
264	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
265		278
266	=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)
267		284
268	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
269	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
270	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
271		288
…		…
278	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
279	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
280	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
281	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
282	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.
283		315
284	=item autocork => <boolean>	316	=item autocork => <boolean>
285		317
286	When disabled (the default), C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
287	write the data to the handle if possible. This avoids having to register	319	write the data to the handle if possible. This avoids having to register
…		…
339	already have occured on BSD systems), but at least it will protect you	371	already have occured on BSD systems), but at least it will protect you
340	from most attacks.	372	from most attacks.
341		373
342	=item read_size => <bytes>	374	=item read_size => <bytes>
343		375
344	The initial read block size, the number of bytes this module will try to	376	The initial read block size, the number of bytes this module will try
345	read during each loop iteration. Each handle object will consume at least	377	to read during each loop iteration. Each handle object will consume
346	this amount of memory for the read buffer as well, so when handling many	378	at least this amount of memory for the read buffer as well, so when
347	connections requirements). See also C<max_read_size>. Default: C<2048>.	379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
348		381
349	=item max_read_size => <bytes>	382	=item max_read_size => <bytes>
350		383
351	The maximum read buffer size used by the dynamic adjustment	384	The maximum read buffer size used by the dynamic adjustment
352	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in	385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
…		…
396	appropriate error message.	429	appropriate error message.
397		430
398	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
399	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
400	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
401	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.
402		436
403	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
404	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>
405	mode.	439	mode.
406		440
…		…
422	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.
423		457
424	=item tls_ctx => $anyevent_tls	458	=item tls_ctx => $anyevent_tls
425		459
426	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
427	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
428	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>.
429		464
430	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
431	=> 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
432	new TLS context object.	467	new TLS context object.
433		468
…		…
502	$self->{connect}[0],	537	$self->{connect}[0],
503	$self->{connect}[1],	538	$self->{connect}[1],
504	sub {	539	sub {
505	my ($fh, $host, $port, $retry) = @_;	540	my ($fh, $host, $port, $retry) = @_;
506		541
		542	delete $self->{_connect}; # no longer needed
		543
507	if ($fh) {	544	if ($fh) {
508	$self->{fh} = $fh;	545	$self->{fh} = $fh;
509		546
510	delete $self->{_skip_drain_rbuf};	547	delete $self->{_skip_drain_rbuf};
511	$self->_start;	548	$self->_start;
…		…
518	});	555	});
519		556
520	} else {	557	} else {
521	if ($self->{on_connect_error}) {	558	if ($self->{on_connect_error}) {
522	$self->{on_connect_error}($self, "$!");	559	$self->{on_connect_error}($self, "$!");
523	$self->destroy;	560	$self->destroy if $self;
524	} else {	561	} else {
525	$self->_error ($!, 1);	562	$self->_error ($!, 1);
526	}	563	}
527	}	564	}
528	},	565	},
529	sub {	566	sub {
530	local $self->{fh} = $_[0];	567	local $self->{fh} = $_[0];
531		568
532	$self->{on_prepare}	569	$self->{on_prepare}
533	? $self->{on_prepare}->($self)	570	? $self->{on_prepare}->($self)
534	: ()	571	: ()
535	}	572	}
536	);	573	);
537	}	574	}
538		575
…		…
737		774
738	=item $handle->rbuf_max ($max_octets)	775	=item $handle->rbuf_max ($max_octets)
739		776
740	Configures the C<rbuf_max> setting (C<undef> disables it).	777	Configures the C<rbuf_max> setting (C<undef> disables it).
741		778
		779	=item $handle->wbuf_max ($max_octets)
		780
		781	Configures the C<wbuf_max> setting (C<undef> disables it).
		782
742	=cut	783	=cut
743		784
744	sub rbuf_max {	785	sub rbuf_max {
745	$_[0]{rbuf_max} = $_[1];	786	$_[0]{rbuf_max} = $_[1];
746	}	787	}
747		788
		789	sub wbuf_max {
		790	$_[0]{wbuf_max} = $_[1];
		791	}
		792
748	#############################################################################	793	#############################################################################
749		794
750	=item $handle->timeout ($seconds)	795	=item $handle->timeout ($seconds)
751		796
752	=item $handle->rtimeout ($seconds)	797	=item $handle->rtimeout ($seconds)
753		798
754	=item $handle->wtimeout ($seconds)	799	=item $handle->wtimeout ($seconds)
755		800
756	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.
757		805
758	=item $handle->timeout_reset	806	=item $handle->timeout_reset
759		807
760	=item $handle->rtimeout_reset	808	=item $handle->rtimeout_reset
761		809
…		…
845		893
846	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
847	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.
848		896
849	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
850	water mark, the C<on_drain> callback will be invoked.	898	water mark, the C<on_drain> callback will be invoked once.
851		899
852	=over 4	900	=over 4
853		901
854	=item $handle->on_drain ($cb)	902	=item $handle->on_drain ($cb)
855		903
…		…
870	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});
871	}	919	}
872		920
873	=item $handle->push_write ($data)	921	=item $handle->push_write ($data)
874		922
875	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
876	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
877	buffers it independently of the kernel.	925	C<AnyEvent::Handle> buffers it independently of the kernel.
878		926
879	This method may invoke callbacks (and therefore the handle might be	927	This method may invoke callbacks (and therefore the handle might be
880	destroyed after it returns).	928	destroyed after it returns).
881		929
882	=cut	930	=cut
…		…
910	$cb->() unless $self->{autocork};	958	$cb->() unless $self->{autocork};
911		959
912	# if still data left in wbuf, we need to poll	960	# if still data left in wbuf, we need to poll
913	$self->{_ww} = AE::io $self->{fh}, 1, $cb	961	$self->{_ww} = AE::io $self->{fh}, 1, $cb
914	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	}
915	};	970	};
916	}	971	}
917		972
918	our %WH;	973	our %WH;
919		974
…		…
1039	=cut	1094	=cut
1040		1095
1041	register_write_type storable => sub {	1096	register_write_type storable => sub {
1042	my ($self, $ref) = @_;	1097	my ($self, $ref) = @_;
1043		1098
1044	require Storable;	1099	require Storable unless $Storable::VERSION;
1045		1100
1046	pack "w/a*", Storable::nfreeze ($ref)	1101	pack "w/a*", Storable::nfreeze ($ref)
1047	};	1102	};
1048		1103
1049	=back	1104	=back
…		…
1054	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
1055	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
1056	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
1057	replaces the C<on_drain> callback with:	1112	replaces the C<on_drain> callback with:
1058		1113
1059	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1114	sub { shutdown $_[0]{fh}, 1 }
1060		1115
1061	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
1062	the peer.	1117	the peer.
1063		1118
1064	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
…		…
1086		1141
1087	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
1088	the handle object and the remaining arguments.	1143	the handle object and the remaining arguments.
1089		1144
1090	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
1091	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
1092	"arguments to on-the-wire-format" converter.	1147	"arguments to on-the-wire-format" converter.
1093		1148
1094	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
1095	arguments using the first one.	1150	arguments using the first one.
1096		1151
…		…
1390	data.	1445	data.
1391		1446
1392	Example: read 2 bytes.	1447	Example: read 2 bytes.
1393		1448
1394	$handle->push_read (chunk => 2, sub {	1449	$handle->push_read (chunk => 2, sub {
1395	warn "yay ", unpack "H*", $_[1];	1450	say "yay " . unpack "H*", $_[1];
1396	});	1451	});
1397		1452
1398	=cut	1453	=cut
1399		1454
1400	register_read_type chunk => sub {	1455	register_read_type chunk => sub {
…		…
1434	if (@_ < 3) {	1489	if (@_ < 3) {
1435	# this is more than twice as fast as the generic code below	1490	# this is more than twice as fast as the generic code below
1436	sub {	1491	sub {
1437	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1492	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
1438		1493
1439	$cb->($_[0], $1, $2);	1494	$cb->($_[0], "$1", "$2");
1440	1	1495	1
1441	}	1496	}
1442	} else {	1497	} else {
1443	$eol = quotemeta $eol unless ref $eol;	1498	$eol = quotemeta $eol unless ref $eol;
1444	$eol = qr\|^(.*?)($eol)\|s;	1499	$eol = qr\|^(.*?)($eol)\|s;
1445		1500
1446	sub {	1501	sub {
1447	$_[0]{rbuf} =~ s/$eol// or return;	1502	$_[0]{rbuf} =~ s/$eol// or return;
1448		1503
1449	$cb->($_[0], $1, $2);	1504	$cb->($_[0], "$1", "$2");
1450	1	1505	1
1451	}	1506	}
1452	}	1507	}
1453	};	1508	};
1454		1509
…		…
1502		1557
1503	sub {	1558	sub {
1504	# accept	1559	# accept
1505	if ($$rbuf =~ $accept) {	1560	if ($$rbuf =~ $accept) {
1506	$data .= substr $$rbuf, 0, $+[0], "";	1561	$data .= substr $$rbuf, 0, $+[0], "";
1507	$cb->($self, $data);	1562	$cb->($_[0], $data);
1508	return 1;	1563	return 1;
1509	}	1564	}
1510		1565
1511	# reject	1566	# reject
1512	if ($reject && $$rbuf =~ $reject) {	1567	if ($reject && $$rbuf =~ $reject) {
1513	$self->_error (Errno::EBADMSG);	1568	$_[0]->_error (Errno::EBADMSG);
1514	}	1569	}
1515		1570
1516	# skip	1571	# skip
1517	if ($skip && $$rbuf =~ $skip) {	1572	if ($skip && $$rbuf =~ $skip) {
1518	$data .= substr $$rbuf, 0, $+[0], "";	1573	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1534	my ($self, $cb) = @_;	1589	my ($self, $cb) = @_;
1535		1590
1536	sub {	1591	sub {
1537	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1592	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1538	if ($_[0]{rbuf} =~ /[^0-9]/) {	1593	if ($_[0]{rbuf} =~ /[^0-9]/) {
1539	$self->_error (Errno::EBADMSG);	1594	$_[0]->_error (Errno::EBADMSG);
1540	}	1595	}
1541	return;	1596	return;
1542	}	1597	}
1543		1598
1544	my $len = $1;	1599	my $len = $1;
1545		1600
1546	$self->unshift_read (chunk => $len, sub {	1601	$_[0]->unshift_read (chunk => $len, sub {
1547	my $string = $_[1];	1602	my $string = $_[1];
1548	$_[0]->unshift_read (chunk => 1, sub {	1603	$_[0]->unshift_read (chunk => 1, sub {
1549	if ($_[1] eq ",") {	1604	if ($_[1] eq ",") {
1550	$cb->($_[0], $string);	1605	$cb->($_[0], $string);
1551	} else {	1606	} else {
1552	$self->_error (Errno::EBADMSG);	1607	$_[0]->_error (Errno::EBADMSG);
1553	}	1608	}
1554	});	1609	});
1555	});	1610	});
1556		1611
1557	1	1612	1
…		…
1630		1685
1631	my $data;	1686	my $data;
1632	my $rbuf = \$self->{rbuf};	1687	my $rbuf = \$self->{rbuf};
1633		1688
1634	sub {	1689	sub {
1635	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1690	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1636		1691
1637	if ($ref) {	1692	if ($ref) {
1638	$self->{rbuf} = $json->incr_text;	1693	$_[0]{rbuf} = $json->incr_text;
1639	$json->incr_text = "";	1694	$json->incr_text = "";
1640	$cb->($self, $ref);	1695	$cb->($_[0], $ref);
1641		1696
1642	1	1697	1
1643	} elsif ($@) {	1698	} elsif ($@) {
1644	# error case	1699	# error case
1645	$json->incr_skip;	1700	$json->incr_skip;
1646		1701
1647	$self->{rbuf} = $json->incr_text;	1702	$_[0]{rbuf} = $json->incr_text;
1648	$json->incr_text = "";	1703	$json->incr_text = "";
1649		1704
1650	$self->_error (Errno::EBADMSG);	1705	$_[0]->_error (Errno::EBADMSG);
1651		1706
1652	()	1707	()
1653	} else {	1708	} else {
1654	$self->{rbuf} = "";	1709	$_[0]{rbuf} = "";
1655		1710
1656	()	1711	()
1657	}	1712	}
1658	}	1713	}
1659	};	1714	};
…		…
1669	=cut	1724	=cut
1670		1725
1671	register_read_type storable => sub {	1726	register_read_type storable => sub {
1672	my ($self, $cb) = @_;	1727	my ($self, $cb) = @_;
1673		1728
1674	require Storable;	1729	require Storable unless $Storable::VERSION;
1675		1730
1676	sub {	1731	sub {
1677	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1732	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1678	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1733	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1679	or return;	1734	or return;
…		…
1682		1737
1683	# bypass unshift if we already have the remaining chunk	1738	# bypass unshift if we already have the remaining chunk
1684	if ($format + $len <= length $_[0]{rbuf}) {	1739	if ($format + $len <= length $_[0]{rbuf}) {
1685	my $data = substr $_[0]{rbuf}, $format, $len;	1740	my $data = substr $_[0]{rbuf}, $format, $len;
1686	substr $_[0]{rbuf}, 0, $format + $len, "";	1741	substr $_[0]{rbuf}, 0, $format + $len, "";
		1742
1687	$cb->($_[0], Storable::thaw ($data));	1743	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1744	or return $_[0]->_error (Errno::EBADMSG);
1688	} else {	1745	} else {
1689	# remove prefix	1746	# remove prefix
1690	substr $_[0]{rbuf}, 0, $format, "";	1747	substr $_[0]{rbuf}, 0, $format, "";
1691		1748
1692	# read remaining chunk	1749	# read remaining chunk
1693	$_[0]->unshift_read (chunk => $len, sub {	1750	$_[0]->unshift_read (chunk => $len, sub {
1694	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1751	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1695	$cb->($_[0], $ref);
1696	} else {
1697	$self->_error (Errno::EBADMSG);	1752	or $_[0]->_error (Errno::EBADMSG);
1698	}
1699	});	1753	});
1700	}	1754	}
1701		1755
1702	1	1756	1
1703	}	1757	}
		1758	};
		1759
		1760	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1761
		1762	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1763	record without consuming anything. Only SSL version 3 or higher
		1764	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1765	SSL2-compatible framing is supported).
		1766
		1767	If it detects that the input data is likely TLS, it calls the callback
		1768	with a true value for C<$detect> and the (on-wire) TLS version as second
		1769	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1770	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1771	be definitely not TLS, it calls the callback with a false value for
		1772	C<$detect>.
		1773
		1774	The callback could use this information to decide whether or not to start
		1775	TLS negotiation.
		1776
		1777	In all cases the data read so far is passed to the following read
		1778	handlers.
		1779
		1780	Usually you want to use the C<tls_autostart> read type instead.
		1781
		1782	If you want to design a protocol that works in the presence of TLS
		1783	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1784	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1785	read type does are a bit more strict, but might losen in the future to
		1786	accomodate protocol changes.
		1787
		1788	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1789	L<Net::SSLeay>).
		1790
		1791	=item tls_autostart => $tls[, $tls_ctx]
		1792
		1793	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1794	to start tls by calling C<starttls> with the given arguments.
		1795
		1796	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1797	been configured to accept, as servers do not normally send a handshake on
		1798	their own and ths cannot be detected in this way.
		1799
		1800	See C<tls_detect> above for more details.
		1801
		1802	Example: give the client a chance to start TLS before accepting a text
		1803	line.
		1804
		1805	$hdl->push_read (tls_detect => "accept");
		1806	$hdl->push_read (line => sub {
		1807	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1808	});
		1809
		1810	=cut
		1811
		1812	register_read_type tls_detect => sub {
		1813	my ($self, $cb) = @_;
		1814
		1815	sub {
		1816	# this regex matches a full or partial tls record
		1817	if (
		1818	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1819	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1820	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1821	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1822	) {
		1823	return if 3 != length $1; # partial match, can't decide yet
		1824
		1825	# full match, valid TLS record
		1826	my ($major, $minor) = unpack "CC", $1;
		1827	$cb->($self, "accept", $major + $minor * 0.1);
		1828	} else {
		1829	# mismatch == guaranteed not TLS
		1830	$cb->($self, undef);
		1831	}
		1832
		1833	1
		1834	}
		1835	};
		1836
		1837	register_read_type tls_autostart => sub {
		1838	my ($self, @tls) = @_;
		1839
		1840	$RH{tls_detect}($self, sub {
		1841	return unless $_[1];
		1842	$_[0]->starttls (@tls);
		1843	})
1704	};	1844	};
1705		1845
1706	=back	1846	=back
1707		1847
1708	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1848	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1740	Note that AnyEvent::Handle will automatically C<start_read> for you when	1880	Note that AnyEvent::Handle will automatically C<start_read> for you when
1741	you change the C<on_read> callback or push/unshift a read callback, and it	1881	you change the C<on_read> callback or push/unshift a read callback, and it
1742	will automatically C<stop_read> for you when neither C<on_read> is set nor	1882	will automatically C<stop_read> for you when neither C<on_read> is set nor
1743	there are any read requests in the queue.	1883	there are any read requests in the queue.
1744		1884
1745	These methods will have no effect when in TLS mode (as TLS doesn't support	1885	In older versions of this module (<= 5.3), these methods had no effect,
1746	half-duplex connections).	1886	as TLS does not support half-duplex connections. In current versions they
		1887	work as expected, as this behaviour is required to avoid certain resource
		1888	attacks, where the program would be forced to read (and buffer) arbitrary
		1889	amounts of data before being able to send some data. The drawback is that
		1890	some readings of the the SSL/TLS specifications basically require this
		1891	attack to be working, as SSL/TLS implementations might stall sending data
		1892	during a rehandshake.
		1893
		1894	As a guideline, during the initial handshake, you should not stop reading,
		1895	and as a client, it might cause problems, depending on your application.
1747		1896
1748	=cut	1897	=cut
1749		1898
1750	sub stop_read {	1899	sub stop_read {
1751	my ($self) = @_;	1900	my ($self) = @_;
1752		1901
1753	delete $self->{_rw} unless $self->{tls};	1902	delete $self->{_rw};
1754	}	1903	}
1755		1904
1756	sub start_read {	1905	sub start_read {
1757	my ($self) = @_;	1906	my ($self) = @_;
1758		1907
…		…
1799	my ($self, $err) = @_;	1948	my ($self, $err) = @_;
1800		1949
1801	return $self->_error ($!, 1)	1950	return $self->_error ($!, 1)
1802	if $err == Net::SSLeay::ERROR_SYSCALL ();	1951	if $err == Net::SSLeay::ERROR_SYSCALL ();
1803		1952
1804	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1953	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1805		1954
1806	# reduce error string to look less scary	1955	# reduce error string to look less scary
1807	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1956	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1808		1957
1809	if ($self->{_on_starttls}) {	1958	if ($self->{_on_starttls}) {
…		…
1875		2024
1876	=item $handle->starttls ($tls[, $tls_ctx])	2025	=item $handle->starttls ($tls[, $tls_ctx])
1877		2026
1878	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2027	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1879	object is created, you can also do that at a later time by calling	2028	object is created, you can also do that at a later time by calling
1880	C<starttls>.	2029	C<starttls>. See the C<tls> constructor argument for general info.
1881		2030
1882	Starting TLS is currently an asynchronous operation - when you push some	2031	Starting TLS is currently an asynchronous operation - when you push some
1883	write data and then call C<< ->starttls >> then TLS negotiation will start	2032	write data and then call C<< ->starttls >> then TLS negotiation will start
1884	immediately, after which the queued write data is then sent.	2033	immediately, after which the queued write data is then sent. This might
		2034	change in future versions, so best make sure you have no outstanding write
		2035	data when calling this method.
1885		2036
1886	The first argument is the same as the C<tls> constructor argument (either	2037	The first argument is the same as the C<tls> constructor argument (either
1887	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2038	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1888		2039
1889	The second argument is the optional C<AnyEvent::TLS> object that is used	2040	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1911	my ($self, $tls, $ctx) = @_;	2062	my ($self, $tls, $ctx) = @_;
1912		2063
1913	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2064	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1914	if $self->{tls};	2065	if $self->{tls};
1915		2066
		2067	unless (defined $AnyEvent::TLS::VERSION) {
		2068	eval {
		2069	require Net::SSLeay;
		2070	require AnyEvent::TLS;
		2071	1
		2072	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2073	}
		2074
1916	$self->{tls} = $tls;	2075	$self->{tls} = $tls;
1917	$self->{tls_ctx} = $ctx if @_ > 2;	2076	$self->{tls_ctx} = $ctx if @_ > 2;
1918		2077
1919	return unless $self->{fh};	2078	return unless $self->{fh};
1920		2079
1921	require Net::SSLeay;
1922
1923	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2080	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1924	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2081	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1925		2082
1926	$tls = delete $self->{tls};	2083	$tls = delete $self->{tls};
1927	$ctx = $self->{tls_ctx};	2084	$ctx = $self->{tls_ctx};
1928		2085
1929	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2086	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1930		2087
1931	if ("HASH" eq ref $ctx) {	2088	if ("HASH" eq ref $ctx) {
1932	require AnyEvent::TLS;
1933
1934	if ($ctx->{cache}) {	2089	if ($ctx->{cache}) {
1935	my $key = $ctx+0;	2090	my $key = $ctx+0;
1936	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2091	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1937	} else {	2092	} else {
1938	$ctx = new AnyEvent::TLS %$ctx;	2093	$ctx = new AnyEvent::TLS %$ctx;
…		…
1960	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2115	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1961		2116
1962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2117	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2118	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1964		2119
1965	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2120	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2121	$self->{rbuf} = "";
1966		2122
1967	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2123	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1968		2124
1969	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2125	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1970	if $self->{on_starttls};	2126	if $self->{on_starttls};
…		…
2007	$self->{tls_ctx}->_put_session (delete $self->{tls})	2163	$self->{tls_ctx}->_put_session (delete $self->{tls})
2008	if $self->{tls} > 0;	2164	if $self->{tls} > 0;
2009		2165
2010	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2166	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2011	}	2167	}
		2168
		2169	=item $handle->resettls
		2170
		2171	This rarely-used method simply resets and TLS state on the handle, usually
		2172	causing data loss.
		2173
		2174	One case where it may be useful is when you want to skip over the data in
		2175	the stream but you are not interested in interpreting it, so data loss is
		2176	no concern.
		2177
		2178	=cut
		2179
		2180	*resettls = \&_freetls;
2012		2181
2013	sub DESTROY {	2182	sub DESTROY {
2014	my ($self) = @_;	2183	my ($self) = @_;
2015		2184
2016	&_freetls;	2185	&_freetls;
…		…
2132		2301
2133	It is only safe to "forget" the reference inside EOF or error callbacks,	2302	It is only safe to "forget" the reference inside EOF or error callbacks,
2134	from within all other callbacks, you need to explicitly call the C<<	2303	from within all other callbacks, you need to explicitly call the C<<
2135	->destroy >> method.	2304	->destroy >> method.
2136		2305
		2306	=item Why is my C<on_eof> callback never called?
		2307
		2308	Probably because your C<on_error> callback is being called instead: When
		2309	you have outstanding requests in your read queue, then an EOF is
		2310	considered an error as you clearly expected some data.
		2311
		2312	To avoid this, make sure you have an empty read queue whenever your handle
		2313	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2314	an C<on_read> handler that simply pushes the first read requests in the
		2315	queue.
		2316
		2317	See also the next question, which explains this in a bit more detail.
		2318
		2319	=item How can I serve requests in a loop?
		2320
		2321	Most protocols consist of some setup phase (authentication for example)
		2322	followed by a request handling phase, where the server waits for requests
		2323	and handles them, in a loop.
		2324
		2325	There are two important variants: The first (traditional, better) variant
		2326	handles requests until the server gets some QUIT command, causing it to
		2327	close the connection first (highly desirable for a busy TCP server). A
		2328	client dropping the connection is an error, which means this variant can
		2329	detect an unexpected detection close.
		2330
		2331	To handle this case, always make sure you have a non-empty read queue, by
		2332	pushing the "read request start" handler on it:
		2333
		2334	# we assume a request starts with a single line
		2335	my @start_request; @start_request = (line => sub {
		2336	my ($hdl, $line) = @_;
		2337
		2338	... handle request
		2339
		2340	# push next request read, possibly from a nested callback
		2341	$hdl->push_read (@start_request);
		2342	});
		2343
		2344	# auth done, now go into request handling loop
		2345	# now push the first @start_request
		2346	$hdl->push_read (@start_request);
		2347
		2348	By always having an outstanding C<push_read>, the handle always expects
		2349	some data and raises the C<EPIPE> error when the connction is dropped
		2350	unexpectedly.
		2351
		2352	The second variant is a protocol where the client can drop the connection
		2353	at any time. For TCP, this means that the server machine may run out of
		2354	sockets easier, and in general, it means you cannot distinguish a protocl
		2355	failure/client crash from a normal connection close. Nevertheless, these
		2356	kinds of protocols are common (and sometimes even the best solution to the
		2357	problem).
		2358
		2359	Having an outstanding read request at all times is possible if you ignore
		2360	C<EPIPE> errors, but this doesn't help with when the client drops the
		2361	connection during a request, which would still be an error.
		2362
		2363	A better solution is to push the initial request read in an C<on_read>
		2364	callback. This avoids an error, as when the server doesn't expect data
		2365	(i.e. is idly waiting for the next request, an EOF will not raise an
		2366	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2367	and simpler:
		2368
		2369	# auth done, now go into request handling loop
		2370	$hdl->on_read (sub {
		2371	my ($hdl) = @_;
		2372
		2373	# called each time we receive data but the read queue is empty
		2374	# simply start read the request
		2375
		2376	$hdl->push_read (line => sub {
		2377	my ($hdl, $line) = @_;
		2378
		2379	... handle request
		2380
		2381	# do nothing special when the request has been handled, just
		2382	# let the request queue go empty.
		2383	});
		2384	});
		2385
2137	=item I get different callback invocations in TLS mode/Why can't I pause	2386	=item I get different callback invocations in TLS mode/Why can't I pause
2138	reading?	2387	reading?
2139		2388
2140	Unlike, say, TCP, TLS connections do not consist of two independent	2389	Unlike, say, TCP, TLS connections do not consist of two independent
2141	communication channels, one for each direction. Or put differently, the	2390	communication channels, one for each direction. Or put differently, the
…		…
2162	$handle->on_eof (undef);	2411	$handle->on_eof (undef);
2163	$handle->on_error (sub {	2412	$handle->on_error (sub {
2164	my $data = delete $_[0]{rbuf};	2413	my $data = delete $_[0]{rbuf};
2165	});	2414	});
2166		2415
		2416	Note that this example removes the C<rbuf> member from the handle object,
		2417	which is not normally allowed by the API. It is expressly permitted in
		2418	this case only, as the handle object needs to be destroyed afterwards.
		2419
2167	The reason to use C<on_error> is that TCP connections, due to latencies	2420	The reason to use C<on_error> is that TCP connections, due to latencies
2168	and packets loss, might get closed quite violently with an error, when in	2421	and packets loss, might get closed quite violently with an error, when in
2169	fact all data has been received.	2422	fact all data has been received.
2170		2423
2171	It is usually better to use acknowledgements when transferring data,	2424	It is usually better to use acknowledgements when transferring data,
…		…
2181	C<low_water_mark> this will be called precisely when all data has been	2434	C<low_water_mark> this will be called precisely when all data has been
2182	written to the socket:	2435	written to the socket:
2183		2436
2184	$handle->push_write (...);	2437	$handle->push_write (...);
2185	$handle->on_drain (sub {	2438	$handle->on_drain (sub {
2186	warn "all data submitted to the kernel\n";	2439	AE::log debug => "All data submitted to the kernel.";
2187	undef $handle;	2440	undef $handle;
2188	});	2441	});
2189		2442
2190	If you just want to queue some data and then signal EOF to the other side,	2443	If you just want to queue some data and then signal EOF to the other side,
2191	consider using C<< ->push_shutdown >> instead.	2444	consider using C<< ->push_shutdown >> instead.
…		…
2275	When you have intermediate CA certificates that your clients might not	2528	When you have intermediate CA certificates that your clients might not
2276	know about, just append them to the C<cert_file>.	2529	know about, just append them to the C<cert_file>.
2277		2530
2278	=back	2531	=back
2279		2532
2280
2281	=head1 SUBCLASSING AnyEvent::Handle	2533	=head1 SUBCLASSING AnyEvent::Handle
2282		2534
2283	In many cases, you might want to subclass AnyEvent::Handle.	2535	In many cases, you might want to subclass AnyEvent::Handle.
2284		2536
2285	To make this easier, a given version of AnyEvent::Handle uses these	2537	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2311		2563
2312	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2564	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2313		2565
2314	=cut	2566	=cut
2315		2567
2316	1; # End of AnyEvent::Handle	2568	1
		2569

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.204 by root, Mon Nov 15 03:29:17 2010 UTC vs. Revision 1.236 by root, Sat May 12 23:14:29 2012 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.204 by root, Mon Nov 15 03:29:17 2010 UTC vs.
Revision 1.236 by root, Sat May 12 23:14:29 2012 UTC