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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs.
Revision 1.83 by root, Thu Aug 21 19:11:37 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 = '0.04';	19	our $VERSION = 4.232;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
70		70
71	=item fh => $filehandle [MANDATORY]	71	=item fh => $filehandle [MANDATORY]
72		72
73	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
74		74
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	76	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		77	that mode.
77		78
78	=item on_eof => $cb->($handle)	79	=item on_eof => $cb->($handle)
79		80
80	Set the callback to be called on EOF.	81	Set the callback to be called when an end-of-file condition is detected,
		82	i.e. in the case of a socket, when the other side has closed the
		83	connection cleanly.
81		84
		85	For sockets, this just means that the other side has stopped sending data,
		86	you can still try to write data, and, in fact, one can return from the eof
		87	callback and continue writing data, as only the read part has been shut
		88	down.
		89
82	While not mandatory, it is highly recommended to set an eof callback,	90	While not mandatory, it is I<highly> recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	91	otherwise you might end up with a closed socket while you are still
84	waiting for data.	92	waiting for data.
85		93
		94	If an EOF condition has been detected but no C<on_eof> callback has been
		95	set, then a fatal error will be raised with C<$!> set to <0>.
		96
86	=item on_error => $cb->($handle)	97	=item on_error => $cb->($handle, $fatal)
87		98
88	This is the fatal error callback, that is called when, well, a fatal error	99	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	100	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	101	connect or a read error.
91		102
92	The object will not be in a usable state when this callback has been	103	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	104	fatal errors the handle object will be shut down and will not be usable
		105	(but you are free to look at the current C< ->rbuf >). Examples of fatal
		106	errors are an EOF condition with active (but unsatisifable) read watchers
		107	(C<EPIPE>) or I/O errors.
		108
		109	Non-fatal errors can be retried by simply returning, but it is recommended
		110	to simply ignore this parameter and instead abondon the handle object
		111	when this callback is invoked. Examples of non-fatal errors are timeouts
		112	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		113
95	On callback entrance, the value of C<$!> contains the operating system	114	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	115	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		116
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100
101	While not mandatory, it is I<highly> recommended to set this callback, as	117	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	118	you will not be notified of errors otherwise. The default simply calls
103	die.	119	C<croak>.
104		120
105	=item on_read => $cb->($handle)	121	=item on_read => $cb->($handle)
106		122
107	This sets the default read callback, which is called when data arrives	123	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	124	and no read request is in the queue (unlike read queue callbacks, this
		125	callback will only be called when at least one octet of data is in the
		126	read buffer).
109		127
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	128	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	129	method or access the C<$handle->{rbuf}> member directly.
112		130
113	When an EOF condition is detected then AnyEvent::Handle will first try to	131	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
119		137
120	This sets the callback that is called when the write buffer becomes empty	138	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	139	(or when the callback is set and the buffer is empty already).
122		140
123	To append to the write buffer, use the C<< ->push_write >> method.	141	To append to the write buffer, use the C<< ->push_write >> method.
		142
		143	This callback is useful when you don't want to put all of your write data
		144	into the queue at once, for example, when you want to write the contents
		145	of some file to the socket you might not want to read the whole file into
		146	memory and push it into the queue, but instead only read more data from
		147	the file when the write queue becomes empty.
124		148
125	=item timeout => $fractional_seconds	149	=item timeout => $fractional_seconds
126		150
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	151	If non-zero, then this enables an "inactivity" timeout: whenever this many
128	seconds pass without a successful read or write on the underlying file	152	seconds pass without a successful read or write on the underlying file
…		…
152	be configured to accept only so-and-so much data that it cannot act on	176	be configured to accept only so-and-so much data that it cannot act on
153	(for example, when expecting a line, an attacker could send an unlimited	177	(for example, when expecting a line, an attacker could send an unlimited
154	amount of data without a callback ever being called as long as the line	178	amount of data without a callback ever being called as long as the line
155	isn't finished).	179	isn't finished).
156		180
		181	=item autocork => <boolean>
		182
		183	When disabled (the default), then C<push_write> will try to immediately
		184	write the data to the handle if possible. This avoids having to register
		185	a write watcher and wait for the next event loop iteration, but can be
		186	inefficient if you write multiple small chunks (this disadvantage is
		187	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		188
		189	When enabled, then writes will always be queued till the next event loop
		190	iteration. This is efficient when you do many small writes per iteration,
		191	but less efficient when you do a single write only.
		192
		193	=item no_delay => <boolean>
		194
		195	When doing small writes on sockets, your operating system kernel might
		196	wait a bit for more data before actually sending it out. This is called
		197	the Nagle algorithm, and usually it is beneficial.
		198
		199	In some situations you want as low a delay as possible, which cna be
		200	accomplishd by setting this option to true.
		201
		202	The default is your opertaing system's default behaviour, this option
		203	explicitly enables or disables it, if possible.
		204
157	=item read_size => <bytes>	205	=item read_size => <bytes>
158		206
159	The default read block size (the amount of bytes this module will try to read	207	The default read block size (the amount of bytes this module will try to read
160	during each (loop iteration). Default: C<8192>.	208	during each (loop iteration). Default: C<8192>.
161		209
162	=item low_water_mark => <bytes>	210	=item low_water_mark => <bytes>
163		211
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	212	Sets the amount of bytes (default: C<0>) that make up an "empty" write
165	buffer: If the write reaches this size or gets even samller it is	213	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	214	considered empty.
		215
		216	=item linger => <seconds>
		217
		218	If non-zero (default: C<3600>), then the destructor of the
		219	AnyEvent::Handle object will check wether there is still outstanding write
		220	data and will install a watcher that will write out this data. No errors
		221	will be reported (this mostly matches how the operating system treats
		222	outstanding data at socket close time).
		223
		224	This will not work for partial TLS data that could not yet been
		225	encoded. This data will be lost.
167		226
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	227	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		228
170	When this parameter is given, it enables TLS (SSL) mode, that means it	229	When this parameter is given, it enables TLS (SSL) mode, that means it
171	will start making tls handshake and will transparently encrypt/decrypt	230	will start making tls handshake and will transparently encrypt/decrypt
…		…
180	You can also provide your own TLS connection object, but you have	239	You can also provide your own TLS connection object, but you have
181	to make sure that you call either C<Net::SSLeay::set_connect_state>	240	to make sure that you call either C<Net::SSLeay::set_connect_state>
182	or C<Net::SSLeay::set_accept_state> on it before you pass it to	241	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	242	AnyEvent::Handle.
184		243
185	See the C<starttls> method if you need to start TLs negotiation later.	244	See the C<starttls> method if you need to start TLS negotiation later.
186		245
187	=item tls_ctx => $ssl_ctx	246	=item tls_ctx => $ssl_ctx
188		247
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	248	Use the given Net::SSLeay::CTX object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	249	(unless a connection object was specified directly). If this parameter is
…		…
222	if ($self->{tls}) {	281	if ($self->{tls}) {
223	require Net::SSLeay;	282	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	283	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}	284	}
226		285
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231
232	$self->{_activity} = AnyEvent->now;	286	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	287	$self->_timeout;
234		288
		289	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		290	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		291
235	$self->start_read;	292	$self->start_read
		293	if $self->{on_read};
236		294
237	$self	295	$self
238	}	296	}
239		297
240	sub _shutdown {	298	sub _shutdown {
…		…
242		300
243	delete $self->{_tw};	301	delete $self->{_tw};
244	delete $self->{_rw};	302	delete $self->{_rw};
245	delete $self->{_ww};	303	delete $self->{_ww};
246	delete $self->{fh};	304	delete $self->{fh};
247	}
248		305
		306	$self->stoptls;
		307
		308	delete $self->{on_read};
		309	delete $self->{_queue};
		310	}
		311
249	sub error {	312	sub _error {
250	my ($self) = @_;	313	my ($self, $errno, $fatal) = @_;
251		314
252	{
253	local $!;
254	$self->_shutdown;	315	$self->_shutdown
255	}	316	if $fatal;
256		317
257	$self->{on_error}($self)	318	$! = $errno;
		319
258	if $self->{on_error};	320	if ($self->{on_error}) {
259		321	$self->{on_error}($self, $fatal);
		322	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	323	Carp::croak "AnyEvent::Handle uncaught error: $!";
		324	}
261	}	325	}
262		326
263	=item $fh = $handle->fh	327	=item $fh = $handle->fh
264		328
265	This method returns the file handle of the L<AnyEvent::Handle> object.	329	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
296		360
297	=cut	361	=cut
298		362
299	sub on_timeout {	363	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	364	$_[0]{on_timeout} = $_[1];
		365	}
		366
		367	=item $handle->autocork ($boolean)
		368
		369	Enables or disables the current autocork behaviour (see C<autocork>
		370	constructor argument).
		371
		372	=cut
		373
		374	=item $handle->no_delay ($boolean)
		375
		376	Enables or disables the C<no_delay> setting (see constructor argument of
		377	the same name for details).
		378
		379	=cut
		380
		381	sub no_delay {
		382	$_[0]{no_delay} = $_[1];
		383
		384	eval {
		385	local $SIG{__DIE__};
		386	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		387	};
301	}	388	}
302		389
303	#############################################################################	390	#############################################################################
304		391
305	=item $handle->timeout ($seconds)	392	=item $handle->timeout ($seconds)
…		…
329	# now or in the past already?	416	# now or in the past already?
330	if ($after <= 0) {	417	if ($after <= 0) {
331	$self->{_activity} = $NOW;	418	$self->{_activity} = $NOW;
332		419
333	if ($self->{on_timeout}) {	420	if ($self->{on_timeout}) {
334	$self->{on_timeout}->($self);	421	$self->{on_timeout}($self);
335	} else {	422	} else {
336	$! = Errno::ETIMEDOUT;	423	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	424	}
339		425
340	# callbakx could have changed timeout value, optimise	426	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	427	return unless $self->{timeout};
342		428
343	# calculate new after	429	# calculate new after
344	$after = $self->{timeout};	430	$after = $self->{timeout};
345	}	431	}
346		432
347	Scalar::Util::weaken $self;	433	Scalar::Util::weaken $self;
		434	return unless $self; # ->error could have destroyed $self
348		435
349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	436	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	437	delete $self->{_tw};
351	$self->_timeout;	438	$self->_timeout;
352	});	439	});
…		…
415	if $self->{low_water_mark} >= length $self->{wbuf}	502	if $self->{low_water_mark} >= length $self->{wbuf}
416	&& $self->{on_drain};	503	&& $self->{on_drain};
417		504
418	delete $self->{_ww} unless length $self->{wbuf};	505	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	506	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	507	$self->_error ($!, 1);
421	}	508	}
422	};	509	};
423		510
424	# try to write data immediately	511	# try to write data immediately
425	$cb->();	512	$cb->() unless $self->{autocork};
426		513
427	# if still data left in wbuf, we need to poll	514	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	515	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	516	if length $self->{wbuf};
430	};	517	};
…		…
445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	532	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
446	->($self, @_);	533	->($self, @_);
447	}	534	}
448		535
449	if ($self->{filter_w}) {	536	if ($self->{filter_w}) {
450	$self->{filter_w}->($self, \$_[0]);	537	$self->{filter_w}($self, \$_[0]);
451	} else {	538	} else {
452	$self->{wbuf} .= $_[0];	539	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	540	$self->_drain_wbuf;
454	}	541	}
455	}	542	}
456		543
457	=item $handle->push_write (type => @args)	544	=item $handle->push_write (type => @args)
458		545
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	546	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	547	the job by specifying a type and type-specific arguments.
463		548
464	Predefined types are (if you have ideas for additional types, feel free to	549	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	550	drop by and tell us):
…		…
469	=item netstring => $string	554	=item netstring => $string
470		555
471	Formats the given value as netstring	556	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	557	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		558
474	=back
475
476	=cut	559	=cut
477		560
478	register_write_type netstring => sub {	561	register_write_type netstring => sub {
479	my ($self, $string) = @_;	562	my ($self, $string) = @_;
480		563
481	sprintf "%d:%s,", (length $string), $string	564	sprintf "%d:%s,", (length $string), $string
		565	};
		566
		567	=item packstring => $format, $data
		568
		569	An octet string prefixed with an encoded length. The encoding C<$format>
		570	uses the same format as a Perl C<pack> format, but must specify a single
		571	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		572	optional C<!>, C<< < >> or C<< > >> modifier).
		573
		574	=cut
		575
		576	register_write_type packstring => sub {
		577	my ($self, $format, $string) = @_;
		578
		579	pack "$format/a*", $string
482	};	580	};
483		581
484	=item json => $array_or_hashref	582	=item json => $array_or_hashref
485		583
486	Encodes the given hash or array reference into a JSON object. Unless you	584	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		618
521	$self->{json} ? $self->{json}->encode ($ref)	619	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	620	: JSON::encode_json ($ref)
523	};	621	};
524		622
		623	=item storable => $reference
		624
		625	Freezes the given reference using L<Storable> and writes it to the
		626	handle. Uses the C<nfreeze> format.
		627
		628	=cut
		629
		630	register_write_type storable => sub {
		631	my ($self, $ref) = @_;
		632
		633	require Storable;
		634
		635	pack "w/a*", Storable::nfreeze ($ref)
		636	};
		637
		638	=back
		639
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	640	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		641
527	This function (not method) lets you add your own types to C<push_write>.	642	This function (not method) lets you add your own types to C<push_write>.
528	Whenever the given C<type> is used, C<push_write> will invoke the code	643	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	644	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	664	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	665	a queue.
551		666
552	In the simple case, you just install an C<on_read> callback and whenever	667	In the simple case, you just install an C<on_read> callback and whenever
553	new data arrives, it will be called. You can then remove some data (if	668	new data arrives, it will be called. You can then remove some data (if
554	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	669	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	670	leave the data there if you want to accumulate more (e.g. when only a
		671	partial message has been received so far).
556		672
557	In the more complex case, you want to queue multiple callbacks. In this	673	In the more complex case, you want to queue multiple callbacks. In this
558	case, AnyEvent::Handle will call the first queued callback each time new	674	case, AnyEvent::Handle will call the first queued callback each time new
559	data arrives and removes it when it has done its job (see C<push_read>,	675	data arrives (also the first time it is queued) and removes it when it has
560	below).	676	done its job (see C<push_read>, below).
561		677
562	This way you can, for example, push three line-reads, followed by reading	678	This way you can, for example, push three line-reads, followed by reading
563	a chunk of data, and AnyEvent::Handle will execute them in order.	679	a chunk of data, and AnyEvent::Handle will execute them in order.
564		680
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	681	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	682	the specified number of bytes which give an XML datagram.
567		683
568	# in the default state, expect some header bytes	684	# in the default state, expect some header bytes
569	$handle->on_read (sub {	685	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	686	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	687	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	688	# header arrived, decode
573	my $len = unpack "N", $_[1];	689	my $len = unpack "N", $_[1];
574		690
575	# now read the payload	691	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	692	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	693	my $xml = $_[1];
578	# handle xml	694	# handle xml
579	});	695	});
580	});	696	});
581	});	697	});
582		698
583	Example 2: Implement a client for a protocol that replies either with	699	Example 2: Implement a client for a protocol that replies either with "OK"
584	"OK" and another line or "ERROR" for one request, and 64 bytes for the	700	and another line or "ERROR" for the first request that is sent, and 64
585	second request. Due tot he availability of a full queue, we can just	701	bytes for the second request. Due to the availability of a queue, we can
586	pipeline sending both requests and manipulate the queue as necessary in	702	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	703	in the callbacks.
588		704
589	# request one	705	When the first callback is called and sees an "OK" response, it will
		706	C<unshift> another line-read. This line-read will be queued I<before> the
		707	64-byte chunk callback.
		708
		709	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	710	$handle->push_write ("request 1\015\012");
591		711
592	# we expect "ERROR" or "OK" as response, so push a line read	712	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	713	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	714	# if we got an "OK", we have to _prepend_ another line,
595	# so it will be read before the second request reads its 64 bytes	715	# so it will be read before the second request reads its 64 bytes
596	# which are already in the queue when this callback is called	716	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	717	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	718	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	719	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	720	my $response = $_[1];
601	...	721	...
602	});	722	});
603	}	723	}
604	});	724	});
605		725
606	# request two	726	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	727	$handle->push_write ("request 2\015\012");
608		728
609	# simply read 64 bytes, always	729	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	730	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	731	my $response = $_[1];
612	...	732	...
613	});	733	});
614		734
615	=over 4	735	=over 4
616		736
617	=cut	737	=cut
618		738
619	sub _drain_rbuf {	739	sub _drain_rbuf {
620	my ($self) = @_;	740	my ($self) = @_;
		741
		742	local $self->{_in_drain} = 1;
621		743
622	if (	744	if (
623	defined $self->{rbuf_max}	745	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	746	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	747	) {
626	$! = &Errno::ENOSPC;	748	$self->_error (&Errno::ENOSPC, 1), return;
627	$self->error;
628	}	749	}
629		750
630	return if $self->{in_drain};	751	while () {
631	local $self->{in_drain} = 1;
632
633	while (my $len = length $self->{rbuf}) {	752	my $len = length $self->{rbuf};
634	no strict 'refs';	753
635	if (my $cb = shift @{ $self->{_queue} }) {	754	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	755	unless ($cb->($self)) {
637	if ($self->{_eof}) {	756	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	757	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	758	$self->_error (&Errno::EPIPE, 1), return;
640	$self->error;
641	}	759	}
642		760
643	unshift @{ $self->{_queue} }, $cb;	761	unshift @{ $self->{_queue} }, $cb;
644	return;	762	last;
645	}	763	}
646	} elsif ($self->{on_read}) {	764	} elsif ($self->{on_read}) {
		765	last unless $len;
		766
647	$self->{on_read}($self);	767	$self->{on_read}($self);
648		768
649	if (	769	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	770	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	771	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	772	&& $self->{on_read} # but we still have on_read
654	) {	773	) {
		774	# no further data will arrive
655	# then no progress can be made	775	# so no progress can be made
656	$! = &Errno::EPIPE;	776	$self->_error (&Errno::EPIPE, 1), return
657	$self->error;	777	if $self->{_eof};
		778
		779	last; # more data might arrive
658	}	780	}
659	} else {	781	} else {
660	# read side becomes idle	782	# read side becomes idle
661	delete $self->{_rw};	783	delete $self->{_rw};
662	return;	784	last;
663	}	785	}
664	}	786	}
665		787
666	if ($self->{_eof}) {	788	if ($self->{_eof}) {
667	$self->_shutdown;	789	if ($self->{on_eof}) {
668	$self->{on_eof}($self)	790	$self->{on_eof}($self)
669	if $self->{on_eof};	791	} else {
		792	$self->_error (0, 1);
		793	}
		794	}
		795
		796	# may need to restart read watcher
		797	unless ($self->{_rw}) {
		798	$self->start_read
		799	if $self->{on_read} \|\| @{ $self->{_queue} };
670	}	800	}
671	}	801	}
672		802
673	=item $handle->on_read ($cb)	803	=item $handle->on_read ($cb)
674		804
…		…
680		810
681	sub on_read {	811	sub on_read {
682	my ($self, $cb) = @_;	812	my ($self, $cb) = @_;
683		813
684	$self->{on_read} = $cb;	814	$self->{on_read} = $cb;
		815	$self->_drain_rbuf if $cb && !$self->{_in_drain};
685	}	816	}
686		817
687	=item $handle->rbuf	818	=item $handle->rbuf
688		819
689	Returns the read buffer (as a modifiable lvalue).	820	Returns the read buffer (as a modifiable lvalue).
…		…
738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	869	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
739	->($self, $cb, @_);	870	->($self, $cb, @_);
740	}	871	}
741		872
742	push @{ $self->{_queue} }, $cb;	873	push @{ $self->{_queue} }, $cb;
743	$self->_drain_rbuf;	874	$self->_drain_rbuf unless $self->{_in_drain};
744	}	875	}
745		876
746	sub unshift_read {	877	sub unshift_read {
747	my $self = shift;	878	my $self = shift;
748	my $cb = pop;	879	my $cb = pop;
…		…
754	->($self, $cb, @_);	885	->($self, $cb, @_);
755	}	886	}
756		887
757		888
758	unshift @{ $self->{_queue} }, $cb;	889	unshift @{ $self->{_queue} }, $cb;
759	$self->_drain_rbuf;	890	$self->_drain_rbuf unless $self->{_in_drain};
760	}	891	}
761		892
762	=item $handle->push_read (type => @args, $cb)	893	=item $handle->push_read (type => @args, $cb)
763		894
764	=item $handle->unshift_read (type => @args, $cb)	895	=item $handle->unshift_read (type => @args, $cb)
…		…
794	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	925	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
795	1	926	1
796	}	927	}
797	};	928	};
798		929
799	# compatibility with older API
800	sub push_read_chunk {
801	$_[0]->push_read (chunk => $_[1], $_[2]);
802	}
803
804	sub unshift_read_chunk {
805	$_[0]->unshift_read (chunk => $_[1], $_[2]);
806	}
807
808	=item line => [$eol, ]$cb->($handle, $line, $eol)	930	=item line => [$eol, ]$cb->($handle, $line, $eol)
809		931
810	The callback will be called only once a full line (including the end of	932	The callback will be called only once a full line (including the end of
811	line marker, C<$eol>) has been read. This line (excluding the end of line	933	line marker, C<$eol>) has been read. This line (excluding the end of line
812	marker) will be passed to the callback as second argument (C<$line>), and	934	marker) will be passed to the callback as second argument (C<$line>), and
…		…
827	=cut	949	=cut
828		950
829	register_read_type line => sub {	951	register_read_type line => sub {
830	my ($self, $cb, $eol) = @_;	952	my ($self, $cb, $eol) = @_;
831		953
832	$eol = qr\|(\015?\012)\| if @_ < 3;	954	if (@_ < 3) {
833	$eol = quotemeta $eol unless ref $eol;	955	# this is more than twice as fast as the generic code below
834	$eol = qr\|^(.*?)($eol)\|s;
835
836	sub {	956	sub {
837	$_[0]{rbuf} =~ s/$eol// or return;	957	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
838		958
839	$cb->($_[0], $1, $2);	959	$cb->($_[0], $1, $2);
840	1
841	}
842	};
843
844	# compatibility with older API
845	sub push_read_line {
846	my $self = shift;
847	$self->push_read (line => @_);
848	}
849
850	sub unshift_read_line {
851	my $self = shift;
852	$self->unshift_read (line => @_);
853	}
854
855	=item netstring => $cb->($handle, $string)
856
857	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
858
859	Throws an error with C<$!> set to EBADMSG on format violations.
860
861	=cut
862
863	register_read_type netstring => sub {
864	my ($self, $cb) = @_;
865
866	sub {
867	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
868	if ($_[0]{rbuf} =~ /[^0-9]/) {
869	$! = &Errno::EBADMSG;
870	$self->error;
871	}	960	1
872	return;
873	}	961	}
		962	} else {
		963	$eol = quotemeta $eol unless ref $eol;
		964	$eol = qr\|^(.*?)($eol)\|s;
874		965
875	my $len = $1;	966	sub {
		967	$_[0]{rbuf} =~ s/$eol// or return;
876		968
877	$self->unshift_read (chunk => $len, sub {	969	$cb->($_[0], $1, $2);
878	my $string = $_[1];
879	$_[0]->unshift_read (chunk => 1, sub {
880	if ($_[1] eq ",") {
881	$cb->($_[0], $string);
882	} else {
883	$! = &Errno::EBADMSG;
884	$self->error;
885	}
886	});	970	1
887	});	971	}
888
889	1
890	}	972	}
891	};	973	};
892		974
893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	975	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
894		976
…		…
946	return 1;	1028	return 1;
947	}	1029	}
948		1030
949	# reject	1031	# reject
950	if ($reject && $$rbuf =~ $reject) {	1032	if ($reject && $$rbuf =~ $reject) {
951	$! = &Errno::EBADMSG;	1033	$self->_error (&Errno::EBADMSG);
952	$self->error;
953	}	1034	}
954		1035
955	# skip	1036	# skip
956	if ($skip && $$rbuf =~ $skip) {	1037	if ($skip && $$rbuf =~ $skip) {
957	$data .= substr $$rbuf, 0, $+[0], "";	1038	$data .= substr $$rbuf, 0, $+[0], "";
…		…
959		1040
960	()	1041	()
961	}	1042	}
962	};	1043	};
963		1044
		1045	=item netstring => $cb->($handle, $string)
		1046
		1047	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1048
		1049	Throws an error with C<$!> set to EBADMSG on format violations.
		1050
		1051	=cut
		1052
		1053	register_read_type netstring => sub {
		1054	my ($self, $cb) = @_;
		1055
		1056	sub {
		1057	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1058	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1059	$self->_error (&Errno::EBADMSG);
		1060	}
		1061	return;
		1062	}
		1063
		1064	my $len = $1;
		1065
		1066	$self->unshift_read (chunk => $len, sub {
		1067	my $string = $_[1];
		1068	$_[0]->unshift_read (chunk => 1, sub {
		1069	if ($_[1] eq ",") {
		1070	$cb->($_[0], $string);
		1071	} else {
		1072	$self->_error (&Errno::EBADMSG);
		1073	}
		1074	});
		1075	});
		1076
		1077	1
		1078	}
		1079	};
		1080
		1081	=item packstring => $format, $cb->($handle, $string)
		1082
		1083	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
		1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1086	optional C<!>, C<< < >> or C<< > >> modifier).
		1087
		1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1089
		1090	Example: read a block of data prefixed by its length in BER-encoded
		1091	format (very efficient).
		1092
		1093	$handle->push_read (packstring => "w", sub {
		1094	my ($handle, $data) = @_;
		1095	});
		1096
		1097	=cut
		1098
		1099	register_read_type packstring => sub {
		1100	my ($self, $cb, $format) = @_;
		1101
		1102	sub {
		1103	# 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} })
		1105	or return;
		1106
		1107	$format = length pack $format, $len;
		1108
		1109	# bypass unshift if we already have the remaining chunk
		1110	if ($format + $len <= length $_[0]{rbuf}) {
		1111	my $data = substr $_[0]{rbuf}, $format, $len;
		1112	substr $_[0]{rbuf}, 0, $format + $len, "";
		1113	$cb->($_[0], $data);
		1114	} else {
		1115	# remove prefix
		1116	substr $_[0]{rbuf}, 0, $format, "";
		1117
		1118	# read remaining chunk
		1119	$_[0]->unshift_read (chunk => $len, $cb);
		1120	}
		1121
		1122	1
		1123	}
		1124	};
		1125
964	=item json => $cb->($handle, $hash_or_arrayref)	1126	=item json => $cb->($handle, $hash_or_arrayref)
965		1127
966	Reads a JSON object or array, decodes it and passes it to the callback.	1128	Reads a JSON object or array, decodes it and passes it to the callback.
967		1129
968	If a C<json> object was passed to the constructor, then that will be used	1130	If a C<json> object was passed to the constructor, then that will be used
…		…
978	the C<json> write type description, above, for an actual example.	1140	the C<json> write type description, above, for an actual example.
979		1141
980	=cut	1142	=cut
981		1143
982	register_read_type json => sub {	1144	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1145	my ($self, $cb) = @_;
984		1146
985	require JSON;	1147	require JSON;
986		1148
987	my $data;	1149	my $data;
988	my $rbuf = \$self->{rbuf};	1150	my $rbuf = \$self->{rbuf};
…		…
1003	()	1165	()
1004	}	1166	}
1005	}	1167	}
1006	};	1168	};
1007		1169
		1170	=item storable => $cb->($handle, $ref)
		1171
		1172	Deserialises a L<Storable> frozen representation as written by the
		1173	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1174	data).
		1175
		1176	Raises C<EBADMSG> error if the data could not be decoded.
		1177
		1178	=cut
		1179
		1180	register_read_type storable => sub {
		1181	my ($self, $cb) = @_;
		1182
		1183	require Storable;
		1184
		1185	sub {
		1186	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1187	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1188	or return;
		1189
		1190	my $format = length pack "w", $len;
		1191
		1192	# bypass unshift if we already have the remaining chunk
		1193	if ($format + $len <= length $_[0]{rbuf}) {
		1194	my $data = substr $_[0]{rbuf}, $format, $len;
		1195	substr $_[0]{rbuf}, 0, $format + $len, "";
		1196	$cb->($_[0], Storable::thaw ($data));
		1197	} else {
		1198	# remove prefix
		1199	substr $_[0]{rbuf}, 0, $format, "";
		1200
		1201	# read remaining chunk
		1202	$_[0]->unshift_read (chunk => $len, sub {
		1203	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1204	$cb->($_[0], $ref);
		1205	} else {
		1206	$self->_error (&Errno::EBADMSG);
		1207	}
		1208	});
		1209	}
		1210
		1211	1
		1212	}
		1213	};
		1214
1008	=back	1215	=back
1009		1216
1010	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1217	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1011		1218
1012	This function (not method) lets you add your own types to C<push_read>.	1219	This function (not method) lets you add your own types to C<push_read>.
…		…
1030	=item $handle->stop_read	1237	=item $handle->stop_read
1031		1238
1032	=item $handle->start_read	1239	=item $handle->start_read
1033		1240
1034	In rare cases you actually do not want to read anything from the	1241	In rare cases you actually do not want to read anything from the
1035	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1242	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1036	any queued callbacks will be executed then. To start reading again, call	1243	any queued callbacks will be executed then. To start reading again, call
1037	C<start_read>.	1244	C<start_read>.
		1245
		1246	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1247	you change the C<on_read> callback or push/unshift a read callback, and it
		1248	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1249	there are any read requests in the queue.
1038		1250
1039	=cut	1251	=cut
1040		1252
1041	sub stop_read {	1253	sub stop_read {
1042	my ($self) = @_;	1254	my ($self) = @_;
…		…
1056		1268
1057	if ($len > 0) {	1269	if ($len > 0) {
1058	$self->{_activity} = AnyEvent->now;	1270	$self->{_activity} = AnyEvent->now;
1059		1271
1060	$self->{filter_r}	1272	$self->{filter_r}
1061	? $self->{filter_r}->($self, $rbuf)	1273	? $self->{filter_r}($self, $rbuf)
1062	: $self->_drain_rbuf;	1274	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1063		1275
1064	} elsif (defined $len) {	1276	} elsif (defined $len) {
1065	delete $self->{_rw};	1277	delete $self->{_rw};
1066	$self->{_eof} = 1;	1278	$self->{_eof} = 1;
1067	$self->_drain_rbuf;	1279	$self->_drain_rbuf unless $self->{_in_drain};
1068		1280
1069	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1281	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1070	return $self->error;	1282	return $self->_error ($!, 1);
1071	}	1283	}
1072	});	1284	});
1073	}	1285	}
1074	}	1286	}
1075		1287
1076	sub _dotls {	1288	sub _dotls {
1077	my ($self) = @_;	1289	my ($self) = @_;
		1290
		1291	my $buf;
1078		1292
1079	if (length $self->{_tls_wbuf}) {	1293	if (length $self->{_tls_wbuf}) {
1080	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1294	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1081	substr $self->{_tls_wbuf}, 0, $len, "";	1295	substr $self->{_tls_wbuf}, 0, $len, "";
1082	}	1296	}
1083	}	1297	}
1084		1298
1085	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1299	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1086	$self->{wbuf} .= $buf;	1300	$self->{wbuf} .= $buf;
1087	$self->_drain_wbuf;	1301	$self->_drain_wbuf;
1088	}	1302	}
1089		1303
1090	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1304	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1305	if (length $buf) {
1091	$self->{rbuf} .= $buf;	1306	$self->{rbuf} .= $buf;
1092	$self->_drain_rbuf;	1307	$self->_drain_rbuf unless $self->{_in_drain};
		1308	} else {
		1309	# let's treat SSL-eof as we treat normal EOF
		1310	$self->{_eof} = 1;
		1311	$self->_shutdown;
		1312	return;
		1313	}
1093	}	1314	}
1094		1315
1095	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1316	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1096		1317
1097	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1318	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1098	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1319	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1099	$self->error;	1320	return $self->_error ($!, 1);
1100	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1321	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1101	$! = &Errno::EIO;	1322	return $self->_error (&Errno::EIO, 1);
1102	$self->error;
1103	}	1323	}
1104		1324
1105	# all others are fine for our purposes	1325	# all others are fine for our purposes
1106	}	1326	}
1107	}	1327	}
…		…
1122	call and can be used or changed to your liking. Note that the handshake	1342	call and can be used or changed to your liking. Note that the handshake
1123	might have already started when this function returns.	1343	might have already started when this function returns.
1124		1344
1125	=cut	1345	=cut
1126		1346
1127	# TODO: maybe document...
1128	sub starttls {	1347	sub starttls {
1129	my ($self, $ssl, $ctx) = @_;	1348	my ($self, $ssl, $ctx) = @_;
1130		1349
1131	$self->stoptls;	1350	$self->stoptls;
1132		1351
…		…
1185		1404
1186	sub DESTROY {	1405	sub DESTROY {
1187	my $self = shift;	1406	my $self = shift;
1188		1407
1189	$self->stoptls;	1408	$self->stoptls;
		1409
		1410	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1411
		1412	if ($linger && length $self->{wbuf}) {
		1413	my $fh = delete $self->{fh};
		1414	my $wbuf = delete $self->{wbuf};
		1415
		1416	my @linger;
		1417
		1418	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1419	my $len = syswrite $fh, $wbuf, length $wbuf;
		1420
		1421	if ($len > 0) {
		1422	substr $wbuf, 0, $len, "";
		1423	} else {
		1424	@linger = (); # end
		1425	}
		1426	});
		1427	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1428	@linger = ();
		1429	});
		1430	}
1190	}	1431	}
1191		1432
1192	=item AnyEvent::Handle::TLS_CTX	1433	=item AnyEvent::Handle::TLS_CTX
1193		1434
1194	This function creates and returns the Net::SSLeay::CTX object used by	1435	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1236	=over 4	1477	=over 4
1237		1478
1238	=item * all constructor arguments become object members.	1479	=item * all constructor arguments become object members.
1239		1480
1240	At least initially, when you pass a C<tls>-argument to the constructor it	1481	At least initially, when you pass a C<tls>-argument to the constructor it
1241	will end up in C<< $handle->{tls} >>. Those members might be changes or	1482	will end up in C<< $handle->{tls} >>. Those members might be changed or
1242	mutated later on (for example C<tls> will hold the TLS connection object).	1483	mutated later on (for example C<tls> will hold the TLS connection object).
1243		1484
1244	=item * other object member names are prefixed with an C<_>.	1485	=item * other object member names are prefixed with an C<_>.
1245		1486
1246	All object members not explicitly documented (internal use) are prefixed	1487	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs. Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs.
Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC