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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.54 by root, Tue Jun 3 09:02:46 2008 UTC vs.
Revision 1.87 by root, Thu Aug 21 20:52:39 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.12;	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;
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detcted,	84	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	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the eof
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	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	94	otherwise you might end up with a closed socket while you are still
86	waiting for data.	95	waiting for data.
		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
87		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal)
89		101
90	This is the error callback, which is called when, well, some error	102	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	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	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	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C< ->rbuf >). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
96	usable. Non-fatal errors can be retried by simply returning, but it is	112	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	113	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		116
100	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		119
103	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
105	C<croak>.	122	C<croak>.
106		123
107	=item on_read => $cb->($handle)	124	=item on_read => $cb->($handle)
108		125
109	This sets the default read callback, which is called when data arrives	126	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue.	127	and no read request is in the queue (unlike read queue callbacks, this
		128	callback will only be called when at least one octet of data is in the
		129	read buffer).
111		130
112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113	method or access the C<$handle->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
114		133
115	When an EOF condition is detected then AnyEvent::Handle will first try to	134	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
121		140
122	This sets the callback that is called when the write buffer becomes empty	141	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).	142	(or when the callback is set and the buffer is empty already).
124		143
125	To append to the write buffer, use the C<< ->push_write >> method.	144	To append to the write buffer, use the C<< ->push_write >> method.
		145
		146	This callback is useful when you don't want to put all of your write data
		147	into the queue at once, for example, when you want to write the contents
		148	of some file to the socket you might not want to read the whole file into
		149	memory and push it into the queue, but instead only read more data from
		150	the file when the write queue becomes empty.
126		151
127	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
128		153
129	If non-zero, then this enables an "inactivity" timeout: whenever this many	154	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	155	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	179	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	180	(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	181	amount of data without a callback ever being called as long as the line
157	isn't finished).	182	isn't finished).
158		183
		184	=item autocork => <boolean>
		185
		186	When disabled (the default), then C<push_write> will try to immediately
		187	write the data to the handle if possible. This avoids having to register
		188	a write watcher and wait for the next event loop iteration, but can be
		189	inefficient if you write multiple small chunks (this disadvantage is
		190	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		191
		192	When enabled, then writes will always be queued till the next event loop
		193	iteration. This is efficient when you do many small writes per iteration,
		194	but less efficient when you do a single write only.
		195
		196	=item no_delay => <boolean>
		197
		198	When doing small writes on sockets, your operating system kernel might
		199	wait a bit for more data before actually sending it out. This is called
		200	the Nagle algorithm, and usually it is beneficial.
		201
		202	In some situations you want as low a delay as possible, which cna be
		203	accomplishd by setting this option to true.
		204
		205	The default is your opertaing system's default behaviour, this option
		206	explicitly enables or disables it, if possible.
		207
159	=item read_size => <bytes>	208	=item read_size => <bytes>
160		209
161	The default read block size (the amount of bytes this module will try to read	210	The default read block size (the amount of bytes this module will try to read
162	during each (loop iteration). Default: C<8192>.	211	during each (loop iteration). Default: C<8192>.
163		212
…		…
165		214
166	Sets the amount of bytes (default: C<0>) that make up an "empty" write	215	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	216	buffer: If the write reaches this size or gets even samller it is
168	considered empty.	217	considered empty.
169		218
		219	=item linger => <seconds>
		220
		221	If non-zero (default: C<3600>), then the destructor of the
		222	AnyEvent::Handle object will check wether there is still outstanding write
		223	data and will install a watcher that will write out this data. No errors
		224	will be reported (this mostly matches how the operating system treats
		225	outstanding data at socket close time).
		226
		227	This will not work for partial TLS data that could not yet been
		228	encoded. This data will be lost.
		229
170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
171		231
172	When this parameter is given, it enables TLS (SSL) mode, that means it	232	When this parameter is given, it enables TLS (SSL) mode, that means
173	will start making tls handshake and will transparently encrypt/decrypt	233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt
174	data.	234	data.
175		235
176	TLS mode requires Net::SSLeay to be installed (it will be loaded	236	TLS mode requires Net::SSLeay to be installed (it will be loaded
177	automatically when you try to create a TLS handle).	237	automatically when you try to create a TLS handle).
178		238
179	For the TLS server side, use C<accept>, and for the TLS client side of a	239	Unlike TCP, TLS has a server and client side: for the TLS server side, use
180	connection, use C<connect> mode.	240	C<accept>, and for the TLS client side of a connection, use C<connect>
		241	mode.
181		242
182	You can also provide your own TLS connection object, but you have	243	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>	244	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	245	or C<Net::SSLeay::set_accept_state> on it before you pass it to
185	AnyEvent::Handle.	246	AnyEvent::Handle.
186		247
187	See the C<starttls> method if you need to start TLs negotiation later.	248	See the C<starttls> method for when need to start TLS negotiation later.
188		249
189	=item tls_ctx => $ssl_ctx	250	=item tls_ctx => $ssl_ctx
190		251
191	Use the given Net::SSLeay::CTX object to create the new TLS connection	252	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	253	(unless a connection object was specified directly). If this parameter is
…		…
195	=item json => JSON or JSON::XS object	256	=item json => JSON or JSON::XS object
196		257
197	This is the json coder object used by the C<json> read and write types.	258	This is the json coder object used by the C<json> read and write types.
198		259
199	If you don't supply it, then AnyEvent::Handle will create and use a	260	If you don't supply it, then AnyEvent::Handle will create and use a
200	suitable one, which will write and expect UTF-8 encoded JSON texts.	261	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		262	texts.
201		263
202	Note that you are responsible to depend on the JSON module if you want to	264	Note that you are responsible to depend on the JSON module if you want to
203	use this functionality, as AnyEvent does not have a dependency itself.	265	use this functionality, as AnyEvent does not have a dependency itself.
204		266
205	=item filter_r => $cb	267	=item filter_r => $cb
206		268
207	=item filter_w => $cb	269	=item filter_w => $cb
208		270
209	These exist, but are undocumented at this time.	271	These exist, but are undocumented at this time. (They are used internally
		272	by the TLS code).
210		273
211	=back	274	=back
212		275
213	=cut	276	=cut
214		277
…		…
224	if ($self->{tls}) {	287	if ($self->{tls}) {
225	require Net::SSLeay;	288	require Net::SSLeay;
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	289	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
227	}	290	}
228		291
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;	292	$self->{_activity} = AnyEvent->now;
235	$self->_timeout;	293	$self->_timeout;
236		294
		295	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		296	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		297
237	$self->start_read;	298	$self->start_read
		299	if $self->{on_read};
238		300
239	$self	301	$self
240	}	302	}
241		303
242	sub _shutdown {	304	sub _shutdown {
…		…
246	delete $self->{_rw};	308	delete $self->{_rw};
247	delete $self->{_ww};	309	delete $self->{_ww};
248	delete $self->{fh};	310	delete $self->{fh};
249		311
250	$self->stoptls;	312	$self->stoptls;
		313
		314	delete $self->{on_read};
		315	delete $self->{_queue};
251	}	316	}
252		317
253	sub _error {	318	sub _error {
254	my ($self, $errno, $fatal) = @_;	319	my ($self, $errno, $fatal) = @_;
255		320
…		…
301		366
302	=cut	367	=cut
303		368
304	sub on_timeout {	369	sub on_timeout {
305	$_[0]{on_timeout} = $_[1];	370	$_[0]{on_timeout} = $_[1];
		371	}
		372
		373	=item $handle->autocork ($boolean)
		374
		375	Enables or disables the current autocork behaviour (see C<autocork>
		376	constructor argument).
		377
		378	=cut
		379
		380	=item $handle->no_delay ($boolean)
		381
		382	Enables or disables the C<no_delay> setting (see constructor argument of
		383	the same name for details).
		384
		385	=cut
		386
		387	sub no_delay {
		388	$_[0]{no_delay} = $_[1];
		389
		390	eval {
		391	local $SIG{__DIE__};
		392	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		393	};
306	}	394	}
307		395
308	#############################################################################	396	#############################################################################
309		397
310	=item $handle->timeout ($seconds)	398	=item $handle->timeout ($seconds)
…		…
339	$self->{on_timeout}($self);	427	$self->{on_timeout}($self);
340	} else {	428	} else {
341	$self->_error (&Errno::ETIMEDOUT);	429	$self->_error (&Errno::ETIMEDOUT);
342	}	430	}
343		431
344	# callbakx could have changed timeout value, optimise	432	# callback could have changed timeout value, optimise
345	return unless $self->{timeout};	433	return unless $self->{timeout};
346		434
347	# calculate new after	435	# calculate new after
348	$after = $self->{timeout};	436	$after = $self->{timeout};
349	}	437	}
350		438
351	Scalar::Util::weaken $self;	439	Scalar::Util::weaken $self;
		440	return unless $self; # ->error could have destroyed $self
352		441
353	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	442	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
354	delete $self->{_tw};	443	delete $self->{_tw};
355	$self->_timeout;	444	$self->_timeout;
356	});	445	});
…		…
424	$self->_error ($!, 1);	513	$self->_error ($!, 1);
425	}	514	}
426	};	515	};
427		516
428	# try to write data immediately	517	# try to write data immediately
429	$cb->();	518	$cb->() unless $self->{autocork};
430		519
431	# if still data left in wbuf, we need to poll	520	# if still data left in wbuf, we need to poll
432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	521	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
433	if length $self->{wbuf};	522	if length $self->{wbuf};
434	};	523	};
…		…
479	my ($self, $string) = @_;	568	my ($self, $string) = @_;
480		569
481	sprintf "%d:%s,", (length $string), $string	570	sprintf "%d:%s,", (length $string), $string
482	};	571	};
483		572
		573	=item packstring => $format, $data
		574
		575	An octet string prefixed with an encoded length. The encoding C<$format>
		576	uses the same format as a Perl C<pack> format, but must specify a single
		577	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		578	optional C<!>, C<< < >> or C<< > >> modifier).
		579
		580	=cut
		581
		582	register_write_type packstring => sub {
		583	my ($self, $format, $string) = @_;
		584
		585	pack "$format/a*", $string
		586	};
		587
484	=item json => $array_or_hashref	588	=item json => $array_or_hashref
485		589
486	Encodes the given hash or array reference into a JSON object. Unless you	590	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	591	provide your own JSON object, this means it will be encoded to JSON text
488	in UTF-8.	592	in UTF-8.
…		…
520		624
521	$self->{json} ? $self->{json}->encode ($ref)	625	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	626	: JSON::encode_json ($ref)
523	};	627	};
524		628
		629	=item storable => $reference
		630
		631	Freezes the given reference using L<Storable> and writes it to the
		632	handle. Uses the C<nfreeze> format.
		633
		634	=cut
		635
		636	register_write_type storable => sub {
		637	my ($self, $ref) = @_;
		638
		639	require Storable;
		640
		641	pack "w/a*", Storable::nfreeze ($ref)
		642	};
		643
525	=back	644	=back
526		645
527	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	646	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
528		647
529	This function (not method) lets you add your own types to C<push_write>.	648	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	670	ways, the "simple" way, using only C<on_read> and the "complex" way, using
552	a queue.	671	a queue.
553		672
554	In the simple case, you just install an C<on_read> callback and whenever	673	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	674	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	675	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
557	or not.	676	leave the data there if you want to accumulate more (e.g. when only a
		677	partial message has been received so far).
558		678
559	In the more complex case, you want to queue multiple callbacks. In this	679	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	680	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>,	681	data arrives (also the first time it is queued) and removes it when it has
562	below).	682	done its job (see C<push_read>, below).
563		683
564	This way you can, for example, push three line-reads, followed by reading	684	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.	685	a chunk of data, and AnyEvent::Handle will execute them in order.
566		686
567	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	687	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
…		…
580	# handle xml	700	# handle xml
581	});	701	});
582	});	702	});
583	});	703	});
584		704
585	Example 2: Implement a client for a protocol that replies either with	705	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	706	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	707	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	708	just pipeline sending both requests and manipulate the queue as necessary
589	the callbacks:	709	in the callbacks.
590		710
591	# request one	711	When the first callback is called and sees an "OK" response, it will
		712	C<unshift> another line-read. This line-read will be queued I<before> the
		713	64-byte chunk callback.
		714
		715	# request one, returns either "OK + extra line" or "ERROR"
592	$handle->push_write ("request 1\015\012");	716	$handle->push_write ("request 1\015\012");
593		717
594	# we expect "ERROR" or "OK" as response, so push a line read	718	# we expect "ERROR" or "OK" as response, so push a line read
595	$handle->push_read (line => sub {	719	$handle->push_read (line => sub {
596	# if we got an "OK", we have to _prepend_ another line,	720	# if we got an "OK", we have to _prepend_ another line,
…		…
603	...	727	...
604	});	728	});
605	}	729	}
606	});	730	});
607		731
608	# request two	732	# request two, simply returns 64 octets
609	$handle->push_write ("request 2\015\012");	733	$handle->push_write ("request 2\015\012");
610		734
611	# simply read 64 bytes, always	735	# simply read 64 bytes, always
612	$handle->push_read (chunk => 64, sub {	736	$handle->push_read (chunk => 64, sub {
613	my $response = $_[1];	737	my $response = $_[1];
…		…
619	=cut	743	=cut
620		744
621	sub _drain_rbuf {	745	sub _drain_rbuf {
622	my ($self) = @_;	746	my ($self) = @_;
623		747
		748	local $self->{_in_drain} = 1;
		749
624	if (	750	if (
625	defined $self->{rbuf_max}	751	defined $self->{rbuf_max}
626	&& $self->{rbuf_max} < length $self->{rbuf}	752	&& $self->{rbuf_max} < length $self->{rbuf}
627	) {	753	) {
628	return $self->_error (&Errno::ENOSPC, 1);	754	$self->_error (&Errno::ENOSPC, 1), return;
629	}	755	}
630		756
631	return if $self->{in_drain};	757	while () {
632	local $self->{in_drain} = 1;
633
634	while (my $len = length $self->{rbuf}) {	758	my $len = length $self->{rbuf};
635	no strict 'refs';	759
636	if (my $cb = shift @{ $self->{_queue} }) {	760	if (my $cb = shift @{ $self->{_queue} }) {
637	unless ($cb->($self)) {	761	unless ($cb->($self)) {
638	if ($self->{_eof}) {	762	if ($self->{_eof}) {
639	# no progress can be made (not enough data and no data forthcoming)	763	# no progress can be made (not enough data and no data forthcoming)
640	return $self->_error (&Errno::EPIPE, 1);	764	$self->_error (&Errno::EPIPE, 1), return;
641	}	765	}
642		766
643	unshift @{ $self->{_queue} }, $cb;	767	unshift @{ $self->{_queue} }, $cb;
644	return;	768	last;
645	}	769	}
646	} elsif ($self->{on_read}) {	770	} elsif ($self->{on_read}) {
		771	last unless $len;
		772
647	$self->{on_read}($self);	773	$self->{on_read}($self);
648		774
649	if (	775	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	776	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	777	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	778	&& $self->{on_read} # but we still have on_read
654	) {	779	) {
		780	# no further data will arrive
655	# then no progress can be made	781	# so no progress can be made
656	return $self->_error (&Errno::EPIPE, 1);	782	$self->_error (&Errno::EPIPE, 1), return
		783	if $self->{_eof};
		784
		785	last; # more data might arrive
657	}	786	}
658	} else {	787	} else {
659	# read side becomes idle	788	# read side becomes idle
660	delete $self->{_rw};	789	delete $self->{_rw};
661	return;	790	last;
662	}	791	}
663	}	792	}
664		793
		794	if ($self->{_eof}) {
		795	if ($self->{on_eof}) {
665	$self->{on_eof}($self)	796	$self->{on_eof}($self)
666	if $self->{_eof} && $self->{on_eof};	797	} else {
		798	$self->_error (0, 1);
		799	}
		800	}
		801
		802	# may need to restart read watcher
		803	unless ($self->{_rw}) {
		804	$self->start_read
		805	if $self->{on_read} \|\| @{ $self->{_queue} };
		806	}
667	}	807	}
668		808
669	=item $handle->on_read ($cb)	809	=item $handle->on_read ($cb)
670		810
671	This replaces the currently set C<on_read> callback, or clears it (when	811	This replaces the currently set C<on_read> callback, or clears it (when
…		…
676		816
677	sub on_read {	817	sub on_read {
678	my ($self, $cb) = @_;	818	my ($self, $cb) = @_;
679		819
680	$self->{on_read} = $cb;	820	$self->{on_read} = $cb;
		821	$self->_drain_rbuf if $cb && !$self->{_in_drain};
681	}	822	}
682		823
683	=item $handle->rbuf	824	=item $handle->rbuf
684		825
685	Returns the read buffer (as a modifiable lvalue).	826	Returns the read buffer (as a modifiable lvalue).
…		…
734	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	875	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
735	->($self, $cb, @_);	876	->($self, $cb, @_);
736	}	877	}
737		878
738	push @{ $self->{_queue} }, $cb;	879	push @{ $self->{_queue} }, $cb;
739	$self->_drain_rbuf;	880	$self->_drain_rbuf unless $self->{_in_drain};
740	}	881	}
741		882
742	sub unshift_read {	883	sub unshift_read {
743	my $self = shift;	884	my $self = shift;
744	my $cb = pop;	885	my $cb = pop;
…		…
750	->($self, $cb, @_);	891	->($self, $cb, @_);
751	}	892	}
752		893
753		894
754	unshift @{ $self->{_queue} }, $cb;	895	unshift @{ $self->{_queue} }, $cb;
755	$self->_drain_rbuf;	896	$self->_drain_rbuf unless $self->{_in_drain};
756	}	897	}
757		898
758	=item $handle->push_read (type => @args, $cb)	899	=item $handle->push_read (type => @args, $cb)
759		900
760	=item $handle->unshift_read (type => @args, $cb)	901	=item $handle->unshift_read (type => @args, $cb)
…		…
790	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	931	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
791	1	932	1
792	}	933	}
793	};	934	};
794		935
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)	936	=item line => [$eol, ]$cb->($handle, $line, $eol)
805		937
806	The callback will be called only once a full line (including the end of	938	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	939	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	940	marker) will be passed to the callback as second argument (C<$line>), and
…		…
823	=cut	955	=cut
824		956
825	register_read_type line => sub {	957	register_read_type line => sub {
826	my ($self, $cb, $eol) = @_;	958	my ($self, $cb, $eol) = @_;
827		959
828	$eol = qr\|(\015?\012)\| if @_ < 3;	960	if (@_ < 3) {
829	$eol = quotemeta $eol unless ref $eol;	961	# this is more than twice as fast as the generic code below
830	$eol = qr\|^(.*?)($eol)\|s;
831
832	sub {	962	sub {
833	$_[0]{rbuf} =~ s/$eol// or return;	963	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
834		964
835	$cb->($_[0], $1, $2);	965	$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	}	966	1
867	return;
868	}	967	}
		968	} else {
		969	$eol = quotemeta $eol unless ref $eol;
		970	$eol = qr\|^(.*?)($eol)\|s;
869		971
870	my $len = $1;	972	sub {
		973	$_[0]{rbuf} =~ s/$eol// or return;
871		974
872	$self->unshift_read (chunk => $len, sub {	975	$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	});	976	1
881	});	977	}
882
883	1
884	}	978	}
885	};	979	};
886		980
887	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	981	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
888		982
…		…
952		1046
953	()	1047	()
954	}	1048	}
955	};	1049	};
956		1050
		1051	=item netstring => $cb->($handle, $string)
		1052
		1053	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1054
		1055	Throws an error with C<$!> set to EBADMSG on format violations.
		1056
		1057	=cut
		1058
		1059	register_read_type netstring => sub {
		1060	my ($self, $cb) = @_;
		1061
		1062	sub {
		1063	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1064	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1065	$self->_error (&Errno::EBADMSG);
		1066	}
		1067	return;
		1068	}
		1069
		1070	my $len = $1;
		1071
		1072	$self->unshift_read (chunk => $len, sub {
		1073	my $string = $_[1];
		1074	$_[0]->unshift_read (chunk => 1, sub {
		1075	if ($_[1] eq ",") {
		1076	$cb->($_[0], $string);
		1077	} else {
		1078	$self->_error (&Errno::EBADMSG);
		1079	}
		1080	});
		1081	});
		1082
		1083	1
		1084	}
		1085	};
		1086
		1087	=item packstring => $format, $cb->($handle, $string)
		1088
		1089	An octet string prefixed with an encoded length. The encoding C<$format>
		1090	uses the same format as a Perl C<pack> format, but must specify a single
		1091	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1092	optional C<!>, C<< < >> or C<< > >> modifier).
		1093
		1094	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1095
		1096	Example: read a block of data prefixed by its length in BER-encoded
		1097	format (very efficient).
		1098
		1099	$handle->push_read (packstring => "w", sub {
		1100	my ($handle, $data) = @_;
		1101	});
		1102
		1103	=cut
		1104
		1105	register_read_type packstring => sub {
		1106	my ($self, $cb, $format) = @_;
		1107
		1108	sub {
		1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1110	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1111	or return;
		1112
		1113	$format = length pack $format, $len;
		1114
		1115	# bypass unshift if we already have the remaining chunk
		1116	if ($format + $len <= length $_[0]{rbuf}) {
		1117	my $data = substr $_[0]{rbuf}, $format, $len;
		1118	substr $_[0]{rbuf}, 0, $format + $len, "";
		1119	$cb->($_[0], $data);
		1120	} else {
		1121	# remove prefix
		1122	substr $_[0]{rbuf}, 0, $format, "";
		1123
		1124	# read remaining chunk
		1125	$_[0]->unshift_read (chunk => $len, $cb);
		1126	}
		1127
		1128	1
		1129	}
		1130	};
		1131
957	=item json => $cb->($handle, $hash_or_arrayref)	1132	=item json => $cb->($handle, $hash_or_arrayref)
958		1133
959	Reads a JSON object or array, decodes it and passes it to the callback.	1134	Reads a JSON object or array, decodes it and passes it to the callback.
960		1135
961	If a C<json> object was passed to the constructor, then that will be used	1136	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.	1146	the C<json> write type description, above, for an actual example.
972		1147
973	=cut	1148	=cut
974		1149
975	register_read_type json => sub {	1150	register_read_type json => sub {
976	my ($self, $cb, $accept, $reject, $skip) = @_;	1151	my ($self, $cb) = @_;
977		1152
978	require JSON;	1153	require JSON;
979		1154
980	my $data;	1155	my $data;
981	my $rbuf = \$self->{rbuf};	1156	my $rbuf = \$self->{rbuf};
…		…
996	()	1171	()
997	}	1172	}
998	}	1173	}
999	};	1174	};
1000		1175
		1176	=item storable => $cb->($handle, $ref)
		1177
		1178	Deserialises a L<Storable> frozen representation as written by the
		1179	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1180	data).
		1181
		1182	Raises C<EBADMSG> error if the data could not be decoded.
		1183
		1184	=cut
		1185
		1186	register_read_type storable => sub {
		1187	my ($self, $cb) = @_;
		1188
		1189	require Storable;
		1190
		1191	sub {
		1192	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1193	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1194	or return;
		1195
		1196	my $format = length pack "w", $len;
		1197
		1198	# bypass unshift if we already have the remaining chunk
		1199	if ($format + $len <= length $_[0]{rbuf}) {
		1200	my $data = substr $_[0]{rbuf}, $format, $len;
		1201	substr $_[0]{rbuf}, 0, $format + $len, "";
		1202	$cb->($_[0], Storable::thaw ($data));
		1203	} else {
		1204	# remove prefix
		1205	substr $_[0]{rbuf}, 0, $format, "";
		1206
		1207	# read remaining chunk
		1208	$_[0]->unshift_read (chunk => $len, sub {
		1209	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1210	$cb->($_[0], $ref);
		1211	} else {
		1212	$self->_error (&Errno::EBADMSG);
		1213	}
		1214	});
		1215	}
		1216
		1217	1
		1218	}
		1219	};
		1220
1001	=back	1221	=back
1002		1222
1003	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1223	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1004		1224
1005	This function (not method) lets you add your own types to C<push_read>.	1225	This function (not method) lets you add your own types to C<push_read>.
…		…
1023	=item $handle->stop_read	1243	=item $handle->stop_read
1024		1244
1025	=item $handle->start_read	1245	=item $handle->start_read
1026		1246
1027	In rare cases you actually do not want to read anything from the	1247	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	1248	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	1249	any queued callbacks will be executed then. To start reading again, call
1030	C<start_read>.	1250	C<start_read>.
		1251
		1252	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1253	you change the C<on_read> callback or push/unshift a read callback, and it
		1254	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1255	there are any read requests in the queue.
1031		1256
1032	=cut	1257	=cut
1033		1258
1034	sub stop_read {	1259	sub stop_read {
1035	my ($self) = @_;	1260	my ($self) = @_;
…		…
1050	if ($len > 0) {	1275	if ($len > 0) {
1051	$self->{_activity} = AnyEvent->now;	1276	$self->{_activity} = AnyEvent->now;
1052		1277
1053	$self->{filter_r}	1278	$self->{filter_r}
1054	? $self->{filter_r}($self, $rbuf)	1279	? $self->{filter_r}($self, $rbuf)
1055	: $self->_drain_rbuf;	1280	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1056		1281
1057	} elsif (defined $len) {	1282	} elsif (defined $len) {
1058	delete $self->{_rw};	1283	delete $self->{_rw};
1059	$self->{_eof} = 1;	1284	$self->{_eof} = 1;
1060	$self->_drain_rbuf;	1285	$self->_drain_rbuf unless $self->{_in_drain};
1061		1286
1062	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1287	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1063	return $self->_error ($!, 1);	1288	return $self->_error ($!, 1);
1064	}	1289	}
1065	});	1290	});
…		…
1067	}	1292	}
1068		1293
1069	sub _dotls {	1294	sub _dotls {
1070	my ($self) = @_;	1295	my ($self) = @_;
1071		1296
		1297	my $buf;
		1298
1072	if (length $self->{_tls_wbuf}) {	1299	if (length $self->{_tls_wbuf}) {
1073	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1300	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1074	substr $self->{_tls_wbuf}, 0, $len, "";	1301	substr $self->{_tls_wbuf}, 0, $len, "";
1075	}	1302	}
1076	}	1303	}
1077		1304
1078	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1305	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1079	$self->{wbuf} .= $buf;	1306	$self->{wbuf} .= $buf;
1080	$self->_drain_wbuf;	1307	$self->_drain_wbuf;
1081	}	1308	}
1082		1309
1083	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1310	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1311	if (length $buf) {
1084	$self->{rbuf} .= $buf;	1312	$self->{rbuf} .= $buf;
1085	$self->_drain_rbuf;	1313	$self->_drain_rbuf unless $self->{_in_drain};
		1314	} else {
		1315	# let's treat SSL-eof as we treat normal EOF
		1316	$self->{_eof} = 1;
		1317	$self->_shutdown;
		1318	return;
		1319	}
1086	}	1320	}
1087		1321
1088	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1322	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1089		1323
1090	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1324	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
…		…
1134	# basically, this is deep magic (because SSL_read should have the same issues)	1368	# basically, this is deep magic (because SSL_read should have the same issues)
1135	# but the openssl maintainers basically said: "trust us, it just works".	1369	# but the openssl maintainers basically said: "trust us, it just works".
1136	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1370	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1137	# and mismaintained ssleay-module doesn't even offer them).	1371	# and mismaintained ssleay-module doesn't even offer them).
1138	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1372	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1373	#
		1374	# in short: this is a mess.
		1375	#
		1376	# note that we do not try to kepe the length constant between writes as we are required to do.
		1377	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1378	# and we drive openssl fully in blocking mode here.
1139	Net::SSLeay::CTX_set_mode ($self->{tls},	1379	Net::SSLeay::CTX_set_mode ($self->{tls},
1140	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1380	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1141	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1381	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1142		1382
1143	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1383	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
…		…
1176		1416
1177	sub DESTROY {	1417	sub DESTROY {
1178	my $self = shift;	1418	my $self = shift;
1179		1419
1180	$self->stoptls;	1420	$self->stoptls;
		1421
		1422	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1423
		1424	if ($linger && length $self->{wbuf}) {
		1425	my $fh = delete $self->{fh};
		1426	my $wbuf = delete $self->{wbuf};
		1427
		1428	my @linger;
		1429
		1430	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1431	my $len = syswrite $fh, $wbuf, length $wbuf;
		1432
		1433	if ($len > 0) {
		1434	substr $wbuf, 0, $len, "";
		1435	} else {
		1436	@linger = (); # end
		1437	}
		1438	});
		1439	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1440	@linger = ();
		1441	});
		1442	}
1181	}	1443	}
1182		1444
1183	=item AnyEvent::Handle::TLS_CTX	1445	=item AnyEvent::Handle::TLS_CTX
1184		1446
1185	This function creates and returns the Net::SSLeay::CTX object used by	1447	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1227	=over 4	1489	=over 4
1228		1490
1229	=item * all constructor arguments become object members.	1491	=item * all constructor arguments become object members.
1230		1492
1231	At least initially, when you pass a C<tls>-argument to the constructor it	1493	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	1494	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).	1495	mutated later on (for example C<tls> will hold the TLS connection object).
1234		1496
1235	=item * other object member names are prefixed with an C<_>.	1497	=item * other object member names are prefixed with an C<_>.
1236		1498
1237	All object members not explicitly documented (internal use) are prefixed	1499	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.54 by root, Tue Jun 3 09:02:46 2008 UTC vs. Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.54 by root, Tue Jun 3 09:02:46 2008 UTC vs.
Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC