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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.44 by root, Thu May 29 00:00:07 2008 UTC vs.
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
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 ();
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.232;
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
		84	For sockets, this just means that the other side has stopped sending data,
		85	you can still try to write data, and, in fact, one can return from the eof
		86	callback and continue writing data, as only the read part has been shut
		87	down.
		88
82	While not mandatory, it is highly recommended to set an eof callback,	89	While not mandatory, it is I<highly> recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	90	otherwise you might end up with a closed socket while you are still
84	waiting for data.	91	waiting for data.
85		92
		93	If an EOF condition has been detected but no C<on_eof> callback has been
		94	set, then a fatal error will be raised with C<$!> set to <0>.
		95
86	=item on_error => $cb->($handle)	96	=item on_error => $cb->($handle, $fatal)
87		97
88	This is the fatal error callback, that is called when, well, a fatal error	98	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	99	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	100	connect or a read error.
91		101
92	The object will not be in a usable state when this callback has been	102	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	103	fatal errors the handle object will be shut down and will not be usable
		104	(but you are free to look at the current C< ->rbuf >). Examples of fatal
		105	errors are an EOF condition with active (but unsatisifable) read watchers
		106	(C<EPIPE>) or I/O errors.
		107
		108	Non-fatal errors can be retried by simply returning, but it is recommended
		109	to simply ignore this parameter and instead abondon the handle object
		110	when this callback is invoked. Examples of non-fatal errors are timeouts
		111	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		112
95	On callback entrance, the value of C<$!> contains the operating system	113	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	114	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		115
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100
101	While not mandatory, it is I<highly> recommended to set this callback, as	116	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	117	you will not be notified of errors otherwise. The default simply calls
103	die.	118	C<croak>.
104		119
105	=item on_read => $cb->($handle)	120	=item on_read => $cb->($handle)
106		121
107	This sets the default read callback, which is called when data arrives	122	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	123	and no read request is in the queue (unlike read queue callbacks, this
		124	callback will only be called when at least one octet of data is in the
		125	read buffer).
109		126
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	127	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	128	method or access the C<$handle->{rbuf}> member directly.
112		129
113	When an EOF condition is detected then AnyEvent::Handle will first try to	130	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
120	This sets the callback that is called when the write buffer becomes empty	137	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).	138	(or when the callback is set and the buffer is empty already).
122		139
123	To append to the write buffer, use the C<< ->push_write >> method.	140	To append to the write buffer, use the C<< ->push_write >> method.
124		141
		142	This callback is useful when you don't want to put all of your write data
		143	into the queue at once, for example, when you want to write the contents
		144	of some file to the socket you might not want to read the whole file into
		145	memory and push it into the queue, but instead only read more data from
		146	the file when the write queue becomes empty.
		147
125	=item timeout => $fractional_seconds	148	=item timeout => $fractional_seconds
126		149
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	150	If non-zero, then this enables an "inactivity" timeout: whenever this many
128	seconds pass without a successful read or write on the underlying file	151	seconds pass without a successful read or write on the underlying file
129	handle, the C<on_timeout> callback will be invoked (and if that one is	152	handle, the C<on_timeout> callback will be invoked (and if that one is
130	missing, an C<ETIMEDOUT> errror will be raised).	153	missing, an C<ETIMEDOUT> error will be raised).
131		154
132	Note that timeout processing is also active when you currently do not have	155	Note that timeout processing is also active when you currently do not have
133	any outstanding read or write requests: If you plan to keep the connection	156	any outstanding read or write requests: If you plan to keep the connection
134	idle then you should disable the timout temporarily or ignore the timeout	157	idle then you should disable the timout temporarily or ignore the timeout
135	in the C<on_timeout> callback.	158	in the C<on_timeout> callback.
…		…
152	be configured to accept only so-and-so much data that it cannot act on	175	be configured to accept only so-and-so much data that it cannot act on
153	(for example, when expecting a line, an attacker could send an unlimited	176	(for example, when expecting a line, an attacker could send an unlimited
154	amount of data without a callback ever being called as long as the line	177	amount of data without a callback ever being called as long as the line
155	isn't finished).	178	isn't finished).
156		179
		180	=item autocork => <boolean>
		181
		182	When disabled (the default), then C<push_write> will try to immediately
		183	write the data to the handle if possible. This avoids having to register
		184	a write watcher and wait for the next event loop iteration, but can be
		185	inefficient if you write multiple small chunks (this disadvantage is
		186	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		187
		188	When enabled, then writes will always be queued till the next event loop
		189	iteration. This is efficient when you do many small writes per iteration,
		190	but less efficient when you do a single write only.
		191
		192	=item no_delay => <boolean>
		193
		194	When doing small writes on sockets, your operating system kernel might
		195	wait a bit for more data before actually sending it out. This is called
		196	the Nagle algorithm, and usually it is beneficial.
		197
		198	In some situations you want as low a delay as possible, which cna be
		199	accomplishd by setting this option to true.
		200
		201	The default is your opertaing system's default behaviour, this option
		202	explicitly enables or disables it, if possible.
		203
157	=item read_size => <bytes>	204	=item read_size => <bytes>
158		205
159	The default read block size (the amount of bytes this module will try to read	206	The default read block size (the amount of bytes this module will try to read
160	on each [loop iteration). Default: C<4096>.	207	during each (loop iteration). Default: C<8192>.
161		208
162	=item low_water_mark => <bytes>	209	=item low_water_mark => <bytes>
163		210
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	211	Sets the amount of bytes (default: C<0>) that make up an "empty" write
165	buffer: If the write reaches this size or gets even samller it is	212	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	213	considered empty.
		214
		215	=item linger => <seconds>
		216
		217	If non-zero (default: C<3600>), then the destructor of the
		218	AnyEvent::Handle object will check wether there is still outstanding write
		219	data and will install a watcher that will write out this data. No errors
		220	will be reported (this mostly matches how the operating system treats
		221	outstanding data at socket close time).
		222
		223	This will not work for partial TLS data that could not yet been
		224	encoded. This data will be lost.
167		225
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	226	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		227
170	When this parameter is given, it enables TLS (SSL) mode, that means it	228	When this parameter is given, it enables TLS (SSL) mode, that means it
171	will start making tls handshake and will transparently encrypt/decrypt	229	will start making tls handshake and will transparently encrypt/decrypt
…		…
180	You can also provide your own TLS connection object, but you have	238	You can also provide your own TLS connection object, but you have
181	to make sure that you call either C<Net::SSLeay::set_connect_state>	239	to make sure that you call either C<Net::SSLeay::set_connect_state>
182	or C<Net::SSLeay::set_accept_state> on it before you pass it to	240	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	241	AnyEvent::Handle.
184		242
185	See the C<starttls> method if you need to start TLs negotiation later.	243	See the C<starttls> method if you need to start TLS negotiation later.
186		244
187	=item tls_ctx => $ssl_ctx	245	=item tls_ctx => $ssl_ctx
188		246
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	247	Use the given Net::SSLeay::CTX object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	248	(unless a connection object was specified directly). If this parameter is
…		…
222	if ($self->{tls}) {	280	if ($self->{tls}) {
223	require Net::SSLeay;	281	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	282	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}	283	}
226		284
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231
232	$self->{_activity} = AnyEvent->now;	285	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	286	$self->_timeout;
234		287
		288	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		289	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		290
235	$self->start_read;	291	$self->start_read
		292	if $self->{on_read};
236		293
237	$self	294	$self
238	}	295	}
239		296
240	sub _shutdown {	297	sub _shutdown {
241	my ($self) = @_;	298	my ($self) = @_;
242		299
		300	delete $self->{_tw};
243	delete $self->{_rw};	301	delete $self->{_rw};
244	delete $self->{_ww};	302	delete $self->{_ww};
245	delete $self->{fh};	303	delete $self->{fh};
246	}
247		304
		305	$self->stoptls;
		306
		307	delete $self->{on_read};
		308	delete $self->{_queue};
		309	}
		310
248	sub error {	311	sub _error {
249	my ($self) = @_;	312	my ($self, $errno, $fatal) = @_;
250		313
251	{
252	local $!;
253	$self->_shutdown;	314	$self->_shutdown
254	}	315	if $fatal;
255		316
256	$self->{on_error}($self)	317	$! = $errno;
		318
257	if $self->{on_error};	319	if ($self->{on_error}) {
258		320	$self->{on_error}($self, $fatal);
		321	} else {
259	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	322	Carp::croak "AnyEvent::Handle uncaught error: $!";
		323	}
260	}	324	}
261		325
262	=item $fh = $handle->fh	326	=item $fh = $handle->fh
263		327
264	This method returns the file handle of the L<AnyEvent::Handle> object.	328	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
295		359
296	=cut	360	=cut
297		361
298	sub on_timeout {	362	sub on_timeout {
299	$_[0]{on_timeout} = $_[1];	363	$_[0]{on_timeout} = $_[1];
		364	}
		365
		366	=item $handle->autocork ($boolean)
		367
		368	Enables or disables the current autocork behaviour (see C<autocork>
		369	constructor argument).
		370
		371	=cut
		372
		373	=item $handle->no_delay ($boolean)
		374
		375	Enables or disables the C<no_delay> setting (see constructor argument of
		376	the same name for details).
		377
		378	=cut
		379
		380	sub no_delay {
		381	$_[0]{no_delay} = $_[1];
		382
		383	eval {
		384	local $SIG{__DIE__};
		385	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		386	};
300	}	387	}
301		388
302	#############################################################################	389	#############################################################################
303		390
304	=item $handle->timeout ($seconds)	391	=item $handle->timeout ($seconds)
…		…
328	# now or in the past already?	415	# now or in the past already?
329	if ($after <= 0) {	416	if ($after <= 0) {
330	$self->{_activity} = $NOW;	417	$self->{_activity} = $NOW;
331		418
332	if ($self->{on_timeout}) {	419	if ($self->{on_timeout}) {
333	$self->{on_timeout}->($self);	420	$self->{on_timeout}($self);
334	} else {	421	} else {
335	$! = Errno::ETIMEDOUT;	422	$self->_error (&Errno::ETIMEDOUT);
336	$self->error;
337	}	423	}
338		424
339	# callbakx could have changed timeout value, optimise	425	# callback could have changed timeout value, optimise
340	return unless $self->{timeout};	426	return unless $self->{timeout};
341		427
342	# calculate new after	428	# calculate new after
343	$after = $self->{timeout};	429	$after = $self->{timeout};
344	}	430	}
345		431
346	Scalar::Util::weaken $self;	432	Scalar::Util::weaken $self;
		433	return unless $self; # ->error could have destroyed $self
347		434
348	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	435	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
349	delete $self->{_tw};	436	delete $self->{_tw};
350	$self->_timeout;	437	$self->_timeout;
351	});	438	});
…		…
414	if $self->{low_water_mark} >= length $self->{wbuf}	501	if $self->{low_water_mark} >= length $self->{wbuf}
415	&& $self->{on_drain};	502	&& $self->{on_drain};
416		503
417	delete $self->{_ww} unless length $self->{wbuf};	504	delete $self->{_ww} unless length $self->{wbuf};
418	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	505	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
419	$self->error;	506	$self->_error ($!, 1);
420	}	507	}
421	};	508	};
422		509
423	# try to write data immediately	510	# try to write data immediately
424	$cb->();	511	$cb->() unless $self->{autocork};
425		512
426	# if still data left in wbuf, we need to poll	513	# if still data left in wbuf, we need to poll
427	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	514	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
428	if length $self->{wbuf};	515	if length $self->{wbuf};
429	};	516	};
…		…
444	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	531	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
445	->($self, @_);	532	->($self, @_);
446	}	533	}
447		534
448	if ($self->{filter_w}) {	535	if ($self->{filter_w}) {
449	$self->{filter_w}->($self, \$_[0]);	536	$self->{filter_w}($self, \$_[0]);
450	} else {	537	} else {
451	$self->{wbuf} .= $_[0];	538	$self->{wbuf} .= $_[0];
452	$self->_drain_wbuf;	539	$self->_drain_wbuf;
453	}	540	}
454	}	541	}
455		542
456	=item $handle->push_write (type => @args)	543	=item $handle->push_write (type => @args)
457		544
458	=item $handle->unshift_write (type => @args)
459
460	Instead of formatting your data yourself, you can also let this module do	545	Instead of formatting your data yourself, you can also let this module do
461	the job by specifying a type and type-specific arguments.	546	the job by specifying a type and type-specific arguments.
462		547
463	Predefined types are (if you have ideas for additional types, feel free to	548	Predefined types are (if you have ideas for additional types, feel free to
464	drop by and tell us):	549	drop by and tell us):
…		…
468	=item netstring => $string	553	=item netstring => $string
469		554
470	Formats the given value as netstring	555	Formats the given value as netstring
471	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	556	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
472		557
473	=back
474
475	=cut	558	=cut
476		559
477	register_write_type netstring => sub {	560	register_write_type netstring => sub {
478	my ($self, $string) = @_;	561	my ($self, $string) = @_;
479		562
480	sprintf "%d:%s,", (length $string), $string	563	sprintf "%d:%s,", (length $string), $string
		564	};
		565
		566	=item packstring => $format, $data
		567
		568	An octet string prefixed with an encoded length. The encoding C<$format>
		569	uses the same format as a Perl C<pack> format, but must specify a single
		570	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		571	optional C<!>, C<< < >> or C<< > >> modifier).
		572
		573	=cut
		574
		575	register_write_type packstring => sub {
		576	my ($self, $format, $string) = @_;
		577
		578	pack "$format/a*", $string
481	};	579	};
482		580
483	=item json => $array_or_hashref	581	=item json => $array_or_hashref
484		582
485	Encodes the given hash or array reference into a JSON object. Unless you	583	Encodes the given hash or array reference into a JSON object. Unless you
…		…
519		617
520	$self->{json} ? $self->{json}->encode ($ref)	618	$self->{json} ? $self->{json}->encode ($ref)
521	: JSON::encode_json ($ref)	619	: JSON::encode_json ($ref)
522	};	620	};
523		621
		622	=item storable => $reference
		623
		624	Freezes the given reference using L<Storable> and writes it to the
		625	handle. Uses the C<nfreeze> format.
		626
		627	=cut
		628
		629	register_write_type storable => sub {
		630	my ($self, $ref) = @_;
		631
		632	require Storable;
		633
		634	pack "w/a*", Storable::nfreeze ($ref)
		635	};
		636
		637	=back
		638
524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	639	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525		640
526	This function (not method) lets you add your own types to C<push_write>.	641	This function (not method) lets you add your own types to C<push_write>.
527	Whenever the given C<type> is used, C<push_write> will invoke the code	642	Whenever the given C<type> is used, C<push_write> will invoke the code
528	reference with the handle object and the remaining arguments.	643	reference with the handle object and the remaining arguments.
…		…
548	ways, the "simple" way, using only C<on_read> and the "complex" way, using	663	ways, the "simple" way, using only C<on_read> and the "complex" way, using
549	a queue.	664	a queue.
550		665
551	In the simple case, you just install an C<on_read> callback and whenever	666	In the simple case, you just install an C<on_read> callback and whenever
552	new data arrives, it will be called. You can then remove some data (if	667	new data arrives, it will be called. You can then remove some data (if
553	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	668	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
554	or not.	669	leave the data there if you want to accumulate more (e.g. when only a
		670	partial message has been received so far).
555		671
556	In the more complex case, you want to queue multiple callbacks. In this	672	In the more complex case, you want to queue multiple callbacks. In this
557	case, AnyEvent::Handle will call the first queued callback each time new	673	case, AnyEvent::Handle will call the first queued callback each time new
558	data arrives and removes it when it has done its job (see C<push_read>,	674	data arrives (also the first time it is queued) and removes it when it has
559	below).	675	done its job (see C<push_read>, below).
560		676
561	This way you can, for example, push three line-reads, followed by reading	677	This way you can, for example, push three line-reads, followed by reading
562	a chunk of data, and AnyEvent::Handle will execute them in order.	678	a chunk of data, and AnyEvent::Handle will execute them in order.
563		679
564	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	680	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
565	the specified number of bytes which give an XML datagram.	681	the specified number of bytes which give an XML datagram.
566		682
567	# in the default state, expect some header bytes	683	# in the default state, expect some header bytes
568	$handle->on_read (sub {	684	$handle->on_read (sub {
569	# some data is here, now queue the length-header-read (4 octets)	685	# some data is here, now queue the length-header-read (4 octets)
570	shift->unshift_read_chunk (4, sub {	686	shift->unshift_read (chunk => 4, sub {
571	# header arrived, decode	687	# header arrived, decode
572	my $len = unpack "N", $_[1];	688	my $len = unpack "N", $_[1];
573		689
574	# now read the payload	690	# now read the payload
575	shift->unshift_read_chunk ($len, sub {	691	shift->unshift_read (chunk => $len, sub {
576	my $xml = $_[1];	692	my $xml = $_[1];
577	# handle xml	693	# handle xml
578	});	694	});
579	});	695	});
580	});	696	});
581		697
582	Example 2: Implement a client for a protocol that replies either with	698	Example 2: Implement a client for a protocol that replies either with "OK"
583	"OK" and another line or "ERROR" for one request, and 64 bytes for the	699	and another line or "ERROR" for the first request that is sent, and 64
584	second request. Due tot he availability of a full queue, we can just	700	bytes for the second request. Due to the availability of a queue, we can
585	pipeline sending both requests and manipulate the queue as necessary in	701	just pipeline sending both requests and manipulate the queue as necessary
586	the callbacks:	702	in the callbacks.
587		703
588	# request one	704	When the first callback is called and sees an "OK" response, it will
		705	C<unshift> another line-read. This line-read will be queued I<before> the
		706	64-byte chunk callback.
		707
		708	# request one, returns either "OK + extra line" or "ERROR"
589	$handle->push_write ("request 1\015\012");	709	$handle->push_write ("request 1\015\012");
590		710
591	# we expect "ERROR" or "OK" as response, so push a line read	711	# we expect "ERROR" or "OK" as response, so push a line read
592	$handle->push_read_line (sub {	712	$handle->push_read (line => sub {
593	# if we got an "OK", we have to _prepend_ another line,	713	# if we got an "OK", we have to _prepend_ another line,
594	# so it will be read before the second request reads its 64 bytes	714	# so it will be read before the second request reads its 64 bytes
595	# which are already in the queue when this callback is called	715	# which are already in the queue when this callback is called
596	# we don't do this in case we got an error	716	# we don't do this in case we got an error
597	if ($_[1] eq "OK") {	717	if ($_[1] eq "OK") {
598	$_[0]->unshift_read_line (sub {	718	$_[0]->unshift_read (line => sub {
599	my $response = $_[1];	719	my $response = $_[1];
600	...	720	...
601	});	721	});
602	}	722	}
603	});	723	});
604		724
605	# request two	725	# request two, simply returns 64 octets
606	$handle->push_write ("request 2\015\012");	726	$handle->push_write ("request 2\015\012");
607		727
608	# simply read 64 bytes, always	728	# simply read 64 bytes, always
609	$handle->push_read_chunk (64, sub {	729	$handle->push_read (chunk => 64, sub {
610	my $response = $_[1];	730	my $response = $_[1];
611	...	731	...
612	});	732	});
613		733
614	=over 4	734	=over 4
615		735
616	=cut	736	=cut
617		737
618	sub _drain_rbuf {	738	sub _drain_rbuf {
619	my ($self) = @_;	739	my ($self) = @_;
		740
		741	local $self->{_in_drain} = 1;
620		742
621	if (	743	if (
622	defined $self->{rbuf_max}	744	defined $self->{rbuf_max}
623	&& $self->{rbuf_max} < length $self->{rbuf}	745	&& $self->{rbuf_max} < length $self->{rbuf}
624	) {	746	) {
625	$! = &Errno::ENOSPC;	747	$self->_error (&Errno::ENOSPC, 1), return;
626	$self->error;
627	}	748	}
628		749
629	return if $self->{in_drain};	750	while () {
630	local $self->{in_drain} = 1;
631
632	while (my $len = length $self->{rbuf}) {	751	my $len = length $self->{rbuf};
633	no strict 'refs';	752
634	if (my $cb = shift @{ $self->{_queue} }) {	753	if (my $cb = shift @{ $self->{_queue} }) {
635	unless ($cb->($self)) {	754	unless ($cb->($self)) {
636	if ($self->{_eof}) {	755	if ($self->{_eof}) {
637	# no progress can be made (not enough data and no data forthcoming)	756	# no progress can be made (not enough data and no data forthcoming)
638	$! = &Errno::EPIPE;	757	$self->_error (&Errno::EPIPE, 1), return;
639	$self->error;
640	}	758	}
641		759
642	unshift @{ $self->{_queue} }, $cb;	760	unshift @{ $self->{_queue} }, $cb;
643	return;	761	last;
644	}	762	}
645	} elsif ($self->{on_read}) {	763	} elsif ($self->{on_read}) {
		764	last unless $len;
		765
646	$self->{on_read}($self);	766	$self->{on_read}($self);
647		767
648	if (	768	if (
649	$self->{_eof} # if no further data will arrive
650	&& $len == length $self->{rbuf} # and no data has been consumed	769	$len == length $self->{rbuf} # if no data has been consumed
651	&& !@{ $self->{_queue} } # and the queue is still empty	770	&& !@{ $self->{_queue} } # and the queue is still empty
652	&& $self->{on_read} # and we still want to read data	771	&& $self->{on_read} # but we still have on_read
653	) {	772	) {
		773	# no further data will arrive
654	# then no progress can be made	774	# so no progress can be made
655	$! = &Errno::EPIPE;	775	$self->_error (&Errno::EPIPE, 1), return
656	$self->error;	776	if $self->{_eof};
		777
		778	last; # more data might arrive
657	}	779	}
658	} else {	780	} else {
659	# read side becomes idle	781	# read side becomes idle
660	delete $self->{_rw};	782	delete $self->{_rw};
661	return;	783	last;
662	}	784	}
663	}	785	}
664		786
665	if ($self->{_eof}) {	787	if ($self->{_eof}) {
666	$self->_shutdown;	788	if ($self->{on_eof}) {
667	$self->{on_eof}($self)	789	$self->{on_eof}($self)
668	if $self->{on_eof};	790	} else {
		791	$self->_error (0, 1);
		792	}
		793	}
		794
		795	# may need to restart read watcher
		796	unless ($self->{_rw}) {
		797	$self->start_read
		798	if $self->{on_read} \|\| @{ $self->{_queue} };
669	}	799	}
670	}	800	}
671		801
672	=item $handle->on_read ($cb)	802	=item $handle->on_read ($cb)
673		803
…		…
679		809
680	sub on_read {	810	sub on_read {
681	my ($self, $cb) = @_;	811	my ($self, $cb) = @_;
682		812
683	$self->{on_read} = $cb;	813	$self->{on_read} = $cb;
		814	$self->_drain_rbuf if $cb && !$self->{_in_drain};
684	}	815	}
685		816
686	=item $handle->rbuf	817	=item $handle->rbuf
687		818
688	Returns the read buffer (as a modifiable lvalue).	819	Returns the read buffer (as a modifiable lvalue).
…		…
737	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	868	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
738	->($self, $cb, @_);	869	->($self, $cb, @_);
739	}	870	}
740		871
741	push @{ $self->{_queue} }, $cb;	872	push @{ $self->{_queue} }, $cb;
742	$self->_drain_rbuf;	873	$self->_drain_rbuf unless $self->{_in_drain};
743	}	874	}
744		875
745	sub unshift_read {	876	sub unshift_read {
746	my $self = shift;	877	my $self = shift;
747	my $cb = pop;	878	my $cb = pop;
…		…
753	->($self, $cb, @_);	884	->($self, $cb, @_);
754	}	885	}
755		886
756		887
757	unshift @{ $self->{_queue} }, $cb;	888	unshift @{ $self->{_queue} }, $cb;
758	$self->_drain_rbuf;	889	$self->_drain_rbuf unless $self->{_in_drain};
759	}	890	}
760		891
761	=item $handle->push_read (type => @args, $cb)	892	=item $handle->push_read (type => @args, $cb)
762		893
763	=item $handle->unshift_read (type => @args, $cb)	894	=item $handle->unshift_read (type => @args, $cb)
…		…
793	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	924	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
794	1	925	1
795	}	926	}
796	};	927	};
797		928
798	# compatibility with older API
799	sub push_read_chunk {
800	$_[0]->push_read (chunk => $_[1], $_[2]);
801	}
802
803	sub unshift_read_chunk {
804	$_[0]->unshift_read (chunk => $_[1], $_[2]);
805	}
806
807	=item line => [$eol, ]$cb->($handle, $line, $eol)	929	=item line => [$eol, ]$cb->($handle, $line, $eol)
808		930
809	The callback will be called only once a full line (including the end of	931	The callback will be called only once a full line (including the end of
810	line marker, C<$eol>) has been read. This line (excluding the end of line	932	line marker, C<$eol>) has been read. This line (excluding the end of line
811	marker) will be passed to the callback as second argument (C<$line>), and	933	marker) will be passed to the callback as second argument (C<$line>), and
…		…
826	=cut	948	=cut
827		949
828	register_read_type line => sub {	950	register_read_type line => sub {
829	my ($self, $cb, $eol) = @_;	951	my ($self, $cb, $eol) = @_;
830		952
831	$eol = qr\|(\015?\012)\| if @_ < 3;	953	if (@_ < 3) {
832	$eol = quotemeta $eol unless ref $eol;	954	# this is more than twice as fast as the generic code below
833	$eol = qr\|^(.*?)($eol)\|s;
834
835	sub {	955	sub {
836	$_[0]{rbuf} =~ s/$eol// or return;	956	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
837		957
838	$cb->($_[0], $1, $2);	958	$cb->($_[0], $1, $2);
839	1
840	}
841	};
842
843	# compatibility with older API
844	sub push_read_line {
845	my $self = shift;
846	$self->push_read (line => @_);
847	}
848
849	sub unshift_read_line {
850	my $self = shift;
851	$self->unshift_read (line => @_);
852	}
853
854	=item netstring => $cb->($handle, $string)
855
856	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
857
858	Throws an error with C<$!> set to EBADMSG on format violations.
859
860	=cut
861
862	register_read_type netstring => sub {
863	my ($self, $cb) = @_;
864
865	sub {
866	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
867	if ($_[0]{rbuf} =~ /[^0-9]/) {
868	$! = &Errno::EBADMSG;
869	$self->error;
870	}	959	1
871	return;
872	}	960	}
		961	} else {
		962	$eol = quotemeta $eol unless ref $eol;
		963	$eol = qr\|^(.*?)($eol)\|s;
873		964
874	my $len = $1;	965	sub {
		966	$_[0]{rbuf} =~ s/$eol// or return;
875		967
876	$self->unshift_read (chunk => $len, sub {	968	$cb->($_[0], $1, $2);
877	my $string = $_[1];
878	$_[0]->unshift_read (chunk => 1, sub {
879	if ($_[1] eq ",") {
880	$cb->($_[0], $string);
881	} else {
882	$! = &Errno::EBADMSG;
883	$self->error;
884	}
885	});	969	1
886	});	970	}
887
888	1
889	}	971	}
890	};	972	};
891		973
892	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	974	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
893		975
…		…
945	return 1;	1027	return 1;
946	}	1028	}
947		1029
948	# reject	1030	# reject
949	if ($reject && $$rbuf =~ $reject) {	1031	if ($reject && $$rbuf =~ $reject) {
950	$! = &Errno::EBADMSG;	1032	$self->_error (&Errno::EBADMSG);
951	$self->error;
952	}	1033	}
953		1034
954	# skip	1035	# skip
955	if ($skip && $$rbuf =~ $skip) {	1036	if ($skip && $$rbuf =~ $skip) {
956	$data .= substr $$rbuf, 0, $+[0], "";	1037	$data .= substr $$rbuf, 0, $+[0], "";
…		…
958		1039
959	()	1040	()
960	}	1041	}
961	};	1042	};
962		1043
		1044	=item netstring => $cb->($handle, $string)
		1045
		1046	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1047
		1048	Throws an error with C<$!> set to EBADMSG on format violations.
		1049
		1050	=cut
		1051
		1052	register_read_type netstring => sub {
		1053	my ($self, $cb) = @_;
		1054
		1055	sub {
		1056	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1057	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1058	$self->_error (&Errno::EBADMSG);
		1059	}
		1060	return;
		1061	}
		1062
		1063	my $len = $1;
		1064
		1065	$self->unshift_read (chunk => $len, sub {
		1066	my $string = $_[1];
		1067	$_[0]->unshift_read (chunk => 1, sub {
		1068	if ($_[1] eq ",") {
		1069	$cb->($_[0], $string);
		1070	} else {
		1071	$self->_error (&Errno::EBADMSG);
		1072	}
		1073	});
		1074	});
		1075
		1076	1
		1077	}
		1078	};
		1079
		1080	=item packstring => $format, $cb->($handle, $string)
		1081
		1082	An octet string prefixed with an encoded length. The encoding C<$format>
		1083	uses the same format as a Perl C<pack> format, but must specify a single
		1084	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1085	optional C<!>, C<< < >> or C<< > >> modifier).
		1086
		1087	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1088
		1089	Example: read a block of data prefixed by its length in BER-encoded
		1090	format (very efficient).
		1091
		1092	$handle->push_read (packstring => "w", sub {
		1093	my ($handle, $data) = @_;
		1094	});
		1095
		1096	=cut
		1097
		1098	register_read_type packstring => sub {
		1099	my ($self, $cb, $format) = @_;
		1100
		1101	sub {
		1102	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1103	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1104	or return;
		1105
		1106	$format = length pack $format, $len;
		1107
		1108	# bypass unshift if we already have the remaining chunk
		1109	if ($format + $len <= length $_[0]{rbuf}) {
		1110	my $data = substr $_[0]{rbuf}, $format, $len;
		1111	substr $_[0]{rbuf}, 0, $format + $len, "";
		1112	$cb->($_[0], $data);
		1113	} else {
		1114	# remove prefix
		1115	substr $_[0]{rbuf}, 0, $format, "";
		1116
		1117	# read remaining chunk
		1118	$_[0]->unshift_read (chunk => $len, $cb);
		1119	}
		1120
		1121	1
		1122	}
		1123	};
		1124
963	=item json => $cb->($handle, $hash_or_arrayref)	1125	=item json => $cb->($handle, $hash_or_arrayref)
964		1126
965	Reads a JSON object or array, decodes it and passes it to the callback.	1127	Reads a JSON object or array, decodes it and passes it to the callback.
966		1128
967	If a C<json> object was passed to the constructor, then that will be used	1129	If a C<json> object was passed to the constructor, then that will be used
…		…
977	the C<json> write type description, above, for an actual example.	1139	the C<json> write type description, above, for an actual example.
978		1140
979	=cut	1141	=cut
980		1142
981	register_read_type json => sub {	1143	register_read_type json => sub {
982	my ($self, $cb, $accept, $reject, $skip) = @_;	1144	my ($self, $cb) = @_;
983		1145
984	require JSON;	1146	require JSON;
985		1147
986	my $data;	1148	my $data;
987	my $rbuf = \$self->{rbuf};	1149	my $rbuf = \$self->{rbuf};
…		…
1002	()	1164	()
1003	}	1165	}
1004	}	1166	}
1005	};	1167	};
1006		1168
		1169	=item storable => $cb->($handle, $ref)
		1170
		1171	Deserialises a L<Storable> frozen representation as written by the
		1172	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1173	data).
		1174
		1175	Raises C<EBADMSG> error if the data could not be decoded.
		1176
		1177	=cut
		1178
		1179	register_read_type storable => sub {
		1180	my ($self, $cb) = @_;
		1181
		1182	require Storable;
		1183
		1184	sub {
		1185	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1186	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1187	or return;
		1188
		1189	my $format = length pack "w", $len;
		1190
		1191	# bypass unshift if we already have the remaining chunk
		1192	if ($format + $len <= length $_[0]{rbuf}) {
		1193	my $data = substr $_[0]{rbuf}, $format, $len;
		1194	substr $_[0]{rbuf}, 0, $format + $len, "";
		1195	$cb->($_[0], Storable::thaw ($data));
		1196	} else {
		1197	# remove prefix
		1198	substr $_[0]{rbuf}, 0, $format, "";
		1199
		1200	# read remaining chunk
		1201	$_[0]->unshift_read (chunk => $len, sub {
		1202	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1203	$cb->($_[0], $ref);
		1204	} else {
		1205	$self->_error (&Errno::EBADMSG);
		1206	}
		1207	});
		1208	}
		1209
		1210	1
		1211	}
		1212	};
		1213
1007	=back	1214	=back
1008		1215
1009	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1216	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1010		1217
1011	This function (not method) lets you add your own types to C<push_read>.	1218	This function (not method) lets you add your own types to C<push_read>.
…		…
1029	=item $handle->stop_read	1236	=item $handle->stop_read
1030		1237
1031	=item $handle->start_read	1238	=item $handle->start_read
1032		1239
1033	In rare cases you actually do not want to read anything from the	1240	In rare cases you actually do not want to read anything from the
1034	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1241	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1035	any queued callbacks will be executed then. To start reading again, call	1242	any queued callbacks will be executed then. To start reading again, call
1036	C<start_read>.	1243	C<start_read>.
		1244
		1245	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1246	you change the C<on_read> callback or push/unshift a read callback, and it
		1247	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1248	there are any read requests in the queue.
1037		1249
1038	=cut	1250	=cut
1039		1251
1040	sub stop_read {	1252	sub stop_read {
1041	my ($self) = @_;	1253	my ($self) = @_;
…		…
1055		1267
1056	if ($len > 0) {	1268	if ($len > 0) {
1057	$self->{_activity} = AnyEvent->now;	1269	$self->{_activity} = AnyEvent->now;
1058		1270
1059	$self->{filter_r}	1271	$self->{filter_r}
1060	? $self->{filter_r}->($self, $rbuf)	1272	? $self->{filter_r}($self, $rbuf)
1061	: $self->_drain_rbuf;	1273	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1062		1274
1063	} elsif (defined $len) {	1275	} elsif (defined $len) {
1064	delete $self->{_rw};	1276	delete $self->{_rw};
1065	delete $self->{_ww};
1066	delete $self->{_tw};
1067	$self->{_eof} = 1;	1277	$self->{_eof} = 1;
1068	$self->_drain_rbuf;	1278	$self->_drain_rbuf unless $self->{_in_drain};
1069		1279
1070	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1280	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1071	return $self->error;	1281	return $self->_error ($!, 1);
1072	}	1282	}
1073	});	1283	});
1074	}	1284	}
1075	}	1285	}
1076		1286
1077	sub _dotls {	1287	sub _dotls {
1078	my ($self) = @_;	1288	my ($self) = @_;
		1289
		1290	my $buf;
1079		1291
1080	if (length $self->{_tls_wbuf}) {	1292	if (length $self->{_tls_wbuf}) {
1081	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1293	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1082	substr $self->{_tls_wbuf}, 0, $len, "";	1294	substr $self->{_tls_wbuf}, 0, $len, "";
1083	}	1295	}
1084	}	1296	}
1085		1297
1086	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1298	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1087	$self->{wbuf} .= $buf;	1299	$self->{wbuf} .= $buf;
1088	$self->_drain_wbuf;	1300	$self->_drain_wbuf;
1089	}	1301	}
1090		1302
1091	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1303	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1304	if (length $buf) {
1092	$self->{rbuf} .= $buf;	1305	$self->{rbuf} .= $buf;
1093	$self->_drain_rbuf;	1306	$self->_drain_rbuf unless $self->{_in_drain};
		1307	} else {
		1308	# let's treat SSL-eof as we treat normal EOF
		1309	$self->{_eof} = 1;
		1310	$self->_shutdown;
		1311	return;
		1312	}
1094	}	1313	}
1095		1314
1096	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1315	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1097		1316
1098	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1317	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1099	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1318	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1100	$self->error;	1319	return $self->_error ($!, 1);
1101	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1320	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1102	$! = &Errno::EIO;	1321	return $self->_error (&Errno::EIO, 1);
1103	$self->error;
1104	}	1322	}
1105		1323
1106	# all others are fine for our purposes	1324	# all others are fine for our purposes
1107	}	1325	}
1108	}	1326	}
…		…
1123	call and can be used or changed to your liking. Note that the handshake	1341	call and can be used or changed to your liking. Note that the handshake
1124	might have already started when this function returns.	1342	might have already started when this function returns.
1125		1343
1126	=cut	1344	=cut
1127		1345
1128	# TODO: maybe document...
1129	sub starttls {	1346	sub starttls {
1130	my ($self, $ssl, $ctx) = @_;	1347	my ($self, $ssl, $ctx) = @_;
1131		1348
1132	$self->stoptls;	1349	$self->stoptls;
1133		1350
…		…
1186		1403
1187	sub DESTROY {	1404	sub DESTROY {
1188	my $self = shift;	1405	my $self = shift;
1189		1406
1190	$self->stoptls;	1407	$self->stoptls;
		1408
		1409	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1410
		1411	if ($linger && length $self->{wbuf}) {
		1412	my $fh = delete $self->{fh};
		1413	my $wbuf = delete $self->{wbuf};
		1414
		1415	my @linger;
		1416
		1417	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1418	my $len = syswrite $fh, $wbuf, length $wbuf;
		1419
		1420	if ($len > 0) {
		1421	substr $wbuf, 0, $len, "";
		1422	} else {
		1423	@linger = (); # end
		1424	}
		1425	});
		1426	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1427	@linger = ();
		1428	});
		1429	}
1191	}	1430	}
1192		1431
1193	=item AnyEvent::Handle::TLS_CTX	1432	=item AnyEvent::Handle::TLS_CTX
1194		1433
1195	This function creates and returns the Net::SSLeay::CTX object used by	1434	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1237	=over 4	1476	=over 4
1238		1477
1239	=item * all constructor arguments become object members.	1478	=item * all constructor arguments become object members.
1240		1479
1241	At least initially, when you pass a C<tls>-argument to the constructor it	1480	At least initially, when you pass a C<tls>-argument to the constructor it
1242	will end up in C<< $handle->{tls} >>. Those members might be changes or	1481	will end up in C<< $handle->{tls} >>. Those members might be changed or
1243	mutated later on (for example C<tls> will hold the TLS connection object).	1482	mutated later on (for example C<tls> will hold the TLS connection object).
1244		1483
1245	=item * other object member names are prefixed with an C<_>.	1484	=item * other object member names are prefixed with an C<_>.
1246		1485
1247	All object members not explicitly documented (internal use) are prefixed	1486	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.44 by root, Thu May 29 00:00:07 2008 UTC vs. Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.44 by root, Thu May 29 00:00:07 2008 UTC vs.
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC