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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.87 by root, Thu Aug 21 20:52:39 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->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called on EOF.	84	Set the callback to be called when an end-of-file condition is detected,
		85	i.e. in the case of a socket, when the other side has closed the
		86	connection cleanly.
81		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the eof
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
82	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
84	waiting for data.	95	waiting for data.
85		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
		99
86	=item on_error => $cb->($handle)	100	=item on_error => $cb->($handle, $fatal)
87		101
88	This is the fatal error callback, that is called when, well, a fatal error	102	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	103	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	104	connect or a read error.
91		105
92	The object will not be in a usable state when this callback has been	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C< ->rbuf >). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
		112	Non-fatal errors can be retried by simply returning, but it is recommended
		113	to simply ignore this parameter and instead abondon the handle object
		114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		116
95	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> 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->($handle)	124	=item on_read => $cb->($handle)
106		125
107	This sets the default read callback, which is called when data arrives	126	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	127	and no read request is in the queue (unlike read queue callbacks, this
		128	callback will only be called when at least one octet of data is in the
		129	read buffer).
109		130
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
112		133
113	When an EOF condition is detected then AnyEvent::Handle will first try to	134	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
119		140
120	This sets the callback that is called when the write buffer becomes empty	141	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	142	(or when the callback is set and the buffer is empty already).
122		143
123	To append to the write buffer, use the C<< ->push_write >> method.	144	To append to the write buffer, use the C<< ->push_write >> method.
		145
		146	This callback is useful when you don't want to put all of your write data
		147	into the queue at once, for example, when you want to write the contents
		148	of some file to the socket you might not want to read the whole file into
		149	memory and push it into the queue, but instead only read more data from
		150	the file when the write queue becomes empty.
		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
…		…
172		255
173	=item json => JSON or JSON::XS object	256	=item json => JSON or JSON::XS object
174		257
175	This is the json coder object used by the C<json> read and write types.	258	This is the json coder object used by the C<json> read and write types.
176		259
177	If you don't supply it, then AnyEvent::Handle will use C<encode_json> and	260	If you don't supply it, then AnyEvent::Handle will create and use a
178	C<decode_json>.	261	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		262	texts.
179		263
180	Note that you are responsible to depend on the JSON module if you want to	264	Note that you are responsible to depend on the JSON module if you want to
181	use this functionality, as AnyEvent does not have a dependency itself.	265	use this functionality, as AnyEvent does not have a dependency itself.
182		266
183	=item filter_r => $cb	267	=item filter_r => $cb
184		268
185	=item filter_w => $cb	269	=item filter_w => $cb
186		270
187	These exist, but are undocumented at this time.	271	These exist, but are undocumented at this time. (They are used internally
		272	by the TLS code).
188		273
189	=back	274	=back
190		275
191	=cut	276	=cut
192		277
…		…
202	if ($self->{tls}) {	287	if ($self->{tls}) {
203	require Net::SSLeay;	288	require Net::SSLeay;
204	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	289	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
205	}	290	}
206		291
207	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	292	$self->{_activity} = AnyEvent->now;
208	$self->on_error (delete $self->{on_error}) if $self->{on_error};	293	$self->_timeout;
		294
209	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	295	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
210	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	296	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
211		297
212	$self->start_read;	298	$self->start_read
		299	if $self->{on_read};
213		300
214	$self	301	$self
215	}	302	}
216		303
217	sub _shutdown {	304	sub _shutdown {
218	my ($self) = @_;	305	my ($self) = @_;
219		306
		307	delete $self->{_tw};
220	delete $self->{_rw};	308	delete $self->{_rw};
221	delete $self->{_ww};	309	delete $self->{_ww};
222	delete $self->{fh};	310	delete $self->{fh};
223	}
224		311
		312	$self->stoptls;
		313
		314	delete $self->{on_read};
		315	delete $self->{_queue};
		316	}
		317
225	sub error {	318	sub _error {
226	my ($self) = @_;	319	my ($self, $errno, $fatal) = @_;
227		320
228	{
229	local $!;
230	$self->_shutdown;	321	$self->_shutdown
231	}	322	if $fatal;
232		323
233	$self->{on_error}($self)	324	$! = $errno;
		325
234	if $self->{on_error};	326	if ($self->{on_error}) {
235		327	$self->{on_error}($self, $fatal);
		328	} else {
236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	329	Carp::croak "AnyEvent::Handle uncaught error: $!";
		330	}
237	}	331	}
238		332
239	=item $fh = $handle->fh	333	=item $fh = $handle->fh
240		334
241	This method returns the file handle of the L<AnyEvent::Handle> object.	335	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
260		354
261	=cut	355	=cut
262		356
263	sub on_eof {	357	sub on_eof {
264	$_[0]{on_eof} = $_[1];	358	$_[0]{on_eof} = $_[1];
		359	}
		360
		361	=item $handle->on_timeout ($cb)
		362
		363	Replace the current C<on_timeout> callback, or disables the callback
		364	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		365	argument.
		366
		367	=cut
		368
		369	sub on_timeout {
		370	$_[0]{on_timeout} = $_[1];
		371	}
		372
		373	=item $handle->autocork ($boolean)
		374
		375	Enables or disables the current autocork behaviour (see C<autocork>
		376	constructor argument).
		377
		378	=cut
		379
		380	=item $handle->no_delay ($boolean)
		381
		382	Enables or disables the C<no_delay> setting (see constructor argument of
		383	the same name for details).
		384
		385	=cut
		386
		387	sub no_delay {
		388	$_[0]{no_delay} = $_[1];
		389
		390	eval {
		391	local $SIG{__DIE__};
		392	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		393	};
		394	}
		395
		396	#############################################################################
		397
		398	=item $handle->timeout ($seconds)
		399
		400	Configures (or disables) the inactivity timeout.
		401
		402	=cut
		403
		404	sub timeout {
		405	my ($self, $timeout) = @_;
		406
		407	$self->{timeout} = $timeout;
		408	$self->_timeout;
		409	}
		410
		411	# reset the timeout watcher, as neccessary
		412	# also check for time-outs
		413	sub _timeout {
		414	my ($self) = @_;
		415
		416	if ($self->{timeout}) {
		417	my $NOW = AnyEvent->now;
		418
		419	# when would the timeout trigger?
		420	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		421
		422	# now or in the past already?
		423	if ($after <= 0) {
		424	$self->{_activity} = $NOW;
		425
		426	if ($self->{on_timeout}) {
		427	$self->{on_timeout}($self);
		428	} else {
		429	$self->_error (&Errno::ETIMEDOUT);
		430	}
		431
		432	# callback could have changed timeout value, optimise
		433	return unless $self->{timeout};
		434
		435	# calculate new after
		436	$after = $self->{timeout};
		437	}
		438
		439	Scalar::Util::weaken $self;
		440	return unless $self; # ->error could have destroyed $self
		441
		442	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		443	delete $self->{_tw};
		444	$self->_timeout;
		445	});
		446	} else {
		447	delete $self->{_tw};
		448	}
265	}	449	}
266		450
267	#############################################################################	451	#############################################################################
268		452
269	=back	453	=back
…		…
316	my $len = syswrite $self->{fh}, $self->{wbuf};	500	my $len = syswrite $self->{fh}, $self->{wbuf};
317		501
318	if ($len >= 0) {	502	if ($len >= 0) {
319	substr $self->{wbuf}, 0, $len, "";	503	substr $self->{wbuf}, 0, $len, "";
320		504
		505	$self->{_activity} = AnyEvent->now;
		506
321	$self->{on_drain}($self)	507	$self->{on_drain}($self)
322	if $self->{low_water_mark} >= length $self->{wbuf}	508	if $self->{low_water_mark} >= length $self->{wbuf}
323	&& $self->{on_drain};	509	&& $self->{on_drain};
324		510
325	delete $self->{_ww} unless length $self->{wbuf};	511	delete $self->{_ww} unless length $self->{wbuf};
326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	512	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
327	$self->error;	513	$self->_error ($!, 1);
328	}	514	}
329	};	515	};
330		516
331	# try to write data immediately	517	# try to write data immediately
332	$cb->();	518	$cb->() unless $self->{autocork};
333		519
334	# if still data left in wbuf, we need to poll	520	# if still data left in wbuf, we need to poll
335	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	521	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
336	if length $self->{wbuf};	522	if length $self->{wbuf};
337	};	523	};
…		…
352	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	538	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
353	->($self, @_);	539	->($self, @_);
354	}	540	}
355		541
356	if ($self->{filter_w}) {	542	if ($self->{filter_w}) {
357	$self->{filter_w}->($self, \$_[0]);	543	$self->{filter_w}($self, \$_[0]);
358	} else {	544	} else {
359	$self->{wbuf} .= $_[0];	545	$self->{wbuf} .= $_[0];
360	$self->_drain_wbuf;	546	$self->_drain_wbuf;
361	}	547	}
362	}	548	}
363		549
364	=item $handle->push_write (type => @args)	550	=item $handle->push_write (type => @args)
365		551
366	=item $handle->unshift_write (type => @args)
367
368	Instead of formatting your data yourself, you can also let this module do	552	Instead of formatting your data yourself, you can also let this module do
369	the job by specifying a type and type-specific arguments.	553	the job by specifying a type and type-specific arguments.
370		554
371	Predefined types are (if you have ideas for additional types, feel free to	555	Predefined types are (if you have ideas for additional types, feel free to
372	drop by and tell us):	556	drop by and tell us):
…		…
376	=item netstring => $string	560	=item netstring => $string
377		561
378	Formats the given value as netstring	562	Formats the given value as netstring
379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	563	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
380		564
381	=back
382
383	=cut	565	=cut
384		566
385	register_write_type netstring => sub {	567	register_write_type netstring => sub {
386	my ($self, $string) = @_;	568	my ($self, $string) = @_;
387		569
388	sprintf "%d:%s,", (length $string), $string	570	sprintf "%d:%s,", (length $string), $string
		571	};
		572
		573	=item packstring => $format, $data
		574
		575	An octet string prefixed with an encoded length. The encoding C<$format>
		576	uses the same format as a Perl C<pack> format, but must specify a single
		577	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		578	optional C<!>, C<< < >> or C<< > >> modifier).
		579
		580	=cut
		581
		582	register_write_type packstring => sub {
		583	my ($self, $format, $string) = @_;
		584
		585	pack "$format/a*", $string
389	};	586	};
390		587
391	=item json => $array_or_hashref	588	=item json => $array_or_hashref
392		589
393	Encodes the given hash or array reference into a JSON object. Unless you	590	Encodes the given hash or array reference into a JSON object. Unless you
…		…
396		593
397	JSON objects (and arrays) are self-delimiting, so you can write JSON at	594	JSON objects (and arrays) are self-delimiting, so you can write JSON at
398	one end of a handle and read them at the other end without using any	595	one end of a handle and read them at the other end without using any
399	additional framing.	596	additional framing.
400		597
		598	The generated JSON text is guaranteed not to contain any newlines: While
		599	this module doesn't need delimiters after or between JSON texts to be
		600	able to read them, many other languages depend on that.
		601
		602	A simple RPC protocol that interoperates easily with others is to send
		603	JSON arrays (or objects, although arrays are usually the better choice as
		604	they mimic how function argument passing works) and a newline after each
		605	JSON text:
		606
		607	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		608	$handle->push_write ("\012");
		609
		610	An AnyEvent::Handle receiver would simply use the C<json> read type and
		611	rely on the fact that the newline will be skipped as leading whitespace:
		612
		613	$handle->push_read (json => sub { my $array = $_[1]; ... });
		614
		615	Other languages could read single lines terminated by a newline and pass
		616	this line into their JSON decoder of choice.
		617
401	=cut	618	=cut
402		619
403	register_write_type json => sub {	620	register_write_type json => sub {
404	my ($self, $ref) = @_;	621	my ($self, $ref) = @_;
405		622
…		…
407		624
408	$self->{json} ? $self->{json}->encode ($ref)	625	$self->{json} ? $self->{json}->encode ($ref)
409	: JSON::encode_json ($ref)	626	: JSON::encode_json ($ref)
410	};	627	};
411		628
		629	=item storable => $reference
		630
		631	Freezes the given reference using L<Storable> and writes it to the
		632	handle. Uses the C<nfreeze> format.
		633
		634	=cut
		635
		636	register_write_type storable => sub {
		637	my ($self, $ref) = @_;
		638
		639	require Storable;
		640
		641	pack "w/a*", Storable::nfreeze ($ref)
		642	};
		643
		644	=back
		645
412	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	646	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
413		647
414	This function (not method) lets you add your own types to C<push_write>.	648	This function (not method) lets you add your own types to C<push_write>.
415	Whenever the given C<type> is used, C<push_write> will invoke the code	649	Whenever the given C<type> is used, C<push_write> will invoke the code
416	reference with the handle object and the remaining arguments.	650	reference with the handle object and the remaining arguments.
…		…
436	ways, the "simple" way, using only C<on_read> and the "complex" way, using	670	ways, the "simple" way, using only C<on_read> and the "complex" way, using
437	a queue.	671	a queue.
438		672
439	In the simple case, you just install an C<on_read> callback and whenever	673	In the simple case, you just install an C<on_read> callback and whenever
440	new data arrives, it will be called. You can then remove some data (if	674	new data arrives, it will be called. You can then remove some data (if
441	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	675	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
442	or not.	676	leave the data there if you want to accumulate more (e.g. when only a
		677	partial message has been received so far).
443		678
444	In the more complex case, you want to queue multiple callbacks. In this	679	In the more complex case, you want to queue multiple callbacks. In this
445	case, AnyEvent::Handle will call the first queued callback each time new	680	case, AnyEvent::Handle will call the first queued callback each time new
446	data arrives and removes it when it has done its job (see C<push_read>,	681	data arrives (also the first time it is queued) and removes it when it has
447	below).	682	done its job (see C<push_read>, below).
448		683
449	This way you can, for example, push three line-reads, followed by reading	684	This way you can, for example, push three line-reads, followed by reading
450	a chunk of data, and AnyEvent::Handle will execute them in order.	685	a chunk of data, and AnyEvent::Handle will execute them in order.
451		686
452	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	687	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
453	the specified number of bytes which give an XML datagram.	688	the specified number of bytes which give an XML datagram.
454		689
455	# in the default state, expect some header bytes	690	# in the default state, expect some header bytes
456	$handle->on_read (sub {	691	$handle->on_read (sub {
457	# some data is here, now queue the length-header-read (4 octets)	692	# some data is here, now queue the length-header-read (4 octets)
458	shift->unshift_read_chunk (4, sub {	693	shift->unshift_read (chunk => 4, sub {
459	# header arrived, decode	694	# header arrived, decode
460	my $len = unpack "N", $_[1];	695	my $len = unpack "N", $_[1];
461		696
462	# now read the payload	697	# now read the payload
463	shift->unshift_read_chunk ($len, sub {	698	shift->unshift_read (chunk => $len, sub {
464	my $xml = $_[1];	699	my $xml = $_[1];
465	# handle xml	700	# handle xml
466	});	701	});
467	});	702	});
468	});	703	});
469		704
470	Example 2: Implement a client for a protocol that replies either with	705	Example 2: Implement a client for a protocol that replies either with "OK"
471	"OK" and another line or "ERROR" for one request, and 64 bytes for the	706	and another line or "ERROR" for the first request that is sent, and 64
472	second request. Due tot he availability of a full queue, we can just	707	bytes for the second request. Due to the availability of a queue, we can
473	pipeline sending both requests and manipulate the queue as necessary in	708	just pipeline sending both requests and manipulate the queue as necessary
474	the callbacks:	709	in the callbacks.
475		710
476	# request one	711	When the first callback is called and sees an "OK" response, it will
		712	C<unshift> another line-read. This line-read will be queued I<before> the
		713	64-byte chunk callback.
		714
		715	# request one, returns either "OK + extra line" or "ERROR"
477	$handle->push_write ("request 1\015\012");	716	$handle->push_write ("request 1\015\012");
478		717
479	# we expect "ERROR" or "OK" as response, so push a line read	718	# we expect "ERROR" or "OK" as response, so push a line read
480	$handle->push_read_line (sub {	719	$handle->push_read (line => sub {
481	# if we got an "OK", we have to _prepend_ another line,	720	# if we got an "OK", we have to _prepend_ another line,
482	# so it will be read before the second request reads its 64 bytes	721	# so it will be read before the second request reads its 64 bytes
483	# which are already in the queue when this callback is called	722	# which are already in the queue when this callback is called
484	# we don't do this in case we got an error	723	# we don't do this in case we got an error
485	if ($_[1] eq "OK") {	724	if ($_[1] eq "OK") {
486	$_[0]->unshift_read_line (sub {	725	$_[0]->unshift_read (line => sub {
487	my $response = $_[1];	726	my $response = $_[1];
488	...	727	...
489	});	728	});
490	}	729	}
491	});	730	});
492		731
493	# request two	732	# request two, simply returns 64 octets
494	$handle->push_write ("request 2\015\012");	733	$handle->push_write ("request 2\015\012");
495		734
496	# simply read 64 bytes, always	735	# simply read 64 bytes, always
497	$handle->push_read_chunk (64, sub {	736	$handle->push_read (chunk => 64, sub {
498	my $response = $_[1];	737	my $response = $_[1];
499	...	738	...
500	});	739	});
501		740
502	=over 4	741	=over 4
503		742
504	=cut	743	=cut
505		744
506	sub _drain_rbuf {	745	sub _drain_rbuf {
507	my ($self) = @_;	746	my ($self) = @_;
		747
		748	local $self->{_in_drain} = 1;
508		749
509	if (	750	if (
510	defined $self->{rbuf_max}	751	defined $self->{rbuf_max}
511	&& $self->{rbuf_max} < length $self->{rbuf}	752	&& $self->{rbuf_max} < length $self->{rbuf}
512	) {	753	) {
513	$! = &Errno::ENOSPC;	754	$self->_error (&Errno::ENOSPC, 1), return;
514	$self->error;
515	}	755	}
516		756
517	return if $self->{in_drain};	757	while () {
518	local $self->{in_drain} = 1;
519
520	while (my $len = length $self->{rbuf}) {	758	my $len = length $self->{rbuf};
521	no strict 'refs';	759
522	if (my $cb = shift @{ $self->{_queue} }) {	760	if (my $cb = shift @{ $self->{_queue} }) {
523	unless ($cb->($self)) {	761	unless ($cb->($self)) {
524	if ($self->{_eof}) {	762	if ($self->{_eof}) {
525	# no progress can be made (not enough data and no data forthcoming)	763	# no progress can be made (not enough data and no data forthcoming)
526	$! = &Errno::EPIPE;	764	$self->_error (&Errno::EPIPE, 1), return;
527	$self->error;
528	}	765	}
529		766
530	unshift @{ $self->{_queue} }, $cb;	767	unshift @{ $self->{_queue} }, $cb;
531	return;	768	last;
532	}	769	}
533	} elsif ($self->{on_read}) {	770	} elsif ($self->{on_read}) {
		771	last unless $len;
		772
534	$self->{on_read}($self);	773	$self->{on_read}($self);
535		774
536	if (	775	if (
537	$self->{_eof} # if no further data will arrive
538	&& $len == length $self->{rbuf} # and no data has been consumed	776	$len == length $self->{rbuf} # if no data has been consumed
539	&& !@{ $self->{_queue} } # and the queue is still empty	777	&& !@{ $self->{_queue} } # and the queue is still empty
540	&& $self->{on_read} # and we still want to read data	778	&& $self->{on_read} # but we still have on_read
541	) {	779	) {
		780	# no further data will arrive
542	# then no progress can be made	781	# so no progress can be made
543	$! = &Errno::EPIPE;	782	$self->_error (&Errno::EPIPE, 1), return
544	$self->error;	783	if $self->{_eof};
		784
		785	last; # more data might arrive
545	}	786	}
546	} else {	787	} else {
547	# read side becomes idle	788	# read side becomes idle
548	delete $self->{_rw};	789	delete $self->{_rw};
549	return;	790	last;
550	}	791	}
551	}	792	}
552		793
553	if ($self->{_eof}) {	794	if ($self->{_eof}) {
554	$self->_shutdown;	795	if ($self->{on_eof}) {
555	$self->{on_eof}($self)	796	$self->{on_eof}($self)
556	if $self->{on_eof};	797	} else {
		798	$self->_error (0, 1);
		799	}
		800	}
		801
		802	# may need to restart read watcher
		803	unless ($self->{_rw}) {
		804	$self->start_read
		805	if $self->{on_read} \|\| @{ $self->{_queue} };
557	}	806	}
558	}	807	}
559		808
560	=item $handle->on_read ($cb)	809	=item $handle->on_read ($cb)
561		810
…		…
567		816
568	sub on_read {	817	sub on_read {
569	my ($self, $cb) = @_;	818	my ($self, $cb) = @_;
570		819
571	$self->{on_read} = $cb;	820	$self->{on_read} = $cb;
		821	$self->_drain_rbuf if $cb && !$self->{_in_drain};
572	}	822	}
573		823
574	=item $handle->rbuf	824	=item $handle->rbuf
575		825
576	Returns the read buffer (as a modifiable lvalue).	826	Returns the read buffer (as a modifiable lvalue).
…		…
625	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	875	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
626	->($self, $cb, @_);	876	->($self, $cb, @_);
627	}	877	}
628		878
629	push @{ $self->{_queue} }, $cb;	879	push @{ $self->{_queue} }, $cb;
630	$self->_drain_rbuf;	880	$self->_drain_rbuf unless $self->{_in_drain};
631	}	881	}
632		882
633	sub unshift_read {	883	sub unshift_read {
634	my $self = shift;	884	my $self = shift;
635	my $cb = pop;	885	my $cb = pop;
…		…
641	->($self, $cb, @_);	891	->($self, $cb, @_);
642	}	892	}
643		893
644		894
645	unshift @{ $self->{_queue} }, $cb;	895	unshift @{ $self->{_queue} }, $cb;
646	$self->_drain_rbuf;	896	$self->_drain_rbuf unless $self->{_in_drain};
647	}	897	}
648		898
649	=item $handle->push_read (type => @args, $cb)	899	=item $handle->push_read (type => @args, $cb)
650		900
651	=item $handle->unshift_read (type => @args, $cb)	901	=item $handle->unshift_read (type => @args, $cb)
…		…
681	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	931	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
682	1	932	1
683	}	933	}
684	};	934	};
685		935
686	# compatibility with older API
687	sub push_read_chunk {
688	$_[0]->push_read (chunk => $_[1], $_[2]);
689	}
690
691	sub unshift_read_chunk {
692	$_[0]->unshift_read (chunk => $_[1], $_[2]);
693	}
694
695	=item line => [$eol, ]$cb->($handle, $line, $eol)	936	=item line => [$eol, ]$cb->($handle, $line, $eol)
696		937
697	The callback will be called only once a full line (including the end of	938	The callback will be called only once a full line (including the end of
698	line marker, C<$eol>) has been read. This line (excluding the end of line	939	line marker, C<$eol>) has been read. This line (excluding the end of line
699	marker) will be passed to the callback as second argument (C<$line>), and	940	marker) will be passed to the callback as second argument (C<$line>), and
…		…
714	=cut	955	=cut
715		956
716	register_read_type line => sub {	957	register_read_type line => sub {
717	my ($self, $cb, $eol) = @_;	958	my ($self, $cb, $eol) = @_;
718		959
719	$eol = qr\|(\015?\012)\| if @_ < 3;	960	if (@_ < 3) {
720	$eol = quotemeta $eol unless ref $eol;	961	# this is more than twice as fast as the generic code below
721	$eol = qr\|^(.*?)($eol)\|s;
722
723	sub {	962	sub {
724	$_[0]{rbuf} =~ s/$eol// or return;	963	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
725		964
726	$cb->($_[0], $1, $2);	965	$cb->($_[0], $1, $2);
727	1
728	}
729	};
730
731	# compatibility with older API
732	sub push_read_line {
733	my $self = shift;
734	$self->push_read (line => @_);
735	}
736
737	sub unshift_read_line {
738	my $self = shift;
739	$self->unshift_read (line => @_);
740	}
741
742	=item netstring => $cb->($handle, $string)
743
744	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
745
746	Throws an error with C<$!> set to EBADMSG on format violations.
747
748	=cut
749
750	register_read_type netstring => sub {
751	my ($self, $cb) = @_;
752
753	sub {
754	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
755	if ($_[0]{rbuf} =~ /[^0-9]/) {
756	$! = &Errno::EBADMSG;
757	$self->error;
758	}	966	1
759	return;
760	}	967	}
		968	} else {
		969	$eol = quotemeta $eol unless ref $eol;
		970	$eol = qr\|^(.*?)($eol)\|s;
761		971
762	my $len = $1;	972	sub {
		973	$_[0]{rbuf} =~ s/$eol// or return;
763		974
764	$self->unshift_read (chunk => $len, sub {	975	$cb->($_[0], $1, $2);
765	my $string = $_[1];
766	$_[0]->unshift_read (chunk => 1, sub {
767	if ($_[1] eq ",") {
768	$cb->($_[0], $string);
769	} else {
770	$! = &Errno::EBADMSG;
771	$self->error;
772	}
773	});	976	1
774	});	977	}
775
776	1
777	}	978	}
778	};	979	};
779		980
780	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	981	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
781		982
…		…
833	return 1;	1034	return 1;
834	}	1035	}
835		1036
836	# reject	1037	# reject
837	if ($reject && $$rbuf =~ $reject) {	1038	if ($reject && $$rbuf =~ $reject) {
838	$! = &Errno::EBADMSG;	1039	$self->_error (&Errno::EBADMSG);
839	$self->error;
840	}	1040	}
841		1041
842	# skip	1042	# skip
843	if ($skip && $$rbuf =~ $skip) {	1043	if ($skip && $$rbuf =~ $skip) {
844	$data .= substr $$rbuf, 0, $+[0], "";	1044	$data .= substr $$rbuf, 0, $+[0], "";
…		…
846		1046
847	()	1047	()
848	}	1048	}
849	};	1049	};
850		1050
		1051	=item netstring => $cb->($handle, $string)
		1052
		1053	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1054
		1055	Throws an error with C<$!> set to EBADMSG on format violations.
		1056
		1057	=cut
		1058
		1059	register_read_type netstring => sub {
		1060	my ($self, $cb) = @_;
		1061
		1062	sub {
		1063	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1064	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1065	$self->_error (&Errno::EBADMSG);
		1066	}
		1067	return;
		1068	}
		1069
		1070	my $len = $1;
		1071
		1072	$self->unshift_read (chunk => $len, sub {
		1073	my $string = $_[1];
		1074	$_[0]->unshift_read (chunk => 1, sub {
		1075	if ($_[1] eq ",") {
		1076	$cb->($_[0], $string);
		1077	} else {
		1078	$self->_error (&Errno::EBADMSG);
		1079	}
		1080	});
		1081	});
		1082
		1083	1
		1084	}
		1085	};
		1086
		1087	=item packstring => $format, $cb->($handle, $string)
		1088
		1089	An octet string prefixed with an encoded length. The encoding C<$format>
		1090	uses the same format as a Perl C<pack> format, but must specify a single
		1091	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1092	optional C<!>, C<< < >> or C<< > >> modifier).
		1093
		1094	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1095
		1096	Example: read a block of data prefixed by its length in BER-encoded
		1097	format (very efficient).
		1098
		1099	$handle->push_read (packstring => "w", sub {
		1100	my ($handle, $data) = @_;
		1101	});
		1102
		1103	=cut
		1104
		1105	register_read_type packstring => sub {
		1106	my ($self, $cb, $format) = @_;
		1107
		1108	sub {
		1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1110	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1111	or return;
		1112
		1113	$format = length pack $format, $len;
		1114
		1115	# bypass unshift if we already have the remaining chunk
		1116	if ($format + $len <= length $_[0]{rbuf}) {
		1117	my $data = substr $_[0]{rbuf}, $format, $len;
		1118	substr $_[0]{rbuf}, 0, $format + $len, "";
		1119	$cb->($_[0], $data);
		1120	} else {
		1121	# remove prefix
		1122	substr $_[0]{rbuf}, 0, $format, "";
		1123
		1124	# read remaining chunk
		1125	$_[0]->unshift_read (chunk => $len, $cb);
		1126	}
		1127
		1128	1
		1129	}
		1130	};
		1131
851	=item json => $cb->($handle, $hash_or_arrayref)	1132	=item json => $cb->($handle, $hash_or_arrayref)
852		1133
853	Reads a JSON object or array, decodes it and passes it to the callback.	1134	Reads a JSON object or array, decodes it and passes it to the callback.
854		1135
855	If a C<json> object was passed to the constructor, then that will be used	1136	If a C<json> object was passed to the constructor, then that will be used
…		…
859	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1140	2.09 (and JSON::XS version 2.2) and above. You have to provide a
860	dependency on your own: this module will load the JSON module, but	1141	dependency on your own: this module will load the JSON module, but
861	AnyEvent does not depend on it itself.	1142	AnyEvent does not depend on it itself.
862		1143
863	Since JSON texts are fully self-delimiting, the C<json> read and write	1144	Since JSON texts are fully self-delimiting, the C<json> read and write
864	types are an ideal simple RPC protocol: just exchange JSON datagrams.	1145	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1146	the C<json> write type description, above, for an actual example.
865		1147
866	=cut	1148	=cut
867		1149
868	register_read_type json => sub {	1150	register_read_type json => sub {
869	my ($self, $cb, $accept, $reject, $skip) = @_;	1151	my ($self, $cb) = @_;
870		1152
871	require JSON;	1153	require JSON;
872		1154
873	my $data;	1155	my $data;
874	my $rbuf = \$self->{rbuf};	1156	my $rbuf = \$self->{rbuf};
875		1157
876	my $json = $self->{json} \|\|= JSON::XS->new->utf8;	1158	my $json = $self->{json} \|\|= JSON->new->utf8;
877		1159
878	sub {	1160	sub {
879	my $ref = $json->incr_parse ($self->{rbuf});	1161	my $ref = $json->incr_parse ($self->{rbuf});
880		1162
881	if ($ref) {	1163	if ($ref) {
…		…
889	()	1171	()
890	}	1172	}
891	}	1173	}
892	};	1174	};
893		1175
		1176	=item storable => $cb->($handle, $ref)
		1177
		1178	Deserialises a L<Storable> frozen representation as written by the
		1179	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1180	data).
		1181
		1182	Raises C<EBADMSG> error if the data could not be decoded.
		1183
		1184	=cut
		1185
		1186	register_read_type storable => sub {
		1187	my ($self, $cb) = @_;
		1188
		1189	require Storable;
		1190
		1191	sub {
		1192	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1193	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1194	or return;
		1195
		1196	my $format = length pack "w", $len;
		1197
		1198	# bypass unshift if we already have the remaining chunk
		1199	if ($format + $len <= length $_[0]{rbuf}) {
		1200	my $data = substr $_[0]{rbuf}, $format, $len;
		1201	substr $_[0]{rbuf}, 0, $format + $len, "";
		1202	$cb->($_[0], Storable::thaw ($data));
		1203	} else {
		1204	# remove prefix
		1205	substr $_[0]{rbuf}, 0, $format, "";
		1206
		1207	# read remaining chunk
		1208	$_[0]->unshift_read (chunk => $len, sub {
		1209	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1210	$cb->($_[0], $ref);
		1211	} else {
		1212	$self->_error (&Errno::EBADMSG);
		1213	}
		1214	});
		1215	}
		1216
		1217	1
		1218	}
		1219	};
		1220
894	=back	1221	=back
895		1222
896	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1223	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
897		1224
898	This function (not method) lets you add your own types to C<push_read>.	1225	This function (not method) lets you add your own types to C<push_read>.
…		…
916	=item $handle->stop_read	1243	=item $handle->stop_read
917		1244
918	=item $handle->start_read	1245	=item $handle->start_read
919		1246
920	In rare cases you actually do not want to read anything from the	1247	In rare cases you actually do not want to read anything from the
921	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1248	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
922	any queued callbacks will be executed then. To start reading again, call	1249	any queued callbacks will be executed then. To start reading again, call
923	C<start_read>.	1250	C<start_read>.
		1251
		1252	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1253	you change the C<on_read> callback or push/unshift a read callback, and it
		1254	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1255	there are any read requests in the queue.
924		1256
925	=cut	1257	=cut
926		1258
927	sub stop_read {	1259	sub stop_read {
928	my ($self) = @_;	1260	my ($self) = @_;
…		…
939	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1271	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
940	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1272	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
941	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1273	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
942		1274
943	if ($len > 0) {	1275	if ($len > 0) {
		1276	$self->{_activity} = AnyEvent->now;
		1277
944	$self->{filter_r}	1278	$self->{filter_r}
945	? $self->{filter_r}->($self, $rbuf)	1279	? $self->{filter_r}($self, $rbuf)
946	: $self->_drain_rbuf;	1280	: $self->{_in_drain} \|\| $self->_drain_rbuf;
947		1281
948	} elsif (defined $len) {	1282	} elsif (defined $len) {
949	delete $self->{_rw};	1283	delete $self->{_rw};
950	$self->{_eof} = 1;	1284	$self->{_eof} = 1;
951	$self->_drain_rbuf;	1285	$self->_drain_rbuf unless $self->{_in_drain};
952		1286
953	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1287	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
954	return $self->error;	1288	return $self->_error ($!, 1);
955	}	1289	}
956	});	1290	});
957	}	1291	}
958	}	1292	}
959		1293
960	sub _dotls {	1294	sub _dotls {
961	my ($self) = @_;	1295	my ($self) = @_;
		1296
		1297	my $buf;
962		1298
963	if (length $self->{_tls_wbuf}) {	1299	if (length $self->{_tls_wbuf}) {
964	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1300	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
965	substr $self->{_tls_wbuf}, 0, $len, "";	1301	substr $self->{_tls_wbuf}, 0, $len, "";
966	}	1302	}
967	}	1303	}
968		1304
969	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1305	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
970	$self->{wbuf} .= $buf;	1306	$self->{wbuf} .= $buf;
971	$self->_drain_wbuf;	1307	$self->_drain_wbuf;
972	}	1308	}
973		1309
974	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1310	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1311	if (length $buf) {
975	$self->{rbuf} .= $buf;	1312	$self->{rbuf} .= $buf;
976	$self->_drain_rbuf;	1313	$self->_drain_rbuf unless $self->{_in_drain};
		1314	} else {
		1315	# let's treat SSL-eof as we treat normal EOF
		1316	$self->{_eof} = 1;
		1317	$self->_shutdown;
		1318	return;
		1319	}
977	}	1320	}
978		1321
979	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1322	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
980		1323
981	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1324	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
982	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1325	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
983	$self->error;	1326	return $self->_error ($!, 1);
984	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1327	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
985	$! = &Errno::EIO;	1328	return $self->_error (&Errno::EIO, 1);
986	$self->error;
987	}	1329	}
988		1330
989	# all others are fine for our purposes	1331	# all others are fine for our purposes
990	}	1332	}
991	}	1333	}
…		…
1006	call and can be used or changed to your liking. Note that the handshake	1348	call and can be used or changed to your liking. Note that the handshake
1007	might have already started when this function returns.	1349	might have already started when this function returns.
1008		1350
1009	=cut	1351	=cut
1010		1352
1011	# TODO: maybe document...
1012	sub starttls {	1353	sub starttls {
1013	my ($self, $ssl, $ctx) = @_;	1354	my ($self, $ssl, $ctx) = @_;
1014		1355
1015	$self->stoptls;	1356	$self->stoptls;
1016		1357
…		…
1027	# basically, this is deep magic (because SSL_read should have the same issues)	1368	# basically, this is deep magic (because SSL_read should have the same issues)
1028	# but the openssl maintainers basically said: "trust us, it just works".	1369	# but the openssl maintainers basically said: "trust us, it just works".
1029	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1370	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1030	# and mismaintained ssleay-module doesn't even offer them).	1371	# and mismaintained ssleay-module doesn't even offer them).
1031	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1372	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1373	#
		1374	# in short: this is a mess.
		1375	#
		1376	# note that we do not try to kepe the length constant between writes as we are required to do.
		1377	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1378	# and we drive openssl fully in blocking mode here.
1032	Net::SSLeay::CTX_set_mode ($self->{tls},	1379	Net::SSLeay::CTX_set_mode ($self->{tls},
1033	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1380	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1034	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1381	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1035		1382
1036	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1383	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
…		…
1069		1416
1070	sub DESTROY {	1417	sub DESTROY {
1071	my $self = shift;	1418	my $self = shift;
1072		1419
1073	$self->stoptls;	1420	$self->stoptls;
		1421
		1422	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1423
		1424	if ($linger && length $self->{wbuf}) {
		1425	my $fh = delete $self->{fh};
		1426	my $wbuf = delete $self->{wbuf};
		1427
		1428	my @linger;
		1429
		1430	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1431	my $len = syswrite $fh, $wbuf, length $wbuf;
		1432
		1433	if ($len > 0) {
		1434	substr $wbuf, 0, $len, "";
		1435	} else {
		1436	@linger = (); # end
		1437	}
		1438	});
		1439	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1440	@linger = ();
		1441	});
		1442	}
1074	}	1443	}
1075		1444
1076	=item AnyEvent::Handle::TLS_CTX	1445	=item AnyEvent::Handle::TLS_CTX
1077		1446
1078	This function creates and returns the Net::SSLeay::CTX object used by	1447	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1120	=over 4	1489	=over 4
1121		1490
1122	=item * all constructor arguments become object members.	1491	=item * all constructor arguments become object members.
1123		1492
1124	At least initially, when you pass a C<tls>-argument to the constructor it	1493	At least initially, when you pass a C<tls>-argument to the constructor it
1125	will end up in C<< $handle->{tls} >>. Those members might be changes or	1494	will end up in C<< $handle->{tls} >>. Those members might be changed or
1126	mutated later on (for example C<tls> will hold the TLS connection object).	1495	mutated later on (for example C<tls> will hold the TLS connection object).
1127		1496
1128	=item * other object member names are prefixed with an C<_>.	1497	=item * other object member names are prefixed with an C<_>.
1129		1498
1130	All object members not explicitly documented (internal use) are prefixed	1499	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.40 by root, Tue May 27 05:36:27 2008 UTC vs. Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC