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

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

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.50 by root, Fri May 30 21:38:46 2008 UTC vs.
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC