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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.31 by root, Sun May 25 00:08:49 2008 UTC vs.
Revision 1.52 by root, Mon Jun 2 09:10:38 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 ();	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.1;
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		102
98	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
99	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
100	die.	105	C<croak>.
101		106
102	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
103		108
104	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
105	and no read request is in the queue.	110	and no read request is in the queue.
106		111
107	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 >>
108	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
109		114
110	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
111	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
112	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
113	error will be raised (with C<$!> set to C<EPIPE>).	118	error will be raised (with C<$!> set to C<EPIPE>).
114		119
115	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
116		121
117	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
118	(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).
119		124
120	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.
121		146
122	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
123		148
124	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>)
125	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
…		…
132	isn't finished).	157	isn't finished).
133		158
134	=item read_size => <bytes>	159	=item read_size => <bytes>
135		160
136	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
137	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
138		163
139	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
140		165
141	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
142	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
…		…
165		190
166	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
167	(unless a connection object was specified directly). If this parameter is	192	(unless a connection object was specified directly). If this parameter is
168	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
169		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
		205	=item filter_r => $cb
		206
		207	=item filter_w => $cb
		208
		209	These exist, but are undocumented at this time.
		210
170	=back	211	=back
171		212
172	=cut	213	=cut
173		214
174	sub new {	215	sub new {
…		…
183	if ($self->{tls}) {	224	if ($self->{tls}) {
184	require Net::SSLeay;	225	require Net::SSLeay;
185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
186	}	227	}
187		228
188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
189	$self->on_error (delete $self->{on_error}) if $self->{on_error};	230	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
		231	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
192		236
193	$self->start_read;	237	$self->start_read;
194		238
195	$self	239	$self
196	}	240	}
197		241
198	sub _shutdown {	242	sub _shutdown {
199	my ($self) = @_;	243	my ($self) = @_;
200		244
		245	delete $self->{_tw};
201	delete $self->{rw};	246	delete $self->{_rw};
202	delete $self->{ww};	247	delete $self->{_ww};
203	delete $self->{fh};	248	delete $self->{fh};
204	}
205		249
		250	$self->stoptls;
		251	}
		252
206	sub error {	253	sub _error {
207	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
208		255
209	{
210	local $!;
211	$self->_shutdown;	256	$self->_shutdown
212	}	257	if $fatal;
		258
		259	$! = $errno;
213		260
214	if ($self->{on_error}) {	261	if ($self->{on_error}) {
215	$self->{on_error}($self);	262	$self->{on_error}($self, $fatal);
216	} else {	263	} else {
217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
218	}	265	}
219	}	266	}
220		267
221	=item $fh = $handle->fh	268	=item $fh = $handle->fh
222		269
223	This method returns the file handle of the L<AnyEvent::Handle> object.	270	This method returns the file handle of the L<AnyEvent::Handle> object.
224		271
225	=cut	272	=cut
226		273
227	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
228		275
229	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
230		277
231	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	278	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
232		279
…		…
242		289
243	=cut	290	=cut
244		291
245	sub on_eof {	292	sub on_eof {
246	$_[0]{on_eof} = $_[1];	293	$_[0]{on_eof} = $_[1];
		294	}
		295
		296	=item $handle->on_timeout ($cb)
		297
		298	Replace the current C<on_timeout> callback, or disables the callback
		299	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		300	argument.
		301
		302	=cut
		303
		304	sub on_timeout {
		305	$_[0]{on_timeout} = $_[1];
		306	}
		307
		308	#############################################################################
		309
		310	=item $handle->timeout ($seconds)
		311
		312	Configures (or disables) the inactivity timeout.
		313
		314	=cut
		315
		316	sub timeout {
		317	my ($self, $timeout) = @_;
		318
		319	$self->{timeout} = $timeout;
		320	$self->_timeout;
		321	}
		322
		323	# reset the timeout watcher, as neccessary
		324	# also check for time-outs
		325	sub _timeout {
		326	my ($self) = @_;
		327
		328	if ($self->{timeout}) {
		329	my $NOW = AnyEvent->now;
		330
		331	# when would the timeout trigger?
		332	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		333
		334	# now or in the past already?
		335	if ($after <= 0) {
		336	$self->{_activity} = $NOW;
		337
		338	if ($self->{on_timeout}) {
		339	$self->{on_timeout}($self);
		340	} else {
		341	$self->_error (&Errno::ETIMEDOUT);
		342	}
		343
		344	# callbakx could have changed timeout value, optimise
		345	return unless $self->{timeout};
		346
		347	# calculate new after
		348	$after = $self->{timeout};
		349	}
		350
		351	Scalar::Util::weaken $self;
		352
		353	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		354	delete $self->{_tw};
		355	$self->_timeout;
		356	});
		357	} else {
		358	delete $self->{_tw};
		359	}
247	}	360	}
248		361
249	#############################################################################	362	#############################################################################
250		363
251	=back	364	=back
…		…
288	=cut	401	=cut
289		402
290	sub _drain_wbuf {	403	sub _drain_wbuf {
291	my ($self) = @_;	404	my ($self) = @_;
292		405
293	if (!$self->{ww} && length $self->{wbuf}) {	406	if (!$self->{_ww} && length $self->{wbuf}) {
		407
294	Scalar::Util::weaken $self;	408	Scalar::Util::weaken $self;
		409
295	my $cb = sub {	410	my $cb = sub {
296	my $len = syswrite $self->{fh}, $self->{wbuf};	411	my $len = syswrite $self->{fh}, $self->{wbuf};
297		412
298	if ($len >= 0) {	413	if ($len >= 0) {
299	substr $self->{wbuf}, 0, $len, "";	414	substr $self->{wbuf}, 0, $len, "";
		415
		416	$self->{_activity} = AnyEvent->now;
300		417
301	$self->{on_drain}($self)	418	$self->{on_drain}($self)
302	if $self->{low_water_mark} >= length $self->{wbuf}	419	if $self->{low_water_mark} >= length $self->{wbuf}
303	&& $self->{on_drain};	420	&& $self->{on_drain};
304		421
305	delete $self->{ww} unless length $self->{wbuf};	422	delete $self->{_ww} unless length $self->{wbuf};
306	} elsif ($! != EAGAIN && $! != EINTR) {	423	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
307	$self->error;	424	$self->_error ($!, 1);
308	}	425	}
309	};	426	};
310		427
		428	# try to write data immediately
		429	$cb->();
		430
		431	# if still data left in wbuf, we need to poll
311	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
312		433	if length $self->{wbuf};
313	$cb->($self);
314	};	434	};
315	}	435	}
316		436
317	our %WH;	437	our %WH;
318		438
…		…
329	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	449	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
330	->($self, @_);	450	->($self, @_);
331	}	451	}
332		452
333	if ($self->{filter_w}) {	453	if ($self->{filter_w}) {
334	$self->{filter_w}->($self, \$_[0]);	454	$self->{filter_w}($self, \$_[0]);
335	} else {	455	} else {
336	$self->{wbuf} .= $_[0];	456	$self->{wbuf} .= $_[0];
337	$self->_drain_wbuf;	457	$self->_drain_wbuf;
338	}	458	}
339	}	459	}
340		460
341	=item $handle->push_write (type => @args)	461	=item $handle->push_write (type => @args)
342		462
343	=item $handle->unshift_write (type => @args)
344
345	Instead of formatting your data yourself, you can also let this module do	463	Instead of formatting your data yourself, you can also let this module do
346	the job by specifying a type and type-specific arguments.	464	the job by specifying a type and type-specific arguments.
347		465
348	Predefined types are (if you have ideas for additional types, feel free to	466	Predefined types are (if you have ideas for additional types, feel free to
349	drop by and tell us):	467	drop by and tell us):
…		…
353	=item netstring => $string	471	=item netstring => $string
354		472
355	Formats the given value as netstring	473	Formats the given value as netstring
356	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	474	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
357		475
358	=back
359
360	=cut	476	=cut
361		477
362	register_write_type netstring => sub {	478	register_write_type netstring => sub {
363	my ($self, $string) = @_;	479	my ($self, $string) = @_;
364		480
365	sprintf "%d:%s,", (length $string), $string	481	sprintf "%d:%s,", (length $string), $string
366	};	482	};
367		483
		484	=item json => $array_or_hashref
		485
		486	Encodes the given hash or array reference into a JSON object. Unless you
		487	provide your own JSON object, this means it will be encoded to JSON text
		488	in UTF-8.
		489
		490	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		491	one end of a handle and read them at the other end without using any
		492	additional framing.
		493
		494	The generated JSON text is guaranteed not to contain any newlines: While
		495	this module doesn't need delimiters after or between JSON texts to be
		496	able to read them, many other languages depend on that.
		497
		498	A simple RPC protocol that interoperates easily with others is to send
		499	JSON arrays (or objects, although arrays are usually the better choice as
		500	they mimic how function argument passing works) and a newline after each
		501	JSON text:
		502
		503	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		504	$handle->push_write ("\012");
		505
		506	An AnyEvent::Handle receiver would simply use the C<json> read type and
		507	rely on the fact that the newline will be skipped as leading whitespace:
		508
		509	$handle->push_read (json => sub { my $array = $_[1]; ... });
		510
		511	Other languages could read single lines terminated by a newline and pass
		512	this line into their JSON decoder of choice.
		513
		514	=cut
		515
		516	register_write_type json => sub {
		517	my ($self, $ref) = @_;
		518
		519	require JSON;
		520
		521	$self->{json} ? $self->{json}->encode ($ref)
		522	: JSON::encode_json ($ref)
		523	};
		524
368	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
369		526
370	This function (not method) lets you add your own types to C<push_write>.	527	This function (not method) lets you add your own types to C<push_write>.
371	Whenever the given C<type> is used, C<push_write> will invoke the code	528	Whenever the given C<type> is used, C<push_write> will invoke the code
372	reference with the handle object and the remaining arguments.	529	reference with the handle object and the remaining arguments.
373		530
374	The code reference is supposed to return a single octet string that will	531	The code reference is supposed to return a single octet string that will
375	be appended to the write buffer.	532	be appended to the write buffer.
376		533
377	Note that this is a function, and all types registered this way will be	534	Note that this is a function, and all types registered this way will be
378	global, so try to use unique names.	535	global, so try to use unique names.
		536
		537	=back
379		538
380	=cut	539	=cut
381		540
382	#############################################################################	541	#############################################################################
383		542
…		…
409	the specified number of bytes which give an XML datagram.	568	the specified number of bytes which give an XML datagram.
410		569
411	# in the default state, expect some header bytes	570	# in the default state, expect some header bytes
412	$handle->on_read (sub {	571	$handle->on_read (sub {
413	# some data is here, now queue the length-header-read (4 octets)	572	# some data is here, now queue the length-header-read (4 octets)
414	shift->unshift_read_chunk (4, sub {	573	shift->unshift_read (chunk => 4, sub {
415	# header arrived, decode	574	# header arrived, decode
416	my $len = unpack "N", $_[1];	575	my $len = unpack "N", $_[1];
417		576
418	# now read the payload	577	# now read the payload
419	shift->unshift_read_chunk ($len, sub {	578	shift->unshift_read (chunk => $len, sub {
420	my $xml = $_[1];	579	my $xml = $_[1];
421	# handle xml	580	# handle xml
422	});	581	});
423	});	582	});
424	});	583	});
…		…
431		590
432	# request one	591	# request one
433	$handle->push_write ("request 1\015\012");	592	$handle->push_write ("request 1\015\012");
434		593
435	# we expect "ERROR" or "OK" as response, so push a line read	594	# we expect "ERROR" or "OK" as response, so push a line read
436	$handle->push_read_line (sub {	595	$handle->push_read (line => sub {
437	# if we got an "OK", we have to _prepend_ another line,	596	# if we got an "OK", we have to _prepend_ another line,
438	# so it will be read before the second request reads its 64 bytes	597	# so it will be read before the second request reads its 64 bytes
439	# which are already in the queue when this callback is called	598	# which are already in the queue when this callback is called
440	# we don't do this in case we got an error	599	# we don't do this in case we got an error
441	if ($_[1] eq "OK") {	600	if ($_[1] eq "OK") {
442	$_[0]->unshift_read_line (sub {	601	$_[0]->unshift_read (line => sub {
443	my $response = $_[1];	602	my $response = $_[1];
444	...	603	...
445	});	604	});
446	}	605	}
447	});	606	});
448		607
449	# request two	608	# request two
450	$handle->push_write ("request 2\015\012");	609	$handle->push_write ("request 2\015\012");
451		610
452	# simply read 64 bytes, always	611	# simply read 64 bytes, always
453	$handle->push_read_chunk (64, sub {	612	$handle->push_read (chunk => 64, sub {
454	my $response = $_[1];	613	my $response = $_[1];
455	...	614	...
456	});	615	});
457		616
458	=over 4	617	=over 4
…		…
464		623
465	if (	624	if (
466	defined $self->{rbuf_max}	625	defined $self->{rbuf_max}
467	&& $self->{rbuf_max} < length $self->{rbuf}	626	&& $self->{rbuf_max} < length $self->{rbuf}
468	) {	627	) {
469	$! = &Errno::ENOSPC; return $self->error;	628	return $self->_error (&Errno::ENOSPC, 1);
470	}	629	}
471		630
472	return if $self->{in_drain};	631	return if $self->{in_drain};
473	local $self->{in_drain} = 1;	632	local $self->{in_drain} = 1;
474		633
475	while (my $len = length $self->{rbuf}) {	634	while (my $len = length $self->{rbuf}) {
476	no strict 'refs';	635	no strict 'refs';
477	if (my $cb = shift @{ $self->{queue} }) {	636	if (my $cb = shift @{ $self->{_queue} }) {
478	unless ($cb->($self)) {	637	unless ($cb->($self)) {
479	if ($self->{eof}) {	638	if ($self->{_eof}) {
480	# no progress can be made (not enough data and no data forthcoming)	639	# no progress can be made (not enough data and no data forthcoming)
481	$! = &Errno::EPIPE; return $self->error;	640	return $self->_error (&Errno::EPIPE, 1);
482	}	641	}
483		642
484	unshift @{ $self->{queue} }, $cb;	643	unshift @{ $self->{_queue} }, $cb;
485	return;	644	return;
486	}	645	}
487	} elsif ($self->{on_read}) {	646	} elsif ($self->{on_read}) {
488	$self->{on_read}($self);	647	$self->{on_read}($self);
489		648
490	if (	649	if (
491	$self->{eof} # if no further data will arrive	650	$self->{_eof} # if no further data will arrive
492	&& $len == length $self->{rbuf} # and no data has been consumed	651	&& $len == length $self->{rbuf} # and no data has been consumed
493	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
494	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # and we still want to read data
495	) {	654	) {
496	# then no progress can be made	655	# then no progress can be made
497	$! = &Errno::EPIPE; return $self->error;	656	return $self->_error (&Errno::EPIPE, 1);
498	}	657	}
499	} else {	658	} else {
500	# read side becomes idle	659	# read side becomes idle
501	delete $self->{rw};	660	delete $self->{_rw};
502	return;	661	return;
503	}	662	}
504	}	663	}
505		664
506	if ($self->{eof}) {
507	$self->_shutdown;
508	$self->{on_eof}($self)	665	$self->{on_eof}($self)
509	if $self->{on_eof};	666	if $self->{_eof} && $self->{on_eof};
510	}
511	}	667	}
512		668
513	=item $handle->on_read ($cb)	669	=item $handle->on_read ($cb)
514		670
515	This replaces the currently set C<on_read> callback, or clears it (when	671	This replaces the currently set C<on_read> callback, or clears it (when
…		…
577		733
578	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	734	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
579	->($self, $cb, @_);	735	->($self, $cb, @_);
580	}	736	}
581		737
582	push @{ $self->{queue} }, $cb;	738	push @{ $self->{_queue} }, $cb;
583	$self->_drain_rbuf;	739	$self->_drain_rbuf;
584	}	740	}
585		741
586	sub unshift_read {	742	sub unshift_read {
587	my $self = shift;	743	my $self = shift;
…		…
593	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	749	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
594	->($self, $cb, @_);	750	->($self, $cb, @_);
595	}	751	}
596		752
597		753
598	unshift @{ $self->{queue} }, $cb;	754	unshift @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	755	$self->_drain_rbuf;
600	}	756	}
601		757
602	=item $handle->push_read (type => @args, $cb)	758	=item $handle->push_read (type => @args, $cb)
603		759
…		…
610	Predefined types are (if you have ideas for additional types, feel free to	766	Predefined types are (if you have ideas for additional types, feel free to
611	drop by and tell us):	767	drop by and tell us):
612		768
613	=over 4	769	=over 4
614		770
615	=item chunk => $octets, $cb->($self, $data)	771	=item chunk => $octets, $cb->($handle, $data)
616		772
617	Invoke the callback only once C<$octets> bytes have been read. Pass the	773	Invoke the callback only once C<$octets> bytes have been read. Pass the
618	data read to the callback. The callback will never be called with less	774	data read to the callback. The callback will never be called with less
619	data.	775	data.
620		776
…		…
643		799
644	sub unshift_read_chunk {	800	sub unshift_read_chunk {
645	$_[0]->unshift_read (chunk => $_[1], $_[2]);	801	$_[0]->unshift_read (chunk => $_[1], $_[2]);
646	}	802	}
647		803
648	=item line => [$eol, ]$cb->($self, $line, $eol)	804	=item line => [$eol, ]$cb->($handle, $line, $eol)
649		805
650	The callback will be called only once a full line (including the end of	806	The callback will be called only once a full line (including the end of
651	line marker, C<$eol>) has been read. This line (excluding the end of line	807	line marker, C<$eol>) has been read. This line (excluding the end of line
652	marker) will be passed to the callback as second argument (C<$line>), and	808	marker) will be passed to the callback as second argument (C<$line>), and
653	the end of line marker as the third argument (C<$eol>).	809	the end of line marker as the third argument (C<$eol>).
…		…
690	sub unshift_read_line {	846	sub unshift_read_line {
691	my $self = shift;	847	my $self = shift;
692	$self->unshift_read (line => @_);	848	$self->unshift_read (line => @_);
693	}	849	}
694		850
695	=item netstring => $cb->($string)	851	=item netstring => $cb->($handle, $string)
696		852
697	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	853	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
698		854
699	Throws an error with C<$!> set to EBADMSG on format violations.	855	Throws an error with C<$!> set to EBADMSG on format violations.
700		856
…		…
704	my ($self, $cb) = @_;	860	my ($self, $cb) = @_;
705		861
706	sub {	862	sub {
707	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	863	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
708	if ($_[0]{rbuf} =~ /[^0-9]/) {	864	if ($_[0]{rbuf} =~ /[^0-9]/) {
709	$! = &Errno::EBADMSG;	865	$self->_error (&Errno::EBADMSG);
710	$self->error;
711	}	866	}
712	return;	867	return;
713	}	868	}
714		869
715	my $len = $1;	870	my $len = $1;
…		…
718	my $string = $_[1];	873	my $string = $_[1];
719	$_[0]->unshift_read (chunk => 1, sub {	874	$_[0]->unshift_read (chunk => 1, sub {
720	if ($_[1] eq ",") {	875	if ($_[1] eq ",") {
721	$cb->($_[0], $string);	876	$cb->($_[0], $string);
722	} else {	877	} else {
723	$! = &Errno::EBADMSG;	878	$self->_error (&Errno::EBADMSG);
724	$self->error;
725	}	879	}
726	});	880	});
727	});	881	});
728		882
729	1	883	1
730	}	884	}
731	};	885	};
732		886
		887	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		888
		889	Makes a regex match against the regex object C<$accept> and returns
		890	everything up to and including the match.
		891
		892	Example: read a single line terminated by '\n'.
		893
		894	$handle->push_read (regex => qr<\n>, sub { ... });
		895
		896	If C<$reject> is given and not undef, then it determines when the data is
		897	to be rejected: it is matched against the data when the C<$accept> regex
		898	does not match and generates an C<EBADMSG> error when it matches. This is
		899	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		900	receive buffer overflow).
		901
		902	Example: expect a single decimal number followed by whitespace, reject
		903	anything else (not the use of an anchor).
		904
		905	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		906
		907	If C<$skip> is given and not C<undef>, then it will be matched against
		908	the receive buffer when neither C<$accept> nor C<$reject> match,
		909	and everything preceding and including the match will be accepted
		910	unconditionally. This is useful to skip large amounts of data that you
		911	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		912	have to start matching from the beginning. This is purely an optimisation
		913	and is usually worth only when you expect more than a few kilobytes.
		914
		915	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		916	expect the header to be very large (it isn't in practise, but...), we use
		917	a skip regex to skip initial portions. The skip regex is tricky in that
		918	it only accepts something not ending in either \015 or \012, as these are
		919	required for the accept regex.
		920
		921	$handle->push_read (regex =>
		922	qr<\015\012\015\012>,
		923	undef, # no reject
		924	qr<^.*[^\015\012]>,
		925	sub { ... });
		926
		927	=cut
		928
		929	register_read_type regex => sub {
		930	my ($self, $cb, $accept, $reject, $skip) = @_;
		931
		932	my $data;
		933	my $rbuf = \$self->{rbuf};
		934
		935	sub {
		936	# accept
		937	if ($$rbuf =~ $accept) {
		938	$data .= substr $$rbuf, 0, $+[0], "";
		939	$cb->($self, $data);
		940	return 1;
		941	}
		942
		943	# reject
		944	if ($reject && $$rbuf =~ $reject) {
		945	$self->_error (&Errno::EBADMSG);
		946	}
		947
		948	# skip
		949	if ($skip && $$rbuf =~ $skip) {
		950	$data .= substr $$rbuf, 0, $+[0], "";
		951	}
		952
		953	()
		954	}
		955	};
		956
		957	=item json => $cb->($handle, $hash_or_arrayref)
		958
		959	Reads a JSON object or array, decodes it and passes it to the callback.
		960
		961	If a C<json> object was passed to the constructor, then that will be used
		962	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		963
		964	This read type uses the incremental parser available with JSON version
		965	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		966	dependency on your own: this module will load the JSON module, but
		967	AnyEvent does not depend on it itself.
		968
		969	Since JSON texts are fully self-delimiting, the C<json> read and write
		970	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		971	the C<json> write type description, above, for an actual example.
		972
		973	=cut
		974
		975	register_read_type json => sub {
		976	my ($self, $cb, $accept, $reject, $skip) = @_;
		977
		978	require JSON;
		979
		980	my $data;
		981	my $rbuf = \$self->{rbuf};
		982
		983	my $json = $self->{json} \|\|= JSON->new->utf8;
		984
		985	sub {
		986	my $ref = $json->incr_parse ($self->{rbuf});
		987
		988	if ($ref) {
		989	$self->{rbuf} = $json->incr_text;
		990	$json->incr_text = "";
		991	$cb->($self, $ref);
		992
		993	1
		994	} else {
		995	$self->{rbuf} = "";
		996	()
		997	}
		998	}
		999	};
		1000
733	=back	1001	=back
734		1002
735	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1003	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
736		1004
737	This function (not method) lets you add your own types to C<push_read>.	1005	This function (not method) lets you add your own types to C<push_read>.
738		1006
739	Whenever the given C<type> is used, C<push_read> will invoke the code	1007	Whenever the given C<type> is used, C<push_read> will invoke the code
740	reference with the handle object, the callback and the remaining	1008	reference with the handle object, the callback and the remaining
…		…
742		1010
743	The code reference is supposed to return a callback (usually a closure)	1011	The code reference is supposed to return a callback (usually a closure)
744	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1012	that works as a plain read callback (see C<< ->push_read ($cb) >>).
745		1013
746	It should invoke the passed callback when it is done reading (remember to	1014	It should invoke the passed callback when it is done reading (remember to
747	pass C<$self> as first argument as all other callbacks do that).	1015	pass C<$handle> as first argument as all other callbacks do that).
748		1016
749	Note that this is a function, and all types registered this way will be	1017	Note that this is a function, and all types registered this way will be
750	global, so try to use unique names.	1018	global, so try to use unique names.
751		1019
752	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1020	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
764	=cut	1032	=cut
765		1033
766	sub stop_read {	1034	sub stop_read {
767	my ($self) = @_;	1035	my ($self) = @_;
768		1036
769	delete $self->{rw};	1037	delete $self->{_rw};
770	}	1038	}
771		1039
772	sub start_read {	1040	sub start_read {
773	my ($self) = @_;	1041	my ($self) = @_;
774		1042
775	unless ($self->{rw} \|\| $self->{eof}) {	1043	unless ($self->{_rw} \|\| $self->{_eof}) {
776	Scalar::Util::weaken $self;	1044	Scalar::Util::weaken $self;
777		1045
778	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1046	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
779	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1047	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
780	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1048	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
781		1049
782	if ($len > 0) {	1050	if ($len > 0) {
		1051	$self->{_activity} = AnyEvent->now;
		1052
783	$self->{filter_r}	1053	$self->{filter_r}
784	? $self->{filter_r}->($self, $rbuf)	1054	? $self->{filter_r}($self, $rbuf)
785	: $self->_drain_rbuf;	1055	: $self->_drain_rbuf;
786		1056
787	} elsif (defined $len) {	1057	} elsif (defined $len) {
788	delete $self->{rw};	1058	delete $self->{_rw};
789	$self->{eof} = 1;	1059	$self->{_eof} = 1;
790	$self->_drain_rbuf;	1060	$self->_drain_rbuf;
791		1061
792	} elsif ($! != EAGAIN && $! != EINTR) {	1062	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
793	return $self->error;	1063	return $self->_error ($!, 1);
794	}	1064	}
795	});	1065	});
796	}	1066	}
797	}	1067	}
798		1068
799	sub _dotls {	1069	sub _dotls {
800	my ($self) = @_;	1070	my ($self) = @_;
801		1071
802	if (length $self->{tls_wbuf}) {	1072	if (length $self->{_tls_wbuf}) {
803	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1073	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
804	substr $self->{tls_wbuf}, 0, $len, "";	1074	substr $self->{_tls_wbuf}, 0, $len, "";
805	}	1075	}
806	}	1076	}
807		1077
808	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1078	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
809	$self->{wbuf} .= $buf;	1079	$self->{wbuf} .= $buf;
810	$self->_drain_wbuf;	1080	$self->_drain_wbuf;
811	}	1081	}
812		1082
813	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1083	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
817		1087
818	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1088	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
819		1089
820	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1090	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
821	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1091	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
822	$self->error;	1092	return $self->_error ($!, 1);
823	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1093	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
824	$! = &Errno::EIO;	1094	return $self->_error (&Errno::EIO, 1);
825	$self->error;
826	}	1095	}
827		1096
828	# all others are fine for our purposes	1097	# all others are fine for our purposes
829	}	1098	}
830	}	1099	}
…		…
839	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1108	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
840		1109
841	The second argument is the optional C<Net::SSLeay::CTX> object that is	1110	The second argument is the optional C<Net::SSLeay::CTX> object that is
842	used when AnyEvent::Handle has to create its own TLS connection object.	1111	used when AnyEvent::Handle has to create its own TLS connection object.
843		1112
844	=cut	1113	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1114	call and can be used or changed to your liking. Note that the handshake
		1115	might have already started when this function returns.
845		1116
846	# TODO: maybe document...	1117	=cut
		1118
847	sub starttls {	1119	sub starttls {
848	my ($self, $ssl, $ctx) = @_;	1120	my ($self, $ssl, $ctx) = @_;
849		1121
850	$self->stoptls;	1122	$self->stoptls;
851		1123
…		…
863	# but the openssl maintainers basically said: "trust us, it just works".	1135	# but the openssl maintainers basically said: "trust us, it just works".
864	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1136	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
865	# and mismaintained ssleay-module doesn't even offer them).	1137	# and mismaintained ssleay-module doesn't even offer them).
866	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1138	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
867	Net::SSLeay::CTX_set_mode ($self->{tls},	1139	Net::SSLeay::CTX_set_mode ($self->{tls},
868	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1140	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
869	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1141	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
870		1142
871	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1143	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1144	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
873		1145
874	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1146	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
875		1147
876	$self->{filter_w} = sub {	1148	$self->{filter_w} = sub {
877	$_[0]{tls_wbuf} .= ${$_[1]};	1149	$_[0]{_tls_wbuf} .= ${$_[1]};
878	&_dotls;	1150	&_dotls;
879	};	1151	};
880	$self->{filter_r} = sub {	1152	$self->{filter_r} = sub {
881	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1153	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
882	&_dotls;	1154	&_dotls;
883	};	1155	};
884	}	1156	}
885		1157
886	=item $handle->stoptls	1158	=item $handle->stoptls
…		…
892		1164
893	sub stoptls {	1165	sub stoptls {
894	my ($self) = @_;	1166	my ($self) = @_;
895		1167
896	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1168	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1169
897	delete $self->{tls_rbio};	1170	delete $self->{_rbio};
898	delete $self->{tls_wbio};	1171	delete $self->{_wbio};
899	delete $self->{tls_wbuf};	1172	delete $self->{_tls_wbuf};
900	delete $self->{filter_r};	1173	delete $self->{filter_r};
901	delete $self->{filter_w};	1174	delete $self->{filter_w};
902	}	1175	}
903		1176
904	sub DESTROY {	1177	sub DESTROY {
…		…
942	}	1215	}
943	}	1216	}
944		1217
945	=back	1218	=back
946		1219
		1220	=head1 SUBCLASSING AnyEvent::Handle
		1221
		1222	In many cases, you might want to subclass AnyEvent::Handle.
		1223
		1224	To make this easier, a given version of AnyEvent::Handle uses these
		1225	conventions:
		1226
		1227	=over 4
		1228
		1229	=item * all constructor arguments become object members.
		1230
		1231	At least initially, when you pass a C<tls>-argument to the constructor it
		1232	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1233	mutated later on (for example C<tls> will hold the TLS connection object).
		1234
		1235	=item * other object member names are prefixed with an C<_>.
		1236
		1237	All object members not explicitly documented (internal use) are prefixed
		1238	with an underscore character, so the remaining non-C<_>-namespace is free
		1239	for use for subclasses.
		1240
		1241	=item * all members not documented here and not prefixed with an underscore
		1242	are free to use in subclasses.
		1243
		1244	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1245	member variables, but thats just life, at least it is documented.
		1246
		1247	=back
		1248
947	=head1 AUTHOR	1249	=head1 AUTHOR
948		1250
949	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1251	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
950		1252
951	=cut	1253	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.31 by root, Sun May 25 00:08:49 2008 UTC vs. Revision 1.52 by root, Mon Jun 2 09:10:38 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.31 by root, Sun May 25 00:08:49 2008 UTC vs.
Revision 1.52 by root, Mon Jun 2 09:10:38 2008 UTC