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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.54 by root, Tue Jun 3 09:02:46 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.12;
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 callbakc 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
		205	=item filter_r => $cb
		206
		207	=item filter_w => $cb
		208
		209	These exist, but are undocumented at this time.
		210
173	=back	211	=back
174		212
175	=cut	213	=cut
176		214
177	sub new {	215	sub new {
…		…
186	if ($self->{tls}) {	224	if ($self->{tls}) {
187	require Net::SSLeay;	225	require Net::SSLeay;
188	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
189	}	227	}
190		228
191	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
192	$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
193	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
194	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
195		236
196	$self->start_read;	237	$self->start_read;
197		238
198	$self	239	$self
199	}	240	}
200		241
201	sub _shutdown {	242	sub _shutdown {
202	my ($self) = @_;	243	my ($self) = @_;
203		244
		245	delete $self->{_tw};
204	delete $self->{rw};	246	delete $self->{_rw};
205	delete $self->{ww};	247	delete $self->{_ww};
206	delete $self->{fh};	248	delete $self->{fh};
207	}
208		249
		250	$self->stoptls;
		251	}
		252
209	sub error {	253	sub _error {
210	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
211		255
212	{
213	local $!;
214	$self->_shutdown;	256	$self->_shutdown
215	}	257	if $fatal;
216		258
217	$self->{on_error}($self)	259	$! = $errno;
		260
218	if $self->{on_error};	261	if ($self->{on_error}) {
219		262	$self->{on_error}($self, $fatal);
		263	} else {
220	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
		265	}
221	}	266	}
222		267
223	=item $fh = $handle->fh	268	=item $fh = $handle->fh
224		269
225	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.
226		271
227	=cut	272	=cut
228		273
229	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
230		275
231	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
232		277
233	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).
234		279
…		…
244		289
245	=cut	290	=cut
246		291
247	sub on_eof {	292	sub on_eof {
248	$_[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	}
249	}	360	}
250		361
251	#############################################################################	362	#############################################################################
252		363
253	=back	364	=back
…		…
290	=cut	401	=cut
291		402
292	sub _drain_wbuf {	403	sub _drain_wbuf {
293	my ($self) = @_;	404	my ($self) = @_;
294		405
295	if (!$self->{ww} && length $self->{wbuf}) {	406	if (!$self->{_ww} && length $self->{wbuf}) {
296		407
297	Scalar::Util::weaken $self;	408	Scalar::Util::weaken $self;
298		409
299	my $cb = sub {	410	my $cb = sub {
300	my $len = syswrite $self->{fh}, $self->{wbuf};	411	my $len = syswrite $self->{fh}, $self->{wbuf};
301		412
302	if ($len >= 0) {	413	if ($len >= 0) {
303	substr $self->{wbuf}, 0, $len, "";	414	substr $self->{wbuf}, 0, $len, "";
		415
		416	$self->{_activity} = AnyEvent->now;
304		417
305	$self->{on_drain}($self)	418	$self->{on_drain}($self)
306	if $self->{low_water_mark} >= length $self->{wbuf}	419	if $self->{low_water_mark} >= length $self->{wbuf}
307	&& $self->{on_drain};	420	&& $self->{on_drain};
308		421
309	delete $self->{ww} unless length $self->{wbuf};	422	delete $self->{_ww} unless length $self->{wbuf};
310	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	423	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
311	$self->error;	424	$self->_error ($!, 1);
312	}	425	}
313	};	426	};
314		427
315	# try to write data immediately	428	# try to write data immediately
316	$cb->();	429	$cb->();
317		430
318	# if still data left in wbuf, we need to poll	431	# if still data left in wbuf, we need to poll
319	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
320	if length $self->{wbuf};	433	if length $self->{wbuf};
321	};	434	};
322	}	435	}
323		436
324	our %WH;	437	our %WH;
…		…
336	@_ = ($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")
337	->($self, @_);	450	->($self, @_);
338	}	451	}
339		452
340	if ($self->{filter_w}) {	453	if ($self->{filter_w}) {
341	$self->{filter_w}->($self, \$_[0]);	454	$self->{filter_w}($self, \$_[0]);
342	} else {	455	} else {
343	$self->{wbuf} .= $_[0];	456	$self->{wbuf} .= $_[0];
344	$self->_drain_wbuf;	457	$self->_drain_wbuf;
345	}	458	}
346	}	459	}
347		460
348	=item $handle->push_write (type => @args)	461	=item $handle->push_write (type => @args)
349		462
350	=item $handle->unshift_write (type => @args)
351
352	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
353	the job by specifying a type and type-specific arguments.	464	the job by specifying a type and type-specific arguments.
354		465
355	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
356	drop by and tell us):	467	drop by and tell us):
…		…
360	=item netstring => $string	471	=item netstring => $string
361		472
362	Formats the given value as netstring	473	Formats the given value as netstring
363	(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).
364		475
365	=back
366
367	=cut	476	=cut
368		477
369	register_write_type netstring => sub {	478	register_write_type netstring => sub {
370	my ($self, $string) = @_;	479	my ($self, $string) = @_;
371		480
372	sprintf "%d:%s,", (length $string), $string	481	sprintf "%d:%s,", (length $string), $string
373	};	482	};
374		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
		525	=back
		526
375	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	527	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
376		528
377	This function (not method) lets you add your own types to C<push_write>.	529	This function (not method) lets you add your own types to C<push_write>.
378	Whenever the given C<type> is used, C<push_write> will invoke the code	530	Whenever the given C<type> is used, C<push_write> will invoke the code
379	reference with the handle object and the remaining arguments.	531	reference with the handle object and the remaining arguments.
380		532
…		…
416	the specified number of bytes which give an XML datagram.	568	the specified number of bytes which give an XML datagram.
417		569
418	# in the default state, expect some header bytes	570	# in the default state, expect some header bytes
419	$handle->on_read (sub {	571	$handle->on_read (sub {
420	# 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)
421	shift->unshift_read_chunk (4, sub {	573	shift->unshift_read (chunk => 4, sub {
422	# header arrived, decode	574	# header arrived, decode
423	my $len = unpack "N", $_[1];	575	my $len = unpack "N", $_[1];
424		576
425	# now read the payload	577	# now read the payload
426	shift->unshift_read_chunk ($len, sub {	578	shift->unshift_read (chunk => $len, sub {
427	my $xml = $_[1];	579	my $xml = $_[1];
428	# handle xml	580	# handle xml
429	});	581	});
430	});	582	});
431	});	583	});
…		…
438		590
439	# request one	591	# request one
440	$handle->push_write ("request 1\015\012");	592	$handle->push_write ("request 1\015\012");
441		593
442	# 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
443	$handle->push_read_line (sub {	595	$handle->push_read (line => sub {
444	# if we got an "OK", we have to _prepend_ another line,	596	# if we got an "OK", we have to _prepend_ another line,
445	# 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
446	# which are already in the queue when this callback is called	598	# which are already in the queue when this callback is called
447	# we don't do this in case we got an error	599	# we don't do this in case we got an error
448	if ($_[1] eq "OK") {	600	if ($_[1] eq "OK") {
449	$_[0]->unshift_read_line (sub {	601	$_[0]->unshift_read (line => sub {
450	my $response = $_[1];	602	my $response = $_[1];
451	...	603	...
452	});	604	});
453	}	605	}
454	});	606	});
455		607
456	# request two	608	# request two
457	$handle->push_write ("request 2\015\012");	609	$handle->push_write ("request 2\015\012");
458		610
459	# simply read 64 bytes, always	611	# simply read 64 bytes, always
460	$handle->push_read_chunk (64, sub {	612	$handle->push_read (chunk => 64, sub {
461	my $response = $_[1];	613	my $response = $_[1];
462	...	614	...
463	});	615	});
464		616
465	=over 4	617	=over 4
…		…
471		623
472	if (	624	if (
473	defined $self->{rbuf_max}	625	defined $self->{rbuf_max}
474	&& $self->{rbuf_max} < length $self->{rbuf}	626	&& $self->{rbuf_max} < length $self->{rbuf}
475	) {	627	) {
476	$! = &Errno::ENOSPC;	628	return $self->_error (&Errno::ENOSPC, 1);
477	$self->error;
478	}	629	}
479		630
480	return if $self->{in_drain};	631	return if $self->{in_drain};
481	local $self->{in_drain} = 1;	632	local $self->{in_drain} = 1;
482		633
483	while (my $len = length $self->{rbuf}) {	634	while (my $len = length $self->{rbuf}) {
484	no strict 'refs';	635	no strict 'refs';
485	if (my $cb = shift @{ $self->{queue} }) {	636	if (my $cb = shift @{ $self->{_queue} }) {
486	unless ($cb->($self)) {	637	unless ($cb->($self)) {
487	if ($self->{eof}) {	638	if ($self->{_eof}) {
488	# 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)
489	$! = &Errno::EPIPE;	640	return $self->_error (&Errno::EPIPE, 1);
490	$self->error;
491	}	641	}
492		642
493	unshift @{ $self->{queue} }, $cb;	643	unshift @{ $self->{_queue} }, $cb;
494	return;	644	return;
495	}	645	}
496	} elsif ($self->{on_read}) {	646	} elsif ($self->{on_read}) {
497	$self->{on_read}($self);	647	$self->{on_read}($self);
498		648
499	if (	649	if (
500	$self->{eof} # if no further data will arrive	650	$self->{_eof} # if no further data will arrive
501	&& $len == length $self->{rbuf} # and no data has been consumed	651	&& $len == length $self->{rbuf} # and no data has been consumed
502	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
503	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # and we still want to read data
504	) {	654	) {
505	# then no progress can be made	655	# then no progress can be made
506	$! = &Errno::EPIPE;	656	return $self->_error (&Errno::EPIPE, 1);
507	$self->error;
508	}	657	}
509	} else {	658	} else {
510	# read side becomes idle	659	# read side becomes idle
511	delete $self->{rw};	660	delete $self->{_rw};
512	return;	661	return;
513	}	662	}
514	}	663	}
515		664
516	if ($self->{eof}) {
517	$self->_shutdown;
518	$self->{on_eof}($self)	665	$self->{on_eof}($self)
519	if $self->{on_eof};	666	if $self->{_eof} && $self->{on_eof};
520	}
521	}	667	}
522		668
523	=item $handle->on_read ($cb)	669	=item $handle->on_read ($cb)
524		670
525	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
…		…
587		733
588	$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")
589	->($self, $cb, @_);	735	->($self, $cb, @_);
590	}	736	}
591		737
592	push @{ $self->{queue} }, $cb;	738	push @{ $self->{_queue} }, $cb;
593	$self->_drain_rbuf;	739	$self->_drain_rbuf;
594	}	740	}
595		741
596	sub unshift_read {	742	sub unshift_read {
597	my $self = shift;	743	my $self = shift;
…		…
603	$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")
604	->($self, $cb, @_);	750	->($self, $cb, @_);
605	}	751	}
606		752
607		753
608	unshift @{ $self->{queue} }, $cb;	754	unshift @{ $self->{_queue} }, $cb;
609	$self->_drain_rbuf;	755	$self->_drain_rbuf;
610	}	756	}
611		757
612	=item $handle->push_read (type => @args, $cb)	758	=item $handle->push_read (type => @args, $cb)
613		759
…		…
620	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
621	drop by and tell us):	767	drop by and tell us):
622		768
623	=over 4	769	=over 4
624		770
625	=item chunk => $octets, $cb->($self, $data)	771	=item chunk => $octets, $cb->($handle, $data)
626		772
627	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
628	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
629	data.	775	data.
630		776
…		…
653		799
654	sub unshift_read_chunk {	800	sub unshift_read_chunk {
655	$_[0]->unshift_read (chunk => $_[1], $_[2]);	801	$_[0]->unshift_read (chunk => $_[1], $_[2]);
656	}	802	}
657		803
658	=item line => [$eol, ]$cb->($self, $line, $eol)	804	=item line => [$eol, ]$cb->($handle, $line, $eol)
659		805
660	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
661	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
662	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
663	the end of line marker as the third argument (C<$eol>).	809	the end of line marker as the third argument (C<$eol>).
…		…
700	sub unshift_read_line {	846	sub unshift_read_line {
701	my $self = shift;	847	my $self = shift;
702	$self->unshift_read (line => @_);	848	$self->unshift_read (line => @_);
703	}	849	}
704		850
705	=item netstring => $cb->($string)	851	=item netstring => $cb->($handle, $string)
706		852
707	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).
708		854
709	Throws an error with C<$!> set to EBADMSG on format violations.	855	Throws an error with C<$!> set to EBADMSG on format violations.
710		856
…		…
714	my ($self, $cb) = @_;	860	my ($self, $cb) = @_;
715		861
716	sub {	862	sub {
717	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	863	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
718	if ($_[0]{rbuf} =~ /[^0-9]/) {	864	if ($_[0]{rbuf} =~ /[^0-9]/) {
719	$! = &Errno::EBADMSG;	865	$self->_error (&Errno::EBADMSG);
720	$self->error;
721	}	866	}
722	return;	867	return;
723	}	868	}
724		869
725	my $len = $1;	870	my $len = $1;
…		…
728	my $string = $_[1];	873	my $string = $_[1];
729	$_[0]->unshift_read (chunk => 1, sub {	874	$_[0]->unshift_read (chunk => 1, sub {
730	if ($_[1] eq ",") {	875	if ($_[1] eq ",") {
731	$cb->($_[0], $string);	876	$cb->($_[0], $string);
732	} else {	877	} else {
733	$! = &Errno::EBADMSG;	878	$self->_error (&Errno::EBADMSG);
734	$self->error;
735	}	879	}
736	});	880	});
737	});	881	});
738		882
739	1	883	1
740	}	884	}
741	};	885	};
742		886
743	=item regex => $accept[, $reject[, $skip], $cb->($data)	887	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
744		888
745	Makes a regex match against the regex object C<$accept> and returns	889	Makes a regex match against the regex object C<$accept> and returns
746	everything up to and including the match.	890	everything up to and including the match.
747		891
748	Example: read a single line terminated by '\n'.	892	Example: read a single line terminated by '\n'.
…		…
796	return 1;	940	return 1;
797	}	941	}
798		942
799	# reject	943	# reject
800	if ($reject && $$rbuf =~ $reject) {	944	if ($reject && $$rbuf =~ $reject) {
801	$! = &Errno::EBADMSG;	945	$self->_error (&Errno::EBADMSG);
802	$self->error;
803	}	946	}
804		947
805	# skip	948	# skip
806	if ($skip && $$rbuf =~ $skip) {	949	if ($skip && $$rbuf =~ $skip) {
807	$data .= substr $$rbuf, 0, $+[0], "";	950	$data .= substr $$rbuf, 0, $+[0], "";
…		…
809		952
810	()	953	()
811	}	954	}
812	};	955	};
813		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
814	=back	1001	=back
815		1002
816	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1003	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
817		1004
818	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>.
819		1006
820	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
821	reference with the handle object, the callback and the remaining	1008	reference with the handle object, the callback and the remaining
…		…
823		1010
824	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)
825	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) >>).
826		1013
827	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
828	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).
829		1016
830	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
831	global, so try to use unique names.	1018	global, so try to use unique names.
832		1019
833	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>,
…		…
845	=cut	1032	=cut
846		1033
847	sub stop_read {	1034	sub stop_read {
848	my ($self) = @_;	1035	my ($self) = @_;
849		1036
850	delete $self->{rw};	1037	delete $self->{_rw};
851	}	1038	}
852		1039
853	sub start_read {	1040	sub start_read {
854	my ($self) = @_;	1041	my ($self) = @_;
855		1042
856	unless ($self->{rw} \|\| $self->{eof}) {	1043	unless ($self->{_rw} \|\| $self->{_eof}) {
857	Scalar::Util::weaken $self;	1044	Scalar::Util::weaken $self;
858		1045
859	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1046	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
860	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1047	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
861	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;
862		1049
863	if ($len > 0) {	1050	if ($len > 0) {
		1051	$self->{_activity} = AnyEvent->now;
		1052
864	$self->{filter_r}	1053	$self->{filter_r}
865	? $self->{filter_r}->($self, $rbuf)	1054	? $self->{filter_r}($self, $rbuf)
866	: $self->_drain_rbuf;	1055	: $self->_drain_rbuf;
867		1056
868	} elsif (defined $len) {	1057	} elsif (defined $len) {
869	delete $self->{rw};	1058	delete $self->{_rw};
870	$self->{eof} = 1;	1059	$self->{_eof} = 1;
871	$self->_drain_rbuf;	1060	$self->_drain_rbuf;
872		1061
873	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1062	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
874	return $self->error;	1063	return $self->_error ($!, 1);
875	}	1064	}
876	});	1065	});
877	}	1066	}
878	}	1067	}
879		1068
880	sub _dotls {	1069	sub _dotls {
881	my ($self) = @_;	1070	my ($self) = @_;
882		1071
883	if (length $self->{tls_wbuf}) {	1072	if (length $self->{_tls_wbuf}) {
884	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) {
885	substr $self->{tls_wbuf}, 0, $len, "";	1074	substr $self->{_tls_wbuf}, 0, $len, "";
886	}	1075	}
887	}	1076	}
888		1077
889	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1078	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
890	$self->{wbuf} .= $buf;	1079	$self->{wbuf} .= $buf;
891	$self->_drain_wbuf;	1080	$self->_drain_wbuf;
892	}	1081	}
893		1082
894	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1083	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
898		1087
899	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1088	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
900		1089
901	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1090	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
902	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1091	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
903	$self->error;	1092	return $self->_error ($!, 1);
904	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1093	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
905	$! = &Errno::EIO;	1094	return $self->_error (&Errno::EIO, 1);
906	$self->error;
907	}	1095	}
908		1096
909	# all others are fine for our purposes	1097	# all others are fine for our purposes
910	}	1098	}
911	}	1099	}
…		…
920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1108	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
921		1109
922	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
923	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.
924		1112
925	=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.
926		1116
927	# TODO: maybe document...	1117	=cut
		1118
928	sub starttls {	1119	sub starttls {
929	my ($self, $ssl, $ctx) = @_;	1120	my ($self, $ssl, $ctx) = @_;
930		1121
931	$self->stoptls;	1122	$self->stoptls;
932		1123
…		…
947	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1138	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
948	Net::SSLeay::CTX_set_mode ($self->{tls},	1139	Net::SSLeay::CTX_set_mode ($self->{tls},
949	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1140	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
950	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1141	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
951		1142
952	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1143	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
953	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1144	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
954		1145
955	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1146	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
956		1147
957	$self->{filter_w} = sub {	1148	$self->{filter_w} = sub {
958	$_[0]{tls_wbuf} .= ${$_[1]};	1149	$_[0]{_tls_wbuf} .= ${$_[1]};
959	&_dotls;	1150	&_dotls;
960	};	1151	};
961	$self->{filter_r} = sub {	1152	$self->{filter_r} = sub {
962	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1153	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
963	&_dotls;	1154	&_dotls;
964	};	1155	};
965	}	1156	}
966		1157
967	=item $handle->stoptls	1158	=item $handle->stoptls
…		…
973		1164
974	sub stoptls {	1165	sub stoptls {
975	my ($self) = @_;	1166	my ($self) = @_;
976		1167
977	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1168	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1169
978	delete $self->{tls_rbio};	1170	delete $self->{_rbio};
979	delete $self->{tls_wbio};	1171	delete $self->{_wbio};
980	delete $self->{tls_wbuf};	1172	delete $self->{_tls_wbuf};
981	delete $self->{filter_r};	1173	delete $self->{filter_r};
982	delete $self->{filter_w};	1174	delete $self->{filter_w};
983	}	1175	}
984		1176
985	sub DESTROY {	1177	sub DESTROY {
…		…
1023	}	1215	}
1024	}	1216	}
1025		1217
1026	=back	1218	=back
1027		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
1028	=head1 AUTHOR	1249	=head1 AUTHOR
1029		1250
1030	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>.
1031		1252
1032	=cut	1253	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs. Revision 1.54 by root, Tue Jun 3 09:02:46 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.54 by root, Tue Jun 3 09:02:46 2008 UTC