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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.64 by root, Fri Jun 6 11:01:17 2008 UTC vs.
Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(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 = 4.15;	19	our $VERSION = 4.45;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detcted,	84	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		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
84	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,
85	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
86	waiting for data.	95	waiting for data.
		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>.
87		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal)
89		101
90	This is the error callback, which is called when, well, some error	102	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	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
96	usable. Non-fatal errors can be retried by simply returning, but it is	112	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	113	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		116
100	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		119
103	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
…		…
110	and no read request is in the queue (unlike read queue callbacks, this	127	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	128	callback will only be called when at least one octet of data is in the
112	read buffer).	129	read buffer).
113		130
114	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 >>
115	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.
116		135
117	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
118	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
119	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
120	error will be raised (with C<$!> set to C<EPIPE>).	139	error will be raised (with C<$!> set to C<EPIPE>).
…		…
124	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
125	(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).
126		145
127	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.
128		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
129	=item timeout => $fractional_seconds	154	=item timeout => $fractional_seconds
130		155
131	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
132	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
133	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
134	missing, an C<ETIMEDOUT> error will be raised).	159	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		160
136	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
137	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
138	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
139	in the C<on_timeout> callback.	164	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		165	restart the timeout.
140		166
141	Zero (the default) disables this timeout.	167	Zero (the default) disables this timeout.
142		168
143	=item on_timeout => $cb->($handle)	169	=item on_timeout => $cb->($handle)
144		170
…		…
148		174
149	=item rbuf_max => <bytes>	175	=item rbuf_max => <bytes>
150		176
151	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>)
152	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
153	avoid denial-of-service attacks.	179	avoid some forms of denial-of-service attacks.
154		180
155	For example, a server accepting connections from untrusted sources should	181	For example, a server accepting connections from untrusted sources should
156	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
157	(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
158	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
159	isn't finished).	185	isn't finished).
160		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
161	=item read_size => <bytes>	213	=item read_size => <bytes>
162		214
163	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
164	during each (loop iteration). Default: C<8192>.	216	try to read during each loop iteration, which affects memory
		217	requirements). Default: C<8192>.
165		218
166	=item low_water_mark => <bytes>	219	=item low_water_mark => <bytes>
167		220
168	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
169	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
170	considered empty.	223	considered empty.
171		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
172	=item linger => <seconds>	230	=item linger => <seconds>
173		231
174	If non-zero (default: C<3600>), then the destructor of the	232	If non-zero (default: C<3600>), then the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	233	AnyEvent::Handle object will check whether there is still outstanding
176	data and will install a watcher that will write out this data. No errors	234	write data and will install a watcher that will write this data to the
177	will be reported (this mostly matches how the operating system treats	235	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	236	system treats outstanding data at socket close time).
179		237
180	This will not work for partial TLS data that could not yet been	238	This will not work for partial TLS data that could not be encoded
181	encoded. This data will be lost.	239	yet. This data will be lost. Calling the C<stoptls> method in time might
		240	help.
182		241
183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
184		243
185	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
186	will start making tls handshake and will transparently encrypt/decrypt	245	AnyEvent will start a TLS handshake as soon as the conenction has been
187	data.	246	established and will transparently encrypt/decrypt data afterwards.
188		247
189	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
190	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.
191		252
192	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
193	connection, use C<connect> mode.	254	C<accept>, and for the TLS client side of a connection, use C<connect>
		255	mode.
194		256
195	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
196	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>
197	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
198	AnyEvent::Handle.	260	AnyEvent::Handle.
199		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
200	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.
201		268
202	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
203		270
204	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
205	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		274
208	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
209		276
210	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.
211		278
212	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
213	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.
214		282
215	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
216	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
217		285
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223
224	=back	286	=back
225		287
226	=cut	288	=cut
227		289
228	sub new {	290	sub new {
…		…
232		294
233	$self->{fh} or Carp::croak "mandatory argument fh is missing";	295	$self->{fh} or Carp::croak "mandatory argument fh is missing";
234		296
235	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
236		298
237	if ($self->{tls}) {
238	require Net::SSLeay;
239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
240	}	300	if $self->{tls};
241		301
242	$self->{_activity} = AnyEvent->now;	302	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;	303	$self->_timeout;
244		304
245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	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
		308	$self->start_read
		309	if $self->{on_read};
246		310
247	$self	311	$self
248	}	312	}
249		313
250	sub _shutdown {	314	sub _shutdown {
251	my ($self) = @_;	315	my ($self) = @_;
252		316
253	delete $self->{_tw};	317	delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)};
254	delete $self->{_rw};
255	delete $self->{_ww};
256	delete $self->{fh};
257		318
258	$self->stoptls;	319	&_freetls;
259	}	320	}
260		321
261	sub _error {	322	sub _error {
262	my ($self, $errno, $fatal) = @_;	323	my ($self, $errno, $fatal) = @_;
263		324
…		…
266		327
267	$! = $errno;	328	$! = $errno;
268		329
269	if ($self->{on_error}) {	330	if ($self->{on_error}) {
270	$self->{on_error}($self, $fatal);	331	$self->{on_error}($self, $fatal);
271	} else {	332	} elsif ($self->{fh}) {
272	Carp::croak "AnyEvent::Handle uncaught error: $!";	333	Carp::croak "AnyEvent::Handle uncaught error: $!";
273	}	334	}
274	}	335	}
275		336
276	=item $fh = $handle->fh	337	=item $fh = $handle->fh
277		338
278	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.
279		340
280	=cut	341	=cut
281		342
282	sub fh { $_[0]{fh} }	343	sub fh { $_[0]{fh} }
283		344
…		…
301	$_[0]{on_eof} = $_[1];	362	$_[0]{on_eof} = $_[1];
302	}	363	}
303		364
304	=item $handle->on_timeout ($cb)	365	=item $handle->on_timeout ($cb)
305		366
306	Replace the current C<on_timeout> callback, or disables the callback	367	Replace the current C<on_timeout> callback, or disables the callback (but
307	(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
308	argument.	369	argument and method.
309		370
310	=cut	371	=cut
311		372
312	sub on_timeout {	373	sub on_timeout {
313	$_[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	};
314	}	402	}
315		403
316	#############################################################################	404	#############################################################################
317		405
318	=item $handle->timeout ($seconds)	406	=item $handle->timeout ($seconds)
…		…
396	my ($self, $cb) = @_;	484	my ($self, $cb) = @_;
397		485
398	$self->{on_drain} = $cb;	486	$self->{on_drain} = $cb;
399		487
400	$cb->($self)	488	$cb->($self)
401	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	489	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
402	}	490	}
403		491
404	=item $handle->push_write ($data)	492	=item $handle->push_write ($data)
405		493
406	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
…		…
423	substr $self->{wbuf}, 0, $len, "";	511	substr $self->{wbuf}, 0, $len, "";
424		512
425	$self->{_activity} = AnyEvent->now;	513	$self->{_activity} = AnyEvent->now;
426		514
427	$self->{on_drain}($self)	515	$self->{on_drain}($self)
428	if $self->{low_water_mark} >= length $self->{wbuf}	516	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
429	&& $self->{on_drain};	517	&& $self->{on_drain};
430		518
431	delete $self->{_ww} unless length $self->{wbuf};	519	delete $self->{_ww} unless length $self->{wbuf};
432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	520	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
433	$self->_error ($!, 1);	521	$self->_error ($!, 1);
434	}	522	}
435	};	523	};
436		524
437	# try to write data immediately	525	# try to write data immediately
438	$cb->();	526	$cb->() unless $self->{autocork};
439		527
440	# if still data left in wbuf, we need to poll	528	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	529	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
442	if length $self->{wbuf};	530	if length $self->{wbuf};
443	};	531	};
…		…
457		545
458	@_ = ($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")
459	->($self, @_);	547	->($self, @_);
460	}	548	}
461		549
462	if ($self->{filter_w}) {	550	if ($self->{tls}) {
463	$self->{filter_w}($self, \$_[0]);	551	$self->{_tls_wbuf} .= $_[0];
		552
		553	&_dotls ($self);
464	} else {	554	} else {
465	$self->{wbuf} .= $_[0];	555	$self->{wbuf} .= $_[0];
466	$self->_drain_wbuf;	556	$self->_drain_wbuf;
467	}	557	}
468	}	558	}
…		…
485	=cut	575	=cut
486		576
487	register_write_type netstring => sub {	577	register_write_type netstring => sub {
488	my ($self, $string) = @_;	578	my ($self, $string) = @_;
489		579
490	sprintf "%d:%s,", (length $string), $string	580	(length $string) . ":$string,"
491	};	581	};
492		582
493	=item packstring => $format, $data	583	=item packstring => $format, $data
494		584
495	An octet string prefixed with an encoded length. The encoding C<$format>	585	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
500	=cut	590	=cut
501		591
502	register_write_type packstring => sub {	592	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	593	my ($self, $format, $string) = @_;
504		594
505	pack "$format/a", $string	595	pack "$format/a*", $string
506	};	596	};
507		597
508	=item json => $array_or_hashref	598	=item json => $array_or_hashref
509		599
510	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
…		…
556	register_write_type storable => sub {	646	register_write_type storable => sub {
557	my ($self, $ref) = @_;	647	my ($self, $ref) = @_;
558		648
559	require Storable;	649	require Storable;
560		650
561	pack "w/a", Storable::nfreeze ($ref)	651	pack "w/a*", Storable::nfreeze ($ref)
562	};	652	};
563		653
564	=back	654	=back
565		655
566	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	656	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
…		…
590	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
591	a queue.	681	a queue.
592		682
593	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
594	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
595	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
596	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).
597		688
598	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
599	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
600	data arrives (also the first time it is queued) and removes it when it has	691	data arrives (also the first time it is queued) and removes it when it has
601	done its job (see C<push_read>, below).	692	done its job (see C<push_read>, below).
…		…
619	# handle xml	710	# handle xml
620	});	711	});
621	});	712	});
622	});	713	});
623		714
624	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"
625	"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
626	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
627	pipeline sending both requests and manipulate the queue as necessary in	718	just pipeline sending both requests and manipulate the queue as necessary
628	the callbacks:	719	in the callbacks.
629		720
630	# 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"
631	$handle->push_write ("request 1\015\012");	726	$handle->push_write ("request 1\015\012");
632		727
633	# 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
634	$handle->push_read (line => sub {	729	$handle->push_read (line => sub {
635	# if we got an "OK", we have to _prepend_ another line,	730	# if we got an "OK", we have to _prepend_ another line,
…		…
642	...	737	...
643	});	738	});
644	}	739	}
645	});	740	});
646		741
647	# request two	742	# request two, simply returns 64 octets
648	$handle->push_write ("request 2\015\012");	743	$handle->push_write ("request 2\015\012");
649		744
650	# simply read 64 bytes, always	745	# simply read 64 bytes, always
651	$handle->push_read (chunk => 64, sub {	746	$handle->push_read (chunk => 64, sub {
652	my $response = $_[1];	747	my $response = $_[1];
…		…
664		759
665	if (	760	if (
666	defined $self->{rbuf_max}	761	defined $self->{rbuf_max}
667	&& $self->{rbuf_max} < length $self->{rbuf}	762	&& $self->{rbuf_max} < length $self->{rbuf}
668	) {	763	) {
669	return $self->_error (&Errno::ENOSPC, 1);	764	$self->_error (&Errno::ENOSPC, 1), return;
670	}	765	}
671		766
672	while () {	767	while () {
673	no strict 'refs';	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};
674		771
675	my $len = length $self->{rbuf};	772	my $len = length $self->{rbuf};
676		773
677	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
678	unless ($cb->($self)) {	775	unless ($cb->($self)) {
679	if ($self->{_eof}) {	776	if ($self->{_eof}) {
680	# 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)
681	$self->_error (&Errno::EPIPE, 1), last;	778	$self->_error (&Errno::EPIPE, 1), return;
682	}	779	}
683		780
684	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
685	last;	782	last;
686	}	783	}
…		…
694	&& !@{ $self->{_queue} } # and the queue is still empty	791	&& !@{ $self->{_queue} } # and the queue is still empty
695	&& $self->{on_read} # but we still have on_read	792	&& $self->{on_read} # but we still have on_read
696	) {	793	) {
697	# no further data will arrive	794	# no further data will arrive
698	# so no progress can be made	795	# so no progress can be made
699	$self->_error (&Errno::EPIPE, 1), last	796	$self->_error (&Errno::EPIPE, 1), return
700	if $self->{_eof};	797	if $self->{_eof};
701		798
702	last; # more data might arrive	799	last; # more data might arrive
703	}	800	}
704	} else {	801	} else {
705	# read side becomes idle	802	# read side becomes idle
706	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
707	last;	804	last;
708	}	805	}
709	}	806	}
710		807
		808	if ($self->{_eof}) {
		809	if ($self->{on_eof}) {
711	$self->{on_eof}($self)	810	$self->{on_eof}($self)
712	if $self->{_eof} && $self->{on_eof};	811	} else {
		812	$self->_error (0, 1);
		813	}
		814	}
713		815
714	# may need to restart read watcher	816	# may need to restart read watcher
715	unless ($self->{_rw}) {	817	unless ($self->{_rw}) {
716	$self->start_read	818	$self->start_read
717	if $self->{on_read} \|\| @{ $self->{_queue} };	819	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
735		837
736	=item $handle->rbuf	838	=item $handle->rbuf
737		839
738	Returns the read buffer (as a modifiable lvalue).	840	Returns the read buffer (as a modifiable lvalue).
739		841
740	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} >>
741	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.
742		847
743	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>,
744	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
745	automatically manage the read buffer.	850	automatically manage the read buffer.
746		851
…		…
843	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	948	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
844	1	949	1
845	}	950	}
846	};	951	};
847		952
848	# compatibility with older API
849	sub push_read_chunk {
850	$_[0]->push_read (chunk => $_[1], $_[2]);
851	}
852
853	sub unshift_read_chunk {
854	$_[0]->unshift_read (chunk => $_[1], $_[2]);
855	}
856
857	=item line => [$eol, ]$cb->($handle, $line, $eol)	953	=item line => [$eol, ]$cb->($handle, $line, $eol)
858		954
859	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
860	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
861	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
…		…
876	=cut	972	=cut
877		973
878	register_read_type line => sub {	974	register_read_type line => sub {
879	my ($self, $cb, $eol) = @_;	975	my ($self, $cb, $eol) = @_;
880		976
881	$eol = qr\|(\015?\012)\| if @_ < 3;	977	if (@_ < 3) {
		978	# this is more than twice as fast as the generic code below
		979	sub {
		980	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		981
		982	$cb->($_[0], $1, $2);
		983	1
		984	}
		985	} else {
882	$eol = quotemeta $eol unless ref $eol;	986	$eol = quotemeta $eol unless ref $eol;
883	$eol = qr\|^(.*?)($eol)\|s;	987	$eol = qr\|^(.*?)($eol)\|s;
884		988
885	sub {	989	sub {
886	$_[0]{rbuf} =~ s/$eol// or return;	990	$_[0]{rbuf} =~ s/$eol// or return;
887		991
888	$cb->($_[0], $1, $2);	992	$cb->($_[0], $1, $2);
		993	1
889	1	994	}
890	}	995	}
891	};	996	};
892
893	# compatibility with older API
894	sub push_read_line {
895	my $self = shift;
896	$self->push_read (line => @_);
897	}
898
899	sub unshift_read_line {
900	my $self = shift;
901	$self->unshift_read (line => @_);
902	}
903		997
904	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	998	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
905		999
906	Makes a regex match against the regex object C<$accept> and returns	1000	Makes a regex match against the regex object C<$accept> and returns
907	everything up to and including the match.	1001	everything up to and including the match.
…		…
1012	An octet string prefixed with an encoded length. The encoding C<$format>	1106	An octet string prefixed with an encoded length. The encoding C<$format>
1013	uses the same format as a Perl C<pack> format, but must specify a single	1107	uses the same format as a Perl C<pack> format, but must specify a single
1014	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1108	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1015	optional C<!>, C<< < >> or C<< > >> modifier).	1109	optional C<!>, C<< < >> or C<< > >> modifier).
1016		1110
1017	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	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).
1018		1113
1019	Example: read a block of data prefixed by its length in BER-encoded	1114	Example: read a block of data prefixed by its length in BER-encoded
1020	format (very efficient).	1115	format (very efficient).
1021		1116
1022	$handle->push_read (packstring => "w", sub {	1117	$handle->push_read (packstring => "w", sub {
…		…
1028	register_read_type packstring => sub {	1123	register_read_type packstring => sub {
1029	my ($self, $cb, $format) = @_;	1124	my ($self, $cb, $format) = @_;
1030		1125
1031	sub {	1126	sub {
1032	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1127	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1033	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1128	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1034	or return;	1129	or return;
1035		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 {
1036	# remove prefix	1139	# remove prefix
1037	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1140	substr $_[0]{rbuf}, 0, $format, "";
1038		1141
1039	# read rest	1142	# read remaining chunk
1040	$_[0]->unshift_read (chunk => $len, $cb);	1143	$_[0]->unshift_read (chunk => $len, $cb);
		1144	}
1041		1145
1042	1	1146	1
1043	}	1147	}
1044	};	1148	};
1045		1149
1046	=item json => $cb->($handle, $hash_or_arrayref)	1150	=item json => $cb->($handle, $hash_or_arrayref)
1047		1151
1048	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.
1049		1154
1050	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
1051	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.
1052		1157
1053	This read type uses the incremental parser available with JSON version	1158	This read type uses the incremental parser available with JSON version
…		…
1070	my $rbuf = \$self->{rbuf};	1175	my $rbuf = \$self->{rbuf};
1071		1176
1072	my $json = $self->{json} \|\|= JSON->new->utf8;	1177	my $json = $self->{json} \|\|= JSON->new->utf8;
1073		1178
1074	sub {	1179	sub {
1075	my $ref = $json->incr_parse ($self->{rbuf});	1180	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1076		1181
1077	if ($ref) {	1182	if ($ref) {
1078	$self->{rbuf} = $json->incr_text;	1183	$self->{rbuf} = $json->incr_text;
1079	$json->incr_text = "";	1184	$json->incr_text = "";
1080	$cb->($self, $ref);	1185	$cb->($self, $ref);
1081		1186
1082	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	()
1083	} else {	1198	} else {
1084	$self->{rbuf} = "";	1199	$self->{rbuf} = "";
		1200
1085	()	1201	()
1086	}	1202	}
1087	}	1203	}
1088	};	1204	};
1089		1205
…		…
1102		1218
1103	require Storable;	1219	require Storable;
1104		1220
1105	sub {	1221	sub {
1106	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1222	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1107	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1223	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1108	or return;	1224	or return;
1109		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 {
1110	# remove prefix	1234	# remove prefix
1111	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1235	substr $_[0]{rbuf}, 0, $format, "";
1112		1236
1113	# read rest	1237	# read remaining chunk
1114	$_[0]->unshift_read (chunk => $len, sub {	1238	$_[0]->unshift_read (chunk => $len, sub {
1115	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1239	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1116	$cb->($_[0], $ref);	1240	$cb->($_[0], $ref);
1117	} else {	1241	} else {
1118	$self->_error (&Errno::EBADMSG);	1242	$self->_error (&Errno::EBADMSG);
		1243	}
1119	}	1244	});
1120	});	1245	}
		1246
		1247	1
1121	}	1248	}
1122	};	1249	};
1123		1250
1124	=back	1251	=back
1125		1252
…		…
1155	Note that AnyEvent::Handle will automatically C<start_read> for you when	1282	Note that AnyEvent::Handle will automatically C<start_read> for you when
1156	you change the C<on_read> callback or push/unshift a read callback, and it	1283	you change the C<on_read> callback or push/unshift a read callback, and it
1157	will automatically C<stop_read> for you when neither C<on_read> is set nor	1284	will automatically C<stop_read> for you when neither C<on_read> is set nor
1158	there are any read requests in the queue.	1285	there are any read requests in the queue.
1159		1286
		1287	These methods will have no effect when in TLS mode (as TLS doesn't support
		1288	half-duplex connections).
		1289
1160	=cut	1290	=cut
1161		1291
1162	sub stop_read {	1292	sub stop_read {
1163	my ($self) = @_;	1293	my ($self) = @_;
1164		1294
1165	delete $self->{_rw};	1295	delete $self->{_rw} unless $self->{tls};
1166	}	1296	}
1167		1297
1168	sub start_read {	1298	sub start_read {
1169	my ($self) = @_;	1299	my ($self) = @_;
1170		1300
1171	unless ($self->{_rw} \|\| $self->{_eof}) {	1301	unless ($self->{_rw} \|\| $self->{_eof}) {
1172	Scalar::Util::weaken $self;	1302	Scalar::Util::weaken $self;
1173		1303
1174	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1304	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1175	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1305	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1176	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;
1177		1307
1178	if ($len > 0) {	1308	if ($len > 0) {
1179	$self->{_activity} = AnyEvent->now;	1309	$self->{_activity} = AnyEvent->now;
1180		1310
1181	$self->{filter_r}	1311	if ($self->{tls}) {
1182	? $self->{filter_r}($self, $rbuf)	1312	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1183	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1313
		1314	&_dotls ($self);
		1315	} else {
		1316	$self->_drain_rbuf unless $self->{_in_drain};
		1317	}
1184		1318
1185	} elsif (defined $len) {	1319	} elsif (defined $len) {
1186	delete $self->{_rw};	1320	delete $self->{_rw};
1187	$self->{_eof} = 1;	1321	$self->{_eof} = 1;
1188	$self->_drain_rbuf unless $self->{_in_drain};	1322	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1192	}	1326	}
1193	});	1327	});
1194	}	1328	}
1195	}	1329	}
1196		1330
		1331	# poll the write BIO and send the data if applicable
1197	sub _dotls {	1332	sub _dotls {
1198	my ($self) = @_;	1333	my ($self) = @_;
1199		1334
1200	my $buf;	1335	my $tmp;
1201		1336
1202	if (length $self->{_tls_wbuf}) {	1337	if (length $self->{_tls_wbuf}) {
1203	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1338	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1204	substr $self->{_tls_wbuf}, 0, $len, "";	1339	substr $self->{_tls_wbuf}, 0, $tmp, "";
1205	}	1340	}
1206	}	1341	}
1207		1342
1208	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1209	$self->{wbuf} .= $buf;
1210	$self->_drain_wbuf;
1211	}
1212
1213	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1343	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1214	if (length $buf) {	1344	unless (length $tmp) {
1215	$self->{rbuf} .= $buf;
1216	$self->_drain_rbuf unless $self->{_in_drain};
1217	} else {
1218	# let's treat SSL-eof as we treat normal EOF	1345	# let's treat SSL-eof as we treat normal EOF
		1346	delete $self->{_rw};
1219	$self->{_eof} = 1;	1347	$self->{_eof} = 1;
1220	$self->_shutdown;	1348	&_freetls;
1221	return;
1222	}	1349	}
1223	}
1224		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
1225	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1356	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1226		1357
1227	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1358	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1228	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1359	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1229	return $self->_error ($!, 1);	1360	return $self->_error ($!, 1);
1230	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1361	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1231	return $self->_error (&Errno::EIO, 1);	1362	return $self->_error (&Errno::EIO, 1);
1232	}	1363	}
1233		1364
1234	# all others are fine for our purposes	1365	# all other errors are fine for our purposes
		1366	}
		1367
		1368	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1369	$self->{wbuf} .= $tmp;
		1370	$self->_drain_wbuf;
1235	}	1371	}
1236	}	1372	}
1237		1373
1238	=item $handle->starttls ($tls[, $tls_ctx])	1374	=item $handle->starttls ($tls[, $tls_ctx])
1239		1375
…		…
1249		1385
1250	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
1251	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
1252	might have already started when this function returns.	1388	might have already started when this function returns.
1253		1389
		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).
		1392
1254	=cut	1393	=cut
1255		1394
1256	sub starttls {	1395	sub starttls {
1257	my ($self, $ssl, $ctx) = @_;	1396	my ($self, $ssl, $ctx) = @_;
1258		1397
1259	$self->stoptls;	1398	require Net::SSLeay;
1260		1399
		1400	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1401	if $self->{tls};
		1402
1261	if ($ssl eq "accept") {	1403	if ($ssl eq "accept") {
1262	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1404	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1263	Net::SSLeay::set_accept_state ($ssl);	1405	Net::SSLeay::set_accept_state ($ssl);
1264	} elsif ($ssl eq "connect") {	1406	} elsif ($ssl eq "connect") {
1265	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1407	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1271	# 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)
1272	# but the openssl maintainers basically said: "trust us, it just works".	1414	# but the openssl maintainers basically said: "trust us, it just works".
1273	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1415	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1274	# and mismaintained ssleay-module doesn't even offer them).	1416	# and mismaintained ssleay-module doesn't even offer them).
1275	# 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.
1276	Net::SSLeay::CTX_set_mode ($self->{tls},	1425	Net::SSLeay::CTX_set_mode ($self->{tls},
1277	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1426	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1278	\| (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));
1279		1428
1280	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1281	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1430	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1282		1431
1283	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1432	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1284		1433
1285	$self->{filter_w} = sub {	1434	&_dotls; # need to trigger the initial handshake
1286	$_[0]{_tls_wbuf} .= ${$_[1]};	1435	$self->start_read; # make sure we actually do read
1287	&_dotls;
1288	};
1289	$self->{filter_r} = sub {
1290	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1291	&_dotls;
1292	};
1293	}	1436	}
1294		1437
1295	=item $handle->stoptls	1438	=item $handle->stoptls
1296		1439
1297	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
1298	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.
1299		1444
1300	=cut	1445	=cut
1301		1446
1302	sub stoptls {	1447	sub stoptls {
1303	my ($self) = @_;	1448	my ($self) = @_;
1304		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
1305	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1466	Net::SSLeay::free (delete $self->{tls});
1306		1467
1307	delete $self->{_rbio};	1468	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1308	delete $self->{_wbio};
1309	delete $self->{_tls_wbuf};
1310	delete $self->{filter_r};
1311	delete $self->{filter_w};
1312	}	1469	}
1313		1470
1314	sub DESTROY {	1471	sub DESTROY {
1315	my $self = shift;	1472	my ($self) = @_;
1316		1473
1317	$self->stoptls;	1474	&_freetls;
1318		1475
1319	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1476	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1320		1477
1321	if ($linger && length $self->{wbuf}) {	1478	if ($linger && length $self->{wbuf}) {
1322	my $fh = delete $self->{fh};	1479	my $fh = delete $self->{fh};
…		…
1337	@linger = ();	1494	@linger = ();
1338	});	1495	});
1339	}	1496	}
1340	}	1497	}
1341		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 = ();
		1522	}
		1523
1342	=item AnyEvent::Handle::TLS_CTX	1524	=item AnyEvent::Handle::TLS_CTX
1343		1525
1344	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
1345	default for TLS mode.	1527	default for TLS mode.
1346		1528
…		…
1374	}	1556	}
1375	}	1557	}
1376		1558
1377	=back	1559	=back
1378		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
1379	=head1 SUBCLASSING AnyEvent::Handle	1633	=head1 SUBCLASSING AnyEvent::Handle
1380		1634
1381	In many cases, you might want to subclass AnyEvent::Handle.	1635	In many cases, you might want to subclass AnyEvent::Handle.
1382		1636
1383	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
…		…
1386	=over 4	1640	=over 4
1387		1641
1388	=item * all constructor arguments become object members.	1642	=item * all constructor arguments become object members.
1389		1643
1390	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
1391	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
1392	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).
1393		1647
1394	=item * other object member names are prefixed with an C<_>.	1648	=item * other object member names are prefixed with an C<_>.
1395		1649
1396	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.64 by root, Fri Jun 6 11:01:17 2008 UTC vs. Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.64 by root, Fri Jun 6 11:01:17 2008 UTC vs.
Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC