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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 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(WSAWOULDBLOCK);	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		12
13	=head1 NAME	13	=head1 NAME
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->($self)	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->($self)	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> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		119
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->($self)	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<$self->{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
114	feed all the remaining data to the queued callbacks and C<on_read> before	135	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	136	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	137	error will be raised (with C<$!> set to C<EPIPE>).
117		138
118	=item on_drain => $cb->()	139	=item on_drain => $cb->($handle)
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.
		151
		152	=item timeout => $fractional_seconds
		153
		154	If non-zero, then this enables an "inactivity" timeout: whenever this many
		155	seconds pass without a successful read or write on the underlying file
		156	handle, the C<on_timeout> callback will be invoked (and if that one is
		157	missing, an C<ETIMEDOUT> error will be raised).
		158
		159	Note that timeout processing is also active when you currently do not have
		160	any outstanding read or write requests: If you plan to keep the connection
		161	idle then you should disable the timout temporarily or ignore the timeout
		162	in the C<on_timeout> callback.
		163
		164	Zero (the default) disables this timeout.
		165
		166	=item on_timeout => $cb->($handle)
		167
		168	Called whenever the inactivity timeout passes. If you return from this
		169	callback, then the timeout will be reset as if some activity had happened,
		170	so this condition is not fatal in any way.
124		171
125	=item rbuf_max => <bytes>	172	=item rbuf_max => <bytes>
126		173
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	174	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
128	when the read buffer ever (strictly) exceeds this size. This is useful to	175	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
132	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
133	(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
134	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
135	isn't finished).	182	isn't finished).
136		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
137	=item read_size => <bytes>	208	=item read_size => <bytes>
138		209
139	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
140	on each [loop iteration). Default: C<4096>.	211	during each (loop iteration). Default: C<8192>.
141		212
142	=item low_water_mark => <bytes>	213	=item low_water_mark => <bytes>
143		214
144	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
145	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
146	considered empty.	217	considered empty.
147		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
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		231
150	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
151	will start making tls handshake and will transparently encrypt/decrypt	233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt
152	data.	234	data.
153		235
154	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
155	automatically when you try to create a TLS handle).	237	automatically when you try to create a TLS handle).
156		238
157	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
158	connection, use C<connect> mode.	240	C<accept>, and for the TLS client side of a connection, use C<connect>
		241	mode.
159		242
160	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
161	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>
162	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
163	AnyEvent::Handle.	246	AnyEvent::Handle.
164		247
165	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.
166		249
167	=item tls_ctx => $ssl_ctx	250	=item tls_ctx => $ssl_ctx
168		251
169	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
170	(unless a connection object was specified directly). If this parameter is	253	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	254	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		255
		256	=item json => JSON or JSON::XS object
		257
		258	This is the json coder object used by the C<json> read and write types.
		259
		260	If you don't supply it, then AnyEvent::Handle will create and use a
		261	suitable one, which will write and expect UTF-8 encoded JSON texts.
		262
		263	Note that you are responsible to depend on the JSON module if you want to
		264	use this functionality, as AnyEvent does not have a dependency itself.
		265
173	=item filter_r => $cb	266	=item filter_r => $cb
174		267
175	=item filter_w => $cb	268	=item filter_w => $cb
176		269
177	These exist, but are undocumented at this time.	270	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	285	if ($self->{tls}) {
193	require Net::SSLeay;	286	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	287	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	288	}
196		289
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	290	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	291	$self->_timeout;
		292
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	293	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	294	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
201		295
202	$self->start_read;	296	$self->start_read
		297	if $self->{on_read};
203		298
204	$self	299	$self
205	}	300	}
206		301
207	sub _shutdown {	302	sub _shutdown {
208	my ($self) = @_;	303	my ($self) = @_;
209		304
		305	delete $self->{_tw};
210	delete $self->{_rw};	306	delete $self->{_rw};
211	delete $self->{_ww};	307	delete $self->{_ww};
212	delete $self->{fh};	308	delete $self->{fh};
213	}
214		309
		310	$self->stoptls;
		311
		312	delete $self->{on_read};
		313	delete $self->{_queue};
		314	}
		315
215	sub error {	316	sub _error {
216	my ($self) = @_;	317	my ($self, $errno, $fatal) = @_;
217		318
218	{
219	local $!;
220	$self->_shutdown;	319	$self->_shutdown
221	}	320	if $fatal;
222		321
223	$self->{on_error}($self)	322	$! = $errno;
		323
224	if $self->{on_error};	324	if ($self->{on_error}) {
225		325	$self->{on_error}($self, $fatal);
		326	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	327	Carp::croak "AnyEvent::Handle uncaught error: $!";
		328	}
227	}	329	}
228		330
229	=item $fh = $handle->fh	331	=item $fh = $handle->fh
230		332
231	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.
…		…
250		352
251	=cut	353	=cut
252		354
253	sub on_eof {	355	sub on_eof {
254	$_[0]{on_eof} = $_[1];	356	$_[0]{on_eof} = $_[1];
		357	}
		358
		359	=item $handle->on_timeout ($cb)
		360
		361	Replace the current C<on_timeout> callback, or disables the callback
		362	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		363	argument.
		364
		365	=cut
		366
		367	sub on_timeout {
		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	};
		392	}
		393
		394	#############################################################################
		395
		396	=item $handle->timeout ($seconds)
		397
		398	Configures (or disables) the inactivity timeout.
		399
		400	=cut
		401
		402	sub timeout {
		403	my ($self, $timeout) = @_;
		404
		405	$self->{timeout} = $timeout;
		406	$self->_timeout;
		407	}
		408
		409	# reset the timeout watcher, as neccessary
		410	# also check for time-outs
		411	sub _timeout {
		412	my ($self) = @_;
		413
		414	if ($self->{timeout}) {
		415	my $NOW = AnyEvent->now;
		416
		417	# when would the timeout trigger?
		418	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		419
		420	# now or in the past already?
		421	if ($after <= 0) {
		422	$self->{_activity} = $NOW;
		423
		424	if ($self->{on_timeout}) {
		425	$self->{on_timeout}($self);
		426	} else {
		427	$self->_error (&Errno::ETIMEDOUT);
		428	}
		429
		430	# callback could have changed timeout value, optimise
		431	return unless $self->{timeout};
		432
		433	# calculate new after
		434	$after = $self->{timeout};
		435	}
		436
		437	Scalar::Util::weaken $self;
		438	return unless $self; # ->error could have destroyed $self
		439
		440	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		441	delete $self->{_tw};
		442	$self->_timeout;
		443	});
		444	} else {
		445	delete $self->{_tw};
		446	}
255	}	447	}
256		448
257	#############################################################################	449	#############################################################################
258		450
259	=back	451	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	498	my $len = syswrite $self->{fh}, $self->{wbuf};
307		499
308	if ($len >= 0) {	500	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	501	substr $self->{wbuf}, 0, $len, "";
310		502
		503	$self->{_activity} = AnyEvent->now;
		504
311	$self->{on_drain}($self)	505	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	506	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	507	&& $self->{on_drain};
314		508
315	delete $self->{_ww} unless length $self->{wbuf};	509	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	510	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	511	$self->_error ($!, 1);
318	}	512	}
319	};	513	};
320		514
321	# try to write data immediately	515	# try to write data immediately
322	$cb->();	516	$cb->() unless $self->{autocork};
323		517
324	# if still data left in wbuf, we need to poll	518	# if still data left in wbuf, we need to poll
325	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	519	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
326	if length $self->{wbuf};	520	if length $self->{wbuf};
327	};	521	};
…		…
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	536	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	537	->($self, @_);
344	}	538	}
345		539
346	if ($self->{filter_w}) {	540	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	541	$self->{filter_w}($self, \$_[0]);
348	} else {	542	} else {
349	$self->{wbuf} .= $_[0];	543	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	544	$self->_drain_wbuf;
351	}	545	}
352	}	546	}
353		547
354	=item $handle->push_write (type => @args)	548	=item $handle->push_write (type => @args)
355		549
356	=item $handle->unshift_write (type => @args)
357
358	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
359	the job by specifying a type and type-specific arguments.	551	the job by specifying a type and type-specific arguments.
360		552
361	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
362	drop by and tell us):	554	drop by and tell us):
…		…
366	=item netstring => $string	558	=item netstring => $string
367		559
368	Formats the given value as netstring	560	Formats the given value as netstring
369	(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).
370		562
371	=back
372
373	=cut	563	=cut
374		564
375	register_write_type netstring => sub {	565	register_write_type netstring => sub {
376	my ($self, $string) = @_;	566	my ($self, $string) = @_;
377		567
378	sprintf "%d:%s,", (length $string), $string	568	sprintf "%d:%s,", (length $string), $string
379	};	569	};
380		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
		584	};
		585
		586	=item json => $array_or_hashref
		587
		588	Encodes the given hash or array reference into a JSON object. Unless you
		589	provide your own JSON object, this means it will be encoded to JSON text
		590	in UTF-8.
		591
		592	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		593	one end of a handle and read them at the other end without using any
		594	additional framing.
		595
		596	The generated JSON text is guaranteed not to contain any newlines: While
		597	this module doesn't need delimiters after or between JSON texts to be
		598	able to read them, many other languages depend on that.
		599
		600	A simple RPC protocol that interoperates easily with others is to send
		601	JSON arrays (or objects, although arrays are usually the better choice as
		602	they mimic how function argument passing works) and a newline after each
		603	JSON text:
		604
		605	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		606	$handle->push_write ("\012");
		607
		608	An AnyEvent::Handle receiver would simply use the C<json> read type and
		609	rely on the fact that the newline will be skipped as leading whitespace:
		610
		611	$handle->push_read (json => sub { my $array = $_[1]; ... });
		612
		613	Other languages could read single lines terminated by a newline and pass
		614	this line into their JSON decoder of choice.
		615
		616	=cut
		617
		618	register_write_type json => sub {
		619	my ($self, $ref) = @_;
		620
		621	require JSON;
		622
		623	$self->{json} ? $self->{json}->encode ($ref)
		624	: JSON::encode_json ($ref)
		625	};
		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
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	644	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		645
383	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>.
384	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
385	reference with the handle object and the remaining arguments.	648	reference with the handle object and the remaining arguments.
386		649
…		…
405	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
406	a queue.	669	a queue.
407		670
408	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
409	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
410	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
411	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).
412		676
413	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
414	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
415	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
416	below).	680	done its job (see C<push_read>, below).
417		681
418	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
419	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.
420		684
421	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
422	the specified number of bytes which give an XML datagram.	686	the specified number of bytes which give an XML datagram.
423		687
424	# in the default state, expect some header bytes	688	# in the default state, expect some header bytes
425	$handle->on_read (sub {	689	$handle->on_read (sub {
426	# 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)
427	shift->unshift_read_chunk (4, sub {	691	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	692	# header arrived, decode
429	my $len = unpack "N", $_[1];	693	my $len = unpack "N", $_[1];
430		694
431	# now read the payload	695	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	696	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	697	my $xml = $_[1];
434	# handle xml	698	# handle xml
435	});	699	});
436	});	700	});
437	});	701	});
438		702
439	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"
440	"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
441	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
442	pipeline sending both requests and manipulate the queue as necessary in	706	just pipeline sending both requests and manipulate the queue as necessary
443	the callbacks:	707	in the callbacks.
444		708
445	# 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"
446	$handle->push_write ("request 1\015\012");	714	$handle->push_write ("request 1\015\012");
447		715
448	# 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
449	$handle->push_read_line (sub {	717	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	718	# if we got an "OK", we have to _prepend_ another line,
451	# 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
452	# which are already in the queue when this callback is called	720	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	721	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	722	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	723	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	724	my $response = $_[1];
457	...	725	...
458	});	726	});
459	}	727	}
460	});	728	});
461		729
462	# request two	730	# request two, simply returns 64 octets
463	$handle->push_write ("request 2\015\012");	731	$handle->push_write ("request 2\015\012");
464		732
465	# simply read 64 bytes, always	733	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	734	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	735	my $response = $_[1];
468	...	736	...
469	});	737	});
470		738
471	=over 4	739	=over 4
472		740
473	=cut	741	=cut
474		742
475	sub _drain_rbuf {	743	sub _drain_rbuf {
476	my ($self) = @_;	744	my ($self) = @_;
		745
		746	local $self->{_in_drain} = 1;
477		747
478	if (	748	if (
479	defined $self->{rbuf_max}	749	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	750	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	751	) {
482	$! = &Errno::ENOSPC;	752	$self->_error (&Errno::ENOSPC, 1), return;
483	$self->error;
484	}	753	}
485		754
486	return if $self->{in_drain};	755	while () {
487	local $self->{in_drain} = 1;
488
489	while (my $len = length $self->{rbuf}) {	756	my $len = length $self->{rbuf};
490	no strict 'refs';	757
491	if (my $cb = shift @{ $self->{_queue} }) {	758	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	759	unless ($cb->($self)) {
493	if ($self->{_eof}) {	760	if ($self->{_eof}) {
494	# 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)
495	$! = &Errno::EPIPE;	762	$self->_error (&Errno::EPIPE, 1), return;
496	$self->error;
497	}	763	}
498		764
499	unshift @{ $self->{_queue} }, $cb;	765	unshift @{ $self->{_queue} }, $cb;
500	return;	766	last;
501	}	767	}
502	} elsif ($self->{on_read}) {	768	} elsif ($self->{on_read}) {
		769	last unless $len;
		770
503	$self->{on_read}($self);	771	$self->{on_read}($self);
504		772
505	if (	773	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	774	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	775	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	776	&& $self->{on_read} # but we still have on_read
510	) {	777	) {
		778	# no further data will arrive
511	# then no progress can be made	779	# so no progress can be made
512	$! = &Errno::EPIPE;	780	$self->_error (&Errno::EPIPE, 1), return
513	$self->error;	781	if $self->{_eof};
		782
		783	last; # more data might arrive
514	}	784	}
515	} else {	785	} else {
516	# read side becomes idle	786	# read side becomes idle
517	delete $self->{_rw};	787	delete $self->{_rw};
518	return;	788	last;
519	}	789	}
520	}	790	}
521		791
522	if ($self->{_eof}) {	792	if ($self->{_eof}) {
523	$self->_shutdown;	793	if ($self->{on_eof}) {
524	$self->{on_eof}($self)	794	$self->{on_eof}($self)
525	if $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} };
526	}	804	}
527	}	805	}
528		806
529	=item $handle->on_read ($cb)	807	=item $handle->on_read ($cb)
530		808
…		…
536		814
537	sub on_read {	815	sub on_read {
538	my ($self, $cb) = @_;	816	my ($self, $cb) = @_;
539		817
540	$self->{on_read} = $cb;	818	$self->{on_read} = $cb;
		819	$self->_drain_rbuf if $cb && !$self->{_in_drain};
541	}	820	}
542		821
543	=item $handle->rbuf	822	=item $handle->rbuf
544		823
545	Returns the read buffer (as a modifiable lvalue).	824	Returns the read buffer (as a modifiable lvalue).
…		…
594	$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")
595	->($self, $cb, @_);	874	->($self, $cb, @_);
596	}	875	}
597		876
598	push @{ $self->{_queue} }, $cb;	877	push @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	878	$self->_drain_rbuf unless $self->{_in_drain};
600	}	879	}
601		880
602	sub unshift_read {	881	sub unshift_read {
603	my $self = shift;	882	my $self = shift;
604	my $cb = pop;	883	my $cb = pop;
…		…
610	->($self, $cb, @_);	889	->($self, $cb, @_);
611	}	890	}
612		891
613		892
614	unshift @{ $self->{_queue} }, $cb;	893	unshift @{ $self->{_queue} }, $cb;
615	$self->_drain_rbuf;	894	$self->_drain_rbuf unless $self->{_in_drain};
616	}	895	}
617		896
618	=item $handle->push_read (type => @args, $cb)	897	=item $handle->push_read (type => @args, $cb)
619		898
620	=item $handle->unshift_read (type => @args, $cb)	899	=item $handle->unshift_read (type => @args, $cb)
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	905	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	906	drop by and tell us):
628		907
629	=over 4	908	=over 4
630		909
631	=item chunk => $octets, $cb->($self, $data)	910	=item chunk => $octets, $cb->($handle, $data)
632		911
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	912	Invoke the callback only once C<$octets> bytes have been read. Pass the
634	data read to the callback. The callback will never be called with less	913	data read to the callback. The callback will never be called with less
635	data.	914	data.
636		915
…		…
650	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	929	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
651	1	930	1
652	}	931	}
653	};	932	};
654		933
655	# compatibility with older API
656	sub push_read_chunk {
657	$_[0]->push_read (chunk => $_[1], $_[2]);
658	}
659
660	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}
663
664	=item line => [$eol, ]$cb->($self, $line, $eol)	934	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		935
666	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
667	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
668	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
669	the end of line marker as the third argument (C<$eol>).	939	the end of line marker as the third argument (C<$eol>).
…		…
683	=cut	953	=cut
684		954
685	register_read_type line => sub {	955	register_read_type line => sub {
686	my ($self, $cb, $eol) = @_;	956	my ($self, $cb, $eol) = @_;
687		957
688	$eol = qr\|(\015?\012)\| if @_ < 3;	958	if (@_ < 3) {
		959	# this is more than twice as fast as the generic code below
		960	sub {
		961	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		962
		963	$cb->($_[0], $1, $2);
		964	1
		965	}
		966	} else {
689	$eol = quotemeta $eol unless ref $eol;	967	$eol = quotemeta $eol unless ref $eol;
690	$eol = qr\|^(.*?)($eol)\|s;	968	$eol = qr\|^(.*?)($eol)\|s;
691		969
692	sub {	970	sub {
693	$_[0]{rbuf} =~ s/$eol// or return;	971	$_[0]{rbuf} =~ s/$eol// or return;
694		972
695	$cb->($_[0], $1, $2);	973	$cb->($_[0], $1, $2);
		974	1
696	1	975	}
697	}	976	}
698	};	977	};
699		978
700	# compatibility with older API
701	sub push_read_line {
702	my $self = shift;
703	$self->push_read (line => @_);
704	}
705
706	sub unshift_read_line {
707	my $self = shift;
708	$self->unshift_read (line => @_);
709	}
710
711	=item netstring => $cb->($string)
712
713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
714
715	Throws an error with C<$!> set to EBADMSG on format violations.
716
717	=cut
718
719	register_read_type netstring => sub {
720	my ($self, $cb) = @_;
721
722	sub {
723	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
724	if ($_[0]{rbuf} =~ /[^0-9]/) {
725	$! = &Errno::EBADMSG;
726	$self->error;
727	}
728	return;
729	}
730
731	my $len = $1;
732
733	$self->unshift_read (chunk => $len, sub {
734	my $string = $_[1];
735	$_[0]->unshift_read (chunk => 1, sub {
736	if ($_[1] eq ",") {
737	$cb->($_[0], $string);
738	} else {
739	$! = &Errno::EBADMSG;
740	$self->error;
741	}
742	});
743	});
744
745	1
746	}
747	};
748
749	=item regex => $accept[, $reject[, $skip], $cb->($data)	979	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		980
751	Makes a regex match against the regex object C<$accept> and returns	981	Makes a regex match against the regex object C<$accept> and returns
752	everything up to and including the match.	982	everything up to and including the match.
753		983
754	Example: read a single line terminated by '\n'.	984	Example: read a single line terminated by '\n'.
…		…
802	return 1;	1032	return 1;
803	}	1033	}
804		1034
805	# reject	1035	# reject
806	if ($reject && $$rbuf =~ $reject) {	1036	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	1037	$self->_error (&Errno::EBADMSG);
808	$self->error;
809	}	1038	}
810		1039
811	# skip	1040	# skip
812	if ($skip && $$rbuf =~ $skip) {	1041	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	1042	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		1044
816	()	1045	()
817	}	1046	}
818	};	1047	};
819		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
		1130	=item json => $cb->($handle, $hash_or_arrayref)
		1131
		1132	Reads a JSON object or array, decodes it and passes it to the callback.
		1133
		1134	If a C<json> object was passed to the constructor, then that will be used
		1135	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1136
		1137	This read type uses the incremental parser available with JSON version
		1138	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1139	dependency on your own: this module will load the JSON module, but
		1140	AnyEvent does not depend on it itself.
		1141
		1142	Since JSON texts are fully self-delimiting, the C<json> read and write
		1143	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1144	the C<json> write type description, above, for an actual example.
		1145
		1146	=cut
		1147
		1148	register_read_type json => sub {
		1149	my ($self, $cb) = @_;
		1150
		1151	require JSON;
		1152
		1153	my $data;
		1154	my $rbuf = \$self->{rbuf};
		1155
		1156	my $json = $self->{json} \|\|= JSON->new->utf8;
		1157
		1158	sub {
		1159	my $ref = $json->incr_parse ($self->{rbuf});
		1160
		1161	if ($ref) {
		1162	$self->{rbuf} = $json->incr_text;
		1163	$json->incr_text = "";
		1164	$cb->($self, $ref);
		1165
		1166	1
		1167	} else {
		1168	$self->{rbuf} = "";
		1169	()
		1170	}
		1171	}
		1172	};
		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
820	=back	1219	=back
821		1220
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1221	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1222
824	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>.
825		1224
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1225	Whenever the given C<type> is used, C<push_read> will invoke the code
827	reference with the handle object, the callback and the remaining	1226	reference with the handle object, the callback and the remaining
…		…
829		1228
830	The code reference is supposed to return a callback (usually a closure)	1229	The code reference is supposed to return a callback (usually a closure)
831	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1230	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1231
833	It should invoke the passed callback when it is done reading (remember to	1232	It should invoke the passed callback when it is done reading (remember to
834	pass C<$self> as first argument as all other callbacks do that).	1233	pass C<$handle> as first argument as all other callbacks do that).
835		1234
836	Note that this is a function, and all types registered this way will be	1235	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1236	global, so try to use unique names.
838		1237
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1238	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
842	=item $handle->stop_read	1241	=item $handle->stop_read
843		1242
844	=item $handle->start_read	1243	=item $handle->start_read
845		1244
846	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
847	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
848	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
849	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.
850		1254
851	=cut	1255	=cut
852		1256
853	sub stop_read {	1257	sub stop_read {
854	my ($self) = @_;	1258	my ($self) = @_;
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1269	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1270	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1271	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
868		1272
869	if ($len > 0) {	1273	if ($len > 0) {
		1274	$self->{_activity} = AnyEvent->now;
		1275
870	$self->{filter_r}	1276	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1277	? $self->{filter_r}($self, $rbuf)
872	: $self->_drain_rbuf;	1278	: $self->{_in_drain} \|\| $self->_drain_rbuf;
873		1279
874	} elsif (defined $len) {	1280	} elsif (defined $len) {
875	delete $self->{_rw};	1281	delete $self->{_rw};
876	$self->{_eof} = 1;	1282	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1283	$self->_drain_rbuf unless $self->{_in_drain};
878		1284
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1285	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1286	return $self->_error ($!, 1);
881	}	1287	}
882	});	1288	});
883	}	1289	}
884	}	1290	}
885		1291
886	sub _dotls {	1292	sub _dotls {
887	my ($self) = @_;	1293	my ($self) = @_;
		1294
		1295	my $buf;
888		1296
889	if (length $self->{_tls_wbuf}) {	1297	if (length $self->{_tls_wbuf}) {
890	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) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1299	substr $self->{_tls_wbuf}, 0, $len, "";
892	}	1300	}
893	}	1301	}
894		1302
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1303	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1304	$self->{wbuf} .= $buf;
897	$self->_drain_wbuf;	1305	$self->_drain_wbuf;
898	}	1306	}
899		1307
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1308	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1309	if (length $buf) {
901	$self->{rbuf} .= $buf;	1310	$self->{rbuf} .= $buf;
902	$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	}
903	}	1318	}
904		1319
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1320	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906		1321
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1322	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1323	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;	1324	return $self->_error ($!, 1);
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1325	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;	1326	return $self->_error (&Errno::EIO, 1);
912	$self->error;
913	}	1327	}
914		1328
915	# all others are fine for our purposes	1329	# all others are fine for our purposes
916	}	1330	}
917	}	1331	}
…		…
932	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
933	might have already started when this function returns.	1347	might have already started when this function returns.
934		1348
935	=cut	1349	=cut
936		1350
937	# TODO: maybe document...
938	sub starttls {	1351	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1352	my ($self, $ssl, $ctx) = @_;
940		1353
941	$self->stoptls;	1354	$self->stoptls;
942		1355
…		…
995		1408
996	sub DESTROY {	1409	sub DESTROY {
997	my $self = shift;	1410	my $self = shift;
998		1411
999	$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	}
1000	}	1435	}
1001		1436
1002	=item AnyEvent::Handle::TLS_CTX	1437	=item AnyEvent::Handle::TLS_CTX
1003		1438
1004	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
…		…
1046	=over 4	1481	=over 4
1047		1482
1048	=item * all constructor arguments become object members.	1483	=item * all constructor arguments become object members.
1049		1484
1050	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
1051	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
1052	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).
1053		1488
1054	=item * other object member names are prefixed with an C<_>.	1489	=item * other object member names are prefixed with an C<_>.
1055		1490
1056	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.38 by root, Mon May 26 21:28:33 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.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.85 by root, Thu Aug 21 19:53:19 2008 UTC