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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs. Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC