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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.48 by root, Thu May 29 00:27:06 2008 UTC vs.
Revision 1.129 by root, Mon Jun 29 11:04:09 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(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
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.42;
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->($handle)	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->($handle)	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>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		119
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100
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->($handle)	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<$handle->{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>).
…		…
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
125	=item timeout => $fractional_seconds	154	=item timeout => $fractional_seconds
126		155
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	156	If non-zero, then this enables an "inactivity" timeout: whenever this many
128	seconds pass without a successful read or write on the underlying file	157	seconds pass without a successful read or write on the underlying file
129	handle, the C<on_timeout> callback will be invoked (and if that one is	158	handle, the C<on_timeout> callback will be invoked (and if that one is
130	missing, an C<ETIMEDOUT> error will be raised).	159	missing, a non-fatal C<ETIMEDOUT> error will be raised).
131		160
132	Note that timeout processing is also active when you currently do not have	161	Note that timeout processing is also active when you currently do not have
133	any outstanding read or write requests: If you plan to keep the connection	162	any outstanding read or write requests: If you plan to keep the connection
134	idle then you should disable the timout temporarily or ignore the timeout	163	idle then you should disable the timout temporarily or ignore the timeout
135	in the C<on_timeout> callback.	164	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		165	restart the timeout.
136		166
137	Zero (the default) disables this timeout.	167	Zero (the default) disables this timeout.
138		168
139	=item on_timeout => $cb->($handle)	169	=item on_timeout => $cb->($handle)
140		170
…		…
144		174
145	=item rbuf_max => <bytes>	175	=item rbuf_max => <bytes>
146		176
147	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>)
148	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
149	avoid denial-of-service attacks.	179	avoid some forms of denial-of-service attacks.
150		180
151	For example, a server accepting connections from untrusted sources should	181	For example, a server accepting connections from untrusted sources should
152	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
153	(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
154	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
155	isn't finished).	185	isn't finished).
156		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
157	=item read_size => <bytes>	213	=item read_size => <bytes>
158		214
159	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
160	during each (loop iteration). Default: C<8192>.	216	try to read during each loop iteration, which affects memory
		217	requirements). Default: C<8192>.
161		218
162	=item low_water_mark => <bytes>	219	=item low_water_mark => <bytes>
163		220
164	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
165	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
166	considered empty.	223	considered empty.
167		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
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		243
170	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
171	will start making tls handshake and will transparently encrypt/decrypt	245	AnyEvent will start a TLS handshake as soon as the conenction has been
172	data.	246	established and will transparently encrypt/decrypt data afterwards.
173		247
174	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
175	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.
176		252
177	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
178	connection, use C<connect> mode.	254	C<accept>, and for the TLS client side of a connection, use C<connect>
		255	mode.
179		256
180	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
181	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>
182	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
183	AnyEvent::Handle.	260	AnyEvent::Handle.
184		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
185	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.
186		268
187	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
188		270
189	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
190	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
192		274
193	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
194		276
195	This is the json coder object used by the C<json> read and write types.	277	This is the json coder object used by the C<json> read and write types.
196		278
197	If you don't supply it, then AnyEvent::Handle will create and use a	279	If you don't supply it, then AnyEvent::Handle will create and use a
198	suitable one, which will write and expect UTF-8 encoded JSON texts.	280	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		281	texts.
199		282
200	Note that you are responsible to depend on the JSON module if you want to	283	Note that you are responsible to depend on the JSON module if you want to
201	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
202		285
203	=item filter_r => $cb
204
205	=item filter_w => $cb
206
207	These exist, but are undocumented at this time.
208
209	=back	286	=back
210		287
211	=cut	288	=cut
212		289
213	sub new {	290	sub new {
…		…
217		294
218	$self->{fh} or Carp::croak "mandatory argument fh is missing";	295	$self->{fh} or Carp::croak "mandatory argument fh is missing";
219		296
220	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
221		298
222	if ($self->{tls}) {
223	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
225	}	300	if $self->{tls};
226
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231		301
232	$self->{_activity} = AnyEvent->now;	302	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	303	$self->_timeout;
234		304
		305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		306	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		307
235	$self->start_read;	308	$self->start_read
		309	if $self->{on_read};
236		310
237	$self	311	$self
238	}	312	}
239		313
240	sub _shutdown {	314	sub _shutdown {
241	my ($self) = @_;	315	my ($self) = @_;
242		316
243	delete $self->{_tw};	317	delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)};
244	delete $self->{_rw};
245	delete $self->{_ww};
246	delete $self->{fh};
247	}
248		318
		319	&_freetls;
		320	}
		321
249	sub error {	322	sub _error {
250	my ($self) = @_;	323	my ($self, $errno, $fatal) = @_;
251		324
252	{
253	local $!;
254	$self->_shutdown;	325	$self->_shutdown
255	}	326	if $fatal;
256		327
257	$self->{on_error}($self)	328	$! = $errno;
		329
258	if $self->{on_error};	330	if ($self->{on_error}) {
259		331	$self->{on_error}($self, $fatal);
		332	} elsif ($self->{fh}) {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	333	Carp::croak "AnyEvent::Handle uncaught error: $!";
		334	}
261	}	335	}
262		336
263	=item $fh = $handle->fh	337	=item $fh = $handle->fh
264		338
265	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.
266		340
267	=cut	341	=cut
268		342
269	sub fh { $_[0]{fh} }	343	sub fh { $_[0]{fh} }
270		344
…		…
288	$_[0]{on_eof} = $_[1];	362	$_[0]{on_eof} = $_[1];
289	}	363	}
290		364
291	=item $handle->on_timeout ($cb)	365	=item $handle->on_timeout ($cb)
292		366
293	Replace the current C<on_timeout> callback, or disables the callback	367	Replace the current C<on_timeout> callback, or disables the callback (but
294	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	368	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
295	argument.	369	argument and method.
296		370
297	=cut	371	=cut
298		372
299	sub on_timeout {	373	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	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	};
301	}	402	}
302		403
303	#############################################################################	404	#############################################################################
304		405
305	=item $handle->timeout ($seconds)	406	=item $handle->timeout ($seconds)
…		…
331	$self->{_activity} = $NOW;	432	$self->{_activity} = $NOW;
332		433
333	if ($self->{on_timeout}) {	434	if ($self->{on_timeout}) {
334	$self->{on_timeout}($self);	435	$self->{on_timeout}($self);
335	} else {	436	} else {
336	$! = Errno::ETIMEDOUT;	437	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	438	}
339		439
340	# callbakx could have changed timeout value, optimise	440	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	441	return unless $self->{timeout};
342		442
343	# calculate new after	443	# calculate new after
344	$after = $self->{timeout};	444	$after = $self->{timeout};
345	}	445	}
346		446
347	Scalar::Util::weaken $self;	447	Scalar::Util::weaken $self;
		448	return unless $self; # ->error could have destroyed $self
348		449
349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	450	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	451	delete $self->{_tw};
351	$self->_timeout;	452	$self->_timeout;
352	});	453	});
…		…
383	my ($self, $cb) = @_;	484	my ($self, $cb) = @_;
384		485
385	$self->{on_drain} = $cb;	486	$self->{on_drain} = $cb;
386		487
387	$cb->($self)	488	$cb->($self)
388	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	489	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
389	}	490	}
390		491
391	=item $handle->push_write ($data)	492	=item $handle->push_write ($data)
392		493
393	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
…		…
410	substr $self->{wbuf}, 0, $len, "";	511	substr $self->{wbuf}, 0, $len, "";
411		512
412	$self->{_activity} = AnyEvent->now;	513	$self->{_activity} = AnyEvent->now;
413		514
414	$self->{on_drain}($self)	515	$self->{on_drain}($self)
415	if $self->{low_water_mark} >= length $self->{wbuf}	516	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
416	&& $self->{on_drain};	517	&& $self->{on_drain};
417		518
418	delete $self->{_ww} unless length $self->{wbuf};	519	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	520	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	521	$self->_error ($!, 1);
421	}	522	}
422	};	523	};
423		524
424	# try to write data immediately	525	# try to write data immediately
425	$cb->();	526	$cb->() unless $self->{autocork};
426		527
427	# if still data left in wbuf, we need to poll	528	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	529	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	530	if length $self->{wbuf};
430	};	531	};
…		…
444		545
445	@_ = ($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")
446	->($self, @_);	547	->($self, @_);
447	}	548	}
448		549
449	if ($self->{filter_w}) {	550	if ($self->{tls}) {
450	$self->{filter_w}($self, \$_[0]);	551	$self->{_tls_wbuf} .= $_[0];
		552
		553	&_dotls ($self);
451	} else {	554	} else {
452	$self->{wbuf} .= $_[0];	555	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	556	$self->_drain_wbuf;
454	}	557	}
455	}	558	}
456		559
457	=item $handle->push_write (type => @args)	560	=item $handle->push_write (type => @args)
458		561
459	=item $handle->unshift_write (type => @args)
460
461	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
462	the job by specifying a type and type-specific arguments.	563	the job by specifying a type and type-specific arguments.
463		564
464	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
465	drop by and tell us):	566	drop by and tell us):
…		…
469	=item netstring => $string	570	=item netstring => $string
470		571
471	Formats the given value as netstring	572	Formats the given value as netstring
472	(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).
473		574
474	=back
475
476	=cut	575	=cut
477		576
478	register_write_type netstring => sub {	577	register_write_type netstring => sub {
479	my ($self, $string) = @_;	578	my ($self, $string) = @_;
480		579
481	sprintf "%d:%s,", (length $string), $string	580	(length $string) . ":$string,"
		581	};
		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
482	};	596	};
483		597
484	=item json => $array_or_hashref	598	=item json => $array_or_hashref
485		599
486	Encodes the given hash or array reference into a JSON object. Unless you	600	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		634
521	$self->{json} ? $self->{json}->encode ($ref)	635	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	636	: JSON::encode_json ($ref)
523	};	637	};
524		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
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	656	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		657
527	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>.
528	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
529	reference with the handle object and the remaining arguments.	660	reference with the handle object and the remaining arguments.
…		…
549	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
550	a queue.	681	a queue.
551		682
552	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
553	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
554	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
555	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).
556		688
557	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
558	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
559	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
560	below).	692	done its job (see C<push_read>, below).
561		693
562	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
563	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.
564		696
565	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
566	the specified number of bytes which give an XML datagram.	698	the specified number of bytes which give an XML datagram.
567		699
568	# in the default state, expect some header bytes	700	# in the default state, expect some header bytes
569	$handle->on_read (sub {	701	$handle->on_read (sub {
570	# 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)
571	shift->unshift_read_chunk (4, sub {	703	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	704	# header arrived, decode
573	my $len = unpack "N", $_[1];	705	my $len = unpack "N", $_[1];
574		706
575	# now read the payload	707	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	708	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	709	my $xml = $_[1];
578	# handle xml	710	# handle xml
579	});	711	});
580	});	712	});
581	});	713	});
582		714
583	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"
584	"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
585	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
586	pipeline sending both requests and manipulate the queue as necessary in	718	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	719	in the callbacks.
588		720
589	# 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"
590	$handle->push_write ("request 1\015\012");	726	$handle->push_write ("request 1\015\012");
591		727
592	# 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
593	$handle->push_read_line (sub {	729	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	730	# if we got an "OK", we have to _prepend_ another line,
595	# 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
596	# which are already in the queue when this callback is called	732	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	733	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	734	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	735	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	736	my $response = $_[1];
601	...	737	...
602	});	738	});
603	}	739	}
604	});	740	});
605		741
606	# request two	742	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	743	$handle->push_write ("request 2\015\012");
608		744
609	# simply read 64 bytes, always	745	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	746	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	747	my $response = $_[1];
612	...	748	...
613	});	749	});
614		750
615	=over 4	751	=over 4
616		752
617	=cut	753	=cut
618		754
619	sub _drain_rbuf {	755	sub _drain_rbuf {
620	my ($self) = @_;	756	my ($self) = @_;
		757
		758	local $self->{_in_drain} = 1;
621		759
622	if (	760	if (
623	defined $self->{rbuf_max}	761	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	762	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	763	) {
626	$! = &Errno::ENOSPC;	764	$self->_error (&Errno::ENOSPC, 1), return;
627	$self->error;
628	}	765	}
629		766
630	return if $self->{in_drain};	767	while () {
631	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};
632		771
633	while (my $len = length $self->{rbuf}) {	772	my $len = length $self->{rbuf};
634	no strict 'refs';	773
635	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	775	unless ($cb->($self)) {
637	if ($self->{_eof}) {	776	if ($self->{_eof}) {
638	# 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)
639	$! = &Errno::EPIPE;	778	$self->_error (&Errno::EPIPE, 1), return;
640	$self->error;
641	}	779	}
642		780
643	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
644	return;	782	last;
645	}	783	}
646	} elsif ($self->{on_read}) {	784	} elsif ($self->{on_read}) {
		785	last unless $len;
		786
647	$self->{on_read}($self);	787	$self->{on_read}($self);
648		788
649	if (	789	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	790	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	791	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	792	&& $self->{on_read} # but we still have on_read
654	) {	793	) {
		794	# no further data will arrive
655	# then no progress can be made	795	# so no progress can be made
656	$! = &Errno::EPIPE;	796	$self->_error (&Errno::EPIPE, 1), return
657	$self->error;	797	if $self->{_eof};
		798
		799	last; # more data might arrive
658	}	800	}
659	} else {	801	} else {
660	# read side becomes idle	802	# read side becomes idle
661	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
662	return;	804	last;
663	}	805	}
664	}	806	}
665		807
		808	if ($self->{_eof}) {
		809	if ($self->{on_eof}) {
666	$self->{on_eof}($self)	810	$self->{on_eof}($self)
667	if $self->{_eof} && $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} };
		820	}
668	}	821	}
669		822
670	=item $handle->on_read ($cb)	823	=item $handle->on_read ($cb)
671		824
672	This replaces the currently set C<on_read> callback, or clears it (when	825	This replaces the currently set C<on_read> callback, or clears it (when
…		…
677		830
678	sub on_read {	831	sub on_read {
679	my ($self, $cb) = @_;	832	my ($self, $cb) = @_;
680		833
681	$self->{on_read} = $cb;	834	$self->{on_read} = $cb;
		835	$self->_drain_rbuf if $cb && !$self->{_in_drain};
682	}	836	}
683		837
684	=item $handle->rbuf	838	=item $handle->rbuf
685		839
686	Returns the read buffer (as a modifiable lvalue).	840	Returns the read buffer (as a modifiable lvalue).
687		841
688	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} >>
689	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.
690		847
691	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>,
692	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
693	automatically manage the read buffer.	850	automatically manage the read buffer.
694		851
…		…
735	$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")
736	->($self, $cb, @_);	893	->($self, $cb, @_);
737	}	894	}
738		895
739	push @{ $self->{_queue} }, $cb;	896	push @{ $self->{_queue} }, $cb;
740	$self->_drain_rbuf;	897	$self->_drain_rbuf unless $self->{_in_drain};
741	}	898	}
742		899
743	sub unshift_read {	900	sub unshift_read {
744	my $self = shift;	901	my $self = shift;
745	my $cb = pop;	902	my $cb = pop;
…		…
751	->($self, $cb, @_);	908	->($self, $cb, @_);
752	}	909	}
753		910
754		911
755	unshift @{ $self->{_queue} }, $cb;	912	unshift @{ $self->{_queue} }, $cb;
756	$self->_drain_rbuf;	913	$self->_drain_rbuf unless $self->{_in_drain};
757	}	914	}
758		915
759	=item $handle->push_read (type => @args, $cb)	916	=item $handle->push_read (type => @args, $cb)
760		917
761	=item $handle->unshift_read (type => @args, $cb)	918	=item $handle->unshift_read (type => @args, $cb)
…		…
791	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	948	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
792	1	949	1
793	}	950	}
794	};	951	};
795		952
796	# compatibility with older API
797	sub push_read_chunk {
798	$_[0]->push_read (chunk => $_[1], $_[2]);
799	}
800
801	sub unshift_read_chunk {
802	$_[0]->unshift_read (chunk => $_[1], $_[2]);
803	}
804
805	=item line => [$eol, ]$cb->($handle, $line, $eol)	953	=item line => [$eol, ]$cb->($handle, $line, $eol)
806		954
807	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
808	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
809	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
…		…
824	=cut	972	=cut
825		973
826	register_read_type line => sub {	974	register_read_type line => sub {
827	my ($self, $cb, $eol) = @_;	975	my ($self, $cb, $eol) = @_;
828		976
829	$eol = qr\|(\015?\012)\| if @_ < 3;	977	if (@_ < 3) {
830	$eol = quotemeta $eol unless ref $eol;	978	# this is more than twice as fast as the generic code below
831	$eol = qr\|^(.*?)($eol)\|s;
832
833	sub {	979	sub {
834	$_[0]{rbuf} =~ s/$eol// or return;	980	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
835		981
836	$cb->($_[0], $1, $2);	982	$cb->($_[0], $1, $2);
837	1
838	}
839	};
840
841	# compatibility with older API
842	sub push_read_line {
843	my $self = shift;
844	$self->push_read (line => @_);
845	}
846
847	sub unshift_read_line {
848	my $self = shift;
849	$self->unshift_read (line => @_);
850	}
851
852	=item netstring => $cb->($handle, $string)
853
854	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
855
856	Throws an error with C<$!> set to EBADMSG on format violations.
857
858	=cut
859
860	register_read_type netstring => sub {
861	my ($self, $cb) = @_;
862
863	sub {
864	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
865	if ($_[0]{rbuf} =~ /[^0-9]/) {
866	$! = &Errno::EBADMSG;
867	$self->error;
868	}	983	1
869	return;
870	}	984	}
		985	} else {
		986	$eol = quotemeta $eol unless ref $eol;
		987	$eol = qr\|^(.*?)($eol)\|s;
871		988
872	my $len = $1;	989	sub {
		990	$_[0]{rbuf} =~ s/$eol// or return;
873		991
874	$self->unshift_read (chunk => $len, sub {	992	$cb->($_[0], $1, $2);
875	my $string = $_[1];
876	$_[0]->unshift_read (chunk => 1, sub {
877	if ($_[1] eq ",") {
878	$cb->($_[0], $string);
879	} else {
880	$! = &Errno::EBADMSG;
881	$self->error;
882	}
883	});	993	1
884	});	994	}
885
886	1
887	}	995	}
888	};	996	};
889		997
890	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	998	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
891		999
…		…
943	return 1;	1051	return 1;
944	}	1052	}
945		1053
946	# reject	1054	# reject
947	if ($reject && $$rbuf =~ $reject) {	1055	if ($reject && $$rbuf =~ $reject) {
948	$! = &Errno::EBADMSG;	1056	$self->_error (&Errno::EBADMSG);
949	$self->error;
950	}	1057	}
951		1058
952	# skip	1059	# skip
953	if ($skip && $$rbuf =~ $skip) {	1060	if ($skip && $$rbuf =~ $skip) {
954	$data .= substr $$rbuf, 0, $+[0], "";	1061	$data .= substr $$rbuf, 0, $+[0], "";
…		…
956		1063
957	()	1064	()
958	}	1065	}
959	};	1066	};
960		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
961	=item json => $cb->($handle, $hash_or_arrayref)	1150	=item json => $cb->($handle, $hash_or_arrayref)
962		1151
963	Reads a JSON object or array, decodes it and passes it to the callback.	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.
964		1154
965	If a C<json> object was passed to the constructor, then that will be used	1155	If a C<json> object was passed to the constructor, then that will be used
966	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1156	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
967		1157
968	This read type uses the incremental parser available with JSON version	1158	This read type uses the incremental parser available with JSON version
…		…
975	the C<json> write type description, above, for an actual example.	1165	the C<json> write type description, above, for an actual example.
976		1166
977	=cut	1167	=cut
978		1168
979	register_read_type json => sub {	1169	register_read_type json => sub {
980	my ($self, $cb, $accept, $reject, $skip) = @_;	1170	my ($self, $cb) = @_;
981		1171
982	require JSON;	1172	require JSON;
983		1173
984	my $data;	1174	my $data;
985	my $rbuf = \$self->{rbuf};	1175	my $rbuf = \$self->{rbuf};
986		1176
987	my $json = $self->{json} \|\|= JSON->new->utf8;	1177	my $json = $self->{json} \|\|= JSON->new->utf8;
988		1178
989	sub {	1179	sub {
990	my $ref = $json->incr_parse ($self->{rbuf});	1180	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
991		1181
992	if ($ref) {	1182	if ($ref) {
993	$self->{rbuf} = $json->incr_text;	1183	$self->{rbuf} = $json->incr_text;
994	$json->incr_text = "";	1184	$json->incr_text = "";
995	$cb->($self, $ref);	1185	$cb->($self, $ref);
996		1186
997	1	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	()
998	} else {	1198	} else {
999	$self->{rbuf} = "";	1199	$self->{rbuf} = "";
		1200
1000	()	1201	()
1001	}	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
1002	}	1248	}
1003	};	1249	};
1004		1250
1005	=back	1251	=back
1006		1252
…		…
1027	=item $handle->stop_read	1273	=item $handle->stop_read
1028		1274
1029	=item $handle->start_read	1275	=item $handle->start_read
1030		1276
1031	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
1032	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
1033	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
1034	C<start_read>.	1280	C<start_read>.
1035		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
1036	=cut	1290	=cut
1037		1291
1038	sub stop_read {	1292	sub stop_read {
1039	my ($self) = @_;	1293	my ($self) = @_;
1040		1294
1041	delete $self->{_rw};	1295	delete $self->{_rw} unless $self->{tls};
1042	}	1296	}
1043		1297
1044	sub start_read {	1298	sub start_read {
1045	my ($self) = @_;	1299	my ($self) = @_;
1046		1300
1047	unless ($self->{_rw} \|\| $self->{_eof}) {	1301	unless ($self->{_rw} \|\| $self->{_eof}) {
1048	Scalar::Util::weaken $self;	1302	Scalar::Util::weaken $self;
1049		1303
1050	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1304	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1051	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1305	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1052	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;
1053		1307
1054	if ($len > 0) {	1308	if ($len > 0) {
1055	$self->{_activity} = AnyEvent->now;	1309	$self->{_activity} = AnyEvent->now;
1056		1310
1057	$self->{filter_r}	1311	if ($self->{tls}) {
1058	? $self->{filter_r}($self, $rbuf)	1312	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1059	: $self->_drain_rbuf;	1313
		1314	&_dotls ($self);
		1315	} else {
		1316	$self->_drain_rbuf unless $self->{_in_drain};
		1317	}
1060		1318
1061	} elsif (defined $len) {	1319	} elsif (defined $len) {
1062	delete $self->{_rw};	1320	delete $self->{_rw};
1063	$self->{_eof} = 1;	1321	$self->{_eof} = 1;
1064	$self->_drain_rbuf;	1322	$self->_drain_rbuf unless $self->{_in_drain};
1065		1323
1066	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1324	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1067	return $self->error;	1325	return $self->_error ($!, 1);
1068	}	1326	}
1069	});	1327	});
1070	}	1328	}
1071	}	1329	}
1072		1330
		1331	# poll the write BIO and send the data if applicable
1073	sub _dotls {	1332	sub _dotls {
1074	my ($self) = @_;	1333	my ($self) = @_;
1075		1334
		1335	my $tmp;
		1336
1076	if (length $self->{_tls_wbuf}) {	1337	if (length $self->{_tls_wbuf}) {
1077	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1338	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1078	substr $self->{_tls_wbuf}, 0, $len, "";	1339	substr $self->{_tls_wbuf}, 0, $tmp, "";
1079	}	1340	}
1080	}	1341	}
1081		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
1082	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1368	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1083	$self->{wbuf} .= $buf;	1369	$self->{wbuf} .= $tmp;
1084	$self->_drain_wbuf;	1370	$self->_drain_wbuf;
1085	}
1086
1087	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
1088	$self->{rbuf} .= $buf;
1089	$self->_drain_rbuf;
1090	}
1091
1092	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1093
1094	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1095	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1096	$self->error;
1097	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1098	$! = &Errno::EIO;
1099	$self->error;
1100	}
1101
1102	# all others are fine for our purposes
1103	}	1371	}
1104	}	1372	}
1105		1373
1106	=item $handle->starttls ($tls[, $tls_ctx])	1374	=item $handle->starttls ($tls[, $tls_ctx])
1107		1375
…		…
1117		1385
1118	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
1119	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
1120	might have already started when this function returns.	1388	might have already started when this function returns.
1121		1389
1122	=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).
1123		1392
1124	# TODO: maybe document...	1393	=cut
		1394
1125	sub starttls {	1395	sub starttls {
1126	my ($self, $ssl, $ctx) = @_;	1396	my ($self, $ssl, $ctx) = @_;
1127		1397
1128	$self->stoptls;	1398	require Net::SSLeay;
1129		1399
		1400	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1401	if $self->{tls};
		1402
1130	if ($ssl eq "accept") {	1403	if ($ssl eq "accept") {
1131	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1404	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1132	Net::SSLeay::set_accept_state ($ssl);	1405	Net::SSLeay::set_accept_state ($ssl);
1133	} elsif ($ssl eq "connect") {	1406	} elsif ($ssl eq "connect") {
1134	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1407	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1140	# 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)
1141	# but the openssl maintainers basically said: "trust us, it just works".	1414	# but the openssl maintainers basically said: "trust us, it just works".
1142	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1415	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1143	# and mismaintained ssleay-module doesn't even offer them).	1416	# and mismaintained ssleay-module doesn't even offer them).
1144	# 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.
1145	Net::SSLeay::CTX_set_mode ($self->{tls},	1425	Net::SSLeay::CTX_set_mode ($self->{tls},
1146	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1426	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1147	\| (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));
1148		1428
1149	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1150	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1430	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1151		1431
1152	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1432	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1153		1433
1154	$self->{filter_w} = sub {	1434	&_dotls; # need to trigger the initial handshake
1155	$_[0]{_tls_wbuf} .= ${$_[1]};	1435	$self->start_read; # make sure we actually do read
1156	&_dotls;
1157	};
1158	$self->{filter_r} = sub {
1159	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1160	&_dotls;
1161	};
1162	}	1436	}
1163		1437
1164	=item $handle->stoptls	1438	=item $handle->stoptls
1165		1439
1166	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
1167	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.
1168		1444
1169	=cut	1445	=cut
1170		1446
1171	sub stoptls {	1447	sub stoptls {
1172	my ($self) = @_;	1448	my ($self) = @_;
1173		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
1174	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1466	Net::SSLeay::free (delete $self->{tls});
1175		1467
1176	delete $self->{_rbio};	1468	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1177	delete $self->{_wbio};
1178	delete $self->{_tls_wbuf};
1179	delete $self->{filter_r};
1180	delete $self->{filter_w};
1181	}	1469	}
1182		1470
1183	sub DESTROY {	1471	sub DESTROY {
1184	my $self = shift;	1472	my ($self) = @_;
1185		1473
1186	$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 = ();
1187	}	1522	}
1188		1523
1189	=item AnyEvent::Handle::TLS_CTX	1524	=item AnyEvent::Handle::TLS_CTX
1190		1525
1191	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
…		…
1221	}	1556	}
1222	}	1557	}
1223		1558
1224	=back	1559	=back
1225		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
1226	=head1 SUBCLASSING AnyEvent::Handle	1633	=head1 SUBCLASSING AnyEvent::Handle
1227		1634
1228	In many cases, you might want to subclass AnyEvent::Handle.	1635	In many cases, you might want to subclass AnyEvent::Handle.
1229		1636
1230	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
…		…
1233	=over 4	1640	=over 4
1234		1641
1235	=item * all constructor arguments become object members.	1642	=item * all constructor arguments become object members.
1236		1643
1237	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
1238	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
1239	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).
1240		1647
1241	=item * other object member names are prefixed with an C<_>.	1648	=item * other object member names are prefixed with an C<_>.
1242		1649
1243	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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.48 by root, Thu May 29 00:27:06 2008 UTC vs. Revision 1.129 by root, Mon Jun 29 11:04:09 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.48 by root, Thu May 29 00:27:06 2008 UTC vs.
Revision 1.129 by root, Mon Jun 29 11:04:09 2009 UTC