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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC vs.
Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.22;	19	our $VERSION = 4.3;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detected,	84	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the EOF
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
85	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
86	waiting for data.	95	waiting for data.
		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
87		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal)
89		101
90	This is the error callback, which is called when, well, some error	102	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
96	usable. Non-fatal errors can be retried by simply returning, but it is	112	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	113	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		116
100	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		119
103	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
135	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
136		153
137	If non-zero, then this enables an "inactivity" timeout: whenever this many	154	If non-zero, then this enables an "inactivity" timeout: whenever this many
138	seconds pass without a successful read or write on the underlying file	155	seconds pass without a successful read or write on the underlying file
139	handle, the C<on_timeout> callback will be invoked (and if that one is	156	handle, the C<on_timeout> callback will be invoked (and if that one is
140	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
141		158
142	Note that timeout processing is also active when you currently do not have	159	Note that timeout processing is also active when you currently do not have
143	any outstanding read or write requests: If you plan to keep the connection	160	any outstanding read or write requests: If you plan to keep the connection
144	idle then you should disable the timout temporarily or ignore the timeout	161	idle then you should disable the timout temporarily or ignore the timeout
145	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
146		164
147	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
148		166
149	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
150		168
…		…
154		172
155	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
156		174
157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	175	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158	when the read buffer ever (strictly) exceeds this size. This is useful to	176	when the read buffer ever (strictly) exceeds this size. This is useful to
159	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
160		178
161	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
162	be configured to accept only so-and-so much data that it cannot act on	180	be configured to accept only so-and-so much data that it cannot act on
163	(for example, when expecting a line, an attacker could send an unlimited	181	(for example, when expecting a line, an attacker could send an unlimited
164	amount of data without a callback ever being called as long as the line	182	amount of data without a callback ever being called as long as the line
165	isn't finished).	183	isn't finished).
166		184
167	=item autocork => <boolean>	185	=item autocork => <boolean>
168		186
169	When disabled (the default), then C<push_write> will try to immediately	187	When disabled (the default), then C<push_write> will try to immediately
170	write the data to the handle if possible. This avoids having to register	188	write the data to the handle, if possible. This avoids having to register
171	a write watcher and wait for the next event loop iteration, but can be	189	a write watcher and wait for the next event loop iteration, but can
172	inefficient if you write multiple small chunks (this disadvantage is	190	be inefficient if you write multiple small chunks (on the wire, this
173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	191	disadvantage is usually avoided by your kernel's nagle algorithm, see
		192	C<no_delay>, but this option can save costly syscalls).
174		193
175	When enabled, then writes will always be queued till the next event loop	194	When enabled, then writes will always be queued till the next event loop
176	iteration. This is efficient when you do many small writes per iteration,	195	iteration. This is efficient when you do many small writes per iteration,
177	but less efficient when you do a single write only.	196	but less efficient when you do a single write only per iteration (or when
		197	the write buffer often is full). It also increases write latency.
178		198
179	=item no_delay => <boolean>	199	=item no_delay => <boolean>
180		200
181	When doing small writes on sockets, your operating system kernel might	201	When doing small writes on sockets, your operating system kernel might
182	wait a bit for more data before actually sending it out. This is called	202	wait a bit for more data before actually sending it out. This is called
183	the Nagle algorithm, and usually it is beneficial.	203	the Nagle algorithm, and usually it is beneficial.
184		204
185	In some situations you want as low a delay as possible, which cna be	205	In some situations you want as low a delay as possible, which can be
186	accomplishd by setting this option to true.	206	accomplishd by setting this option to a true value.
187		207
188	The default is your opertaing system's default behaviour, this option	208	The default is your opertaing system's default behaviour (most likely
189	explicitly enables or disables it, if possible.	209	enabled), this option explicitly enables or disables it, if possible.
190		210
191	=item read_size => <bytes>	211	=item read_size => <bytes>
192		212
193	The default read block size (the amount of bytes this module will try to read	213	The default read block size (the amount of bytes this module will
194	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
195		216
196	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
197		218
198	Sets the amount of bytes (default: C<0>) that make up an "empty" write	219	Sets the amount of bytes (default: C<0>) that make up an "empty" write
199	buffer: If the write reaches this size or gets even samller it is	220	buffer: If the write reaches this size or gets even samller it is
200	considered empty.	221	considered empty.
201		222
		223	Sometimes it can be beneficial (for performance reasons) to add data to
		224	the write buffer before it is fully drained, but this is a rare case, as
		225	the operating system kernel usually buffers data as well, so the default
		226	is good in almost all cases.
		227
202	=item linger => <seconds>	228	=item linger => <seconds>
203		229
204	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
205	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
206	data and will install a watcher that will write out this data. No errors	232	write data and will install a watcher that will write this data to the
207	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
208	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
209		235
210	This will not work for partial TLS data that could not yet been	236	This will not work for partial TLS data that could not be encoded
211	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
212		239
213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
214		241
215	When this parameter is given, it enables TLS (SSL) mode, that means it	242	When this parameter is given, it enables TLS (SSL) mode, that means
216	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
217	data.	244	established and will transparently encrypt/decrypt data afterwards.
218		245
219	TLS mode requires Net::SSLeay to be installed (it will be loaded	246	TLS mode requires Net::SSLeay to be installed (it will be loaded
220	automatically when you try to create a TLS handle).	247	automatically when you try to create a TLS handle): this module doesn't
		248	have a dependency on that module, so if your module requires it, you have
		249	to add the dependency yourself.
221		250
222	For the TLS server side, use C<accept>, and for the TLS client side of a	251	Unlike TCP, TLS has a server and client side: for the TLS server side, use
223	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
224		254
225	You can also provide your own TLS connection object, but you have	255	You can also provide your own TLS connection object, but you have
226	to make sure that you call either C<Net::SSLeay::set_connect_state>	256	to make sure that you call either C<Net::SSLeay::set_connect_state>
227	or C<Net::SSLeay::set_accept_state> on it before you pass it to	257	or C<Net::SSLeay::set_accept_state> on it before you pass it to
228	AnyEvent::Handle.	258	AnyEvent::Handle.
229		259
230	See the C<starttls> method if you need to start TLS negotiation later.	260	See the C<< ->starttls >> method for when need to start TLS negotiation later.
231		261
232	=item tls_ctx => $ssl_ctx	262	=item tls_ctx => $ssl_ctx
233		263
234	Use the given Net::SSLeay::CTX object to create the new TLS connection	264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
235	(unless a connection object was specified directly). If this parameter is	265	(unless a connection object was specified directly). If this parameter is
236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
237		267
238	=item json => JSON or JSON::XS object	268	=item json => JSON or JSON::XS object
239		269
240	This is the json coder object used by the C<json> read and write types.	270	This is the json coder object used by the C<json> read and write types.
241		271
242	If you don't supply it, then AnyEvent::Handle will create and use a	272	If you don't supply it, then AnyEvent::Handle will create and use a
243	suitable one, which will write and expect UTF-8 encoded JSON texts.	273	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		274	texts.
244		275
245	Note that you are responsible to depend on the JSON module if you want to	276	Note that you are responsible to depend on the JSON module if you want to
246	use this functionality, as AnyEvent does not have a dependency itself.	277	use this functionality, as AnyEvent does not have a dependency itself.
247		278
248	=item filter_r => $cb
249
250	=item filter_w => $cb
251
252	These exist, but are undocumented at this time.
253
254	=back	279	=back
255		280
256	=cut	281	=cut
257		282
258	sub new {	283	sub new {
…		…
262		287
263	$self->{fh} or Carp::croak "mandatory argument fh is missing";	288	$self->{fh} or Carp::croak "mandatory argument fh is missing";
264		289
265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
266		291
267	if ($self->{tls}) {
268	require Net::SSLeay;
269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
270	}	293	if $self->{tls};
271		294
272	$self->{_activity} = AnyEvent->now;	295	$self->{_activity} = AnyEvent->now;
273	$self->_timeout;	296	$self->_timeout;
274		297
275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
287	delete $self->{_tw};	310	delete $self->{_tw};
288	delete $self->{_rw};	311	delete $self->{_rw};
289	delete $self->{_ww};	312	delete $self->{_ww};
290	delete $self->{fh};	313	delete $self->{fh};
291		314
292	$self->stoptls;	315	&_freetls;
		316
		317	delete $self->{on_read};
		318	delete $self->{_queue};
293	}	319	}
294		320
295	sub _error {	321	sub _error {
296	my ($self, $errno, $fatal) = @_;	322	my ($self, $errno, $fatal) = @_;
297		323
…		…
300		326
301	$! = $errno;	327	$! = $errno;
302		328
303	if ($self->{on_error}) {	329	if ($self->{on_error}) {
304	$self->{on_error}($self, $fatal);	330	$self->{on_error}($self, $fatal);
305	} else {	331	} elsif ($self->{fh}) {
306	Carp::croak "AnyEvent::Handle uncaught error: $!";	332	Carp::croak "AnyEvent::Handle uncaught error: $!";
307	}	333	}
308	}	334	}
309		335
310	=item $fh = $handle->fh	336	=item $fh = $handle->fh
311		337
312	This method returns the file handle of the L<AnyEvent::Handle> object.	338	This method returns the file handle used to create the L<AnyEvent::Handle> object.
313		339
314	=cut	340	=cut
315		341
316	sub fh { $_[0]{fh} }	342	sub fh { $_[0]{fh} }
317		343
…		…
335	$_[0]{on_eof} = $_[1];	361	$_[0]{on_eof} = $_[1];
336	}	362	}
337		363
338	=item $handle->on_timeout ($cb)	364	=item $handle->on_timeout ($cb)
339		365
340	Replace the current C<on_timeout> callback, or disables the callback	366	Replace the current C<on_timeout> callback, or disables the callback (but
341	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	367	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
342	argument.	368	argument and method.
343		369
344	=cut	370	=cut
345		371
346	sub on_timeout {	372	sub on_timeout {
347	$_[0]{on_timeout} = $_[1];	373	$_[0]{on_timeout} = $_[1];
…		…
453	my ($self, $cb) = @_;	479	my ($self, $cb) = @_;
454		480
455	$self->{on_drain} = $cb;	481	$self->{on_drain} = $cb;
456		482
457	$cb->($self)	483	$cb->($self)
458	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	484	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
459	}	485	}
460		486
461	=item $handle->push_write ($data)	487	=item $handle->push_write ($data)
462		488
463	Queues the given scalar to be written. You can push as much data as you	489	Queues the given scalar to be written. You can push as much data as you
…		…
480	substr $self->{wbuf}, 0, $len, "";	506	substr $self->{wbuf}, 0, $len, "";
481		507
482	$self->{_activity} = AnyEvent->now;	508	$self->{_activity} = AnyEvent->now;
483		509
484	$self->{on_drain}($self)	510	$self->{on_drain}($self)
485	if $self->{low_water_mark} >= length $self->{wbuf}	511	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
486	&& $self->{on_drain};	512	&& $self->{on_drain};
487		513
488	delete $self->{_ww} unless length $self->{wbuf};	514	delete $self->{_ww} unless length $self->{wbuf};
489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	515	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
490	$self->_error ($!, 1);	516	$self->_error ($!, 1);
…		…
514		540
515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	541	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
516	->($self, @_);	542	->($self, @_);
517	}	543	}
518		544
519	if ($self->{filter_w}) {	545	if ($self->{tls}) {
520	$self->{filter_w}($self, \$_[0]);	546	$self->{_tls_wbuf} .= $_[0];
		547
		548	&_dotls ($self);
521	} else {	549	} else {
522	$self->{wbuf} .= $_[0];	550	$self->{wbuf} .= $_[0];
523	$self->_drain_wbuf;	551	$self->_drain_wbuf;
524	}	552	}
525	}	553	}
…		…
542	=cut	570	=cut
543		571
544	register_write_type netstring => sub {	572	register_write_type netstring => sub {
545	my ($self, $string) = @_;	573	my ($self, $string) = @_;
546		574
547	sprintf "%d:%s,", (length $string), $string	575	(length $string) . ":$string,"
548	};	576	};
549		577
550	=item packstring => $format, $data	578	=item packstring => $format, $data
551		579
552	An octet string prefixed with an encoded length. The encoding C<$format>	580	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
726		754
727	if (	755	if (
728	defined $self->{rbuf_max}	756	defined $self->{rbuf_max}
729	&& $self->{rbuf_max} < length $self->{rbuf}	757	&& $self->{rbuf_max} < length $self->{rbuf}
730	) {	758	) {
731	return $self->_error (&Errno::ENOSPC, 1);	759	$self->_error (&Errno::ENOSPC, 1), return;
732	}	760	}
733		761
734	while () {	762	while () {
735	no strict 'refs';
736
737	my $len = length $self->{rbuf};	763	my $len = length $self->{rbuf};
738		764
739	if (my $cb = shift @{ $self->{_queue} }) {	765	if (my $cb = shift @{ $self->{_queue} }) {
740	unless ($cb->($self)) {	766	unless ($cb->($self)) {
741	if ($self->{_eof}) {	767	if ($self->{_eof}) {
742	# no progress can be made (not enough data and no data forthcoming)	768	# no progress can be made (not enough data and no data forthcoming)
743	$self->_error (&Errno::EPIPE, 1), last;	769	$self->_error (&Errno::EPIPE, 1), return;
744	}	770	}
745		771
746	unshift @{ $self->{_queue} }, $cb;	772	unshift @{ $self->{_queue} }, $cb;
747	last;	773	last;
748	}	774	}
…		…
756	&& !@{ $self->{_queue} } # and the queue is still empty	782	&& !@{ $self->{_queue} } # and the queue is still empty
757	&& $self->{on_read} # but we still have on_read	783	&& $self->{on_read} # but we still have on_read
758	) {	784	) {
759	# no further data will arrive	785	# no further data will arrive
760	# so no progress can be made	786	# so no progress can be made
761	$self->_error (&Errno::EPIPE, 1), last	787	$self->_error (&Errno::EPIPE, 1), return
762	if $self->{_eof};	788	if $self->{_eof};
763		789
764	last; # more data might arrive	790	last; # more data might arrive
765	}	791	}
766	} else {	792	} else {
767	# read side becomes idle	793	# read side becomes idle
768	delete $self->{_rw};	794	delete $self->{_rw} unless $self->{tls};
769	last;	795	last;
770	}	796	}
771	}	797	}
772		798
		799	if ($self->{_eof}) {
		800	if ($self->{on_eof}) {
773	$self->{on_eof}($self)	801	$self->{on_eof}($self)
774	if $self->{_eof} && $self->{on_eof};	802	} else {
		803	$self->_error (0, 1);
		804	}
		805	}
775		806
776	# may need to restart read watcher	807	# may need to restart read watcher
777	unless ($self->{_rw}) {	808	unless ($self->{_rw}) {
778	$self->start_read	809	$self->start_read
779	if $self->{on_read} \|\| @{ $self->{_queue} };	810	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
904	$len <= length $_[0]{rbuf} or return;	935	$len <= length $_[0]{rbuf} or return;
905	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	936	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
906	1	937	1
907	}	938	}
908	};	939	};
909
910	# compatibility with older API
911	sub push_read_chunk {
912	$_[0]->push_read (chunk => $_[1], $_[2]);
913	}
914
915	sub unshift_read_chunk {
916	$_[0]->unshift_read (chunk => $_[1], $_[2]);
917	}
918		940
919	=item line => [$eol, ]$cb->($handle, $line, $eol)	941	=item line => [$eol, ]$cb->($handle, $line, $eol)
920		942
921	The callback will be called only once a full line (including the end of	943	The callback will be called only once a full line (including the end of
922	line marker, C<$eol>) has been read. This line (excluding the end of line	944	line marker, C<$eol>) has been read. This line (excluding the end of line
…		…
958	$cb->($_[0], $1, $2);	980	$cb->($_[0], $1, $2);
959	1	981	1
960	}	982	}
961	}	983	}
962	};	984	};
963
964	# compatibility with older API
965	sub push_read_line {
966	my $self = shift;
967	$self->push_read (line => @_);
968	}
969
970	sub unshift_read_line {
971	my $self = shift;
972	$self->unshift_read (line => @_);
973	}
974		985
975	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	986	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
976		987
977	Makes a regex match against the regex object C<$accept> and returns	988	Makes a regex match against the regex object C<$accept> and returns
978	everything up to and including the match.	989	everything up to and including the match.
…		…
1083	An octet string prefixed with an encoded length. The encoding C<$format>	1094	An octet string prefixed with an encoded length. The encoding C<$format>
1084	uses the same format as a Perl C<pack> format, but must specify a single	1095	uses the same format as a Perl C<pack> format, but must specify a single
1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1096	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1086	optional C<!>, C<< < >> or C<< > >> modifier).	1097	optional C<!>, C<< < >> or C<< > >> modifier).
1087		1098
1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1099	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1100	EPP uses a prefix of C<N> (4 octtes).
1089		1101
1090	Example: read a block of data prefixed by its length in BER-encoded	1102	Example: read a block of data prefixed by its length in BER-encoded
1091	format (very efficient).	1103	format (very efficient).
1092		1104
1093	$handle->push_read (packstring => "w", sub {	1105	$handle->push_read (packstring => "w", sub {
…		…
1102	sub {	1114	sub {
1103	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1115	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1104	defined (my $len = eval { unpack $format, $_[0]{rbuf} })	1116	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1105	or return;	1117	or return;
1106		1118
		1119	$format = length pack $format, $len;
		1120
		1121	# bypass unshift if we already have the remaining chunk
		1122	if ($format + $len <= length $_[0]{rbuf}) {
		1123	my $data = substr $_[0]{rbuf}, $format, $len;
		1124	substr $_[0]{rbuf}, 0, $format + $len, "";
		1125	$cb->($_[0], $data);
		1126	} else {
1107	# remove prefix	1127	# remove prefix
1108	substr $_[0]{rbuf}, 0, (length pack $format, $len), "";	1128	substr $_[0]{rbuf}, 0, $format, "";
1109		1129
1110	# read rest	1130	# read remaining chunk
1111	$_[0]->unshift_read (chunk => $len, $cb);	1131	$_[0]->unshift_read (chunk => $len, $cb);
		1132	}
1112		1133
1113	1	1134	1
1114	}	1135	}
1115	};	1136	};
1116		1137
…		…
1176	sub {	1197	sub {
1177	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1198	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1178	defined (my $len = eval { unpack "w", $_[0]{rbuf} })	1199	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1179	or return;	1200	or return;
1180		1201
		1202	my $format = length pack "w", $len;
		1203
		1204	# bypass unshift if we already have the remaining chunk
		1205	if ($format + $len <= length $_[0]{rbuf}) {
		1206	my $data = substr $_[0]{rbuf}, $format, $len;
		1207	substr $_[0]{rbuf}, 0, $format + $len, "";
		1208	$cb->($_[0], Storable::thaw ($data));
		1209	} else {
1181	# remove prefix	1210	# remove prefix
1182	substr $_[0]{rbuf}, 0, (length pack "w", $len), "";	1211	substr $_[0]{rbuf}, 0, $format, "";
1183		1212
1184	# read rest	1213	# read remaining chunk
1185	$_[0]->unshift_read (chunk => $len, sub {	1214	$_[0]->unshift_read (chunk => $len, sub {
1186	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1215	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1187	$cb->($_[0], $ref);	1216	$cb->($_[0], $ref);
1188	} else {	1217	} else {
1189	$self->_error (&Errno::EBADMSG);	1218	$self->_error (&Errno::EBADMSG);
		1219	}
1190	}	1220	});
1191	});	1221	}
		1222
		1223	1
1192	}	1224	}
1193	};	1225	};
1194		1226
1195	=back	1227	=back
1196		1228
…		…
1226	Note that AnyEvent::Handle will automatically C<start_read> for you when	1258	Note that AnyEvent::Handle will automatically C<start_read> for you when
1227	you change the C<on_read> callback or push/unshift a read callback, and it	1259	you change the C<on_read> callback or push/unshift a read callback, and it
1228	will automatically C<stop_read> for you when neither C<on_read> is set nor	1260	will automatically C<stop_read> for you when neither C<on_read> is set nor
1229	there are any read requests in the queue.	1261	there are any read requests in the queue.
1230		1262
		1263	These methods will have no effect when in TLS mode (as TLS doesn't support
		1264	half-duplex connections).
		1265
1231	=cut	1266	=cut
1232		1267
1233	sub stop_read {	1268	sub stop_read {
1234	my ($self) = @_;	1269	my ($self) = @_;
1235		1270
1236	delete $self->{_rw};	1271	delete $self->{_rw} unless $self->{tls};
1237	}	1272	}
1238		1273
1239	sub start_read {	1274	sub start_read {
1240	my ($self) = @_;	1275	my ($self) = @_;
1241		1276
1242	unless ($self->{_rw} \|\| $self->{_eof}) {	1277	unless ($self->{_rw} \|\| $self->{_eof}) {
1243	Scalar::Util::weaken $self;	1278	Scalar::Util::weaken $self;
1244		1279
1245	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1280	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1246	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1281	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1247	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1282	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1248		1283
1249	if ($len > 0) {	1284	if ($len > 0) {
1250	$self->{_activity} = AnyEvent->now;	1285	$self->{_activity} = AnyEvent->now;
1251		1286
1252	$self->{filter_r}	1287	if ($self->{tls}) {
1253	? $self->{filter_r}($self, $rbuf)	1288	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1254	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1289
		1290	&_dotls ($self);
		1291	} else {
		1292	$self->_drain_rbuf unless $self->{_in_drain};
		1293	}
1255		1294
1256	} elsif (defined $len) {	1295	} elsif (defined $len) {
1257	delete $self->{_rw};	1296	delete $self->{_rw};
1258	$self->{_eof} = 1;	1297	$self->{_eof} = 1;
1259	$self->_drain_rbuf unless $self->{_in_drain};	1298	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1263	}	1302	}
1264	});	1303	});
1265	}	1304	}
1266	}	1305	}
1267		1306
		1307	# poll the write BIO and send the data if applicable
1268	sub _dotls {	1308	sub _dotls {
1269	my ($self) = @_;	1309	my ($self) = @_;
1270		1310
1271	my $buf;	1311	my $tmp;
1272		1312
1273	if (length $self->{_tls_wbuf}) {	1313	if (length $self->{_tls_wbuf}) {
1274	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1275	substr $self->{_tls_wbuf}, 0, $len, "";	1315	substr $self->{_tls_wbuf}, 0, $tmp, "";
1276	}	1316	}
1277	}	1317	}
1278		1318
1279	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1280	$self->{wbuf} .= $buf;
1281	$self->_drain_wbuf;
1282	}
1283
1284	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1285	if (length $buf) {	1320	unless (length $tmp) {
1286	$self->{rbuf} .= $buf;
1287	$self->_drain_rbuf unless $self->{_in_drain};
1288	} else {
1289	# let's treat SSL-eof as we treat normal EOF	1321	# let's treat SSL-eof as we treat normal EOF
		1322	delete $self->{_rw};
1290	$self->{_eof} = 1;	1323	$self->{_eof} = 1;
1291	$self->_shutdown;	1324	&_freetls;
1292	return;
1293	}	1325	}
1294	}
1295		1326
		1327	$self->{rbuf} .= $tmp;
		1328	$self->_drain_rbuf unless $self->{_in_drain};
		1329	$self->{tls} or return; # tls session might have gone away in callback
		1330	}
		1331
1296	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1297		1333
1298	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1299	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1300	return $self->_error ($!, 1);	1336	return $self->_error ($!, 1);
1301	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1302	return $self->_error (&Errno::EIO, 1);	1338	return $self->_error (&Errno::EIO, 1);
1303	}	1339	}
1304		1340
1305	# all others are fine for our purposes	1341	# all other errors are fine for our purposes
		1342	}
		1343
		1344	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1345	$self->{wbuf} .= $tmp;
		1346	$self->_drain_wbuf;
1306	}	1347	}
1307	}	1348	}
1308		1349
1309	=item $handle->starttls ($tls[, $tls_ctx])	1350	=item $handle->starttls ($tls[, $tls_ctx])
1310		1351
…		…
1320		1361
1321	The TLS connection object will end up in C<< $handle->{tls} >> after this	1362	The TLS connection object will end up in C<< $handle->{tls} >> after this
1322	call and can be used or changed to your liking. Note that the handshake	1363	call and can be used or changed to your liking. Note that the handshake
1323	might have already started when this function returns.	1364	might have already started when this function returns.
1324		1365
		1366	If it an error to start a TLS handshake more than once per
		1367	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1368
1325	=cut	1369	=cut
1326		1370
1327	sub starttls {	1371	sub starttls {
1328	my ($self, $ssl, $ctx) = @_;	1372	my ($self, $ssl, $ctx) = @_;
1329		1373
1330	$self->stoptls;	1374	require Net::SSLeay;
1331		1375
		1376	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1377	if $self->{tls};
		1378
1332	if ($ssl eq "accept") {	1379	if ($ssl eq "accept") {
1333	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1380	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1334	Net::SSLeay::set_accept_state ($ssl);	1381	Net::SSLeay::set_accept_state ($ssl);
1335	} elsif ($ssl eq "connect") {	1382	} elsif ($ssl eq "connect") {
1336	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1342	# basically, this is deep magic (because SSL_read should have the same issues)	1389	# basically, this is deep magic (because SSL_read should have the same issues)
1343	# but the openssl maintainers basically said: "trust us, it just works".	1390	# but the openssl maintainers basically said: "trust us, it just works".
1344	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1345	# and mismaintained ssleay-module doesn't even offer them).	1392	# and mismaintained ssleay-module doesn't even offer them).
1346	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1393	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1394	#
		1395	# in short: this is a mess.
		1396	#
		1397	# note that we do not try to keep the length constant between writes as we are required to do.
		1398	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1399	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1400	# have identity issues in that area.
1347	Net::SSLeay::CTX_set_mode ($self->{tls},	1401	Net::SSLeay::CTX_set_mode ($self->{tls},
1348	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1349	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1403	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1350		1404
1351	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1352	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1353		1407
1354	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1408	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1355		1409
1356	$self->{filter_w} = sub {	1410	&_dotls; # need to trigger the initial handshake
1357	$_[0]{_tls_wbuf} .= ${$_[1]};	1411	$self->start_read; # make sure we actually do read
1358	&_dotls;
1359	};
1360	$self->{filter_r} = sub {
1361	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1362	&_dotls;
1363	};
1364	}	1412	}
1365		1413
1366	=item $handle->stoptls	1414	=item $handle->stoptls
1367		1415
1368	Destroys the SSL connection, if any. Partial read or write data will be	1416	Shuts down the SSL connection - this makes a proper EOF handshake by
1369	lost.	1417	sending a close notify to the other side, but since OpenSSL doesn't
		1418	support non-blocking shut downs, it is not possible to re-use the stream
		1419	afterwards.
1370		1420
1371	=cut	1421	=cut
1372		1422
1373	sub stoptls {	1423	sub stoptls {
1374	my ($self) = @_;	1424	my ($self) = @_;
1375		1425
		1426	if ($self->{tls}) {
		1427	Net::SSLeay::shutdown ($self->{tls});
		1428
		1429	&_dotls;
		1430
		1431	# we don't give a shit. no, we do, but we can't. no...
		1432	# we, we... have to use openssl :/
		1433	&_freetls;
		1434	}
		1435	}
		1436
		1437	sub _freetls {
		1438	my ($self) = @_;
		1439
		1440	return unless $self->{tls};
		1441
1376	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1442	Net::SSLeay::free (delete $self->{tls});
1377		1443
1378	delete $self->{_rbio};	1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1379	delete $self->{_wbio};
1380	delete $self->{_tls_wbuf};
1381	delete $self->{filter_r};
1382	delete $self->{filter_w};
1383	}	1445	}
1384		1446
1385	sub DESTROY {	1447	sub DESTROY {
1386	my $self = shift;	1448	my $self = shift;
1387		1449
1388	$self->stoptls;	1450	&_freetls;
1389		1451
1390	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1391		1453
1392	if ($linger && length $self->{wbuf}) {	1454	if ($linger && length $self->{wbuf}) {
1393	my $fh = delete $self->{fh};	1455	my $fh = delete $self->{fh};
…		…
1408	@linger = ();	1470	@linger = ();
1409	});	1471	});
1410	}	1472	}
1411	}	1473	}
1412		1474
		1475	=item $handle->destroy
		1476
		1477	Shuts down the handle object as much as possible - this call ensures that
		1478	no further callbacks will be invoked and resources will be freed as much
		1479	as possible. You must not call any methods on the object afterwards.
		1480
		1481	Normally, you can just "forget" any references to an AnyEvent::Handle
		1482	object and it will simply shut down. This works in fatal error and EOF
		1483	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1484	callback, so when you want to destroy the AnyEvent::Handle object from
		1485	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1486	that case.
		1487
		1488	The handle might still linger in the background and write out remaining
		1489	data, as specified by the C<linger> option, however.
		1490
		1491	=cut
		1492
		1493	sub destroy {
		1494	my ($self) = @_;
		1495
		1496	$self->DESTROY;
		1497	%$self = ();
		1498	}
		1499
1413	=item AnyEvent::Handle::TLS_CTX	1500	=item AnyEvent::Handle::TLS_CTX
1414		1501
1415	This function creates and returns the Net::SSLeay::CTX object used by	1502	This function creates and returns the Net::SSLeay::CTX object used by
1416	default for TLS mode.	1503	default for TLS mode.
1417		1504
…		…
1445	}	1532	}
1446	}	1533	}
1447		1534
1448	=back	1535	=back
1449		1536
		1537
		1538	=head1 NONFREQUENTLY ASKED QUESTIONS
		1539
		1540	=over 4
		1541
		1542	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1543	still get further invocations!
		1544
		1545	That's because AnyEvent::Handle keeps a reference to itself when handling
		1546	read or write callbacks.
		1547
		1548	It is only safe to "forget" the reference inside EOF or error callbacks,
		1549	from within all other callbacks, you need to explicitly call the C<<
		1550	->destroy >> method.
		1551
		1552	=item I get different callback invocations in TLS mode/Why can't I pause
		1553	reading?
		1554
		1555	Unlike, say, TCP, TLS connections do not consist of two independent
		1556	communication channels, one for each direction. Or put differently. The
		1557	read and write directions are not independent of each other: you cannot
		1558	write data unless you are also prepared to read, and vice versa.
		1559
		1560	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1561	callback invocations when you are not expecting any read data - the reason
		1562	is that AnyEvent::Handle always reads in TLS mode.
		1563
		1564	During the connection, you have to make sure that you always have a
		1565	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1566	connection (or when you no longer want to use it) you can call the
		1567	C<destroy> method.
		1568
		1569	=item How do I read data until the other side closes the connection?
		1570
		1571	If you just want to read your data into a perl scalar, the easiest way
		1572	to achieve this is by setting an C<on_read> callback that does nothing,
		1573	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1574	will be in C<$_[0]{rbuf}>:
		1575
		1576	$handle->on_read (sub { });
		1577	$handle->on_eof (undef);
		1578	$handle->on_error (sub {
		1579	my $data = delete $_[0]{rbuf};
		1580	undef $handle;
		1581	});
		1582
		1583	The reason to use C<on_error> is that TCP connections, due to latencies
		1584	and packets loss, might get closed quite violently with an error, when in
		1585	fact, all data has been received.
		1586
		1587	It is usually better to use acknowledgements when transferring data,
		1588	to make sure the other side hasn't just died and you got the data
		1589	intact. This is also one reason why so many internet protocols have an
		1590	explicit QUIT command.
		1591
		1592	=item I don't want to destroy the handle too early - how do I wait until
		1593	all data has been written?
		1594
		1595	After writing your last bits of data, set the C<on_drain> callback
		1596	and destroy the handle in there - with the default setting of
		1597	C<low_water_mark> this will be called precisely when all data has been
		1598	written to the socket:
		1599
		1600	$handle->push_write (...);
		1601	$handle->on_drain (sub {
		1602	warn "all data submitted to the kernel\n";
		1603	undef $handle;
		1604	});
		1605
		1606	=back
		1607
		1608
1450	=head1 SUBCLASSING AnyEvent::Handle	1609	=head1 SUBCLASSING AnyEvent::Handle
1451		1610
1452	In many cases, you might want to subclass AnyEvent::Handle.	1611	In many cases, you might want to subclass AnyEvent::Handle.
1453		1612
1454	To make this easier, a given version of AnyEvent::Handle uses these	1613	To make this easier, a given version of AnyEvent::Handle uses these

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC vs. Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC vs.
Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC