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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.31 by root, Sun May 25 00:08:49 2008 UTC vs. Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.31 by root, Sun May 25 00:08:49 2008 UTC vs.
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC