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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.83 by root, Thu Aug 21 19:11:37 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;
70		70
71	=item fh => $filehandle [MANDATORY]	71	=item fh => $filehandle [MANDATORY]
72		72
73	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
74		74
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	76	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		77	that mode.
77		78
78	=item on_eof => $cb->($self)	79	=item on_eof => $cb->($handle)
79		80
80	Set the callback to be called on EOF.	81	Set the callback to be called when an end-of-file condition is detected,
		82	i.e. in the case of a socket, when the other side has closed the
		83	connection cleanly.
81		84
		85	For sockets, this just means that the other side has stopped sending data,
		86	you can still try to write data, and, in fact, one can return from the eof
		87	callback and continue writing data, as only the read part has been shut
		88	down.
		89
82	While not mandatory, it is highly recommended to set an eof callback,	90	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	91	otherwise you might end up with a closed socket while you are still
84	waiting for data.	92	waiting for data.
85		93
		94	If an EOF condition has been detected but no C<on_eof> callback has been
		95	set, then a fatal error will be raised with C<$!> set to <0>.
		96
86	=item on_error => $cb->($self)	97	=item on_error => $cb->($handle, $fatal)
87		98
88	This is the fatal error callback, that is called when, well, a fatal error	99	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	100	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	101	connect or a read error.
91		102
92	The object will not be in a usable state when this callback has been	103	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	104	fatal errors the handle object will be shut down and will not be usable
		105	(but you are free to look at the current C< ->rbuf >). Examples of fatal
		106	errors are an EOF condition with active (but unsatisifable) read watchers
		107	(C<EPIPE>) or I/O errors.
		108
		109	Non-fatal errors can be retried by simply returning, but it is recommended
		110	to simply ignore this parameter and instead abondon the handle object
		111	when this callback is invoked. Examples of non-fatal errors are timeouts
		112	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		113
95	On callback entrance, the value of C<$!> contains the operating system	114	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	115	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callbakc should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		116
101	While not mandatory, it is I<highly> recommended to set this callback, as	117	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	118	you will not be notified of errors otherwise. The default simply calls
103	die.	119	C<croak>.
104		120
105	=item on_read => $cb->($self)	121	=item on_read => $cb->($handle)
106		122
107	This sets the default read callback, which is called when data arrives	123	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	124	and no read request is in the queue (unlike read queue callbacks, this
		125	callback will only be called when at least one octet of data is in the
		126	read buffer).
109		127
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	128	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$self->{rbuf}> member directly.	129	method or access the C<$handle->{rbuf}> member directly.
112		130
113	When an EOF condition is detected then AnyEvent::Handle will first try to	131	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	132	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	133	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>).	134	error will be raised (with C<$!> set to C<EPIPE>).
117		135
118	=item on_drain => $cb->()	136	=item on_drain => $cb->($handle)
119		137
120	This sets the callback that is called when the write buffer becomes empty	138	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).	139	(or when the callback is set and the buffer is empty already).
122		140
123	To append to the write buffer, use the C<< ->push_write >> method.	141	To append to the write buffer, use the C<< ->push_write >> method.
		142
		143	This callback is useful when you don't want to put all of your write data
		144	into the queue at once, for example, when you want to write the contents
		145	of some file to the socket you might not want to read the whole file into
		146	memory and push it into the queue, but instead only read more data from
		147	the file when the write queue becomes empty.
		148
		149	=item timeout => $fractional_seconds
		150
		151	If non-zero, then this enables an "inactivity" timeout: whenever this many
		152	seconds pass without a successful read or write on the underlying file
		153	handle, the C<on_timeout> callback will be invoked (and if that one is
		154	missing, an C<ETIMEDOUT> error will be raised).
		155
		156	Note that timeout processing is also active when you currently do not have
		157	any outstanding read or write requests: If you plan to keep the connection
		158	idle then you should disable the timout temporarily or ignore the timeout
		159	in the C<on_timeout> callback.
		160
		161	Zero (the default) disables this timeout.
		162
		163	=item on_timeout => $cb->($handle)
		164
		165	Called whenever the inactivity timeout passes. If you return from this
		166	callback, then the timeout will be reset as if some activity had happened,
		167	so this condition is not fatal in any way.
124		168
125	=item rbuf_max => <bytes>	169	=item rbuf_max => <bytes>
126		170
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	171	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	172	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	176	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	177	(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	178	amount of data without a callback ever being called as long as the line
135	isn't finished).	179	isn't finished).
136		180
		181	=item autocork => <boolean>
		182
		183	When disabled (the default), then C<push_write> will try to immediately
		184	write the data to the handle if possible. This avoids having to register
		185	a write watcher and wait for the next event loop iteration, but can be
		186	inefficient if you write multiple small chunks (this disadvantage is
		187	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		188
		189	When enabled, then writes will always be queued till the next event loop
		190	iteration. This is efficient when you do many small writes per iteration,
		191	but less efficient when you do a single write only.
		192
		193	=item no_delay => <boolean>
		194
		195	When doing small writes on sockets, your operating system kernel might
		196	wait a bit for more data before actually sending it out. This is called
		197	the Nagle algorithm, and usually it is beneficial.
		198
		199	In some situations you want as low a delay as possible, which cna be
		200	accomplishd by setting this option to true.
		201
		202	The default is your opertaing system's default behaviour, this option
		203	explicitly enables or disables it, if possible.
		204
137	=item read_size => <bytes>	205	=item read_size => <bytes>
138		206
139	The default read block size (the amount of bytes this module will try to read	207	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	208	during each (loop iteration). Default: C<8192>.
141		209
142	=item low_water_mark => <bytes>	210	=item low_water_mark => <bytes>
143		211
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	212	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	213	buffer: If the write reaches this size or gets even samller it is
146	considered empty.	214	considered empty.
		215
		216	=item linger => <seconds>
		217
		218	If non-zero (default: C<3600>), then the destructor of the
		219	AnyEvent::Handle object will check wether there is still outstanding write
		220	data and will install a watcher that will write out this data. No errors
		221	will be reported (this mostly matches how the operating system treats
		222	outstanding data at socket close time).
		223
		224	This will not work for partial TLS data that could not yet been
		225	encoded. This data will be lost.
147		226
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	227	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		228
150	When this parameter is given, it enables TLS (SSL) mode, that means it	229	When this parameter is given, it enables TLS (SSL) mode, that means it
151	will start making tls handshake and will transparently encrypt/decrypt	230	will start making tls handshake and will transparently encrypt/decrypt
…		…
160	You can also provide your own TLS connection object, but you have	239	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>	240	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	241	or C<Net::SSLeay::set_accept_state> on it before you pass it to
163	AnyEvent::Handle.	242	AnyEvent::Handle.
164		243
165	See the C<starttls> method if you need to start TLs negotiation later.	244	See the C<starttls> method if you need to start TLS negotiation later.
166		245
167	=item tls_ctx => $ssl_ctx	246	=item tls_ctx => $ssl_ctx
168		247
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	248	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	249	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	250	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		251
		252	=item json => JSON or JSON::XS object
		253
		254	This is the json coder object used by the C<json> read and write types.
		255
		256	If you don't supply it, then AnyEvent::Handle will create and use a
		257	suitable one, which will write and expect UTF-8 encoded JSON texts.
		258
		259	Note that you are responsible to depend on the JSON module if you want to
		260	use this functionality, as AnyEvent does not have a dependency itself.
		261
		262	=item filter_r => $cb
		263
		264	=item filter_w => $cb
		265
		266	These exist, but are undocumented at this time.
		267
173	=back	268	=back
174		269
175	=cut	270	=cut
176		271
177	sub new {	272	sub new {
…		…
186	if ($self->{tls}) {	281	if ($self->{tls}) {
187	require Net::SSLeay;	282	require Net::SSLeay;
188	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	283	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
189	}	284	}
190		285
191	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	286	$self->{_activity} = AnyEvent->now;
192	$self->on_error (delete $self->{on_error}) if $self->{on_error};	287	$self->_timeout;
		288
193	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	289	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
194	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	290	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
195		291
196	$self->start_read;	292	$self->start_read
		293	if $self->{on_read};
197		294
198	$self	295	$self
199	}	296	}
200		297
201	sub _shutdown {	298	sub _shutdown {
202	my ($self) = @_;	299	my ($self) = @_;
203		300
		301	delete $self->{_tw};
204	delete $self->{rw};	302	delete $self->{_rw};
205	delete $self->{ww};	303	delete $self->{_ww};
206	delete $self->{fh};	304	delete $self->{fh};
207	}
208		305
		306	$self->stoptls;
		307
		308	delete $self->{on_read};
		309	delete $self->{_queue};
		310	}
		311
209	sub error {	312	sub _error {
210	my ($self) = @_;	313	my ($self, $errno, $fatal) = @_;
211		314
212	{
213	local $!;
214	$self->_shutdown;	315	$self->_shutdown
215	}	316	if $fatal;
216		317
217	$self->{on_error}($self)	318	$! = $errno;
		319
218	if $self->{on_error};	320	if ($self->{on_error}) {
219		321	$self->{on_error}($self, $fatal);
		322	} else {
220	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	323	Carp::croak "AnyEvent::Handle uncaught error: $!";
		324	}
221	}	325	}
222		326
223	=item $fh = $handle->fh	327	=item $fh = $handle->fh
224		328
225	This method returns the file handle of the L<AnyEvent::Handle> object.	329	This method returns the file handle of the L<AnyEvent::Handle> object.
226		330
227	=cut	331	=cut
228		332
229	sub fh { $_[0]->{fh} }	333	sub fh { $_[0]{fh} }
230		334
231	=item $handle->on_error ($cb)	335	=item $handle->on_error ($cb)
232		336
233	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	337	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
234		338
…		…
244		348
245	=cut	349	=cut
246		350
247	sub on_eof {	351	sub on_eof {
248	$_[0]{on_eof} = $_[1];	352	$_[0]{on_eof} = $_[1];
		353	}
		354
		355	=item $handle->on_timeout ($cb)
		356
		357	Replace the current C<on_timeout> callback, or disables the callback
		358	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		359	argument.
		360
		361	=cut
		362
		363	sub on_timeout {
		364	$_[0]{on_timeout} = $_[1];
		365	}
		366
		367	=item $handle->autocork ($boolean)
		368
		369	Enables or disables the current autocork behaviour (see C<autocork>
		370	constructor argument).
		371
		372	=cut
		373
		374	=item $handle->no_delay ($boolean)
		375
		376	Enables or disables the C<no_delay> setting (see constructor argument of
		377	the same name for details).
		378
		379	=cut
		380
		381	sub no_delay {
		382	$_[0]{no_delay} = $_[1];
		383
		384	eval {
		385	local $SIG{__DIE__};
		386	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		387	};
		388	}
		389
		390	#############################################################################
		391
		392	=item $handle->timeout ($seconds)
		393
		394	Configures (or disables) the inactivity timeout.
		395
		396	=cut
		397
		398	sub timeout {
		399	my ($self, $timeout) = @_;
		400
		401	$self->{timeout} = $timeout;
		402	$self->_timeout;
		403	}
		404
		405	# reset the timeout watcher, as neccessary
		406	# also check for time-outs
		407	sub _timeout {
		408	my ($self) = @_;
		409
		410	if ($self->{timeout}) {
		411	my $NOW = AnyEvent->now;
		412
		413	# when would the timeout trigger?
		414	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		415
		416	# now or in the past already?
		417	if ($after <= 0) {
		418	$self->{_activity} = $NOW;
		419
		420	if ($self->{on_timeout}) {
		421	$self->{on_timeout}($self);
		422	} else {
		423	$self->_error (&Errno::ETIMEDOUT);
		424	}
		425
		426	# callback could have changed timeout value, optimise
		427	return unless $self->{timeout};
		428
		429	# calculate new after
		430	$after = $self->{timeout};
		431	}
		432
		433	Scalar::Util::weaken $self;
		434	return unless $self; # ->error could have destroyed $self
		435
		436	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		437	delete $self->{_tw};
		438	$self->_timeout;
		439	});
		440	} else {
		441	delete $self->{_tw};
		442	}
249	}	443	}
250		444
251	#############################################################################	445	#############################################################################
252		446
253	=back	447	=back
…		…
290	=cut	484	=cut
291		485
292	sub _drain_wbuf {	486	sub _drain_wbuf {
293	my ($self) = @_;	487	my ($self) = @_;
294		488
295	if (!$self->{ww} && length $self->{wbuf}) {	489	if (!$self->{_ww} && length $self->{wbuf}) {
296		490
297	Scalar::Util::weaken $self;	491	Scalar::Util::weaken $self;
298		492
299	my $cb = sub {	493	my $cb = sub {
300	my $len = syswrite $self->{fh}, $self->{wbuf};	494	my $len = syswrite $self->{fh}, $self->{wbuf};
301		495
302	if ($len >= 0) {	496	if ($len >= 0) {
303	substr $self->{wbuf}, 0, $len, "";	497	substr $self->{wbuf}, 0, $len, "";
		498
		499	$self->{_activity} = AnyEvent->now;
304		500
305	$self->{on_drain}($self)	501	$self->{on_drain}($self)
306	if $self->{low_water_mark} >= length $self->{wbuf}	502	if $self->{low_water_mark} >= length $self->{wbuf}
307	&& $self->{on_drain};	503	&& $self->{on_drain};
308		504
309	delete $self->{ww} unless length $self->{wbuf};	505	delete $self->{_ww} unless length $self->{wbuf};
310	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	506	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
311	$self->error;	507	$self->_error ($!, 1);
312	}	508	}
313	};	509	};
314		510
315	# try to write data immediately	511	# try to write data immediately
316	$cb->();	512	$cb->() unless $self->{autocork};
317		513
318	# if still data left in wbuf, we need to poll	514	# if still data left in wbuf, we need to poll
319	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	515	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
320	if length $self->{wbuf};	516	if length $self->{wbuf};
321	};	517	};
322	}	518	}
323		519
324	our %WH;	520	our %WH;
…		…
336	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	532	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
337	->($self, @_);	533	->($self, @_);
338	}	534	}
339		535
340	if ($self->{filter_w}) {	536	if ($self->{filter_w}) {
341	$self->{filter_w}->($self, \$_[0]);	537	$self->{filter_w}($self, \$_[0]);
342	} else {	538	} else {
343	$self->{wbuf} .= $_[0];	539	$self->{wbuf} .= $_[0];
344	$self->_drain_wbuf;	540	$self->_drain_wbuf;
345	}	541	}
346	}	542	}
347		543
348	=item $handle->push_write (type => @args)	544	=item $handle->push_write (type => @args)
349		545
350	=item $handle->unshift_write (type => @args)
351
352	Instead of formatting your data yourself, you can also let this module do	546	Instead of formatting your data yourself, you can also let this module do
353	the job by specifying a type and type-specific arguments.	547	the job by specifying a type and type-specific arguments.
354		548
355	Predefined types are (if you have ideas for additional types, feel free to	549	Predefined types are (if you have ideas for additional types, feel free to
356	drop by and tell us):	550	drop by and tell us):
…		…
360	=item netstring => $string	554	=item netstring => $string
361		555
362	Formats the given value as netstring	556	Formats the given value as netstring
363	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	557	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
364		558
365	=back
366
367	=cut	559	=cut
368		560
369	register_write_type netstring => sub {	561	register_write_type netstring => sub {
370	my ($self, $string) = @_;	562	my ($self, $string) = @_;
371		563
372	sprintf "%d:%s,", (length $string), $string	564	sprintf "%d:%s,", (length $string), $string
373	};	565	};
374		566
		567	=item packstring => $format, $data
		568
		569	An octet string prefixed with an encoded length. The encoding C<$format>
		570	uses the same format as a Perl C<pack> format, but must specify a single
		571	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		572	optional C<!>, C<< < >> or C<< > >> modifier).
		573
		574	=cut
		575
		576	register_write_type packstring => sub {
		577	my ($self, $format, $string) = @_;
		578
		579	pack "$format/a*", $string
		580	};
		581
		582	=item json => $array_or_hashref
		583
		584	Encodes the given hash or array reference into a JSON object. Unless you
		585	provide your own JSON object, this means it will be encoded to JSON text
		586	in UTF-8.
		587
		588	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		589	one end of a handle and read them at the other end without using any
		590	additional framing.
		591
		592	The generated JSON text is guaranteed not to contain any newlines: While
		593	this module doesn't need delimiters after or between JSON texts to be
		594	able to read them, many other languages depend on that.
		595
		596	A simple RPC protocol that interoperates easily with others is to send
		597	JSON arrays (or objects, although arrays are usually the better choice as
		598	they mimic how function argument passing works) and a newline after each
		599	JSON text:
		600
		601	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		602	$handle->push_write ("\012");
		603
		604	An AnyEvent::Handle receiver would simply use the C<json> read type and
		605	rely on the fact that the newline will be skipped as leading whitespace:
		606
		607	$handle->push_read (json => sub { my $array = $_[1]; ... });
		608
		609	Other languages could read single lines terminated by a newline and pass
		610	this line into their JSON decoder of choice.
		611
		612	=cut
		613
		614	register_write_type json => sub {
		615	my ($self, $ref) = @_;
		616
		617	require JSON;
		618
		619	$self->{json} ? $self->{json}->encode ($ref)
		620	: JSON::encode_json ($ref)
		621	};
		622
		623	=item storable => $reference
		624
		625	Freezes the given reference using L<Storable> and writes it to the
		626	handle. Uses the C<nfreeze> format.
		627
		628	=cut
		629
		630	register_write_type storable => sub {
		631	my ($self, $ref) = @_;
		632
		633	require Storable;
		634
		635	pack "w/a*", Storable::nfreeze ($ref)
		636	};
		637
		638	=back
		639
375	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	640	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
376		641
377	This function (not method) lets you add your own types to C<push_write>.	642	This function (not method) lets you add your own types to C<push_write>.
378	Whenever the given C<type> is used, C<push_write> will invoke the code	643	Whenever the given C<type> is used, C<push_write> will invoke the code
379	reference with the handle object and the remaining arguments.	644	reference with the handle object and the remaining arguments.
380		645
…		…
399	ways, the "simple" way, using only C<on_read> and the "complex" way, using	664	ways, the "simple" way, using only C<on_read> and the "complex" way, using
400	a queue.	665	a queue.
401		666
402	In the simple case, you just install an C<on_read> callback and whenever	667	In the simple case, you just install an C<on_read> callback and whenever
403	new data arrives, it will be called. You can then remove some data (if	668	new data arrives, it will be called. You can then remove some data (if
404	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	669	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
405	or not.	670	leave the data there if you want to accumulate more (e.g. when only a
		671	partial message has been received so far).
406		672
407	In the more complex case, you want to queue multiple callbacks. In this	673	In the more complex case, you want to queue multiple callbacks. In this
408	case, AnyEvent::Handle will call the first queued callback each time new	674	case, AnyEvent::Handle will call the first queued callback each time new
409	data arrives and removes it when it has done its job (see C<push_read>,	675	data arrives (also the first time it is queued) and removes it when it has
410	below).	676	done its job (see C<push_read>, below).
411		677
412	This way you can, for example, push three line-reads, followed by reading	678	This way you can, for example, push three line-reads, followed by reading
413	a chunk of data, and AnyEvent::Handle will execute them in order.	679	a chunk of data, and AnyEvent::Handle will execute them in order.
414		680
415	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	681	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
416	the specified number of bytes which give an XML datagram.	682	the specified number of bytes which give an XML datagram.
417		683
418	# in the default state, expect some header bytes	684	# in the default state, expect some header bytes
419	$handle->on_read (sub {	685	$handle->on_read (sub {
420	# some data is here, now queue the length-header-read (4 octets)	686	# some data is here, now queue the length-header-read (4 octets)
421	shift->unshift_read_chunk (4, sub {	687	shift->unshift_read (chunk => 4, sub {
422	# header arrived, decode	688	# header arrived, decode
423	my $len = unpack "N", $_[1];	689	my $len = unpack "N", $_[1];
424		690
425	# now read the payload	691	# now read the payload
426	shift->unshift_read_chunk ($len, sub {	692	shift->unshift_read (chunk => $len, sub {
427	my $xml = $_[1];	693	my $xml = $_[1];
428	# handle xml	694	# handle xml
429	});	695	});
430	});	696	});
431	});	697	});
432		698
433	Example 2: Implement a client for a protocol that replies either with	699	Example 2: Implement a client for a protocol that replies either with "OK"
434	"OK" and another line or "ERROR" for one request, and 64 bytes for the	700	and another line or "ERROR" for the first request that is sent, and 64
435	second request. Due tot he availability of a full queue, we can just	701	bytes for the second request. Due to the availability of a queue, we can
436	pipeline sending both requests and manipulate the queue as necessary in	702	just pipeline sending both requests and manipulate the queue as necessary
437	the callbacks:	703	in the callbacks.
438		704
439	# request one	705	When the first callback is called and sees an "OK" response, it will
		706	C<unshift> another line-read. This line-read will be queued I<before> the
		707	64-byte chunk callback.
		708
		709	# request one, returns either "OK + extra line" or "ERROR"
440	$handle->push_write ("request 1\015\012");	710	$handle->push_write ("request 1\015\012");
441		711
442	# we expect "ERROR" or "OK" as response, so push a line read	712	# we expect "ERROR" or "OK" as response, so push a line read
443	$handle->push_read_line (sub {	713	$handle->push_read (line => sub {
444	# if we got an "OK", we have to _prepend_ another line,	714	# if we got an "OK", we have to _prepend_ another line,
445	# so it will be read before the second request reads its 64 bytes	715	# so it will be read before the second request reads its 64 bytes
446	# which are already in the queue when this callback is called	716	# which are already in the queue when this callback is called
447	# we don't do this in case we got an error	717	# we don't do this in case we got an error
448	if ($_[1] eq "OK") {	718	if ($_[1] eq "OK") {
449	$_[0]->unshift_read_line (sub {	719	$_[0]->unshift_read (line => sub {
450	my $response = $_[1];	720	my $response = $_[1];
451	...	721	...
452	});	722	});
453	}	723	}
454	});	724	});
455		725
456	# request two	726	# request two, simply returns 64 octets
457	$handle->push_write ("request 2\015\012");	727	$handle->push_write ("request 2\015\012");
458		728
459	# simply read 64 bytes, always	729	# simply read 64 bytes, always
460	$handle->push_read_chunk (64, sub {	730	$handle->push_read (chunk => 64, sub {
461	my $response = $_[1];	731	my $response = $_[1];
462	...	732	...
463	});	733	});
464		734
465	=over 4	735	=over 4
466		736
467	=cut	737	=cut
468		738
469	sub _drain_rbuf {	739	sub _drain_rbuf {
470	my ($self) = @_;	740	my ($self) = @_;
		741
		742	local $self->{_in_drain} = 1;
471		743
472	if (	744	if (
473	defined $self->{rbuf_max}	745	defined $self->{rbuf_max}
474	&& $self->{rbuf_max} < length $self->{rbuf}	746	&& $self->{rbuf_max} < length $self->{rbuf}
475	) {	747	) {
476	$! = &Errno::ENOSPC;	748	$self->_error (&Errno::ENOSPC, 1), return;
477	$self->error;
478	}	749	}
479		750
480	return if $self->{in_drain};	751	while () {
481	local $self->{in_drain} = 1;
482
483	while (my $len = length $self->{rbuf}) {	752	my $len = length $self->{rbuf};
484	no strict 'refs';	753
485	if (my $cb = shift @{ $self->{queue} }) {	754	if (my $cb = shift @{ $self->{_queue} }) {
486	unless ($cb->($self)) {	755	unless ($cb->($self)) {
487	if ($self->{eof}) {	756	if ($self->{_eof}) {
488	# no progress can be made (not enough data and no data forthcoming)	757	# no progress can be made (not enough data and no data forthcoming)
489	$! = &Errno::EPIPE;	758	$self->_error (&Errno::EPIPE, 1), return;
490	$self->error;
491	}	759	}
492		760
493	unshift @{ $self->{queue} }, $cb;	761	unshift @{ $self->{_queue} }, $cb;
494	return;	762	last;
495	}	763	}
496	} elsif ($self->{on_read}) {	764	} elsif ($self->{on_read}) {
		765	last unless $len;
		766
497	$self->{on_read}($self);	767	$self->{on_read}($self);
498		768
499	if (	769	if (
500	$self->{eof} # if no further data will arrive
501	&& $len == length $self->{rbuf} # and no data has been consumed	770	$len == length $self->{rbuf} # if no data has been consumed
502	&& !@{ $self->{queue} } # and the queue is still empty	771	&& !@{ $self->{_queue} } # and the queue is still empty
503	&& $self->{on_read} # and we still want to read data	772	&& $self->{on_read} # but we still have on_read
504	) {	773	) {
		774	# no further data will arrive
505	# then no progress can be made	775	# so no progress can be made
506	$! = &Errno::EPIPE;	776	$self->_error (&Errno::EPIPE, 1), return
507	$self->error;	777	if $self->{_eof};
		778
		779	last; # more data might arrive
508	}	780	}
509	} else {	781	} else {
510	# read side becomes idle	782	# read side becomes idle
511	delete $self->{rw};	783	delete $self->{_rw};
512	return;	784	last;
513	}	785	}
514	}	786	}
515		787
516	if ($self->{eof}) {	788	if ($self->{_eof}) {
517	$self->_shutdown;	789	if ($self->{on_eof}) {
518	$self->{on_eof}($self)	790	$self->{on_eof}($self)
519	if $self->{on_eof};	791	} else {
		792	$self->_error (0, 1);
		793	}
		794	}
		795
		796	# may need to restart read watcher
		797	unless ($self->{_rw}) {
		798	$self->start_read
		799	if $self->{on_read} \|\| @{ $self->{_queue} };
520	}	800	}
521	}	801	}
522		802
523	=item $handle->on_read ($cb)	803	=item $handle->on_read ($cb)
524		804
…		…
530		810
531	sub on_read {	811	sub on_read {
532	my ($self, $cb) = @_;	812	my ($self, $cb) = @_;
533		813
534	$self->{on_read} = $cb;	814	$self->{on_read} = $cb;
		815	$self->_drain_rbuf if $cb && !$self->{_in_drain};
535	}	816	}
536		817
537	=item $handle->rbuf	818	=item $handle->rbuf
538		819
539	Returns the read buffer (as a modifiable lvalue).	820	Returns the read buffer (as a modifiable lvalue).
…		…
587		868
588	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	869	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
589	->($self, $cb, @_);	870	->($self, $cb, @_);
590	}	871	}
591		872
592	push @{ $self->{queue} }, $cb;	873	push @{ $self->{_queue} }, $cb;
593	$self->_drain_rbuf;	874	$self->_drain_rbuf unless $self->{_in_drain};
594	}	875	}
595		876
596	sub unshift_read {	877	sub unshift_read {
597	my $self = shift;	878	my $self = shift;
598	my $cb = pop;	879	my $cb = pop;
…		…
603	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	884	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
604	->($self, $cb, @_);	885	->($self, $cb, @_);
605	}	886	}
606		887
607		888
608	unshift @{ $self->{queue} }, $cb;	889	unshift @{ $self->{_queue} }, $cb;
609	$self->_drain_rbuf;	890	$self->_drain_rbuf unless $self->{_in_drain};
610	}	891	}
611		892
612	=item $handle->push_read (type => @args, $cb)	893	=item $handle->push_read (type => @args, $cb)
613		894
614	=item $handle->unshift_read (type => @args, $cb)	895	=item $handle->unshift_read (type => @args, $cb)
…		…
620	Predefined types are (if you have ideas for additional types, feel free to	901	Predefined types are (if you have ideas for additional types, feel free to
621	drop by and tell us):	902	drop by and tell us):
622		903
623	=over 4	904	=over 4
624		905
625	=item chunk => $octets, $cb->($self, $data)	906	=item chunk => $octets, $cb->($handle, $data)
626		907
627	Invoke the callback only once C<$octets> bytes have been read. Pass the	908	Invoke the callback only once C<$octets> bytes have been read. Pass the
628	data read to the callback. The callback will never be called with less	909	data read to the callback. The callback will never be called with less
629	data.	910	data.
630		911
…		…
644	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	925	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
645	1	926	1
646	}	927	}
647	};	928	};
648		929
649	# compatibility with older API
650	sub push_read_chunk {
651	$_[0]->push_read (chunk => $_[1], $_[2]);
652	}
653
654	sub unshift_read_chunk {
655	$_[0]->unshift_read (chunk => $_[1], $_[2]);
656	}
657
658	=item line => [$eol, ]$cb->($self, $line, $eol)	930	=item line => [$eol, ]$cb->($handle, $line, $eol)
659		931
660	The callback will be called only once a full line (including the end of	932	The callback will be called only once a full line (including the end of
661	line marker, C<$eol>) has been read. This line (excluding the end of line	933	line marker, C<$eol>) has been read. This line (excluding the end of line
662	marker) will be passed to the callback as second argument (C<$line>), and	934	marker) will be passed to the callback as second argument (C<$line>), and
663	the end of line marker as the third argument (C<$eol>).	935	the end of line marker as the third argument (C<$eol>).
…		…
677	=cut	949	=cut
678		950
679	register_read_type line => sub {	951	register_read_type line => sub {
680	my ($self, $cb, $eol) = @_;	952	my ($self, $cb, $eol) = @_;
681		953
682	$eol = qr\|(\015?\012)\| if @_ < 3;	954	if (@_ < 3) {
		955	# this is more than twice as fast as the generic code below
		956	sub {
		957	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		958
		959	$cb->($_[0], $1, $2);
		960	1
		961	}
		962	} else {
683	$eol = quotemeta $eol unless ref $eol;	963	$eol = quotemeta $eol unless ref $eol;
684	$eol = qr\|^(.*?)($eol)\|s;	964	$eol = qr\|^(.*?)($eol)\|s;
685		965
686	sub {	966	sub {
687	$_[0]{rbuf} =~ s/$eol// or return;	967	$_[0]{rbuf} =~ s/$eol// or return;
688		968
689	$cb->($_[0], $1, $2);	969	$cb->($_[0], $1, $2);
		970	1
690	1	971	}
691	}	972	}
692	};	973	};
693		974
694	# compatibility with older API
695	sub push_read_line {
696	my $self = shift;
697	$self->push_read (line => @_);
698	}
699
700	sub unshift_read_line {
701	my $self = shift;
702	$self->unshift_read (line => @_);
703	}
704
705	=item netstring => $cb->($string)
706
707	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
708
709	Throws an error with C<$!> set to EBADMSG on format violations.
710
711	=cut
712
713	register_read_type netstring => sub {
714	my ($self, $cb) = @_;
715
716	sub {
717	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
718	if ($_[0]{rbuf} =~ /[^0-9]/) {
719	$! = &Errno::EBADMSG;
720	$self->error;
721	}
722	return;
723	}
724
725	my $len = $1;
726
727	$self->unshift_read (chunk => $len, sub {
728	my $string = $_[1];
729	$_[0]->unshift_read (chunk => 1, sub {
730	if ($_[1] eq ",") {
731	$cb->($_[0], $string);
732	} else {
733	$! = &Errno::EBADMSG;
734	$self->error;
735	}
736	});
737	});
738
739	1
740	}
741	};
742
743	=item regex => $accept[, $reject[, $skip], $cb->($data)	975	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
744		976
745	Makes a regex match against the regex object C<$accept> and returns	977	Makes a regex match against the regex object C<$accept> and returns
746	everything up to and including the match.	978	everything up to and including the match.
747		979
748	Example: read a single line terminated by '\n'.	980	Example: read a single line terminated by '\n'.
…		…
796	return 1;	1028	return 1;
797	}	1029	}
798		1030
799	# reject	1031	# reject
800	if ($reject && $$rbuf =~ $reject) {	1032	if ($reject && $$rbuf =~ $reject) {
801	$! = &Errno::EBADMSG;	1033	$self->_error (&Errno::EBADMSG);
802	$self->error;
803	}	1034	}
804		1035
805	# skip	1036	# skip
806	if ($skip && $$rbuf =~ $skip) {	1037	if ($skip && $$rbuf =~ $skip) {
807	$data .= substr $$rbuf, 0, $+[0], "";	1038	$data .= substr $$rbuf, 0, $+[0], "";
…		…
809		1040
810	()	1041	()
811	}	1042	}
812	};	1043	};
813		1044
		1045	=item netstring => $cb->($handle, $string)
		1046
		1047	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1048
		1049	Throws an error with C<$!> set to EBADMSG on format violations.
		1050
		1051	=cut
		1052
		1053	register_read_type netstring => sub {
		1054	my ($self, $cb) = @_;
		1055
		1056	sub {
		1057	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1058	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1059	$self->_error (&Errno::EBADMSG);
		1060	}
		1061	return;
		1062	}
		1063
		1064	my $len = $1;
		1065
		1066	$self->unshift_read (chunk => $len, sub {
		1067	my $string = $_[1];
		1068	$_[0]->unshift_read (chunk => 1, sub {
		1069	if ($_[1] eq ",") {
		1070	$cb->($_[0], $string);
		1071	} else {
		1072	$self->_error (&Errno::EBADMSG);
		1073	}
		1074	});
		1075	});
		1076
		1077	1
		1078	}
		1079	};
		1080
		1081	=item packstring => $format, $cb->($handle, $string)
		1082
		1083	An octet string prefixed with an encoded length. The encoding C<$format>
		1084	uses the same format as a Perl C<pack> format, but must specify a single
		1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1086	optional C<!>, C<< < >> or C<< > >> modifier).
		1087
		1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1089
		1090	Example: read a block of data prefixed by its length in BER-encoded
		1091	format (very efficient).
		1092
		1093	$handle->push_read (packstring => "w", sub {
		1094	my ($handle, $data) = @_;
		1095	});
		1096
		1097	=cut
		1098
		1099	register_read_type packstring => sub {
		1100	my ($self, $cb, $format) = @_;
		1101
		1102	sub {
		1103	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1104	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1105	or return;
		1106
		1107	$format = length pack $format, $len;
		1108
		1109	# bypass unshift if we already have the remaining chunk
		1110	if ($format + $len <= length $_[0]{rbuf}) {
		1111	my $data = substr $_[0]{rbuf}, $format, $len;
		1112	substr $_[0]{rbuf}, 0, $format + $len, "";
		1113	$cb->($_[0], $data);
		1114	} else {
		1115	# remove prefix
		1116	substr $_[0]{rbuf}, 0, $format, "";
		1117
		1118	# read remaining chunk
		1119	$_[0]->unshift_read (chunk => $len, $cb);
		1120	}
		1121
		1122	1
		1123	}
		1124	};
		1125
		1126	=item json => $cb->($handle, $hash_or_arrayref)
		1127
		1128	Reads a JSON object or array, decodes it and passes it to the callback.
		1129
		1130	If a C<json> object was passed to the constructor, then that will be used
		1131	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1132
		1133	This read type uses the incremental parser available with JSON version
		1134	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1135	dependency on your own: this module will load the JSON module, but
		1136	AnyEvent does not depend on it itself.
		1137
		1138	Since JSON texts are fully self-delimiting, the C<json> read and write
		1139	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1140	the C<json> write type description, above, for an actual example.
		1141
		1142	=cut
		1143
		1144	register_read_type json => sub {
		1145	my ($self, $cb) = @_;
		1146
		1147	require JSON;
		1148
		1149	my $data;
		1150	my $rbuf = \$self->{rbuf};
		1151
		1152	my $json = $self->{json} \|\|= JSON->new->utf8;
		1153
		1154	sub {
		1155	my $ref = $json->incr_parse ($self->{rbuf});
		1156
		1157	if ($ref) {
		1158	$self->{rbuf} = $json->incr_text;
		1159	$json->incr_text = "";
		1160	$cb->($self, $ref);
		1161
		1162	1
		1163	} else {
		1164	$self->{rbuf} = "";
		1165	()
		1166	}
		1167	}
		1168	};
		1169
		1170	=item storable => $cb->($handle, $ref)
		1171
		1172	Deserialises a L<Storable> frozen representation as written by the
		1173	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1174	data).
		1175
		1176	Raises C<EBADMSG> error if the data could not be decoded.
		1177
		1178	=cut
		1179
		1180	register_read_type storable => sub {
		1181	my ($self, $cb) = @_;
		1182
		1183	require Storable;
		1184
		1185	sub {
		1186	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1187	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1188	or return;
		1189
		1190	my $format = length pack "w", $len;
		1191
		1192	# bypass unshift if we already have the remaining chunk
		1193	if ($format + $len <= length $_[0]{rbuf}) {
		1194	my $data = substr $_[0]{rbuf}, $format, $len;
		1195	substr $_[0]{rbuf}, 0, $format + $len, "";
		1196	$cb->($_[0], Storable::thaw ($data));
		1197	} else {
		1198	# remove prefix
		1199	substr $_[0]{rbuf}, 0, $format, "";
		1200
		1201	# read remaining chunk
		1202	$_[0]->unshift_read (chunk => $len, sub {
		1203	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1204	$cb->($_[0], $ref);
		1205	} else {
		1206	$self->_error (&Errno::EBADMSG);
		1207	}
		1208	});
		1209	}
		1210
		1211	1
		1212	}
		1213	};
		1214
814	=back	1215	=back
815		1216
816	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1217	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
817		1218
818	This function (not method) lets you add your own types to C<push_read>.	1219	This function (not method) lets you add your own types to C<push_read>.
819		1220
820	Whenever the given C<type> is used, C<push_read> will invoke the code	1221	Whenever the given C<type> is used, C<push_read> will invoke the code
821	reference with the handle object, the callback and the remaining	1222	reference with the handle object, the callback and the remaining
…		…
823		1224
824	The code reference is supposed to return a callback (usually a closure)	1225	The code reference is supposed to return a callback (usually a closure)
825	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1226	that works as a plain read callback (see C<< ->push_read ($cb) >>).
826		1227
827	It should invoke the passed callback when it is done reading (remember to	1228	It should invoke the passed callback when it is done reading (remember to
828	pass C<$self> as first argument as all other callbacks do that).	1229	pass C<$handle> as first argument as all other callbacks do that).
829		1230
830	Note that this is a function, and all types registered this way will be	1231	Note that this is a function, and all types registered this way will be
831	global, so try to use unique names.	1232	global, so try to use unique names.
832		1233
833	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1234	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
836	=item $handle->stop_read	1237	=item $handle->stop_read
837		1238
838	=item $handle->start_read	1239	=item $handle->start_read
839		1240
840	In rare cases you actually do not want to read anything from the	1241	In rare cases you actually do not want to read anything from the
841	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1242	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
842	any queued callbacks will be executed then. To start reading again, call	1243	any queued callbacks will be executed then. To start reading again, call
843	C<start_read>.	1244	C<start_read>.
844		1245
		1246	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1247	you change the C<on_read> callback or push/unshift a read callback, and it
		1248	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1249	there are any read requests in the queue.
		1250
845	=cut	1251	=cut
846		1252
847	sub stop_read {	1253	sub stop_read {
848	my ($self) = @_;	1254	my ($self) = @_;
849		1255
850	delete $self->{rw};	1256	delete $self->{_rw};
851	}	1257	}
852		1258
853	sub start_read {	1259	sub start_read {
854	my ($self) = @_;	1260	my ($self) = @_;
855		1261
856	unless ($self->{rw} \|\| $self->{eof}) {	1262	unless ($self->{_rw} \|\| $self->{_eof}) {
857	Scalar::Util::weaken $self;	1263	Scalar::Util::weaken $self;
858		1264
859	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1265	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
860	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1266	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
861	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1267	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
862		1268
863	if ($len > 0) {	1269	if ($len > 0) {
		1270	$self->{_activity} = AnyEvent->now;
		1271
864	$self->{filter_r}	1272	$self->{filter_r}
865	? $self->{filter_r}->($self, $rbuf)	1273	? $self->{filter_r}($self, $rbuf)
866	: $self->_drain_rbuf;	1274	: $self->{_in_drain} \|\| $self->_drain_rbuf;
867		1275
868	} elsif (defined $len) {	1276	} elsif (defined $len) {
869	delete $self->{rw};	1277	delete $self->{_rw};
870	$self->{eof} = 1;	1278	$self->{_eof} = 1;
871	$self->_drain_rbuf;	1279	$self->_drain_rbuf unless $self->{_in_drain};
872		1280
873	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1281	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
874	return $self->error;	1282	return $self->_error ($!, 1);
875	}	1283	}
876	});	1284	});
877	}	1285	}
878	}	1286	}
879		1287
880	sub _dotls {	1288	sub _dotls {
881	my ($self) = @_;	1289	my ($self) = @_;
882		1290
		1291	my $buf;
		1292
883	if (length $self->{tls_wbuf}) {	1293	if (length $self->{_tls_wbuf}) {
884	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1294	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
885	substr $self->{tls_wbuf}, 0, $len, "";	1295	substr $self->{_tls_wbuf}, 0, $len, "";
886	}	1296	}
887	}	1297	}
888		1298
889	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1299	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
890	$self->{wbuf} .= $buf;	1300	$self->{wbuf} .= $buf;
891	$self->_drain_wbuf;	1301	$self->_drain_wbuf;
892	}	1302	}
893		1303
894	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1304	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1305	if (length $buf) {
895	$self->{rbuf} .= $buf;	1306	$self->{rbuf} .= $buf;
896	$self->_drain_rbuf;	1307	$self->_drain_rbuf unless $self->{_in_drain};
		1308	} else {
		1309	# let's treat SSL-eof as we treat normal EOF
		1310	$self->{_eof} = 1;
		1311	$self->_shutdown;
		1312	return;
		1313	}
897	}	1314	}
898		1315
899	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1316	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
900		1317
901	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1318	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
902	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1319	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
903	$self->error;	1320	return $self->_error ($!, 1);
904	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1321	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
905	$! = &Errno::EIO;	1322	return $self->_error (&Errno::EIO, 1);
906	$self->error;
907	}	1323	}
908		1324
909	# all others are fine for our purposes	1325	# all others are fine for our purposes
910	}	1326	}
911	}	1327	}
…		…
920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1336	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
921		1337
922	The second argument is the optional C<Net::SSLeay::CTX> object that is	1338	The second argument is the optional C<Net::SSLeay::CTX> object that is
923	used when AnyEvent::Handle has to create its own TLS connection object.	1339	used when AnyEvent::Handle has to create its own TLS connection object.
924		1340
925	=cut	1341	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1342	call and can be used or changed to your liking. Note that the handshake
		1343	might have already started when this function returns.
926		1344
927	# TODO: maybe document...	1345	=cut
		1346
928	sub starttls {	1347	sub starttls {
929	my ($self, $ssl, $ctx) = @_;	1348	my ($self, $ssl, $ctx) = @_;
930		1349
931	$self->stoptls;	1350	$self->stoptls;
932		1351
…		…
947	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1366	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
948	Net::SSLeay::CTX_set_mode ($self->{tls},	1367	Net::SSLeay::CTX_set_mode ($self->{tls},
949	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1368	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
950	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1369	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
951		1370
952	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1371	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
953	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1372	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
954		1373
955	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1374	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
956		1375
957	$self->{filter_w} = sub {	1376	$self->{filter_w} = sub {
958	$_[0]{tls_wbuf} .= ${$_[1]};	1377	$_[0]{_tls_wbuf} .= ${$_[1]};
959	&_dotls;	1378	&_dotls;
960	};	1379	};
961	$self->{filter_r} = sub {	1380	$self->{filter_r} = sub {
962	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1381	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
963	&_dotls;	1382	&_dotls;
964	};	1383	};
965	}	1384	}
966		1385
967	=item $handle->stoptls	1386	=item $handle->stoptls
…		…
973		1392
974	sub stoptls {	1393	sub stoptls {
975	my ($self) = @_;	1394	my ($self) = @_;
976		1395
977	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1396	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1397
978	delete $self->{tls_rbio};	1398	delete $self->{_rbio};
979	delete $self->{tls_wbio};	1399	delete $self->{_wbio};
980	delete $self->{tls_wbuf};	1400	delete $self->{_tls_wbuf};
981	delete $self->{filter_r};	1401	delete $self->{filter_r};
982	delete $self->{filter_w};	1402	delete $self->{filter_w};
983	}	1403	}
984		1404
985	sub DESTROY {	1405	sub DESTROY {
986	my $self = shift;	1406	my $self = shift;
987		1407
988	$self->stoptls;	1408	$self->stoptls;
		1409
		1410	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1411
		1412	if ($linger && length $self->{wbuf}) {
		1413	my $fh = delete $self->{fh};
		1414	my $wbuf = delete $self->{wbuf};
		1415
		1416	my @linger;
		1417
		1418	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1419	my $len = syswrite $fh, $wbuf, length $wbuf;
		1420
		1421	if ($len > 0) {
		1422	substr $wbuf, 0, $len, "";
		1423	} else {
		1424	@linger = (); # end
		1425	}
		1426	});
		1427	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1428	@linger = ();
		1429	});
		1430	}
989	}	1431	}
990		1432
991	=item AnyEvent::Handle::TLS_CTX	1433	=item AnyEvent::Handle::TLS_CTX
992		1434
993	This function creates and returns the Net::SSLeay::CTX object used by	1435	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1023	}	1465	}
1024	}	1466	}
1025		1467
1026	=back	1468	=back
1027		1469
		1470	=head1 SUBCLASSING AnyEvent::Handle
		1471
		1472	In many cases, you might want to subclass AnyEvent::Handle.
		1473
		1474	To make this easier, a given version of AnyEvent::Handle uses these
		1475	conventions:
		1476
		1477	=over 4
		1478
		1479	=item * all constructor arguments become object members.
		1480
		1481	At least initially, when you pass a C<tls>-argument to the constructor it
		1482	will end up in C<< $handle->{tls} >>. Those members might be changed or
		1483	mutated later on (for example C<tls> will hold the TLS connection object).
		1484
		1485	=item * other object member names are prefixed with an C<_>.
		1486
		1487	All object members not explicitly documented (internal use) are prefixed
		1488	with an underscore character, so the remaining non-C<_>-namespace is free
		1489	for use for subclasses.
		1490
		1491	=item * all members not documented here and not prefixed with an underscore
		1492	are free to use in subclasses.
		1493
		1494	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1495	member variables, but thats just life, at least it is documented.
		1496
		1497	=back
		1498
1028	=head1 AUTHOR	1499	=head1 AUTHOR
1029		1500
1030	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1501	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1031		1502
1032	=cut	1503	=cut

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs. Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC