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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.212 by root, Fri Dec 31 04:50:44 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
…		…
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
…		…
354	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
355	from most attacks.	372	from most attacks.
356		373
357	=item read_size => <bytes>	374	=item read_size => <bytes>
358		375
359	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
360	read during each loop iteration. Each handle object will consume at least	377	to read during each loop iteration. Each handle object will consume
361	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
362	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>.
363		381
364	=item max_read_size => <bytes>	382	=item max_read_size => <bytes>
365		383
366	The maximum read buffer size used by the dynamic adjustment	384	The maximum read buffer size used by the dynamic adjustment
367	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
…		…
411	appropriate error message.	429	appropriate error message.
412		430
413	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
414	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
415	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
416	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.
417		436
418	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
419	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>
420	mode.	439	mode.
421		440
…		…
536	});	555	});
537		556
538	} else {	557	} else {
539	if ($self->{on_connect_error}) {	558	if ($self->{on_connect_error}) {
540	$self->{on_connect_error}($self, "$!");	559	$self->{on_connect_error}($self, "$!");
541	$self->destroy;	560	$self->destroy if $self;
542	} else {	561	} else {
543	$self->_error ($!, 1);	562	$self->_error ($!, 1);
544	}	563	}
545	}	564	}
546	},	565	},
…		…
765		784
766	sub rbuf_max {	785	sub rbuf_max {
767	$_[0]{rbuf_max} = $_[1];	786	$_[0]{rbuf_max} = $_[1];
768	}	787	}
769		788
770	sub rbuf_max {	789	sub wbuf_max {
771	$_[0]{wbuf_max} = $_[1];	790	$_[0]{wbuf_max} = $_[1];
772	}	791	}
773		792
774	#############################################################################	793	#############################################################################
775		794
…		…
778	=item $handle->rtimeout ($seconds)	797	=item $handle->rtimeout ($seconds)
779		798
780	=item $handle->wtimeout ($seconds)	799	=item $handle->wtimeout ($seconds)
781		800
782	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.
783		805
784	=item $handle->timeout_reset	806	=item $handle->timeout_reset
785		807
786	=item $handle->rtimeout_reset	808	=item $handle->rtimeout_reset
787		809
…		…
871		893
872	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
873	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.
874		896
875	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
876	water mark, the C<on_drain> callback will be invoked.	898	water mark, the C<on_drain> callback will be invoked once.
877		899
878	=over 4	900	=over 4
879		901
880	=item $handle->on_drain ($cb)	902	=item $handle->on_drain ($cb)
881		903
…		…
1072	=cut	1094	=cut
1073		1095
1074	register_write_type storable => sub {	1096	register_write_type storable => sub {
1075	my ($self, $ref) = @_;	1097	my ($self, $ref) = @_;
1076		1098
1077	require Storable;	1099	require Storable unless $Storable::VERSION;
1078		1100
1079	pack "w/a*", Storable::nfreeze ($ref)	1101	pack "w/a*", Storable::nfreeze ($ref)
1080	};	1102	};
1081		1103
1082	=back	1104	=back
…		…
1087	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
1088	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
1089	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
1090	replaces the C<on_drain> callback with:	1112	replaces the C<on_drain> callback with:
1091		1113
1092	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1114	sub { shutdown $_[0]{fh}, 1 }
1093		1115
1094	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
1095	the peer.	1117	the peer.
1096		1118
1097	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
…		…
1119		1141
1120	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
1121	the handle object and the remaining arguments.	1143	the handle object and the remaining arguments.
1122		1144
1123	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
1124	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
1125	"arguments to on-the-wire-format" converter.	1147	"arguments to on-the-wire-format" converter.
1126		1148
1127	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
1128	arguments using the first one.	1150	arguments using the first one.
1129		1151
…		…
1423	data.	1445	data.
1424		1446
1425	Example: read 2 bytes.	1447	Example: read 2 bytes.
1426		1448
1427	$handle->push_read (chunk => 2, sub {	1449	$handle->push_read (chunk => 2, sub {
1428	warn "yay ", unpack "H*", $_[1];	1450	say "yay " . unpack "H*", $_[1];
1429	});	1451	});
1430		1452
1431	=cut	1453	=cut
1432		1454
1433	register_read_type chunk => sub {	1455	register_read_type chunk => sub {
…		…
1463		1485
1464	register_read_type line => sub {	1486	register_read_type line => sub {
1465	my ($self, $cb, $eol) = @_;	1487	my ($self, $cb, $eol) = @_;
1466		1488
1467	if (@_ < 3) {	1489	if (@_ < 3) {
1468	# this is more than twice as fast as the generic code below	1490	# this is faster then the generic code below
1469	sub {	1491	sub {
1470	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1492	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1493	or return;
1471		1494
		1495	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1472	$cb->($_[0], $1, $2);	1496	$cb->($_[0], $str, "$1");
1473	1	1497	1
1474	}	1498	}
1475	} else {	1499	} else {
1476	$eol = quotemeta $eol unless ref $eol;	1500	$eol = quotemeta $eol unless ref $eol;
1477	$eol = qr\|^(.*?)($eol)\|s;	1501	$eol = qr\|^(.*?)($eol)\|s;
1478		1502
1479	sub {	1503	sub {
1480	$_[0]{rbuf} =~ s/$eol// or return;	1504	$_[0]{rbuf} =~ s/$eol// or return;
1481		1505
1482	$cb->($_[0], $1, $2);	1506	$cb->($_[0], "$1", "$2");
1483	1	1507	1
1484	}	1508	}
1485	}	1509	}
1486	};	1510	};
1487		1511
…		…
1535		1559
1536	sub {	1560	sub {
1537	# accept	1561	# accept
1538	if ($$rbuf =~ $accept) {	1562	if ($$rbuf =~ $accept) {
1539	$data .= substr $$rbuf, 0, $+[0], "";	1563	$data .= substr $$rbuf, 0, $+[0], "";
1540	$cb->($self, $data);	1564	$cb->($_[0], $data);
1541	return 1;	1565	return 1;
1542	}	1566	}
1543		1567
1544	# reject	1568	# reject
1545	if ($reject && $$rbuf =~ $reject) {	1569	if ($reject && $$rbuf =~ $reject) {
1546	$self->_error (Errno::EBADMSG);	1570	$_[0]->_error (Errno::EBADMSG);
1547	}	1571	}
1548		1572
1549	# skip	1573	# skip
1550	if ($skip && $$rbuf =~ $skip) {	1574	if ($skip && $$rbuf =~ $skip) {
1551	$data .= substr $$rbuf, 0, $+[0], "";	1575	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1567	my ($self, $cb) = @_;	1591	my ($self, $cb) = @_;
1568		1592
1569	sub {	1593	sub {
1570	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1594	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1571	if ($_[0]{rbuf} =~ /[^0-9]/) {	1595	if ($_[0]{rbuf} =~ /[^0-9]/) {
1572	$self->_error (Errno::EBADMSG);	1596	$_[0]->_error (Errno::EBADMSG);
1573	}	1597	}
1574	return;	1598	return;
1575	}	1599	}
1576		1600
1577	my $len = $1;	1601	my $len = $1;
1578		1602
1579	$self->unshift_read (chunk => $len, sub {	1603	$_[0]->unshift_read (chunk => $len, sub {
1580	my $string = $_[1];	1604	my $string = $_[1];
1581	$_[0]->unshift_read (chunk => 1, sub {	1605	$_[0]->unshift_read (chunk => 1, sub {
1582	if ($_[1] eq ",") {	1606	if ($_[1] eq ",") {
1583	$cb->($_[0], $string);	1607	$cb->($_[0], $string);
1584	} else {	1608	} else {
1585	$self->_error (Errno::EBADMSG);	1609	$_[0]->_error (Errno::EBADMSG);
1586	}	1610	}
1587	});	1611	});
1588	});	1612	});
1589		1613
1590	1	1614	1
…		…
1663		1687
1664	my $data;	1688	my $data;
1665	my $rbuf = \$self->{rbuf};	1689	my $rbuf = \$self->{rbuf};
1666		1690
1667	sub {	1691	sub {
1668	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1692	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1669		1693
1670	if ($ref) {	1694	if ($ref) {
1671	$self->{rbuf} = $json->incr_text;	1695	$_[0]{rbuf} = $json->incr_text;
1672	$json->incr_text = "";	1696	$json->incr_text = "";
1673	$cb->($self, $ref);	1697	$cb->($_[0], $ref);
1674		1698
1675	1	1699	1
1676	} elsif ($@) {	1700	} elsif ($@) {
1677	# error case	1701	# error case
1678	$json->incr_skip;	1702	$json->incr_skip;
1679		1703
1680	$self->{rbuf} = $json->incr_text;	1704	$_[0]{rbuf} = $json->incr_text;
1681	$json->incr_text = "";	1705	$json->incr_text = "";
1682		1706
1683	$self->_error (Errno::EBADMSG);	1707	$_[0]->_error (Errno::EBADMSG);
1684		1708
1685	()	1709	()
1686	} else {	1710	} else {
1687	$self->{rbuf} = "";	1711	$_[0]{rbuf} = "";
1688		1712
1689	()	1713	()
1690	}	1714	}
1691	}	1715	}
1692	};	1716	};
…		…
1702	=cut	1726	=cut
1703		1727
1704	register_read_type storable => sub {	1728	register_read_type storable => sub {
1705	my ($self, $cb) = @_;	1729	my ($self, $cb) = @_;
1706		1730
1707	require Storable;	1731	require Storable unless $Storable::VERSION;
1708		1732
1709	sub {	1733	sub {
1710	# 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
1711	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1735	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1712	or return;	1736	or return;
…		…
1715		1739
1716	# bypass unshift if we already have the remaining chunk	1740	# bypass unshift if we already have the remaining chunk
1717	if ($format + $len <= length $_[0]{rbuf}) {	1741	if ($format + $len <= length $_[0]{rbuf}) {
1718	my $data = substr $_[0]{rbuf}, $format, $len;	1742	my $data = substr $_[0]{rbuf}, $format, $len;
1719	substr $_[0]{rbuf}, 0, $format + $len, "";	1743	substr $_[0]{rbuf}, 0, $format + $len, "";
		1744
1720	$cb->($_[0], Storable::thaw ($data));	1745	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1746	or return $_[0]->_error (Errno::EBADMSG);
1721	} else {	1747	} else {
1722	# remove prefix	1748	# remove prefix
1723	substr $_[0]{rbuf}, 0, $format, "";	1749	substr $_[0]{rbuf}, 0, $format, "";
1724		1750
1725	# read remaining chunk	1751	# read remaining chunk
1726	$_[0]->unshift_read (chunk => $len, sub {	1752	$_[0]->unshift_read (chunk => $len, sub {
1727	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1753	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1728	$cb->($_[0], $ref);
1729	} else {
1730	$self->_error (Errno::EBADMSG);	1754	or $_[0]->_error (Errno::EBADMSG);
1731	}
1732	});	1755	});
1733	}	1756	}
1734		1757
1735	1	1758	1
1736	}	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	})
1737	};	1846	};
1738		1847
1739	=back	1848	=back
1740		1849
1741	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1850	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1773	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
1774	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
1775	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
1776	there are any read requests in the queue.	1885	there are any read requests in the queue.
1777		1886
1778	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,
1779	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.
1780		1898
1781	=cut	1899	=cut
1782		1900
1783	sub stop_read {	1901	sub stop_read {
1784	my ($self) = @_;	1902	my ($self) = @_;
1785		1903
1786	delete $self->{_rw} unless $self->{tls};	1904	delete $self->{_rw};
1787	}	1905	}
1788		1906
1789	sub start_read {	1907	sub start_read {
1790	my ($self) = @_;	1908	my ($self) = @_;
1791		1909
…		…
1832	my ($self, $err) = @_;	1950	my ($self, $err) = @_;
1833		1951
1834	return $self->_error ($!, 1)	1952	return $self->_error ($!, 1)
1835	if $err == Net::SSLeay::ERROR_SYSCALL ();	1953	if $err == Net::SSLeay::ERROR_SYSCALL ();
1836		1954
1837	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 ());
1838		1956
1839	# reduce error string to look less scary	1957	# reduce error string to look less scary
1840	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1958	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1841		1959
1842	if ($self->{_on_starttls}) {	1960	if ($self->{_on_starttls}) {
…		…
1908		2026
1909	=item $handle->starttls ($tls[, $tls_ctx])	2027	=item $handle->starttls ($tls[, $tls_ctx])
1910		2028
1911	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2029	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1912	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
1913	C<starttls>.	2031	C<starttls>. See the C<tls> constructor argument for general info.
1914		2032
1915	Starting TLS is currently an asynchronous operation - when you push some	2033	Starting TLS is currently an asynchronous operation - when you push some
1916	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
1917	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.
1918		2038
1919	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
1920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2040	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1921		2041
1922	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
…		…
1944	my ($self, $tls, $ctx) = @_;	2064	my ($self, $tls, $ctx) = @_;
1945		2065
1946	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"
1947	if $self->{tls};	2067	if $self->{tls};
1948		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
1949	$self->{tls} = $tls;	2077	$self->{tls} = $tls;
1950	$self->{tls_ctx} = $ctx if @_ > 2;	2078	$self->{tls_ctx} = $ctx if @_ > 2;
1951		2079
1952	return unless $self->{fh};	2080	return unless $self->{fh};
1953		2081
1954	require Net::SSLeay;
1955
1956	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2082	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1957	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2083	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1958		2084
1959	$tls = delete $self->{tls};	2085	$tls = delete $self->{tls};
1960	$ctx = $self->{tls_ctx};	2086	$ctx = $self->{tls_ctx};
1961		2087
1962	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
1963		2089
1964	if ("HASH" eq ref $ctx) {	2090	if ("HASH" eq ref $ctx) {
1965	require AnyEvent::TLS;
1966
1967	if ($ctx->{cache}) {	2091	if ($ctx->{cache}) {
1968	my $key = $ctx+0;	2092	my $key = $ctx+0;
1969	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2093	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1970	} else {	2094	} else {
1971	$ctx = new AnyEvent::TLS %$ctx;	2095	$ctx = new AnyEvent::TLS %$ctx;
…		…
1993	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2117	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1994		2118
1995	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2119	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1996	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2120	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1997		2121
1998	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2122	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2123	$self->{rbuf} = "";
1999		2124
2000	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2125	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
2001		2126
2002	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2127	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
2003	if $self->{on_starttls};	2128	if $self->{on_starttls};
…		…
2040	$self->{tls_ctx}->_put_session (delete $self->{tls})	2165	$self->{tls_ctx}->_put_session (delete $self->{tls})
2041	if $self->{tls} > 0;	2166	if $self->{tls} > 0;
2042		2167
2043	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2168	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2044	}	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;
2045		2183
2046	sub DESTROY {	2184	sub DESTROY {
2047	my ($self) = @_;	2185	my ($self) = @_;
2048		2186
2049	&_freetls;	2187	&_freetls;
…		…
2172	Probably because your C<on_error> callback is being called instead: When	2310	Probably because your C<on_error> callback is being called instead: When
2173	you have outstanding requests in your read queue, then an EOF is	2311	you have outstanding requests in your read queue, then an EOF is
2174	considered an error as you clearly expected some data.	2312	considered an error as you clearly expected some data.
2175		2313
2176	To avoid this, make sure you have an empty read queue whenever your handle	2314	To avoid this, make sure you have an empty read queue whenever your handle
2177	is supposed to be "idle" (i.e. connection closes are O.K.). You cna set	2315	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
2178	an C<on_read> handler that simply pushes the first read requests in the	2316	an C<on_read> handler that simply pushes the first read requests in the
2179	queue.	2317	queue.
2180		2318
2181	See also the next question, which explains this in a bit more detail.	2319	See also the next question, which explains this in a bit more detail.
2182		2320
…		…
2190	handles requests until the server gets some QUIT command, causing it to	2328	handles requests until the server gets some QUIT command, causing it to
2191	close the connection first (highly desirable for a busy TCP server). A	2329	close the connection first (highly desirable for a busy TCP server). A
2192	client dropping the connection is an error, which means this variant can	2330	client dropping the connection is an error, which means this variant can
2193	detect an unexpected detection close.	2331	detect an unexpected detection close.
2194		2332
2195	To handle this case, always make sure you have a on-empty read queue, by	2333	To handle this case, always make sure you have a non-empty read queue, by
2196	pushing the "read request start" handler on it:	2334	pushing the "read request start" handler on it:
2197		2335
2198	# we assume a request starts with a single line	2336	# we assume a request starts with a single line
2199	my @start_request; @start_request = (line => sub {	2337	my @start_request; @start_request = (line => sub {
2200	my ($hdl, $line) = @_;	2338	my ($hdl, $line) = @_;
…		…
2213	some data and raises the C<EPIPE> error when the connction is dropped	2351	some data and raises the C<EPIPE> error when the connction is dropped
2214	unexpectedly.	2352	unexpectedly.
2215		2353
2216	The second variant is a protocol where the client can drop the connection	2354	The second variant is a protocol where the client can drop the connection
2217	at any time. For TCP, this means that the server machine may run out of	2355	at any time. For TCP, this means that the server machine may run out of
2218	sockets easier, and in general, it means you cnanot distinguish a protocl	2356	sockets easier, and in general, it means you cannot distinguish a protocl
2219	failure/client crash from a normal connection close. Nevertheless, these	2357	failure/client crash from a normal connection close. Nevertheless, these
2220	kinds of protocols are common (and sometimes even the best solution to the	2358	kinds of protocols are common (and sometimes even the best solution to the
2221	problem).	2359	problem).
2222		2360
2223	Having an outstanding read request at all times is possible if you ignore	2361	Having an outstanding read request at all times is possible if you ignore
…		…
2275	$handle->on_eof (undef);	2413	$handle->on_eof (undef);
2276	$handle->on_error (sub {	2414	$handle->on_error (sub {
2277	my $data = delete $_[0]{rbuf};	2415	my $data = delete $_[0]{rbuf};
2278	});	2416	});
2279		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
2280	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
2281	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
2282	fact all data has been received.	2424	fact all data has been received.
2283		2425
2284	It is usually better to use acknowledgements when transferring data,	2426	It is usually better to use acknowledgements when transferring data,
…		…
2294	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
2295	written to the socket:	2437	written to the socket:
2296		2438
2297	$handle->push_write (...);	2439	$handle->push_write (...);
2298	$handle->on_drain (sub {	2440	$handle->on_drain (sub {
2299	warn "all data submitted to the kernel\n";	2441	AE::log debug => "All data submitted to the kernel.";
2300	undef $handle;	2442	undef $handle;
2301	});	2443	});
2302		2444
2303	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,
2304	consider using C<< ->push_shutdown >> instead.	2446	consider using C<< ->push_shutdown >> instead.
…		…
2388	When you have intermediate CA certificates that your clients might not	2530	When you have intermediate CA certificates that your clients might not
2389	know about, just append them to the C<cert_file>.	2531	know about, just append them to the C<cert_file>.
2390		2532
2391	=back	2533	=back
2392		2534
2393
2394	=head1 SUBCLASSING AnyEvent::Handle	2535	=head1 SUBCLASSING AnyEvent::Handle
2395		2536
2396	In many cases, you might want to subclass AnyEvent::Handle.	2537	In many cases, you might want to subclass AnyEvent::Handle.
2397		2538
2398	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
…		…
2424		2565
2425	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>.
2426		2567
2427	=cut	2568	=cut
2428		2569
2429	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.212 by root, Fri Dec 31 04:50:44 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.212 by root, Fri Dec 31 04:50:44 2010 UTC vs.
Revision 1.237 by root, Tue Jul 30 23:14:32 2013 UTC