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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC vs.
Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC

…		…
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	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.22;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($handle)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detected,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($handle)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> 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->($handle)	107	=item on_read => $cb->($handle)
106		108
107	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	110	and no read request is in the queue (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
109		113
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
112		116
113	When an EOF condition is detected then AnyEvent::Handle will first try to	117	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
119		123
120	This sets the callback that is called when the write buffer becomes empty	124	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	125	(or when the callback is set and the buffer is empty already).
122		126
123	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
		128
		129	This callback is useful when you don't want to put all of your write data
		130	into the queue at once, for example, when you want to write the contents
		131	of some file to the socket you might not want to read the whole file into
		132	memory and push it into the queue, but instead only read more data from
		133	the file when the write queue becomes empty.
		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
…		…
132	be configured to accept only so-and-so much data that it cannot act on	162	be configured to accept only so-and-so much data that it cannot act on
133	(for example, when expecting a line, an attacker could send an unlimited	163	(for example, when expecting a line, an attacker could send an unlimited
134	amount of data without a callback ever being called as long as the line	164	amount of data without a callback ever being called as long as the line
135	isn't finished).	165	isn't finished).
136		166
		167	=item autocork => <boolean>
		168
		169	When disabled (the default), then C<push_write> will try to immediately
		170	write the data to the handle if possible. This avoids having to register
		171	a write watcher and wait for the next event loop iteration, but can be
		172	inefficient if you write multiple small chunks (this disadvantage is
		173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		174
		175	When enabled, then writes will always be queued till the next event loop
		176	iteration. This is efficient when you do many small writes per iteration,
		177	but less efficient when you do a single write only.
		178
		179	=item no_delay => <boolean>
		180
		181	When doing small writes on sockets, your operating system kernel might
		182	wait a bit for more data before actually sending it out. This is called
		183	the Nagle algorithm, and usually it is beneficial.
		184
		185	In some situations you want as low a delay as possible, which cna be
		186	accomplishd by setting this option to true.
		187
		188	The default is your opertaing system's default behaviour, this option
		189	explicitly enables or disables it, if possible.
		190
137	=item read_size => <bytes>	191	=item read_size => <bytes>
138		192
139	The default read block size (the amount of bytes this module will try to read	193	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	194	during each (loop iteration). Default: C<8192>.
141		195
142	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
143		197
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	198	Sets the amount of bytes (default: C<0>) that make up an "empty" write
145	buffer: If the write reaches this size or gets even samller it is	199	buffer: If the write reaches this size or gets even samller it is
146	considered empty.	200	considered empty.
		201
		202	=item linger => <seconds>
		203
		204	If non-zero (default: C<3600>), then the destructor of the
		205	AnyEvent::Handle object will check wether there is still outstanding write
		206	data and will install a watcher that will write out this data. No errors
		207	will be reported (this mostly matches how the operating system treats
		208	outstanding data at socket close time).
		209
		210	This will not work for partial TLS data that could not yet been
		211	encoded. This data will be lost.
147		212
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		214
150	When this parameter is given, it enables TLS (SSL) mode, that means it	215	When this parameter is given, it enables TLS (SSL) mode, that means it
151	will start making tls handshake and will transparently encrypt/decrypt	216	will start making tls handshake and will transparently encrypt/decrypt
…		…
160	You can also provide your own TLS connection object, but you have	225	You can also provide your own TLS connection object, but you have
161	to make sure that you call either C<Net::SSLeay::set_connect_state>	226	to make sure that you call either C<Net::SSLeay::set_connect_state>
162	or C<Net::SSLeay::set_accept_state> on it before you pass it to	227	or C<Net::SSLeay::set_accept_state> on it before you pass it to
163	AnyEvent::Handle.	228	AnyEvent::Handle.
164		229
165	See the C<starttls> method if you need to start TLs negotiation later.	230	See the C<starttls> method if you need to start TLS negotiation later.
166		231
167	=item tls_ctx => $ssl_ctx	232	=item tls_ctx => $ssl_ctx
168		233
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	234	Use the given Net::SSLeay::CTX object to create the new TLS connection
170	(unless a connection object was specified directly). If this parameter is	235	(unless a connection object was specified directly). If this parameter is
…		…
202	if ($self->{tls}) {	267	if ($self->{tls}) {
203	require Net::SSLeay;	268	require Net::SSLeay;
204	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
205	}	270	}
206		271
207	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	272	$self->{_activity} = AnyEvent->now;
208	$self->on_error (delete $self->{on_error}) if $self->{on_error};	273	$self->_timeout;
		274
209	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
210	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
211		277
212	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
213		280
214	$self	281	$self
215	}	282	}
216		283
217	sub _shutdown {	284	sub _shutdown {
218	my ($self) = @_;	285	my ($self) = @_;
219		286
		287	delete $self->{_tw};
220	delete $self->{_rw};	288	delete $self->{_rw};
221	delete $self->{_ww};	289	delete $self->{_ww};
222	delete $self->{fh};	290	delete $self->{fh};
223	}
224		291
		292	$self->stoptls;
		293	}
		294
225	sub error {	295	sub _error {
226	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
227		297
228	{
229	local $!;
230	$self->_shutdown;	298	$self->_shutdown
231	}	299	if $fatal;
232		300
233	$self->{on_error}($self)	301	$! = $errno;
		302
234	if $self->{on_error};	303	if ($self->{on_error}) {
235		304	$self->{on_error}($self, $fatal);
		305	} else {
236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
		307	}
237	}	308	}
238		309
239	=item $fh = $handle->fh	310	=item $fh = $handle->fh
240		311
241	This method returns the file handle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
260		331
261	=cut	332	=cut
262		333
263	sub on_eof {	334	sub on_eof {
264	$_[0]{on_eof} = $_[1];	335	$_[0]{on_eof} = $_[1];
		336	}
		337
		338	=item $handle->on_timeout ($cb)
		339
		340	Replace the current C<on_timeout> callback, or disables the callback
		341	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		342	argument.
		343
		344	=cut
		345
		346	sub on_timeout {
		347	$_[0]{on_timeout} = $_[1];
		348	}
		349
		350	=item $handle->autocork ($boolean)
		351
		352	Enables or disables the current autocork behaviour (see C<autocork>
		353	constructor argument).
		354
		355	=cut
		356
		357	=item $handle->no_delay ($boolean)
		358
		359	Enables or disables the C<no_delay> setting (see constructor argument of
		360	the same name for details).
		361
		362	=cut
		363
		364	sub no_delay {
		365	$_[0]{no_delay} = $_[1];
		366
		367	eval {
		368	local $SIG{__DIE__};
		369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		370	};
		371	}
		372
		373	#############################################################################
		374
		375	=item $handle->timeout ($seconds)
		376
		377	Configures (or disables) the inactivity timeout.
		378
		379	=cut
		380
		381	sub timeout {
		382	my ($self, $timeout) = @_;
		383
		384	$self->{timeout} = $timeout;
		385	$self->_timeout;
		386	}
		387
		388	# reset the timeout watcher, as neccessary
		389	# also check for time-outs
		390	sub _timeout {
		391	my ($self) = @_;
		392
		393	if ($self->{timeout}) {
		394	my $NOW = AnyEvent->now;
		395
		396	# when would the timeout trigger?
		397	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		398
		399	# now or in the past already?
		400	if ($after <= 0) {
		401	$self->{_activity} = $NOW;
		402
		403	if ($self->{on_timeout}) {
		404	$self->{on_timeout}($self);
		405	} else {
		406	$self->_error (&Errno::ETIMEDOUT);
		407	}
		408
		409	# callback could have changed timeout value, optimise
		410	return unless $self->{timeout};
		411
		412	# calculate new after
		413	$after = $self->{timeout};
		414	}
		415
		416	Scalar::Util::weaken $self;
		417	return unless $self; # ->error could have destroyed $self
		418
		419	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		420	delete $self->{_tw};
		421	$self->_timeout;
		422	});
		423	} else {
		424	delete $self->{_tw};
		425	}
265	}	426	}
266		427
267	#############################################################################	428	#############################################################################
268		429
269	=back	430	=back
…		…
316	my $len = syswrite $self->{fh}, $self->{wbuf};	477	my $len = syswrite $self->{fh}, $self->{wbuf};
317		478
318	if ($len >= 0) {	479	if ($len >= 0) {
319	substr $self->{wbuf}, 0, $len, "";	480	substr $self->{wbuf}, 0, $len, "";
320		481
		482	$self->{_activity} = AnyEvent->now;
		483
321	$self->{on_drain}($self)	484	$self->{on_drain}($self)
322	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
323	&& $self->{on_drain};	486	&& $self->{on_drain};
324		487
325	delete $self->{_ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
327	$self->error;	490	$self->_error ($!, 1);
328	}	491	}
329	};	492	};
330		493
331	# try to write data immediately	494	# try to write data immediately
332	$cb->();	495	$cb->() unless $self->{autocork};
333		496
334	# if still data left in wbuf, we need to poll	497	# if still data left in wbuf, we need to poll
335	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
336	if length $self->{wbuf};	499	if length $self->{wbuf};
337	};	500	};
…		…
352	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
353	->($self, @_);	516	->($self, @_);
354	}	517	}
355		518
356	if ($self->{filter_w}) {	519	if ($self->{filter_w}) {
357	$self->{filter_w}->($self, \$_[0]);	520	$self->{filter_w}($self, \$_[0]);
358	} else {	521	} else {
359	$self->{wbuf} .= $_[0];	522	$self->{wbuf} .= $_[0];
360	$self->_drain_wbuf;	523	$self->_drain_wbuf;
361	}	524	}
362	}	525	}
363		526
364	=item $handle->push_write (type => @args)	527	=item $handle->push_write (type => @args)
365		528
366	=item $handle->unshift_write (type => @args)
367
368	Instead of formatting your data yourself, you can also let this module do	529	Instead of formatting your data yourself, you can also let this module do
369	the job by specifying a type and type-specific arguments.	530	the job by specifying a type and type-specific arguments.
370		531
371	Predefined types are (if you have ideas for additional types, feel free to	532	Predefined types are (if you have ideas for additional types, feel free to
372	drop by and tell us):	533	drop by and tell us):
…		…
376	=item netstring => $string	537	=item netstring => $string
377		538
378	Formats the given value as netstring	539	Formats the given value as netstring
379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
380		541
381	=back
382
383	=cut	542	=cut
384		543
385	register_write_type netstring => sub {	544	register_write_type netstring => sub {
386	my ($self, $string) = @_;	545	my ($self, $string) = @_;
387		546
388	sprintf "%d:%s,", (length $string), $string	547	sprintf "%d:%s,", (length $string), $string
		548	};
		549
		550	=item packstring => $format, $data
		551
		552	An octet string prefixed with an encoded length. The encoding C<$format>
		553	uses the same format as a Perl C<pack> format, but must specify a single
		554	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		555	optional C<!>, C<< < >> or C<< > >> modifier).
		556
		557	=cut
		558
		559	register_write_type packstring => sub {
		560	my ($self, $format, $string) = @_;
		561
		562	pack "$format/a*", $string
389	};	563	};
390		564
391	=item json => $array_or_hashref	565	=item json => $array_or_hashref
392		566
393	Encodes the given hash or array reference into a JSON object. Unless you	567	Encodes the given hash or array reference into a JSON object. Unless you
…		…
427		601
428	$self->{json} ? $self->{json}->encode ($ref)	602	$self->{json} ? $self->{json}->encode ($ref)
429	: JSON::encode_json ($ref)	603	: JSON::encode_json ($ref)
430	};	604	};
431		605
		606	=item storable => $reference
		607
		608	Freezes the given reference using L<Storable> and writes it to the
		609	handle. Uses the C<nfreeze> format.
		610
		611	=cut
		612
		613	register_write_type storable => sub {
		614	my ($self, $ref) = @_;
		615
		616	require Storable;
		617
		618	pack "w/a*", Storable::nfreeze ($ref)
		619	};
		620
		621	=back
		622
432	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
433		624
434	This function (not method) lets you add your own types to C<push_write>.	625	This function (not method) lets you add your own types to C<push_write>.
435	Whenever the given C<type> is used, C<push_write> will invoke the code	626	Whenever the given C<type> is used, C<push_write> will invoke the code
436	reference with the handle object and the remaining arguments.	627	reference with the handle object and the remaining arguments.
…		…
456	ways, the "simple" way, using only C<on_read> and the "complex" way, using	647	ways, the "simple" way, using only C<on_read> and the "complex" way, using
457	a queue.	648	a queue.
458		649
459	In the simple case, you just install an C<on_read> callback and whenever	650	In the simple case, you just install an C<on_read> callback and whenever
460	new data arrives, it will be called. You can then remove some data (if	651	new data arrives, it will be called. You can then remove some data (if
461	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	652	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
462	or not.	653	leave the data there if you want to accumulate more (e.g. when only a
		654	partial message has been received so far).
463		655
464	In the more complex case, you want to queue multiple callbacks. In this	656	In the more complex case, you want to queue multiple callbacks. In this
465	case, AnyEvent::Handle will call the first queued callback each time new	657	case, AnyEvent::Handle will call the first queued callback each time new
466	data arrives and removes it when it has done its job (see C<push_read>,	658	data arrives (also the first time it is queued) and removes it when it has
467	below).	659	done its job (see C<push_read>, below).
468		660
469	This way you can, for example, push three line-reads, followed by reading	661	This way you can, for example, push three line-reads, followed by reading
470	a chunk of data, and AnyEvent::Handle will execute them in order.	662	a chunk of data, and AnyEvent::Handle will execute them in order.
471		663
472	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	664	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
473	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
474		666
475	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
476	$handle->on_read (sub {	668	$handle->on_read (sub {
477	# some data is here, now queue the length-header-read (4 octets)	669	# some data is here, now queue the length-header-read (4 octets)
478	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
479	# header arrived, decode	671	# header arrived, decode
480	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
481		673
482	# now read the payload	674	# now read the payload
483	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
484	my $xml = $_[1];	676	my $xml = $_[1];
485	# handle xml	677	# handle xml
486	});	678	});
487	});	679	});
488	});	680	});
489		681
490	Example 2: Implement a client for a protocol that replies either with	682	Example 2: Implement a client for a protocol that replies either with "OK"
491	"OK" and another line or "ERROR" for one request, and 64 bytes for the	683	and another line or "ERROR" for the first request that is sent, and 64
492	second request. Due tot he availability of a full queue, we can just	684	bytes for the second request. Due to the availability of a queue, we can
493	pipeline sending both requests and manipulate the queue as necessary in	685	just pipeline sending both requests and manipulate the queue as necessary
494	the callbacks:	686	in the callbacks.
495		687
496	# request one	688	When the first callback is called and sees an "OK" response, it will
		689	C<unshift> another line-read. This line-read will be queued I<before> the
		690	64-byte chunk callback.
		691
		692	# request one, returns either "OK + extra line" or "ERROR"
497	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
498		694
499	# we expect "ERROR" or "OK" as response, so push a line read	695	# we expect "ERROR" or "OK" as response, so push a line read
500	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
501	# if we got an "OK", we have to _prepend_ another line,	697	# if we got an "OK", we have to _prepend_ another line,
502	# so it will be read before the second request reads its 64 bytes	698	# so it will be read before the second request reads its 64 bytes
503	# which are already in the queue when this callback is called	699	# which are already in the queue when this callback is called
504	# we don't do this in case we got an error	700	# we don't do this in case we got an error
505	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
506	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
507	my $response = $_[1];	703	my $response = $_[1];
508	...	704	...
509	});	705	});
510	}	706	}
511	});	707	});
512		708
513	# request two	709	# request two, simply returns 64 octets
514	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
515		711
516	# simply read 64 bytes, always	712	# simply read 64 bytes, always
517	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
518	my $response = $_[1];	714	my $response = $_[1];
519	...	715	...
520	});	716	});
521		717
522	=over 4	718	=over 4
523		719
524	=cut	720	=cut
525		721
526	sub _drain_rbuf {	722	sub _drain_rbuf {
527	my ($self) = @_;	723	my ($self) = @_;
		724
		725	local $self->{_in_drain} = 1;
528		726
529	if (	727	if (
530	defined $self->{rbuf_max}	728	defined $self->{rbuf_max}
531	&& $self->{rbuf_max} < length $self->{rbuf}	729	&& $self->{rbuf_max} < length $self->{rbuf}
532	) {	730	) {
533	$! = &Errno::ENOSPC;	731	return $self->_error (&Errno::ENOSPC, 1);
534	$self->error;
535	}	732	}
536		733
537	return if $self->{in_drain};	734	while () {
538	local $self->{in_drain} = 1;
539
540	while (my $len = length $self->{rbuf}) {
541	no strict 'refs';	735	no strict 'refs';
		736
		737	my $len = length $self->{rbuf};
		738
542	if (my $cb = shift @{ $self->{_queue} }) {	739	if (my $cb = shift @{ $self->{_queue} }) {
543	unless ($cb->($self)) {	740	unless ($cb->($self)) {
544	if ($self->{_eof}) {	741	if ($self->{_eof}) {
545	# no progress can be made (not enough data and no data forthcoming)	742	# no progress can be made (not enough data and no data forthcoming)
546	$! = &Errno::EPIPE;	743	$self->_error (&Errno::EPIPE, 1), last;
547	$self->error;
548	}	744	}
549		745
550	unshift @{ $self->{_queue} }, $cb;	746	unshift @{ $self->{_queue} }, $cb;
551	return;	747	last;
552	}	748	}
553	} elsif ($self->{on_read}) {	749	} elsif ($self->{on_read}) {
		750	last unless $len;
		751
554	$self->{on_read}($self);	752	$self->{on_read}($self);
555		753
556	if (	754	if (
557	$self->{_eof} # if no further data will arrive
558	&& $len == length $self->{rbuf} # and no data has been consumed	755	$len == length $self->{rbuf} # if no data has been consumed
559	&& !@{ $self->{_queue} } # and the queue is still empty	756	&& !@{ $self->{_queue} } # and the queue is still empty
560	&& $self->{on_read} # and we still want to read data	757	&& $self->{on_read} # but we still have on_read
561	) {	758	) {
		759	# no further data will arrive
562	# then no progress can be made	760	# so no progress can be made
563	$! = &Errno::EPIPE;	761	$self->_error (&Errno::EPIPE, 1), last
564	$self->error;	762	if $self->{_eof};
		763
		764	last; # more data might arrive
565	}	765	}
566	} else {	766	} else {
567	# read side becomes idle	767	# read side becomes idle
568	delete $self->{_rw};	768	delete $self->{_rw};
569	return;	769	last;
570	}	770	}
571	}	771	}
572		772
573	if ($self->{_eof}) {
574	$self->_shutdown;
575	$self->{on_eof}($self)	773	$self->{on_eof}($self)
576	if $self->{on_eof};	774	if $self->{_eof} && $self->{on_eof};
		775
		776	# may need to restart read watcher
		777	unless ($self->{_rw}) {
		778	$self->start_read
		779	if $self->{on_read} \|\| @{ $self->{_queue} };
577	}	780	}
578	}	781	}
579		782
580	=item $handle->on_read ($cb)	783	=item $handle->on_read ($cb)
581		784
…		…
587		790
588	sub on_read {	791	sub on_read {
589	my ($self, $cb) = @_;	792	my ($self, $cb) = @_;
590		793
591	$self->{on_read} = $cb;	794	$self->{on_read} = $cb;
		795	$self->_drain_rbuf if $cb && !$self->{_in_drain};
592	}	796	}
593		797
594	=item $handle->rbuf	798	=item $handle->rbuf
595		799
596	Returns the read buffer (as a modifiable lvalue).	800	Returns the read buffer (as a modifiable lvalue).
…		…
645	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	849	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
646	->($self, $cb, @_);	850	->($self, $cb, @_);
647	}	851	}
648		852
649	push @{ $self->{_queue} }, $cb;	853	push @{ $self->{_queue} }, $cb;
650	$self->_drain_rbuf;	854	$self->_drain_rbuf unless $self->{_in_drain};
651	}	855	}
652		856
653	sub unshift_read {	857	sub unshift_read {
654	my $self = shift;	858	my $self = shift;
655	my $cb = pop;	859	my $cb = pop;
…		…
661	->($self, $cb, @_);	865	->($self, $cb, @_);
662	}	866	}
663		867
664		868
665	unshift @{ $self->{_queue} }, $cb;	869	unshift @{ $self->{_queue} }, $cb;
666	$self->_drain_rbuf;	870	$self->_drain_rbuf unless $self->{_in_drain};
667	}	871	}
668		872
669	=item $handle->push_read (type => @args, $cb)	873	=item $handle->push_read (type => @args, $cb)
670		874
671	=item $handle->unshift_read (type => @args, $cb)	875	=item $handle->unshift_read (type => @args, $cb)
…		…
734	=cut	938	=cut
735		939
736	register_read_type line => sub {	940	register_read_type line => sub {
737	my ($self, $cb, $eol) = @_;	941	my ($self, $cb, $eol) = @_;
738		942
739	$eol = qr\|(\015?\012)\| if @_ < 3;	943	if (@_ < 3) {
		944	# this is more than twice as fast as the generic code below
		945	sub {
		946	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		947
		948	$cb->($_[0], $1, $2);
		949	1
		950	}
		951	} else {
740	$eol = quotemeta $eol unless ref $eol;	952	$eol = quotemeta $eol unless ref $eol;
741	$eol = qr\|^(.*?)($eol)\|s;	953	$eol = qr\|^(.*?)($eol)\|s;
742		954
743	sub {	955	sub {
744	$_[0]{rbuf} =~ s/$eol// or return;	956	$_[0]{rbuf} =~ s/$eol// or return;
745		957
746	$cb->($_[0], $1, $2);	958	$cb->($_[0], $1, $2);
		959	1
747	1	960	}
748	}	961	}
749	};	962	};
750		963
751	# compatibility with older API	964	# compatibility with older API
752	sub push_read_line {	965	sub push_read_line {
…		…
756		969
757	sub unshift_read_line {	970	sub unshift_read_line {
758	my $self = shift;	971	my $self = shift;
759	$self->unshift_read (line => @_);	972	$self->unshift_read (line => @_);
760	}	973	}
761
762	=item netstring => $cb->($handle, $string)
763
764	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
765
766	Throws an error with C<$!> set to EBADMSG on format violations.
767
768	=cut
769
770	register_read_type netstring => sub {
771	my ($self, $cb) = @_;
772
773	sub {
774	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
775	if ($_[0]{rbuf} =~ /[^0-9]/) {
776	$! = &Errno::EBADMSG;
777	$self->error;
778	}
779	return;
780	}
781
782	my $len = $1;
783
784	$self->unshift_read (chunk => $len, sub {
785	my $string = $_[1];
786	$_[0]->unshift_read (chunk => 1, sub {
787	if ($_[1] eq ",") {
788	$cb->($_[0], $string);
789	} else {
790	$! = &Errno::EBADMSG;
791	$self->error;
792	}
793	});
794	});
795
796	1
797	}
798	};
799		974
800	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	975	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
801		976
802	Makes a regex match against the regex object C<$accept> and returns	977	Makes a regex match against the regex object C<$accept> and returns
803	everything up to and including the match.	978	everything up to and including the match.
…		…
853	return 1;	1028	return 1;
854	}	1029	}
855		1030
856	# reject	1031	# reject
857	if ($reject && $$rbuf =~ $reject) {	1032	if ($reject && $$rbuf =~ $reject) {
858	$! = &Errno::EBADMSG;	1033	$self->_error (&Errno::EBADMSG);
859	$self->error;
860	}	1034	}
861		1035
862	# skip	1036	# skip
863	if ($skip && $$rbuf =~ $skip) {	1037	if ($skip && $$rbuf =~ $skip) {
864	$data .= substr $$rbuf, 0, $+[0], "";	1038	$data .= substr $$rbuf, 0, $+[0], "";
…		…
866		1040
867	()	1041	()
868	}	1042	}
869	};	1043	};
870		1044
		1045	=item netstring => $cb->($handle, $string)
		1046
		1047	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1048
		1049	Throws an error with C<$!> set to EBADMSG on format violations.
		1050
		1051	=cut
		1052
		1053	register_read_type netstring => sub {
		1054	my ($self, $cb) = @_;
		1055
		1056	sub {
		1057	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1058	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1059	$self->_error (&Errno::EBADMSG);
		1060	}
		1061	return;
		1062	}
		1063
		1064	my $len = $1;
		1065
		1066	$self->unshift_read (chunk => $len, sub {
		1067	my $string = $_[1];
		1068	$_[0]->unshift_read (chunk => 1, sub {
		1069	if ($_[1] eq ",") {
		1070	$cb->($_[0], $string);
		1071	} else {
		1072	$self->_error (&Errno::EBADMSG);
		1073	}
		1074	});
		1075	});
		1076
		1077	1
		1078	}
		1079	};
		1080
		1081	=item packstring => $format, $cb->($handle, $string)
		1082
		1083	An octet string prefixed with an encoded length. The encoding C<$format>
		1084	uses the same format as a Perl C<pack> format, but must specify a single
		1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1086	optional C<!>, C<< < >> or C<< > >> modifier).
		1087
		1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1089
		1090	Example: read a block of data prefixed by its length in BER-encoded
		1091	format (very efficient).
		1092
		1093	$handle->push_read (packstring => "w", sub {
		1094	my ($handle, $data) = @_;
		1095	});
		1096
		1097	=cut
		1098
		1099	register_read_type packstring => sub {
		1100	my ($self, $cb, $format) = @_;
		1101
		1102	sub {
		1103	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1104	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1105	or return;
		1106
		1107	# remove prefix
		1108	substr $_[0]{rbuf}, 0, (length pack $format, $len), "";
		1109
		1110	# read rest
		1111	$_[0]->unshift_read (chunk => $len, $cb);
		1112
		1113	1
		1114	}
		1115	};
		1116
871	=item json => $cb->($handle, $hash_or_arrayref)	1117	=item json => $cb->($handle, $hash_or_arrayref)
872		1118
873	Reads a JSON object or array, decodes it and passes it to the callback.	1119	Reads a JSON object or array, decodes it and passes it to the callback.
874		1120
875	If a C<json> object was passed to the constructor, then that will be used	1121	If a C<json> object was passed to the constructor, then that will be used
…		…
885	the C<json> write type description, above, for an actual example.	1131	the C<json> write type description, above, for an actual example.
886		1132
887	=cut	1133	=cut
888		1134
889	register_read_type json => sub {	1135	register_read_type json => sub {
890	my ($self, $cb, $accept, $reject, $skip) = @_;	1136	my ($self, $cb) = @_;
891		1137
892	require JSON;	1138	require JSON;
893		1139
894	my $data;	1140	my $data;
895	my $rbuf = \$self->{rbuf};	1141	my $rbuf = \$self->{rbuf};
…		…
910	()	1156	()
911	}	1157	}
912	}	1158	}
913	};	1159	};
914		1160
		1161	=item storable => $cb->($handle, $ref)
		1162
		1163	Deserialises a L<Storable> frozen representation as written by the
		1164	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1165	data).
		1166
		1167	Raises C<EBADMSG> error if the data could not be decoded.
		1168
		1169	=cut
		1170
		1171	register_read_type storable => sub {
		1172	my ($self, $cb) = @_;
		1173
		1174	require Storable;
		1175
		1176	sub {
		1177	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1178	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1179	or return;
		1180
		1181	# remove prefix
		1182	substr $_[0]{rbuf}, 0, (length pack "w", $len), "";
		1183
		1184	# read rest
		1185	$_[0]->unshift_read (chunk => $len, sub {
		1186	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1187	$cb->($_[0], $ref);
		1188	} else {
		1189	$self->_error (&Errno::EBADMSG);
		1190	}
		1191	});
		1192	}
		1193	};
		1194
915	=back	1195	=back
916		1196
917	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1197	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
918		1198
919	This function (not method) lets you add your own types to C<push_read>.	1199	This function (not method) lets you add your own types to C<push_read>.
…		…
937	=item $handle->stop_read	1217	=item $handle->stop_read
938		1218
939	=item $handle->start_read	1219	=item $handle->start_read
940		1220
941	In rare cases you actually do not want to read anything from the	1221	In rare cases you actually do not want to read anything from the
942	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1222	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
943	any queued callbacks will be executed then. To start reading again, call	1223	any queued callbacks will be executed then. To start reading again, call
944	C<start_read>.	1224	C<start_read>.
		1225
		1226	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1227	you change the C<on_read> callback or push/unshift a read callback, and it
		1228	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1229	there are any read requests in the queue.
945		1230
946	=cut	1231	=cut
947		1232
948	sub stop_read {	1233	sub stop_read {
949	my ($self) = @_;	1234	my ($self) = @_;
…		…
960	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1245	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
961	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1246	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
962	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1247	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
963		1248
964	if ($len > 0) {	1249	if ($len > 0) {
		1250	$self->{_activity} = AnyEvent->now;
		1251
965	$self->{filter_r}	1252	$self->{filter_r}
966	? $self->{filter_r}->($self, $rbuf)	1253	? $self->{filter_r}($self, $rbuf)
967	: $self->_drain_rbuf;	1254	: $self->{_in_drain} \|\| $self->_drain_rbuf;
968		1255
969	} elsif (defined $len) {	1256	} elsif (defined $len) {
970	delete $self->{_rw};	1257	delete $self->{_rw};
971	$self->{_eof} = 1;	1258	$self->{_eof} = 1;
972	$self->_drain_rbuf;	1259	$self->_drain_rbuf unless $self->{_in_drain};
973		1260
974	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1261	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
975	return $self->error;	1262	return $self->_error ($!, 1);
976	}	1263	}
977	});	1264	});
978	}	1265	}
979	}	1266	}
980		1267
981	sub _dotls {	1268	sub _dotls {
982	my ($self) = @_;	1269	my ($self) = @_;
		1270
		1271	my $buf;
983		1272
984	if (length $self->{_tls_wbuf}) {	1273	if (length $self->{_tls_wbuf}) {
985	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1274	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
986	substr $self->{_tls_wbuf}, 0, $len, "";	1275	substr $self->{_tls_wbuf}, 0, $len, "";
987	}	1276	}
988	}	1277	}
989		1278
990	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1279	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
991	$self->{wbuf} .= $buf;	1280	$self->{wbuf} .= $buf;
992	$self->_drain_wbuf;	1281	$self->_drain_wbuf;
993	}	1282	}
994		1283
995	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1284	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1285	if (length $buf) {
996	$self->{rbuf} .= $buf;	1286	$self->{rbuf} .= $buf;
997	$self->_drain_rbuf;	1287	$self->_drain_rbuf unless $self->{_in_drain};
		1288	} else {
		1289	# let's treat SSL-eof as we treat normal EOF
		1290	$self->{_eof} = 1;
		1291	$self->_shutdown;
		1292	return;
		1293	}
998	}	1294	}
999		1295
1000	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1296	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1001		1297
1002	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1298	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1003	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1299	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1004	$self->error;	1300	return $self->_error ($!, 1);
1005	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1301	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1006	$! = &Errno::EIO;	1302	return $self->_error (&Errno::EIO, 1);
1007	$self->error;
1008	}	1303	}
1009		1304
1010	# all others are fine for our purposes	1305	# all others are fine for our purposes
1011	}	1306	}
1012	}	1307	}
…		…
1027	call and can be used or changed to your liking. Note that the handshake	1322	call and can be used or changed to your liking. Note that the handshake
1028	might have already started when this function returns.	1323	might have already started when this function returns.
1029		1324
1030	=cut	1325	=cut
1031		1326
1032	# TODO: maybe document...
1033	sub starttls {	1327	sub starttls {
1034	my ($self, $ssl, $ctx) = @_;	1328	my ($self, $ssl, $ctx) = @_;
1035		1329
1036	$self->stoptls;	1330	$self->stoptls;
1037		1331
…		…
1090		1384
1091	sub DESTROY {	1385	sub DESTROY {
1092	my $self = shift;	1386	my $self = shift;
1093		1387
1094	$self->stoptls;	1388	$self->stoptls;
		1389
		1390	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1391
		1392	if ($linger && length $self->{wbuf}) {
		1393	my $fh = delete $self->{fh};
		1394	my $wbuf = delete $self->{wbuf};
		1395
		1396	my @linger;
		1397
		1398	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1399	my $len = syswrite $fh, $wbuf, length $wbuf;
		1400
		1401	if ($len > 0) {
		1402	substr $wbuf, 0, $len, "";
		1403	} else {
		1404	@linger = (); # end
		1405	}
		1406	});
		1407	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1408	@linger = ();
		1409	});
		1410	}
1095	}	1411	}
1096		1412
1097	=item AnyEvent::Handle::TLS_CTX	1413	=item AnyEvent::Handle::TLS_CTX
1098		1414
1099	This function creates and returns the Net::SSLeay::CTX object used by	1415	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1141	=over 4	1457	=over 4
1142		1458
1143	=item * all constructor arguments become object members.	1459	=item * all constructor arguments become object members.
1144		1460
1145	At least initially, when you pass a C<tls>-argument to the constructor it	1461	At least initially, when you pass a C<tls>-argument to the constructor it
1146	will end up in C<< $handle->{tls} >>. Those members might be changes or	1462	will end up in C<< $handle->{tls} >>. Those members might be changed or
1147	mutated later on (for example C<tls> will hold the TLS connection object).	1463	mutated later on (for example C<tls> will hold the TLS connection object).
1148		1464
1149	=item * other object member names are prefixed with an C<_>.	1465	=item * other object member names are prefixed with an C<_>.
1150		1466
1151	All object members not explicitly documented (internal use) are prefixed	1467	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC vs. Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC vs.
Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC