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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC

…		…
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 ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	11	use Errno qw(EAGAIN EINTR);
12	use Time::HiRes qw(time);
13		12
14	=head1 NAME	13	=head1 NAME
15		14
16	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
17		16
18	=cut	17	=cut
19		18
20	our $VERSION = '0.04';	19	our $VERSION = 4.22;
21		20
22	=head1 SYNOPSIS	21	=head1 SYNOPSIS
23		22
24	use AnyEvent;	23	use AnyEvent;
25	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
76	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
77	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
78		77
79	=item on_eof => $cb->($handle)	78	=item on_eof => $cb->($handle)
80		79
81	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detected,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
82		83
83	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
84	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
85	waiting for data.	86	waiting for data.
86		87
87	=item on_error => $cb->($handle)	88	=item on_error => $cb->($handle, $fatal)
88		89
89	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
90	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
91	or a read error.	92	connect or a read error.
92		93
93	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
94	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
95		99
96	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
97	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
98		102
99	The callback should throw an exception. If it returns, then
100	AnyEvent::Handle will C<croak> for you.
101
102	While not mandatory, it is I<highly> recommended to set this callback, as	103	While not mandatory, it is I<highly> recommended to set this callback, as
103	you will not be notified of errors otherwise. The default simply calls	104	you will not be notified of errors otherwise. The default simply calls
104	die.	105	C<croak>.
105		106
106	=item on_read => $cb->($handle)	107	=item on_read => $cb->($handle)
107		108
108	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
109	and no read request is in the queue.	110	and no read request is in the queue (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
110		113
111	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
112	method or access the C<$handle->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
113		116
114	When an EOF condition is detected then AnyEvent::Handle will first try to	117	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
121	This sets the callback that is called when the write buffer becomes empty	124	This sets the callback that is called when the write buffer becomes empty
122	(or when the callback is set and the buffer is empty already).	125	(or when the callback is set and the buffer is empty already).
123		126
124	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
125		128
		129	This callback is useful when you don't want to put all of your write data
		130	into the queue at once, for example, when you want to write the contents
		131	of some file to the socket you might not want to read the whole file into
		132	memory and push it into the queue, but instead only read more data from
		133	the file when the write queue becomes empty.
		134
126	=item timeout => $fractional_seconds	135	=item timeout => $fractional_seconds
127		136
128	If non-zero, then this enables an "inactivity" timeout: whenever this many	137	If non-zero, then this enables an "inactivity" timeout: whenever this many
129	seconds pass without a successful read or write on the underlying file	138	seconds pass without a successful read or write on the underlying file
130	handle, the C<on_timeout> callback will be invoked (and if that one is	139	handle, the C<on_timeout> callback will be invoked (and if that one is
131	missing, an C<ETIMEDOUT> errror will be raised).	140	missing, an C<ETIMEDOUT> error will be raised).
132		141
133	Note that timeout processing is also active when you currently do not have	142	Note that timeout processing is also active when you currently do not have
134	any outstanding read or write requests: If you plan to keep the connection	143	any outstanding read or write requests: If you plan to keep the connection
135	idle then you should disable the timout temporarily or ignore the timeout	144	idle then you should disable the timout temporarily or ignore the timeout
136	in the C<on_timeout> callback.	145	in the C<on_timeout> callback.
…		…
153	be configured to accept only so-and-so much data that it cannot act on	162	be configured to accept only so-and-so much data that it cannot act on
154	(for example, when expecting a line, an attacker could send an unlimited	163	(for example, when expecting a line, an attacker could send an unlimited
155	amount of data without a callback ever being called as long as the line	164	amount of data without a callback ever being called as long as the line
156	isn't finished).	165	isn't finished).
157		166
		167	=item autocork => <boolean>
		168
		169	When disabled (the default), then C<push_write> will try to immediately
		170	write the data to the handle if possible. This avoids having to register
		171	a write watcher and wait for the next event loop iteration, but can be
		172	inefficient if you write multiple small chunks (this disadvantage is
		173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		174
		175	When enabled, then writes will always be queued till the next event loop
		176	iteration. This is efficient when you do many small writes per iteration,
		177	but less efficient when you do a single write only.
		178
		179	=item no_delay => <boolean>
		180
		181	When doing small writes on sockets, your operating system kernel might
		182	wait a bit for more data before actually sending it out. This is called
		183	the Nagle algorithm, and usually it is beneficial.
		184
		185	In some situations you want as low a delay as possible, which cna be
		186	accomplishd by setting this option to true.
		187
		188	The default is your opertaing system's default behaviour, this option
		189	explicitly enables or disables it, if possible.
		190
158	=item read_size => <bytes>	191	=item read_size => <bytes>
159		192
160	The default read block size (the amount of bytes this module will try to read	193	The default read block size (the amount of bytes this module will try to read
161	on each [loop iteration). Default: C<4096>.	194	during each (loop iteration). Default: C<8192>.
162		195
163	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
164		197
165	Sets the amount of bytes (default: C<0>) that make up an "empty" write	198	Sets the amount of bytes (default: C<0>) that make up an "empty" write
166	buffer: If the write reaches this size or gets even samller it is	199	buffer: If the write reaches this size or gets even samller it is
167	considered empty.	200	considered empty.
		201
		202	=item linger => <seconds>
		203
		204	If non-zero (default: C<3600>), then the destructor of the
		205	AnyEvent::Handle object will check wether there is still outstanding write
		206	data and will install a watcher that will write out this data. No errors
		207	will be reported (this mostly matches how the operating system treats
		208	outstanding data at socket close time).
		209
		210	This will not work for partial TLS data that could not yet been
		211	encoded. This data will be lost.
168		212
169	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
170		214
171	When this parameter is given, it enables TLS (SSL) mode, that means it	215	When this parameter is given, it enables TLS (SSL) mode, that means it
172	will start making tls handshake and will transparently encrypt/decrypt	216	will start making tls handshake and will transparently encrypt/decrypt
…		…
181	You can also provide your own TLS connection object, but you have	225	You can also provide your own TLS connection object, but you have
182	to make sure that you call either C<Net::SSLeay::set_connect_state>	226	to make sure that you call either C<Net::SSLeay::set_connect_state>
183	or C<Net::SSLeay::set_accept_state> on it before you pass it to	227	or C<Net::SSLeay::set_accept_state> on it before you pass it to
184	AnyEvent::Handle.	228	AnyEvent::Handle.
185		229
186	See the C<starttls> method if you need to start TLs negotiation later.	230	See the C<starttls> method if you need to start TLS negotiation later.
187		231
188	=item tls_ctx => $ssl_ctx	232	=item tls_ctx => $ssl_ctx
189		233
190	Use the given Net::SSLeay::CTX object to create the new TLS connection	234	Use the given Net::SSLeay::CTX object to create the new TLS connection
191	(unless a connection object was specified directly). If this parameter is	235	(unless a connection object was specified directly). If this parameter is
…		…
223	if ($self->{tls}) {	267	if ($self->{tls}) {
224	require Net::SSLeay;	268	require Net::SSLeay;
225	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
226	}	270	}
227		271
228	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
229	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
230	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
231	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
232
233	$self->{_activity} = time;	272	$self->{_activity} = AnyEvent->now;
234	$self->_timeout;	273	$self->_timeout;
235		274
		275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		277
236	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
237		280
238	$self	281	$self
239	}	282	}
240		283
241	sub _shutdown {	284	sub _shutdown {
242	my ($self) = @_;	285	my ($self) = @_;
243		286
		287	delete $self->{_tw};
244	delete $self->{_rw};	288	delete $self->{_rw};
245	delete $self->{_ww};	289	delete $self->{_ww};
246	delete $self->{fh};	290	delete $self->{fh};
247	}
248		291
		292	$self->stoptls;
		293	}
		294
249	sub error {	295	sub _error {
250	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
251		297
252	{
253	local $!;
254	$self->_shutdown;	298	$self->_shutdown
255	}	299	if $fatal;
256		300
257	$self->{on_error}($self)	301	$! = $errno;
		302
258	if $self->{on_error};	303	if ($self->{on_error}) {
259		304	$self->{on_error}($self, $fatal);
		305	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
		307	}
261	}	308	}
262		309
263	=item $fh = $handle->fh	310	=item $fh = $handle->fh
264		311
265	This method returns the file handle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
296		343
297	=cut	344	=cut
298		345
299	sub on_timeout {	346	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	347	$_[0]{on_timeout} = $_[1];
		348	}
		349
		350	=item $handle->autocork ($boolean)
		351
		352	Enables or disables the current autocork behaviour (see C<autocork>
		353	constructor argument).
		354
		355	=cut
		356
		357	=item $handle->no_delay ($boolean)
		358
		359	Enables or disables the C<no_delay> setting (see constructor argument of
		360	the same name for details).
		361
		362	=cut
		363
		364	sub no_delay {
		365	$_[0]{no_delay} = $_[1];
		366
		367	eval {
		368	local $SIG{__DIE__};
		369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		370	};
301	}	371	}
302		372
303	#############################################################################	373	#############################################################################
304		374
305	=item $handle->timeout ($seconds)	375	=item $handle->timeout ($seconds)
…		…
319	# also check for time-outs	389	# also check for time-outs
320	sub _timeout {	390	sub _timeout {
321	my ($self) = @_;	391	my ($self) = @_;
322		392
323	if ($self->{timeout}) {	393	if ($self->{timeout}) {
324	my $NOW = time;	394	my $NOW = AnyEvent->now;
325		395
326	# when would the timeout trigger?	396	# when would the timeout trigger?
327	my $after = $self->{_activity} + $self->{timeout} - $NOW;	397	my $after = $self->{_activity} + $self->{timeout} - $NOW;
328
329	warn "next to in $after\n";#d#
330		398
331	# now or in the past already?	399	# now or in the past already?
332	if ($after <= 0) {	400	if ($after <= 0) {
333	$self->{_activity} = $NOW;	401	$self->{_activity} = $NOW;
334		402
335	if ($self->{on_timeout}) {	403	if ($self->{on_timeout}) {
336	$self->{on_timeout}->($self);	404	$self->{on_timeout}($self);
337	} else {	405	} else {
338	$! = Errno::ETIMEDOUT;	406	$self->_error (&Errno::ETIMEDOUT);
339	$self->error;
340	}	407	}
341		408
342	# callbakx could have changed timeout value, optimise	409	# callback could have changed timeout value, optimise
343	return unless $self->{timeout};	410	return unless $self->{timeout};
344		411
345	# calculate new after	412	# calculate new after
346	$after = $self->{timeout};	413	$after = $self->{timeout};
347	}	414	}
348		415
349	Scalar::Util::weaken $self;	416	Scalar::Util::weaken $self;
		417	return unless $self; # ->error could have destroyed $self
350		418
351	warn "after $after\n";#d#
352	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	419	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
353	delete $self->{_tw};	420	delete $self->{_tw};
354	$self->_timeout;	421	$self->_timeout;
355	});	422	});
356	} else {	423	} else {
…		…
410	my $len = syswrite $self->{fh}, $self->{wbuf};	477	my $len = syswrite $self->{fh}, $self->{wbuf};
411		478
412	if ($len >= 0) {	479	if ($len >= 0) {
413	substr $self->{wbuf}, 0, $len, "";	480	substr $self->{wbuf}, 0, $len, "";
414		481
415	$self->{_activity} = time;	482	$self->{_activity} = AnyEvent->now;
416		483
417	$self->{on_drain}($self)	484	$self->{on_drain}($self)
418	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
419	&& $self->{on_drain};	486	&& $self->{on_drain};
420		487
421	delete $self->{_ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
422	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
423	$self->error;	490	$self->_error ($!, 1);
424	}	491	}
425	};	492	};
426		493
427	# try to write data immediately	494	# try to write data immediately
428	$cb->();	495	$cb->() unless $self->{autocork};
429		496
430	# if still data left in wbuf, we need to poll	497	# if still data left in wbuf, we need to poll
431	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
432	if length $self->{wbuf};	499	if length $self->{wbuf};
433	};	500	};
…		…
448	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
449	->($self, @_);	516	->($self, @_);
450	}	517	}
451		518
452	if ($self->{filter_w}) {	519	if ($self->{filter_w}) {
453	$self->{filter_w}->($self, \$_[0]);	520	$self->{filter_w}($self, \$_[0]);
454	} else {	521	} else {
455	$self->{wbuf} .= $_[0];	522	$self->{wbuf} .= $_[0];
456	$self->_drain_wbuf;	523	$self->_drain_wbuf;
457	}	524	}
458	}	525	}
459		526
460	=item $handle->push_write (type => @args)	527	=item $handle->push_write (type => @args)
461		528
462	=item $handle->unshift_write (type => @args)
463
464	Instead of formatting your data yourself, you can also let this module do	529	Instead of formatting your data yourself, you can also let this module do
465	the job by specifying a type and type-specific arguments.	530	the job by specifying a type and type-specific arguments.
466		531
467	Predefined types are (if you have ideas for additional types, feel free to	532	Predefined types are (if you have ideas for additional types, feel free to
468	drop by and tell us):	533	drop by and tell us):
…		…
472	=item netstring => $string	537	=item netstring => $string
473		538
474	Formats the given value as netstring	539	Formats the given value as netstring
475	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
476		541
477	=back
478
479	=cut	542	=cut
480		543
481	register_write_type netstring => sub {	544	register_write_type netstring => sub {
482	my ($self, $string) = @_;	545	my ($self, $string) = @_;
483		546
484	sprintf "%d:%s,", (length $string), $string	547	sprintf "%d:%s,", (length $string), $string
		548	};
		549
		550	=item packstring => $format, $data
		551
		552	An octet string prefixed with an encoded length. The encoding C<$format>
		553	uses the same format as a Perl C<pack> format, but must specify a single
		554	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		555	optional C<!>, C<< < >> or C<< > >> modifier).
		556
		557	=cut
		558
		559	register_write_type packstring => sub {
		560	my ($self, $format, $string) = @_;
		561
		562	pack "$format/a*", $string
485	};	563	};
486		564
487	=item json => $array_or_hashref	565	=item json => $array_or_hashref
488		566
489	Encodes the given hash or array reference into a JSON object. Unless you	567	Encodes the given hash or array reference into a JSON object. Unless you
…		…
523		601
524	$self->{json} ? $self->{json}->encode ($ref)	602	$self->{json} ? $self->{json}->encode ($ref)
525	: JSON::encode_json ($ref)	603	: JSON::encode_json ($ref)
526	};	604	};
527		605
		606	=item storable => $reference
		607
		608	Freezes the given reference using L<Storable> and writes it to the
		609	handle. Uses the C<nfreeze> format.
		610
		611	=cut
		612
		613	register_write_type storable => sub {
		614	my ($self, $ref) = @_;
		615
		616	require Storable;
		617
		618	pack "w/a*", Storable::nfreeze ($ref)
		619	};
		620
		621	=back
		622
528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
529		624
530	This function (not method) lets you add your own types to C<push_write>.	625	This function (not method) lets you add your own types to C<push_write>.
531	Whenever the given C<type> is used, C<push_write> will invoke the code	626	Whenever the given C<type> is used, C<push_write> will invoke the code
532	reference with the handle object and the remaining arguments.	627	reference with the handle object and the remaining arguments.
…		…
552	ways, the "simple" way, using only C<on_read> and the "complex" way, using	647	ways, the "simple" way, using only C<on_read> and the "complex" way, using
553	a queue.	648	a queue.
554		649
555	In the simple case, you just install an C<on_read> callback and whenever	650	In the simple case, you just install an C<on_read> callback and whenever
556	new data arrives, it will be called. You can then remove some data (if	651	new data arrives, it will be called. You can then remove some data (if
557	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	652	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
558	or not.	653	leave the data there if you want to accumulate more (e.g. when only a
		654	partial message has been received so far).
559		655
560	In the more complex case, you want to queue multiple callbacks. In this	656	In the more complex case, you want to queue multiple callbacks. In this
561	case, AnyEvent::Handle will call the first queued callback each time new	657	case, AnyEvent::Handle will call the first queued callback each time new
562	data arrives and removes it when it has done its job (see C<push_read>,	658	data arrives (also the first time it is queued) and removes it when it has
563	below).	659	done its job (see C<push_read>, below).
564		660
565	This way you can, for example, push three line-reads, followed by reading	661	This way you can, for example, push three line-reads, followed by reading
566	a chunk of data, and AnyEvent::Handle will execute them in order.	662	a chunk of data, and AnyEvent::Handle will execute them in order.
567		663
568	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	664	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
569	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
570		666
571	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
572	$handle->on_read (sub {	668	$handle->on_read (sub {
573	# some data is here, now queue the length-header-read (4 octets)	669	# some data is here, now queue the length-header-read (4 octets)
574	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
575	# header arrived, decode	671	# header arrived, decode
576	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
577		673
578	# now read the payload	674	# now read the payload
579	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
580	my $xml = $_[1];	676	my $xml = $_[1];
581	# handle xml	677	# handle xml
582	});	678	});
583	});	679	});
584	});	680	});
585		681
586	Example 2: Implement a client for a protocol that replies either with	682	Example 2: Implement a client for a protocol that replies either with "OK"
587	"OK" and another line or "ERROR" for one request, and 64 bytes for the	683	and another line or "ERROR" for the first request that is sent, and 64
588	second request. Due tot he availability of a full queue, we can just	684	bytes for the second request. Due to the availability of a queue, we can
589	pipeline sending both requests and manipulate the queue as necessary in	685	just pipeline sending both requests and manipulate the queue as necessary
590	the callbacks:	686	in the callbacks.
591		687
592	# request one	688	When the first callback is called and sees an "OK" response, it will
		689	C<unshift> another line-read. This line-read will be queued I<before> the
		690	64-byte chunk callback.
		691
		692	# request one, returns either "OK + extra line" or "ERROR"
593	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
594		694
595	# we expect "ERROR" or "OK" as response, so push a line read	695	# we expect "ERROR" or "OK" as response, so push a line read
596	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
597	# if we got an "OK", we have to _prepend_ another line,	697	# if we got an "OK", we have to _prepend_ another line,
598	# so it will be read before the second request reads its 64 bytes	698	# so it will be read before the second request reads its 64 bytes
599	# which are already in the queue when this callback is called	699	# which are already in the queue when this callback is called
600	# we don't do this in case we got an error	700	# we don't do this in case we got an error
601	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
602	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
603	my $response = $_[1];	703	my $response = $_[1];
604	...	704	...
605	});	705	});
606	}	706	}
607	});	707	});
608		708
609	# request two	709	# request two, simply returns 64 octets
610	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
611		711
612	# simply read 64 bytes, always	712	# simply read 64 bytes, always
613	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
614	my $response = $_[1];	714	my $response = $_[1];
615	...	715	...
616	});	716	});
617		717
618	=over 4	718	=over 4
619		719
620	=cut	720	=cut
621		721
622	sub _drain_rbuf {	722	sub _drain_rbuf {
623	my ($self) = @_;	723	my ($self) = @_;
		724
		725	local $self->{_in_drain} = 1;
624		726
625	if (	727	if (
626	defined $self->{rbuf_max}	728	defined $self->{rbuf_max}
627	&& $self->{rbuf_max} < length $self->{rbuf}	729	&& $self->{rbuf_max} < length $self->{rbuf}
628	) {	730	) {
629	$! = &Errno::ENOSPC;	731	return $self->_error (&Errno::ENOSPC, 1);
630	$self->error;
631	}	732	}
632		733
633	return if $self->{in_drain};	734	while () {
634	local $self->{in_drain} = 1;
635
636	while (my $len = length $self->{rbuf}) {
637	no strict 'refs';	735	no strict 'refs';
		736
		737	my $len = length $self->{rbuf};
		738
638	if (my $cb = shift @{ $self->{_queue} }) {	739	if (my $cb = shift @{ $self->{_queue} }) {
639	unless ($cb->($self)) {	740	unless ($cb->($self)) {
640	if ($self->{_eof}) {	741	if ($self->{_eof}) {
641	# no progress can be made (not enough data and no data forthcoming)	742	# no progress can be made (not enough data and no data forthcoming)
642	$! = &Errno::EPIPE;	743	$self->_error (&Errno::EPIPE, 1), last;
643	$self->error;
644	}	744	}
645		745
646	unshift @{ $self->{_queue} }, $cb;	746	unshift @{ $self->{_queue} }, $cb;
647	return;	747	last;
648	}	748	}
649	} elsif ($self->{on_read}) {	749	} elsif ($self->{on_read}) {
		750	last unless $len;
		751
650	$self->{on_read}($self);	752	$self->{on_read}($self);
651		753
652	if (	754	if (
653	$self->{_eof} # if no further data will arrive
654	&& $len == length $self->{rbuf} # and no data has been consumed	755	$len == length $self->{rbuf} # if no data has been consumed
655	&& !@{ $self->{_queue} } # and the queue is still empty	756	&& !@{ $self->{_queue} } # and the queue is still empty
656	&& $self->{on_read} # and we still want to read data	757	&& $self->{on_read} # but we still have on_read
657	) {	758	) {
		759	# no further data will arrive
658	# then no progress can be made	760	# so no progress can be made
659	$! = &Errno::EPIPE;	761	$self->_error (&Errno::EPIPE, 1), last
660	$self->error;	762	if $self->{_eof};
		763
		764	last; # more data might arrive
661	}	765	}
662	} else {	766	} else {
663	# read side becomes idle	767	# read side becomes idle
664	delete $self->{_rw};	768	delete $self->{_rw};
665	return;	769	last;
666	}	770	}
667	}	771	}
668		772
669	if ($self->{_eof}) {
670	$self->_shutdown;
671	$self->{on_eof}($self)	773	$self->{on_eof}($self)
672	if $self->{on_eof};	774	if $self->{_eof} && $self->{on_eof};
		775
		776	# may need to restart read watcher
		777	unless ($self->{_rw}) {
		778	$self->start_read
		779	if $self->{on_read} \|\| @{ $self->{_queue} };
673	}	780	}
674	}	781	}
675		782
676	=item $handle->on_read ($cb)	783	=item $handle->on_read ($cb)
677		784
…		…
683		790
684	sub on_read {	791	sub on_read {
685	my ($self, $cb) = @_;	792	my ($self, $cb) = @_;
686		793
687	$self->{on_read} = $cb;	794	$self->{on_read} = $cb;
		795	$self->_drain_rbuf if $cb && !$self->{_in_drain};
688	}	796	}
689		797
690	=item $handle->rbuf	798	=item $handle->rbuf
691		799
692	Returns the read buffer (as a modifiable lvalue).	800	Returns the read buffer (as a modifiable lvalue).
…		…
741	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	849	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
742	->($self, $cb, @_);	850	->($self, $cb, @_);
743	}	851	}
744		852
745	push @{ $self->{_queue} }, $cb;	853	push @{ $self->{_queue} }, $cb;
746	$self->_drain_rbuf;	854	$self->_drain_rbuf unless $self->{_in_drain};
747	}	855	}
748		856
749	sub unshift_read {	857	sub unshift_read {
750	my $self = shift;	858	my $self = shift;
751	my $cb = pop;	859	my $cb = pop;
…		…
757	->($self, $cb, @_);	865	->($self, $cb, @_);
758	}	866	}
759		867
760		868
761	unshift @{ $self->{_queue} }, $cb;	869	unshift @{ $self->{_queue} }, $cb;
762	$self->_drain_rbuf;	870	$self->_drain_rbuf unless $self->{_in_drain};
763	}	871	}
764		872
765	=item $handle->push_read (type => @args, $cb)	873	=item $handle->push_read (type => @args, $cb)
766		874
767	=item $handle->unshift_read (type => @args, $cb)	875	=item $handle->unshift_read (type => @args, $cb)
…		…
830	=cut	938	=cut
831		939
832	register_read_type line => sub {	940	register_read_type line => sub {
833	my ($self, $cb, $eol) = @_;	941	my ($self, $cb, $eol) = @_;
834		942
835	$eol = qr\|(\015?\012)\| if @_ < 3;	943	if (@_ < 3) {
		944	# this is more than twice as fast as the generic code below
		945	sub {
		946	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		947
		948	$cb->($_[0], $1, $2);
		949	1
		950	}
		951	} else {
836	$eol = quotemeta $eol unless ref $eol;	952	$eol = quotemeta $eol unless ref $eol;
837	$eol = qr\|^(.*?)($eol)\|s;	953	$eol = qr\|^(.*?)($eol)\|s;
838		954
839	sub {	955	sub {
840	$_[0]{rbuf} =~ s/$eol// or return;	956	$_[0]{rbuf} =~ s/$eol// or return;
841		957
842	$cb->($_[0], $1, $2);	958	$cb->($_[0], $1, $2);
		959	1
843	1	960	}
844	}	961	}
845	};	962	};
846		963
847	# compatibility with older API	964	# compatibility with older API
848	sub push_read_line {	965	sub push_read_line {
…		…
852		969
853	sub unshift_read_line {	970	sub unshift_read_line {
854	my $self = shift;	971	my $self = shift;
855	$self->unshift_read (line => @_);	972	$self->unshift_read (line => @_);
856	}	973	}
857
858	=item netstring => $cb->($handle, $string)
859
860	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
861
862	Throws an error with C<$!> set to EBADMSG on format violations.
863
864	=cut
865
866	register_read_type netstring => sub {
867	my ($self, $cb) = @_;
868
869	sub {
870	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
871	if ($_[0]{rbuf} =~ /[^0-9]/) {
872	$! = &Errno::EBADMSG;
873	$self->error;
874	}
875	return;
876	}
877
878	my $len = $1;
879
880	$self->unshift_read (chunk => $len, sub {
881	my $string = $_[1];
882	$_[0]->unshift_read (chunk => 1, sub {
883	if ($_[1] eq ",") {
884	$cb->($_[0], $string);
885	} else {
886	$! = &Errno::EBADMSG;
887	$self->error;
888	}
889	});
890	});
891
892	1
893	}
894	};
895		974
896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	975	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
897		976
898	Makes a regex match against the regex object C<$accept> and returns	977	Makes a regex match against the regex object C<$accept> and returns
899	everything up to and including the match.	978	everything up to and including the match.
…		…
949	return 1;	1028	return 1;
950	}	1029	}
951		1030
952	# reject	1031	# reject
953	if ($reject && $$rbuf =~ $reject) {	1032	if ($reject && $$rbuf =~ $reject) {
954	$! = &Errno::EBADMSG;	1033	$self->_error (&Errno::EBADMSG);
955	$self->error;
956	}	1034	}
957		1035
958	# skip	1036	# skip
959	if ($skip && $$rbuf =~ $skip) {	1037	if ($skip && $$rbuf =~ $skip) {
960	$data .= substr $$rbuf, 0, $+[0], "";	1038	$data .= substr $$rbuf, 0, $+[0], "";
…		…
962		1040
963	()	1041	()
964	}	1042	}
965	};	1043	};
966		1044
		1045	=item netstring => $cb->($handle, $string)
		1046
		1047	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1048
		1049	Throws an error with C<$!> set to EBADMSG on format violations.
		1050
		1051	=cut
		1052
		1053	register_read_type netstring => sub {
		1054	my ($self, $cb) = @_;
		1055
		1056	sub {
		1057	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1058	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1059	$self->_error (&Errno::EBADMSG);
		1060	}
		1061	return;
		1062	}
		1063
		1064	my $len = $1;
		1065
		1066	$self->unshift_read (chunk => $len, sub {
		1067	my $string = $_[1];
		1068	$_[0]->unshift_read (chunk => 1, sub {
		1069	if ($_[1] eq ",") {
		1070	$cb->($_[0], $string);
		1071	} else {
		1072	$self->_error (&Errno::EBADMSG);
		1073	}
		1074	});
		1075	});
		1076
		1077	1
		1078	}
		1079	};
		1080
		1081	=item packstring => $format, $cb->($handle, $string)
		1082
		1083	An octet string prefixed with an encoded length. The encoding C<$format>
		1084	uses the same format as a Perl C<pack> format, but must specify a single
		1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1086	optional C<!>, C<< < >> or C<< > >> modifier).
		1087
		1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1089
		1090	Example: read a block of data prefixed by its length in BER-encoded
		1091	format (very efficient).
		1092
		1093	$handle->push_read (packstring => "w", sub {
		1094	my ($handle, $data) = @_;
		1095	});
		1096
		1097	=cut
		1098
		1099	register_read_type packstring => sub {
		1100	my ($self, $cb, $format) = @_;
		1101
		1102	sub {
		1103	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1104	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1105	or return;
		1106
		1107	# remove prefix
		1108	substr $_[0]{rbuf}, 0, (length pack $format, $len), "";
		1109
		1110	# read rest
		1111	$_[0]->unshift_read (chunk => $len, $cb);
		1112
		1113	1
		1114	}
		1115	};
		1116
967	=item json => $cb->($handle, $hash_or_arrayref)	1117	=item json => $cb->($handle, $hash_or_arrayref)
968		1118
969	Reads a JSON object or array, decodes it and passes it to the callback.	1119	Reads a JSON object or array, decodes it and passes it to the callback.
970		1120
971	If a C<json> object was passed to the constructor, then that will be used	1121	If a C<json> object was passed to the constructor, then that will be used
…		…
981	the C<json> write type description, above, for an actual example.	1131	the C<json> write type description, above, for an actual example.
982		1132
983	=cut	1133	=cut
984		1134
985	register_read_type json => sub {	1135	register_read_type json => sub {
986	my ($self, $cb, $accept, $reject, $skip) = @_;	1136	my ($self, $cb) = @_;
987		1137
988	require JSON;	1138	require JSON;
989		1139
990	my $data;	1140	my $data;
991	my $rbuf = \$self->{rbuf};	1141	my $rbuf = \$self->{rbuf};
…		…
1006	()	1156	()
1007	}	1157	}
1008	}	1158	}
1009	};	1159	};
1010		1160
		1161	=item storable => $cb->($handle, $ref)
		1162
		1163	Deserialises a L<Storable> frozen representation as written by the
		1164	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1165	data).
		1166
		1167	Raises C<EBADMSG> error if the data could not be decoded.
		1168
		1169	=cut
		1170
		1171	register_read_type storable => sub {
		1172	my ($self, $cb) = @_;
		1173
		1174	require Storable;
		1175
		1176	sub {
		1177	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1178	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1179	or return;
		1180
		1181	# remove prefix
		1182	substr $_[0]{rbuf}, 0, (length pack "w", $len), "";
		1183
		1184	# read rest
		1185	$_[0]->unshift_read (chunk => $len, sub {
		1186	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1187	$cb->($_[0], $ref);
		1188	} else {
		1189	$self->_error (&Errno::EBADMSG);
		1190	}
		1191	});
		1192	}
		1193	};
		1194
1011	=back	1195	=back
1012		1196
1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1197	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1014		1198
1015	This function (not method) lets you add your own types to C<push_read>.	1199	This function (not method) lets you add your own types to C<push_read>.
…		…
1033	=item $handle->stop_read	1217	=item $handle->stop_read
1034		1218
1035	=item $handle->start_read	1219	=item $handle->start_read
1036		1220
1037	In rare cases you actually do not want to read anything from the	1221	In rare cases you actually do not want to read anything from the
1038	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1222	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1039	any queued callbacks will be executed then. To start reading again, call	1223	any queued callbacks will be executed then. To start reading again, call
1040	C<start_read>.	1224	C<start_read>.
		1225
		1226	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1227	you change the C<on_read> callback or push/unshift a read callback, and it
		1228	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1229	there are any read requests in the queue.
1041		1230
1042	=cut	1231	=cut
1043		1232
1044	sub stop_read {	1233	sub stop_read {
1045	my ($self) = @_;	1234	my ($self) = @_;
…		…
1056	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1245	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1057	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1246	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
1058	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1247	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1059		1248
1060	if ($len > 0) {	1249	if ($len > 0) {
1061	$self->{_activity} = time;	1250	$self->{_activity} = AnyEvent->now;
1062		1251
1063	$self->{filter_r}	1252	$self->{filter_r}
1064	? $self->{filter_r}->($self, $rbuf)	1253	? $self->{filter_r}($self, $rbuf)
1065	: $self->_drain_rbuf;	1254	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1066		1255
1067	} elsif (defined $len) {	1256	} elsif (defined $len) {
1068	delete $self->{_rw};	1257	delete $self->{_rw};
1069	delete $self->{_ww};
1070	delete $self->{_tw};
1071	$self->{_eof} = 1;	1258	$self->{_eof} = 1;
1072	$self->_drain_rbuf;	1259	$self->_drain_rbuf unless $self->{_in_drain};
1073		1260
1074	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1261	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1075	return $self->error;	1262	return $self->_error ($!, 1);
1076	}	1263	}
1077	});	1264	});
1078	}	1265	}
1079	}	1266	}
1080		1267
1081	sub _dotls {	1268	sub _dotls {
1082	my ($self) = @_;	1269	my ($self) = @_;
		1270
		1271	my $buf;
1083		1272
1084	if (length $self->{_tls_wbuf}) {	1273	if (length $self->{_tls_wbuf}) {
1085	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1274	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1086	substr $self->{_tls_wbuf}, 0, $len, "";	1275	substr $self->{_tls_wbuf}, 0, $len, "";
1087	}	1276	}
1088	}	1277	}
1089		1278
1090	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1279	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1091	$self->{wbuf} .= $buf;	1280	$self->{wbuf} .= $buf;
1092	$self->_drain_wbuf;	1281	$self->_drain_wbuf;
1093	}	1282	}
1094		1283
1095	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1284	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1285	if (length $buf) {
1096	$self->{rbuf} .= $buf;	1286	$self->{rbuf} .= $buf;
1097	$self->_drain_rbuf;	1287	$self->_drain_rbuf unless $self->{_in_drain};
		1288	} else {
		1289	# let's treat SSL-eof as we treat normal EOF
		1290	$self->{_eof} = 1;
		1291	$self->_shutdown;
		1292	return;
		1293	}
1098	}	1294	}
1099		1295
1100	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1296	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1101		1297
1102	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1298	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1103	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1299	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1104	$self->error;	1300	return $self->_error ($!, 1);
1105	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1301	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1106	$! = &Errno::EIO;	1302	return $self->_error (&Errno::EIO, 1);
1107	$self->error;
1108	}	1303	}
1109		1304
1110	# all others are fine for our purposes	1305	# all others are fine for our purposes
1111	}	1306	}
1112	}	1307	}
…		…
1127	call and can be used or changed to your liking. Note that the handshake	1322	call and can be used or changed to your liking. Note that the handshake
1128	might have already started when this function returns.	1323	might have already started when this function returns.
1129		1324
1130	=cut	1325	=cut
1131		1326
1132	# TODO: maybe document...
1133	sub starttls {	1327	sub starttls {
1134	my ($self, $ssl, $ctx) = @_;	1328	my ($self, $ssl, $ctx) = @_;
1135		1329
1136	$self->stoptls;	1330	$self->stoptls;
1137		1331
…		…
1190		1384
1191	sub DESTROY {	1385	sub DESTROY {
1192	my $self = shift;	1386	my $self = shift;
1193		1387
1194	$self->stoptls;	1388	$self->stoptls;
		1389
		1390	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1391
		1392	if ($linger && length $self->{wbuf}) {
		1393	my $fh = delete $self->{fh};
		1394	my $wbuf = delete $self->{wbuf};
		1395
		1396	my @linger;
		1397
		1398	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1399	my $len = syswrite $fh, $wbuf, length $wbuf;
		1400
		1401	if ($len > 0) {
		1402	substr $wbuf, 0, $len, "";
		1403	} else {
		1404	@linger = (); # end
		1405	}
		1406	});
		1407	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1408	@linger = ();
		1409	});
		1410	}
1195	}	1411	}
1196		1412
1197	=item AnyEvent::Handle::TLS_CTX	1413	=item AnyEvent::Handle::TLS_CTX
1198		1414
1199	This function creates and returns the Net::SSLeay::CTX object used by	1415	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1241	=over 4	1457	=over 4
1242		1458
1243	=item * all constructor arguments become object members.	1459	=item * all constructor arguments become object members.
1244		1460
1245	At least initially, when you pass a C<tls>-argument to the constructor it	1461	At least initially, when you pass a C<tls>-argument to the constructor it
1246	will end up in C<< $handle->{tls} >>. Those members might be changes or	1462	will end up in C<< $handle->{tls} >>. Those members might be changed or
1247	mutated later on (for example C<tls> will hold the TLS connection object).	1463	mutated later on (for example C<tls> will hold the TLS connection object).
1248		1464
1249	=item * other object member names are prefixed with an C<_>.	1465	=item * other object member names are prefixed with an C<_>.
1250		1466
1251	All object members not explicitly documented (internal use) are prefixed	1467	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.43 by root, Wed May 28 23:57:38 2008 UTC vs. Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.76 by root, Sun Jul 27 03:28:36 2008 UTC