ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.33 by root, Sun May 25 03:03:51 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 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.331;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($self)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called on EOF.	84	Set the callback to be called when an end-of-file condition is detected,
		85	i.e. in the case of a socket, when the other side has closed the
		86	connection cleanly.
81		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the EOF
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
82	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
83	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
84	waiting for data.	95	waiting for data.
85		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
		99
86	=item on_error => $cb->($self)	100	=item on_error => $cb->($handle, $fatal)
87		101
88	This is the fatal error callback, that is called when, well, a fatal error	102	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	103	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	104	connect or a read error.
91		105
92	The object will not be in a usable state when this callback has been	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
		112	Non-fatal errors can be retried by simply returning, but it is recommended
		113	to simply ignore this parameter and instead abondon the handle object
		114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		116
95	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		119
98	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
99	you will not be notified of errors otherwise. The default simply calls	121	you will not be notified of errors otherwise. The default simply calls
100	die.	122	C<croak>.
101		123
102	=item on_read => $cb->($self)	124	=item on_read => $cb->($handle)
103		125
104	This sets the default read callback, which is called when data arrives	126	This sets the default read callback, which is called when data arrives
105	and no read request is in the queue.	127	and no read request is in the queue (unlike read queue callbacks, this
		128	callback will only be called when at least one octet of data is in the
		129	read buffer).
106		130
107	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
108	method or access the C<$self->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
109		133
110	When an EOF condition is detected then AnyEvent::Handle will first try to	134	When an EOF condition is detected then AnyEvent::Handle will first try to
111	feed all the remaining data to the queued callbacks and C<on_read> before	135	feed all the remaining data to the queued callbacks and C<on_read> before
112	calling the C<on_eof> callback. If no progress can be made, then a fatal	136	calling the C<on_eof> callback. If no progress can be made, then a fatal
113	error will be raised (with C<$!> set to C<EPIPE>).	137	error will be raised (with C<$!> set to C<EPIPE>).
114		138
115	=item on_drain => $cb->()	139	=item on_drain => $cb->($handle)
116		140
117	This sets the callback that is called when the write buffer becomes empty	141	This sets the callback that is called when the write buffer becomes empty
118	(or when the callback is set and the buffer is empty already).	142	(or when the callback is set and the buffer is empty already).
119		143
120	To append to the write buffer, use the C<< ->push_write >> method.	144	To append to the write buffer, use the C<< ->push_write >> method.
121		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
122	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
123		174
124	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>)
125	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
126	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
127		178
128	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
129	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
130	(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
131	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
132	isn't finished).	183	isn't finished).
133		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
134	=item read_size => <bytes>	211	=item read_size => <bytes>
135		212
136	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
137	on each [loop iteration). Default: C<4096>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
138		216
139	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
140		218
141	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
142	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
143	considered empty.	221	considered empty.
144		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. Calling the C<stoptls> method in time might
		238	help.
		239
145	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	240	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
146		241
147	When this parameter is given, it enables TLS (SSL) mode, that means it	242	When this parameter is given, it enables TLS (SSL) mode, that means
148	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
149	data.	244	established and will transparently encrypt/decrypt data afterwards.
150		245
151	TLS mode requires Net::SSLeay to be installed (it will be loaded	246	TLS mode requires Net::SSLeay to be installed (it will be loaded
152	automatically when you try to create a TLS handle).	247	automatically when you try to create a TLS handle): this module doesn't
		248	have a dependency on that module, so if your module requires it, you have
		249	to add the dependency yourself.
153		250
154	For the TLS server side, use C<accept>, and for the TLS client side of a	251	Unlike TCP, TLS has a server and client side: for the TLS server side, use
155	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
156		254
157	You can also provide your own TLS connection object, but you have	255	You can also provide your own TLS connection object, but you have
158	to make sure that you call either C<Net::SSLeay::set_connect_state>	256	to make sure that you call either C<Net::SSLeay::set_connect_state>
159	or C<Net::SSLeay::set_accept_state> on it before you pass it to	257	or C<Net::SSLeay::set_accept_state> on it before you pass it to
160	AnyEvent::Handle.	258	AnyEvent::Handle.
161		259
		260	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		261	passing in the wrong integer will lead to certain crash. This most often
		262	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		263	segmentation fault.
		264
162	See the C<starttls> method if you need to start TLs negotiation later.	265	See the C<< ->starttls >> method for when need to start TLS negotiation later.
163		266
164	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
165		268
166	Use the given Net::SSLeay::CTX object to create the new TLS connection	269	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
167	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
168	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
169		272
		273	=item json => JSON or JSON::XS object
		274
		275	This is the json coder object used by the C<json> read and write types.
		276
		277	If you don't supply it, then AnyEvent::Handle will create and use a
		278	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		279	texts.
		280
		281	Note that you are responsible to depend on the JSON module if you want to
		282	use this functionality, as AnyEvent does not have a dependency itself.
		283
170	=back	284	=back
171		285
172	=cut	286	=cut
173		287
174	sub new {	288	sub new {
…		…
178		292
179	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
180		294
181	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
182		296
183	if ($self->{tls}) {
184	require Net::SSLeay;
185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
186	}	298	if $self->{tls};
187		299
188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	300	$self->{_activity} = AnyEvent->now;
189	$self->on_error (delete $self->{on_error}) if $self->{on_error};	301	$self->_timeout;
		302
190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	304	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
192		305
193	$self->start_read;	306	$self->start_read
		307	if $self->{on_read};
194		308
195	$self	309	$self
196	}	310	}
197		311
198	sub _shutdown {	312	sub _shutdown {
199	my ($self) = @_;	313	my ($self) = @_;
200		314
		315	delete $self->{_tw};
201	delete $self->{rw};	316	delete $self->{_rw};
202	delete $self->{ww};	317	delete $self->{_ww};
203	delete $self->{fh};	318	delete $self->{fh};
204	}
205		319
		320	&_freetls;
		321
		322	delete $self->{on_read};
		323	delete $self->{_queue};
		324	}
		325
206	sub error {	326	sub _error {
207	my ($self) = @_;	327	my ($self, $errno, $fatal) = @_;
208		328
209	{
210	local $!;
211	$self->_shutdown;	329	$self->_shutdown
212	}	330	if $fatal;
		331
		332	$! = $errno;
213		333
214	if ($self->{on_error}) {	334	if ($self->{on_error}) {
215	$self->{on_error}($self);	335	$self->{on_error}($self, $fatal);
216	} else {	336	} elsif ($self->{fh}) {
217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
218	}	338	}
219	}	339	}
220		340
221	=item $fh = $handle->fh	341	=item $fh = $handle->fh
222		342
223	This method returns the file handle of the L<AnyEvent::Handle> object.	343	This method returns the file handle used to create the L<AnyEvent::Handle> object.
224		344
225	=cut	345	=cut
226		346
227	sub fh { $_[0]->{fh} }	347	sub fh { $_[0]{fh} }
228		348
229	=item $handle->on_error ($cb)	349	=item $handle->on_error ($cb)
230		350
231	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	351	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
232		352
…		…
244		364
245	sub on_eof {	365	sub on_eof {
246	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
247	}	367	}
248		368
		369	=item $handle->on_timeout ($cb)
		370
		371	Replace the current C<on_timeout> callback, or disables the callback (but
		372	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
		373	argument and method.
		374
		375	=cut
		376
		377	sub on_timeout {
		378	$_[0]{on_timeout} = $_[1];
		379	}
		380
		381	=item $handle->autocork ($boolean)
		382
		383	Enables or disables the current autocork behaviour (see C<autocork>
		384	constructor argument). Changes will only take effect on the next write.
		385
		386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
		391
		392	=item $handle->no_delay ($boolean)
		393
		394	Enables or disables the C<no_delay> setting (see constructor argument of
		395	the same name for details).
		396
		397	=cut
		398
		399	sub no_delay {
		400	$_[0]{no_delay} = $_[1];
		401
		402	eval {
		403	local $SIG{__DIE__};
		404	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		405	};
		406	}
		407
		408	#############################################################################
		409
		410	=item $handle->timeout ($seconds)
		411
		412	Configures (or disables) the inactivity timeout.
		413
		414	=cut
		415
		416	sub timeout {
		417	my ($self, $timeout) = @_;
		418
		419	$self->{timeout} = $timeout;
		420	$self->_timeout;
		421	}
		422
		423	# reset the timeout watcher, as neccessary
		424	# also check for time-outs
		425	sub _timeout {
		426	my ($self) = @_;
		427
		428	if ($self->{timeout}) {
		429	my $NOW = AnyEvent->now;
		430
		431	# when would the timeout trigger?
		432	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		433
		434	# now or in the past already?
		435	if ($after <= 0) {
		436	$self->{_activity} = $NOW;
		437
		438	if ($self->{on_timeout}) {
		439	$self->{on_timeout}($self);
		440	} else {
		441	$self->_error (&Errno::ETIMEDOUT);
		442	}
		443
		444	# callback could have changed timeout value, optimise
		445	return unless $self->{timeout};
		446
		447	# calculate new after
		448	$after = $self->{timeout};
		449	}
		450
		451	Scalar::Util::weaken $self;
		452	return unless $self; # ->error could have destroyed $self
		453
		454	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		455	delete $self->{_tw};
		456	$self->_timeout;
		457	});
		458	} else {
		459	delete $self->{_tw};
		460	}
		461	}
		462
249	#############################################################################	463	#############################################################################
250		464
251	=back	465	=back
252		466
253	=head2 WRITE QUEUE	467	=head2 WRITE QUEUE
…		…
274	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
275		489
276	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
277		491
278	$cb->($self)	492	$cb->($self)
279	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
280	}	494	}
281		495
282	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
283		497
284	Queues the given scalar to be written. You can push as much data as you	498	Queues the given scalar to be written. You can push as much data as you
…		…
288	=cut	502	=cut
289		503
290	sub _drain_wbuf {	504	sub _drain_wbuf {
291	my ($self) = @_;	505	my ($self) = @_;
292		506
293	if (!$self->{ww} && length $self->{wbuf}) {	507	if (!$self->{_ww} && length $self->{wbuf}) {
		508
294	Scalar::Util::weaken $self;	509	Scalar::Util::weaken $self;
		510
295	my $cb = sub {	511	my $cb = sub {
296	my $len = syswrite $self->{fh}, $self->{wbuf};	512	my $len = syswrite $self->{fh}, $self->{wbuf};
297		513
298	if ($len >= 0) {	514	if ($len >= 0) {
299	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
300		516
		517	$self->{_activity} = AnyEvent->now;
		518
301	$self->{on_drain}($self)	519	$self->{on_drain}($self)
302	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
303	&& $self->{on_drain};	521	&& $self->{on_drain};
304		522
305	delete $self->{ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
307	$self->error;	525	$self->_error ($!, 1);
308	}	526	}
309	};	527	};
310		528
		529	# try to write data immediately
		530	$cb->() unless $self->{autocork};
		531
		532	# if still data left in wbuf, we need to poll
311	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	533	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
312		534	if length $self->{wbuf};
313	$cb->($self);
314	};	535	};
315	}	536	}
316		537
317	our %WH;	538	our %WH;
318		539
…		…
328		549
329	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	550	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
330	->($self, @_);	551	->($self, @_);
331	}	552	}
332		553
333	if ($self->{filter_w}) {	554	if ($self->{tls}) {
334	$self->{filter_w}->($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
335	} else {	558	} else {
336	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
337	$self->_drain_wbuf;	560	$self->_drain_wbuf;
338	}	561	}
339	}	562	}
340		563
341	=item $handle->push_write (type => @args)	564	=item $handle->push_write (type => @args)
342		565
343	=item $handle->unshift_write (type => @args)
344
345	Instead of formatting your data yourself, you can also let this module do	566	Instead of formatting your data yourself, you can also let this module do
346	the job by specifying a type and type-specific arguments.	567	the job by specifying a type and type-specific arguments.
347		568
348	Predefined types are (if you have ideas for additional types, feel free to	569	Predefined types are (if you have ideas for additional types, feel free to
349	drop by and tell us):	570	drop by and tell us):
…		…
353	=item netstring => $string	574	=item netstring => $string
354		575
355	Formats the given value as netstring	576	Formats the given value as netstring
356	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	577	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
357		578
358	=back
359
360	=cut	579	=cut
361		580
362	register_write_type netstring => sub {	581	register_write_type netstring => sub {
363	my ($self, $string) = @_;	582	my ($self, $string) = @_;
364		583
365	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
366	};	585	};
367		586
		587	=item packstring => $format, $data
		588
		589	An octet string prefixed with an encoded length. The encoding C<$format>
		590	uses the same format as a Perl C<pack> format, but must specify a single
		591	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		592	optional C<!>, C<< < >> or C<< > >> modifier).
		593
		594	=cut
		595
		596	register_write_type packstring => sub {
		597	my ($self, $format, $string) = @_;
		598
		599	pack "$format/a*", $string
		600	};
		601
		602	=item json => $array_or_hashref
		603
		604	Encodes the given hash or array reference into a JSON object. Unless you
		605	provide your own JSON object, this means it will be encoded to JSON text
		606	in UTF-8.
		607
		608	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		609	one end of a handle and read them at the other end without using any
		610	additional framing.
		611
		612	The generated JSON text is guaranteed not to contain any newlines: While
		613	this module doesn't need delimiters after or between JSON texts to be
		614	able to read them, many other languages depend on that.
		615
		616	A simple RPC protocol that interoperates easily with others is to send
		617	JSON arrays (or objects, although arrays are usually the better choice as
		618	they mimic how function argument passing works) and a newline after each
		619	JSON text:
		620
		621	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		622	$handle->push_write ("\012");
		623
		624	An AnyEvent::Handle receiver would simply use the C<json> read type and
		625	rely on the fact that the newline will be skipped as leading whitespace:
		626
		627	$handle->push_read (json => sub { my $array = $_[1]; ... });
		628
		629	Other languages could read single lines terminated by a newline and pass
		630	this line into their JSON decoder of choice.
		631
		632	=cut
		633
		634	register_write_type json => sub {
		635	my ($self, $ref) = @_;
		636
		637	require JSON;
		638
		639	$self->{json} ? $self->{json}->encode ($ref)
		640	: JSON::encode_json ($ref)
		641	};
		642
		643	=item storable => $reference
		644
		645	Freezes the given reference using L<Storable> and writes it to the
		646	handle. Uses the C<nfreeze> format.
		647
		648	=cut
		649
		650	register_write_type storable => sub {
		651	my ($self, $ref) = @_;
		652
		653	require Storable;
		654
		655	pack "w/a*", Storable::nfreeze ($ref)
		656	};
		657
		658	=back
		659
368	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
369		661
370	This function (not method) lets you add your own types to C<push_write>.	662	This function (not method) lets you add your own types to C<push_write>.
371	Whenever the given C<type> is used, C<push_write> will invoke the code	663	Whenever the given C<type> is used, C<push_write> will invoke the code
372	reference with the handle object and the remaining arguments.	664	reference with the handle object and the remaining arguments.
373		665
…		…
392	ways, the "simple" way, using only C<on_read> and the "complex" way, using	684	ways, the "simple" way, using only C<on_read> and the "complex" way, using
393	a queue.	685	a queue.
394		686
395	In the simple case, you just install an C<on_read> callback and whenever	687	In the simple case, you just install an C<on_read> callback and whenever
396	new data arrives, it will be called. You can then remove some data (if	688	new data arrives, it will be called. You can then remove some data (if
397	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	689	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
398	or not.	690	leave the data there if you want to accumulate more (e.g. when only a
		691	partial message has been received so far).
399		692
400	In the more complex case, you want to queue multiple callbacks. In this	693	In the more complex case, you want to queue multiple callbacks. In this
401	case, AnyEvent::Handle will call the first queued callback each time new	694	case, AnyEvent::Handle will call the first queued callback each time new
402	data arrives and removes it when it has done its job (see C<push_read>,	695	data arrives (also the first time it is queued) and removes it when it has
403	below).	696	done its job (see C<push_read>, below).
404		697
405	This way you can, for example, push three line-reads, followed by reading	698	This way you can, for example, push three line-reads, followed by reading
406	a chunk of data, and AnyEvent::Handle will execute them in order.	699	a chunk of data, and AnyEvent::Handle will execute them in order.
407		700
408	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	701	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
409	the specified number of bytes which give an XML datagram.	702	the specified number of bytes which give an XML datagram.
410		703
411	# in the default state, expect some header bytes	704	# in the default state, expect some header bytes
412	$handle->on_read (sub {	705	$handle->on_read (sub {
413	# some data is here, now queue the length-header-read (4 octets)	706	# some data is here, now queue the length-header-read (4 octets)
414	shift->unshift_read_chunk (4, sub {	707	shift->unshift_read (chunk => 4, sub {
415	# header arrived, decode	708	# header arrived, decode
416	my $len = unpack "N", $_[1];	709	my $len = unpack "N", $_[1];
417		710
418	# now read the payload	711	# now read the payload
419	shift->unshift_read_chunk ($len, sub {	712	shift->unshift_read (chunk => $len, sub {
420	my $xml = $_[1];	713	my $xml = $_[1];
421	# handle xml	714	# handle xml
422	});	715	});
423	});	716	});
424	});	717	});
425		718
426	Example 2: Implement a client for a protocol that replies either with	719	Example 2: Implement a client for a protocol that replies either with "OK"
427	"OK" and another line or "ERROR" for one request, and 64 bytes for the	720	and another line or "ERROR" for the first request that is sent, and 64
428	second request. Due tot he availability of a full queue, we can just	721	bytes for the second request. Due to the availability of a queue, we can
429	pipeline sending both requests and manipulate the queue as necessary in	722	just pipeline sending both requests and manipulate the queue as necessary
430	the callbacks:	723	in the callbacks.
431		724
432	# request one	725	When the first callback is called and sees an "OK" response, it will
		726	C<unshift> another line-read. This line-read will be queued I<before> the
		727	64-byte chunk callback.
		728
		729	# request one, returns either "OK + extra line" or "ERROR"
433	$handle->push_write ("request 1\015\012");	730	$handle->push_write ("request 1\015\012");
434		731
435	# we expect "ERROR" or "OK" as response, so push a line read	732	# we expect "ERROR" or "OK" as response, so push a line read
436	$handle->push_read_line (sub {	733	$handle->push_read (line => sub {
437	# if we got an "OK", we have to _prepend_ another line,	734	# if we got an "OK", we have to _prepend_ another line,
438	# so it will be read before the second request reads its 64 bytes	735	# so it will be read before the second request reads its 64 bytes
439	# which are already in the queue when this callback is called	736	# which are already in the queue when this callback is called
440	# we don't do this in case we got an error	737	# we don't do this in case we got an error
441	if ($_[1] eq "OK") {	738	if ($_[1] eq "OK") {
442	$_[0]->unshift_read_line (sub {	739	$_[0]->unshift_read (line => sub {
443	my $response = $_[1];	740	my $response = $_[1];
444	...	741	...
445	});	742	});
446	}	743	}
447	});	744	});
448		745
449	# request two	746	# request two, simply returns 64 octets
450	$handle->push_write ("request 2\015\012");	747	$handle->push_write ("request 2\015\012");
451		748
452	# simply read 64 bytes, always	749	# simply read 64 bytes, always
453	$handle->push_read_chunk (64, sub {	750	$handle->push_read (chunk => 64, sub {
454	my $response = $_[1];	751	my $response = $_[1];
455	...	752	...
456	});	753	});
457		754
458	=over 4	755	=over 4
459		756
460	=cut	757	=cut
461		758
462	sub _drain_rbuf {	759	sub _drain_rbuf {
463	my ($self) = @_;	760	my ($self) = @_;
		761
		762	local $self->{_in_drain} = 1;
464		763
465	if (	764	if (
466	defined $self->{rbuf_max}	765	defined $self->{rbuf_max}
467	&& $self->{rbuf_max} < length $self->{rbuf}	766	&& $self->{rbuf_max} < length $self->{rbuf}
468	) {	767	) {
469	$! = &Errno::ENOSPC; return $self->error;	768	$self->_error (&Errno::ENOSPC, 1), return;
470	}	769	}
471		770
472	return if $self->{in_drain};	771	while () {
473	local $self->{in_drain} = 1;	772	$self->{rbuf} .= delete $self->{tls_rbuf} if exists $self->{tls_rbuf};#d#
474		773
475	while (my $len = length $self->{rbuf}) {	774	my $len = length $self->{rbuf};
476	no strict 'refs';	775
477	if (my $cb = shift @{ $self->{queue} }) {	776	if (my $cb = shift @{ $self->{_queue} }) {
478	unless ($cb->($self)) {	777	unless ($cb->($self)) {
479	if ($self->{eof}) {	778	if ($self->{_eof}) {
480	# no progress can be made (not enough data and no data forthcoming)	779	# no progress can be made (not enough data and no data forthcoming)
481	$! = &Errno::EPIPE; return $self->error;	780	$self->_error (&Errno::EPIPE, 1), return;
482	}	781	}
483		782
484	unshift @{ $self->{queue} }, $cb;	783	unshift @{ $self->{_queue} }, $cb;
485	return;	784	last;
486	}	785	}
487	} elsif ($self->{on_read}) {	786	} elsif ($self->{on_read}) {
		787	last unless $len;
		788
488	$self->{on_read}($self);	789	$self->{on_read}($self);
489		790
490	if (	791	if (
491	$self->{eof} # if no further data will arrive
492	&& $len == length $self->{rbuf} # and no data has been consumed	792	$len == length $self->{rbuf} # if no data has been consumed
493	&& !@{ $self->{queue} } # and the queue is still empty	793	&& !@{ $self->{_queue} } # and the queue is still empty
494	&& $self->{on_read} # and we still want to read data	794	&& $self->{on_read} # but we still have on_read
495	) {	795	) {
		796	# no further data will arrive
496	# then no progress can be made	797	# so no progress can be made
497	$! = &Errno::EPIPE; return $self->error;	798	$self->_error (&Errno::EPIPE, 1), return
		799	if $self->{_eof};
		800
		801	last; # more data might arrive
498	}	802	}
499	} else {	803	} else {
500	# read side becomes idle	804	# read side becomes idle
501	delete $self->{rw};	805	delete $self->{_rw} unless $self->{tls};
502	return;	806	last;
503	}	807	}
504	}	808	}
505		809
506	if ($self->{eof}) {	810	if ($self->{_eof}) {
507	$self->_shutdown;	811	if ($self->{on_eof}) {
508	$self->{on_eof}($self)	812	$self->{on_eof}($self)
509	if $self->{on_eof};	813	} else {
		814	$self->_error (0, 1);
		815	}
		816	}
		817
		818	# may need to restart read watcher
		819	unless ($self->{_rw}) {
		820	$self->start_read
		821	if $self->{on_read} || @{ $self->{_queue} };
510	}	822	}
511	}	823	}
512		824
513	=item $handle->on_read ($cb)	825	=item $handle->on_read ($cb)
514		826
…		…
520		832
521	sub on_read {	833	sub on_read {
522	my ($self, $cb) = @_;	834	my ($self, $cb) = @_;
523		835
524	$self->{on_read} = $cb;	836	$self->{on_read} = $cb;
		837	$self->_drain_rbuf if $cb && !$self->{_in_drain};
525	}	838	}
526		839
527	=item $handle->rbuf	840	=item $handle->rbuf
528		841
529	Returns the read buffer (as a modifiable lvalue).	842	Returns the read buffer (as a modifiable lvalue).
…		…
577		890
578	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	891	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
579	->($self, $cb, @_);	892	->($self, $cb, @_);
580	}	893	}
581		894
582	push @{ $self->{queue} }, $cb;	895	push @{ $self->{_queue} }, $cb;
583	$self->_drain_rbuf;	896	$self->_drain_rbuf unless $self->{_in_drain};
584	}	897	}
585		898
586	sub unshift_read {	899	sub unshift_read {
587	my $self = shift;	900	my $self = shift;
588	my $cb = pop;	901	my $cb = pop;
…		…
593	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	906	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
594	->($self, $cb, @_);	907	->($self, $cb, @_);
595	}	908	}
596		909
597		910
598	unshift @{ $self->{queue} }, $cb;	911	unshift @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	912	$self->_drain_rbuf unless $self->{_in_drain};
600	}	913	}
601		914
602	=item $handle->push_read (type => @args, $cb)	915	=item $handle->push_read (type => @args, $cb)
603		916
604	=item $handle->unshift_read (type => @args, $cb)	917	=item $handle->unshift_read (type => @args, $cb)
…		…
610	Predefined types are (if you have ideas for additional types, feel free to	923	Predefined types are (if you have ideas for additional types, feel free to
611	drop by and tell us):	924	drop by and tell us):
612		925
613	=over 4	926	=over 4
614		927
615	=item chunk => $octets, $cb->($self, $data)	928	=item chunk => $octets, $cb->($handle, $data)
616		929
617	Invoke the callback only once C<$octets> bytes have been read. Pass the	930	Invoke the callback only once C<$octets> bytes have been read. Pass the
618	data read to the callback. The callback will never be called with less	931	data read to the callback. The callback will never be called with less
619	data.	932	data.
620		933
…		…
634	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	947	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
635	1	948	1
636	}	949	}
637	};	950	};
638		951
639	# compatibility with older API
640	sub push_read_chunk {
641	$_[0]->push_read (chunk => $_[1], $_[2]);
642	}
643
644	sub unshift_read_chunk {
645	$_[0]->unshift_read (chunk => $_[1], $_[2]);
646	}
647
648	=item line => [$eol, ]$cb->($self, $line, $eol)	952	=item line => [$eol, ]$cb->($handle, $line, $eol)
649		953
650	The callback will be called only once a full line (including the end of	954	The callback will be called only once a full line (including the end of
651	line marker, C<$eol>) has been read. This line (excluding the end of line	955	line marker, C<$eol>) has been read. This line (excluding the end of line
652	marker) will be passed to the callback as second argument (C<$line>), and	956	marker) will be passed to the callback as second argument (C<$line>), and
653	the end of line marker as the third argument (C<$eol>).	957	the end of line marker as the third argument (C<$eol>).
…		…
667	=cut	971	=cut
668		972
669	register_read_type line => sub {	973	register_read_type line => sub {
670	my ($self, $cb, $eol) = @_;	974	my ($self, $cb, $eol) = @_;
671		975
672	$eol = qr|(\015?\012)| if @_ < 3;	976	if (@_ < 3) {
		977	# this is more than twice as fast as the generic code below
		978	sub {
		979	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		980
		981	$cb->($_[0], $1, $2);
		982	1
		983	}
		984	} else {
673	$eol = quotemeta $eol unless ref $eol;	985	$eol = quotemeta $eol unless ref $eol;
674	$eol = qr|^(.*?)($eol)|s;	986	$eol = qr|^(.*?)($eol)|s;
		987
		988	sub {
		989	$_[0]{rbuf} =~ s/$eol// or return;
		990
		991	$cb->($_[0], $1, $2);
		992	1
		993	}
		994	}
		995	};
		996
		997	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		998
		999	Makes a regex match against the regex object C<$accept> and returns
		1000	everything up to and including the match.
		1001
		1002	Example: read a single line terminated by '\n'.
		1003
		1004	$handle->push_read (regex => qr<\n>, sub { ... });
		1005
		1006	If C<$reject> is given and not undef, then it determines when the data is
		1007	to be rejected: it is matched against the data when the C<$accept> regex
		1008	does not match and generates an C<EBADMSG> error when it matches. This is
		1009	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		1010	receive buffer overflow).
		1011
		1012	Example: expect a single decimal number followed by whitespace, reject
		1013	anything else (not the use of an anchor).
		1014
		1015	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		1016
		1017	If C<$skip> is given and not C<undef>, then it will be matched against
		1018	the receive buffer when neither C<$accept> nor C<$reject> match,
		1019	and everything preceding and including the match will be accepted
		1020	unconditionally. This is useful to skip large amounts of data that you
		1021	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		1022	have to start matching from the beginning. This is purely an optimisation
		1023	and is usually worth only when you expect more than a few kilobytes.
		1024
		1025	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		1026	expect the header to be very large (it isn't in practise, but...), we use
		1027	a skip regex to skip initial portions. The skip regex is tricky in that
		1028	it only accepts something not ending in either \015 or \012, as these are
		1029	required for the accept regex.
		1030
		1031	$handle->push_read (regex =>
		1032	qr<\015\012\015\012>,
		1033	undef, # no reject
		1034	qr<^.*[^\015\012]>,
		1035	sub { ... });
		1036
		1037	=cut
		1038
		1039	register_read_type regex => sub {
		1040	my ($self, $cb, $accept, $reject, $skip) = @_;
		1041
		1042	my $data;
		1043	my $rbuf = \$self->{rbuf};
675		1044
676	sub {	1045	sub {
677	$_[0]{rbuf} =~ s/$eol// or return;	1046	# accept
678		1047	if ($$rbuf =~ $accept) {
679	$cb->($_[0], $1, $2);	1048	$data .= substr $$rbuf, 0, $+[0], "";
		1049	$cb->($self, $data);
		1050	return 1;
		1051	}
680	1	1052
		1053	# reject
		1054	if ($reject && $$rbuf =~ $reject) {
		1055	$self->_error (&Errno::EBADMSG);
		1056	}
		1057
		1058	# skip
		1059	if ($skip && $$rbuf =~ $skip) {
		1060	$data .= substr $$rbuf, 0, $+[0], "";
		1061	}
		1062
		1063	()
681	}	1064	}
682	};	1065	};
683		1066
684	# compatibility with older API
685	sub push_read_line {
686	my $self = shift;
687	$self->push_read (line => @_);
688	}
689
690	sub unshift_read_line {
691	my $self = shift;
692	$self->unshift_read (line => @_);
693	}
694
695	=item netstring => $cb->($string)	1067	=item netstring => $cb->($handle, $string)
696		1068
697	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	1069	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
698		1070
699	Throws an error with C<$!> set to EBADMSG on format violations.	1071	Throws an error with C<$!> set to EBADMSG on format violations.
700		1072
…		…
704	my ($self, $cb) = @_;	1076	my ($self, $cb) = @_;
705		1077
706	sub {	1078	sub {
707	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1079	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
708	if ($_[0]{rbuf} =~ /[^0-9]/) {	1080	if ($_[0]{rbuf} =~ /[^0-9]/) {
709	$! = &Errno::EBADMSG;	1081	$self->_error (&Errno::EBADMSG);
710	$self->error;
711	}	1082	}
712	return;	1083	return;
713	}	1084	}
714		1085
715	my $len = $1;	1086	my $len = $1;
…		…
718	my $string = $_[1];	1089	my $string = $_[1];
719	$_[0]->unshift_read (chunk => 1, sub {	1090	$_[0]->unshift_read (chunk => 1, sub {
720	if ($_[1] eq ",") {	1091	if ($_[1] eq ",") {
721	$cb->($_[0], $string);	1092	$cb->($_[0], $string);
722	} else {	1093	} else {
723	$! = &Errno::EBADMSG;	1094	$self->_error (&Errno::EBADMSG);
724	$self->error;
725	}	1095	}
726	});	1096	});
727	});	1097	});
728		1098
729	1	1099	1
730	}	1100	}
731	};	1101	};
732		1102
		1103	=item packstring => $format, $cb->($handle, $string)
		1104
		1105	An octet string prefixed with an encoded length. The encoding C<$format>
		1106	uses the same format as a Perl C<pack> format, but must specify a single
		1107	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1108	optional C<!>, C<< < >> or C<< > >> modifier).
		1109
		1110	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1111	EPP uses a prefix of C<N> (4 octtes).
		1112
		1113	Example: read a block of data prefixed by its length in BER-encoded
		1114	format (very efficient).
		1115
		1116	$handle->push_read (packstring => "w", sub {
		1117	my ($handle, $data) = @_;
		1118	});
		1119
		1120	=cut
		1121
		1122	register_read_type packstring => sub {
		1123	my ($self, $cb, $format) = @_;
		1124
		1125	sub {
		1126	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1127	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1128	or return;
		1129
		1130	$format = length pack $format, $len;
		1131
		1132	# bypass unshift if we already have the remaining chunk
		1133	if ($format + $len <= length $_[0]{rbuf}) {
		1134	my $data = substr $_[0]{rbuf}, $format, $len;
		1135	substr $_[0]{rbuf}, 0, $format + $len, "";
		1136	$cb->($_[0], $data);
		1137	} else {
		1138	# remove prefix
		1139	substr $_[0]{rbuf}, 0, $format, "";
		1140
		1141	# read remaining chunk
		1142	$_[0]->unshift_read (chunk => $len, $cb);
		1143	}
		1144
		1145	1
		1146	}
		1147	};
		1148
		1149	=item json => $cb->($handle, $hash_or_arrayref)
		1150
		1151	Reads a JSON object or array, decodes it and passes it to the
		1152	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
		1153
		1154	If a C<json> object was passed to the constructor, then that will be used
		1155	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1156
		1157	This read type uses the incremental parser available with JSON version
		1158	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1159	dependency on your own: this module will load the JSON module, but
		1160	AnyEvent does not depend on it itself.
		1161
		1162	Since JSON texts are fully self-delimiting, the C<json> read and write
		1163	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1164	the C<json> write type description, above, for an actual example.
		1165
		1166	=cut
		1167
		1168	register_read_type json => sub {
		1169	my ($self, $cb) = @_;
		1170
		1171	require JSON;
		1172
		1173	my $data;
		1174	my $rbuf = \$self->{rbuf};
		1175
		1176	my $json = $self->{json} ||= JSON->new->utf8;
		1177
		1178	sub {
		1179	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
		1180
		1181	if ($ref) {
		1182	$self->{rbuf} = $json->incr_text;
		1183	$json->incr_text = "";
		1184	$cb->($self, $ref);
		1185
		1186	1
		1187	} elsif ($@) {
		1188	# error case
		1189	$json->incr_skip;
		1190
		1191	$self->{rbuf} = $json->incr_text;
		1192	$json->incr_text = "";
		1193
		1194	$self->_error (&Errno::EBADMSG);
		1195
		1196	()
		1197	} else {
		1198	$self->{rbuf} = "";
		1199
		1200	()
		1201	}
		1202	}
		1203	};
		1204
		1205	=item storable => $cb->($handle, $ref)
		1206
		1207	Deserialises a L<Storable> frozen representation as written by the
		1208	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1209	data).
		1210
		1211	Raises C<EBADMSG> error if the data could not be decoded.
		1212
		1213	=cut
		1214
		1215	register_read_type storable => sub {
		1216	my ($self, $cb) = @_;
		1217
		1218	require Storable;
		1219
		1220	sub {
		1221	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1222	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1223	or return;
		1224
		1225	my $format = length pack "w", $len;
		1226
		1227	# bypass unshift if we already have the remaining chunk
		1228	if ($format + $len <= length $_[0]{rbuf}) {
		1229	my $data = substr $_[0]{rbuf}, $format, $len;
		1230	substr $_[0]{rbuf}, 0, $format + $len, "";
		1231	$cb->($_[0], Storable::thaw ($data));
		1232	} else {
		1233	# remove prefix
		1234	substr $_[0]{rbuf}, 0, $format, "";
		1235
		1236	# read remaining chunk
		1237	$_[0]->unshift_read (chunk => $len, sub {
		1238	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1239	$cb->($_[0], $ref);
		1240	} else {
		1241	$self->_error (&Errno::EBADMSG);
		1242	}
		1243	});
		1244	}
		1245
		1246	1
		1247	}
		1248	};
		1249
733	=back	1250	=back
734		1251
735	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1252	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
736		1253
737	This function (not method) lets you add your own types to C<push_read>.	1254	This function (not method) lets you add your own types to C<push_read>.
738		1255
739	Whenever the given C<type> is used, C<push_read> will invoke the code	1256	Whenever the given C<type> is used, C<push_read> will invoke the code
740	reference with the handle object, the callback and the remaining	1257	reference with the handle object, the callback and the remaining
…		…
742		1259
743	The code reference is supposed to return a callback (usually a closure)	1260	The code reference is supposed to return a callback (usually a closure)
744	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1261	that works as a plain read callback (see C<< ->push_read ($cb) >>).
745		1262
746	It should invoke the passed callback when it is done reading (remember to	1263	It should invoke the passed callback when it is done reading (remember to
747	pass C<$self> as first argument as all other callbacks do that).	1264	pass C<$handle> as first argument as all other callbacks do that).
748		1265
749	Note that this is a function, and all types registered this way will be	1266	Note that this is a function, and all types registered this way will be
750	global, so try to use unique names.	1267	global, so try to use unique names.
751		1268
752	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1269	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
755	=item $handle->stop_read	1272	=item $handle->stop_read
756		1273
757	=item $handle->start_read	1274	=item $handle->start_read
758		1275
759	In rare cases you actually do not want to read anything from the	1276	In rare cases you actually do not want to read anything from the
760	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1277	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
761	any queued callbacks will be executed then. To start reading again, call	1278	any queued callbacks will be executed then. To start reading again, call
762	C<start_read>.	1279	C<start_read>.
763		1280
		1281	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1282	you change the C<on_read> callback or push/unshift a read callback, and it
		1283	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1284	there are any read requests in the queue.
		1285
		1286	These methods will have no effect when in TLS mode (as TLS doesn't support
		1287	half-duplex connections).
		1288
764	=cut	1289	=cut
765		1290
766	sub stop_read {	1291	sub stop_read {
767	my ($self) = @_;	1292	my ($self) = @_;
768		1293
769	delete $self->{rw};	1294	delete $self->{_rw} unless $self->{tls};
770	}	1295	}
771		1296
772	sub start_read {	1297	sub start_read {
773	my ($self) = @_;	1298	my ($self) = @_;
774		1299
775	unless ($self->{rw} || $self->{eof}) {	1300	unless ($self->{_rw} || $self->{_eof}) {
776	Scalar::Util::weaken $self;	1301	Scalar::Util::weaken $self;
777		1302
778	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1303	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
779	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1304	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
780	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1305	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
781		1306
782	if ($len > 0) {	1307	if ($len > 0) {
783	$self->{filter_r}	1308	$self->{_activity} = AnyEvent->now;
784	? $self->{filter_r}->($self, $rbuf)	1309
785	: $self->_drain_rbuf;	1310	if ($self->{tls}) {
		1311	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1312
		1313	&_dotls ($self);
		1314	} else {
		1315	$self->_drain_rbuf unless $self->{_in_drain};
		1316	}
786		1317
787	} elsif (defined $len) {	1318	} elsif (defined $len) {
788	delete $self->{rw};	1319	delete $self->{_rw};
789	$self->{eof} = 1;	1320	$self->{_eof} = 1;
790	$self->_drain_rbuf;	1321	$self->_drain_rbuf unless $self->{_in_drain};
791		1322
792	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1323	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
793	return $self->error;	1324	return $self->_error ($!, 1);
794	}	1325	}
795	});	1326	});
796	}	1327	}
797	}	1328	}
798		1329
		1330	# poll the write BIO and send the data if applicable
799	sub _dotls {	1331	sub _dotls {
800	my ($self) = @_;	1332	my ($self) = @_;
801		1333
		1334	my $tmp;
		1335
802	if (length $self->{tls_wbuf}) {	1336	if (length $self->{_tls_wbuf}) {
803	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1337	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
804	substr $self->{tls_wbuf}, 0, $len, "";	1338	substr $self->{_tls_wbuf}, 0, $tmp, "";
805	}	1339	}
806	}	1340	}
807		1341
808	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1342	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1343	unless (length $tmp) {
		1344	# let's treat SSL-eof as we treat normal EOF
		1345	delete $self->{_rw};
		1346	$self->{_eof} = 1;
		1347	&_freetls;
		1348	}
		1349
		1350	$self->{tls_rbuf} .= $tmp;#d#
		1351	$self->_drain_rbuf unless $self->{_in_drain};
		1352	$self->{tls} or return; # tls session might have gone away in callback
		1353	}
		1354
		1355	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1356
		1357	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
		1358	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
		1359	return $self->_error ($!, 1);
		1360	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
		1361	return $self->_error (&Errno::EIO, 1);
		1362	}
		1363
		1364	# all other errors are fine for our purposes
		1365	}
		1366
		1367	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
809	$self->{wbuf} .= $buf;	1368	$self->{wbuf} .= $tmp;
810	$self->_drain_wbuf;	1369	$self->_drain_wbuf;
811	}
812
813	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
814	$self->{rbuf} .= $buf;
815	$self->_drain_rbuf;
816	}
817
818	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
819
820	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
821	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
822	$self->error;
823	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
824	$! = &Errno::EIO;
825	$self->error;
826	}
827
828	# all others are fine for our purposes
829	}	1370	}
830	}	1371	}
831		1372
832	=item $handle->starttls ($tls[, $tls_ctx])	1373	=item $handle->starttls ($tls[, $tls_ctx])
833		1374
…		…
839	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1380	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
840		1381
841	The second argument is the optional C<Net::SSLeay::CTX> object that is	1382	The second argument is the optional C<Net::SSLeay::CTX> object that is
842	used when AnyEvent::Handle has to create its own TLS connection object.	1383	used when AnyEvent::Handle has to create its own TLS connection object.
843		1384
844	=cut	1385	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1386	call and can be used or changed to your liking. Note that the handshake
		1387	might have already started when this function returns.
845		1388
846	# TODO: maybe document...	1389	If it an error to start a TLS handshake more than once per
		1390	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1391
		1392	=cut
		1393
847	sub starttls {	1394	sub starttls {
848	my ($self, $ssl, $ctx) = @_;	1395	my ($self, $ssl, $ctx) = @_;
849		1396
850	$self->stoptls;	1397	require Net::SSLeay;
851		1398
		1399	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1400	if $self->{tls};
		1401
852	if ($ssl eq "accept") {	1402	if ($ssl eq "accept") {
853	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1403	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
854	Net::SSLeay::set_accept_state ($ssl);	1404	Net::SSLeay::set_accept_state ($ssl);
855	} elsif ($ssl eq "connect") {	1405	} elsif ($ssl eq "connect") {
856	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1406	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
…		…
862	# basically, this is deep magic (because SSL_read should have the same issues)	1412	# basically, this is deep magic (because SSL_read should have the same issues)
863	# but the openssl maintainers basically said: "trust us, it just works".	1413	# but the openssl maintainers basically said: "trust us, it just works".
864	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1414	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
865	# and mismaintained ssleay-module doesn't even offer them).	1415	# and mismaintained ssleay-module doesn't even offer them).
866	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1416	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1417	#
		1418	# in short: this is a mess.
		1419	#
		1420	# note that we do not try to keep the length constant between writes as we are required to do.
		1421	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1422	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1423	# have identity issues in that area.
867	Net::SSLeay::CTX_set_mode ($self->{tls},	1424	Net::SSLeay::CTX_set_mode ($self->{tls},
868	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1425	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
869	| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1426	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
870		1427
871	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
873		1430
874	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1431	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
875		1432
876	$self->{filter_w} = sub {	1433	&_dotls; # need to trigger the initial handshake
877	$_[0]{tls_wbuf} .= ${$_[1]};	1434	$self->start_read; # make sure we actually do read
878	&_dotls;
879	};
880	$self->{filter_r} = sub {
881	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
882	&_dotls;
883	};
884	}	1435	}
885		1436
886	=item $handle->stoptls	1437	=item $handle->stoptls
887		1438
888	Destroys the SSL connection, if any. Partial read or write data will be	1439	Shuts down the SSL connection - this makes a proper EOF handshake by
889	lost.	1440	sending a close notify to the other side, but since OpenSSL doesn't
		1441	support non-blocking shut downs, it is not possible to re-use the stream
		1442	afterwards.
890		1443
891	=cut	1444	=cut
892		1445
893	sub stoptls {	1446	sub stoptls {
894	my ($self) = @_;	1447	my ($self) = @_;
895		1448
		1449	if ($self->{tls}) {
		1450	Net::SSLeay::shutdown ($self->{tls});
		1451
		1452	&_dotls;
		1453
		1454	# we don't give a shit. no, we do, but we can't. no...
		1455	# we, we... have to use openssl :/
		1456	&_freetls;
		1457	}
		1458	}
		1459
		1460	sub _freetls {
		1461	my ($self) = @_;
		1462
		1463	return unless $self->{tls};
		1464
896	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1465	Net::SSLeay::free (delete $self->{tls});
897	delete $self->{tls_rbio};	1466
898	delete $self->{tls_wbio};	1467	delete @$self{qw(_rbio _wbio _tls_wbuf)};
899	delete $self->{tls_wbuf};
900	delete $self->{filter_r};
901	delete $self->{filter_w};
902	}	1468	}
903		1469
904	sub DESTROY {	1470	sub DESTROY {
905	my $self = shift;	1471	my $self = shift;
906		1472
907	$self->stoptls;	1473	&_freetls;
		1474
		1475	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1476
		1477	if ($linger && length $self->{wbuf}) {
		1478	my $fh = delete $self->{fh};
		1479	my $wbuf = delete $self->{wbuf};
		1480
		1481	my @linger;
		1482
		1483	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1484	my $len = syswrite $fh, $wbuf, length $wbuf;
		1485
		1486	if ($len > 0) {
		1487	substr $wbuf, 0, $len, "";
		1488	} else {
		1489	@linger = (); # end
		1490	}
		1491	});
		1492	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1493	@linger = ();
		1494	});
		1495	}
		1496	}
		1497
		1498	=item $handle->destroy
		1499
		1500	Shuts down the handle object as much as possible - this call ensures that
		1501	no further callbacks will be invoked and resources will be freed as much
		1502	as possible. You must not call any methods on the object afterwards.
		1503
		1504	Normally, you can just "forget" any references to an AnyEvent::Handle
		1505	object and it will simply shut down. This works in fatal error and EOF
		1506	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1507	callback, so when you want to destroy the AnyEvent::Handle object from
		1508	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1509	that case.
		1510
		1511	The handle might still linger in the background and write out remaining
		1512	data, as specified by the C<linger> option, however.
		1513
		1514	=cut
		1515
		1516	sub destroy {
		1517	my ($self) = @_;
		1518
		1519	$self->DESTROY;
		1520	%$self = ();
908	}	1521	}
909		1522
910	=item AnyEvent::Handle::TLS_CTX	1523	=item AnyEvent::Handle::TLS_CTX
911		1524
912	This function creates and returns the Net::SSLeay::CTX object used by	1525	This function creates and returns the Net::SSLeay::CTX object used by
…		…
942	}	1555	}
943	}	1556	}
944		1557
945	=back	1558	=back
946		1559
		1560
		1561	=head1 NONFREQUENTLY ASKED QUESTIONS
		1562
		1563	=over 4
		1564
		1565	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1566	still get further invocations!
		1567
		1568	That's because AnyEvent::Handle keeps a reference to itself when handling
		1569	read or write callbacks.
		1570
		1571	It is only safe to "forget" the reference inside EOF or error callbacks,
		1572	from within all other callbacks, you need to explicitly call the C<<
		1573	->destroy >> method.
		1574
		1575	=item I get different callback invocations in TLS mode/Why can't I pause
		1576	reading?
		1577
		1578	Unlike, say, TCP, TLS connections do not consist of two independent
		1579	communication channels, one for each direction. Or put differently. The
		1580	read and write directions are not independent of each other: you cannot
		1581	write data unless you are also prepared to read, and vice versa.
		1582
		1583	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1584	callback invocations when you are not expecting any read data - the reason
		1585	is that AnyEvent::Handle always reads in TLS mode.
		1586
		1587	During the connection, you have to make sure that you always have a
		1588	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1589	connection (or when you no longer want to use it) you can call the
		1590	C<destroy> method.
		1591
		1592	=item How do I read data until the other side closes the connection?
		1593
		1594	If you just want to read your data into a perl scalar, the easiest way
		1595	to achieve this is by setting an C<on_read> callback that does nothing,
		1596	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1597	will be in C<$_[0]{rbuf}>:
		1598
		1599	$handle->on_read (sub { });
		1600	$handle->on_eof (undef);
		1601	$handle->on_error (sub {
		1602	my $data = delete $_[0]{rbuf};
		1603	undef $handle;
		1604	});
		1605
		1606	The reason to use C<on_error> is that TCP connections, due to latencies
		1607	and packets loss, might get closed quite violently with an error, when in
		1608	fact, all data has been received.
		1609
		1610	It is usually better to use acknowledgements when transferring data,
		1611	to make sure the other side hasn't just died and you got the data
		1612	intact. This is also one reason why so many internet protocols have an
		1613	explicit QUIT command.
		1614
		1615	=item I don't want to destroy the handle too early - how do I wait until
		1616	all data has been written?
		1617
		1618	After writing your last bits of data, set the C<on_drain> callback
		1619	and destroy the handle in there - with the default setting of
		1620	C<low_water_mark> this will be called precisely when all data has been
		1621	written to the socket:
		1622
		1623	$handle->push_write (...);
		1624	$handle->on_drain (sub {
		1625	warn "all data submitted to the kernel\n";
		1626	undef $handle;
		1627	});
		1628
		1629	=back
		1630
		1631
		1632	=head1 SUBCLASSING AnyEvent::Handle
		1633
		1634	In many cases, you might want to subclass AnyEvent::Handle.
		1635
		1636	To make this easier, a given version of AnyEvent::Handle uses these
		1637	conventions:
		1638
		1639	=over 4
		1640
		1641	=item * all constructor arguments become object members.
		1642
		1643	At least initially, when you pass a C<tls>-argument to the constructor it
		1644	will end up in C<< $handle->{tls} >>. Those members might be changed or
		1645	mutated later on (for example C<tls> will hold the TLS connection object).
		1646
		1647	=item * other object member names are prefixed with an C<_>.
		1648
		1649	All object members not explicitly documented (internal use) are prefixed
		1650	with an underscore character, so the remaining non-C<_>-namespace is free
		1651	for use for subclasses.
		1652
		1653	=item * all members not documented here and not prefixed with an underscore
		1654	are free to use in subclasses.
		1655
		1656	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1657	member variables, but thats just life, at least it is documented.
		1658
		1659	=back
		1660
947	=head1 AUTHOR	1661	=head1 AUTHOR
948		1662
949	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1663	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
950		1664
951	=cut	1665	=cut

Diff Legend

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