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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.60 by root, Thu Jun 5 18:30:08 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
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.14;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
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 (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($self)	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 detcted,
		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->($self)	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> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		102
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->($self)	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.
109		111
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
112		114
113	When an EOF condition is detected then AnyEvent::Handle will first try to	115	When an EOF condition is detected then AnyEvent::Handle will first try to
114	feed all the remaining data to the queued callbacks and C<on_read> before	116	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	117	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	118	error will be raised (with C<$!> set to C<EPIPE>).
117		119
118	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
119		121
120	This sets the callback that is called when the write buffer becomes empty	122	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).	123	(or when the callback is set and the buffer is empty already).
122		124
123	To append to the write buffer, use the C<< ->push_write >> method.	125	To append to the write buffer, use the C<< ->push_write >> method.
		126
		127	=item timeout => $fractional_seconds
		128
		129	If non-zero, then this enables an "inactivity" timeout: whenever this many
		130	seconds pass without a successful read or write on the underlying file
		131	handle, the C<on_timeout> callback will be invoked (and if that one is
		132	missing, an C<ETIMEDOUT> error will be raised).
		133
		134	Note that timeout processing is also active when you currently do not have
		135	any outstanding read or write requests: If you plan to keep the connection
		136	idle then you should disable the timout temporarily or ignore the timeout
		137	in the C<on_timeout> callback.
		138
		139	Zero (the default) disables this timeout.
		140
		141	=item on_timeout => $cb->($handle)
		142
		143	Called whenever the inactivity timeout passes. If you return from this
		144	callback, then the timeout will be reset as if some activity had happened,
		145	so this condition is not fatal in any way.
124		146
125	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
126		148
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	149	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
128	when the read buffer ever (strictly) exceeds this size. This is useful to	150	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
135	isn't finished).	157	isn't finished).
136		158
137	=item read_size => <bytes>	159	=item read_size => <bytes>
138		160
139	The default read block size (the amount of bytes this module will try to read	161	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
141		163
142	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
143		165
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	166	Sets the amount of bytes (default: C<0>) that make up an "empty" write
145	buffer: If the write reaches this size or gets even samller it is	167	buffer: If the write reaches this size or gets even samller it is
…		…
168		190
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	191	Use the given Net::SSLeay::CTX object to create the new TLS connection
170	(unless a connection object was specified directly). If this parameter is	192	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		194
		195	=item json => JSON or JSON::XS object
		196
		197	This is the json coder object used by the C<json> read and write types.
		198
		199	If you don't supply it, then AnyEvent::Handle will create and use a
		200	suitable one, which will write and expect UTF-8 encoded JSON texts.
		201
		202	Note that you are responsible to depend on the JSON module if you want to
		203	use this functionality, as AnyEvent does not have a dependency itself.
		204
173	=item filter_r => $cb	205	=item filter_r => $cb
174		206
175	=item filter_w => $cb	207	=item filter_w => $cb
176		208
177	These exist, but are undocumented at this time.	209	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	224	if ($self->{tls}) {
193	require Net::SSLeay;	225	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	227	}
196		228
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	230	$self->_timeout;
		231
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
201		234
202	$self->start_read;
203
204	$self	235	$self
205	}	236	}
206		237
207	sub _shutdown {	238	sub _shutdown {
208	my ($self) = @_;	239	my ($self) = @_;
209		240
		241	delete $self->{_tw};
210	delete $self->{_rw};	242	delete $self->{_rw};
211	delete $self->{_ww};	243	delete $self->{_ww};
212	delete $self->{fh};	244	delete $self->{fh};
213	}
214		245
		246	$self->stoptls;
		247	}
		248
215	sub error {	249	sub _error {
216	my ($self) = @_;	250	my ($self, $errno, $fatal) = @_;
217		251
218	{
219	local $!;
220	$self->_shutdown;	252	$self->_shutdown
221	}	253	if $fatal;
222		254
223	$self->{on_error}($self)	255	$! = $errno;
		256
224	if $self->{on_error};	257	if ($self->{on_error}) {
225		258	$self->{on_error}($self, $fatal);
		259	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	260	Carp::croak "AnyEvent::Handle uncaught error: $!";
		261	}
227	}	262	}
228		263
229	=item $fh = $handle->fh	264	=item $fh = $handle->fh
230		265
231	This method returns the file handle of the L<AnyEvent::Handle> object.	266	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
250		285
251	=cut	286	=cut
252		287
253	sub on_eof {	288	sub on_eof {
254	$_[0]{on_eof} = $_[1];	289	$_[0]{on_eof} = $_[1];
		290	}
		291
		292	=item $handle->on_timeout ($cb)
		293
		294	Replace the current C<on_timeout> callback, or disables the callback
		295	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		296	argument.
		297
		298	=cut
		299
		300	sub on_timeout {
		301	$_[0]{on_timeout} = $_[1];
		302	}
		303
		304	#############################################################################
		305
		306	=item $handle->timeout ($seconds)
		307
		308	Configures (or disables) the inactivity timeout.
		309
		310	=cut
		311
		312	sub timeout {
		313	my ($self, $timeout) = @_;
		314
		315	$self->{timeout} = $timeout;
		316	$self->_timeout;
		317	}
		318
		319	# reset the timeout watcher, as neccessary
		320	# also check for time-outs
		321	sub _timeout {
		322	my ($self) = @_;
		323
		324	if ($self->{timeout}) {
		325	my $NOW = AnyEvent->now;
		326
		327	# when would the timeout trigger?
		328	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		329
		330	# now or in the past already?
		331	if ($after <= 0) {
		332	$self->{_activity} = $NOW;
		333
		334	if ($self->{on_timeout}) {
		335	$self->{on_timeout}($self);
		336	} else {
		337	$self->_error (&Errno::ETIMEDOUT);
		338	}
		339
		340	# callback could have changed timeout value, optimise
		341	return unless $self->{timeout};
		342
		343	# calculate new after
		344	$after = $self->{timeout};
		345	}
		346
		347	Scalar::Util::weaken $self;
		348	return unless $self; # ->error could have destroyed $self
		349
		350	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		351	delete $self->{_tw};
		352	$self->_timeout;
		353	});
		354	} else {
		355	delete $self->{_tw};
		356	}
255	}	357	}
256		358
257	#############################################################################	359	#############################################################################
258		360
259	=back	361	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	408	my $len = syswrite $self->{fh}, $self->{wbuf};
307		409
308	if ($len >= 0) {	410	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	411	substr $self->{wbuf}, 0, $len, "";
310		412
		413	$self->{_activity} = AnyEvent->now;
		414
311	$self->{on_drain}($self)	415	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	416	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	417	&& $self->{on_drain};
314		418
315	delete $self->{_ww} unless length $self->{wbuf};	419	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	420	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	421	$self->_error ($!, 1);
318	}	422	}
319	};	423	};
320		424
321	# try to write data immediately	425	# try to write data immediately
322	$cb->();	426	$cb->();
…		…
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	446	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	447	->($self, @_);
344	}	448	}
345		449
346	if ($self->{filter_w}) {	450	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	451	$self->{filter_w}($self, \$_[0]);
348	} else {	452	} else {
349	$self->{wbuf} .= $_[0];	453	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	454	$self->_drain_wbuf;
351	}	455	}
352	}	456	}
353		457
354	=item $handle->push_write (type => @args)	458	=item $handle->push_write (type => @args)
355		459
356	=item $handle->unshift_write (type => @args)
357
358	Instead of formatting your data yourself, you can also let this module do	460	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	461	the job by specifying a type and type-specific arguments.
360		462
361	Predefined types are (if you have ideas for additional types, feel free to	463	Predefined types are (if you have ideas for additional types, feel free to
362	drop by and tell us):	464	drop by and tell us):
…		…
366	=item netstring => $string	468	=item netstring => $string
367		469
368	Formats the given value as netstring	470	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	471	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		472
371	=back
372
373	=cut	473	=cut
374		474
375	register_write_type netstring => sub {	475	register_write_type netstring => sub {
376	my ($self, $string) = @_;	476	my ($self, $string) = @_;
377		477
378	sprintf "%d:%s,", (length $string), $string	478	sprintf "%d:%s,", (length $string), $string
379	};	479	};
380		480
		481	=item json => $array_or_hashref
		482
		483	Encodes the given hash or array reference into a JSON object. Unless you
		484	provide your own JSON object, this means it will be encoded to JSON text
		485	in UTF-8.
		486
		487	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		488	one end of a handle and read them at the other end without using any
		489	additional framing.
		490
		491	The generated JSON text is guaranteed not to contain any newlines: While
		492	this module doesn't need delimiters after or between JSON texts to be
		493	able to read them, many other languages depend on that.
		494
		495	A simple RPC protocol that interoperates easily with others is to send
		496	JSON arrays (or objects, although arrays are usually the better choice as
		497	they mimic how function argument passing works) and a newline after each
		498	JSON text:
		499
		500	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		501	$handle->push_write ("\012");
		502
		503	An AnyEvent::Handle receiver would simply use the C<json> read type and
		504	rely on the fact that the newline will be skipped as leading whitespace:
		505
		506	$handle->push_read (json => sub { my $array = $_[1]; ... });
		507
		508	Other languages could read single lines terminated by a newline and pass
		509	this line into their JSON decoder of choice.
		510
		511	=cut
		512
		513	register_write_type json => sub {
		514	my ($self, $ref) = @_;
		515
		516	require JSON;
		517
		518	$self->{json} ? $self->{json}->encode ($ref)
		519	: JSON::encode_json ($ref)
		520	};
		521
		522	=back
		523
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		525
383	This function (not method) lets you add your own types to C<push_write>.	526	This function (not method) lets you add your own types to C<push_write>.
384	Whenever the given C<type> is used, C<push_write> will invoke the code	527	Whenever the given C<type> is used, C<push_write> will invoke the code
385	reference with the handle object and the remaining arguments.	528	reference with the handle object and the remaining arguments.
386		529
…		…
422	the specified number of bytes which give an XML datagram.	565	the specified number of bytes which give an XML datagram.
423		566
424	# in the default state, expect some header bytes	567	# in the default state, expect some header bytes
425	$handle->on_read (sub {	568	$handle->on_read (sub {
426	# some data is here, now queue the length-header-read (4 octets)	569	# some data is here, now queue the length-header-read (4 octets)
427	shift->unshift_read_chunk (4, sub {	570	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	571	# header arrived, decode
429	my $len = unpack "N", $_[1];	572	my $len = unpack "N", $_[1];
430		573
431	# now read the payload	574	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	575	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	576	my $xml = $_[1];
434	# handle xml	577	# handle xml
435	});	578	});
436	});	579	});
437	});	580	});
…		…
444		587
445	# request one	588	# request one
446	$handle->push_write ("request 1\015\012");	589	$handle->push_write ("request 1\015\012");
447		590
448	# we expect "ERROR" or "OK" as response, so push a line read	591	# we expect "ERROR" or "OK" as response, so push a line read
449	$handle->push_read_line (sub {	592	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	593	# if we got an "OK", we have to _prepend_ another line,
451	# so it will be read before the second request reads its 64 bytes	594	# so it will be read before the second request reads its 64 bytes
452	# which are already in the queue when this callback is called	595	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	596	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	597	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	598	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	599	my $response = $_[1];
457	...	600	...
458	});	601	});
459	}	602	}
460	});	603	});
461		604
462	# request two	605	# request two
463	$handle->push_write ("request 2\015\012");	606	$handle->push_write ("request 2\015\012");
464		607
465	# simply read 64 bytes, always	608	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	609	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	610	my $response = $_[1];
468	...	611	...
469	});	612	});
470		613
471	=over 4	614	=over 4
472		615
473	=cut	616	=cut
474		617
475	sub _drain_rbuf {	618	sub _drain_rbuf {
476	my ($self) = @_;	619	my ($self) = @_;
		620
		621	local $self->{_in_drain} = 1;
477		622
478	if (	623	if (
479	defined $self->{rbuf_max}	624	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	625	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	626	) {
482	$! = &Errno::ENOSPC;	627	return $self->_error (&Errno::ENOSPC, 1);
483	$self->error;
484	}	628	}
485		629
486	return if $self->{in_drain};	630	while () {
487	local $self->{in_drain} = 1;
488
489	while (my $len = length $self->{rbuf}) {
490	no strict 'refs';	631	no strict 'refs';
		632
		633	my $len = length $self->{rbuf};
		634
491	if (my $cb = shift @{ $self->{_queue} }) {	635	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	636	unless ($cb->($self)) {
493	if ($self->{_eof}) {	637	if ($self->{_eof}) {
494	# no progress can be made (not enough data and no data forthcoming)	638	# no progress can be made (not enough data and no data forthcoming)
495	$! = &Errno::EPIPE;	639	return $self->_error (&Errno::EPIPE, 1);
496	$self->error;
497	}	640	}
498		641
499	unshift @{ $self->{_queue} }, $cb;	642	unshift @{ $self->{_queue} }, $cb;
500	return;	643	last;
501	}	644	}
502	} elsif ($self->{on_read}) {	645	} elsif ($self->{on_read}) {
503	$self->{on_read}($self);	646	$self->{on_read}($self);
504		647
505	if (	648	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	649	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	650	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	651	&& $self->{on_read} # but we still have on_read
510	) {	652	) {
		653	# no further data will arrive
511	# then no progress can be made	654	# so no progress can be made
512	$! = &Errno::EPIPE;	655	return $self->_error (&Errno::EPIPE, 1)
513	$self->error;	656	if $self->{_eof};
		657
		658	last; # more data might arrive
514	}	659	}
515	} else {	660	} else {
516	# read side becomes idle	661	# read side becomes idle
517	delete $self->{_rw};	662	delete $self->{_rw};
518	return;	663	last;
519	}	664	}
520	}	665	}
521		666
522	if ($self->{_eof}) {
523	$self->_shutdown;
524	$self->{on_eof}($self)	667	$self->{on_eof}($self)
525	if $self->{on_eof};	668	if $self->{_eof} && $self->{on_eof};
		669
		670	# may need to restart read watcher
		671	unless ($self->{_rw}) {
		672	$self->start_read
		673	if $self->{on_read} \|\| @{ $self->{_queue} };
526	}	674	}
527	}	675	}
528		676
529	=item $handle->on_read ($cb)	677	=item $handle->on_read ($cb)
530		678
…		…
536		684
537	sub on_read {	685	sub on_read {
538	my ($self, $cb) = @_;	686	my ($self, $cb) = @_;
539		687
540	$self->{on_read} = $cb;	688	$self->{on_read} = $cb;
		689	$self->_drain_rbuf if $cb && !$self->{_in_drain};
541	}	690	}
542		691
543	=item $handle->rbuf	692	=item $handle->rbuf
544		693
545	Returns the read buffer (as a modifiable lvalue).	694	Returns the read buffer (as a modifiable lvalue).
…		…
594	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	743	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
595	->($self, $cb, @_);	744	->($self, $cb, @_);
596	}	745	}
597		746
598	push @{ $self->{_queue} }, $cb;	747	push @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	748	$self->_drain_rbuf unless $self->{_in_drain};
600	}	749	}
601		750
602	sub unshift_read {	751	sub unshift_read {
603	my $self = shift;	752	my $self = shift;
604	my $cb = pop;	753	my $cb = pop;
…		…
610	->($self, $cb, @_);	759	->($self, $cb, @_);
611	}	760	}
612		761
613		762
614	unshift @{ $self->{_queue} }, $cb;	763	unshift @{ $self->{_queue} }, $cb;
615	$self->_drain_rbuf;	764	$self->_drain_rbuf unless $self->{_in_drain};
616	}	765	}
617		766
618	=item $handle->push_read (type => @args, $cb)	767	=item $handle->push_read (type => @args, $cb)
619		768
620	=item $handle->unshift_read (type => @args, $cb)	769	=item $handle->unshift_read (type => @args, $cb)
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	775	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	776	drop by and tell us):
628		777
629	=over 4	778	=over 4
630		779
631	=item chunk => $octets, $cb->($self, $data)	780	=item chunk => $octets, $cb->($handle, $data)
632		781
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	782	Invoke the callback only once C<$octets> bytes have been read. Pass the
634	data read to the callback. The callback will never be called with less	783	data read to the callback. The callback will never be called with less
635	data.	784	data.
636		785
…		…
659		808
660	sub unshift_read_chunk {	809	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);	810	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}	811	}
663		812
664	=item line => [$eol, ]$cb->($self, $line, $eol)	813	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		814
666	The callback will be called only once a full line (including the end of	815	The callback will be called only once a full line (including the end of
667	line marker, C<$eol>) has been read. This line (excluding the end of line	816	line marker, C<$eol>) has been read. This line (excluding the end of line
668	marker) will be passed to the callback as second argument (C<$line>), and	817	marker) will be passed to the callback as second argument (C<$line>), and
669	the end of line marker as the third argument (C<$eol>).	818	the end of line marker as the third argument (C<$eol>).
…		…
706	sub unshift_read_line {	855	sub unshift_read_line {
707	my $self = shift;	856	my $self = shift;
708	$self->unshift_read (line => @_);	857	$self->unshift_read (line => @_);
709	}	858	}
710		859
711	=item netstring => $cb->($string)	860	=item netstring => $cb->($handle, $string)
712		861
713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	862	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
714		863
715	Throws an error with C<$!> set to EBADMSG on format violations.	864	Throws an error with C<$!> set to EBADMSG on format violations.
716		865
…		…
720	my ($self, $cb) = @_;	869	my ($self, $cb) = @_;
721		870
722	sub {	871	sub {
723	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	872	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
724	if ($_[0]{rbuf} =~ /[^0-9]/) {	873	if ($_[0]{rbuf} =~ /[^0-9]/) {
725	$! = &Errno::EBADMSG;	874	$self->_error (&Errno::EBADMSG);
726	$self->error;
727	}	875	}
728	return;	876	return;
729	}	877	}
730		878
731	my $len = $1;	879	my $len = $1;
…		…
734	my $string = $_[1];	882	my $string = $_[1];
735	$_[0]->unshift_read (chunk => 1, sub {	883	$_[0]->unshift_read (chunk => 1, sub {
736	if ($_[1] eq ",") {	884	if ($_[1] eq ",") {
737	$cb->($_[0], $string);	885	$cb->($_[0], $string);
738	} else {	886	} else {
739	$! = &Errno::EBADMSG;	887	$self->_error (&Errno::EBADMSG);
740	$self->error;
741	}	888	}
742	});	889	});
743	});	890	});
744		891
745	1	892	1
746	}	893	}
747	};	894	};
748		895
749	=item regex => $accept[, $reject[, $skip], $cb->($data)	896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		897
751	Makes a regex match against the regex object C<$accept> and returns	898	Makes a regex match against the regex object C<$accept> and returns
752	everything up to and including the match.	899	everything up to and including the match.
753		900
754	Example: read a single line terminated by '\n'.	901	Example: read a single line terminated by '\n'.
…		…
802	return 1;	949	return 1;
803	}	950	}
804		951
805	# reject	952	# reject
806	if ($reject && $$rbuf =~ $reject) {	953	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	954	$self->_error (&Errno::EBADMSG);
808	$self->error;
809	}	955	}
810		956
811	# skip	957	# skip
812	if ($skip && $$rbuf =~ $skip) {	958	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	959	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		961
816	()	962	()
817	}	963	}
818	};	964	};
819		965
		966	=item json => $cb->($handle, $hash_or_arrayref)
		967
		968	Reads a JSON object or array, decodes it and passes it to the callback.
		969
		970	If a C<json> object was passed to the constructor, then that will be used
		971	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		972
		973	This read type uses the incremental parser available with JSON version
		974	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		975	dependency on your own: this module will load the JSON module, but
		976	AnyEvent does not depend on it itself.
		977
		978	Since JSON texts are fully self-delimiting, the C<json> read and write
		979	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		980	the C<json> write type description, above, for an actual example.
		981
		982	=cut
		983
		984	register_read_type json => sub {
		985	my ($self, $cb, $accept, $reject, $skip) = @_;
		986
		987	require JSON;
		988
		989	my $data;
		990	my $rbuf = \$self->{rbuf};
		991
		992	my $json = $self->{json} \|\|= JSON->new->utf8;
		993
		994	sub {
		995	my $ref = $json->incr_parse ($self->{rbuf});
		996
		997	if ($ref) {
		998	$self->{rbuf} = $json->incr_text;
		999	$json->incr_text = "";
		1000	$cb->($self, $ref);
		1001
		1002	1
		1003	} else {
		1004	$self->{rbuf} = "";
		1005	()
		1006	}
		1007	}
		1008	};
		1009
820	=back	1010	=back
821		1011
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1012	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1013
824	This function (not method) lets you add your own types to C<push_read>.	1014	This function (not method) lets you add your own types to C<push_read>.
825		1015
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1016	Whenever the given C<type> is used, C<push_read> will invoke the code
827	reference with the handle object, the callback and the remaining	1017	reference with the handle object, the callback and the remaining
…		…
829		1019
830	The code reference is supposed to return a callback (usually a closure)	1020	The code reference is supposed to return a callback (usually a closure)
831	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1021	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1022
833	It should invoke the passed callback when it is done reading (remember to	1023	It should invoke the passed callback when it is done reading (remember to
834	pass C<$self> as first argument as all other callbacks do that).	1024	pass C<$handle> as first argument as all other callbacks do that).
835		1025
836	Note that this is a function, and all types registered this way will be	1026	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1027	global, so try to use unique names.
838		1028
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1029	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
842	=item $handle->stop_read	1032	=item $handle->stop_read
843		1033
844	=item $handle->start_read	1034	=item $handle->start_read
845		1035
846	In rare cases you actually do not want to read anything from the	1036	In rare cases you actually do not want to read anything from the
847	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1037	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
848	any queued callbacks will be executed then. To start reading again, call	1038	any queued callbacks will be executed then. To start reading again, call
849	C<start_read>.	1039	C<start_read>.
		1040
		1041	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1042	you change the C<on_read> callback or push/unshift a read callback, and it
		1043	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1044	there are any read requests in the queue.
850		1045
851	=cut	1046	=cut
852		1047
853	sub stop_read {	1048	sub stop_read {
854	my ($self) = @_;	1049	my ($self) = @_;
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1060	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1061	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1062	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
868		1063
869	if ($len > 0) {	1064	if ($len > 0) {
		1065	$self->{_activity} = AnyEvent->now;
		1066
870	$self->{filter_r}	1067	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1068	? $self->{filter_r}($self, $rbuf)
872	: $self->_drain_rbuf;	1069	: $self->{_in_drain} \|\| $self->_drain_rbuf;
873		1070
874	} elsif (defined $len) {	1071	} elsif (defined $len) {
875	delete $self->{_rw};	1072	delete $self->{_rw};
876	$self->{_eof} = 1;	1073	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1074	$self->_drain_rbuf unless $self->{_in_drain};
878		1075
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1076	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1077	return $self->_error ($!, 1);
881	}	1078	}
882	});	1079	});
883	}	1080	}
884	}	1081	}
885		1082
886	sub _dotls {	1083	sub _dotls {
887	my ($self) = @_;	1084	my ($self) = @_;
		1085
		1086	my $buf;
888		1087
889	if (length $self->{_tls_wbuf}) {	1088	if (length $self->{_tls_wbuf}) {
890	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1089	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1090	substr $self->{_tls_wbuf}, 0, $len, "";
892	}	1091	}
893	}	1092	}
894		1093
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1094	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1095	$self->{wbuf} .= $buf;
897	$self->_drain_wbuf;	1096	$self->_drain_wbuf;
898	}	1097	}
899		1098
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1099	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1100	if (length $buf) {
901	$self->{rbuf} .= $buf;	1101	$self->{rbuf} .= $buf;
902	$self->_drain_rbuf;	1102	$self->_drain_rbuf unless $self->{_in_drain};
		1103	} else {
		1104	# let's treat SSL-eof as we treat normal EOF
		1105	$self->{_eof} = 1;
		1106	$self->_shutdown;
		1107	return;
		1108	}
903	}	1109	}
904		1110
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1111	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906		1112
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1113	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1114	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;	1115	return $self->_error ($!, 1);
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1116	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;	1117	return $self->_error (&Errno::EIO, 1);
912	$self->error;
913	}	1118	}
914		1119
915	# all others are fine for our purposes	1120	# all others are fine for our purposes
916	}	1121	}
917	}	1122	}
…		…
932	call and can be used or changed to your liking. Note that the handshake	1137	call and can be used or changed to your liking. Note that the handshake
933	might have already started when this function returns.	1138	might have already started when this function returns.
934		1139
935	=cut	1140	=cut
936		1141
937	# TODO: maybe document...
938	sub starttls {	1142	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1143	my ($self, $ssl, $ctx) = @_;
940		1144
941	$self->stoptls;	1145	$self->stoptls;
942		1146

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs. Revision 1.60 by root, Thu Jun 5 18:30:08 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.60 by root, Thu Jun 5 18:30:08 2008 UTC