[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.86 by root, Thu Aug 21 20:41:16 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 (on demand), which will write and expect UTF-8 encoded JSON
		262	texts.
		263
		264	Note that you are responsible to depend on the JSON module if you want to
		265	use this functionality, as AnyEvent does not have a dependency itself.
		266
173	=item filter_r => $cb	267	=item filter_r => $cb
174		268
175	=item filter_w => $cb	269	=item filter_w => $cb
176		270
177	These exist, but are undocumented at this time.	271	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	286	if ($self->{tls}) {
193	require Net::SSLeay;	287	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	288	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	289	}
196		290
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	291	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	292	$self->_timeout;
		293
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	294	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	295	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
201		296
202	$self->start_read;	297	$self->start_read
		298	if $self->{on_read};
203		299
204	$self	300	$self
205	}	301	}
206		302
207	sub _shutdown {	303	sub _shutdown {
208	my ($self) = @_;	304	my ($self) = @_;
209		305
		306	delete $self->{_tw};
210	delete $self->{_rw};	307	delete $self->{_rw};
211	delete $self->{_ww};	308	delete $self->{_ww};
212	delete $self->{fh};	309	delete $self->{fh};
213	}
214		310
		311	$self->stoptls;
		312
		313	delete $self->{on_read};
		314	delete $self->{_queue};
		315	}
		316
215	sub error {	317	sub _error {
216	my ($self) = @_;	318	my ($self, $errno, $fatal) = @_;
217		319
218	{
219	local $!;
220	$self->_shutdown;	320	$self->_shutdown
221	}	321	if $fatal;
222		322
223	$self->{on_error}($self)	323	$! = $errno;
		324
224	if $self->{on_error};	325	if ($self->{on_error}) {
225		326	$self->{on_error}($self, $fatal);
		327	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	328	Carp::croak "AnyEvent::Handle uncaught error: $!";
		329	}
227	}	330	}
228		331
229	=item $fh = $handle->fh	332	=item $fh = $handle->fh
230		333
231	This method returns the file handle of the L<AnyEvent::Handle> object.	334	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
250		353
251	=cut	354	=cut
252		355
253	sub on_eof {	356	sub on_eof {
254	$_[0]{on_eof} = $_[1];	357	$_[0]{on_eof} = $_[1];
		358	}
		359
		360	=item $handle->on_timeout ($cb)
		361
		362	Replace the current C<on_timeout> callback, or disables the callback
		363	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		364	argument.
		365
		366	=cut
		367
		368	sub on_timeout {
		369	$_[0]{on_timeout} = $_[1];
		370	}
		371
		372	=item $handle->autocork ($boolean)
		373
		374	Enables or disables the current autocork behaviour (see C<autocork>
		375	constructor argument).
		376
		377	=cut
		378
		379	=item $handle->no_delay ($boolean)
		380
		381	Enables or disables the C<no_delay> setting (see constructor argument of
		382	the same name for details).
		383
		384	=cut
		385
		386	sub no_delay {
		387	$_[0]{no_delay} = $_[1];
		388
		389	eval {
		390	local $SIG{__DIE__};
		391	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		392	};
		393	}
		394
		395	#############################################################################
		396
		397	=item $handle->timeout ($seconds)
		398
		399	Configures (or disables) the inactivity timeout.
		400
		401	=cut
		402
		403	sub timeout {
		404	my ($self, $timeout) = @_;
		405
		406	$self->{timeout} = $timeout;
		407	$self->_timeout;
		408	}
		409
		410	# reset the timeout watcher, as neccessary
		411	# also check for time-outs
		412	sub _timeout {
		413	my ($self) = @_;
		414
		415	if ($self->{timeout}) {
		416	my $NOW = AnyEvent->now;
		417
		418	# when would the timeout trigger?
		419	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		420
		421	# now or in the past already?
		422	if ($after <= 0) {
		423	$self->{_activity} = $NOW;
		424
		425	if ($self->{on_timeout}) {
		426	$self->{on_timeout}($self);
		427	} else {
		428	$self->_error (&Errno::ETIMEDOUT);
		429	}
		430
		431	# callback could have changed timeout value, optimise
		432	return unless $self->{timeout};
		433
		434	# calculate new after
		435	$after = $self->{timeout};
		436	}
		437
		438	Scalar::Util::weaken $self;
		439	return unless $self; # ->error could have destroyed $self
		440
		441	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		442	delete $self->{_tw};
		443	$self->_timeout;
		444	});
		445	} else {
		446	delete $self->{_tw};
		447	}
255	}	448	}
256		449
257	#############################################################################	450	#############################################################################
258		451
259	=back	452	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	499	my $len = syswrite $self->{fh}, $self->{wbuf};
307		500
308	if ($len >= 0) {	501	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	502	substr $self->{wbuf}, 0, $len, "";
310		503
		504	$self->{_activity} = AnyEvent->now;
		505
311	$self->{on_drain}($self)	506	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	507	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	508	&& $self->{on_drain};
314		509
315	delete $self->{_ww} unless length $self->{wbuf};	510	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	511	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	512	$self->_error ($!, 1);
318	}	513	}
319	};	514	};
320		515
321	# try to write data immediately	516	# try to write data immediately
322	$cb->();	517	$cb->() unless $self->{autocork};
323		518
324	# if still data left in wbuf, we need to poll	519	# if still data left in wbuf, we need to poll
325	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	520	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
326	if length $self->{wbuf};	521	if length $self->{wbuf};
327	};	522	};
…		…
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	537	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	538	->($self, @_);
344	}	539	}
345		540
346	if ($self->{filter_w}) {	541	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	542	$self->{filter_w}($self, \$_[0]);
348	} else {	543	} else {
349	$self->{wbuf} .= $_[0];	544	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	545	$self->_drain_wbuf;
351	}	546	}
352	}	547	}
353		548
354	=item $handle->push_write (type => @args)	549	=item $handle->push_write (type => @args)
355		550
356	=item $handle->unshift_write (type => @args)
357
358	Instead of formatting your data yourself, you can also let this module do	551	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	552	the job by specifying a type and type-specific arguments.
360		553
361	Predefined types are (if you have ideas for additional types, feel free to	554	Predefined types are (if you have ideas for additional types, feel free to
362	drop by and tell us):	555	drop by and tell us):
…		…
366	=item netstring => $string	559	=item netstring => $string
367		560
368	Formats the given value as netstring	561	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	562	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		563
371	=back
372
373	=cut	564	=cut
374		565
375	register_write_type netstring => sub {	566	register_write_type netstring => sub {
376	my ($self, $string) = @_;	567	my ($self, $string) = @_;
377		568
378	sprintf "%d:%s,", (length $string), $string	569	sprintf "%d:%s,", (length $string), $string
379	};	570	};
380		571
		572	=item packstring => $format, $data
		573
		574	An octet string prefixed with an encoded length. The encoding C<$format>
		575	uses the same format as a Perl C<pack> format, but must specify a single
		576	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		577	optional C<!>, C<< < >> or C<< > >> modifier).
		578
		579	=cut
		580
		581	register_write_type packstring => sub {
		582	my ($self, $format, $string) = @_;
		583
		584	pack "$format/a*", $string
		585	};
		586
		587	=item json => $array_or_hashref
		588
		589	Encodes the given hash or array reference into a JSON object. Unless you
		590	provide your own JSON object, this means it will be encoded to JSON text
		591	in UTF-8.
		592
		593	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		594	one end of a handle and read them at the other end without using any
		595	additional framing.
		596
		597	The generated JSON text is guaranteed not to contain any newlines: While
		598	this module doesn't need delimiters after or between JSON texts to be
		599	able to read them, many other languages depend on that.
		600
		601	A simple RPC protocol that interoperates easily with others is to send
		602	JSON arrays (or objects, although arrays are usually the better choice as
		603	they mimic how function argument passing works) and a newline after each
		604	JSON text:
		605
		606	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		607	$handle->push_write ("\012");
		608
		609	An AnyEvent::Handle receiver would simply use the C<json> read type and
		610	rely on the fact that the newline will be skipped as leading whitespace:
		611
		612	$handle->push_read (json => sub { my $array = $_[1]; ... });
		613
		614	Other languages could read single lines terminated by a newline and pass
		615	this line into their JSON decoder of choice.
		616
		617	=cut
		618
		619	register_write_type json => sub {
		620	my ($self, $ref) = @_;
		621
		622	require JSON;
		623
		624	$self->{json} ? $self->{json}->encode ($ref)
		625	: JSON::encode_json ($ref)
		626	};
		627
		628	=item storable => $reference
		629
		630	Freezes the given reference using L<Storable> and writes it to the
		631	handle. Uses the C<nfreeze> format.
		632
		633	=cut
		634
		635	register_write_type storable => sub {
		636	my ($self, $ref) = @_;
		637
		638	require Storable;
		639
		640	pack "w/a*", Storable::nfreeze ($ref)
		641	};
		642
		643	=back
		644
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	645	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		646
383	This function (not method) lets you add your own types to C<push_write>.	647	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	648	Whenever the given C<type> is used, C<push_write> will invoke the code
385	reference with the handle object and the remaining arguments.	649	reference with the handle object and the remaining arguments.
386		650
…		…
405	ways, the "simple" way, using only C<on_read> and the "complex" way, using	669	ways, the "simple" way, using only C<on_read> and the "complex" way, using
406	a queue.	670	a queue.
407		671
408	In the simple case, you just install an C<on_read> callback and whenever	672	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	673	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	674	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
411	or not.	675	leave the data there if you want to accumulate more (e.g. when only a
		676	partial message has been received so far).
412		677
413	In the more complex case, you want to queue multiple callbacks. In this	678	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	679	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>,	680	data arrives (also the first time it is queued) and removes it when it has
416	below).	681	done its job (see C<push_read>, below).
417		682
418	This way you can, for example, push three line-reads, followed by reading	683	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.	684	a chunk of data, and AnyEvent::Handle will execute them in order.
420		685
421	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	686	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
422	the specified number of bytes which give an XML datagram.	687	the specified number of bytes which give an XML datagram.
423		688
424	# in the default state, expect some header bytes	689	# in the default state, expect some header bytes
425	$handle->on_read (sub {	690	$handle->on_read (sub {
426	# some data is here, now queue the length-header-read (4 octets)	691	# some data is here, now queue the length-header-read (4 octets)
427	shift->unshift_read_chunk (4, sub {	692	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	693	# header arrived, decode
429	my $len = unpack "N", $_[1];	694	my $len = unpack "N", $_[1];
430		695
431	# now read the payload	696	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	697	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	698	my $xml = $_[1];
434	# handle xml	699	# handle xml
435	});	700	});
436	});	701	});
437	});	702	});
438		703
439	Example 2: Implement a client for a protocol that replies either with	704	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	705	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	706	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	707	just pipeline sending both requests and manipulate the queue as necessary
443	the callbacks:	708	in the callbacks.
444		709
445	# request one	710	When the first callback is called and sees an "OK" response, it will
		711	C<unshift> another line-read. This line-read will be queued I<before> the
		712	64-byte chunk callback.
		713
		714	# request one, returns either "OK + extra line" or "ERROR"
446	$handle->push_write ("request 1\015\012");	715	$handle->push_write ("request 1\015\012");
447		716
448	# we expect "ERROR" or "OK" as response, so push a line read	717	# we expect "ERROR" or "OK" as response, so push a line read
449	$handle->push_read_line (sub {	718	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	719	# 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	720	# 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	721	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	722	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	723	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	724	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	725	my $response = $_[1];
457	...	726	...
458	});	727	});
459	}	728	}
460	});	729	});
461		730
462	# request two	731	# request two, simply returns 64 octets
463	$handle->push_write ("request 2\015\012");	732	$handle->push_write ("request 2\015\012");
464		733
465	# simply read 64 bytes, always	734	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	735	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	736	my $response = $_[1];
468	...	737	...
469	});	738	});
470		739
471	=over 4	740	=over 4
472		741
473	=cut	742	=cut
474		743
475	sub _drain_rbuf {	744	sub _drain_rbuf {
476	my ($self) = @_;	745	my ($self) = @_;
		746
		747	local $self->{_in_drain} = 1;
477		748
478	if (	749	if (
479	defined $self->{rbuf_max}	750	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	751	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	752	) {
482	$! = &Errno::ENOSPC;	753	$self->_error (&Errno::ENOSPC, 1), return;
483	$self->error;
484	}	754	}
485		755
486	return if $self->{in_drain};	756	while () {
487	local $self->{in_drain} = 1;
488
489	while (my $len = length $self->{rbuf}) {	757	my $len = length $self->{rbuf};
490	no strict 'refs';	758
491	if (my $cb = shift @{ $self->{_queue} }) {	759	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	760	unless ($cb->($self)) {
493	if ($self->{_eof}) {	761	if ($self->{_eof}) {
494	# no progress can be made (not enough data and no data forthcoming)	762	# no progress can be made (not enough data and no data forthcoming)
495	$! = &Errno::EPIPE;	763	$self->_error (&Errno::EPIPE, 1), return;
496	$self->error;
497	}	764	}
498		765
499	unshift @{ $self->{_queue} }, $cb;	766	unshift @{ $self->{_queue} }, $cb;
500	return;	767	last;
501	}	768	}
502	} elsif ($self->{on_read}) {	769	} elsif ($self->{on_read}) {
		770	last unless $len;
		771
503	$self->{on_read}($self);	772	$self->{on_read}($self);
504		773
505	if (	774	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	775	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	776	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	777	&& $self->{on_read} # but we still have on_read
510	) {	778	) {
		779	# no further data will arrive
511	# then no progress can be made	780	# so no progress can be made
512	$! = &Errno::EPIPE;	781	$self->_error (&Errno::EPIPE, 1), return
513	$self->error;	782	if $self->{_eof};
		783
		784	last; # more data might arrive
514	}	785	}
515	} else {	786	} else {
516	# read side becomes idle	787	# read side becomes idle
517	delete $self->{_rw};	788	delete $self->{_rw};
518	return;	789	last;
519	}	790	}
520	}	791	}
521		792
522	if ($self->{_eof}) {	793	if ($self->{_eof}) {
523	$self->_shutdown;	794	if ($self->{on_eof}) {
524	$self->{on_eof}($self)	795	$self->{on_eof}($self)
525	if $self->{on_eof};	796	} else {
		797	$self->_error (0, 1);
		798	}
		799	}
		800
		801	# may need to restart read watcher
		802	unless ($self->{_rw}) {
		803	$self->start_read
		804	if $self->{on_read} \|\| @{ $self->{_queue} };
526	}	805	}
527	}	806	}
528		807
529	=item $handle->on_read ($cb)	808	=item $handle->on_read ($cb)
530		809
…		…
536		815
537	sub on_read {	816	sub on_read {
538	my ($self, $cb) = @_;	817	my ($self, $cb) = @_;
539		818
540	$self->{on_read} = $cb;	819	$self->{on_read} = $cb;
		820	$self->_drain_rbuf if $cb && !$self->{_in_drain};
541	}	821	}
542		822
543	=item $handle->rbuf	823	=item $handle->rbuf
544		824
545	Returns the read buffer (as a modifiable lvalue).	825	Returns the read buffer (as a modifiable lvalue).
…		…
594	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	874	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
595	->($self, $cb, @_);	875	->($self, $cb, @_);
596	}	876	}
597		877
598	push @{ $self->{_queue} }, $cb;	878	push @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	879	$self->_drain_rbuf unless $self->{_in_drain};
600	}	880	}
601		881
602	sub unshift_read {	882	sub unshift_read {
603	my $self = shift;	883	my $self = shift;
604	my $cb = pop;	884	my $cb = pop;
…		…
610	->($self, $cb, @_);	890	->($self, $cb, @_);
611	}	891	}
612		892
613		893
614	unshift @{ $self->{_queue} }, $cb;	894	unshift @{ $self->{_queue} }, $cb;
615	$self->_drain_rbuf;	895	$self->_drain_rbuf unless $self->{_in_drain};
616	}	896	}
617		897
618	=item $handle->push_read (type => @args, $cb)	898	=item $handle->push_read (type => @args, $cb)
619		899
620	=item $handle->unshift_read (type => @args, $cb)	900	=item $handle->unshift_read (type => @args, $cb)
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	906	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	907	drop by and tell us):
628		908
629	=over 4	909	=over 4
630		910
631	=item chunk => $octets, $cb->($self, $data)	911	=item chunk => $octets, $cb->($handle, $data)
632		912
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	913	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	914	data read to the callback. The callback will never be called with less
635	data.	915	data.
636		916
…		…
650	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	930	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
651	1	931	1
652	}	932	}
653	};	933	};
654		934
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)	935	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		936
666	The callback will be called only once a full line (including the end of	937	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	938	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	939	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>).	940	the end of line marker as the third argument (C<$eol>).
…		…
683	=cut	954	=cut
684		955
685	register_read_type line => sub {	956	register_read_type line => sub {
686	my ($self, $cb, $eol) = @_;	957	my ($self, $cb, $eol) = @_;
687		958
688	$eol = qr\|(\015?\012)\| if @_ < 3;	959	if (@_ < 3) {
		960	# this is more than twice as fast as the generic code below
		961	sub {
		962	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		963
		964	$cb->($_[0], $1, $2);
		965	1
		966	}
		967	} else {
689	$eol = quotemeta $eol unless ref $eol;	968	$eol = quotemeta $eol unless ref $eol;
690	$eol = qr\|^(.*?)($eol)\|s;	969	$eol = qr\|^(.*?)($eol)\|s;
691		970
692	sub {	971	sub {
693	$_[0]{rbuf} =~ s/$eol// or return;	972	$_[0]{rbuf} =~ s/$eol// or return;
694		973
695	$cb->($_[0], $1, $2);	974	$cb->($_[0], $1, $2);
		975	1
696	1	976	}
697	}	977	}
698	};	978	};
699		979
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)	980	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		981
751	Makes a regex match against the regex object C<$accept> and returns	982	Makes a regex match against the regex object C<$accept> and returns
752	everything up to and including the match.	983	everything up to and including the match.
753		984
754	Example: read a single line terminated by '\n'.	985	Example: read a single line terminated by '\n'.
…		…
802	return 1;	1033	return 1;
803	}	1034	}
804		1035
805	# reject	1036	# reject
806	if ($reject && $$rbuf =~ $reject) {	1037	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	1038	$self->_error (&Errno::EBADMSG);
808	$self->error;
809	}	1039	}
810		1040
811	# skip	1041	# skip
812	if ($skip && $$rbuf =~ $skip) {	1042	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	1043	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		1045
816	()	1046	()
817	}	1047	}
818	};	1048	};
819		1049
		1050	=item netstring => $cb->($handle, $string)
		1051
		1052	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1053
		1054	Throws an error with C<$!> set to EBADMSG on format violations.
		1055
		1056	=cut
		1057
		1058	register_read_type netstring => sub {
		1059	my ($self, $cb) = @_;
		1060
		1061	sub {
		1062	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1063	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1064	$self->_error (&Errno::EBADMSG);
		1065	}
		1066	return;
		1067	}
		1068
		1069	my $len = $1;
		1070
		1071	$self->unshift_read (chunk => $len, sub {
		1072	my $string = $_[1];
		1073	$_[0]->unshift_read (chunk => 1, sub {
		1074	if ($_[1] eq ",") {
		1075	$cb->($_[0], $string);
		1076	} else {
		1077	$self->_error (&Errno::EBADMSG);
		1078	}
		1079	});
		1080	});
		1081
		1082	1
		1083	}
		1084	};
		1085
		1086	=item packstring => $format, $cb->($handle, $string)
		1087
		1088	An octet string prefixed with an encoded length. The encoding C<$format>
		1089	uses the same format as a Perl C<pack> format, but must specify a single
		1090	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1091	optional C<!>, C<< < >> or C<< > >> modifier).
		1092
		1093	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1094
		1095	Example: read a block of data prefixed by its length in BER-encoded
		1096	format (very efficient).
		1097
		1098	$handle->push_read (packstring => "w", sub {
		1099	my ($handle, $data) = @_;
		1100	});
		1101
		1102	=cut
		1103
		1104	register_read_type packstring => sub {
		1105	my ($self, $cb, $format) = @_;
		1106
		1107	sub {
		1108	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1109	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1110	or return;
		1111
		1112	$format = length pack $format, $len;
		1113
		1114	# bypass unshift if we already have the remaining chunk
		1115	if ($format + $len <= length $_[0]{rbuf}) {
		1116	my $data = substr $_[0]{rbuf}, $format, $len;
		1117	substr $_[0]{rbuf}, 0, $format + $len, "";
		1118	$cb->($_[0], $data);
		1119	} else {
		1120	# remove prefix
		1121	substr $_[0]{rbuf}, 0, $format, "";
		1122
		1123	# read remaining chunk
		1124	$_[0]->unshift_read (chunk => $len, $cb);
		1125	}
		1126
		1127	1
		1128	}
		1129	};
		1130
		1131	=item json => $cb->($handle, $hash_or_arrayref)
		1132
		1133	Reads a JSON object or array, decodes it and passes it to the callback.
		1134
		1135	If a C<json> object was passed to the constructor, then that will be used
		1136	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1137
		1138	This read type uses the incremental parser available with JSON version
		1139	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1140	dependency on your own: this module will load the JSON module, but
		1141	AnyEvent does not depend on it itself.
		1142
		1143	Since JSON texts are fully self-delimiting, the C<json> read and write
		1144	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1145	the C<json> write type description, above, for an actual example.
		1146
		1147	=cut
		1148
		1149	register_read_type json => sub {
		1150	my ($self, $cb) = @_;
		1151
		1152	require JSON;
		1153
		1154	my $data;
		1155	my $rbuf = \$self->{rbuf};
		1156
		1157	my $json = $self->{json} \|\|= JSON->new->utf8;
		1158
		1159	sub {
		1160	my $ref = $json->incr_parse ($self->{rbuf});
		1161
		1162	if ($ref) {
		1163	$self->{rbuf} = $json->incr_text;
		1164	$json->incr_text = "";
		1165	$cb->($self, $ref);
		1166
		1167	1
		1168	} else {
		1169	$self->{rbuf} = "";
		1170	()
		1171	}
		1172	}
		1173	};
		1174
		1175	=item storable => $cb->($handle, $ref)
		1176
		1177	Deserialises a L<Storable> frozen representation as written by the
		1178	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1179	data).
		1180
		1181	Raises C<EBADMSG> error if the data could not be decoded.
		1182
		1183	=cut
		1184
		1185	register_read_type storable => sub {
		1186	my ($self, $cb) = @_;
		1187
		1188	require Storable;
		1189
		1190	sub {
		1191	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1192	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1193	or return;
		1194
		1195	my $format = length pack "w", $len;
		1196
		1197	# bypass unshift if we already have the remaining chunk
		1198	if ($format + $len <= length $_[0]{rbuf}) {
		1199	my $data = substr $_[0]{rbuf}, $format, $len;
		1200	substr $_[0]{rbuf}, 0, $format + $len, "";
		1201	$cb->($_[0], Storable::thaw ($data));
		1202	} else {
		1203	# remove prefix
		1204	substr $_[0]{rbuf}, 0, $format, "";
		1205
		1206	# read remaining chunk
		1207	$_[0]->unshift_read (chunk => $len, sub {
		1208	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1209	$cb->($_[0], $ref);
		1210	} else {
		1211	$self->_error (&Errno::EBADMSG);
		1212	}
		1213	});
		1214	}
		1215
		1216	1
		1217	}
		1218	};
		1219
820	=back	1220	=back
821		1221
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1222	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1223
824	This function (not method) lets you add your own types to C<push_read>.	1224	This function (not method) lets you add your own types to C<push_read>.
825		1225
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1226	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	1227	reference with the handle object, the callback and the remaining
…		…
829		1229
830	The code reference is supposed to return a callback (usually a closure)	1230	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) >>).	1231	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1232
833	It should invoke the passed callback when it is done reading (remember to	1233	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).	1234	pass C<$handle> as first argument as all other callbacks do that).
835		1235
836	Note that this is a function, and all types registered this way will be	1236	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1237	global, so try to use unique names.
838		1238
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1239	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
842	=item $handle->stop_read	1242	=item $handle->stop_read
843		1243
844	=item $handle->start_read	1244	=item $handle->start_read
845		1245
846	In rare cases you actually do not want to read anything from the	1246	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	1247	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	1248	any queued callbacks will be executed then. To start reading again, call
849	C<start_read>.	1249	C<start_read>.
		1250
		1251	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1252	you change the C<on_read> callback or push/unshift a read callback, and it
		1253	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1254	there are any read requests in the queue.
850		1255
851	=cut	1256	=cut
852		1257
853	sub stop_read {	1258	sub stop_read {
854	my ($self) = @_;	1259	my ($self) = @_;
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1270	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1271	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1272	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
868		1273
869	if ($len > 0) {	1274	if ($len > 0) {
		1275	$self->{_activity} = AnyEvent->now;
		1276
870	$self->{filter_r}	1277	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1278	? $self->{filter_r}($self, $rbuf)
872	: $self->_drain_rbuf;	1279	: $self->{_in_drain} \|\| $self->_drain_rbuf;
873		1280
874	} elsif (defined $len) {	1281	} elsif (defined $len) {
875	delete $self->{_rw};	1282	delete $self->{_rw};
876	$self->{_eof} = 1;	1283	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1284	$self->_drain_rbuf unless $self->{_in_drain};
878		1285
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1286	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1287	return $self->_error ($!, 1);
881	}	1288	}
882	});	1289	});
883	}	1290	}
884	}	1291	}
885		1292
886	sub _dotls {	1293	sub _dotls {
887	my ($self) = @_;	1294	my ($self) = @_;
		1295
		1296	my $buf;
888		1297
889	if (length $self->{_tls_wbuf}) {	1298	if (length $self->{_tls_wbuf}) {
890	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1299	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1300	substr $self->{_tls_wbuf}, 0, $len, "";
892	}	1301	}
893	}	1302	}
894		1303
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1304	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1305	$self->{wbuf} .= $buf;
897	$self->_drain_wbuf;	1306	$self->_drain_wbuf;
898	}	1307	}
899		1308
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1309	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1310	if (length $buf) {
901	$self->{rbuf} .= $buf;	1311	$self->{rbuf} .= $buf;
902	$self->_drain_rbuf;	1312	$self->_drain_rbuf unless $self->{_in_drain};
		1313	} else {
		1314	# let's treat SSL-eof as we treat normal EOF
		1315	$self->{_eof} = 1;
		1316	$self->_shutdown;
		1317	return;
		1318	}
903	}	1319	}
904		1320
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1321	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906		1322
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1323	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1324	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;	1325	return $self->_error ($!, 1);
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1326	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;	1327	return $self->_error (&Errno::EIO, 1);
912	$self->error;
913	}	1328	}
914		1329
915	# all others are fine for our purposes	1330	# all others are fine for our purposes
916	}	1331	}
917	}	1332	}
…		…
932	call and can be used or changed to your liking. Note that the handshake	1347	call and can be used or changed to your liking. Note that the handshake
933	might have already started when this function returns.	1348	might have already started when this function returns.
934		1349
935	=cut	1350	=cut
936		1351
937	# TODO: maybe document...
938	sub starttls {	1352	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1353	my ($self, $ssl, $ctx) = @_;
940		1354
941	$self->stoptls;	1355	$self->stoptls;
942		1356
…		…
995		1409
996	sub DESTROY {	1410	sub DESTROY {
997	my $self = shift;	1411	my $self = shift;
998		1412
999	$self->stoptls;	1413	$self->stoptls;
		1414
		1415	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1416
		1417	if ($linger && length $self->{wbuf}) {
		1418	my $fh = delete $self->{fh};
		1419	my $wbuf = delete $self->{wbuf};
		1420
		1421	my @linger;
		1422
		1423	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1424	my $len = syswrite $fh, $wbuf, length $wbuf;
		1425
		1426	if ($len > 0) {
		1427	substr $wbuf, 0, $len, "";
		1428	} else {
		1429	@linger = (); # end
		1430	}
		1431	});
		1432	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1433	@linger = ();
		1434	});
		1435	}
1000	}	1436	}
1001		1437
1002	=item AnyEvent::Handle::TLS_CTX	1438	=item AnyEvent::Handle::TLS_CTX
1003		1439
1004	This function creates and returns the Net::SSLeay::CTX object used by	1440	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1046	=over 4	1482	=over 4
1047		1483
1048	=item * all constructor arguments become object members.	1484	=item * all constructor arguments become object members.
1049		1485
1050	At least initially, when you pass a C<tls>-argument to the constructor it	1486	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	1487	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).	1488	mutated later on (for example C<tls> will hold the TLS connection object).
1053		1489
1054	=item * other object member names are prefixed with an C<_>.	1490	=item * other object member names are prefixed with an C<_>.
1055		1491
1056	All object members not explicitly documented (internal use) are prefixed	1492	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.86 by root, Thu Aug 21 20:41:16 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.86 by root, Thu Aug 21 20:41:16 2008 UTC