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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.200 by root, Tue Oct 12 06:47:54 2010 UTC vs.
Revision 1.233 by root, Thu Apr 5 06:14:10 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
…		…
75	}	75	}
76		76
77	\&$func	77	\&$func
78	}	78	}
79		79
		80	sub MAX_READ_SIZE() { 131072 }
		81
80	=head1 METHODS	82	=head1 METHODS
81		83
82	=over 4	84	=over 4
83		85
84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
…		…
112	=over 4	114	=over 4
113		115
114	=item on_prepare => $cb->($handle)	116	=item on_prepare => $cb->($handle)
115		117
116	This (rarely used) callback is called before a new connection is	118	This (rarely used) callback is called before a new connection is
117	attempted, but after the file handle has been created. It could be used to	119	attempted, but after the file handle has been created (you can access that
		120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
118	prepare the file handle with parameters required for the actual connect	121	file handle with parameters required for the actual connect (as opposed to
119	(as opposed to settings that can be changed when the connection is already	122	settings that can be changed when the connection is already established).
120	established).
121		123
122	The return value of this callback should be the connect timeout value in	124	The return value of this callback should be the connect timeout value in
123	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
124	default timeout is to be used).	126	default timeout is to be used).
125		127
126	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
127		129
128	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
129		131
130	The peer's numeric host and port (the socket peername) are passed as	132	The peer's numeric host and port (the socket peername) are passed as
131	parameters, together with a retry callback.	133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
132		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
133	If, for some reason, the handle is not acceptable, calling C<$retry>	140	If, for some reason, the handle is not acceptable, calling C<$retry> will
134	will continue with the next connection target (in case of multi-homed	141	continue with the next connection target (in case of multi-homed hosts or
135	hosts or SRV records there can be multiple connection endpoints). At the	142	SRV records there can be multiple connection endpoints). The C<$retry>
136	time it is called the read and write queues, eof status, tls status and	143	callback can be invoked after the connect callback returns, i.e. one can
137	similar properties of the handle will have been reset.	144	start a handshake and then decide to retry with the next host if the
		145	handshake fails.
138		146
139	In most cases, you should ignore the C<$retry> parameter.	147	In most cases, you should ignore the C<$retry> parameter.
140		148
141	=item on_connect_error => $cb->($handle, $message)	149	=item on_connect_error => $cb->($handle, $message)
142		150
…		…
157		165
158	Some errors are fatal (which is indicated by C<$fatal> being true). On	166	Some errors are fatal (which is indicated by C<$fatal> being true). On
159	fatal errors the handle object will be destroyed (by a call to C<< ->	167	fatal errors the handle object will be destroyed (by a call to C<< ->
160	destroy >>) after invoking the error callback (which means you are free to	168	destroy >>) after invoking the error callback (which means you are free to
161	examine the handle object). Examples of fatal errors are an EOF condition	169	examine the handle object). Examples of fatal errors are an EOF condition
162	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
163	cases where the other side can close the connection at will, it is	171	cases where the other side can close the connection at will, it is
164	often easiest to not report C<EPIPE> errors in this callback.	172	often easiest to not report C<EPIPE> errors in this callback.
165		173
166	AnyEvent::Handle tries to find an appropriate error code for you to check	174	AnyEvent::Handle tries to find an appropriate error code for you to check
167	against, but in some cases (TLS errors), this does not work well. It is	175	against, but in some cases (TLS errors), this does not work well.
168	recommended to always output the C<$message> argument in human-readable	176
169	error messages (it's usually the same as C<"$!">).	177	If you report the error to the user, it is recommended to always output
		178	the C<$message> argument in human-readable error messages (you don't need
		179	to report C<"$!"> if you report C<$message>).
		180
		181	If you want to react programmatically to the error, then looking at C<$!>
		182	and comparing it against some of the documented C<Errno> values is usually
		183	better than looking at the C<$message>.
170		184
171	Non-fatal errors can be retried by returning, but it is recommended	185	Non-fatal errors can be retried by returning, but it is recommended
172	to simply ignore this parameter and instead abondon the handle object	186	to simply ignore this parameter and instead abondon the handle object
173	when this callback is invoked. Examples of non-fatal errors are timeouts	187	when this callback is invoked. Examples of non-fatal errors are timeouts
174	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
222	If an EOF condition has been detected but no C<on_eof> callback has been	236	If an EOF condition has been detected but no C<on_eof> callback has been
223	set, then a fatal error will be raised with C<$!> set to <0>.	237	set, then a fatal error will be raised with C<$!> set to <0>.
224		238
225	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
226		240
227	This sets the callback that is called when the write buffer becomes empty	241	This sets the callback that is called once when the write buffer becomes
228	(or immediately if the buffer is empty already).	242	empty (and immediately when the handle object is created).
229		243
230	To append to the write buffer, use the C<< ->push_write >> method.	244	To append to the write buffer, use the C<< ->push_write >> method.
231		245
232	This callback is useful when you don't want to put all of your write data	246	This callback is useful when you don't want to put all of your write data
233	into the queue at once, for example, when you want to write the contents	247	into the queue at once, for example, when you want to write the contents
…		…
245	many seconds pass without a successful read or write on the underlying	259	many seconds pass without a successful read or write on the underlying
246	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
247	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
248	error will be raised).	262	error will be raised).
249		263
250	There are three variants of the timeouts that work independently	264	There are three variants of the timeouts that work independently of each
251	of each other, for both read and write, just read, and just write:	265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
252	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks	267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
253	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions	268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
254	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.	269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
255		270
256	Note that timeout processing is active even when you do not have	271	Note that timeout processing is active even when you do not have any
257	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
258	idle then you should disable the timeout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
259	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	274	timeout in the corresponding C<on_timeout> callback, in which case
260	restart the timeout.	275	AnyEvent::Handle will simply restart the timeout.
261		276
262	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
263		278
264	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
265		284
266	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
267	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
268	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
269		288
…		…
276	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
277	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
278	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
279	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
280	isn't finished).	299	isn't finished).
		300
		301	=item wbuf_max => <bytes>
		302
		303	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		304	when the write buffer ever (strictly) exceeds this size. This is useful to
		305	avoid some forms of denial-of-service attacks.
		306
		307	Although the units of this parameter is bytes, this is the I<raw> number
		308	of bytes not yet accepted by the kernel. This can make a difference when
		309	you e.g. use TLS, as TLS typically makes your write data larger (but it
		310	can also make it smaller due to compression).
		311
		312	As an example of when this limit is useful, take a chat server that sends
		313	chat messages to a client. If the client does not read those in a timely
		314	manner then the send buffer in the server would grow unbounded.
281		315
282	=item autocork => <boolean>	316	=item autocork => <boolean>
283		317
284	When disabled (the default), C<push_write> will try to immediately	318	When disabled (the default), C<push_write> will try to immediately
285	write the data to the handle if possible. This avoids having to register	319	write the data to the handle if possible. This avoids having to register
…		…
337	already have occured on BSD systems), but at least it will protect you	371	already have occured on BSD systems), but at least it will protect you
338	from most attacks.	372	from most attacks.
339		373
340	=item read_size => <bytes>	374	=item read_size => <bytes>
341		375
342	The default read block size (the number of bytes this module will	376	The initial read block size, the number of bytes this module will try
343	try to read during each loop iteration, which affects memory	377	to read during each loop iteration. Each handle object will consume
344	requirements). Default: C<8192>.	378	at least this amount of memory for the read buffer as well, so when
		379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
		381
		382	=item max_read_size => <bytes>
		383
		384	The maximum read buffer size used by the dynamic adjustment
		385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		386	one go it will double C<read_size> up to the maximum given by this
		387	option. Default: C<131072> or C<read_size>, whichever is higher.
345		388
346	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
347		390
348	Sets the number of bytes (default: C<0>) that make up an "empty" write	391	Sets the number of bytes (default: C<0>) that make up an "empty" write
349	buffer: If the buffer reaches this size or gets even samller it is	392	buffer: If the buffer reaches this size or gets even samller it is
…		…
412	Use the C<< ->starttls >> method if you need to start TLS negotiation later.	455	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
413		456
414	=item tls_ctx => $anyevent_tls	457	=item tls_ctx => $anyevent_tls
415		458
416	Use the given C<AnyEvent::TLS> object to create the new TLS connection	459	Use the given C<AnyEvent::TLS> object to create the new TLS connection
417	(unless a connection object was specified directly). If this parameter is	460	(unless a connection object was specified directly). If this
418	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	461	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		462	C<AnyEvent::Handle::TLS_CTX>.
419		463
420	Instead of an object, you can also specify a hash reference with C<< key	464	Instead of an object, you can also specify a hash reference with C<< key
421	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	465	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
422	new TLS context object.	466	new TLS context object.
423		467
…		…
492	$self->{connect}[0],	536	$self->{connect}[0],
493	$self->{connect}[1],	537	$self->{connect}[1],
494	sub {	538	sub {
495	my ($fh, $host, $port, $retry) = @_;	539	my ($fh, $host, $port, $retry) = @_;
496		540
		541	delete $self->{_connect}; # no longer needed
		542
497	if ($fh) {	543	if ($fh) {
498	$self->{fh} = $fh;	544	$self->{fh} = $fh;
499		545
500	delete $self->{_skip_drain_rbuf};	546	delete $self->{_skip_drain_rbuf};
501	$self->_start;	547	$self->_start;
…		…
508	});	554	});
509		555
510	} else {	556	} else {
511	if ($self->{on_connect_error}) {	557	if ($self->{on_connect_error}) {
512	$self->{on_connect_error}($self, "$!");	558	$self->{on_connect_error}($self, "$!");
513	$self->destroy;	559	$self->destroy if $self;
514	} else {	560	} else {
515	$self->_error ($!, 1);	561	$self->_error ($!, 1);
516	}	562	}
517	}	563	}
518	},	564	},
519	sub {	565	sub {
520	local $self->{fh} = $_[0];	566	local $self->{fh} = $_[0];
521		567
522	$self->{on_prepare}	568	$self->{on_prepare}
523	? $self->{on_prepare}->($self)	569	? $self->{on_prepare}->($self)
524	: ()	570	: ()
525	}	571	}
526	);	572	);
527	}	573	}
528		574
…		…
545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	591	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
546		592
547	$self->{_activity} =	593	$self->{_activity} =
548	$self->{_ractivity} =	594	$self->{_ractivity} =
549	$self->{_wactivity} = AE::now;	595	$self->{_wactivity} = AE::now;
		596
		597	$self->{read_size} \|\|= 2048;
		598	$self->{max_read_size} = $self->{read_size}
		599	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
550		600
551	$self->timeout (delete $self->{timeout} ) if $self->{timeout};	601	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
552	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};	602	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
553	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};	603	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
554		604
…		…
723		773
724	=item $handle->rbuf_max ($max_octets)	774	=item $handle->rbuf_max ($max_octets)
725		775
726	Configures the C<rbuf_max> setting (C<undef> disables it).	776	Configures the C<rbuf_max> setting (C<undef> disables it).
727		777
		778	=item $handle->wbuf_max ($max_octets)
		779
		780	Configures the C<wbuf_max> setting (C<undef> disables it).
		781
728	=cut	782	=cut
729		783
730	sub rbuf_max {	784	sub rbuf_max {
731	$_[0]{rbuf_max} = $_[1];	785	$_[0]{rbuf_max} = $_[1];
732	}	786	}
733		787
		788	sub wbuf_max {
		789	$_[0]{wbuf_max} = $_[1];
		790	}
		791
734	#############################################################################	792	#############################################################################
735		793
736	=item $handle->timeout ($seconds)	794	=item $handle->timeout ($seconds)
737		795
738	=item $handle->rtimeout ($seconds)	796	=item $handle->rtimeout ($seconds)
739		797
740	=item $handle->wtimeout ($seconds)	798	=item $handle->wtimeout ($seconds)
741		799
742	Configures (or disables) the inactivity timeout.	800	Configures (or disables) the inactivity timeout.
		801
		802	The timeout will be checked instantly, so this method might destroy the
		803	handle before it returns.
743		804
744	=item $handle->timeout_reset	805	=item $handle->timeout_reset
745		806
746	=item $handle->rtimeout_reset	807	=item $handle->rtimeout_reset
747		808
…		…
764	$_[0]{$on_timeout} = $_[1];	825	$_[0]{$on_timeout} = $_[1];
765	};	826	};
766		827
767	*$timeout = sub {	828	*$timeout = sub {
768	my ($self, $new_value) = @_;	829	my ($self, $new_value) = @_;
		830
		831	$new_value >= 0
		832	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
769		833
770	$self->{$timeout} = $new_value;	834	$self->{$timeout} = $new_value;
771	delete $self->{$tw}; &$cb;	835	delete $self->{$tw}; &$cb;
772	};	836	};
773		837
…		…
828		892
829	The write queue is very simple: you can add data to its end, and	893	The write queue is very simple: you can add data to its end, and
830	AnyEvent::Handle will automatically try to get rid of it for you.	894	AnyEvent::Handle will automatically try to get rid of it for you.
831		895
832	When data could be written and the write buffer is shorter then the low	896	When data could be written and the write buffer is shorter then the low
833	water mark, the C<on_drain> callback will be invoked.	897	water mark, the C<on_drain> callback will be invoked once.
834		898
835	=over 4	899	=over 4
836		900
837	=item $handle->on_drain ($cb)	901	=item $handle->on_drain ($cb)
838		902
…		…
853	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});	917	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
854	}	918	}
855		919
856	=item $handle->push_write ($data)	920	=item $handle->push_write ($data)
857		921
858	Queues the given scalar to be written. You can push as much data as you	922	Queues the given scalar to be written. You can push as much data as
859	want (only limited by the available memory), as C<AnyEvent::Handle>	923	you want (only limited by the available memory and C<wbuf_max>), as
860	buffers it independently of the kernel.	924	C<AnyEvent::Handle> buffers it independently of the kernel.
861		925
862	This method may invoke callbacks (and therefore the handle might be	926	This method may invoke callbacks (and therefore the handle might be
863	destroyed after it returns).	927	destroyed after it returns).
864		928
865	=cut	929	=cut
…		…
893	$cb->() unless $self->{autocork};	957	$cb->() unless $self->{autocork};
894		958
895	# if still data left in wbuf, we need to poll	959	# if still data left in wbuf, we need to poll
896	$self->{_ww} = AE::io $self->{fh}, 1, $cb	960	$self->{_ww} = AE::io $self->{fh}, 1, $cb
897	if length $self->{wbuf};	961	if length $self->{wbuf};
		962
		963	if (
		964	defined $self->{wbuf_max}
		965	&& $self->{wbuf_max} < length $self->{wbuf}
		966	) {
		967	$self->_error (Errno::ENOSPC, 1), return;
		968	}
898	};	969	};
899	}	970	}
900		971
901	our %WH;	972	our %WH;
902		973
…		…
1022	=cut	1093	=cut
1023		1094
1024	register_write_type storable => sub {	1095	register_write_type storable => sub {
1025	my ($self, $ref) = @_;	1096	my ($self, $ref) = @_;
1026		1097
1027	require Storable;	1098	require Storable unless $Storable::VERSION;
1028		1099
1029	pack "w/a*", Storable::nfreeze ($ref)	1100	pack "w/a*", Storable::nfreeze ($ref)
1030	};	1101	};
1031		1102
1032	=back	1103	=back
…		…
1037	before it was actually written. One way to do that is to replace your	1108	before it was actually written. One way to do that is to replace your
1038	C<on_drain> handler by a callback that shuts down the socket (and set	1109	C<on_drain> handler by a callback that shuts down the socket (and set
1039	C<low_water_mark> to C<0>). This method is a shorthand for just that, and	1110	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
1040	replaces the C<on_drain> callback with:	1111	replaces the C<on_drain> callback with:
1041		1112
1042	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1113	sub { shutdown $_[0]{fh}, 1 }
1043		1114
1044	This simply shuts down the write side and signals an EOF condition to the	1115	This simply shuts down the write side and signals an EOF condition to the
1045	the peer.	1116	the peer.
1046		1117
1047	You can rely on the normal read queue and C<on_eof> handling	1118	You can rely on the normal read queue and C<on_eof> handling
…		…
1069		1140
1070	Whenever the given C<type> is used, C<push_write> will the function with	1141	Whenever the given C<type> is used, C<push_write> will the function with
1071	the handle object and the remaining arguments.	1142	the handle object and the remaining arguments.
1072		1143
1073	The function is supposed to return a single octet string that will be	1144	The function is supposed to return a single octet string that will be
1074	appended to the write buffer, so you cna mentally treat this function as a	1145	appended to the write buffer, so you can mentally treat this function as a
1075	"arguments to on-the-wire-format" converter.	1146	"arguments to on-the-wire-format" converter.
1076		1147
1077	Example: implement a custom write type C<join> that joins the remaining	1148	Example: implement a custom write type C<join> that joins the remaining
1078	arguments using the first one.	1149	arguments using the first one.
1079		1150
…		…
1373	data.	1444	data.
1374		1445
1375	Example: read 2 bytes.	1446	Example: read 2 bytes.
1376		1447
1377	$handle->push_read (chunk => 2, sub {	1448	$handle->push_read (chunk => 2, sub {
1378	warn "yay ", unpack "H*", $_[1];	1449	say "yay " . unpack "H*", $_[1];
1379	});	1450	});
1380		1451
1381	=cut	1452	=cut
1382		1453
1383	register_read_type chunk => sub {	1454	register_read_type chunk => sub {
…		…
1417	if (@_ < 3) {	1488	if (@_ < 3) {
1418	# this is more than twice as fast as the generic code below	1489	# this is more than twice as fast as the generic code below
1419	sub {	1490	sub {
1420	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1491	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
1421		1492
1422	$cb->($_[0], $1, $2);	1493	$cb->($_[0], "$1", "$2");
1423	1	1494	1
1424	}	1495	}
1425	} else {	1496	} else {
1426	$eol = quotemeta $eol unless ref $eol;	1497	$eol = quotemeta $eol unless ref $eol;
1427	$eol = qr\|^(.*?)($eol)\|s;	1498	$eol = qr\|^(.*?)($eol)\|s;
1428		1499
1429	sub {	1500	sub {
1430	$_[0]{rbuf} =~ s/$eol// or return;	1501	$_[0]{rbuf} =~ s/$eol// or return;
1431		1502
1432	$cb->($_[0], $1, $2);	1503	$cb->($_[0], "$1", "$2");
1433	1	1504	1
1434	}	1505	}
1435	}	1506	}
1436	};	1507	};
1437		1508
…		…
1485		1556
1486	sub {	1557	sub {
1487	# accept	1558	# accept
1488	if ($$rbuf =~ $accept) {	1559	if ($$rbuf =~ $accept) {
1489	$data .= substr $$rbuf, 0, $+[0], "";	1560	$data .= substr $$rbuf, 0, $+[0], "";
1490	$cb->($self, $data);	1561	$cb->($_[0], $data);
1491	return 1;	1562	return 1;
1492	}	1563	}
1493		1564
1494	# reject	1565	# reject
1495	if ($reject && $$rbuf =~ $reject) {	1566	if ($reject && $$rbuf =~ $reject) {
1496	$self->_error (Errno::EBADMSG);	1567	$_[0]->_error (Errno::EBADMSG);
1497	}	1568	}
1498		1569
1499	# skip	1570	# skip
1500	if ($skip && $$rbuf =~ $skip) {	1571	if ($skip && $$rbuf =~ $skip) {
1501	$data .= substr $$rbuf, 0, $+[0], "";	1572	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1517	my ($self, $cb) = @_;	1588	my ($self, $cb) = @_;
1518		1589
1519	sub {	1590	sub {
1520	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1591	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1521	if ($_[0]{rbuf} =~ /[^0-9]/) {	1592	if ($_[0]{rbuf} =~ /[^0-9]/) {
1522	$self->_error (Errno::EBADMSG);	1593	$_[0]->_error (Errno::EBADMSG);
1523	}	1594	}
1524	return;	1595	return;
1525	}	1596	}
1526		1597
1527	my $len = $1;	1598	my $len = $1;
1528		1599
1529	$self->unshift_read (chunk => $len, sub {	1600	$_[0]->unshift_read (chunk => $len, sub {
1530	my $string = $_[1];	1601	my $string = $_[1];
1531	$_[0]->unshift_read (chunk => 1, sub {	1602	$_[0]->unshift_read (chunk => 1, sub {
1532	if ($_[1] eq ",") {	1603	if ($_[1] eq ",") {
1533	$cb->($_[0], $string);	1604	$cb->($_[0], $string);
1534	} else {	1605	} else {
1535	$self->_error (Errno::EBADMSG);	1606	$_[0]->_error (Errno::EBADMSG);
1536	}	1607	}
1537	});	1608	});
1538	});	1609	});
1539		1610
1540	1	1611	1
…		…
1613		1684
1614	my $data;	1685	my $data;
1615	my $rbuf = \$self->{rbuf};	1686	my $rbuf = \$self->{rbuf};
1616		1687
1617	sub {	1688	sub {
1618	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1689	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1619		1690
1620	if ($ref) {	1691	if ($ref) {
1621	$self->{rbuf} = $json->incr_text;	1692	$_[0]{rbuf} = $json->incr_text;
1622	$json->incr_text = "";	1693	$json->incr_text = "";
1623	$cb->($self, $ref);	1694	$cb->($_[0], $ref);
1624		1695
1625	1	1696	1
1626	} elsif ($@) {	1697	} elsif ($@) {
1627	# error case	1698	# error case
1628	$json->incr_skip;	1699	$json->incr_skip;
1629		1700
1630	$self->{rbuf} = $json->incr_text;	1701	$_[0]{rbuf} = $json->incr_text;
1631	$json->incr_text = "";	1702	$json->incr_text = "";
1632		1703
1633	$self->_error (Errno::EBADMSG);	1704	$_[0]->_error (Errno::EBADMSG);
1634		1705
1635	()	1706	()
1636	} else {	1707	} else {
1637	$self->{rbuf} = "";	1708	$_[0]{rbuf} = "";
1638		1709
1639	()	1710	()
1640	}	1711	}
1641	}	1712	}
1642	};	1713	};
…		…
1652	=cut	1723	=cut
1653		1724
1654	register_read_type storable => sub {	1725	register_read_type storable => sub {
1655	my ($self, $cb) = @_;	1726	my ($self, $cb) = @_;
1656		1727
1657	require Storable;	1728	require Storable unless $Storable::VERSION;
1658		1729
1659	sub {	1730	sub {
1660	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1731	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1661	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1732	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1662	or return;	1733	or return;
…		…
1665		1736
1666	# bypass unshift if we already have the remaining chunk	1737	# bypass unshift if we already have the remaining chunk
1667	if ($format + $len <= length $_[0]{rbuf}) {	1738	if ($format + $len <= length $_[0]{rbuf}) {
1668	my $data = substr $_[0]{rbuf}, $format, $len;	1739	my $data = substr $_[0]{rbuf}, $format, $len;
1669	substr $_[0]{rbuf}, 0, $format + $len, "";	1740	substr $_[0]{rbuf}, 0, $format + $len, "";
		1741
1670	$cb->($_[0], Storable::thaw ($data));	1742	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1743	or return $_[0]->_error (Errno::EBADMSG);
1671	} else {	1744	} else {
1672	# remove prefix	1745	# remove prefix
1673	substr $_[0]{rbuf}, 0, $format, "";	1746	substr $_[0]{rbuf}, 0, $format, "";
1674		1747
1675	# read remaining chunk	1748	# read remaining chunk
1676	$_[0]->unshift_read (chunk => $len, sub {	1749	$_[0]->unshift_read (chunk => $len, sub {
1677	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1750	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1678	$cb->($_[0], $ref);
1679	} else {
1680	$self->_error (Errno::EBADMSG);	1751	or $_[0]->_error (Errno::EBADMSG);
1681	}
1682	});	1752	});
1683	}	1753	}
1684		1754
1685	1	1755	1
1686	}	1756	}
…		…
1723	Note that AnyEvent::Handle will automatically C<start_read> for you when	1793	Note that AnyEvent::Handle will automatically C<start_read> for you when
1724	you change the C<on_read> callback or push/unshift a read callback, and it	1794	you change the C<on_read> callback or push/unshift a read callback, and it
1725	will automatically C<stop_read> for you when neither C<on_read> is set nor	1795	will automatically C<stop_read> for you when neither C<on_read> is set nor
1726	there are any read requests in the queue.	1796	there are any read requests in the queue.
1727		1797
1728	These methods will have no effect when in TLS mode (as TLS doesn't support	1798	In older versions of this module (<= 5.3), these methods had no effect,
1729	half-duplex connections).	1799	as TLS does not support half-duplex connections. In current versions they
		1800	work as expected, as this behaviour is required to avoid certain resource
		1801	attacks, where the program would be forced to read (and buffer) arbitrary
		1802	amounts of data before being able to send some data. The drawback is that
		1803	some readings of the the SSL/TLS specifications basically require this
		1804	attack to be working, as SSL/TLS implementations might stall sending data
		1805	during a rehandshake.
		1806
		1807	As a guideline, during the initial handshake, you should not stop reading,
		1808	and as a client, it might cause problems, depending on your application.
1730		1809
1731	=cut	1810	=cut
1732		1811
1733	sub stop_read {	1812	sub stop_read {
1734	my ($self) = @_;	1813	my ($self) = @_;
1735		1814
1736	delete $self->{_rw} unless $self->{tls};	1815	delete $self->{_rw};
1737	}	1816	}
1738		1817
1739	sub start_read {	1818	sub start_read {
1740	my ($self) = @_;	1819	my ($self) = @_;
1741		1820
1742	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {	1821	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1743	Scalar::Util::weaken $self;	1822	Scalar::Util::weaken $self;
1744		1823
1745	$self->{_rw} = AE::io $self->{fh}, 0, sub {	1824	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1746	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1825	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1747	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1826	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1748		1827
1749	if ($len > 0) {	1828	if ($len > 0) {
1750	$self->{_activity} = $self->{_ractivity} = AE::now;	1829	$self->{_activity} = $self->{_ractivity} = AE::now;
1751		1830
1752	if ($self->{tls}) {	1831	if ($self->{tls}) {
…		…
1755	&_dotls ($self);	1834	&_dotls ($self);
1756	} else {	1835	} else {
1757	$self->_drain_rbuf;	1836	$self->_drain_rbuf;
1758	}	1837	}
1759		1838
		1839	if ($len == $self->{read_size}) {
		1840	$self->{read_size} *= 2;
		1841	$self->{read_size} = $self->{max_read_size} \|\| MAX_READ_SIZE
		1842	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		1843	}
		1844
1760	} elsif (defined $len) {	1845	} elsif (defined $len) {
1761	delete $self->{_rw};	1846	delete $self->{_rw};
1762	$self->{_eof} = 1;	1847	$self->{_eof} = 1;
1763	$self->_drain_rbuf;	1848	$self->_drain_rbuf;
1764		1849
…		…
1776	my ($self, $err) = @_;	1861	my ($self, $err) = @_;
1777		1862
1778	return $self->_error ($!, 1)	1863	return $self->_error ($!, 1)
1779	if $err == Net::SSLeay::ERROR_SYSCALL ();	1864	if $err == Net::SSLeay::ERROR_SYSCALL ();
1780		1865
1781	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1866	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1782		1867
1783	# reduce error string to look less scary	1868	# reduce error string to look less scary
1784	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1869	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1785		1870
1786	if ($self->{_on_starttls}) {	1871	if ($self->{_on_starttls}) {
…		…
1937	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2022	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1938		2023
1939	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2024	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1940	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2025	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1941		2026
1942	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});	2027	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2028	$self->{rbuf} = "";
1943		2029
1944	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	2030	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1945		2031
1946	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	2032	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1947	if $self->{on_starttls};	2033	if $self->{on_starttls};
…		…
1985	if $self->{tls} > 0;	2071	if $self->{tls} > 0;
1986		2072
1987	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2073	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1988	}	2074	}
1989		2075
		2076	=item $handle->resettls
		2077
		2078	This rarely-used method simply resets and TLS state on the handle, usually
		2079	causing data loss.
		2080
		2081	One case where it may be useful is when you want to skip over the data in
		2082	the stream but you are not interested in interpreting it, so data loss is
		2083	no concern.
		2084
		2085	=cut
		2086
		2087	*resettls = \&_freetls;
		2088
1990	sub DESTROY {	2089	sub DESTROY {
1991	my ($self) = @_;	2090	my ($self) = @_;
1992		2091
1993	&_freetls;	2092	&_freetls;
1994		2093
…		…
2003	push @linger, AE::io $fh, 1, sub {	2102	push @linger, AE::io $fh, 1, sub {
2004	my $len = syswrite $fh, $wbuf, length $wbuf;	2103	my $len = syswrite $fh, $wbuf, length $wbuf;
2005		2104
2006	if ($len > 0) {	2105	if ($len > 0) {
2007	substr $wbuf, 0, $len, "";	2106	substr $wbuf, 0, $len, "";
2008	} else {	2107	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
2009	@linger = (); # end	2108	@linger = (); # end
2010	}	2109	}
2011	};	2110	};
2012	push @linger, AE::timer $linger, 0, sub {	2111	push @linger, AE::timer $linger, 0, sub {
2013	@linger = ();	2112	@linger = ();
…		…
2109		2208
2110	It is only safe to "forget" the reference inside EOF or error callbacks,	2209	It is only safe to "forget" the reference inside EOF or error callbacks,
2111	from within all other callbacks, you need to explicitly call the C<<	2210	from within all other callbacks, you need to explicitly call the C<<
2112	->destroy >> method.	2211	->destroy >> method.
2113		2212
		2213	=item Why is my C<on_eof> callback never called?
		2214
		2215	Probably because your C<on_error> callback is being called instead: When
		2216	you have outstanding requests in your read queue, then an EOF is
		2217	considered an error as you clearly expected some data.
		2218
		2219	To avoid this, make sure you have an empty read queue whenever your handle
		2220	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2221	an C<on_read> handler that simply pushes the first read requests in the
		2222	queue.
		2223
		2224	See also the next question, which explains this in a bit more detail.
		2225
		2226	=item How can I serve requests in a loop?
		2227
		2228	Most protocols consist of some setup phase (authentication for example)
		2229	followed by a request handling phase, where the server waits for requests
		2230	and handles them, in a loop.
		2231
		2232	There are two important variants: The first (traditional, better) variant
		2233	handles requests until the server gets some QUIT command, causing it to
		2234	close the connection first (highly desirable for a busy TCP server). A
		2235	client dropping the connection is an error, which means this variant can
		2236	detect an unexpected detection close.
		2237
		2238	To handle this case, always make sure you have a on-empty read queue, by
		2239	pushing the "read request start" handler on it:
		2240
		2241	# we assume a request starts with a single line
		2242	my @start_request; @start_request = (line => sub {
		2243	my ($hdl, $line) = @_;
		2244
		2245	... handle request
		2246
		2247	# push next request read, possibly from a nested callback
		2248	$hdl->push_read (@start_request);
		2249	});
		2250
		2251	# auth done, now go into request handling loop
		2252	# now push the first @start_request
		2253	$hdl->push_read (@start_request);
		2254
		2255	By always having an outstanding C<push_read>, the handle always expects
		2256	some data and raises the C<EPIPE> error when the connction is dropped
		2257	unexpectedly.
		2258
		2259	The second variant is a protocol where the client can drop the connection
		2260	at any time. For TCP, this means that the server machine may run out of
		2261	sockets easier, and in general, it means you cannot distinguish a protocl
		2262	failure/client crash from a normal connection close. Nevertheless, these
		2263	kinds of protocols are common (and sometimes even the best solution to the
		2264	problem).
		2265
		2266	Having an outstanding read request at all times is possible if you ignore
		2267	C<EPIPE> errors, but this doesn't help with when the client drops the
		2268	connection during a request, which would still be an error.
		2269
		2270	A better solution is to push the initial request read in an C<on_read>
		2271	callback. This avoids an error, as when the server doesn't expect data
		2272	(i.e. is idly waiting for the next request, an EOF will not raise an
		2273	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2274	and simpler:
		2275
		2276	# auth done, now go into request handling loop
		2277	$hdl->on_read (sub {
		2278	my ($hdl) = @_;
		2279
		2280	# called each time we receive data but the read queue is empty
		2281	# simply start read the request
		2282
		2283	$hdl->push_read (line => sub {
		2284	my ($hdl, $line) = @_;
		2285
		2286	... handle request
		2287
		2288	# do nothing special when the request has been handled, just
		2289	# let the request queue go empty.
		2290	});
		2291	});
		2292
2114	=item I get different callback invocations in TLS mode/Why can't I pause	2293	=item I get different callback invocations in TLS mode/Why can't I pause
2115	reading?	2294	reading?
2116		2295
2117	Unlike, say, TCP, TLS connections do not consist of two independent	2296	Unlike, say, TCP, TLS connections do not consist of two independent
2118	communication channels, one for each direction. Or put differently, the	2297	communication channels, one for each direction. Or put differently, the
…		…
2139	$handle->on_eof (undef);	2318	$handle->on_eof (undef);
2140	$handle->on_error (sub {	2319	$handle->on_error (sub {
2141	my $data = delete $_[0]{rbuf};	2320	my $data = delete $_[0]{rbuf};
2142	});	2321	});
2143		2322
		2323	Note that this example removes the C<rbuf> member from the handle object,
		2324	which is not normally allowed by the API. It is expressly permitted in
		2325	this case only, as the handle object needs to be destroyed afterwards.
		2326
2144	The reason to use C<on_error> is that TCP connections, due to latencies	2327	The reason to use C<on_error> is that TCP connections, due to latencies
2145	and packets loss, might get closed quite violently with an error, when in	2328	and packets loss, might get closed quite violently with an error, when in
2146	fact all data has been received.	2329	fact all data has been received.
2147		2330
2148	It is usually better to use acknowledgements when transferring data,	2331	It is usually better to use acknowledgements when transferring data,
…		…
2158	C<low_water_mark> this will be called precisely when all data has been	2341	C<low_water_mark> this will be called precisely when all data has been
2159	written to the socket:	2342	written to the socket:
2160		2343
2161	$handle->push_write (...);	2344	$handle->push_write (...);
2162	$handle->on_drain (sub {	2345	$handle->on_drain (sub {
2163	warn "all data submitted to the kernel\n";	2346	AE::log debug => "All data submitted to the kernel.";
2164	undef $handle;	2347	undef $handle;
2165	});	2348	});
2166		2349
2167	If you just want to queue some data and then signal EOF to the other side,	2350	If you just want to queue some data and then signal EOF to the other side,
2168	consider using C<< ->push_shutdown >> instead.	2351	consider using C<< ->push_shutdown >> instead.
…		…
2252	When you have intermediate CA certificates that your clients might not	2435	When you have intermediate CA certificates that your clients might not
2253	know about, just append them to the C<cert_file>.	2436	know about, just append them to the C<cert_file>.
2254		2437
2255	=back	2438	=back
2256		2439
2257
2258	=head1 SUBCLASSING AnyEvent::Handle	2440	=head1 SUBCLASSING AnyEvent::Handle
2259		2441
2260	In many cases, you might want to subclass AnyEvent::Handle.	2442	In many cases, you might want to subclass AnyEvent::Handle.
2261		2443
2262	To make this easier, a given version of AnyEvent::Handle uses these	2444	To make this easier, a given version of AnyEvent::Handle uses these
…		…
2288		2470
2289	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2471	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
2290		2472
2291	=cut	2473	=cut
2292		2474
2293	1; # End of AnyEvent::Handle	2475	1
		2476

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.200 by root, Tue Oct 12 06:47:54 2010 UTC vs. Revision 1.233 by root, Thu Apr 5 06:14:10 2012 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.200 by root, Tue Oct 12 06:47:54 2010 UTC vs.
Revision 1.233 by root, Thu Apr 5 06:14:10 2012 UTC