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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.45 by root, Thu May 29 00:20:39 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 = '0.04';	19	our $VERSION = 4.232;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
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	on each [loop iteration). Default: C<4096>.	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 {
241	my ($self) = @_;	302	my ($self) = @_;
242		303
		304	delete $self->{_tw};
243	delete $self->{_rw};	305	delete $self->{_rw};
244	delete $self->{_ww};	306	delete $self->{_ww};
245	delete $self->{fh};	307	delete $self->{fh};
246	}
247		308
		309	$self->stoptls;
		310
		311	delete $self->{on_read};
		312	delete $self->{_queue};
		313	}
		314
248	sub error {	315	sub _error {
249	my ($self) = @_;	316	my ($self, $errno, $fatal) = @_;
250		317
251	{
252	local $!;
253	$self->_shutdown;	318	$self->_shutdown
254	}	319	if $fatal;
255		320
256	$self->{on_error}($self)	321	$! = $errno;
		322
257	if $self->{on_error};	323	if ($self->{on_error}) {
258		324	$self->{on_error}($self, $fatal);
		325	} else {
259	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	326	Carp::croak "AnyEvent::Handle uncaught error: $!";
		327	}
260	}	328	}
261		329
262	=item $fh = $handle->fh	330	=item $fh = $handle->fh
263		331
264	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.
…		…
295		363
296	=cut	364	=cut
297		365
298	sub on_timeout {	366	sub on_timeout {
299	$_[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	};
300	}	391	}
301		392
302	#############################################################################	393	#############################################################################
303		394
304	=item $handle->timeout ($seconds)	395	=item $handle->timeout ($seconds)
…		…
328	# now or in the past already?	419	# now or in the past already?
329	if ($after <= 0) {	420	if ($after <= 0) {
330	$self->{_activity} = $NOW;	421	$self->{_activity} = $NOW;
331		422
332	if ($self->{on_timeout}) {	423	if ($self->{on_timeout}) {
333	$self->{on_timeout}->($self);	424	$self->{on_timeout}($self);
334	} else {	425	} else {
335	$! = Errno::ETIMEDOUT;	426	$self->_error (&Errno::ETIMEDOUT);
336	$self->error;
337	}	427	}
338		428
339	# callbakx could have changed timeout value, optimise	429	# callback could have changed timeout value, optimise
340	return unless $self->{timeout};	430	return unless $self->{timeout};
341		431
342	# calculate new after	432	# calculate new after
343	$after = $self->{timeout};	433	$after = $self->{timeout};
344	}	434	}
345		435
346	Scalar::Util::weaken $self;	436	Scalar::Util::weaken $self;
		437	return unless $self; # ->error could have destroyed $self
347		438
348	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	439	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
349	delete $self->{_tw};	440	delete $self->{_tw};
350	$self->_timeout;	441	$self->_timeout;
351	});	442	});
…		…
414	if $self->{low_water_mark} >= length $self->{wbuf}	505	if $self->{low_water_mark} >= length $self->{wbuf}
415	&& $self->{on_drain};	506	&& $self->{on_drain};
416		507
417	delete $self->{_ww} unless length $self->{wbuf};	508	delete $self->{_ww} unless length $self->{wbuf};
418	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	509	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
419	$self->error;	510	$self->_error ($!, 1);
420	}	511	}
421	};	512	};
422		513
423	# try to write data immediately	514	# try to write data immediately
424	$cb->();	515	$cb->() unless $self->{autocork};
425		516
426	# if still data left in wbuf, we need to poll	517	# if still data left in wbuf, we need to poll
427	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	518	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
428	if length $self->{wbuf};	519	if length $self->{wbuf};
429	};	520	};
…		…
444	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	535	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
445	->($self, @_);	536	->($self, @_);
446	}	537	}
447		538
448	if ($self->{filter_w}) {	539	if ($self->{filter_w}) {
449	$self->{filter_w}->($self, \$_[0]);	540	$self->{filter_w}($self, \$_[0]);
450	} else {	541	} else {
451	$self->{wbuf} .= $_[0];	542	$self->{wbuf} .= $_[0];
452	$self->_drain_wbuf;	543	$self->_drain_wbuf;
453	}	544	}
454	}	545	}
455		546
456	=item $handle->push_write (type => @args)	547	=item $handle->push_write (type => @args)
457		548
458	=item $handle->unshift_write (type => @args)
459
460	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
461	the job by specifying a type and type-specific arguments.	550	the job by specifying a type and type-specific arguments.
462		551
463	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
464	drop by and tell us):	553	drop by and tell us):
…		…
468	=item netstring => $string	557	=item netstring => $string
469		558
470	Formats the given value as netstring	559	Formats the given value as netstring
471	(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).
472		561
473	=back
474
475	=cut	562	=cut
476		563
477	register_write_type netstring => sub {	564	register_write_type netstring => sub {
478	my ($self, $string) = @_;	565	my ($self, $string) = @_;
479		566
480	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
481	};	583	};
482		584
483	=item json => $array_or_hashref	585	=item json => $array_or_hashref
484		586
485	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
…		…
519		621
520	$self->{json} ? $self->{json}->encode ($ref)	622	$self->{json} ? $self->{json}->encode ($ref)
521	: JSON::encode_json ($ref)	623	: JSON::encode_json ($ref)
522	};	624	};
523		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
524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	643	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525		644
526	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>.
527	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
528	reference with the handle object and the remaining arguments.	647	reference with the handle object and the remaining arguments.
…		…
548	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
549	a queue.	668	a queue.
550		669
551	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
552	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
553	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
554	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).
555		675
556	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
557	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
558	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
559	below).	679	done its job (see C<push_read>, below).
560		680
561	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
562	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.
563		683
564	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
565	the specified number of bytes which give an XML datagram.	685	the specified number of bytes which give an XML datagram.
566		686
567	# in the default state, expect some header bytes	687	# in the default state, expect some header bytes
568	$handle->on_read (sub {	688	$handle->on_read (sub {
569	# 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)
570	shift->unshift_read_chunk (4, sub {	690	shift->unshift_read (chunk => 4, sub {
571	# header arrived, decode	691	# header arrived, decode
572	my $len = unpack "N", $_[1];	692	my $len = unpack "N", $_[1];
573		693
574	# now read the payload	694	# now read the payload
575	shift->unshift_read_chunk ($len, sub {	695	shift->unshift_read (chunk => $len, sub {
576	my $xml = $_[1];	696	my $xml = $_[1];
577	# handle xml	697	# handle xml
578	});	698	});
579	});	699	});
580	});	700	});
581		701
582	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"
583	"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
584	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
585	pipeline sending both requests and manipulate the queue as necessary in	705	just pipeline sending both requests and manipulate the queue as necessary
586	the callbacks:	706	in the callbacks.
587		707
588	# 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"
589	$handle->push_write ("request 1\015\012");	713	$handle->push_write ("request 1\015\012");
590		714
591	# 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
592	$handle->push_read_line (sub {	716	$handle->push_read (line => sub {
593	# if we got an "OK", we have to _prepend_ another line,	717	# if we got an "OK", we have to _prepend_ another line,
594	# so it will be read before the second request reads its 64 bytes	718	# so it will be read before the second request reads its 64 bytes
595	# which are already in the queue when this callback is called	719	# which are already in the queue when this callback is called
596	# we don't do this in case we got an error	720	# we don't do this in case we got an error
597	if ($_[1] eq "OK") {	721	if ($_[1] eq "OK") {
598	$_[0]->unshift_read_line (sub {	722	$_[0]->unshift_read (line => sub {
599	my $response = $_[1];	723	my $response = $_[1];
600	...	724	...
601	});	725	});
602	}	726	}
603	});	727	});
604		728
605	# request two	729	# request two, simply returns 64 octets
606	$handle->push_write ("request 2\015\012");	730	$handle->push_write ("request 2\015\012");
607		731
608	# simply read 64 bytes, always	732	# simply read 64 bytes, always
609	$handle->push_read_chunk (64, sub {	733	$handle->push_read (chunk => 64, sub {
610	my $response = $_[1];	734	my $response = $_[1];
611	...	735	...
612	});	736	});
613		737
614	=over 4	738	=over 4
615		739
616	=cut	740	=cut
617		741
618	sub _drain_rbuf {	742	sub _drain_rbuf {
619	my ($self) = @_;	743	my ($self) = @_;
		744
		745	local $self->{_in_drain} = 1;
620		746
621	if (	747	if (
622	defined $self->{rbuf_max}	748	defined $self->{rbuf_max}
623	&& $self->{rbuf_max} < length $self->{rbuf}	749	&& $self->{rbuf_max} < length $self->{rbuf}
624	) {	750	) {
625	$! = &Errno::ENOSPC;	751	$self->_error (&Errno::ENOSPC, 1), return;
626	$self->error;
627	}	752	}
628		753
629	return if $self->{in_drain};	754	while () {
630	local $self->{in_drain} = 1;
631
632	while (my $len = length $self->{rbuf}) {	755	my $len = length $self->{rbuf};
633	no strict 'refs';	756
634	if (my $cb = shift @{ $self->{_queue} }) {	757	if (my $cb = shift @{ $self->{_queue} }) {
635	unless ($cb->($self)) {	758	unless ($cb->($self)) {
636	if ($self->{_eof}) {	759	if ($self->{_eof}) {
637	# 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)
638	$! = &Errno::EPIPE;	761	$self->_error (&Errno::EPIPE, 1), return;
639	$self->error;
640	}	762	}
641		763
642	unshift @{ $self->{_queue} }, $cb;	764	unshift @{ $self->{_queue} }, $cb;
643	return;	765	last;
644	}	766	}
645	} elsif ($self->{on_read}) {	767	} elsif ($self->{on_read}) {
		768	last unless $len;
		769
646	$self->{on_read}($self);	770	$self->{on_read}($self);
647		771
648	if (	772	if (
649	$self->{_eof} # if no further data will arrive
650	&& $len == length $self->{rbuf} # and no data has been consumed	773	$len == length $self->{rbuf} # if no data has been consumed
651	&& !@{ $self->{_queue} } # and the queue is still empty	774	&& !@{ $self->{_queue} } # and the queue is still empty
652	&& $self->{on_read} # and we still want to read data	775	&& $self->{on_read} # but we still have on_read
653	) {	776	) {
		777	# no further data will arrive
654	# then no progress can be made	778	# so no progress can be made
655	$! = &Errno::EPIPE;	779	$self->_error (&Errno::EPIPE, 1), return
656	$self->error;	780	if $self->{_eof};
		781
		782	last; # more data might arrive
657	}	783	}
658	} else {	784	} else {
659	# read side becomes idle	785	# read side becomes idle
660	delete $self->{_rw};	786	delete $self->{_rw};
661	return;	787	last;
662	}	788	}
663	}	789	}
664		790
665	if ($self->{_eof}) {	791	if ($self->{_eof}) {
666	$self->_shutdown;	792	if ($self->{on_eof}) {
667	$self->{on_eof}($self)	793	$self->{on_eof}($self)
668	if $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} };
669	}	803	}
670	}	804	}
671		805
672	=item $handle->on_read ($cb)	806	=item $handle->on_read ($cb)
673		807
…		…
679		813
680	sub on_read {	814	sub on_read {
681	my ($self, $cb) = @_;	815	my ($self, $cb) = @_;
682		816
683	$self->{on_read} = $cb;	817	$self->{on_read} = $cb;
		818	$self->_drain_rbuf if $cb && !$self->{_in_drain};
684	}	819	}
685		820
686	=item $handle->rbuf	821	=item $handle->rbuf
687		822
688	Returns the read buffer (as a modifiable lvalue).	823	Returns the read buffer (as a modifiable lvalue).
…		…
737	$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")
738	->($self, $cb, @_);	873	->($self, $cb, @_);
739	}	874	}
740		875
741	push @{ $self->{_queue} }, $cb;	876	push @{ $self->{_queue} }, $cb;
742	$self->_drain_rbuf;	877	$self->_drain_rbuf unless $self->{_in_drain};
743	}	878	}
744		879
745	sub unshift_read {	880	sub unshift_read {
746	my $self = shift;	881	my $self = shift;
747	my $cb = pop;	882	my $cb = pop;
…		…
753	->($self, $cb, @_);	888	->($self, $cb, @_);
754	}	889	}
755		890
756		891
757	unshift @{ $self->{_queue} }, $cb;	892	unshift @{ $self->{_queue} }, $cb;
758	$self->_drain_rbuf;	893	$self->_drain_rbuf unless $self->{_in_drain};
759	}	894	}
760		895
761	=item $handle->push_read (type => @args, $cb)	896	=item $handle->push_read (type => @args, $cb)
762		897
763	=item $handle->unshift_read (type => @args, $cb)	898	=item $handle->unshift_read (type => @args, $cb)
…		…
793	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	928	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
794	1	929	1
795	}	930	}
796	};	931	};
797		932
798	# compatibility with older API
799	sub push_read_chunk {
800	$_[0]->push_read (chunk => $_[1], $_[2]);
801	}
802
803	sub unshift_read_chunk {
804	$_[0]->unshift_read (chunk => $_[1], $_[2]);
805	}
806
807	=item line => [$eol, ]$cb->($handle, $line, $eol)	933	=item line => [$eol, ]$cb->($handle, $line, $eol)
808		934
809	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
810	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
811	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
…		…
826	=cut	952	=cut
827		953
828	register_read_type line => sub {	954	register_read_type line => sub {
829	my ($self, $cb, $eol) = @_;	955	my ($self, $cb, $eol) = @_;
830		956
831	$eol = qr\|(\015?\012)\| if @_ < 3;	957	if (@_ < 3) {
832	$eol = quotemeta $eol unless ref $eol;	958	# this is more than twice as fast as the generic code below
833	$eol = qr\|^(.*?)($eol)\|s;
834
835	sub {	959	sub {
836	$_[0]{rbuf} =~ s/$eol// or return;	960	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
837		961
838	$cb->($_[0], $1, $2);	962	$cb->($_[0], $1, $2);
839	1
840	}
841	};
842
843	# compatibility with older API
844	sub push_read_line {
845	my $self = shift;
846	$self->push_read (line => @_);
847	}
848
849	sub unshift_read_line {
850	my $self = shift;
851	$self->unshift_read (line => @_);
852	}
853
854	=item netstring => $cb->($handle, $string)
855
856	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
857
858	Throws an error with C<$!> set to EBADMSG on format violations.
859
860	=cut
861
862	register_read_type netstring => sub {
863	my ($self, $cb) = @_;
864
865	sub {
866	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
867	if ($_[0]{rbuf} =~ /[^0-9]/) {
868	$! = &Errno::EBADMSG;
869	$self->error;
870	}	963	1
871	return;
872	}	964	}
		965	} else {
		966	$eol = quotemeta $eol unless ref $eol;
		967	$eol = qr\|^(.*?)($eol)\|s;
873		968
874	my $len = $1;	969	sub {
		970	$_[0]{rbuf} =~ s/$eol// or return;
875		971
876	$self->unshift_read (chunk => $len, sub {	972	$cb->($_[0], $1, $2);
877	my $string = $_[1];
878	$_[0]->unshift_read (chunk => 1, sub {
879	if ($_[1] eq ",") {
880	$cb->($_[0], $string);
881	} else {
882	$! = &Errno::EBADMSG;
883	$self->error;
884	}
885	});	973	1
886	});	974	}
887
888	1
889	}	975	}
890	};	976	};
891		977
892	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	978	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
893		979
…		…
945	return 1;	1031	return 1;
946	}	1032	}
947		1033
948	# reject	1034	# reject
949	if ($reject && $$rbuf =~ $reject) {	1035	if ($reject && $$rbuf =~ $reject) {
950	$! = &Errno::EBADMSG;	1036	$self->_error (&Errno::EBADMSG);
951	$self->error;
952	}	1037	}
953		1038
954	# skip	1039	# skip
955	if ($skip && $$rbuf =~ $skip) {	1040	if ($skip && $$rbuf =~ $skip) {
956	$data .= substr $$rbuf, 0, $+[0], "";	1041	$data .= substr $$rbuf, 0, $+[0], "";
…		…
958		1043
959	()	1044	()
960	}	1045	}
961	};	1046	};
962		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
963	=item json => $cb->($handle, $hash_or_arrayref)	1129	=item json => $cb->($handle, $hash_or_arrayref)
964		1130
965	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.
966		1132
967	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
…		…
977	the C<json> write type description, above, for an actual example.	1143	the C<json> write type description, above, for an actual example.
978		1144
979	=cut	1145	=cut
980		1146
981	register_read_type json => sub {	1147	register_read_type json => sub {
982	my ($self, $cb, $accept, $reject, $skip) = @_;	1148	my ($self, $cb) = @_;
983		1149
984	require JSON;	1150	require JSON;
985		1151
986	my $data;	1152	my $data;
987	my $rbuf = \$self->{rbuf};	1153	my $rbuf = \$self->{rbuf};
…		…
1002	()	1168	()
1003	}	1169	}
1004	}	1170	}
1005	};	1171	};
1006		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
1007	=back	1218	=back
1008		1219
1009	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1220	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1010		1221
1011	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>.
…		…
1029	=item $handle->stop_read	1240	=item $handle->stop_read
1030		1241
1031	=item $handle->start_read	1242	=item $handle->start_read
1032		1243
1033	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
1034	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
1035	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
1036	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.
1037		1253
1038	=cut	1254	=cut
1039		1255
1040	sub stop_read {	1256	sub stop_read {
1041	my ($self) = @_;	1257	my ($self) = @_;
…		…
1055		1271
1056	if ($len > 0) {	1272	if ($len > 0) {
1057	$self->{_activity} = AnyEvent->now;	1273	$self->{_activity} = AnyEvent->now;
1058		1274
1059	$self->{filter_r}	1275	$self->{filter_r}
1060	? $self->{filter_r}->($self, $rbuf)	1276	? $self->{filter_r}($self, $rbuf)
1061	: $self->_drain_rbuf;	1277	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1062		1278
1063	} elsif (defined $len) {	1279	} elsif (defined $len) {
1064	delete $self->{_rw};	1280	delete $self->{_rw};
1065	delete $self->{_ww};
1066	delete $self->{_tw};
1067	$self->{_eof} = 1;	1281	$self->{_eof} = 1;
1068	$self->_drain_rbuf;	1282	$self->_drain_rbuf unless $self->{_in_drain};
1069		1283
1070	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1284	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1071	return $self->error;	1285	return $self->_error ($!, 1);
1072	}	1286	}
1073	});	1287	});
1074	}	1288	}
1075	}	1289	}
1076		1290
1077	sub _dotls {	1291	sub _dotls {
1078	my ($self) = @_;	1292	my ($self) = @_;
		1293
		1294	my $buf;
1079		1295
1080	if (length $self->{_tls_wbuf}) {	1296	if (length $self->{_tls_wbuf}) {
1081	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) {
1082	substr $self->{_tls_wbuf}, 0, $len, "";	1298	substr $self->{_tls_wbuf}, 0, $len, "";
1083	}	1299	}
1084	}	1300	}
1085		1301
1086	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1302	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1087	$self->{wbuf} .= $buf;	1303	$self->{wbuf} .= $buf;
1088	$self->_drain_wbuf;	1304	$self->_drain_wbuf;
1089	}	1305	}
1090		1306
1091	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1307	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1308	if (length $buf) {
1092	$self->{rbuf} .= $buf;	1309	$self->{rbuf} .= $buf;
1093	$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	}
1094	}	1317	}
1095		1318
1096	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1319	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1097		1320
1098	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1321	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1099	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1322	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1100	$self->error;	1323	return $self->_error ($!, 1);
1101	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1324	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1102	$! = &Errno::EIO;	1325	return $self->_error (&Errno::EIO, 1);
1103	$self->error;
1104	}	1326	}
1105		1327
1106	# all others are fine for our purposes	1328	# all others are fine for our purposes
1107	}	1329	}
1108	}	1330	}
…		…
1123	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
1124	might have already started when this function returns.	1346	might have already started when this function returns.
1125		1347
1126	=cut	1348	=cut
1127		1349
1128	# TODO: maybe document...
1129	sub starttls {	1350	sub starttls {
1130	my ($self, $ssl, $ctx) = @_;	1351	my ($self, $ssl, $ctx) = @_;
1131		1352
1132	$self->stoptls;	1353	$self->stoptls;
1133		1354
…		…
1186		1407
1187	sub DESTROY {	1408	sub DESTROY {
1188	my $self = shift;	1409	my $self = shift;
1189		1410
1190	$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	}
1191	}	1434	}
1192		1435
1193	=item AnyEvent::Handle::TLS_CTX	1436	=item AnyEvent::Handle::TLS_CTX
1194		1437
1195	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
…		…
1237	=over 4	1480	=over 4
1238		1481
1239	=item * all constructor arguments become object members.	1482	=item * all constructor arguments become object members.
1240		1483
1241	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
1242	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
1243	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).
1244		1487
1245	=item * other object member names are prefixed with an C<_>.	1488	=item * other object member names are prefixed with an C<_>.
1246		1489
1247	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.45 by root, Thu May 29 00:20:39 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.45 by root, Thu May 29 00:20:39 2008 UTC vs.
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC