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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs. Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs.
Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC