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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.50 by root, Fri May 30 21:38:46 2008 UTC vs.
Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC

…		…
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.1;	19	our $VERSION = 4.22;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($handle)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	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
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($handle)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	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	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		102
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	103	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	104	you will not be notified of errors otherwise. The default simply calls
103	die.	105	C<croak>.
104		106
105	=item on_read => $cb->($handle)	107	=item on_read => $cb->($handle)
106		108
107	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	110	and no read request is in the queue (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
109		113
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
112		116
113	When an EOF condition is detected then AnyEvent::Handle will first try to	117	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
119		123
120	This sets the callback that is called when the write buffer becomes empty	124	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).	125	(or when the callback is set and the buffer is empty already).
122		126
123	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
		128
		129	This callback is useful when you don't want to put all of your write data
		130	into the queue at once, for example, when you want to write the contents
		131	of some file to the socket you might not want to read the whole file into
		132	memory and push it into the queue, but instead only read more data from
		133	the file when the write queue becomes empty.
124		134
125	=item timeout => $fractional_seconds	135	=item timeout => $fractional_seconds
126		136
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	137	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	138	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	162	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	163	(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	164	amount of data without a callback ever being called as long as the line
155	isn't finished).	165	isn't finished).
156		166
		167	=item autocork => <boolean>
		168
		169	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
		171	a write watcher and wait for the next event loop iteration, but can be
		172	inefficient if you write multiple small chunks (this disadvantage is
		173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		174
		175	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,
		177	but less efficient when you do a single write only.
		178
		179	=item no_delay => <boolean>
		180
		181	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
		183	the Nagle algorithm, and usually it is beneficial.
		184
		185	In some situations you want as low a delay as possible, which cna be
		186	accomplishd by setting this option to true.
		187
		188	The default is your opertaing system's default behaviour, this option
		189	explicitly enables or disables it, if possible.
		190
157	=item read_size => <bytes>	191	=item read_size => <bytes>
158		192
159	The default read block size (the amount of bytes this module will try to read	193	The default read block size (the amount of bytes this module will try to read
160	during each (loop iteration). Default: C<8192>.	194	during each (loop iteration). Default: C<8192>.
161		195
162	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
163		197
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	198	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	199	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	200	considered empty.
		201
		202	=item linger => <seconds>
		203
		204	If non-zero (default: C<3600>), then the destructor of the
		205	AnyEvent::Handle object will check wether there is still outstanding write
		206	data and will install a watcher that will write out this data. No errors
		207	will be reported (this mostly matches how the operating system treats
		208	outstanding data at socket close time).
		209
		210	This will not work for partial TLS data that could not yet been
		211	encoded. This data will be lost.
167		212
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		214
170	When this parameter is given, it enables TLS (SSL) mode, that means it	215	When this parameter is given, it enables TLS (SSL) mode, that means it
171	will start making tls handshake and will transparently encrypt/decrypt	216	will start making tls handshake and will transparently encrypt/decrypt
…		…
180	You can also provide your own TLS connection object, but you have	225	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>	226	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	227	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	228	AnyEvent::Handle.
184		229
185	See the C<starttls> method if you need to start TLs negotiation later.	230	See the C<starttls> method if you need to start TLS negotiation later.
186		231
187	=item tls_ctx => $ssl_ctx	232	=item tls_ctx => $ssl_ctx
188		233
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	234	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	235	(unless a connection object was specified directly). If this parameter is
…		…
222	if ($self->{tls}) {	267	if ($self->{tls}) {
223	require Net::SSLeay;	268	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}	270	}
226		271
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;	272	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	273	$self->_timeout;
234		274
		275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		277
235	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
236		280
237	$self	281	$self
238	}	282	}
239		283
240	sub _shutdown {	284	sub _shutdown {
…		…
242		286
243	delete $self->{_tw};	287	delete $self->{_tw};
244	delete $self->{_rw};	288	delete $self->{_rw};
245	delete $self->{_ww};	289	delete $self->{_ww};
246	delete $self->{fh};	290	delete $self->{fh};
247	}
248		291
		292	$self->stoptls;
		293	}
		294
249	sub error {	295	sub _error {
250	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
251		297
252	{
253	local $!;
254	$self->_shutdown;	298	$self->_shutdown
255	}	299	if $fatal;
256		300
257	$self->{on_error}($self)	301	$! = $errno;
		302
258	if $self->{on_error};	303	if ($self->{on_error}) {
259		304	$self->{on_error}($self, $fatal);
		305	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
		307	}
261	}	308	}
262		309
263	=item $fh = $handle->fh	310	=item $fh = $handle->fh
264		311
265	This method returns the file handle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
296		343
297	=cut	344	=cut
298		345
299	sub on_timeout {	346	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	347	$_[0]{on_timeout} = $_[1];
		348	}
		349
		350	=item $handle->autocork ($boolean)
		351
		352	Enables or disables the current autocork behaviour (see C<autocork>
		353	constructor argument).
		354
		355	=cut
		356
		357	=item $handle->no_delay ($boolean)
		358
		359	Enables or disables the C<no_delay> setting (see constructor argument of
		360	the same name for details).
		361
		362	=cut
		363
		364	sub no_delay {
		365	$_[0]{no_delay} = $_[1];
		366
		367	eval {
		368	local $SIG{__DIE__};
		369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		370	};
301	}	371	}
302		372
303	#############################################################################	373	#############################################################################
304		374
305	=item $handle->timeout ($seconds)	375	=item $handle->timeout ($seconds)
…		…
331	$self->{_activity} = $NOW;	401	$self->{_activity} = $NOW;
332		402
333	if ($self->{on_timeout}) {	403	if ($self->{on_timeout}) {
334	$self->{on_timeout}($self);	404	$self->{on_timeout}($self);
335	} else {	405	} else {
336	$! = Errno::ETIMEDOUT;	406	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	407	}
339		408
340	# callbakx could have changed timeout value, optimise	409	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	410	return unless $self->{timeout};
342		411
343	# calculate new after	412	# calculate new after
344	$after = $self->{timeout};	413	$after = $self->{timeout};
345	}	414	}
346		415
347	Scalar::Util::weaken $self;	416	Scalar::Util::weaken $self;
		417	return unless $self; # ->error could have destroyed $self
348		418
349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	419	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	420	delete $self->{_tw};
351	$self->_timeout;	421	$self->_timeout;
352	});	422	});
…		…
415	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
416	&& $self->{on_drain};	486	&& $self->{on_drain};
417		487
418	delete $self->{_ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	490	$self->_error ($!, 1);
421	}	491	}
422	};	492	};
423		493
424	# try to write data immediately	494	# try to write data immediately
425	$cb->();	495	$cb->() unless $self->{autocork};
426		496
427	# if still data left in wbuf, we need to poll	497	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	499	if length $self->{wbuf};
430	};	500	};
…		…
454	}	524	}
455	}	525	}
456		526
457	=item $handle->push_write (type => @args)	527	=item $handle->push_write (type => @args)
458		528
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	529	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	530	the job by specifying a type and type-specific arguments.
463		531
464	Predefined types are (if you have ideas for additional types, feel free to	532	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	533	drop by and tell us):
…		…
469	=item netstring => $string	537	=item netstring => $string
470		538
471	Formats the given value as netstring	539	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		541
474	=back
475
476	=cut	542	=cut
477		543
478	register_write_type netstring => sub {	544	register_write_type netstring => sub {
479	my ($self, $string) = @_;	545	my ($self, $string) = @_;
480		546
481	sprintf "%d:%s,", (length $string), $string	547	sprintf "%d:%s,", (length $string), $string
		548	};
		549
		550	=item packstring => $format, $data
		551
		552	An octet string prefixed with an encoded length. The encoding C<$format>
		553	uses the same format as a Perl C<pack> format, but must specify a single
		554	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		555	optional C<!>, C<< < >> or C<< > >> modifier).
		556
		557	=cut
		558
		559	register_write_type packstring => sub {
		560	my ($self, $format, $string) = @_;
		561
		562	pack "$format/a*", $string
482	};	563	};
483		564
484	=item json => $array_or_hashref	565	=item json => $array_or_hashref
485		566
486	Encodes the given hash or array reference into a JSON object. Unless you	567	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		601
521	$self->{json} ? $self->{json}->encode ($ref)	602	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	603	: JSON::encode_json ($ref)
523	};	604	};
524		605
		606	=item storable => $reference
		607
		608	Freezes the given reference using L<Storable> and writes it to the
		609	handle. Uses the C<nfreeze> format.
		610
		611	=cut
		612
		613	register_write_type storable => sub {
		614	my ($self, $ref) = @_;
		615
		616	require Storable;
		617
		618	pack "w/a*", Storable::nfreeze ($ref)
		619	};
		620
		621	=back
		622
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		624
527	This function (not method) lets you add your own types to C<push_write>.	625	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	626	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	627	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	647	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	648	a queue.
551		649
552	In the simple case, you just install an C<on_read> callback and whenever	650	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	651	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	652	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	653	leave the data there if you want to accumulate more (e.g. when only a
		654	partial message has been received so far).
556		655
557	In the more complex case, you want to queue multiple callbacks. In this	656	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	657	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>,	658	data arrives (also the first time it is queued) and removes it when it has
560	below).	659	done its job (see C<push_read>, below).
561		660
562	This way you can, for example, push three line-reads, followed by reading	661	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.	662	a chunk of data, and AnyEvent::Handle will execute them in order.
564		663
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	664	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
567		666
568	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
569	$handle->on_read (sub {	668	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	669	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	671	# header arrived, decode
573	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
574		673
575	# now read the payload	674	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	676	my $xml = $_[1];
578	# handle xml	677	# handle xml
579	});	678	});
580	});	679	});
581	});	680	});
582		681
583	Example 2: Implement a client for a protocol that replies either with	682	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	683	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	684	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	685	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	686	in the callbacks.
588		687
589	# request one	688	When the first callback is called and sees an "OK" response, it will
		689	C<unshift> another line-read. This line-read will be queued I<before> the
		690	64-byte chunk callback.
		691
		692	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
591		694
592	# we expect "ERROR" or "OK" as response, so push a line read	695	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	697	# 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	698	# 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	699	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	700	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	703	my $response = $_[1];
601	...	704	...
602	});	705	});
603	}	706	}
604	});	707	});
605		708
606	# request two	709	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
608		711
609	# simply read 64 bytes, always	712	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	714	my $response = $_[1];
612	...	715	...
613	});	716	});
614		717
615	=over 4	718	=over 4
616		719
617	=cut	720	=cut
618		721
619	sub _drain_rbuf {	722	sub _drain_rbuf {
620	my ($self) = @_;	723	my ($self) = @_;
		724
		725	local $self->{_in_drain} = 1;
621		726
622	if (	727	if (
623	defined $self->{rbuf_max}	728	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	729	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	730	) {
626	$! = &Errno::ENOSPC;	731	return $self->_error (&Errno::ENOSPC, 1);
627	$self->error;
628	}	732	}
629		733
630	return if $self->{in_drain};	734	while () {
631	local $self->{in_drain} = 1;
632
633	while (my $len = length $self->{rbuf}) {
634	no strict 'refs';	735	no strict 'refs';
		736
		737	my $len = length $self->{rbuf};
		738
635	if (my $cb = shift @{ $self->{_queue} }) {	739	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	740	unless ($cb->($self)) {
637	if ($self->{_eof}) {	741	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	742	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	743	$self->_error (&Errno::EPIPE, 1), last;
640	$self->error;
641	}	744	}
642		745
643	unshift @{ $self->{_queue} }, $cb;	746	unshift @{ $self->{_queue} }, $cb;
644	return;	747	last;
645	}	748	}
646	} elsif ($self->{on_read}) {	749	} elsif ($self->{on_read}) {
		750	last unless $len;
		751
647	$self->{on_read}($self);	752	$self->{on_read}($self);
648		753
649	if (	754	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	755	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	756	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	757	&& $self->{on_read} # but we still have on_read
654	) {	758	) {
		759	# no further data will arrive
655	# then no progress can be made	760	# so no progress can be made
656	$! = &Errno::EPIPE;	761	$self->_error (&Errno::EPIPE, 1), last
657	$self->error;	762	if $self->{_eof};
		763
		764	last; # more data might arrive
658	}	765	}
659	} else {	766	} else {
660	# read side becomes idle	767	# read side becomes idle
661	delete $self->{_rw};	768	delete $self->{_rw};
662	return;	769	last;
663	}	770	}
664	}	771	}
665		772
666	$self->{on_eof}($self)	773	$self->{on_eof}($self)
667	if $self->{_eof} && $self->{on_eof};	774	if $self->{_eof} && $self->{on_eof};
		775
		776	# may need to restart read watcher
		777	unless ($self->{_rw}) {
		778	$self->start_read
		779	if $self->{on_read} \|\| @{ $self->{_queue} };
		780	}
668	}	781	}
669		782
670	=item $handle->on_read ($cb)	783	=item $handle->on_read ($cb)
671		784
672	This replaces the currently set C<on_read> callback, or clears it (when	785	This replaces the currently set C<on_read> callback, or clears it (when
…		…
677		790
678	sub on_read {	791	sub on_read {
679	my ($self, $cb) = @_;	792	my ($self, $cb) = @_;
680		793
681	$self->{on_read} = $cb;	794	$self->{on_read} = $cb;
		795	$self->_drain_rbuf if $cb && !$self->{_in_drain};
682	}	796	}
683		797
684	=item $handle->rbuf	798	=item $handle->rbuf
685		799
686	Returns the read buffer (as a modifiable lvalue).	800	Returns the read buffer (as a modifiable lvalue).
…		…
735	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	849	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
736	->($self, $cb, @_);	850	->($self, $cb, @_);
737	}	851	}
738		852
739	push @{ $self->{_queue} }, $cb;	853	push @{ $self->{_queue} }, $cb;
740	$self->_drain_rbuf;	854	$self->_drain_rbuf unless $self->{_in_drain};
741	}	855	}
742		856
743	sub unshift_read {	857	sub unshift_read {
744	my $self = shift;	858	my $self = shift;
745	my $cb = pop;	859	my $cb = pop;
…		…
751	->($self, $cb, @_);	865	->($self, $cb, @_);
752	}	866	}
753		867
754		868
755	unshift @{ $self->{_queue} }, $cb;	869	unshift @{ $self->{_queue} }, $cb;
756	$self->_drain_rbuf;	870	$self->_drain_rbuf unless $self->{_in_drain};
757	}	871	}
758		872
759	=item $handle->push_read (type => @args, $cb)	873	=item $handle->push_read (type => @args, $cb)
760		874
761	=item $handle->unshift_read (type => @args, $cb)	875	=item $handle->unshift_read (type => @args, $cb)
…		…
824	=cut	938	=cut
825		939
826	register_read_type line => sub {	940	register_read_type line => sub {
827	my ($self, $cb, $eol) = @_;	941	my ($self, $cb, $eol) = @_;
828		942
829	$eol = qr\|(\015?\012)\| if @_ < 3;	943	if (@_ < 3) {
		944	# this is more than twice as fast as the generic code below
		945	sub {
		946	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		947
		948	$cb->($_[0], $1, $2);
		949	1
		950	}
		951	} else {
830	$eol = quotemeta $eol unless ref $eol;	952	$eol = quotemeta $eol unless ref $eol;
831	$eol = qr\|^(.*?)($eol)\|s;	953	$eol = qr\|^(.*?)($eol)\|s;
832		954
833	sub {	955	sub {
834	$_[0]{rbuf} =~ s/$eol// or return;	956	$_[0]{rbuf} =~ s/$eol// or return;
835		957
836	$cb->($_[0], $1, $2);	958	$cb->($_[0], $1, $2);
		959	1
837	1	960	}
838	}	961	}
839	};	962	};
840		963
841	# compatibility with older API	964	# compatibility with older API
842	sub push_read_line {	965	sub push_read_line {
…		…
846		969
847	sub unshift_read_line {	970	sub unshift_read_line {
848	my $self = shift;	971	my $self = shift;
849	$self->unshift_read (line => @_);	972	$self->unshift_read (line => @_);
850	}	973	}
851
852	=item netstring => $cb->($handle, $string)
853
854	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
855
856	Throws an error with C<$!> set to EBADMSG on format violations.
857
858	=cut
859
860	register_read_type netstring => sub {
861	my ($self, $cb) = @_;
862
863	sub {
864	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
865	if ($_[0]{rbuf} =~ /[^0-9]/) {
866	$! = &Errno::EBADMSG;
867	$self->error;
868	}
869	return;
870	}
871
872	my $len = $1;
873
874	$self->unshift_read (chunk => $len, sub {
875	my $string = $_[1];
876	$_[0]->unshift_read (chunk => 1, sub {
877	if ($_[1] eq ",") {
878	$cb->($_[0], $string);
879	} else {
880	$! = &Errno::EBADMSG;
881	$self->error;
882	}
883	});
884	});
885
886	1
887	}
888	};
889		974
890	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	975	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
891		976
892	Makes a regex match against the regex object C<$accept> and returns	977	Makes a regex match against the regex object C<$accept> and returns
893	everything up to and including the match.	978	everything up to and including the match.
…		…
943	return 1;	1028	return 1;
944	}	1029	}
945		1030
946	# reject	1031	# reject
947	if ($reject && $$rbuf =~ $reject) {	1032	if ($reject && $$rbuf =~ $reject) {
948	$! = &Errno::EBADMSG;	1033	$self->_error (&Errno::EBADMSG);
949	$self->error;
950	}	1034	}
951		1035
952	# skip	1036	# skip
953	if ($skip && $$rbuf =~ $skip) {	1037	if ($skip && $$rbuf =~ $skip) {
954	$data .= substr $$rbuf, 0, $+[0], "";	1038	$data .= substr $$rbuf, 0, $+[0], "";
…		…
956		1040
957	()	1041	()
958	}	1042	}
959	};	1043	};
960		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
961	=item json => $cb->($handle, $hash_or_arrayref)	1126	=item json => $cb->($handle, $hash_or_arrayref)
962		1127
963	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.
964		1129
965	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
…		…
975	the C<json> write type description, above, for an actual example.	1140	the C<json> write type description, above, for an actual example.
976		1141
977	=cut	1142	=cut
978		1143
979	register_read_type json => sub {	1144	register_read_type json => sub {
980	my ($self, $cb, $accept, $reject, $skip) = @_;	1145	my ($self, $cb) = @_;
981		1146
982	require JSON;	1147	require JSON;
983		1148
984	my $data;	1149	my $data;
985	my $rbuf = \$self->{rbuf};	1150	my $rbuf = \$self->{rbuf};
…		…
1000	()	1165	()
1001	}	1166	}
1002	}	1167	}
1003	};	1168	};
1004		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
1005	=back	1215	=back
1006		1216
1007	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1217	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1008		1218
1009	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>.
…		…
1027	=item $handle->stop_read	1237	=item $handle->stop_read
1028		1238
1029	=item $handle->start_read	1239	=item $handle->start_read
1030		1240
1031	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
1032	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
1033	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
1034	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.
1035		1250
1036	=cut	1251	=cut
1037		1252
1038	sub stop_read {	1253	sub stop_read {
1039	my ($self) = @_;	1254	my ($self) = @_;
…		…
1054	if ($len > 0) {	1269	if ($len > 0) {
1055	$self->{_activity} = AnyEvent->now;	1270	$self->{_activity} = AnyEvent->now;
1056		1271
1057	$self->{filter_r}	1272	$self->{filter_r}
1058	? $self->{filter_r}($self, $rbuf)	1273	? $self->{filter_r}($self, $rbuf)
1059	: $self->_drain_rbuf;	1274	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1060		1275
1061	} elsif (defined $len) {	1276	} elsif (defined $len) {
1062	delete $self->{_rw};	1277	delete $self->{_rw};
1063	$self->{_eof} = 1;	1278	$self->{_eof} = 1;
1064	$self->_drain_rbuf;	1279	$self->_drain_rbuf unless $self->{_in_drain};
1065		1280
1066	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1281	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1067	return $self->error;	1282	return $self->_error ($!, 1);
1068	}	1283	}
1069	});	1284	});
1070	}	1285	}
1071	}	1286	}
1072		1287
1073	sub _dotls {	1288	sub _dotls {
1074	my ($self) = @_;	1289	my ($self) = @_;
		1290
		1291	my $buf;
1075		1292
1076	if (length $self->{_tls_wbuf}) {	1293	if (length $self->{_tls_wbuf}) {
1077	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) {
1078	substr $self->{_tls_wbuf}, 0, $len, "";	1295	substr $self->{_tls_wbuf}, 0, $len, "";
1079	}	1296	}
1080	}	1297	}
1081		1298
1082	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1299	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1083	$self->{wbuf} .= $buf;	1300	$self->{wbuf} .= $buf;
1084	$self->_drain_wbuf;	1301	$self->_drain_wbuf;
1085	}	1302	}
1086		1303
1087	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1304	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1305	if (length $buf) {
1088	$self->{rbuf} .= $buf;	1306	$self->{rbuf} .= $buf;
1089	$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	}
1090	}	1314	}
1091		1315
1092	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1316	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1093		1317
1094	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1318	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1095	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1319	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1096	$self->error;	1320	return $self->_error ($!, 1);
1097	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1321	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1098	$! = &Errno::EIO;	1322	return $self->_error (&Errno::EIO, 1);
1099	$self->error;
1100	}	1323	}
1101		1324
1102	# all others are fine for our purposes	1325	# all others are fine for our purposes
1103	}	1326	}
1104	}	1327	}
…		…
1119	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
1120	might have already started when this function returns.	1343	might have already started when this function returns.
1121		1344
1122	=cut	1345	=cut
1123		1346
1124	# TODO: maybe document...
1125	sub starttls {	1347	sub starttls {
1126	my ($self, $ssl, $ctx) = @_;	1348	my ($self, $ssl, $ctx) = @_;
1127		1349
1128	$self->stoptls;	1350	$self->stoptls;
1129		1351
…		…
1182		1404
1183	sub DESTROY {	1405	sub DESTROY {
1184	my $self = shift;	1406	my $self = shift;
1185		1407
1186	$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	}
1187	}	1431	}
1188		1432
1189	=item AnyEvent::Handle::TLS_CTX	1433	=item AnyEvent::Handle::TLS_CTX
1190		1434
1191	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
…		…
1233	=over 4	1477	=over 4
1234		1478
1235	=item * all constructor arguments become object members.	1479	=item * all constructor arguments become object members.
1236		1480
1237	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
1238	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
1239	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).
1240		1484
1241	=item * other object member names are prefixed with an C<_>.	1485	=item * other object member names are prefixed with an C<_>.
1242		1486
1243	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.50 by root, Fri May 30 21:38:46 2008 UTC vs. Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.50 by root, Fri May 30 21:38:46 2008 UTC vs.
Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC