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

Diff Legend

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