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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.207 by root, Mon Nov 15 22:29:36 2010 UTC vs.
Revision 1.235 by root, Tue May 8 19:41:22 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
…		…
521	});	555	});
522		556
523	} else {	557	} else {
524	if ($self->{on_connect_error}) {	558	if ($self->{on_connect_error}) {
525	$self->{on_connect_error}($self, "$!");	559	$self->{on_connect_error}($self, "$!");
526	$self->destroy;	560	$self->destroy if $self;
527	} else {	561	} else {
528	$self->_error ($!, 1);	562	$self->_error ($!, 1);
529	}	563	}
530	}	564	}
531	},	565	},
532	sub {	566	sub {
533	local $self->{fh} = $_[0];	567	local $self->{fh} = $_[0];
534		568
535	$self->{on_prepare}	569	$self->{on_prepare}
536	? $self->{on_prepare}->($self)	570	? $self->{on_prepare}->($self)
537	: ()	571	: ()
538	}	572	}
539	);	573	);
540	}	574	}
541		575
…		…
740		774
741	=item $handle->rbuf_max ($max_octets)	775	=item $handle->rbuf_max ($max_octets)
742		776
743	Configures the C<rbuf_max> setting (C<undef> disables it).	777	Configures the C<rbuf_max> setting (C<undef> disables it).
744		778
		779	=item $handle->wbuf_max ($max_octets)
		780
		781	Configures the C<wbuf_max> setting (C<undef> disables it).
		782
745	=cut	783	=cut
746		784
747	sub rbuf_max {	785	sub rbuf_max {
748	$_[0]{rbuf_max} = $_[1];	786	$_[0]{rbuf_max} = $_[1];
749	}	787	}
750		788
		789	sub wbuf_max {
		790	$_[0]{wbuf_max} = $_[1];
		791	}
		792
751	#############################################################################	793	#############################################################################
752		794
753	=item $handle->timeout ($seconds)	795	=item $handle->timeout ($seconds)
754		796
755	=item $handle->rtimeout ($seconds)	797	=item $handle->rtimeout ($seconds)
756		798
757	=item $handle->wtimeout ($seconds)	799	=item $handle->wtimeout ($seconds)
758		800
759	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.
760		805
761	=item $handle->timeout_reset	806	=item $handle->timeout_reset
762		807
763	=item $handle->rtimeout_reset	808	=item $handle->rtimeout_reset
764		809
…		…
848		893
849	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
850	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.
851		896
852	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
853	water mark, the C<on_drain> callback will be invoked.	898	water mark, the C<on_drain> callback will be invoked once.
854		899
855	=over 4	900	=over 4
856		901
857	=item $handle->on_drain ($cb)	902	=item $handle->on_drain ($cb)
858		903
…		…
873	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});
874	}	919	}
875		920
876	=item $handle->push_write ($data)	921	=item $handle->push_write ($data)
877		922
878	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
879	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
880	buffers it independently of the kernel.	925	C<AnyEvent::Handle> buffers it independently of the kernel.
881		926
882	This method may invoke callbacks (and therefore the handle might be	927	This method may invoke callbacks (and therefore the handle might be
883	destroyed after it returns).	928	destroyed after it returns).
884		929
885	=cut	930	=cut
…		…
913	$cb->() unless $self->{autocork};	958	$cb->() unless $self->{autocork};
914		959
915	# if still data left in wbuf, we need to poll	960	# if still data left in wbuf, we need to poll
916	$self->{_ww} = AE::io $self->{fh}, 1, $cb	961	$self->{_ww} = AE::io $self->{fh}, 1, $cb
917	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	}
918	};	970	};
919	}	971	}
920		972
921	our %WH;	973	our %WH;
922		974
…		…
1042	=cut	1094	=cut
1043		1095
1044	register_write_type storable => sub {	1096	register_write_type storable => sub {
1045	my ($self, $ref) = @_;	1097	my ($self, $ref) = @_;
1046		1098
1047	require Storable;	1099	require Storable unless $Storable::VERSION;
1048		1100
1049	pack "w/a*", Storable::nfreeze ($ref)	1101	pack "w/a*", Storable::nfreeze ($ref)
1050	};	1102	};
1051		1103
1052	=back	1104	=back
…		…
1057	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
1058	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
1059	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
1060	replaces the C<on_drain> callback with:	1112	replaces the C<on_drain> callback with:
1061		1113
1062	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1114	sub { shutdown $_[0]{fh}, 1 }
1063		1115
1064	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
1065	the peer.	1117	the peer.
1066		1118
1067	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
…		…
1089		1141
1090	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
1091	the handle object and the remaining arguments.	1143	the handle object and the remaining arguments.
1092		1144
1093	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
1094	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
1095	"arguments to on-the-wire-format" converter.	1147	"arguments to on-the-wire-format" converter.
1096		1148
1097	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
1098	arguments using the first one.	1150	arguments using the first one.
1099		1151
…		…
1393	data.	1445	data.
1394		1446
1395	Example: read 2 bytes.	1447	Example: read 2 bytes.
1396		1448
1397	$handle->push_read (chunk => 2, sub {	1449	$handle->push_read (chunk => 2, sub {
1398	warn "yay ", unpack "H*", $_[1];	1450	say "yay " . unpack "H*", $_[1];
1399	});	1451	});
1400		1452
1401	=cut	1453	=cut
1402		1454
1403	register_read_type chunk => sub {	1455	register_read_type chunk => sub {
…		…
1437	if (@_ < 3) {	1489	if (@_ < 3) {
1438	# 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
1439	sub {	1491	sub {
1440	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1492	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
1441		1493
1442	$cb->($_[0], $1, $2);	1494	$cb->($_[0], "$1", "$2");
1443	1	1495	1
1444	}	1496	}
1445	} else {	1497	} else {
1446	$eol = quotemeta $eol unless ref $eol;	1498	$eol = quotemeta $eol unless ref $eol;
1447	$eol = qr\|^(.*?)($eol)\|s;	1499	$eol = qr\|^(.*?)($eol)\|s;
1448		1500
1449	sub {	1501	sub {
1450	$_[0]{rbuf} =~ s/$eol// or return;	1502	$_[0]{rbuf} =~ s/$eol// or return;
1451		1503
1452	$cb->($_[0], $1, $2);	1504	$cb->($_[0], "$1", "$2");
1453	1	1505	1
1454	}	1506	}
1455	}	1507	}
1456	};	1508	};
1457		1509
…		…
1505		1557
1506	sub {	1558	sub {
1507	# accept	1559	# accept
1508	if ($$rbuf =~ $accept) {	1560	if ($$rbuf =~ $accept) {
1509	$data .= substr $$rbuf, 0, $+[0], "";	1561	$data .= substr $$rbuf, 0, $+[0], "";
1510	$cb->($self, $data);	1562	$cb->($_[0], $data);
1511	return 1;	1563	return 1;
1512	}	1564	}
1513		1565
1514	# reject	1566	# reject
1515	if ($reject && $$rbuf =~ $reject) {	1567	if ($reject && $$rbuf =~ $reject) {
1516	$self->_error (Errno::EBADMSG);	1568	$_[0]->_error (Errno::EBADMSG);
1517	}	1569	}
1518		1570
1519	# skip	1571	# skip
1520	if ($skip && $$rbuf =~ $skip) {	1572	if ($skip && $$rbuf =~ $skip) {
1521	$data .= substr $$rbuf, 0, $+[0], "";	1573	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1537	my ($self, $cb) = @_;	1589	my ($self, $cb) = @_;
1538		1590
1539	sub {	1591	sub {
1540	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1592	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1541	if ($_[0]{rbuf} =~ /[^0-9]/) {	1593	if ($_[0]{rbuf} =~ /[^0-9]/) {
1542	$self->_error (Errno::EBADMSG);	1594	$_[0]->_error (Errno::EBADMSG);
1543	}	1595	}
1544	return;	1596	return;
1545	}	1597	}
1546		1598
1547	my $len = $1;	1599	my $len = $1;
1548		1600
1549	$self->unshift_read (chunk => $len, sub {	1601	$_[0]->unshift_read (chunk => $len, sub {
1550	my $string = $_[1];	1602	my $string = $_[1];
1551	$_[0]->unshift_read (chunk => 1, sub {	1603	$_[0]->unshift_read (chunk => 1, sub {
1552	if ($_[1] eq ",") {	1604	if ($_[1] eq ",") {
1553	$cb->($_[0], $string);	1605	$cb->($_[0], $string);
1554	} else {	1606	} else {
1555	$self->_error (Errno::EBADMSG);	1607	$_[0]->_error (Errno::EBADMSG);
1556	}	1608	}
1557	});	1609	});
1558	});	1610	});
1559		1611
1560	1	1612	1
…		…
1633		1685
1634	my $data;	1686	my $data;
1635	my $rbuf = \$self->{rbuf};	1687	my $rbuf = \$self->{rbuf};
1636		1688
1637	sub {	1689	sub {
1638	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1690	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1639		1691
1640	if ($ref) {	1692	if ($ref) {
1641	$self->{rbuf} = $json->incr_text;	1693	$_[0]{rbuf} = $json->incr_text;
1642	$json->incr_text = "";	1694	$json->incr_text = "";
1643	$cb->($self, $ref);	1695	$cb->($_[0], $ref);
1644		1696
1645	1	1697	1
1646	} elsif ($@) {	1698	} elsif ($@) {
1647	# error case	1699	# error case
1648	$json->incr_skip;	1700	$json->incr_skip;
1649		1701
1650	$self->{rbuf} = $json->incr_text;	1702	$_[0]{rbuf} = $json->incr_text;
1651	$json->incr_text = "";	1703	$json->incr_text = "";
1652		1704
1653	$self->_error (Errno::EBADMSG);	1705	$_[0]->_error (Errno::EBADMSG);
1654		1706
1655	()	1707	()
1656	} else {	1708	} else {
1657	$self->{rbuf} = "";	1709	$_[0]{rbuf} = "";
1658		1710
1659	()	1711	()
1660	}	1712	}
1661	}	1713	}
1662	};	1714	};
…		…
1672	=cut	1724	=cut
1673		1725
1674	register_read_type storable => sub {	1726	register_read_type storable => sub {
1675	my ($self, $cb) = @_;	1727	my ($self, $cb) = @_;
1676		1728
1677	require Storable;	1729	require Storable unless $Storable::VERSION;
1678		1730
1679	sub {	1731	sub {
1680	# 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
1681	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1733	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1682	or return;	1734	or return;
…		…
1685		1737
1686	# bypass unshift if we already have the remaining chunk	1738	# bypass unshift if we already have the remaining chunk
1687	if ($format + $len <= length $_[0]{rbuf}) {	1739	if ($format + $len <= length $_[0]{rbuf}) {
1688	my $data = substr $_[0]{rbuf}, $format, $len;	1740	my $data = substr $_[0]{rbuf}, $format, $len;
1689	substr $_[0]{rbuf}, 0, $format + $len, "";	1741	substr $_[0]{rbuf}, 0, $format + $len, "";
		1742
1690	$cb->($_[0], Storable::thaw ($data));	1743	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1744	or return $_[0]->_error (Errno::EBADMSG);
1691	} else {	1745	} else {
1692	# remove prefix	1746	# remove prefix
1693	substr $_[0]{rbuf}, 0, $format, "";	1747	substr $_[0]{rbuf}, 0, $format, "";
1694		1748
1695	# read remaining chunk	1749	# read remaining chunk
1696	$_[0]->unshift_read (chunk => $len, sub {	1750	$_[0]->unshift_read (chunk => $len, sub {
1697	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1751	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1698	$cb->($_[0], $ref);
1699	} else {
1700	$self->_error (Errno::EBADMSG);	1752	or $_[0]->_error (Errno::EBADMSG);
1701	}
1702	});	1753	});
1703	}	1754	}
1704		1755
1705	1	1756	1
1706	}	1757	}
…		…
1743	Note that AnyEvent::Handle will automatically C<start_read> for you when	1794	Note that AnyEvent::Handle will automatically C<start_read> for you when
1744	you change the C<on_read> callback or push/unshift a read callback, and it	1795	you change the C<on_read> callback or push/unshift a read callback, and it
1745	will automatically C<stop_read> for you when neither C<on_read> is set nor	1796	will automatically C<stop_read> for you when neither C<on_read> is set nor
1746	there are any read requests in the queue.	1797	there are any read requests in the queue.
1747		1798
1748	These methods will have no effect when in TLS mode (as TLS doesn't support	1799	In older versions of this module (<= 5.3), these methods had no effect,
1749	half-duplex connections).	1800	as TLS does not support half-duplex connections. In current versions they
		1801	work as expected, as this behaviour is required to avoid certain resource
		1802	attacks, where the program would be forced to read (and buffer) arbitrary
		1803	amounts of data before being able to send some data. The drawback is that
		1804	some readings of the the SSL/TLS specifications basically require this
		1805	attack to be working, as SSL/TLS implementations might stall sending data
		1806	during a rehandshake.
		1807
		1808	As a guideline, during the initial handshake, you should not stop reading,
		1809	and as a client, it might cause problems, depending on your application.
1750		1810
1751	=cut	1811	=cut
1752		1812
1753	sub stop_read {	1813	sub stop_read {
1754	my ($self) = @_;	1814	my ($self) = @_;
1755		1815
1756	delete $self->{_rw} unless $self->{tls};	1816	delete $self->{_rw};
1757	}	1817	}
1758		1818
1759	sub start_read {	1819	sub start_read {
1760	my ($self) = @_;	1820	my ($self) = @_;
1761		1821
…		…
1802	my ($self, $err) = @_;	1862	my ($self, $err) = @_;
1803		1863
1804	return $self->_error ($!, 1)	1864	return $self->_error ($!, 1)
1805	if $err == Net::SSLeay::ERROR_SYSCALL ();	1865	if $err == Net::SSLeay::ERROR_SYSCALL ();
1806		1866
1807	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1867	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1808		1868
1809	# reduce error string to look less scary	1869	# reduce error string to look less scary
1810	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1870	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1811		1871
1812	if ($self->{_on_starttls}) {	1872	if ($self->{_on_starttls}) {
…		…
1878		1938
1879	=item $handle->starttls ($tls[, $tls_ctx])	1939	=item $handle->starttls ($tls[, $tls_ctx])
1880		1940
1881	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1941	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1882	object is created, you can also do that at a later time by calling	1942	object is created, you can also do that at a later time by calling
1883	C<starttls>.	1943	C<starttls>. See the C<tls> constructor argument for general info.
1884		1944
1885	Starting TLS is currently an asynchronous operation - when you push some	1945	Starting TLS is currently an asynchronous operation - when you push some
1886	write data and then call C<< ->starttls >> then TLS negotiation will start	1946	write data and then call C<< ->starttls >> then TLS negotiation will start
1887	immediately, after which the queued write data is then sent.	1947	immediately, after which the queued write data is then sent. This might
		1948	change in future versions, so best make sure you have no outstanding write
		1949	data when calling this method.
1888		1950
1889	The first argument is the same as the C<tls> constructor argument (either	1951	The first argument is the same as the C<tls> constructor argument (either
1890	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1952	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1891		1953
1892	The second argument is the optional C<AnyEvent::TLS> object that is used	1954	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1914	my ($self, $tls, $ctx) = @_;	1976	my ($self, $tls, $ctx) = @_;
1915		1977
1916	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	1978	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1917	if $self->{tls};	1979	if $self->{tls};
1918		1980
		1981	unless (defined $AnyEvent::TLS::VERSION) {
		1982	eval {
		1983	require Net::SSLeay;
		1984	require AnyEvent::TLS;
		1985	1
		1986	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		1987	}
		1988
1919	$self->{tls} = $tls;	1989	$self->{tls} = $tls;
1920	$self->{tls_ctx} = $ctx if @_ > 2;	1990	$self->{tls_ctx} = $ctx if @_ > 2;
1921		1991
1922	return unless $self->{fh};	1992	return unless $self->{fh};
1923		1993
1924	require Net::SSLeay;
1925
1926	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1994	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1927	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1995	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1928		1996
1929	$tls = delete $self->{tls};	1997	$tls = delete $self->{tls};
1930	$ctx = $self->{tls_ctx};	1998	$ctx = $self->{tls_ctx};
1931		1999
1932	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2000	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1933		2001
1934	if ("HASH" eq ref $ctx) {	2002	if ("HASH" eq ref $ctx) {
1935	require AnyEvent::TLS;
1936
1937	if ($ctx->{cache}) {	2003	if ($ctx->{cache}) {
1938	my $key = $ctx+0;	2004	my $key = $ctx+0;
1939	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2005	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1940	} else {	2006	} else {
1941	$ctx = new AnyEvent::TLS %$ctx;	2007	$ctx = new AnyEvent::TLS %$ctx;
…		…
1963	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2029	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1964		2030
1965	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2031	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1966	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2032	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1967		2033
1968	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2034	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2035	$self->{rbuf} = "";
1969		2036
1970	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2037	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1971		2038
1972	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2039	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1973	if $self->{on_starttls};	2040	if $self->{on_starttls};
…		…
2010	$self->{tls_ctx}->_put_session (delete $self->{tls})	2077	$self->{tls_ctx}->_put_session (delete $self->{tls})
2011	if $self->{tls} > 0;	2078	if $self->{tls} > 0;
2012		2079
2013	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2080	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
2014	}	2081	}
		2082
		2083	=item $handle->resettls
		2084
		2085	This rarely-used method simply resets and TLS state on the handle, usually
		2086	causing data loss.
		2087
		2088	One case where it may be useful is when you want to skip over the data in
		2089	the stream but you are not interested in interpreting it, so data loss is
		2090	no concern.
		2091
		2092	=cut
		2093
		2094	*resettls = \&_freetls;
2015		2095
2016	sub DESTROY {	2096	sub DESTROY {
2017	my ($self) = @_;	2097	my ($self) = @_;
2018		2098
2019	&_freetls;	2099	&_freetls;
…		…
2135		2215
2136	It is only safe to "forget" the reference inside EOF or error callbacks,	2216	It is only safe to "forget" the reference inside EOF or error callbacks,
2137	from within all other callbacks, you need to explicitly call the C<<	2217	from within all other callbacks, you need to explicitly call the C<<
2138	->destroy >> method.	2218	->destroy >> method.
2139		2219
		2220	=item Why is my C<on_eof> callback never called?
		2221
		2222	Probably because your C<on_error> callback is being called instead: When
		2223	you have outstanding requests in your read queue, then an EOF is
		2224	considered an error as you clearly expected some data.
		2225
		2226	To avoid this, make sure you have an empty read queue whenever your handle
		2227	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2228	an C<on_read> handler that simply pushes the first read requests in the
		2229	queue.
		2230
		2231	See also the next question, which explains this in a bit more detail.
		2232
		2233	=item How can I serve requests in a loop?
		2234
		2235	Most protocols consist of some setup phase (authentication for example)
		2236	followed by a request handling phase, where the server waits for requests
		2237	and handles them, in a loop.
		2238
		2239	There are two important variants: The first (traditional, better) variant
		2240	handles requests until the server gets some QUIT command, causing it to
		2241	close the connection first (highly desirable for a busy TCP server). A
		2242	client dropping the connection is an error, which means this variant can
		2243	detect an unexpected detection close.
		2244
		2245	To handle this case, always make sure you have a non-empty read queue, by
		2246	pushing the "read request start" handler on it:
		2247
		2248	# we assume a request starts with a single line
		2249	my @start_request; @start_request = (line => sub {
		2250	my ($hdl, $line) = @_;
		2251
		2252	... handle request
		2253
		2254	# push next request read, possibly from a nested callback
		2255	$hdl->push_read (@start_request);
		2256	});
		2257
		2258	# auth done, now go into request handling loop
		2259	# now push the first @start_request
		2260	$hdl->push_read (@start_request);
		2261
		2262	By always having an outstanding C<push_read>, the handle always expects
		2263	some data and raises the C<EPIPE> error when the connction is dropped
		2264	unexpectedly.
		2265
		2266	The second variant is a protocol where the client can drop the connection
		2267	at any time. For TCP, this means that the server machine may run out of
		2268	sockets easier, and in general, it means you cannot distinguish a protocl
		2269	failure/client crash from a normal connection close. Nevertheless, these
		2270	kinds of protocols are common (and sometimes even the best solution to the
		2271	problem).
		2272
		2273	Having an outstanding read request at all times is possible if you ignore
		2274	C<EPIPE> errors, but this doesn't help with when the client drops the
		2275	connection during a request, which would still be an error.
		2276
		2277	A better solution is to push the initial request read in an C<on_read>
		2278	callback. This avoids an error, as when the server doesn't expect data
		2279	(i.e. is idly waiting for the next request, an EOF will not raise an
		2280	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2281	and simpler:
		2282
		2283	# auth done, now go into request handling loop
		2284	$hdl->on_read (sub {
		2285	my ($hdl) = @_;
		2286
		2287	# called each time we receive data but the read queue is empty
		2288	# simply start read the request
		2289
		2290	$hdl->push_read (line => sub {
		2291	my ($hdl, $line) = @_;
		2292
		2293	... handle request
		2294
		2295	# do nothing special when the request has been handled, just
		2296	# let the request queue go empty.
		2297	});
		2298	});
		2299
2140	=item I get different callback invocations in TLS mode/Why can't I pause	2300	=item I get different callback invocations in TLS mode/Why can't I pause
2141	reading?	2301	reading?
2142		2302
2143	Unlike, say, TCP, TLS connections do not consist of two independent	2303	Unlike, say, TCP, TLS connections do not consist of two independent
2144	communication channels, one for each direction. Or put differently, the	2304	communication channels, one for each direction. Or put differently, the
…		…
2165	$handle->on_eof (undef);	2325	$handle->on_eof (undef);
2166	$handle->on_error (sub {	2326	$handle->on_error (sub {
2167	my $data = delete $_[0]{rbuf};	2327	my $data = delete $_[0]{rbuf};
2168	});	2328	});
2169		2329
		2330	Note that this example removes the C<rbuf> member from the handle object,
		2331	which is not normally allowed by the API. It is expressly permitted in
		2332	this case only, as the handle object needs to be destroyed afterwards.
		2333
2170	The reason to use C<on_error> is that TCP connections, due to latencies	2334	The reason to use C<on_error> is that TCP connections, due to latencies
2171	and packets loss, might get closed quite violently with an error, when in	2335	and packets loss, might get closed quite violently with an error, when in
2172	fact all data has been received.	2336	fact all data has been received.
2173		2337
2174	It is usually better to use acknowledgements when transferring data,	2338	It is usually better to use acknowledgements when transferring data,
…		…
2184	C<low_water_mark> this will be called precisely when all data has been	2348	C<low_water_mark> this will be called precisely when all data has been
2185	written to the socket:	2349	written to the socket:
2186		2350
2187	$handle->push_write (...);	2351	$handle->push_write (...);
2188	$handle->on_drain (sub {	2352	$handle->on_drain (sub {
2189	warn "all data submitted to the kernel\n";	2353	AE::log debug => "All data submitted to the kernel.";
2190	undef $handle;	2354	undef $handle;
2191	});	2355	});
2192		2356
2193	If you just want to queue some data and then signal EOF to the other side,	2357	If you just want to queue some data and then signal EOF to the other side,
2194	consider using C<< ->push_shutdown >> instead.	2358	consider using C<< ->push_shutdown >> instead.
…		…
2278	When you have intermediate CA certificates that your clients might not	2442	When you have intermediate CA certificates that your clients might not
2279	know about, just append them to the C<cert_file>.	2443	know about, just append them to the C<cert_file>.
2280		2444
2281	=back	2445	=back
2282		2446
2283
2284	=head1 SUBCLASSING AnyEvent::Handle	2447	=head1 SUBCLASSING AnyEvent::Handle
2285		2448
2286	In many cases, you might want to subclass AnyEvent::Handle.	2449	In many cases, you might want to subclass AnyEvent::Handle.
2287		2450
2288	To make this easier, a given version of AnyEvent::Handle uses these	2451	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2314		2477
2315	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2478	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2316		2479
2317	=cut	2480	=cut
2318		2481
2319	1; # End of AnyEvent::Handle	2482	1
		2483

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.207 by root, Mon Nov 15 22:29:36 2010 UTC vs. Revision 1.235 by root, Tue May 8 19:41:22 2012 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.207 by root, Mon Nov 15 22:29:36 2010 UTC vs.
Revision 1.235 by root, Tue May 8 19:41:22 2012 UTC