[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.69 by root, Sun Jun 15 21:44:56 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.151;
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 (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<$self->{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
114	feed all the remaining data to the queued callbacks and C<on_read> before	118	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	119	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>).	120	error will be raised (with C<$!> set to C<EPIPE>).
117		121
118	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
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.
		134
		135	=item timeout => $fractional_seconds
		136
		137	If non-zero, then this enables an "inactivity" timeout: whenever this many
		138	seconds pass without a successful read or write on the underlying file
		139	handle, the C<on_timeout> callback will be invoked (and if that one is
		140	missing, an C<ETIMEDOUT> error will be raised).
		141
		142	Note that timeout processing is also active when you currently do not have
		143	any outstanding read or write requests: If you plan to keep the connection
		144	idle then you should disable the timout temporarily or ignore the timeout
		145	in the C<on_timeout> callback.
		146
		147	Zero (the default) disables this timeout.
		148
		149	=item on_timeout => $cb->($handle)
		150
		151	Called whenever the inactivity timeout passes. If you return from this
		152	callback, then the timeout will be reset as if some activity had happened,
		153	so this condition is not fatal in any way.
124		154
125	=item rbuf_max => <bytes>	155	=item rbuf_max => <bytes>
126		156
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	157	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	158	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
135	isn't finished).	165	isn't finished).
136		166
137	=item read_size => <bytes>	167	=item read_size => <bytes>
138		168
139	The default read block size (the amount of bytes this module will try to read	169	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	170	during each (loop iteration). Default: C<8192>.
141		171
142	=item low_water_mark => <bytes>	172	=item low_water_mark => <bytes>
143		173
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	174	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	175	buffer: If the write reaches this size or gets even samller it is
146	considered empty.	176	considered empty.
		177
		178	=item linger => <seconds>
		179
		180	If non-zero (default: C<3600>), then the destructor of the
		181	AnyEvent::Handle object will check wether there is still outstanding write
		182	data and will install a watcher that will write out this data. No errors
		183	will be reported (this mostly matches how the operating system treats
		184	outstanding data at socket close time).
		185
		186	This will not work for partial TLS data that could not yet been
		187	encoded. This data will be lost.
147		188
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	189	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		190
150	When this parameter is given, it enables TLS (SSL) mode, that means it	191	When this parameter is given, it enables TLS (SSL) mode, that means it
151	will start making tls handshake and will transparently encrypt/decrypt	192	will start making tls handshake and will transparently encrypt/decrypt
…		…
168		209
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	210	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	211	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	212	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		213
		214	=item json => JSON or JSON::XS object
		215
		216	This is the json coder object used by the C<json> read and write types.
		217
		218	If you don't supply it, then AnyEvent::Handle will create and use a
		219	suitable one, which will write and expect UTF-8 encoded JSON texts.
		220
		221	Note that you are responsible to depend on the JSON module if you want to
		222	use this functionality, as AnyEvent does not have a dependency itself.
		223
173	=item filter_r => $cb	224	=item filter_r => $cb
174		225
175	=item filter_w => $cb	226	=item filter_w => $cb
176		227
177	These exist, but are undocumented at this time.	228	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	243	if ($self->{tls}) {
193	require Net::SSLeay;	244	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	245	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	246	}
196		247
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	248	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	249	$self->_timeout;
		250
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	251	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
201		252
202	$self->start_read;	253	$self->start_read
		254	if $self->{on_read};
203		255
204	$self	256	$self
205	}	257	}
206		258
207	sub _shutdown {	259	sub _shutdown {
208	my ($self) = @_;	260	my ($self) = @_;
209		261
		262	delete $self->{_tw};
210	delete $self->{_rw};	263	delete $self->{_rw};
211	delete $self->{_ww};	264	delete $self->{_ww};
212	delete $self->{fh};	265	delete $self->{fh};
213	}
214		266
		267	$self->stoptls;
		268	}
		269
215	sub error {	270	sub _error {
216	my ($self) = @_;	271	my ($self, $errno, $fatal) = @_;
217		272
218	{
219	local $!;
220	$self->_shutdown;	273	$self->_shutdown
221	}	274	if $fatal;
222		275
223	$self->{on_error}($self)	276	$! = $errno;
		277
224	if $self->{on_error};	278	if ($self->{on_error}) {
225		279	$self->{on_error}($self, $fatal);
		280	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	281	Carp::croak "AnyEvent::Handle uncaught error: $!";
		282	}
227	}	283	}
228		284
229	=item $fh = $handle->fh	285	=item $fh = $handle->fh
230		286
231	This method returns the file handle of the L<AnyEvent::Handle> object.	287	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
250		306
251	=cut	307	=cut
252		308
253	sub on_eof {	309	sub on_eof {
254	$_[0]{on_eof} = $_[1];	310	$_[0]{on_eof} = $_[1];
		311	}
		312
		313	=item $handle->on_timeout ($cb)
		314
		315	Replace the current C<on_timeout> callback, or disables the callback
		316	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		317	argument.
		318
		319	=cut
		320
		321	sub on_timeout {
		322	$_[0]{on_timeout} = $_[1];
		323	}
		324
		325	#############################################################################
		326
		327	=item $handle->timeout ($seconds)
		328
		329	Configures (or disables) the inactivity timeout.
		330
		331	=cut
		332
		333	sub timeout {
		334	my ($self, $timeout) = @_;
		335
		336	$self->{timeout} = $timeout;
		337	$self->_timeout;
		338	}
		339
		340	# reset the timeout watcher, as neccessary
		341	# also check for time-outs
		342	sub _timeout {
		343	my ($self) = @_;
		344
		345	if ($self->{timeout}) {
		346	my $NOW = AnyEvent->now;
		347
		348	# when would the timeout trigger?
		349	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		350
		351	# now or in the past already?
		352	if ($after <= 0) {
		353	$self->{_activity} = $NOW;
		354
		355	if ($self->{on_timeout}) {
		356	$self->{on_timeout}($self);
		357	} else {
		358	$self->_error (&Errno::ETIMEDOUT);
		359	}
		360
		361	# callback could have changed timeout value, optimise
		362	return unless $self->{timeout};
		363
		364	# calculate new after
		365	$after = $self->{timeout};
		366	}
		367
		368	Scalar::Util::weaken $self;
		369	return unless $self; # ->error could have destroyed $self
		370
		371	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		372	delete $self->{_tw};
		373	$self->_timeout;
		374	});
		375	} else {
		376	delete $self->{_tw};
		377	}
255	}	378	}
256		379
257	#############################################################################	380	#############################################################################
258		381
259	=back	382	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	429	my $len = syswrite $self->{fh}, $self->{wbuf};
307		430
308	if ($len >= 0) {	431	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	432	substr $self->{wbuf}, 0, $len, "";
310		433
		434	$self->{_activity} = AnyEvent->now;
		435
311	$self->{on_drain}($self)	436	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	437	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	438	&& $self->{on_drain};
314		439
315	delete $self->{_ww} unless length $self->{wbuf};	440	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	441	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	442	$self->_error ($!, 1);
318	}	443	}
319	};	444	};
320		445
321	# try to write data immediately	446	# try to write data immediately
322	$cb->();	447	$cb->();
…		…
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	467	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	468	->($self, @_);
344	}	469	}
345		470
346	if ($self->{filter_w}) {	471	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	472	$self->{filter_w}($self, \$_[0]);
348	} else {	473	} else {
349	$self->{wbuf} .= $_[0];	474	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	475	$self->_drain_wbuf;
351	}	476	}
352	}	477	}
353		478
354	=item $handle->push_write (type => @args)	479	=item $handle->push_write (type => @args)
355		480
356	=item $handle->unshift_write (type => @args)
357
358	Instead of formatting your data yourself, you can also let this module do	481	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	482	the job by specifying a type and type-specific arguments.
360		483
361	Predefined types are (if you have ideas for additional types, feel free to	484	Predefined types are (if you have ideas for additional types, feel free to
362	drop by and tell us):	485	drop by and tell us):
…		…
366	=item netstring => $string	489	=item netstring => $string
367		490
368	Formats the given value as netstring	491	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	492	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		493
371	=back
372
373	=cut	494	=cut
374		495
375	register_write_type netstring => sub {	496	register_write_type netstring => sub {
376	my ($self, $string) = @_;	497	my ($self, $string) = @_;
377		498
378	sprintf "%d:%s,", (length $string), $string	499	sprintf "%d:%s,", (length $string), $string
379	};	500	};
380		501
		502	=item packstring => $format, $data
		503
		504	An octet string prefixed with an encoded length. The encoding C<$format>
		505	uses the same format as a Perl C<pack> format, but must specify a single
		506	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		507	optional C<!>, C<< < >> or C<< > >> modifier).
		508
		509	=cut
		510
		511	register_write_type packstring => sub {
		512	my ($self, $format, $string) = @_;
		513
		514	pack "$format/a*", $string
		515	};
		516
		517	=item json => $array_or_hashref
		518
		519	Encodes the given hash or array reference into a JSON object. Unless you
		520	provide your own JSON object, this means it will be encoded to JSON text
		521	in UTF-8.
		522
		523	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		524	one end of a handle and read them at the other end without using any
		525	additional framing.
		526
		527	The generated JSON text is guaranteed not to contain any newlines: While
		528	this module doesn't need delimiters after or between JSON texts to be
		529	able to read them, many other languages depend on that.
		530
		531	A simple RPC protocol that interoperates easily with others is to send
		532	JSON arrays (or objects, although arrays are usually the better choice as
		533	they mimic how function argument passing works) and a newline after each
		534	JSON text:
		535
		536	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		537	$handle->push_write ("\012");
		538
		539	An AnyEvent::Handle receiver would simply use the C<json> read type and
		540	rely on the fact that the newline will be skipped as leading whitespace:
		541
		542	$handle->push_read (json => sub { my $array = $_[1]; ... });
		543
		544	Other languages could read single lines terminated by a newline and pass
		545	this line into their JSON decoder of choice.
		546
		547	=cut
		548
		549	register_write_type json => sub {
		550	my ($self, $ref) = @_;
		551
		552	require JSON;
		553
		554	$self->{json} ? $self->{json}->encode ($ref)
		555	: JSON::encode_json ($ref)
		556	};
		557
		558	=item storable => $reference
		559
		560	Freezes the given reference using L<Storable> and writes it to the
		561	handle. Uses the C<nfreeze> format.
		562
		563	=cut
		564
		565	register_write_type storable => sub {
		566	my ($self, $ref) = @_;
		567
		568	require Storable;
		569
		570	pack "w/a*", Storable::nfreeze ($ref)
		571	};
		572
		573	=back
		574
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	575	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		576
383	This function (not method) lets you add your own types to C<push_write>.	577	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	578	Whenever the given C<type> is used, C<push_write> will invoke the code
385	reference with the handle object and the remaining arguments.	579	reference with the handle object and the remaining arguments.
386		580
…		…
405	ways, the "simple" way, using only C<on_read> and the "complex" way, using	599	ways, the "simple" way, using only C<on_read> and the "complex" way, using
406	a queue.	600	a queue.
407		601
408	In the simple case, you just install an C<on_read> callback and whenever	602	In the simple case, you just install an C<on_read> callback and whenever
409	new data arrives, it will be called. You can then remove some data (if	603	new data arrives, it will be called. You can then remove some data (if
410	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	604	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
411	or not.	605	leave the data there if you want to accumulate more (e.g. when only a
		606	partial message has been received so far).
412		607
413	In the more complex case, you want to queue multiple callbacks. In this	608	In the more complex case, you want to queue multiple callbacks. In this
414	case, AnyEvent::Handle will call the first queued callback each time new	609	case, AnyEvent::Handle will call the first queued callback each time new
415	data arrives and removes it when it has done its job (see C<push_read>,	610	data arrives (also the first time it is queued) and removes it when it has
416	below).	611	done its job (see C<push_read>, below).
417		612
418	This way you can, for example, push three line-reads, followed by reading	613	This way you can, for example, push three line-reads, followed by reading
419	a chunk of data, and AnyEvent::Handle will execute them in order.	614	a chunk of data, and AnyEvent::Handle will execute them in order.
420		615
421	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	616	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
422	the specified number of bytes which give an XML datagram.	617	the specified number of bytes which give an XML datagram.
423		618
424	# in the default state, expect some header bytes	619	# in the default state, expect some header bytes
425	$handle->on_read (sub {	620	$handle->on_read (sub {
426	# some data is here, now queue the length-header-read (4 octets)	621	# some data is here, now queue the length-header-read (4 octets)
427	shift->unshift_read_chunk (4, sub {	622	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	623	# header arrived, decode
429	my $len = unpack "N", $_[1];	624	my $len = unpack "N", $_[1];
430		625
431	# now read the payload	626	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	627	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	628	my $xml = $_[1];
434	# handle xml	629	# handle xml
435	});	630	});
436	});	631	});
437	});	632	});
438		633
439	Example 2: Implement a client for a protocol that replies either with	634	Example 2: Implement a client for a protocol that replies either with "OK"
440	"OK" and another line or "ERROR" for one request, and 64 bytes for the	635	and another line or "ERROR" for the first request that is sent, and 64
441	second request. Due tot he availability of a full queue, we can just	636	bytes for the second request. Due to the availability of a queue, we can
442	pipeline sending both requests and manipulate the queue as necessary in	637	just pipeline sending both requests and manipulate the queue as necessary
443	the callbacks:	638	in the callbacks.
444		639
445	# request one	640	When the first callback is called and sees an "OK" response, it will
		641	C<unshift> another line-read. This line-read will be queued I<before> the
		642	64-byte chunk callback.
		643
		644	# request one, returns either "OK + extra line" or "ERROR"
446	$handle->push_write ("request 1\015\012");	645	$handle->push_write ("request 1\015\012");
447		646
448	# we expect "ERROR" or "OK" as response, so push a line read	647	# we expect "ERROR" or "OK" as response, so push a line read
449	$handle->push_read_line (sub {	648	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	649	# 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	650	# 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	651	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	652	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	653	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	654	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	655	my $response = $_[1];
457	...	656	...
458	});	657	});
459	}	658	}
460	});	659	});
461		660
462	# request two	661	# request two, simply returns 64 octets
463	$handle->push_write ("request 2\015\012");	662	$handle->push_write ("request 2\015\012");
464		663
465	# simply read 64 bytes, always	664	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	665	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	666	my $response = $_[1];
468	...	667	...
469	});	668	});
470		669
471	=over 4	670	=over 4
472		671
473	=cut	672	=cut
474		673
475	sub _drain_rbuf {	674	sub _drain_rbuf {
476	my ($self) = @_;	675	my ($self) = @_;
		676
		677	local $self->{_in_drain} = 1;
477		678
478	if (	679	if (
479	defined $self->{rbuf_max}	680	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	681	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	682	) {
482	$! = &Errno::ENOSPC;	683	return $self->_error (&Errno::ENOSPC, 1);
483	$self->error;
484	}	684	}
485		685
486	return if $self->{in_drain};	686	while () {
487	local $self->{in_drain} = 1;
488
489	while (my $len = length $self->{rbuf}) {
490	no strict 'refs';	687	no strict 'refs';
		688
		689	my $len = length $self->{rbuf};
		690
491	if (my $cb = shift @{ $self->{_queue} }) {	691	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	692	unless ($cb->($self)) {
493	if ($self->{_eof}) {	693	if ($self->{_eof}) {
494	# no progress can be made (not enough data and no data forthcoming)	694	# no progress can be made (not enough data and no data forthcoming)
495	$! = &Errno::EPIPE;	695	$self->_error (&Errno::EPIPE, 1), last;
496	$self->error;
497	}	696	}
498		697
499	unshift @{ $self->{_queue} }, $cb;	698	unshift @{ $self->{_queue} }, $cb;
500	return;	699	last;
501	}	700	}
502	} elsif ($self->{on_read}) {	701	} elsif ($self->{on_read}) {
		702	last unless $len;
		703
503	$self->{on_read}($self);	704	$self->{on_read}($self);
504		705
505	if (	706	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	707	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	708	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	709	&& $self->{on_read} # but we still have on_read
510	) {	710	) {
		711	# no further data will arrive
511	# then no progress can be made	712	# so no progress can be made
512	$! = &Errno::EPIPE;	713	$self->_error (&Errno::EPIPE, 1), last
513	$self->error;	714	if $self->{_eof};
		715
		716	last; # more data might arrive
514	}	717	}
515	} else {	718	} else {
516	# read side becomes idle	719	# read side becomes idle
517	delete $self->{_rw};	720	delete $self->{_rw};
518	return;	721	last;
519	}	722	}
520	}	723	}
521		724
522	if ($self->{_eof}) {
523	$self->_shutdown;
524	$self->{on_eof}($self)	725	$self->{on_eof}($self)
525	if $self->{on_eof};	726	if $self->{_eof} && $self->{on_eof};
		727
		728	# may need to restart read watcher
		729	unless ($self->{_rw}) {
		730	$self->start_read
		731	if $self->{on_read} \|\| @{ $self->{_queue} };
526	}	732	}
527	}	733	}
528		734
529	=item $handle->on_read ($cb)	735	=item $handle->on_read ($cb)
530		736
…		…
536		742
537	sub on_read {	743	sub on_read {
538	my ($self, $cb) = @_;	744	my ($self, $cb) = @_;
539		745
540	$self->{on_read} = $cb;	746	$self->{on_read} = $cb;
		747	$self->_drain_rbuf if $cb && !$self->{_in_drain};
541	}	748	}
542		749
543	=item $handle->rbuf	750	=item $handle->rbuf
544		751
545	Returns the read buffer (as a modifiable lvalue).	752	Returns the read buffer (as a modifiable lvalue).
…		…
594	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	801	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
595	->($self, $cb, @_);	802	->($self, $cb, @_);
596	}	803	}
597		804
598	push @{ $self->{_queue} }, $cb;	805	push @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	806	$self->_drain_rbuf unless $self->{_in_drain};
600	}	807	}
601		808
602	sub unshift_read {	809	sub unshift_read {
603	my $self = shift;	810	my $self = shift;
604	my $cb = pop;	811	my $cb = pop;
…		…
610	->($self, $cb, @_);	817	->($self, $cb, @_);
611	}	818	}
612		819
613		820
614	unshift @{ $self->{_queue} }, $cb;	821	unshift @{ $self->{_queue} }, $cb;
615	$self->_drain_rbuf;	822	$self->_drain_rbuf unless $self->{_in_drain};
616	}	823	}
617		824
618	=item $handle->push_read (type => @args, $cb)	825	=item $handle->push_read (type => @args, $cb)
619		826
620	=item $handle->unshift_read (type => @args, $cb)	827	=item $handle->unshift_read (type => @args, $cb)
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	833	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	834	drop by and tell us):
628		835
629	=over 4	836	=over 4
630		837
631	=item chunk => $octets, $cb->($self, $data)	838	=item chunk => $octets, $cb->($handle, $data)
632		839
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	840	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	841	data read to the callback. The callback will never be called with less
635	data.	842	data.
636		843
…		…
659		866
660	sub unshift_read_chunk {	867	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);	868	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}	869	}
663		870
664	=item line => [$eol, ]$cb->($self, $line, $eol)	871	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		872
666	The callback will be called only once a full line (including the end of	873	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	874	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	875	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>).	876	the end of line marker as the third argument (C<$eol>).
…		…
706	sub unshift_read_line {	913	sub unshift_read_line {
707	my $self = shift;	914	my $self = shift;
708	$self->unshift_read (line => @_);	915	$self->unshift_read (line => @_);
709	}	916	}
710		917
711	=item netstring => $cb->($string)
712
713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
714
715	Throws an error with C<$!> set to EBADMSG on format violations.
716
717	=cut
718
719	register_read_type netstring => sub {
720	my ($self, $cb) = @_;
721
722	sub {
723	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
724	if ($_[0]{rbuf} =~ /[^0-9]/) {
725	$! = &Errno::EBADMSG;
726	$self->error;
727	}
728	return;
729	}
730
731	my $len = $1;
732
733	$self->unshift_read (chunk => $len, sub {
734	my $string = $_[1];
735	$_[0]->unshift_read (chunk => 1, sub {
736	if ($_[1] eq ",") {
737	$cb->($_[0], $string);
738	} else {
739	$! = &Errno::EBADMSG;
740	$self->error;
741	}
742	});
743	});
744
745	1
746	}
747	};
748
749	=item regex => $accept[, $reject[, $skip], $cb->($data)	918	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		919
751	Makes a regex match against the regex object C<$accept> and returns	920	Makes a regex match against the regex object C<$accept> and returns
752	everything up to and including the match.	921	everything up to and including the match.
753		922
754	Example: read a single line terminated by '\n'.	923	Example: read a single line terminated by '\n'.
…		…
802	return 1;	971	return 1;
803	}	972	}
804		973
805	# reject	974	# reject
806	if ($reject && $$rbuf =~ $reject) {	975	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	976	$self->_error (&Errno::EBADMSG);
808	$self->error;
809	}	977	}
810		978
811	# skip	979	# skip
812	if ($skip && $$rbuf =~ $skip) {	980	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	981	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		983
816	()	984	()
817	}	985	}
818	};	986	};
819		987
		988	=item netstring => $cb->($handle, $string)
		989
		990	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		991
		992	Throws an error with C<$!> set to EBADMSG on format violations.
		993
		994	=cut
		995
		996	register_read_type netstring => sub {
		997	my ($self, $cb) = @_;
		998
		999	sub {
		1000	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1001	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1002	$self->_error (&Errno::EBADMSG);
		1003	}
		1004	return;
		1005	}
		1006
		1007	my $len = $1;
		1008
		1009	$self->unshift_read (chunk => $len, sub {
		1010	my $string = $_[1];
		1011	$_[0]->unshift_read (chunk => 1, sub {
		1012	if ($_[1] eq ",") {
		1013	$cb->($_[0], $string);
		1014	} else {
		1015	$self->_error (&Errno::EBADMSG);
		1016	}
		1017	});
		1018	});
		1019
		1020	1
		1021	}
		1022	};
		1023
		1024	=item packstring => $format, $cb->($handle, $string)
		1025
		1026	An octet string prefixed with an encoded length. The encoding C<$format>
		1027	uses the same format as a Perl C<pack> format, but must specify a single
		1028	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1029	optional C<!>, C<< < >> or C<< > >> modifier).
		1030
		1031	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1032
		1033	Example: read a block of data prefixed by its length in BER-encoded
		1034	format (very efficient).
		1035
		1036	$handle->push_read (packstring => "w", sub {
		1037	my ($handle, $data) = @_;
		1038	});
		1039
		1040	=cut
		1041
		1042	register_read_type packstring => sub {
		1043	my ($self, $cb, $format) = @_;
		1044
		1045	sub {
		1046	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1047	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1048	or return;
		1049
		1050	# remove prefix
		1051	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1052
		1053	# read rest
		1054	$_[0]->unshift_read (chunk => $len, $cb);
		1055
		1056	1
		1057	}
		1058	};
		1059
		1060	=item json => $cb->($handle, $hash_or_arrayref)
		1061
		1062	Reads a JSON object or array, decodes it and passes it to the callback.
		1063
		1064	If a C<json> object was passed to the constructor, then that will be used
		1065	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1066
		1067	This read type uses the incremental parser available with JSON version
		1068	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1069	dependency on your own: this module will load the JSON module, but
		1070	AnyEvent does not depend on it itself.
		1071
		1072	Since JSON texts are fully self-delimiting, the C<json> read and write
		1073	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1074	the C<json> write type description, above, for an actual example.
		1075
		1076	=cut
		1077
		1078	register_read_type json => sub {
		1079	my ($self, $cb) = @_;
		1080
		1081	require JSON;
		1082
		1083	my $data;
		1084	my $rbuf = \$self->{rbuf};
		1085
		1086	my $json = $self->{json} \|\|= JSON->new->utf8;
		1087
		1088	sub {
		1089	my $ref = $json->incr_parse ($self->{rbuf});
		1090
		1091	if ($ref) {
		1092	$self->{rbuf} = $json->incr_text;
		1093	$json->incr_text = "";
		1094	$cb->($self, $ref);
		1095
		1096	1
		1097	} else {
		1098	$self->{rbuf} = "";
		1099	()
		1100	}
		1101	}
		1102	};
		1103
		1104	=item storable => $cb->($handle, $ref)
		1105
		1106	Deserialises a L<Storable> frozen representation as written by the
		1107	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1108	data).
		1109
		1110	Raises C<EBADMSG> error if the data could not be decoded.
		1111
		1112	=cut
		1113
		1114	register_read_type storable => sub {
		1115	my ($self, $cb) = @_;
		1116
		1117	require Storable;
		1118
		1119	sub {
		1120	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1121	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1122	or return;
		1123
		1124	# remove prefix
		1125	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1126
		1127	# read rest
		1128	$_[0]->unshift_read (chunk => $len, sub {
		1129	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1130	$cb->($_[0], $ref);
		1131	} else {
		1132	$self->_error (&Errno::EBADMSG);
		1133	}
		1134	});
		1135	}
		1136	};
		1137
820	=back	1138	=back
821		1139
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1140	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1141
824	This function (not method) lets you add your own types to C<push_read>.	1142	This function (not method) lets you add your own types to C<push_read>.
825		1143
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1144	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	1145	reference with the handle object, the callback and the remaining
…		…
829		1147
830	The code reference is supposed to return a callback (usually a closure)	1148	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) >>).	1149	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1150
833	It should invoke the passed callback when it is done reading (remember to	1151	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).	1152	pass C<$handle> as first argument as all other callbacks do that).
835		1153
836	Note that this is a function, and all types registered this way will be	1154	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1155	global, so try to use unique names.
838		1156
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1157	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
842	=item $handle->stop_read	1160	=item $handle->stop_read
843		1161
844	=item $handle->start_read	1162	=item $handle->start_read
845		1163
846	In rare cases you actually do not want to read anything from the	1164	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	1165	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	1166	any queued callbacks will be executed then. To start reading again, call
849	C<start_read>.	1167	C<start_read>.
		1168
		1169	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1170	you change the C<on_read> callback or push/unshift a read callback, and it
		1171	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1172	there are any read requests in the queue.
850		1173
851	=cut	1174	=cut
852		1175
853	sub stop_read {	1176	sub stop_read {
854	my ($self) = @_;	1177	my ($self) = @_;
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1188	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1189	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1190	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
868		1191
869	if ($len > 0) {	1192	if ($len > 0) {
		1193	$self->{_activity} = AnyEvent->now;
		1194
870	$self->{filter_r}	1195	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1196	? $self->{filter_r}($self, $rbuf)
872	: $self->_drain_rbuf;	1197	: $self->{_in_drain} \|\| $self->_drain_rbuf;
873		1198
874	} elsif (defined $len) {	1199	} elsif (defined $len) {
875	delete $self->{_rw};	1200	delete $self->{_rw};
876	$self->{_eof} = 1;	1201	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1202	$self->_drain_rbuf unless $self->{_in_drain};
878		1203
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1204	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1205	return $self->_error ($!, 1);
881	}	1206	}
882	});	1207	});
883	}	1208	}
884	}	1209	}
885		1210
886	sub _dotls {	1211	sub _dotls {
887	my ($self) = @_;	1212	my ($self) = @_;
		1213
		1214	my $buf;
888		1215
889	if (length $self->{_tls_wbuf}) {	1216	if (length $self->{_tls_wbuf}) {
890	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1217	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1218	substr $self->{_tls_wbuf}, 0, $len, "";
892	}	1219	}
893	}	1220	}
894		1221
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1222	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1223	$self->{wbuf} .= $buf;
897	$self->_drain_wbuf;	1224	$self->_drain_wbuf;
898	}	1225	}
899		1226
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1227	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1228	if (length $buf) {
901	$self->{rbuf} .= $buf;	1229	$self->{rbuf} .= $buf;
902	$self->_drain_rbuf;	1230	$self->_drain_rbuf unless $self->{_in_drain};
		1231	} else {
		1232	# let's treat SSL-eof as we treat normal EOF
		1233	$self->{_eof} = 1;
		1234	$self->_shutdown;
		1235	return;
		1236	}
903	}	1237	}
904		1238
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1239	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906		1240
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1241	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1242	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;	1243	return $self->_error ($!, 1);
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1244	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;	1245	return $self->_error (&Errno::EIO, 1);
912	$self->error;
913	}	1246	}
914		1247
915	# all others are fine for our purposes	1248	# all others are fine for our purposes
916	}	1249	}
917	}	1250	}
…		…
932	call and can be used or changed to your liking. Note that the handshake	1265	call and can be used or changed to your liking. Note that the handshake
933	might have already started when this function returns.	1266	might have already started when this function returns.
934		1267
935	=cut	1268	=cut
936		1269
937	# TODO: maybe document...
938	sub starttls {	1270	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1271	my ($self, $ssl, $ctx) = @_;
940		1272
941	$self->stoptls;	1273	$self->stoptls;
942		1274
…		…
995		1327
996	sub DESTROY {	1328	sub DESTROY {
997	my $self = shift;	1329	my $self = shift;
998		1330
999	$self->stoptls;	1331	$self->stoptls;
		1332
		1333	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1334
		1335	if ($linger && length $self->{wbuf}) {
		1336	my $fh = delete $self->{fh};
		1337	my $wbuf = delete $self->{wbuf};
		1338
		1339	my @linger;
		1340
		1341	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1342	my $len = syswrite $fh, $wbuf, length $wbuf;
		1343
		1344	if ($len > 0) {
		1345	substr $wbuf, 0, $len, "";
		1346	} else {
		1347	@linger = (); # end
		1348	}
		1349	});
		1350	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1351	@linger = ();
		1352	});
		1353	}
1000	}	1354	}
1001		1355
1002	=item AnyEvent::Handle::TLS_CTX	1356	=item AnyEvent::Handle::TLS_CTX
1003		1357
1004	This function creates and returns the Net::SSLeay::CTX object used by	1358	This function creates and returns the Net::SSLeay::CTX object used by

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.69 by root, Sun Jun 15 21:44:56 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.69 by root, Sun Jun 15 21:44:56 2008 UTC