[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.107 by root, Wed Nov 26 06:40:47 2008 UTC

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