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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC vs.
Revision 1.121 by root, Fri Mar 27 10:49:50 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.14;	19	our $VERSION = 4.35;
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
		230	=item linger => <seconds>
		231
		232	If non-zero (default: C<3600>), then the destructor of the
		233	AnyEvent::Handle object will check whether there is still outstanding
		234	write data and will install a watcher that will write this data to the
		235	socket. No errors will be reported (this mostly matches how the operating
		236	system treats outstanding data at socket close time).
		237
		238	This will not work for partial TLS data that could not be encoded
		239	yet. This data will be lost. Calling the C<stoptls> method in time might
		240	help.
		241
172	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
173		243
174	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
175	will start making tls handshake and will transparently encrypt/decrypt	245	AnyEvent will start a TLS handshake as soon as the conenction has been
176	data.	246	established and will transparently encrypt/decrypt data afterwards.
177		247
178	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
179	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.
180		252
181	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
182	connection, use C<connect> mode.	254	C<accept>, and for the TLS client side of a connection, use C<connect>
		255	mode.
183		256
184	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
185	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>
186	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
187	AnyEvent::Handle.	260	AnyEvent::Handle.
188		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
189	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.
190		268
191	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
192		270
193	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
194	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
195	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
196		274
197	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
198		276
199	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.
200		278
201	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
202	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.
203		282
204	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
205	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
206		285
207	=item filter_r => $cb
208
209	=item filter_w => $cb
210
211	These exist, but are undocumented at this time.
212
213	=back	286	=back
214		287
215	=cut	288	=cut
216		289
217	sub new {	290	sub new {
…		…
221		294
222	$self->{fh} or Carp::croak "mandatory argument fh is missing";	295	$self->{fh} or Carp::croak "mandatory argument fh is missing";
223		296
224	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
225		298
226	if ($self->{tls}) {
227	require Net::SSLeay;
228	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
229	}	300	if $self->{tls};
230		301
231	$self->{_activity} = AnyEvent->now;	302	$self->{_activity} = AnyEvent->now;
232	$self->_timeout;	303	$self->_timeout;
233		304
234	$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};
235		310
236	$self	311	$self
237	}	312	}
238		313
239	sub _shutdown {	314	sub _shutdown {
…		…
242	delete $self->{_tw};	317	delete $self->{_tw};
243	delete $self->{_rw};	318	delete $self->{_rw};
244	delete $self->{_ww};	319	delete $self->{_ww};
245	delete $self->{fh};	320	delete $self->{fh};
246		321
247	$self->stoptls;	322	&_freetls;
		323
		324	delete $self->{on_read};
		325	delete $self->{_queue};
248	}	326	}
249		327
250	sub _error {	328	sub _error {
251	my ($self, $errno, $fatal) = @_;	329	my ($self, $errno, $fatal) = @_;
252		330
…		…
255		333
256	$! = $errno;	334	$! = $errno;
257		335
258	if ($self->{on_error}) {	336	if ($self->{on_error}) {
259	$self->{on_error}($self, $fatal);	337	$self->{on_error}($self, $fatal);
260	} else {	338	} elsif ($self->{fh}) {
261	Carp::croak "AnyEvent::Handle uncaught error: $!";	339	Carp::croak "AnyEvent::Handle uncaught error: $!";
262	}	340	}
263	}	341	}
264		342
265	=item $fh = $handle->fh	343	=item $fh = $handle->fh
266		344
267	This method returns the file handle of the L<AnyEvent::Handle> object.	345	This method returns the file handle used to create the L<AnyEvent::Handle> object.
268		346
269	=cut	347	=cut
270		348
271	sub fh { $_[0]{fh} }	349	sub fh { $_[0]{fh} }
272		350
…		…
290	$_[0]{on_eof} = $_[1];	368	$_[0]{on_eof} = $_[1];
291	}	369	}
292		370
293	=item $handle->on_timeout ($cb)	371	=item $handle->on_timeout ($cb)
294		372
295	Replace the current C<on_timeout> callback, or disables the callback	373	Replace the current C<on_timeout> callback, or disables the callback (but
296	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	374	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
297	argument.	375	argument and method.
298		376
299	=cut	377	=cut
300		378
301	sub on_timeout {	379	sub on_timeout {
302	$_[0]{on_timeout} = $_[1];	380	$_[0]{on_timeout} = $_[1];
		381	}
		382
		383	=item $handle->autocork ($boolean)
		384
		385	Enables or disables the current autocork behaviour (see C<autocork>
		386	constructor argument). Changes will only take effect on the next write.
		387
		388	=cut
		389
		390	sub autocork {
		391	$_[0]{autocork} = $_[1];
		392	}
		393
		394	=item $handle->no_delay ($boolean)
		395
		396	Enables or disables the C<no_delay> setting (see constructor argument of
		397	the same name for details).
		398
		399	=cut
		400
		401	sub no_delay {
		402	$_[0]{no_delay} = $_[1];
		403
		404	eval {
		405	local $SIG{__DIE__};
		406	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		407	};
303	}	408	}
304		409
305	#############################################################################	410	#############################################################################
306		411
307	=item $handle->timeout ($seconds)	412	=item $handle->timeout ($seconds)
…		…
385	my ($self, $cb) = @_;	490	my ($self, $cb) = @_;
386		491
387	$self->{on_drain} = $cb;	492	$self->{on_drain} = $cb;
388		493
389	$cb->($self)	494	$cb->($self)
390	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	495	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
391	}	496	}
392		497
393	=item $handle->push_write ($data)	498	=item $handle->push_write ($data)
394		499
395	Queues the given scalar to be written. You can push as much data as you	500	Queues the given scalar to be written. You can push as much data as you
…		…
412	substr $self->{wbuf}, 0, $len, "";	517	substr $self->{wbuf}, 0, $len, "";
413		518
414	$self->{_activity} = AnyEvent->now;	519	$self->{_activity} = AnyEvent->now;
415		520
416	$self->{on_drain}($self)	521	$self->{on_drain}($self)
417	if $self->{low_water_mark} >= length $self->{wbuf}	522	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
418	&& $self->{on_drain};	523	&& $self->{on_drain};
419		524
420	delete $self->{_ww} unless length $self->{wbuf};	525	delete $self->{_ww} unless length $self->{wbuf};
421	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	526	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
422	$self->_error ($!, 1);	527	$self->_error ($!, 1);
423	}	528	}
424	};	529	};
425		530
426	# try to write data immediately	531	# try to write data immediately
427	$cb->();	532	$cb->() unless $self->{autocork};
428		533
429	# if still data left in wbuf, we need to poll	534	# if still data left in wbuf, we need to poll
430	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	535	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
431	if length $self->{wbuf};	536	if length $self->{wbuf};
432	};	537	};
…		…
446		551
447	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	552	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
448	->($self, @_);	553	->($self, @_);
449	}	554	}
450		555
451	if ($self->{filter_w}) {	556	if ($self->{tls}) {
452	$self->{filter_w}($self, \$_[0]);	557	$self->{_tls_wbuf} .= $_[0];
		558
		559	&_dotls ($self);
453	} else {	560	} else {
454	$self->{wbuf} .= $_[0];	561	$self->{wbuf} .= $_[0];
455	$self->_drain_wbuf;	562	$self->_drain_wbuf;
456	}	563	}
457	}	564	}
…		…
474	=cut	581	=cut
475		582
476	register_write_type netstring => sub {	583	register_write_type netstring => sub {
477	my ($self, $string) = @_;	584	my ($self, $string) = @_;
478		585
479	sprintf "%d:%s,", (length $string), $string	586	(length $string) . ":$string,"
480	};	587	};
481		588
482	=item packstring => $format, $data	589	=item packstring => $format, $data
483		590
484	An octet string prefixed with an encoded length. The encoding C<$format>	591	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
489	=cut	596	=cut
490		597
491	register_write_type packstring => sub {	598	register_write_type packstring => sub {
492	my ($self, $format, $string) = @_;	599	my ($self, $format, $string) = @_;
493		600
494	pack "$format/a", $string	601	pack "$format/a*", $string
495	};	602	};
496		603
497	=item json => $array_or_hashref	604	=item json => $array_or_hashref
498		605
499	Encodes the given hash or array reference into a JSON object. Unless you	606	Encodes the given hash or array reference into a JSON object. Unless you
…		…
533		640
534	$self->{json} ? $self->{json}->encode ($ref)	641	$self->{json} ? $self->{json}->encode ($ref)
535	: JSON::encode_json ($ref)	642	: JSON::encode_json ($ref)
536	};	643	};
537		644
		645	=item storable => $reference
		646
		647	Freezes the given reference using L<Storable> and writes it to the
		648	handle. Uses the C<nfreeze> format.
		649
		650	=cut
		651
		652	register_write_type storable => sub {
		653	my ($self, $ref) = @_;
		654
		655	require Storable;
		656
		657	pack "w/a*", Storable::nfreeze ($ref)
		658	};
		659
538	=back	660	=back
539		661
540	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	662	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
541		663
542	This function (not method) lets you add your own types to C<push_write>.	664	This function (not method) lets you add your own types to C<push_write>.
…		…
564	ways, the "simple" way, using only C<on_read> and the "complex" way, using	686	ways, the "simple" way, using only C<on_read> and the "complex" way, using
565	a queue.	687	a queue.
566		688
567	In the simple case, you just install an C<on_read> callback and whenever	689	In the simple case, you just install an C<on_read> callback and whenever
568	new data arrives, it will be called. You can then remove some data (if	690	new data arrives, it will be called. You can then remove some data (if
569	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	691	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
570	or not.	692	leave the data there if you want to accumulate more (e.g. when only a
		693	partial message has been received so far).
571		694
572	In the more complex case, you want to queue multiple callbacks. In this	695	In the more complex case, you want to queue multiple callbacks. In this
573	case, AnyEvent::Handle will call the first queued callback each time new	696	case, AnyEvent::Handle will call the first queued callback each time new
574	data arrives (also the first time it is queued) and removes it when it has	697	data arrives (also the first time it is queued) and removes it when it has
575	done its job (see C<push_read>, below).	698	done its job (see C<push_read>, below).
…		…
593	# handle xml	716	# handle xml
594	});	717	});
595	});	718	});
596	});	719	});
597		720
598	Example 2: Implement a client for a protocol that replies either with	721	Example 2: Implement a client for a protocol that replies either with "OK"
599	"OK" and another line or "ERROR" for one request, and 64 bytes for the	722	and another line or "ERROR" for the first request that is sent, and 64
600	second request. Due tot he availability of a full queue, we can just	723	bytes for the second request. Due to the availability of a queue, we can
601	pipeline sending both requests and manipulate the queue as necessary in	724	just pipeline sending both requests and manipulate the queue as necessary
602	the callbacks:	725	in the callbacks.
603		726
604	# request one	727	When the first callback is called and sees an "OK" response, it will
		728	C<unshift> another line-read. This line-read will be queued I<before> the
		729	64-byte chunk callback.
		730
		731	# request one, returns either "OK + extra line" or "ERROR"
605	$handle->push_write ("request 1\015\012");	732	$handle->push_write ("request 1\015\012");
606		733
607	# we expect "ERROR" or "OK" as response, so push a line read	734	# we expect "ERROR" or "OK" as response, so push a line read
608	$handle->push_read (line => sub {	735	$handle->push_read (line => sub {
609	# if we got an "OK", we have to _prepend_ another line,	736	# if we got an "OK", we have to _prepend_ another line,
…		…
616	...	743	...
617	});	744	});
618	}	745	}
619	});	746	});
620		747
621	# request two	748	# request two, simply returns 64 octets
622	$handle->push_write ("request 2\015\012");	749	$handle->push_write ("request 2\015\012");
623		750
624	# simply read 64 bytes, always	751	# simply read 64 bytes, always
625	$handle->push_read (chunk => 64, sub {	752	$handle->push_read (chunk => 64, sub {
626	my $response = $_[1];	753	my $response = $_[1];
…		…
638		765
639	if (	766	if (
640	defined $self->{rbuf_max}	767	defined $self->{rbuf_max}
641	&& $self->{rbuf_max} < length $self->{rbuf}	768	&& $self->{rbuf_max} < length $self->{rbuf}
642	) {	769	) {
643	return $self->_error (&Errno::ENOSPC, 1);	770	$self->_error (&Errno::ENOSPC, 1), return;
644	}	771	}
645		772
646	while () {	773	while () {
647	no strict 'refs';	774	# we need to use a separate tls read buffer, as we must not receive data while
		775	# we are draining the buffer, and this can only happen with TLS.
		776	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
648		777
649	my $len = length $self->{rbuf};	778	my $len = length $self->{rbuf};
650		779
651	if (my $cb = shift @{ $self->{_queue} }) {	780	if (my $cb = shift @{ $self->{_queue} }) {
652	unless ($cb->($self)) {	781	unless ($cb->($self)) {
653	if ($self->{_eof}) {	782	if ($self->{_eof}) {
654	# no progress can be made (not enough data and no data forthcoming)	783	# no progress can be made (not enough data and no data forthcoming)
655	$self->_error (&Errno::EPIPE, 1), last;	784	$self->_error (&Errno::EPIPE, 1), return;
656	}	785	}
657		786
658	unshift @{ $self->{_queue} }, $cb;	787	unshift @{ $self->{_queue} }, $cb;
659	last;	788	last;
660	}	789	}
…		…
668	&& !@{ $self->{_queue} } # and the queue is still empty	797	&& !@{ $self->{_queue} } # and the queue is still empty
669	&& $self->{on_read} # but we still have on_read	798	&& $self->{on_read} # but we still have on_read
670	) {	799	) {
671	# no further data will arrive	800	# no further data will arrive
672	# so no progress can be made	801	# so no progress can be made
673	$self->_error (&Errno::EPIPE, 1), last	802	$self->_error (&Errno::EPIPE, 1), return
674	if $self->{_eof};	803	if $self->{_eof};
675		804
676	last; # more data might arrive	805	last; # more data might arrive
677	}	806	}
678	} else {	807	} else {
679	# read side becomes idle	808	# read side becomes idle
680	delete $self->{_rw};	809	delete $self->{_rw} unless $self->{tls};
681	last;	810	last;
682	}	811	}
683	}	812	}
684		813
		814	if ($self->{_eof}) {
		815	if ($self->{on_eof}) {
685	$self->{on_eof}($self)	816	$self->{on_eof}($self)
686	if $self->{_eof} && $self->{on_eof};	817	} else {
		818	$self->_error (0, 1);
		819	}
		820	}
687		821
688	# may need to restart read watcher	822	# may need to restart read watcher
689	unless ($self->{_rw}) {	823	unless ($self->{_rw}) {
690	$self->start_read	824	$self->start_read
691	if $self->{on_read} \|\| @{ $self->{_queue} };	825	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
709		843
710	=item $handle->rbuf	844	=item $handle->rbuf
711		845
712	Returns the read buffer (as a modifiable lvalue).	846	Returns the read buffer (as a modifiable lvalue).
713		847
714	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	848	You can access the read buffer directly as the C<< ->{rbuf} >>
715	you want.	849	member, if you want. However, the only operation allowed on the
		850	read buffer (apart from looking at it) is removing data from its
		851	beginning. Otherwise modifying or appending to it is not allowed and will
		852	lead to hard-to-track-down bugs.
716		853
717	NOTE: The read buffer should only be used or modified if the C<on_read>,	854	NOTE: The read buffer should only be used or modified if the C<on_read>,
718	C<push_read> or C<unshift_read> methods are used. The other read methods	855	C<push_read> or C<unshift_read> methods are used. The other read methods
719	automatically manage the read buffer.	856	automatically manage the read buffer.
720		857
…		…
817	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	954	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
818	1	955	1
819	}	956	}
820	};	957	};
821		958
822	# compatibility with older API
823	sub push_read_chunk {
824	$_[0]->push_read (chunk => $_[1], $_[2]);
825	}
826
827	sub unshift_read_chunk {
828	$_[0]->unshift_read (chunk => $_[1], $_[2]);
829	}
830
831	=item line => [$eol, ]$cb->($handle, $line, $eol)	959	=item line => [$eol, ]$cb->($handle, $line, $eol)
832		960
833	The callback will be called only once a full line (including the end of	961	The callback will be called only once a full line (including the end of
834	line marker, C<$eol>) has been read. This line (excluding the end of line	962	line marker, C<$eol>) has been read. This line (excluding the end of line
835	marker) will be passed to the callback as second argument (C<$line>), and	963	marker) will be passed to the callback as second argument (C<$line>), and
…		…
850	=cut	978	=cut
851		979
852	register_read_type line => sub {	980	register_read_type line => sub {
853	my ($self, $cb, $eol) = @_;	981	my ($self, $cb, $eol) = @_;
854		982
855	$eol = qr\|(\015?\012)\| if @_ < 3;	983	if (@_ < 3) {
		984	# this is more than twice as fast as the generic code below
		985	sub {
		986	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		987
		988	$cb->($_[0], $1, $2);
		989	1
		990	}
		991	} else {
856	$eol = quotemeta $eol unless ref $eol;	992	$eol = quotemeta $eol unless ref $eol;
857	$eol = qr\|^(.*?)($eol)\|s;	993	$eol = qr\|^(.*?)($eol)\|s;
858		994
859	sub {	995	sub {
860	$_[0]{rbuf} =~ s/$eol// or return;	996	$_[0]{rbuf} =~ s/$eol// or return;
861		997
862	$cb->($_[0], $1, $2);	998	$cb->($_[0], $1, $2);
		999	1
863	1	1000	}
864	}	1001	}
865	};	1002	};
866
867	# compatibility with older API
868	sub push_read_line {
869	my $self = shift;
870	$self->push_read (line => @_);
871	}
872
873	sub unshift_read_line {
874	my $self = shift;
875	$self->unshift_read (line => @_);
876	}
877		1003
878	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1004	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
879		1005
880	Makes a regex match against the regex object C<$accept> and returns	1006	Makes a regex match against the regex object C<$accept> and returns
881	everything up to and including the match.	1007	everything up to and including the match.
…		…
986	An octet string prefixed with an encoded length. The encoding C<$format>	1112	An octet string prefixed with an encoded length. The encoding C<$format>
987	uses the same format as a Perl C<pack> format, but must specify a single	1113	uses the same format as a Perl C<pack> format, but must specify a single
988	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1114	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
989	optional C<!>, C<< < >> or C<< > >> modifier).	1115	optional C<!>, C<< < >> or C<< > >> modifier).
990		1116
991	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1117	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1118	EPP uses a prefix of C<N> (4 octtes).
992		1119
993	Example: read a block of data prefixed by its length in BER-encoded	1120	Example: read a block of data prefixed by its length in BER-encoded
994	format (very efficient).	1121	format (very efficient).
995		1122
996	$handle->push_read (packstring => "w", sub {	1123	$handle->push_read (packstring => "w", sub {
…		…
1002	register_read_type packstring => sub {	1129	register_read_type packstring => sub {
1003	my ($self, $cb, $format) = @_;	1130	my ($self, $cb, $format) = @_;
1004		1131
1005	sub {	1132	sub {
1006	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1133	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1007	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1134	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1008	or return;	1135	or return;
1009		1136
		1137	$format = length pack $format, $len;
		1138
		1139	# bypass unshift if we already have the remaining chunk
		1140	if ($format + $len <= length $_[0]{rbuf}) {
		1141	my $data = substr $_[0]{rbuf}, $format, $len;
		1142	substr $_[0]{rbuf}, 0, $format + $len, "";
		1143	$cb->($_[0], $data);
		1144	} else {
1010	# remove prefix	1145	# remove prefix
1011	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1146	substr $_[0]{rbuf}, 0, $format, "";
1012		1147
1013	# read rest	1148	# read remaining chunk
1014	$_[0]->unshift_read (chunk => $len, $cb);	1149	$_[0]->unshift_read (chunk => $len, $cb);
		1150	}
1015		1151
1016	1	1152	1
1017	}	1153	}
1018	};	1154	};
1019		1155
1020	=item json => $cb->($handle, $hash_or_arrayref)	1156	=item json => $cb->($handle, $hash_or_arrayref)
1021		1157
1022	Reads a JSON object or array, decodes it and passes it to the callback.	1158	Reads a JSON object or array, decodes it and passes it to the
		1159	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1023		1160
1024	If a C<json> object was passed to the constructor, then that will be used	1161	If a C<json> object was passed to the constructor, then that will be used
1025	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1162	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1026		1163
1027	This read type uses the incremental parser available with JSON version	1164	This read type uses the incremental parser available with JSON version
…		…
1034	the C<json> write type description, above, for an actual example.	1171	the C<json> write type description, above, for an actual example.
1035		1172
1036	=cut	1173	=cut
1037		1174
1038	register_read_type json => sub {	1175	register_read_type json => sub {
1039	my ($self, $cb, $accept, $reject, $skip) = @_;	1176	my ($self, $cb) = @_;
1040		1177
1041	require JSON;	1178	require JSON;
1042		1179
1043	my $data;	1180	my $data;
1044	my $rbuf = \$self->{rbuf};	1181	my $rbuf = \$self->{rbuf};
1045		1182
1046	my $json = $self->{json} \|\|= JSON->new->utf8;	1183	my $json = $self->{json} \|\|= JSON->new->utf8;
1047		1184
1048	sub {	1185	sub {
1049	my $ref = $json->incr_parse ($self->{rbuf});	1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1050		1187
1051	if ($ref) {	1188	if ($ref) {
1052	$self->{rbuf} = $json->incr_text;	1189	$self->{rbuf} = $json->incr_text;
1053	$json->incr_text = "";	1190	$json->incr_text = "";
1054	$cb->($self, $ref);	1191	$cb->($self, $ref);
1055		1192
1056	1	1193	1
		1194	} elsif ($@) {
		1195	# error case
		1196	$json->incr_skip;
		1197
		1198	$self->{rbuf} = $json->incr_text;
		1199	$json->incr_text = "";
		1200
		1201	$self->_error (&Errno::EBADMSG);
		1202
		1203	()
1057	} else {	1204	} else {
1058	$self->{rbuf} = "";	1205	$self->{rbuf} = "";
		1206
1059	()	1207	()
1060	}	1208	}
		1209	}
		1210	};
		1211
		1212	=item storable => $cb->($handle, $ref)
		1213
		1214	Deserialises a L<Storable> frozen representation as written by the
		1215	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1216	data).
		1217
		1218	Raises C<EBADMSG> error if the data could not be decoded.
		1219
		1220	=cut
		1221
		1222	register_read_type storable => sub {
		1223	my ($self, $cb) = @_;
		1224
		1225	require Storable;
		1226
		1227	sub {
		1228	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1229	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1230	or return;
		1231
		1232	my $format = length pack "w", $len;
		1233
		1234	# bypass unshift if we already have the remaining chunk
		1235	if ($format + $len <= length $_[0]{rbuf}) {
		1236	my $data = substr $_[0]{rbuf}, $format, $len;
		1237	substr $_[0]{rbuf}, 0, $format + $len, "";
		1238	$cb->($_[0], Storable::thaw ($data));
		1239	} else {
		1240	# remove prefix
		1241	substr $_[0]{rbuf}, 0, $format, "";
		1242
		1243	# read remaining chunk
		1244	$_[0]->unshift_read (chunk => $len, sub {
		1245	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1246	$cb->($_[0], $ref);
		1247	} else {
		1248	$self->_error (&Errno::EBADMSG);
		1249	}
		1250	});
		1251	}
		1252
		1253	1
1061	}	1254	}
1062	};	1255	};
1063		1256
1064	=back	1257	=back
1065		1258
…		…
1095	Note that AnyEvent::Handle will automatically C<start_read> for you when	1288	Note that AnyEvent::Handle will automatically C<start_read> for you when
1096	you change the C<on_read> callback or push/unshift a read callback, and it	1289	you change the C<on_read> callback or push/unshift a read callback, and it
1097	will automatically C<stop_read> for you when neither C<on_read> is set nor	1290	will automatically C<stop_read> for you when neither C<on_read> is set nor
1098	there are any read requests in the queue.	1291	there are any read requests in the queue.
1099		1292
		1293	These methods will have no effect when in TLS mode (as TLS doesn't support
		1294	half-duplex connections).
		1295
1100	=cut	1296	=cut
1101		1297
1102	sub stop_read {	1298	sub stop_read {
1103	my ($self) = @_;	1299	my ($self) = @_;
1104		1300
1105	delete $self->{_rw};	1301	delete $self->{_rw} unless $self->{tls};
1106	}	1302	}
1107		1303
1108	sub start_read {	1304	sub start_read {
1109	my ($self) = @_;	1305	my ($self) = @_;
1110		1306
1111	unless ($self->{_rw} \|\| $self->{_eof}) {	1307	unless ($self->{_rw} \|\| $self->{_eof}) {
1112	Scalar::Util::weaken $self;	1308	Scalar::Util::weaken $self;
1113		1309
1114	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1310	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1115	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1311	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1116	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1312	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1117		1313
1118	if ($len > 0) {	1314	if ($len > 0) {
1119	$self->{_activity} = AnyEvent->now;	1315	$self->{_activity} = AnyEvent->now;
1120		1316
1121	$self->{filter_r}	1317	if ($self->{tls}) {
1122	? $self->{filter_r}($self, $rbuf)	1318	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1123	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1319
		1320	&_dotls ($self);
		1321	} else {
		1322	$self->_drain_rbuf unless $self->{_in_drain};
		1323	}
1124		1324
1125	} elsif (defined $len) {	1325	} elsif (defined $len) {
1126	delete $self->{_rw};	1326	delete $self->{_rw};
1127	$self->{_eof} = 1;	1327	$self->{_eof} = 1;
1128	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1132	}	1332	}
1133	});	1333	});
1134	}	1334	}
1135	}	1335	}
1136		1336
		1337	# poll the write BIO and send the data if applicable
1137	sub _dotls {	1338	sub _dotls {
1138	my ($self) = @_;	1339	my ($self) = @_;
1139		1340
1140	my $buf;	1341	my $tmp;
1141		1342
1142	if (length $self->{_tls_wbuf}) {	1343	if (length $self->{_tls_wbuf}) {
1143	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1144	substr $self->{_tls_wbuf}, 0, $len, "";	1345	substr $self->{_tls_wbuf}, 0, $tmp, "";
1145	}	1346	}
1146	}	1347	}
1147		1348
1148	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1149	$self->{wbuf} .= $buf;
1150	$self->_drain_wbuf;
1151	}
1152
1153	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1154	if (length $buf) {	1350	unless (length $tmp) {
1155	$self->{rbuf} .= $buf;
1156	$self->_drain_rbuf unless $self->{_in_drain};
1157	} else {
1158	# let's treat SSL-eof as we treat normal EOF	1351	# let's treat SSL-eof as we treat normal EOF
		1352	delete $self->{_rw};
1159	$self->{_eof} = 1;	1353	$self->{_eof} = 1;
1160	$self->_shutdown;	1354	&_freetls;
1161	return;
1162	}	1355	}
1163	}
1164		1356
		1357	$self->{_tls_rbuf} .= $tmp;
		1358	$self->_drain_rbuf unless $self->{_in_drain};
		1359	$self->{tls} or return; # tls session might have gone away in callback
		1360	}
		1361
1165	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1166		1363
1167	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1168	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1169	return $self->_error ($!, 1);	1366	return $self->_error ($!, 1);
1170	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1171	return $self->_error (&Errno::EIO, 1);	1368	return $self->_error (&Errno::EIO, 1);
1172	}	1369	}
1173		1370
1174	# all others are fine for our purposes	1371	# all other errors are fine for our purposes
		1372	}
		1373
		1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1375	$self->{wbuf} .= $tmp;
		1376	$self->_drain_wbuf;
1175	}	1377	}
1176	}	1378	}
1177		1379
1178	=item $handle->starttls ($tls[, $tls_ctx])	1380	=item $handle->starttls ($tls[, $tls_ctx])
1179		1381
…		…
1189		1391
1190	The TLS connection object will end up in C<< $handle->{tls} >> after this	1392	The TLS connection object will end up in C<< $handle->{tls} >> after this
1191	call and can be used or changed to your liking. Note that the handshake	1393	call and can be used or changed to your liking. Note that the handshake
1192	might have already started when this function returns.	1394	might have already started when this function returns.
1193		1395
		1396	If it an error to start a TLS handshake more than once per
		1397	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1398
1194	=cut	1399	=cut
1195		1400
1196	sub starttls {	1401	sub starttls {
1197	my ($self, $ssl, $ctx) = @_;	1402	my ($self, $ssl, $ctx) = @_;
1198		1403
1199	$self->stoptls;	1404	require Net::SSLeay;
1200		1405
		1406	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1407	if $self->{tls};
		1408
1201	if ($ssl eq "accept") {	1409	if ($ssl eq "accept") {
1202	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1410	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1203	Net::SSLeay::set_accept_state ($ssl);	1411	Net::SSLeay::set_accept_state ($ssl);
1204	} elsif ($ssl eq "connect") {	1412	} elsif ($ssl eq "connect") {
1205	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1413	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1211	# basically, this is deep magic (because SSL_read should have the same issues)	1419	# basically, this is deep magic (because SSL_read should have the same issues)
1212	# but the openssl maintainers basically said: "trust us, it just works".	1420	# but the openssl maintainers basically said: "trust us, it just works".
1213	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1421	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1214	# and mismaintained ssleay-module doesn't even offer them).	1422	# and mismaintained ssleay-module doesn't even offer them).
1215	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1423	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1424	#
		1425	# in short: this is a mess.
		1426	#
		1427	# note that we do not try to keep the length constant between writes as we are required to do.
		1428	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1429	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1430	# have identity issues in that area.
1216	Net::SSLeay::CTX_set_mode ($self->{tls},	1431	Net::SSLeay::CTX_set_mode ($self->{tls},
1217	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1218	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1433	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1219		1434
1220	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1221	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1222		1437
1223	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1438	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1224		1439
1225	$self->{filter_w} = sub {	1440	&_dotls; # need to trigger the initial handshake
1226	$_[0]{_tls_wbuf} .= ${$_[1]};	1441	$self->start_read; # make sure we actually do read
1227	&_dotls;
1228	};
1229	$self->{filter_r} = sub {
1230	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1231	&_dotls;
1232	};
1233	}	1442	}
1234		1443
1235	=item $handle->stoptls	1444	=item $handle->stoptls
1236		1445
1237	Destroys the SSL connection, if any. Partial read or write data will be	1446	Shuts down the SSL connection - this makes a proper EOF handshake by
1238	lost.	1447	sending a close notify to the other side, but since OpenSSL doesn't
		1448	support non-blocking shut downs, it is not possible to re-use the stream
		1449	afterwards.
1239		1450
1240	=cut	1451	=cut
1241		1452
1242	sub stoptls {	1453	sub stoptls {
1243	my ($self) = @_;	1454	my ($self) = @_;
1244		1455
		1456	if ($self->{tls}) {
		1457	Net::SSLeay::shutdown ($self->{tls});
		1458
		1459	&_dotls;
		1460
		1461	# we don't give a shit. no, we do, but we can't. no...
		1462	# we, we... have to use openssl :/
		1463	&_freetls;
		1464	}
		1465	}
		1466
		1467	sub _freetls {
		1468	my ($self) = @_;
		1469
		1470	return unless $self->{tls};
		1471
1245	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1472	Net::SSLeay::free (delete $self->{tls});
1246		1473
1247	delete $self->{_rbio};	1474	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1248	delete $self->{_wbio};
1249	delete $self->{_tls_wbuf};
1250	delete $self->{filter_r};
1251	delete $self->{filter_w};
1252	}	1475	}
1253		1476
1254	sub DESTROY {	1477	sub DESTROY {
1255	my $self = shift;	1478	my ($self) = @_;
1256		1479
1257	$self->stoptls;	1480	&_freetls;
		1481
		1482	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1483
		1484	if ($linger && length $self->{wbuf}) {
		1485	my $fh = delete $self->{fh};
		1486	my $wbuf = delete $self->{wbuf};
		1487
		1488	my @linger;
		1489
		1490	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1491	my $len = syswrite $fh, $wbuf, length $wbuf;
		1492
		1493	if ($len > 0) {
		1494	substr $wbuf, 0, $len, "";
		1495	} else {
		1496	@linger = (); # end
		1497	}
		1498	});
		1499	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1500	@linger = ();
		1501	});
		1502	}
		1503	}
		1504
		1505	=item $handle->destroy
		1506
		1507	Shuts down the handle object as much as possible - this call ensures that
		1508	no further callbacks will be invoked and resources will be freed as much
		1509	as possible. You must not call any methods on the object afterwards.
		1510
		1511	Normally, you can just "forget" any references to an AnyEvent::Handle
		1512	object and it will simply shut down. This works in fatal error and EOF
		1513	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1514	callback, so when you want to destroy the AnyEvent::Handle object from
		1515	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1516	that case.
		1517
		1518	The handle might still linger in the background and write out remaining
		1519	data, as specified by the C<linger> option, however.
		1520
		1521	=cut
		1522
		1523	sub destroy {
		1524	my ($self) = @_;
		1525
		1526	$self->DESTROY;
		1527	%$self = ();
1258	}	1528	}
1259		1529
1260	=item AnyEvent::Handle::TLS_CTX	1530	=item AnyEvent::Handle::TLS_CTX
1261		1531
1262	This function creates and returns the Net::SSLeay::CTX object used by	1532	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1292	}	1562	}
1293	}	1563	}
1294		1564
1295	=back	1565	=back
1296		1566
		1567
		1568	=head1 NONFREQUENTLY ASKED QUESTIONS
		1569
		1570	=over 4
		1571
		1572	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1573	still get further invocations!
		1574
		1575	That's because AnyEvent::Handle keeps a reference to itself when handling
		1576	read or write callbacks.
		1577
		1578	It is only safe to "forget" the reference inside EOF or error callbacks,
		1579	from within all other callbacks, you need to explicitly call the C<<
		1580	->destroy >> method.
		1581
		1582	=item I get different callback invocations in TLS mode/Why can't I pause
		1583	reading?
		1584
		1585	Unlike, say, TCP, TLS connections do not consist of two independent
		1586	communication channels, one for each direction. Or put differently. The
		1587	read and write directions are not independent of each other: you cannot
		1588	write data unless you are also prepared to read, and vice versa.
		1589
		1590	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1591	callback invocations when you are not expecting any read data - the reason
		1592	is that AnyEvent::Handle always reads in TLS mode.
		1593
		1594	During the connection, you have to make sure that you always have a
		1595	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1596	connection (or when you no longer want to use it) you can call the
		1597	C<destroy> method.
		1598
		1599	=item How do I read data until the other side closes the connection?
		1600
		1601	If you just want to read your data into a perl scalar, the easiest way
		1602	to achieve this is by setting an C<on_read> callback that does nothing,
		1603	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1604	will be in C<$_[0]{rbuf}>:
		1605
		1606	$handle->on_read (sub { });
		1607	$handle->on_eof (undef);
		1608	$handle->on_error (sub {
		1609	my $data = delete $_[0]{rbuf};
		1610	undef $handle;
		1611	});
		1612
		1613	The reason to use C<on_error> is that TCP connections, due to latencies
		1614	and packets loss, might get closed quite violently with an error, when in
		1615	fact, all data has been received.
		1616
		1617	It is usually better to use acknowledgements when transferring data,
		1618	to make sure the other side hasn't just died and you got the data
		1619	intact. This is also one reason why so many internet protocols have an
		1620	explicit QUIT command.
		1621
		1622	=item I don't want to destroy the handle too early - how do I wait until
		1623	all data has been written?
		1624
		1625	After writing your last bits of data, set the C<on_drain> callback
		1626	and destroy the handle in there - with the default setting of
		1627	C<low_water_mark> this will be called precisely when all data has been
		1628	written to the socket:
		1629
		1630	$handle->push_write (...);
		1631	$handle->on_drain (sub {
		1632	warn "all data submitted to the kernel\n";
		1633	undef $handle;
		1634	});
		1635
		1636	=back
		1637
		1638
1297	=head1 SUBCLASSING AnyEvent::Handle	1639	=head1 SUBCLASSING AnyEvent::Handle
1298		1640
1299	In many cases, you might want to subclass AnyEvent::Handle.	1641	In many cases, you might want to subclass AnyEvent::Handle.
1300		1642
1301	To make this easier, a given version of AnyEvent::Handle uses these	1643	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1304	=over 4	1646	=over 4
1305		1647
1306	=item * all constructor arguments become object members.	1648	=item * all constructor arguments become object members.
1307		1649
1308	At least initially, when you pass a C<tls>-argument to the constructor it	1650	At least initially, when you pass a C<tls>-argument to the constructor it
1309	will end up in C<< $handle->{tls} >>. Those members might be changes or	1651	will end up in C<< $handle->{tls} >>. Those members might be changed or
1310	mutated later on (for example C<tls> will hold the TLS connection object).	1652	mutated later on (for example C<tls> will hold the TLS connection object).
1311		1653
1312	=item * other object member names are prefixed with an C<_>.	1654	=item * other object member names are prefixed with an C<_>.
1313		1655
1314	All object members not explicitly documented (internal use) are prefixed	1656	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.61 by root, Fri Jun 6 10:23:50 2008 UTC vs. Revision 1.121 by root, Fri Mar 27 10:49:50 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC vs.
Revision 1.121 by root, Fri Mar 27 10:49:50 2009 UTC