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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.53 by root, Mon Jun 2 09:12:14 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 = 4.1;	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 when an end-of-file condition is detcted,	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	81	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	82	connection cleanly.
83		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
84	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,
85	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
86	waiting for data.	91	waiting for data.
		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>.
87		95
88	=item on_error => $cb->($handle, $fatal)	96	=item on_error => $cb->($handle, $fatal)
89		97
90	This is the error callback, which is called when, well, some error	98	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	99	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	100	connect or a read error.
93		101
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	102	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	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
96	usable. Non-fatal errors can be retried by simply returning, but it is	108	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	109	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	110	when this callback is invoked. Examples of non-fatal errors are timeouts
		111	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		112
100	On callback entrance, the value of C<$!> contains the operating system	113	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	114	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		115
103	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
…		…
105	C<croak>.	118	C<croak>.
106		119
107	=item on_read => $cb->($handle)	120	=item on_read => $cb->($handle)
108		121
109	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
110	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).
111		126
112	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 >>
113	method or access the C<$handle->{rbuf}> member directly.	128	method or access the C<$handle->{rbuf}> member directly.
114		129
115	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
…		…
121		136
122	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
123	(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).
124		139
125	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.
		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.
126		147
127	=item timeout => $fractional_seconds	148	=item timeout => $fractional_seconds
128		149
129	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
130	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
…		…
154	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
155	(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
156	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
157	isn't finished).	178	isn't finished).
158		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
159	=item read_size => <bytes>	204	=item read_size => <bytes>
160		205
161	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
162	during each (loop iteration). Default: C<8192>.	207	during each (loop iteration). Default: C<8192>.
163		208
164	=item low_water_mark => <bytes>	209	=item low_water_mark => <bytes>
165		210
166	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
167	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
168	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.
169		225
170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	226	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
171		227
172	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
173	will start making tls handshake and will transparently encrypt/decrypt	229	will start making tls handshake and will transparently encrypt/decrypt
…		…
182	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
183	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>
184	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
185	AnyEvent::Handle.	241	AnyEvent::Handle.
186		242
187	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.
188		244
189	=item tls_ctx => $ssl_ctx	245	=item tls_ctx => $ssl_ctx
190		246
191	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
192	(unless a connection object was specified directly). If this parameter is	248	(unless a connection object was specified directly). If this parameter is
…		…
224	if ($self->{tls}) {	280	if ($self->{tls}) {
225	require Net::SSLeay;	281	require Net::SSLeay;
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	282	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
227	}	283	}
228		284
229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
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
232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
233
234	$self->{_activity} = AnyEvent->now;	285	$self->{_activity} = AnyEvent->now;
235	$self->_timeout;	286	$self->_timeout;
236		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
237	$self->start_read;	291	$self->start_read
		292	if $self->{on_read};
238		293
239	$self	294	$self
240	}	295	}
241		296
242	sub _shutdown {	297	sub _shutdown {
…		…
246	delete $self->{_rw};	301	delete $self->{_rw};
247	delete $self->{_ww};	302	delete $self->{_ww};
248	delete $self->{fh};	303	delete $self->{fh};
249		304
250	$self->stoptls;	305	$self->stoptls;
		306
		307	delete $self->{on_read};
		308	delete $self->{_queue};
251	}	309	}
252		310
253	sub _error {	311	sub _error {
254	my ($self, $errno, $fatal) = @_;	312	my ($self, $errno, $fatal) = @_;
255		313
…		…
301		359
302	=cut	360	=cut
303		361
304	sub on_timeout {	362	sub on_timeout {
305	$_[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	};
306	}	387	}
307		388
308	#############################################################################	389	#############################################################################
309		390
310	=item $handle->timeout ($seconds)	391	=item $handle->timeout ($seconds)
…		…
339	$self->{on_timeout}($self);	420	$self->{on_timeout}($self);
340	} else {	421	} else {
341	$self->_error (&Errno::ETIMEDOUT);	422	$self->_error (&Errno::ETIMEDOUT);
342	}	423	}
343		424
344	# callbakx could have changed timeout value, optimise	425	# callback could have changed timeout value, optimise
345	return unless $self->{timeout};	426	return unless $self->{timeout};
346		427
347	# calculate new after	428	# calculate new after
348	$after = $self->{timeout};	429	$after = $self->{timeout};
349	}	430	}
350		431
351	Scalar::Util::weaken $self;	432	Scalar::Util::weaken $self;
		433	return unless $self; # ->error could have destroyed $self
352		434
353	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	435	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
354	delete $self->{_tw};	436	delete $self->{_tw};
355	$self->_timeout;	437	$self->_timeout;
356	});	438	});
…		…
424	$self->_error ($!, 1);	506	$self->_error ($!, 1);
425	}	507	}
426	};	508	};
427		509
428	# try to write data immediately	510	# try to write data immediately
429	$cb->();	511	$cb->() unless $self->{autocork};
430		512
431	# if still data left in wbuf, we need to poll	513	# if still data left in wbuf, we need to poll
432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	514	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
433	if length $self->{wbuf};	515	if length $self->{wbuf};
434	};	516	};
…		…
479	my ($self, $string) = @_;	561	my ($self, $string) = @_;
480		562
481	sprintf "%d:%s,", (length $string), $string	563	sprintf "%d:%s,", (length $string), $string
482	};	564	};
483		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
		579	};
		580
484	=item json => $array_or_hashref	581	=item json => $array_or_hashref
485		582
486	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
487	provide your own JSON object, this means it will be encoded to JSON text	584	provide your own JSON object, this means it will be encoded to JSON text
488	in UTF-8.	585	in UTF-8.
…		…
520		617
521	$self->{json} ? $self->{json}->encode ($ref)	618	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	619	: JSON::encode_json ($ref)
523	};	620	};
524		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
525	=back	637	=back
526		638
527	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	639	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
528		640
529	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>.
…		…
551	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
552	a queue.	664	a queue.
553		665
554	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
555	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
556	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
557	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).
558		671
559	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
560	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
561	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
562	below).	675	done its job (see C<push_read>, below).
563		676
564	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
565	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.
566		679
567	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
…		…
580	# handle xml	693	# handle xml
581	});	694	});
582	});	695	});
583	});	696	});
584		697
585	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"
586	"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
587	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
588	pipeline sending both requests and manipulate the queue as necessary in	701	just pipeline sending both requests and manipulate the queue as necessary
589	the callbacks:	702	in the callbacks.
590		703
591	# 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"
592	$handle->push_write ("request 1\015\012");	709	$handle->push_write ("request 1\015\012");
593		710
594	# 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
595	$handle->push_read (line => sub {	712	$handle->push_read (line => sub {
596	# if we got an "OK", we have to _prepend_ another line,	713	# if we got an "OK", we have to _prepend_ another line,
…		…
603	...	720	...
604	});	721	});
605	}	722	}
606	});	723	});
607		724
608	# request two	725	# request two, simply returns 64 octets
609	$handle->push_write ("request 2\015\012");	726	$handle->push_write ("request 2\015\012");
610		727
611	# simply read 64 bytes, always	728	# simply read 64 bytes, always
612	$handle->push_read (chunk => 64, sub {	729	$handle->push_read (chunk => 64, sub {
613	my $response = $_[1];	730	my $response = $_[1];
…		…
619	=cut	736	=cut
620		737
621	sub _drain_rbuf {	738	sub _drain_rbuf {
622	my ($self) = @_;	739	my ($self) = @_;
623		740
		741	local $self->{_in_drain} = 1;
		742
624	if (	743	if (
625	defined $self->{rbuf_max}	744	defined $self->{rbuf_max}
626	&& $self->{rbuf_max} < length $self->{rbuf}	745	&& $self->{rbuf_max} < length $self->{rbuf}
627	) {	746	) {
628	return $self->_error (&Errno::ENOSPC, 1);	747	$self->_error (&Errno::ENOSPC, 1), return;
629	}	748	}
630		749
631	return if $self->{in_drain};	750	while () {
632	local $self->{in_drain} = 1;
633
634	while (my $len = length $self->{rbuf}) {	751	my $len = length $self->{rbuf};
635	no strict 'refs';	752
636	if (my $cb = shift @{ $self->{_queue} }) {	753	if (my $cb = shift @{ $self->{_queue} }) {
637	unless ($cb->($self)) {	754	unless ($cb->($self)) {
638	if ($self->{_eof}) {	755	if ($self->{_eof}) {
639	# 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)
640	return $self->_error (&Errno::EPIPE, 1);	757	$self->_error (&Errno::EPIPE, 1), return;
641	}	758	}
642		759
643	unshift @{ $self->{_queue} }, $cb;	760	unshift @{ $self->{_queue} }, $cb;
644	return;	761	last;
645	}	762	}
646	} elsif ($self->{on_read}) {	763	} elsif ($self->{on_read}) {
		764	last unless $len;
		765
647	$self->{on_read}($self);	766	$self->{on_read}($self);
648		767
649	if (	768	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	769	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	770	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	771	&& $self->{on_read} # but we still have on_read
654	) {	772	) {
		773	# no further data will arrive
655	# then no progress can be made	774	# so no progress can be made
656	return $self->_error (&Errno::EPIPE, 1);	775	$self->_error (&Errno::EPIPE, 1), return
		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
		787	if ($self->{_eof}) {
		788	if ($self->{on_eof}) {
665	$self->{on_eof}($self)	789	$self->{on_eof}($self)
666	if $self->{_eof} && $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} };
		799	}
667	}	800	}
668		801
669	=item $handle->on_read ($cb)	802	=item $handle->on_read ($cb)
670		803
671	This replaces the currently set C<on_read> callback, or clears it (when	804	This replaces the currently set C<on_read> callback, or clears it (when
…		…
676		809
677	sub on_read {	810	sub on_read {
678	my ($self, $cb) = @_;	811	my ($self, $cb) = @_;
679		812
680	$self->{on_read} = $cb;	813	$self->{on_read} = $cb;
		814	$self->_drain_rbuf if $cb && !$self->{_in_drain};
681	}	815	}
682		816
683	=item $handle->rbuf	817	=item $handle->rbuf
684		818
685	Returns the read buffer (as a modifiable lvalue).	819	Returns the read buffer (as a modifiable lvalue).
…		…
734	$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")
735	->($self, $cb, @_);	869	->($self, $cb, @_);
736	}	870	}
737		871
738	push @{ $self->{_queue} }, $cb;	872	push @{ $self->{_queue} }, $cb;
739	$self->_drain_rbuf;	873	$self->_drain_rbuf unless $self->{_in_drain};
740	}	874	}
741		875
742	sub unshift_read {	876	sub unshift_read {
743	my $self = shift;	877	my $self = shift;
744	my $cb = pop;	878	my $cb = pop;
…		…
750	->($self, $cb, @_);	884	->($self, $cb, @_);
751	}	885	}
752		886
753		887
754	unshift @{ $self->{_queue} }, $cb;	888	unshift @{ $self->{_queue} }, $cb;
755	$self->_drain_rbuf;	889	$self->_drain_rbuf unless $self->{_in_drain};
756	}	890	}
757		891
758	=item $handle->push_read (type => @args, $cb)	892	=item $handle->push_read (type => @args, $cb)
759		893
760	=item $handle->unshift_read (type => @args, $cb)	894	=item $handle->unshift_read (type => @args, $cb)
…		…
790	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	924	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
791	1	925	1
792	}	926	}
793	};	927	};
794		928
795	# compatibility with older API
796	sub push_read_chunk {
797	$_[0]->push_read (chunk => $_[1], $_[2]);
798	}
799
800	sub unshift_read_chunk {
801	$_[0]->unshift_read (chunk => $_[1], $_[2]);
802	}
803
804	=item line => [$eol, ]$cb->($handle, $line, $eol)	929	=item line => [$eol, ]$cb->($handle, $line, $eol)
805		930
806	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
807	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
808	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
…		…
823	=cut	948	=cut
824		949
825	register_read_type line => sub {	950	register_read_type line => sub {
826	my ($self, $cb, $eol) = @_;	951	my ($self, $cb, $eol) = @_;
827		952
828	$eol = qr\|(\015?\012)\| if @_ < 3;	953	if (@_ < 3) {
829	$eol = quotemeta $eol unless ref $eol;	954	# this is more than twice as fast as the generic code below
830	$eol = qr\|^(.*?)($eol)\|s;
831
832	sub {	955	sub {
833	$_[0]{rbuf} =~ s/$eol// or return;	956	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
834		957
835	$cb->($_[0], $1, $2);	958	$cb->($_[0], $1, $2);
836	1
837	}
838	};
839
840	# compatibility with older API
841	sub push_read_line {
842	my $self = shift;
843	$self->push_read (line => @_);
844	}
845
846	sub unshift_read_line {
847	my $self = shift;
848	$self->unshift_read (line => @_);
849	}
850
851	=item netstring => $cb->($handle, $string)
852
853	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
854
855	Throws an error with C<$!> set to EBADMSG on format violations.
856
857	=cut
858
859	register_read_type netstring => sub {
860	my ($self, $cb) = @_;
861
862	sub {
863	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
864	if ($_[0]{rbuf} =~ /[^0-9]/) {
865	$self->_error (&Errno::EBADMSG);
866	}	959	1
867	return;
868	}	960	}
		961	} else {
		962	$eol = quotemeta $eol unless ref $eol;
		963	$eol = qr\|^(.*?)($eol)\|s;
869		964
870	my $len = $1;	965	sub {
		966	$_[0]{rbuf} =~ s/$eol// or return;
871		967
872	$self->unshift_read (chunk => $len, sub {	968	$cb->($_[0], $1, $2);
873	my $string = $_[1];
874	$_[0]->unshift_read (chunk => 1, sub {
875	if ($_[1] eq ",") {
876	$cb->($_[0], $string);
877	} else {
878	$self->_error (&Errno::EBADMSG);
879	}
880	});	969	1
881	});	970	}
882
883	1
884	}	971	}
885	};	972	};
886		973
887	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	974	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
888		975
…		…
952		1039
953	()	1040	()
954	}	1041	}
955	};	1042	};
956		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
957	=item json => $cb->($handle, $hash_or_arrayref)	1125	=item json => $cb->($handle, $hash_or_arrayref)
958		1126
959	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.
960		1128
961	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
…		…
971	the C<json> write type description, above, for an actual example.	1139	the C<json> write type description, above, for an actual example.
972		1140
973	=cut	1141	=cut
974		1142
975	register_read_type json => sub {	1143	register_read_type json => sub {
976	my ($self, $cb, $accept, $reject, $skip) = @_;	1144	my ($self, $cb) = @_;
977		1145
978	require JSON;	1146	require JSON;
979		1147
980	my $data;	1148	my $data;
981	my $rbuf = \$self->{rbuf};	1149	my $rbuf = \$self->{rbuf};
…		…
996	()	1164	()
997	}	1165	}
998	}	1166	}
999	};	1167	};
1000		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
1001	=back	1214	=back
1002		1215
1003	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1216	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1004		1217
1005	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>.
…		…
1023	=item $handle->stop_read	1236	=item $handle->stop_read
1024		1237
1025	=item $handle->start_read	1238	=item $handle->start_read
1026		1239
1027	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
1028	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
1029	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
1030	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.
1031		1249
1032	=cut	1250	=cut
1033		1251
1034	sub stop_read {	1252	sub stop_read {
1035	my ($self) = @_;	1253	my ($self) = @_;
…		…
1050	if ($len > 0) {	1268	if ($len > 0) {
1051	$self->{_activity} = AnyEvent->now;	1269	$self->{_activity} = AnyEvent->now;
1052		1270
1053	$self->{filter_r}	1271	$self->{filter_r}
1054	? $self->{filter_r}($self, $rbuf)	1272	? $self->{filter_r}($self, $rbuf)
1055	: $self->_drain_rbuf;	1273	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1056		1274
1057	} elsif (defined $len) {	1275	} elsif (defined $len) {
1058	delete $self->{_rw};	1276	delete $self->{_rw};
1059	$self->{_eof} = 1;	1277	$self->{_eof} = 1;
1060	$self->_drain_rbuf;	1278	$self->_drain_rbuf unless $self->{_in_drain};
1061		1279
1062	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1280	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1063	return $self->_error ($!, 1);	1281	return $self->_error ($!, 1);
1064	}	1282	}
1065	});	1283	});
…		…
1067	}	1285	}
1068		1286
1069	sub _dotls {	1287	sub _dotls {
1070	my ($self) = @_;	1288	my ($self) = @_;
1071		1289
		1290	my $buf;
		1291
1072	if (length $self->{_tls_wbuf}) {	1292	if (length $self->{_tls_wbuf}) {
1073	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) {
1074	substr $self->{_tls_wbuf}, 0, $len, "";	1294	substr $self->{_tls_wbuf}, 0, $len, "";
1075	}	1295	}
1076	}	1296	}
1077		1297
1078	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1298	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1079	$self->{wbuf} .= $buf;	1299	$self->{wbuf} .= $buf;
1080	$self->_drain_wbuf;	1300	$self->_drain_wbuf;
1081	}	1301	}
1082		1302
1083	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1303	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1304	if (length $buf) {
1084	$self->{rbuf} .= $buf;	1305	$self->{rbuf} .= $buf;
1085	$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	}
1086	}	1313	}
1087		1314
1088	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1315	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1089		1316
1090	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1317	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
…		…
1176		1403
1177	sub DESTROY {	1404	sub DESTROY {
1178	my $self = shift;	1405	my $self = shift;
1179		1406
1180	$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	}
1181	}	1430	}
1182		1431
1183	=item AnyEvent::Handle::TLS_CTX	1432	=item AnyEvent::Handle::TLS_CTX
1184		1433
1185	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
…		…
1227	=over 4	1476	=over 4
1228		1477
1229	=item * all constructor arguments become object members.	1478	=item * all constructor arguments become object members.
1230		1479
1231	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
1232	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
1233	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).
1234		1483
1235	=item * other object member names are prefixed with an C<_>.	1484	=item * other object member names are prefixed with an C<_>.
1236		1485
1237	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.53 by root, Mon Jun 2 09:12:14 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.53 by root, Mon Jun 2 09:12:14 2008 UTC vs.
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC