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

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

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.49 by root, Thu May 29 03:45:37 2008 UTC vs.
Revision 1.85 by root, Thu Aug 21 19:53:19 2008 UTC