[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.132 by elmex, Thu Jul 2 22:25:13 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.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
…		…
60		63
61	=head1 METHODS	64	=head1 METHODS
62		65
63	=over 4	66	=over 4
64		67
65	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		69
67	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
68		71
69	=over 4	72	=over 4
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
		242	=item common_name => $string
		243
		244	The common name used by some verification methods (most notably SSL/TLS)
		245	associated with this connection. Usually this is the remote hostname used
		246	to connect, but can be almost anything.
		247
172	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
173		249
174	When this parameter is given, it enables TLS (SSL) mode, that means it	250	When this parameter is given, it enables TLS (SSL) mode, that means
175	will start making tls handshake and will transparently encrypt/decrypt	251	AnyEvent will start a TLS handshake as soon as the conenction has been
176	data.	252	established and will transparently encrypt/decrypt data afterwards.
177		253
178	TLS mode requires Net::SSLeay to be installed (it will be loaded	254	TLS mode requires Net::SSLeay to be installed (it will be loaded
179	automatically when you try to create a TLS handle).	255	automatically when you try to create a TLS handle): this module doesn't
		256	have a dependency on that module, so if your module requires it, you have
		257	to add the dependency yourself.
180		258
181	For the TLS server side, use C<accept>, and for the TLS client side of a	259	Unlike TCP, TLS has a server and client side: for the TLS server side, use
182	connection, use C<connect> mode.	260	C<accept>, and for the TLS client side of a connection, use C<connect>
		261	mode.
183		262
184	You can also provide your own TLS connection object, but you have	263	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>	264	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	265	or C<Net::SSLeay::set_accept_state> on it before you pass it to
187	AnyEvent::Handle.	266	AnyEvent::Handle. Also, this module will take ownership of this connection
		267	object.
188		268
		269	At some future point, AnyEvent::Handle might switch to another TLS
		270	implementation, then the option to use your own session object will go
		271	away.
		272
		273	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		274	passing in the wrong integer will lead to certain crash. This most often
		275	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		276	segmentation fault.
		277
189	See the C<starttls> method if you need to start TLs negotiation later.	278	See the C<< ->starttls >> method for when need to start TLS negotiation later.
190		279
191	=item tls_ctx => $ssl_ctx	280	=item tls_ctx => $anyevent_tls
192		281
193	Use the given Net::SSLeay::CTX object to create the new TLS connection	282	Use the given C<AnyEvent::TLS> object to create the new TLS connection
194	(unless a connection object was specified directly). If this parameter is	283	(unless a connection object was specified directly). If this parameter is
195	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	284	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
196		285
		286	Instead of an object, you can also specify a hash reference with C<< key
		287	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		288	new TLS context object.
		289
197	=item json => JSON or JSON::XS object	290	=item json => JSON or JSON::XS object
198		291
199	This is the json coder object used by the C<json> read and write types.	292	This is the json coder object used by the C<json> read and write types.
200		293
201	If you don't supply it, then AnyEvent::Handle will create and use a	294	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.	295	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		296	texts.
203		297
204	Note that you are responsible to depend on the JSON module if you want to	298	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.	299	use this functionality, as AnyEvent does not have a dependency itself.
206		300
207	=item filter_r => $cb
208
209	=item filter_w => $cb
210
211	These exist, but are undocumented at this time.
212
213	=back	301	=back
214		302
215	=cut	303	=cut
216		304
217	sub new {	305	sub new {
218	my $class = shift;	306	my $class = shift;
219
220	my $self = bless { @_ }, $class;	307	my $self = bless { @_ }, $class;
221		308
222	$self->{fh} or Carp::croak "mandatory argument fh is missing";	309	$self->{fh} or Carp::croak "mandatory argument fh is missing";
223		310
224	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	311	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
225
226	if ($self->{tls}) {
227	require Net::SSLeay;
228	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
229	}
230		312
231	$self->{_activity} = AnyEvent->now;	313	$self->{_activity} = AnyEvent->now;
232	$self->_timeout;	314	$self->_timeout;
233		315
		316	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		317
		318	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		319	if $self->{tls};
		320
234	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	321	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
235		322
236	$self	323	$self->start_read
		324	if $self->{on_read};
		325
		326	$self->{fh} && $self
237	}	327	}
238		328
239	sub _shutdown {	329	sub _shutdown {
240	my ($self) = @_;	330	my ($self) = @_;
241		331
242	delete $self->{_tw};	332	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
243	delete $self->{_rw};	333	$self->{_eof} = 1; # tell starttls et. al to stop trying
244	delete $self->{_ww};
245	delete $self->{fh};
246		334
247	$self->stoptls;	335	&_freetls;
248	}	336	}
249		337
250	sub _error {	338	sub _error {
251	my ($self, $errno, $fatal) = @_;	339	my ($self, $errno, $fatal) = @_;
252		340
…		…
255		343
256	$! = $errno;	344	$! = $errno;
257		345
258	if ($self->{on_error}) {	346	if ($self->{on_error}) {
259	$self->{on_error}($self, $fatal);	347	$self->{on_error}($self, $fatal);
260	} else {	348	} elsif ($self->{fh}) {
261	Carp::croak "AnyEvent::Handle uncaught error: $!";	349	Carp::croak "AnyEvent::Handle uncaught error: $!";
262	}	350	}
263	}	351	}
264		352
265	=item $fh = $handle->fh	353	=item $fh = $handle->fh
266		354
267	This method returns the file handle of the L<AnyEvent::Handle> object.	355	This method returns the file handle used to create the L<AnyEvent::Handle> object.
268		356
269	=cut	357	=cut
270		358
271	sub fh { $_[0]{fh} }	359	sub fh { $_[0]{fh} }
272		360
…		…
290	$_[0]{on_eof} = $_[1];	378	$_[0]{on_eof} = $_[1];
291	}	379	}
292		380
293	=item $handle->on_timeout ($cb)	381	=item $handle->on_timeout ($cb)
294		382
295	Replace the current C<on_timeout> callback, or disables the callback	383	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	384	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
297	argument.	385	argument and method.
298		386
299	=cut	387	=cut
300		388
301	sub on_timeout {	389	sub on_timeout {
302	$_[0]{on_timeout} = $_[1];	390	$_[0]{on_timeout} = $_[1];
		391	}
		392
		393	=item $handle->autocork ($boolean)
		394
		395	Enables or disables the current autocork behaviour (see C<autocork>
		396	constructor argument). Changes will only take effect on the next write.
		397
		398	=cut
		399
		400	sub autocork {
		401	$_[0]{autocork} = $_[1];
		402	}
		403
		404	=item $handle->no_delay ($boolean)
		405
		406	Enables or disables the C<no_delay> setting (see constructor argument of
		407	the same name for details).
		408
		409	=cut
		410
		411	sub no_delay {
		412	$_[0]{no_delay} = $_[1];
		413
		414	eval {
		415	local $SIG{__DIE__};
		416	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		417	};
303	}	418	}
304		419
305	#############################################################################	420	#############################################################################
306		421
307	=item $handle->timeout ($seconds)	422	=item $handle->timeout ($seconds)
…		…
385	my ($self, $cb) = @_;	500	my ($self, $cb) = @_;
386		501
387	$self->{on_drain} = $cb;	502	$self->{on_drain} = $cb;
388		503
389	$cb->($self)	504	$cb->($self)
390	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	505	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
391	}	506	}
392		507
393	=item $handle->push_write ($data)	508	=item $handle->push_write ($data)
394		509
395	Queues the given scalar to be written. You can push as much data as you	510	Queues the given scalar to be written. You can push as much data as you
…		…
412	substr $self->{wbuf}, 0, $len, "";	527	substr $self->{wbuf}, 0, $len, "";
413		528
414	$self->{_activity} = AnyEvent->now;	529	$self->{_activity} = AnyEvent->now;
415		530
416	$self->{on_drain}($self)	531	$self->{on_drain}($self)
417	if $self->{low_water_mark} >= length $self->{wbuf}	532	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
418	&& $self->{on_drain};	533	&& $self->{on_drain};
419		534
420	delete $self->{_ww} unless length $self->{wbuf};	535	delete $self->{_ww} unless length $self->{wbuf};
421	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	536	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
422	$self->_error ($!, 1);	537	$self->_error ($!, 1);
423	}	538	}
424	};	539	};
425		540
426	# try to write data immediately	541	# try to write data immediately
427	$cb->();	542	$cb->() unless $self->{autocork};
428		543
429	# if still data left in wbuf, we need to poll	544	# if still data left in wbuf, we need to poll
430	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	545	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
431	if length $self->{wbuf};	546	if length $self->{wbuf};
432	};	547	};
…		…
446		561
447	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	562	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
448	->($self, @_);	563	->($self, @_);
449	}	564	}
450		565
451	if ($self->{filter_w}) {	566	if ($self->{tls}) {
452	$self->{filter_w}($self, \$_[0]);	567	$self->{_tls_wbuf} .= $_[0];
		568
		569	&_dotls ($self);
453	} else {	570	} else {
454	$self->{wbuf} .= $_[0];	571	$self->{wbuf} .= $_[0];
455	$self->_drain_wbuf;	572	$self->_drain_wbuf;
456	}	573	}
457	}	574	}
…		…
474	=cut	591	=cut
475		592
476	register_write_type netstring => sub {	593	register_write_type netstring => sub {
477	my ($self, $string) = @_;	594	my ($self, $string) = @_;
478		595
479	sprintf "%d:%s,", (length $string), $string	596	(length $string) . ":$string,"
480	};	597	};
481		598
482	=item packstring => $format, $data	599	=item packstring => $format, $data
483		600
484	An octet string prefixed with an encoded length. The encoding C<$format>	601	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
489	=cut	606	=cut
490		607
491	register_write_type packstring => sub {	608	register_write_type packstring => sub {
492	my ($self, $format, $string) = @_;	609	my ($self, $format, $string) = @_;
493		610
494	pack "$format/a", $string	611	pack "$format/a*", $string
495	};	612	};
496		613
497	=item json => $array_or_hashref	614	=item json => $array_or_hashref
498		615
499	Encodes the given hash or array reference into a JSON object. Unless you	616	Encodes the given hash or array reference into a JSON object. Unless you
…		…
533		650
534	$self->{json} ? $self->{json}->encode ($ref)	651	$self->{json} ? $self->{json}->encode ($ref)
535	: JSON::encode_json ($ref)	652	: JSON::encode_json ($ref)
536	};	653	};
537		654
		655	=item storable => $reference
		656
		657	Freezes the given reference using L<Storable> and writes it to the
		658	handle. Uses the C<nfreeze> format.
		659
		660	=cut
		661
		662	register_write_type storable => sub {
		663	my ($self, $ref) = @_;
		664
		665	require Storable;
		666
		667	pack "w/a*", Storable::nfreeze ($ref)
		668	};
		669
538	=back	670	=back
539		671
540	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	672	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
541		673
542	This function (not method) lets you add your own types to C<push_write>.	674	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	696	ways, the "simple" way, using only C<on_read> and the "complex" way, using
565	a queue.	697	a queue.
566		698
567	In the simple case, you just install an C<on_read> callback and whenever	699	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	700	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	701	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
570	or not.	702	leave the data there if you want to accumulate more (e.g. when only a
		703	partial message has been received so far).
571		704
572	In the more complex case, you want to queue multiple callbacks. In this	705	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	706	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	707	data arrives (also the first time it is queued) and removes it when it has
575	done its job (see C<push_read>, below).	708	done its job (see C<push_read>, below).
…		…
593	# handle xml	726	# handle xml
594	});	727	});
595	});	728	});
596	});	729	});
597		730
598	Example 2: Implement a client for a protocol that replies either with	731	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	732	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	733	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	734	just pipeline sending both requests and manipulate the queue as necessary
602	the callbacks:	735	in the callbacks.
603		736
604	# request one	737	When the first callback is called and sees an "OK" response, it will
		738	C<unshift> another line-read. This line-read will be queued I<before> the
		739	64-byte chunk callback.
		740
		741	# request one, returns either "OK + extra line" or "ERROR"
605	$handle->push_write ("request 1\015\012");	742	$handle->push_write ("request 1\015\012");
606		743
607	# we expect "ERROR" or "OK" as response, so push a line read	744	# we expect "ERROR" or "OK" as response, so push a line read
608	$handle->push_read (line => sub {	745	$handle->push_read (line => sub {
609	# if we got an "OK", we have to _prepend_ another line,	746	# if we got an "OK", we have to _prepend_ another line,
…		…
616	...	753	...
617	});	754	});
618	}	755	}
619	});	756	});
620		757
621	# request two	758	# request two, simply returns 64 octets
622	$handle->push_write ("request 2\015\012");	759	$handle->push_write ("request 2\015\012");
623		760
624	# simply read 64 bytes, always	761	# simply read 64 bytes, always
625	$handle->push_read (chunk => 64, sub {	762	$handle->push_read (chunk => 64, sub {
626	my $response = $_[1];	763	my $response = $_[1];
…		…
638		775
639	if (	776	if (
640	defined $self->{rbuf_max}	777	defined $self->{rbuf_max}
641	&& $self->{rbuf_max} < length $self->{rbuf}	778	&& $self->{rbuf_max} < length $self->{rbuf}
642	) {	779	) {
643	return $self->_error (&Errno::ENOSPC, 1);	780	$self->_error (&Errno::ENOSPC, 1), return;
644	}	781	}
645		782
646	while () {	783	while () {
647	no strict 'refs';	784	# we need to use a separate tls read buffer, as we must not receive data while
		785	# we are draining the buffer, and this can only happen with TLS.
		786	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
648		787
649	my $len = length $self->{rbuf};	788	my $len = length $self->{rbuf};
650		789
651	if (my $cb = shift @{ $self->{_queue} }) {	790	if (my $cb = shift @{ $self->{_queue} }) {
652	unless ($cb->($self)) {	791	unless ($cb->($self)) {
653	if ($self->{_eof}) {	792	if ($self->{_eof}) {
654	# no progress can be made (not enough data and no data forthcoming)	793	# no progress can be made (not enough data and no data forthcoming)
655	$self->_error (&Errno::EPIPE, 1), last;	794	$self->_error (&Errno::EPIPE, 1), return;
656	}	795	}
657		796
658	unshift @{ $self->{_queue} }, $cb;	797	unshift @{ $self->{_queue} }, $cb;
659	last;	798	last;
660	}	799	}
…		…
668	&& !@{ $self->{_queue} } # and the queue is still empty	807	&& !@{ $self->{_queue} } # and the queue is still empty
669	&& $self->{on_read} # but we still have on_read	808	&& $self->{on_read} # but we still have on_read
670	) {	809	) {
671	# no further data will arrive	810	# no further data will arrive
672	# so no progress can be made	811	# so no progress can be made
673	$self->_error (&Errno::EPIPE, 1), last	812	$self->_error (&Errno::EPIPE, 1), return
674	if $self->{_eof};	813	if $self->{_eof};
675		814
676	last; # more data might arrive	815	last; # more data might arrive
677	}	816	}
678	} else {	817	} else {
679	# read side becomes idle	818	# read side becomes idle
680	delete $self->{_rw};	819	delete $self->{_rw} unless $self->{tls};
681	last;	820	last;
682	}	821	}
683	}	822	}
684		823
		824	if ($self->{_eof}) {
		825	if ($self->{on_eof}) {
685	$self->{on_eof}($self)	826	$self->{on_eof}($self)
686	if $self->{_eof} && $self->{on_eof};	827	} else {
		828	$self->_error (0, 1);
		829	}
		830	}
687		831
688	# may need to restart read watcher	832	# may need to restart read watcher
689	unless ($self->{_rw}) {	833	unless ($self->{_rw}) {
690	$self->start_read	834	$self->start_read
691	if $self->{on_read} \|\| @{ $self->{_queue} };	835	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
709		853
710	=item $handle->rbuf	854	=item $handle->rbuf
711		855
712	Returns the read buffer (as a modifiable lvalue).	856	Returns the read buffer (as a modifiable lvalue).
713		857
714	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	858	You can access the read buffer directly as the C<< ->{rbuf} >>
715	you want.	859	member, if you want. However, the only operation allowed on the
		860	read buffer (apart from looking at it) is removing data from its
		861	beginning. Otherwise modifying or appending to it is not allowed and will
		862	lead to hard-to-track-down bugs.
716		863
717	NOTE: The read buffer should only be used or modified if the C<on_read>,	864	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	865	C<push_read> or C<unshift_read> methods are used. The other read methods
719	automatically manage the read buffer.	866	automatically manage the read buffer.
720		867
…		…
817	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	964	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
818	1	965	1
819	}	966	}
820	};	967	};
821		968
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)	969	=item line => [$eol, ]$cb->($handle, $line, $eol)
832		970
833	The callback will be called only once a full line (including the end of	971	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	972	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	973	marker) will be passed to the callback as second argument (C<$line>), and
…		…
850	=cut	988	=cut
851		989
852	register_read_type line => sub {	990	register_read_type line => sub {
853	my ($self, $cb, $eol) = @_;	991	my ($self, $cb, $eol) = @_;
854		992
855	$eol = qr\|(\015?\012)\| if @_ < 3;	993	if (@_ < 3) {
		994	# this is more than twice as fast as the generic code below
		995	sub {
		996	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		997
		998	$cb->($_[0], $1, $2);
		999	1
		1000	}
		1001	} else {
856	$eol = quotemeta $eol unless ref $eol;	1002	$eol = quotemeta $eol unless ref $eol;
857	$eol = qr\|^(.*?)($eol)\|s;	1003	$eol = qr\|^(.*?)($eol)\|s;
858		1004
859	sub {	1005	sub {
860	$_[0]{rbuf} =~ s/$eol// or return;	1006	$_[0]{rbuf} =~ s/$eol// or return;
861		1007
862	$cb->($_[0], $1, $2);	1008	$cb->($_[0], $1, $2);
		1009	1
863	1	1010	}
864	}	1011	}
865	};	1012	};
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		1013
878	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1014	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
879		1015
880	Makes a regex match against the regex object C<$accept> and returns	1016	Makes a regex match against the regex object C<$accept> and returns
881	everything up to and including the match.	1017	everything up to and including the match.
…		…
986	An octet string prefixed with an encoded length. The encoding C<$format>	1122	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	1123	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	1124	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
989	optional C<!>, C<< < >> or C<< > >> modifier).	1125	optional C<!>, C<< < >> or C<< > >> modifier).
990		1126
991	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1127	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1128	EPP uses a prefix of C<N> (4 octtes).
992		1129
993	Example: read a block of data prefixed by its length in BER-encoded	1130	Example: read a block of data prefixed by its length in BER-encoded
994	format (very efficient).	1131	format (very efficient).
995		1132
996	$handle->push_read (packstring => "w", sub {	1133	$handle->push_read (packstring => "w", sub {
…		…
1002	register_read_type packstring => sub {	1139	register_read_type packstring => sub {
1003	my ($self, $cb, $format) = @_;	1140	my ($self, $cb, $format) = @_;
1004		1141
1005	sub {	1142	sub {
1006	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1143	# 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} })	1144	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1008	or return;	1145	or return;
1009		1146
		1147	$format = length pack $format, $len;
		1148
		1149	# bypass unshift if we already have the remaining chunk
		1150	if ($format + $len <= length $_[0]{rbuf}) {
		1151	my $data = substr $_[0]{rbuf}, $format, $len;
		1152	substr $_[0]{rbuf}, 0, $format + $len, "";
		1153	$cb->($_[0], $data);
		1154	} else {
1010	# remove prefix	1155	# remove prefix
1011	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1156	substr $_[0]{rbuf}, 0, $format, "";
1012		1157
1013	# read rest	1158	# read remaining chunk
1014	$_[0]->unshift_read (chunk => $len, $cb);	1159	$_[0]->unshift_read (chunk => $len, $cb);
		1160	}
1015		1161
1016	1	1162	1
1017	}	1163	}
1018	};	1164	};
1019		1165
1020	=item json => $cb->($handle, $hash_or_arrayref)	1166	=item json => $cb->($handle, $hash_or_arrayref)
1021		1167
1022	Reads a JSON object or array, decodes it and passes it to the callback.	1168	Reads a JSON object or array, decodes it and passes it to the
		1169	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1023		1170
1024	If a C<json> object was passed to the constructor, then that will be used	1171	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.	1172	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1026		1173
1027	This read type uses the incremental parser available with JSON version	1174	This read type uses the incremental parser available with JSON version
…		…
1034	the C<json> write type description, above, for an actual example.	1181	the C<json> write type description, above, for an actual example.
1035		1182
1036	=cut	1183	=cut
1037		1184
1038	register_read_type json => sub {	1185	register_read_type json => sub {
1039	my ($self, $cb, $accept, $reject, $skip) = @_;	1186	my ($self, $cb) = @_;
1040		1187
1041	require JSON;	1188	require JSON;
1042		1189
1043	my $data;	1190	my $data;
1044	my $rbuf = \$self->{rbuf};	1191	my $rbuf = \$self->{rbuf};
1045		1192
1046	my $json = $self->{json} \|\|= JSON->new->utf8;	1193	my $json = $self->{json} \|\|= JSON->new->utf8;
1047		1194
1048	sub {	1195	sub {
1049	my $ref = $json->incr_parse ($self->{rbuf});	1196	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1050		1197
1051	if ($ref) {	1198	if ($ref) {
1052	$self->{rbuf} = $json->incr_text;	1199	$self->{rbuf} = $json->incr_text;
1053	$json->incr_text = "";	1200	$json->incr_text = "";
1054	$cb->($self, $ref);	1201	$cb->($self, $ref);
1055		1202
1056	1	1203	1
		1204	} elsif ($@) {
		1205	# error case
		1206	$json->incr_skip;
		1207
		1208	$self->{rbuf} = $json->incr_text;
		1209	$json->incr_text = "";
		1210
		1211	$self->_error (&Errno::EBADMSG);
		1212
		1213	()
1057	} else {	1214	} else {
1058	$self->{rbuf} = "";	1215	$self->{rbuf} = "";
		1216
1059	()	1217	()
1060	}	1218	}
		1219	}
		1220	};
		1221
		1222	=item storable => $cb->($handle, $ref)
		1223
		1224	Deserialises a L<Storable> frozen representation as written by the
		1225	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1226	data).
		1227
		1228	Raises C<EBADMSG> error if the data could not be decoded.
		1229
		1230	=cut
		1231
		1232	register_read_type storable => sub {
		1233	my ($self, $cb) = @_;
		1234
		1235	require Storable;
		1236
		1237	sub {
		1238	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1239	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1240	or return;
		1241
		1242	my $format = length pack "w", $len;
		1243
		1244	# bypass unshift if we already have the remaining chunk
		1245	if ($format + $len <= length $_[0]{rbuf}) {
		1246	my $data = substr $_[0]{rbuf}, $format, $len;
		1247	substr $_[0]{rbuf}, 0, $format + $len, "";
		1248	$cb->($_[0], Storable::thaw ($data));
		1249	} else {
		1250	# remove prefix
		1251	substr $_[0]{rbuf}, 0, $format, "";
		1252
		1253	# read remaining chunk
		1254	$_[0]->unshift_read (chunk => $len, sub {
		1255	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1256	$cb->($_[0], $ref);
		1257	} else {
		1258	$self->_error (&Errno::EBADMSG);
		1259	}
		1260	});
		1261	}
		1262
		1263	1
1061	}	1264	}
1062	};	1265	};
1063		1266
1064	=back	1267	=back
1065		1268
…		…
1095	Note that AnyEvent::Handle will automatically C<start_read> for you when	1298	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	1299	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	1300	will automatically C<stop_read> for you when neither C<on_read> is set nor
1098	there are any read requests in the queue.	1301	there are any read requests in the queue.
1099		1302
		1303	These methods will have no effect when in TLS mode (as TLS doesn't support
		1304	half-duplex connections).
		1305
1100	=cut	1306	=cut
1101		1307
1102	sub stop_read {	1308	sub stop_read {
1103	my ($self) = @_;	1309	my ($self) = @_;
1104		1310
1105	delete $self->{_rw};	1311	delete $self->{_rw} unless $self->{tls};
1106	}	1312	}
1107		1313
1108	sub start_read {	1314	sub start_read {
1109	my ($self) = @_;	1315	my ($self) = @_;
1110		1316
1111	unless ($self->{_rw} \|\| $self->{_eof}) {	1317	unless ($self->{_rw} \|\| $self->{_eof}) {
1112	Scalar::Util::weaken $self;	1318	Scalar::Util::weaken $self;
1113		1319
1114	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1320	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1115	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1321	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1116	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1322	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1117		1323
1118	if ($len > 0) {	1324	if ($len > 0) {
1119	$self->{_activity} = AnyEvent->now;	1325	$self->{_activity} = AnyEvent->now;
1120		1326
1121	$self->{filter_r}	1327	if ($self->{tls}) {
1122	? $self->{filter_r}($self, $rbuf)	1328	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1123	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1329
		1330	&_dotls ($self);
		1331	} else {
		1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	}
1124		1334
1125	} elsif (defined $len) {	1335	} elsif (defined $len) {
1126	delete $self->{_rw};	1336	delete $self->{_rw};
1127	$self->{_eof} = 1;	1337	$self->{_eof} = 1;
1128	$self->_drain_rbuf unless $self->{_in_drain};	1338	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1132	}	1342	}
1133	});	1343	});
1134	}	1344	}
1135	}	1345	}
1136		1346
		1347	# poll the write BIO and send the data if applicable
1137	sub _dotls {	1348	sub _dotls {
1138	my ($self) = @_;	1349	my ($self) = @_;
1139		1350
1140	my $buf;	1351	my $tmp;
1141		1352
1142	if (length $self->{_tls_wbuf}) {	1353	if (length $self->{_tls_wbuf}) {
1143	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1354	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1144	substr $self->{_tls_wbuf}, 0, $len, "";	1355	substr $self->{_tls_wbuf}, 0, $tmp, "";
1145	}	1356	}
1146	}	1357	}
1147		1358
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}))) {	1359	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1154	if (length $buf) {	1360	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	1361	# let's treat SSL-eof as we treat normal EOF
		1362	delete $self->{_rw};
1159	$self->{_eof} = 1;	1363	$self->{_eof} = 1;
1160	$self->_shutdown;	1364	&_freetls;
1161	return;
1162	}	1365	}
1163	}
1164		1366
		1367	$self->{_tls_rbuf} .= $tmp;
		1368	$self->_drain_rbuf unless $self->{_in_drain};
		1369	$self->{tls} or return; # tls session might have gone away in callback
		1370	}
		1371
1165	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1372	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1166		1373
1167	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1374	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1168	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1375	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1169	return $self->_error ($!, 1);	1376	return $self->_error ($!, 1);
1170	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1377	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1171	return $self->_error (&Errno::EIO, 1);	1378	return $self->_error (&Errno::EIO, 1);
1172	}	1379	}
1173		1380
1174	# all others are fine for our purposes	1381	# all other errors are fine for our purposes
		1382	}
		1383
		1384	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1385	$self->{wbuf} .= $tmp;
		1386	$self->_drain_wbuf;
1175	}	1387	}
1176	}	1388	}
1177		1389
1178	=item $handle->starttls ($tls[, $tls_ctx])	1390	=item $handle->starttls ($tls[, $tls_ctx])
1179		1391
…		…
1182	C<starttls>.	1394	C<starttls>.
1183		1395
1184	The first argument is the same as the C<tls> constructor argument (either	1396	The first argument is the same as the C<tls> constructor argument (either
1185	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1397	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1186		1398
1187	The second argument is the optional C<Net::SSLeay::CTX> object that is	1399	The second argument is the optional C<AnyEvent::TLS> object that is used
1188	used when AnyEvent::Handle has to create its own TLS connection object.	1400	when AnyEvent::Handle has to create its own TLS connection object, or
		1401	a hash reference with C<< key => value >> pairs that will be used to
		1402	construct a new context.
1189		1403
1190	The TLS connection object will end up in C<< $handle->{tls} >> after this	1404	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1191	call and can be used or changed to your liking. Note that the handshake	1405	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1192	might have already started when this function returns.	1406	changed to your liking. Note that the handshake might have already started
		1407	when this function returns.
		1408
		1409	If it an error to start a TLS handshake more than once per
		1410	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1193		1411
1194	=cut	1412	=cut
1195		1413
1196	sub starttls {	1414	sub starttls {
1197	my ($self, $ssl, $ctx) = @_;	1415	my ($self, $ssl, $ctx) = @_;
1198		1416
1199	$self->stoptls;	1417	require Net::SSLeay;
1200		1418
1201	if ($ssl eq "accept") {	1419	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1202	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1420	if $self->{tls};
1203	Net::SSLeay::set_accept_state ($ssl);	1421
1204	} elsif ($ssl eq "connect") {	1422	$ctx \|\|= $self->{tls_ctx};
1205	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1423
1206	Net::SSLeay::set_connect_state ($ssl);	1424	if ("HASH" eq ref $ctx) {
		1425	require AnyEvent::TLS;
		1426
		1427	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1428	$ctx = new AnyEvent::TLS %$ctx;
		1429	}
1207	}	1430
1208		1431	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1209	$self->{tls} = $ssl;	1432	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self);
1210		1433
1211	# basically, this is deep magic (because SSL_read should have the same issues)	1434	# 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".	1435	# but the openssl maintainers basically said: "trust us, it just works".
1213	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1436	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1214	# and mismaintained ssleay-module doesn't even offer them).	1437	# and mismaintained ssleay-module doesn't even offer them).
1215	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1438	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1439	#
		1440	# in short: this is a mess.
		1441	#
		1442	# note that we do not try to keep the length constant between writes as we are required to do.
		1443	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1444	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1445	# have identity issues in that area.
1216	Net::SSLeay::CTX_set_mode ($self->{tls},	1446	# Net::SSLeay::CTX_set_mode ($ssl,
1217	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1447	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1218	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1448	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1449	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1219		1450
1220	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1451	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1221	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1452	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1222		1453
1223	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1454	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1224		1455
1225	$self->{filter_w} = sub {	1456	&_dotls; # need to trigger the initial handshake
1226	$_[0]{_tls_wbuf} .= ${$_[1]};	1457	$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	}	1458	}
1234		1459
1235	=item $handle->stoptls	1460	=item $handle->stoptls
1236		1461
1237	Destroys the SSL connection, if any. Partial read or write data will be	1462	Shuts down the SSL connection - this makes a proper EOF handshake by
1238	lost.	1463	sending a close notify to the other side, but since OpenSSL doesn't
		1464	support non-blocking shut downs, it is not possible to re-use the stream
		1465	afterwards.
1239		1466
1240	=cut	1467	=cut
1241		1468
1242	sub stoptls {	1469	sub stoptls {
1243	my ($self) = @_;	1470	my ($self) = @_;
1244		1471
1245	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1472	if ($self->{tls}) {
		1473	Net::SSLeay::shutdown ($self->{tls});
1246		1474
1247	delete $self->{_rbio};	1475	&_dotls;
1248	delete $self->{_wbio};	1476
1249	delete $self->{_tls_wbuf};	1477	# we don't give a shit. no, we do, but we can't. no...
1250	delete $self->{filter_r};	1478	# we, we... have to use openssl :/
1251	delete $self->{filter_w};	1479	&_freetls;
		1480	}
		1481	}
		1482
		1483	sub _freetls {
		1484	my ($self) = @_;
		1485
		1486	return unless $self->{tls};
		1487
		1488	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1489
		1490	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1252	}	1491	}
1253		1492
1254	sub DESTROY {	1493	sub DESTROY {
1255	my $self = shift;	1494	my ($self) = @_;
1256		1495
1257	$self->stoptls;	1496	&_freetls;
		1497
		1498	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1499
		1500	if ($linger && length $self->{wbuf}) {
		1501	my $fh = delete $self->{fh};
		1502	my $wbuf = delete $self->{wbuf};
		1503
		1504	my @linger;
		1505
		1506	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1507	my $len = syswrite $fh, $wbuf, length $wbuf;
		1508
		1509	if ($len > 0) {
		1510	substr $wbuf, 0, $len, "";
		1511	} else {
		1512	@linger = (); # end
		1513	}
		1514	});
		1515	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1516	@linger = ();
		1517	});
		1518	}
		1519	}
		1520
		1521	=item $handle->destroy
		1522
		1523	Shuts down the handle object as much as possible - this call ensures that
		1524	no further callbacks will be invoked and resources will be freed as much
		1525	as possible. You must not call any methods on the object afterwards.
		1526
		1527	Normally, you can just "forget" any references to an AnyEvent::Handle
		1528	object and it will simply shut down. This works in fatal error and EOF
		1529	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1530	callback, so when you want to destroy the AnyEvent::Handle object from
		1531	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1532	that case.
		1533
		1534	The handle might still linger in the background and write out remaining
		1535	data, as specified by the C<linger> option, however.
		1536
		1537	=cut
		1538
		1539	sub destroy {
		1540	my ($self) = @_;
		1541
		1542	$self->DESTROY;
		1543	%$self = ();
1258	}	1544	}
1259		1545
1260	=item AnyEvent::Handle::TLS_CTX	1546	=item AnyEvent::Handle::TLS_CTX
1261		1547
1262	This function creates and returns the Net::SSLeay::CTX object used by	1548	This function creates and returns the AnyEvent::TLS object used by default
1263	default for TLS mode.	1549	for TLS mode.
1264		1550
1265	The context is created like this:	1551	The context is created by calling L<AnyEvent::TLS> without any arguments.
1266
1267	Net::SSLeay::load_error_strings;
1268	Net::SSLeay::SSLeay_add_ssl_algorithms;
1269	Net::SSLeay::randomize;
1270
1271	my $CTX = Net::SSLeay::CTX_new;
1272
1273	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1274		1552
1275	=cut	1553	=cut
1276		1554
1277	our $TLS_CTX;	1555	our $TLS_CTX;
1278		1556
1279	sub TLS_CTX() {	1557	sub TLS_CTX() {
1280	$TLS_CTX \|\| do {	1558	$TLS_CTX \|\|= do {
1281	require Net::SSLeay;	1559	require AnyEvent::TLS;
1282		1560
1283	Net::SSLeay::load_error_strings ();	1561	new AnyEvent::TLS
1284	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1285	Net::SSLeay::randomize ();
1286
1287	$TLS_CTX = Net::SSLeay::CTX_new ();
1288
1289	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1290
1291	$TLS_CTX
1292	}	1562	}
1293	}	1563	}
1294		1564
1295	=back	1565	=back
		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
1296		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
…		…
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.132 by elmex, Thu Jul 2 22:25:13 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.132 by elmex, Thu Jul 2 22:25:13 2009 UTC