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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC vs.
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.232;	16	our $VERSION = 4.86;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
32	$cv->broadcast;	28	my ($hdl, $fatal, $msg) = @_;
33	},	29	warn "got error $msg\n";
		30	$hdl->destroy;
		31	$cv->send;
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
63		61
64	=head1 METHODS	62	=head1 METHODS
65		63
66	=over 4	64	=over 4
67		65
68	=item B<new (%args)>	66	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		67
70	The constructor supports these arguments (all as key => value pairs).	68	The constructor supports these arguments (all as C<< key => value >> pairs).
71		69
72	=over 4	70	=over 4
73		71
74	=item fh => $filehandle [MANDATORY]	72	=item fh => $filehandle [MANDATORY]
75		73
		74	#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		80
		81	#=item connect => [$host, $service]
		82	#
		83	# You have to specify either this parameter, or C<connect>, below.
		84	#Try to connect to the specified host and service (port), using
		85	#C<AnyEvent::Socket::tcp_connect>.
		86	#
		87	#When this
		88
82	=item on_eof => $cb->($handle)	89	=item on_eof => $cb->($handle)
83		90
84	Set the callback to be called when an end-of-file condition is detected,	91	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	92	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	93	connection cleanly, and there are no outstanding read requests in the
		94	queue (if there are read requests, then an EOF counts as an unexpected
		95	connection close and will be flagged as an error).
87		96
88	For sockets, this just means that the other side has stopped sending data,	97	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	98	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	99	callback and continue writing data, as only the read part has been shut
91	down.	100	down.
92		101
93	While not mandatory, it is I<highly> recommended to set an eof callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	102	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>.	103	set, then a fatal error will be raised with C<$!> set to <0>.
99		104
100	=item on_error => $cb->($handle, $fatal)	105	=item on_error => $cb->($handle, $fatal, $message)
101		106
102	This is the error callback, which is called when, well, some error	107	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to	108	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	109	connect or a read error.
105		110
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	111	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable	112	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C< ->rbuf >). Examples of fatal	113	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	114	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		116
		117	AnyEvent::Handle tries to find an appropriate error code for you to check
		118	against, but in some cases (TLS errors), this does not work well. It is
		119	recommended to always output the C<$message> argument in human-readable
		120	error messages (it's usually the same as C<"$!">).
111		121
112	Non-fatal errors can be retried by simply returning, but it is recommended	122	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	123	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	124	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	125	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		126
117	On callback entrance, the value of C<$!> contains the operating system	127	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	128	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		129	C<EPROTO>).
119		130
120	While not mandatory, it is I<highly> recommended to set this callback, as	131	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls	132	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.	133	C<croak>.
123		134
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	138	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the	139	callback will only be called when at least one octet of data is in the
129	read buffer).	140	read buffer).
130		141
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	142	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.	143	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		144	must not enlarge or modify the read buffer, you can only remove data at
		145	the beginning from it.
133		146
134	When an EOF condition is detected then AnyEvent::Handle will first try to	147	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before	148	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal	149	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).	150	error will be raised (with C<$!> set to C<EPIPE>).
		151
		152	Note that, unlike requests in the read queue, an C<on_read> callback
		153	doesn't mean you I<require> some data: if there is an EOF and there
		154	are outstanding read requests then an error will be flagged. With an
		155	C<on_read> callback, the C<on_eof> callback will be invoked.
138		156
139	=item on_drain => $cb->($handle)	157	=item on_drain => $cb->($handle)
140		158
141	This sets the callback that is called when the write buffer becomes empty	159	This sets the callback that is called when the write buffer becomes empty
142	(or when the callback is set and the buffer is empty already).	160	(or when the callback is set and the buffer is empty already).
…		…
152	=item timeout => $fractional_seconds	170	=item timeout => $fractional_seconds
153		171
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	172	If non-zero, then this enables an "inactivity" timeout: whenever this many
155	seconds pass without a successful read or write on the underlying file	173	seconds pass without a successful read or write on the underlying file
156	handle, the C<on_timeout> callback will be invoked (and if that one is	174	handle, the C<on_timeout> callback will be invoked (and if that one is
157	missing, an C<ETIMEDOUT> error will be raised).	175	missing, a non-fatal C<ETIMEDOUT> error will be raised).
158		176
159	Note that timeout processing is also active when you currently do not have	177	Note that timeout processing is also active when you currently do not have
160	any outstanding read or write requests: If you plan to keep the connection	178	any outstanding read or write requests: If you plan to keep the connection
161	idle then you should disable the timout temporarily or ignore the timeout	179	idle then you should disable the timout temporarily or ignore the timeout
162	in the C<on_timeout> callback.	180	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		181	restart the timeout.
163		182
164	Zero (the default) disables this timeout.	183	Zero (the default) disables this timeout.
165		184
166	=item on_timeout => $cb->($handle)	185	=item on_timeout => $cb->($handle)
167		186
…		…
171		190
172	=item rbuf_max => <bytes>	191	=item rbuf_max => <bytes>
173		192
174	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	193	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
175	when the read buffer ever (strictly) exceeds this size. This is useful to	194	when the read buffer ever (strictly) exceeds this size. This is useful to
176	avoid denial-of-service attacks.	195	avoid some forms of denial-of-service attacks.
177		196
178	For example, a server accepting connections from untrusted sources should	197	For example, a server accepting connections from untrusted sources should
179	be configured to accept only so-and-so much data that it cannot act on	198	be configured to accept only so-and-so much data that it cannot act on
180	(for example, when expecting a line, an attacker could send an unlimited	199	(for example, when expecting a line, an attacker could send an unlimited
181	amount of data without a callback ever being called as long as the line	200	amount of data without a callback ever being called as long as the line
182	isn't finished).	201	isn't finished).
183		202
184	=item autocork => <boolean>	203	=item autocork => <boolean>
185		204
186	When disabled (the default), then C<push_write> will try to immediately	205	When disabled (the default), then C<push_write> will try to immediately
187	write the data to the handle if possible. This avoids having to register	206	write the data to the handle, if possible. This avoids having to register
188	a write watcher and wait for the next event loop iteration, but can be	207	a write watcher and wait for the next event loop iteration, but can
189	inefficient if you write multiple small chunks (this disadvantage is	208	be inefficient if you write multiple small chunks (on the wire, this
190	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	209	disadvantage is usually avoided by your kernel's nagle algorithm, see
		210	C<no_delay>, but this option can save costly syscalls).
191		211
192	When enabled, then writes will always be queued till the next event loop	212	When enabled, then writes will always be queued till the next event loop
193	iteration. This is efficient when you do many small writes per iteration,	213	iteration. This is efficient when you do many small writes per iteration,
194	but less efficient when you do a single write only.	214	but less efficient when you do a single write only per iteration (or when
		215	the write buffer often is full). It also increases write latency.
195		216
196	=item no_delay => <boolean>	217	=item no_delay => <boolean>
197		218
198	When doing small writes on sockets, your operating system kernel might	219	When doing small writes on sockets, your operating system kernel might
199	wait a bit for more data before actually sending it out. This is called	220	wait a bit for more data before actually sending it out. This is called
200	the Nagle algorithm, and usually it is beneficial.	221	the Nagle algorithm, and usually it is beneficial.
201		222
202	In some situations you want as low a delay as possible, which cna be	223	In some situations you want as low a delay as possible, which can be
203	accomplishd by setting this option to true.	224	accomplishd by setting this option to a true value.
204		225
205	The default is your opertaing system's default behaviour, this option	226	The default is your opertaing system's default behaviour (most likely
206	explicitly enables or disables it, if possible.	227	enabled), this option explicitly enables or disables it, if possible.
207		228
208	=item read_size => <bytes>	229	=item read_size => <bytes>
209		230
210	The default read block size (the amount of bytes this module will try to read	231	The default read block size (the amount of bytes this module will
211	during each (loop iteration). Default: C<8192>.	232	try to read during each loop iteration, which affects memory
		233	requirements). Default: C<8192>.
212		234
213	=item low_water_mark => <bytes>	235	=item low_water_mark => <bytes>
214		236
215	Sets the amount of bytes (default: C<0>) that make up an "empty" write	237	Sets the amount of bytes (default: C<0>) that make up an "empty" write
216	buffer: If the write reaches this size or gets even samller it is	238	buffer: If the write reaches this size or gets even samller it is
217	considered empty.	239	considered empty.
218		240
		241	Sometimes it can be beneficial (for performance reasons) to add data to
		242	the write buffer before it is fully drained, but this is a rare case, as
		243	the operating system kernel usually buffers data as well, so the default
		244	is good in almost all cases.
		245
219	=item linger => <seconds>	246	=item linger => <seconds>
220		247
221	If non-zero (default: C<3600>), then the destructor of the	248	If non-zero (default: C<3600>), then the destructor of the
222	AnyEvent::Handle object will check wether there is still outstanding write	249	AnyEvent::Handle object will check whether there is still outstanding
223	data and will install a watcher that will write out this data. No errors	250	write data and will install a watcher that will write this data to the
224	will be reported (this mostly matches how the operating system treats	251	socket. No errors will be reported (this mostly matches how the operating
225	outstanding data at socket close time).	252	system treats outstanding data at socket close time).
226		253
227	This will not work for partial TLS data that could not yet been	254	This will not work for partial TLS data that could not be encoded
228	encoded. This data will be lost.	255	yet. This data will be lost. Calling the C<stoptls> method in time might
		256	help.
		257
		258	=item peername => $string
		259
		260	A string used to identify the remote site - usually the DNS hostname
		261	(I<not> IDN!) used to create the connection, rarely the IP address.
		262
		263	Apart from being useful in error messages, this string is also used in TLS
		264	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		265	verification will be skipped when C<peername> is not specified or
		266	C<undef>.
229		267
230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	268	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
231		269
232	When this parameter is given, it enables TLS (SSL) mode, that means it	270	When this parameter is given, it enables TLS (SSL) mode, that means
233	will start making tls handshake and will transparently encrypt/decrypt	271	AnyEvent will start a TLS handshake as soon as the conenction has been
234	data.	272	established and will transparently encrypt/decrypt data afterwards.
		273
		274	All TLS protocol errors will be signalled as C<EPROTO>, with an
		275	appropriate error message.
235		276
236	TLS mode requires Net::SSLeay to be installed (it will be loaded	277	TLS mode requires Net::SSLeay to be installed (it will be loaded
237	automatically when you try to create a TLS handle).	278	automatically when you try to create a TLS handle): this module doesn't
		279	have a dependency on that module, so if your module requires it, you have
		280	to add the dependency yourself.
238		281
239	For the TLS server side, use C<accept>, and for the TLS client side of a	282	Unlike TCP, TLS has a server and client side: for the TLS server side, use
240	connection, use C<connect> mode.	283	C<accept>, and for the TLS client side of a connection, use C<connect>
		284	mode.
241		285
242	You can also provide your own TLS connection object, but you have	286	You can also provide your own TLS connection object, but you have
243	to make sure that you call either C<Net::SSLeay::set_connect_state>	287	to make sure that you call either C<Net::SSLeay::set_connect_state>
244	or C<Net::SSLeay::set_accept_state> on it before you pass it to	288	or C<Net::SSLeay::set_accept_state> on it before you pass it to
245	AnyEvent::Handle.	289	AnyEvent::Handle. Also, this module will take ownership of this connection
		290	object.
246		291
		292	At some future point, AnyEvent::Handle might switch to another TLS
		293	implementation, then the option to use your own session object will go
		294	away.
		295
		296	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		297	passing in the wrong integer will lead to certain crash. This most often
		298	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		299	segmentation fault.
		300
247	See the C<starttls> method if you need to start TLS negotiation later.	301	See the C<< ->starttls >> method for when need to start TLS negotiation later.
248		302
249	=item tls_ctx => $ssl_ctx	303	=item tls_ctx => $anyevent_tls
250		304
251	Use the given Net::SSLeay::CTX object to create the new TLS connection	305	Use the given C<AnyEvent::TLS> object to create the new TLS connection
252	(unless a connection object was specified directly). If this parameter is	306	(unless a connection object was specified directly). If this parameter is
253	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	307	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
254		308
		309	Instead of an object, you can also specify a hash reference with C<< key
		310	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		311	new TLS context object.
		312
		313	=item on_starttls => $cb->($handle, $success[, $error_message])
		314
		315	This callback will be invoked when the TLS/SSL handshake has finished. If
		316	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		317	(C<on_stoptls> will not be called in this case).
		318
		319	The session in C<< $handle->{tls} >> can still be examined in this
		320	callback, even when the handshake was not successful.
		321
		322	TLS handshake failures will not cause C<on_error> to be invoked when this
		323	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		324
		325	Without this callback, handshake failures lead to C<on_error> being
		326	called, as normal.
		327
		328	Note that you cannot call C<starttls> right again in this callback. If you
		329	need to do that, start an zero-second timer instead whose callback can
		330	then call C<< ->starttls >> again.
		331
		332	=item on_stoptls => $cb->($handle)
		333
		334	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		335	set, then it will be invoked after freeing the TLS session. If it is not,
		336	then a TLS shutdown condition will be treated like a normal EOF condition
		337	on the handle.
		338
		339	The session in C<< $handle->{tls} >> can still be examined in this
		340	callback.
		341
		342	This callback will only be called on TLS shutdowns, not when the
		343	underlying handle signals EOF.
		344
255	=item json => JSON or JSON::XS object	345	=item json => JSON or JSON::XS object
256		346
257	This is the json coder object used by the C<json> read and write types.	347	This is the json coder object used by the C<json> read and write types.
258		348
259	If you don't supply it, then AnyEvent::Handle will create and use a	349	If you don't supply it, then AnyEvent::Handle will create and use a
260	suitable one, which will write and expect UTF-8 encoded JSON texts.	350	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		351	texts.
261		352
262	Note that you are responsible to depend on the JSON module if you want to	353	Note that you are responsible to depend on the JSON module if you want to
263	use this functionality, as AnyEvent does not have a dependency itself.	354	use this functionality, as AnyEvent does not have a dependency itself.
264		355
265	=item filter_r => $cb
266
267	=item filter_w => $cb
268
269	These exist, but are undocumented at this time.
270
271	=back	356	=back
272		357
273	=cut	358	=cut
274		359
275	sub new {	360	sub new {
276	my $class = shift;	361	my $class = shift;
277
278	my $self = bless { @_ }, $class;	362	my $self = bless { @_ }, $class;
279		363
280	$self->{fh} or Carp::croak "mandatory argument fh is missing";	364	$self->{fh} or Carp::croak "mandatory argument fh is missing";
281		365
282	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	366	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
283
284	if ($self->{tls}) {
285	require Net::SSLeay;
286	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
287	}
288		367
289	$self->{_activity} = AnyEvent->now;	368	$self->{_activity} = AnyEvent->now;
290	$self->_timeout;	369	$self->_timeout;
291		370
292	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
293	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	371	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		372
		373	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		374	if $self->{tls};
		375
		376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
294		377
295	$self->start_read	378	$self->start_read
296	if $self->{on_read};	379	if $self->{on_read};
297		380
298	$self	381	$self->{fh} && $self
299	}	382	}
300		383
301	sub _shutdown {	384	#sub _shutdown {
302	my ($self) = @_;	385	# my ($self) = @_;
303		386	#
304	delete $self->{_tw};	387	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
305	delete $self->{_rw};	388	# $self->{_eof} = 1; # tell starttls et. al to stop trying
306	delete $self->{_ww};	389	#
307	delete $self->{fh};	390	# &_freetls;
308		391	#}
309	$self->stoptls;
310
311	delete $self->{on_read};
312	delete $self->{_queue};
313	}
314		392
315	sub _error {	393	sub _error {
316	my ($self, $errno, $fatal) = @_;	394	my ($self, $errno, $fatal, $message) = @_;
317
318	$self->_shutdown
319	if $fatal;
320		395
321	$! = $errno;	396	$! = $errno;
		397	$message \|\|= "$!";
322		398
323	if ($self->{on_error}) {	399	if ($self->{on_error}) {
324	$self->{on_error}($self, $fatal);	400	$self->{on_error}($self, $fatal, $message);
325	} else {	401	$self->destroy if $fatal;
		402	} elsif ($self->{fh}) {
		403	$self->destroy;
326	Carp::croak "AnyEvent::Handle uncaught error: $!";	404	Carp::croak "AnyEvent::Handle uncaught error: $message";
327	}	405	}
328	}	406	}
329		407
330	=item $fh = $handle->fh	408	=item $fh = $handle->fh
331		409
332	This method returns the file handle of the L<AnyEvent::Handle> object.	410	This method returns the file handle used to create the L<AnyEvent::Handle> object.
333		411
334	=cut	412	=cut
335		413
336	sub fh { $_[0]{fh} }	414	sub fh { $_[0]{fh} }
337		415
…		…
355	$_[0]{on_eof} = $_[1];	433	$_[0]{on_eof} = $_[1];
356	}	434	}
357		435
358	=item $handle->on_timeout ($cb)	436	=item $handle->on_timeout ($cb)
359		437
360	Replace the current C<on_timeout> callback, or disables the callback	438	Replace the current C<on_timeout> callback, or disables the callback (but
361	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	439	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
362	argument.	440	argument and method.
363		441
364	=cut	442	=cut
365		443
366	sub on_timeout {	444	sub on_timeout {
367	$_[0]{on_timeout} = $_[1];	445	$_[0]{on_timeout} = $_[1];
368	}	446	}
369		447
370	=item $handle->autocork ($boolean)	448	=item $handle->autocork ($boolean)
371		449
372	Enables or disables the current autocork behaviour (see C<autocork>	450	Enables or disables the current autocork behaviour (see C<autocork>
373	constructor argument).	451	constructor argument). Changes will only take effect on the next write.
374		452
375	=cut	453	=cut
		454
		455	sub autocork {
		456	$_[0]{autocork} = $_[1];
		457	}
376		458
377	=item $handle->no_delay ($boolean)	459	=item $handle->no_delay ($boolean)
378		460
379	Enables or disables the C<no_delay> setting (see constructor argument of	461	Enables or disables the C<no_delay> setting (see constructor argument of
380	the same name for details).	462	the same name for details).
…		…
388	local $SIG{__DIE__};	470	local $SIG{__DIE__};
389	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	471	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
390	};	472	};
391	}	473	}
392		474
		475	=item $handle->on_starttls ($cb)
		476
		477	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		478
		479	=cut
		480
		481	sub on_starttls {
		482	$_[0]{on_starttls} = $_[1];
		483	}
		484
		485	=item $handle->on_stoptls ($cb)
		486
		487	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		488
		489	=cut
		490
		491	sub on_starttls {
		492	$_[0]{on_stoptls} = $_[1];
		493	}
		494
393	#############################################################################	495	#############################################################################
394		496
395	=item $handle->timeout ($seconds)	497	=item $handle->timeout ($seconds)
396		498
397	Configures (or disables) the inactivity timeout.	499	Configures (or disables) the inactivity timeout.
…		…
421	$self->{_activity} = $NOW;	523	$self->{_activity} = $NOW;
422		524
423	if ($self->{on_timeout}) {	525	if ($self->{on_timeout}) {
424	$self->{on_timeout}($self);	526	$self->{on_timeout}($self);
425	} else {	527	} else {
426	$self->_error (&Errno::ETIMEDOUT);	528	$self->_error (Errno::ETIMEDOUT);
427	}	529	}
428		530
429	# callback could have changed timeout value, optimise	531	# callback could have changed timeout value, optimise
430	return unless $self->{timeout};	532	return unless $self->{timeout};
431		533
…		…
473	my ($self, $cb) = @_;	575	my ($self, $cb) = @_;
474		576
475	$self->{on_drain} = $cb;	577	$self->{on_drain} = $cb;
476		578
477	$cb->($self)	579	$cb->($self)
478	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	580	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
479	}	581	}
480		582
481	=item $handle->push_write ($data)	583	=item $handle->push_write ($data)
482		584
483	Queues the given scalar to be written. You can push as much data as you	585	Queues the given scalar to be written. You can push as much data as you
…		…
494	Scalar::Util::weaken $self;	596	Scalar::Util::weaken $self;
495		597
496	my $cb = sub {	598	my $cb = sub {
497	my $len = syswrite $self->{fh}, $self->{wbuf};	599	my $len = syswrite $self->{fh}, $self->{wbuf};
498		600
499	if ($len >= 0) {	601	if (defined $len) {
500	substr $self->{wbuf}, 0, $len, "";	602	substr $self->{wbuf}, 0, $len, "";
501		603
502	$self->{_activity} = AnyEvent->now;	604	$self->{_activity} = AnyEvent->now;
503		605
504	$self->{on_drain}($self)	606	$self->{on_drain}($self)
505	if $self->{low_water_mark} >= length $self->{wbuf}	607	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
506	&& $self->{on_drain};	608	&& $self->{on_drain};
507		609
508	delete $self->{_ww} unless length $self->{wbuf};	610	delete $self->{_ww} unless length $self->{wbuf};
509	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	611	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
510	$self->_error ($!, 1);	612	$self->_error ($!, 1);
…		…
534		636
535	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	637	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
536	->($self, @_);	638	->($self, @_);
537	}	639	}
538		640
539	if ($self->{filter_w}) {	641	if ($self->{tls}) {
540	$self->{filter_w}($self, \$_[0]);	642	$self->{_tls_wbuf} .= $_[0];
		643
		644	&_dotls ($self);
541	} else {	645	} else {
542	$self->{wbuf} .= $_[0];	646	$self->{wbuf} .= $_[0];
543	$self->_drain_wbuf;	647	$self->_drain_wbuf;
544	}	648	}
545	}	649	}
…		…
562	=cut	666	=cut
563		667
564	register_write_type netstring => sub {	668	register_write_type netstring => sub {
565	my ($self, $string) = @_;	669	my ($self, $string) = @_;
566		670
567	sprintf "%d:%s,", (length $string), $string	671	(length $string) . ":$string,"
568	};	672	};
569		673
570	=item packstring => $format, $data	674	=item packstring => $format, $data
571		675
572	An octet string prefixed with an encoded length. The encoding C<$format>	676	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
637		741
638	pack "w/a*", Storable::nfreeze ($ref)	742	pack "w/a*", Storable::nfreeze ($ref)
639	};	743	};
640		744
641	=back	745	=back
		746
		747	=item $handle->push_shutdown
		748
		749	Sometimes you know you want to close the socket after writing your data
		750	before it was actually written. One way to do that is to replace your
		751	C<on_drain> handler by a callback that shuts down the socket (and set
		752	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		753	replaces the C<on_drain> callback with:
		754
		755	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		756
		757	This simply shuts down the write side and signals an EOF condition to the
		758	the peer.
		759
		760	You can rely on the normal read queue and C<on_eof> handling
		761	afterwards. This is the cleanest way to close a connection.
		762
		763	=cut
		764
		765	sub push_shutdown {
		766	my ($self) = @_;
		767
		768	delete $self->{low_water_mark};
		769	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		770	}
642		771
643	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	772	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
644		773
645	This function (not method) lets you add your own types to C<push_write>.	774	This function (not method) lets you add your own types to C<push_write>.
646	Whenever the given C<type> is used, C<push_write> will invoke the code	775	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
746		875
747	if (	876	if (
748	defined $self->{rbuf_max}	877	defined $self->{rbuf_max}
749	&& $self->{rbuf_max} < length $self->{rbuf}	878	&& $self->{rbuf_max} < length $self->{rbuf}
750	) {	879	) {
751	$self->_error (&Errno::ENOSPC, 1), return;	880	$self->_error (Errno::ENOSPC, 1), return;
752	}	881	}
753		882
754	while () {	883	while () {
		884	# we need to use a separate tls read buffer, as we must not receive data while
		885	# we are draining the buffer, and this can only happen with TLS.
		886	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		887
755	my $len = length $self->{rbuf};	888	my $len = length $self->{rbuf};
756		889
757	if (my $cb = shift @{ $self->{_queue} }) {	890	if (my $cb = shift @{ $self->{_queue} }) {
758	unless ($cb->($self)) {	891	unless ($cb->($self)) {
759	if ($self->{_eof}) {	892	if ($self->{_eof}) {
760	# no progress can be made (not enough data and no data forthcoming)	893	# no progress can be made (not enough data and no data forthcoming)
761	$self->_error (&Errno::EPIPE, 1), return;	894	$self->_error (Errno::EPIPE, 1), return;
762	}	895	}
763		896
764	unshift @{ $self->{_queue} }, $cb;	897	unshift @{ $self->{_queue} }, $cb;
765	last;	898	last;
766	}	899	}
…		…
774	&& !@{ $self->{_queue} } # and the queue is still empty	907	&& !@{ $self->{_queue} } # and the queue is still empty
775	&& $self->{on_read} # but we still have on_read	908	&& $self->{on_read} # but we still have on_read
776	) {	909	) {
777	# no further data will arrive	910	# no further data will arrive
778	# so no progress can be made	911	# so no progress can be made
779	$self->_error (&Errno::EPIPE, 1), return	912	$self->_error (Errno::EPIPE, 1), return
780	if $self->{_eof};	913	if $self->{_eof};
781		914
782	last; # more data might arrive	915	last; # more data might arrive
783	}	916	}
784	} else {	917	} else {
785	# read side becomes idle	918	# read side becomes idle
786	delete $self->{_rw};	919	delete $self->{_rw} unless $self->{tls};
787	last;	920	last;
788	}	921	}
789	}	922	}
790		923
791	if ($self->{_eof}) {	924	if ($self->{_eof}) {
792	if ($self->{on_eof}) {	925	if ($self->{on_eof}) {
793	$self->{on_eof}($self)	926	$self->{on_eof}($self)
794	} else {	927	} else {
795	$self->_error (0, 1);	928	$self->_error (0, 1, "Unexpected end-of-file");
796	}	929	}
797	}	930	}
798		931
799	# may need to restart read watcher	932	# may need to restart read watcher
800	unless ($self->{_rw}) {	933	unless ($self->{_rw}) {
…		…
820		953
821	=item $handle->rbuf	954	=item $handle->rbuf
822		955
823	Returns the read buffer (as a modifiable lvalue).	956	Returns the read buffer (as a modifiable lvalue).
824		957
825	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	958	You can access the read buffer directly as the C<< ->{rbuf} >>
826	you want.	959	member, if you want. However, the only operation allowed on the
		960	read buffer (apart from looking at it) is removing data from its
		961	beginning. Otherwise modifying or appending to it is not allowed and will
		962	lead to hard-to-track-down bugs.
827		963
828	NOTE: The read buffer should only be used or modified if the C<on_read>,	964	NOTE: The read buffer should only be used or modified if the C<on_read>,
829	C<push_read> or C<unshift_read> methods are used. The other read methods	965	C<push_read> or C<unshift_read> methods are used. The other read methods
830	automatically manage the read buffer.	966	automatically manage the read buffer.
831		967
…		…
1031	return 1;	1167	return 1;
1032	}	1168	}
1033		1169
1034	# reject	1170	# reject
1035	if ($reject && $$rbuf =~ $reject) {	1171	if ($reject && $$rbuf =~ $reject) {
1036	$self->_error (&Errno::EBADMSG);	1172	$self->_error (Errno::EBADMSG);
1037	}	1173	}
1038		1174
1039	# skip	1175	# skip
1040	if ($skip && $$rbuf =~ $skip) {	1176	if ($skip && $$rbuf =~ $skip) {
1041	$data .= substr $$rbuf, 0, $+[0], "";	1177	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1057	my ($self, $cb) = @_;	1193	my ($self, $cb) = @_;
1058		1194
1059	sub {	1195	sub {
1060	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1196	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1061	if ($_[0]{rbuf} =~ /[^0-9]/) {	1197	if ($_[0]{rbuf} =~ /[^0-9]/) {
1062	$self->_error (&Errno::EBADMSG);	1198	$self->_error (Errno::EBADMSG);
1063	}	1199	}
1064	return;	1200	return;
1065	}	1201	}
1066		1202
1067	my $len = $1;	1203	my $len = $1;
…		…
1070	my $string = $_[1];	1206	my $string = $_[1];
1071	$_[0]->unshift_read (chunk => 1, sub {	1207	$_[0]->unshift_read (chunk => 1, sub {
1072	if ($_[1] eq ",") {	1208	if ($_[1] eq ",") {
1073	$cb->($_[0], $string);	1209	$cb->($_[0], $string);
1074	} else {	1210	} else {
1075	$self->_error (&Errno::EBADMSG);	1211	$self->_error (Errno::EBADMSG);
1076	}	1212	}
1077	});	1213	});
1078	});	1214	});
1079		1215
1080	1	1216	1
…		…
1086	An octet string prefixed with an encoded length. The encoding C<$format>	1222	An octet string prefixed with an encoded length. The encoding C<$format>
1087	uses the same format as a Perl C<pack> format, but must specify a single	1223	uses the same format as a Perl C<pack> format, but must specify a single
1088	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1224	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1089	optional C<!>, C<< < >> or C<< > >> modifier).	1225	optional C<!>, C<< < >> or C<< > >> modifier).
1090		1226
1091	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1227	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1228	EPP uses a prefix of C<N> (4 octtes).
1092		1229
1093	Example: read a block of data prefixed by its length in BER-encoded	1230	Example: read a block of data prefixed by its length in BER-encoded
1094	format (very efficient).	1231	format (very efficient).
1095		1232
1096	$handle->push_read (packstring => "w", sub {	1233	$handle->push_read (packstring => "w", sub {
…		…
1126	}	1263	}
1127	};	1264	};
1128		1265
1129	=item json => $cb->($handle, $hash_or_arrayref)	1266	=item json => $cb->($handle, $hash_or_arrayref)
1130		1267
1131	Reads a JSON object or array, decodes it and passes it to the callback.	1268	Reads a JSON object or array, decodes it and passes it to the
		1269	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1132		1270
1133	If a C<json> object was passed to the constructor, then that will be used	1271	If a C<json> object was passed to the constructor, then that will be used
1134	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1272	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1135		1273
1136	This read type uses the incremental parser available with JSON version	1274	This read type uses the incremental parser available with JSON version
…		…
1145	=cut	1283	=cut
1146		1284
1147	register_read_type json => sub {	1285	register_read_type json => sub {
1148	my ($self, $cb) = @_;	1286	my ($self, $cb) = @_;
1149		1287
1150	require JSON;	1288	my $json = $self->{json} \|\|=
		1289	eval { require JSON::XS; JSON::XS->new->utf8 }
		1290	\|\| do { require JSON; JSON->new->utf8 };
1151		1291
1152	my $data;	1292	my $data;
1153	my $rbuf = \$self->{rbuf};	1293	my $rbuf = \$self->{rbuf};
1154		1294
1155	my $json = $self->{json} \|\|= JSON->new->utf8;
1156
1157	sub {	1295	sub {
1158	my $ref = $json->incr_parse ($self->{rbuf});	1296	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1159		1297
1160	if ($ref) {	1298	if ($ref) {
1161	$self->{rbuf} = $json->incr_text;	1299	$self->{rbuf} = $json->incr_text;
1162	$json->incr_text = "";	1300	$json->incr_text = "";
1163	$cb->($self, $ref);	1301	$cb->($self, $ref);
1164		1302
1165	1	1303	1
		1304	} elsif ($@) {
		1305	# error case
		1306	$json->incr_skip;
		1307
		1308	$self->{rbuf} = $json->incr_text;
		1309	$json->incr_text = "";
		1310
		1311	$self->_error (Errno::EBADMSG);
		1312
		1313	()
1166	} else {	1314	} else {
1167	$self->{rbuf} = "";	1315	$self->{rbuf} = "";
		1316
1168	()	1317	()
1169	}	1318	}
1170	}	1319	}
1171	};	1320	};
1172		1321
…		…
1204	# read remaining chunk	1353	# read remaining chunk
1205	$_[0]->unshift_read (chunk => $len, sub {	1354	$_[0]->unshift_read (chunk => $len, sub {
1206	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1355	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1207	$cb->($_[0], $ref);	1356	$cb->($_[0], $ref);
1208	} else {	1357	} else {
1209	$self->_error (&Errno::EBADMSG);	1358	$self->_error (Errno::EBADMSG);
1210	}	1359	}
1211	});	1360	});
1212	}	1361	}
1213		1362
1214	1	1363	1
…		…
1249	Note that AnyEvent::Handle will automatically C<start_read> for you when	1398	Note that AnyEvent::Handle will automatically C<start_read> for you when
1250	you change the C<on_read> callback or push/unshift a read callback, and it	1399	you change the C<on_read> callback or push/unshift a read callback, and it
1251	will automatically C<stop_read> for you when neither C<on_read> is set nor	1400	will automatically C<stop_read> for you when neither C<on_read> is set nor
1252	there are any read requests in the queue.	1401	there are any read requests in the queue.
1253		1402
		1403	These methods will have no effect when in TLS mode (as TLS doesn't support
		1404	half-duplex connections).
		1405
1254	=cut	1406	=cut
1255		1407
1256	sub stop_read {	1408	sub stop_read {
1257	my ($self) = @_;	1409	my ($self) = @_;
1258		1410
1259	delete $self->{_rw};	1411	delete $self->{_rw} unless $self->{tls};
1260	}	1412	}
1261		1413
1262	sub start_read {	1414	sub start_read {
1263	my ($self) = @_;	1415	my ($self) = @_;
1264		1416
1265	unless ($self->{_rw} \|\| $self->{_eof}) {	1417	unless ($self->{_rw} \|\| $self->{_eof}) {
1266	Scalar::Util::weaken $self;	1418	Scalar::Util::weaken $self;
1267		1419
1268	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1420	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1269	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1421	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1270	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1422	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1271		1423
1272	if ($len > 0) {	1424	if ($len > 0) {
1273	$self->{_activity} = AnyEvent->now;	1425	$self->{_activity} = AnyEvent->now;
1274		1426
1275	$self->{filter_r}	1427	if ($self->{tls}) {
1276	? $self->{filter_r}($self, $rbuf)	1428	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1277	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1429
		1430	&_dotls ($self);
		1431	} else {
		1432	$self->_drain_rbuf unless $self->{_in_drain};
		1433	}
1278		1434
1279	} elsif (defined $len) {	1435	} elsif (defined $len) {
1280	delete $self->{_rw};	1436	delete $self->{_rw};
1281	$self->{_eof} = 1;	1437	$self->{_eof} = 1;
1282	$self->_drain_rbuf unless $self->{_in_drain};	1438	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1286	}	1442	}
1287	});	1443	});
1288	}	1444	}
1289	}	1445	}
1290		1446
		1447	our $ERROR_SYSCALL;
		1448	our $ERROR_WANT_READ;
		1449
		1450	sub _tls_error {
		1451	my ($self, $err) = @_;
		1452
		1453	return $self->_error ($!, 1)
		1454	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1455
		1456	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1457
		1458	# reduce error string to look less scary
		1459	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1460
		1461	if ($self->{_on_starttls}) {
		1462	(delete $self->{_on_starttls})->($self, undef, $err);
		1463	&_freetls;
		1464	} else {
		1465	&_freetls;
		1466	$self->_error (Errno::EPROTO, 1, $err);
		1467	}
		1468	}
		1469
		1470	# poll the write BIO and send the data if applicable
		1471	# also decode read data if possible
		1472	# this is basiclaly our TLS state machine
		1473	# more efficient implementations are possible with openssl,
		1474	# but not with the buggy and incomplete Net::SSLeay.
1291	sub _dotls {	1475	sub _dotls {
1292	my ($self) = @_;	1476	my ($self) = @_;
1293		1477
1294	my $buf;	1478	my $tmp;
1295		1479
1296	if (length $self->{_tls_wbuf}) {	1480	if (length $self->{_tls_wbuf}) {
1297	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1481	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1298	substr $self->{_tls_wbuf}, 0, $len, "";	1482	substr $self->{_tls_wbuf}, 0, $tmp, "";
1299	}	1483	}
1300	}
1301		1484
		1485	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1486	return $self->_tls_error ($tmp)
		1487	if $tmp != $ERROR_WANT_READ
		1488	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1489	}
		1490
		1491	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1492	unless (length $tmp) {
		1493	$self->{_on_starttls}
		1494	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1495	&_freetls;
		1496
		1497	if ($self->{on_stoptls}) {
		1498	$self->{on_stoptls}($self);
		1499	return;
		1500	} else {
		1501	# let's treat SSL-eof as we treat normal EOF
		1502	delete $self->{_rw};
		1503	$self->{_eof} = 1;
		1504	}
		1505	}
		1506
		1507	$self->{_tls_rbuf} .= $tmp;
		1508	$self->_drain_rbuf unless $self->{_in_drain};
		1509	$self->{tls} or return; # tls session might have gone away in callback
		1510	}
		1511
		1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1513	return $self->_tls_error ($tmp)
		1514	if $tmp != $ERROR_WANT_READ
		1515	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1516
1302	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1517	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1303	$self->{wbuf} .= $buf;	1518	$self->{wbuf} .= $tmp;
1304	$self->_drain_wbuf;	1519	$self->_drain_wbuf;
1305	}	1520	}
1306		1521
1307	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1522	$self->{_on_starttls}
1308	if (length $buf) {	1523	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1309	$self->{rbuf} .= $buf;	1524	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1310	$self->_drain_rbuf unless $self->{_in_drain};
1311	} else {
1312	# let's treat SSL-eof as we treat normal EOF
1313	$self->{_eof} = 1;
1314	$self->_shutdown;
1315	return;
1316	}
1317	}
1318
1319	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1320
1321	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1322	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1323	return $self->_error ($!, 1);
1324	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1325	return $self->_error (&Errno::EIO, 1);
1326	}
1327
1328	# all others are fine for our purposes
1329	}
1330	}	1525	}
1331		1526
1332	=item $handle->starttls ($tls[, $tls_ctx])	1527	=item $handle->starttls ($tls[, $tls_ctx])
1333		1528
1334	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1529	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1335	object is created, you can also do that at a later time by calling	1530	object is created, you can also do that at a later time by calling
1336	C<starttls>.	1531	C<starttls>.
1337		1532
		1533	Starting TLS is currently an asynchronous operation - when you push some
		1534	write data and then call C<< ->starttls >> then TLS negotiation will start
		1535	immediately, after which the queued write data is then sent.
		1536
1338	The first argument is the same as the C<tls> constructor argument (either	1537	The first argument is the same as the C<tls> constructor argument (either
1339	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1538	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1340		1539
1341	The second argument is the optional C<Net::SSLeay::CTX> object that is	1540	The second argument is the optional C<AnyEvent::TLS> object that is used
1342	used when AnyEvent::Handle has to create its own TLS connection object.	1541	when AnyEvent::Handle has to create its own TLS connection object, or
		1542	a hash reference with C<< key => value >> pairs that will be used to
		1543	construct a new context.
1343		1544
1344	The TLS connection object will end up in C<< $handle->{tls} >> after this	1545	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1345	call and can be used or changed to your liking. Note that the handshake	1546	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1346	might have already started when this function returns.	1547	changed to your liking. Note that the handshake might have already started
		1548	when this function returns.
1347		1549
		1550	If it an error to start a TLS handshake more than once per
		1551	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1552
1348	=cut	1553	=cut
		1554
		1555	our %TLS_CACHE; #TODO not yet documented, should we?
1349		1556
1350	sub starttls {	1557	sub starttls {
1351	my ($self, $ssl, $ctx) = @_;	1558	my ($self, $ssl, $ctx) = @_;
1352		1559
1353	$self->stoptls;	1560	require Net::SSLeay;
1354		1561
1355	if ($ssl eq "accept") {	1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1356	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1563	if $self->{tls};
1357	Net::SSLeay::set_accept_state ($ssl);	1564
1358	} elsif ($ssl eq "connect") {	1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1359	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1360	Net::SSLeay::set_connect_state ($ssl);	1567
		1568	$ctx \|\|= $self->{tls_ctx};
		1569
		1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1571
		1572	if ("HASH" eq ref $ctx) {
		1573	require AnyEvent::TLS;
		1574
		1575	if ($ctx->{cache}) {
		1576	my $key = $ctx+0;
		1577	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1578	} else {
		1579	$ctx = new AnyEvent::TLS %$ctx;
		1580	}
		1581	}
1361	}	1582
1362		1583	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1363	$self->{tls} = $ssl;	1584	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1364		1585
1365	# basically, this is deep magic (because SSL_read should have the same issues)	1586	# basically, this is deep magic (because SSL_read should have the same issues)
1366	# but the openssl maintainers basically said: "trust us, it just works".	1587	# but the openssl maintainers basically said: "trust us, it just works".
1367	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1588	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1368	# and mismaintained ssleay-module doesn't even offer them).	1589	# and mismaintained ssleay-module doesn't even offer them).
1369	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1590	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1591	#
		1592	# in short: this is a mess.
		1593	#
		1594	# note that we do not try to keep the length constant between writes as we are required to do.
		1595	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1596	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1597	# have identity issues in that area.
1370	Net::SSLeay::CTX_set_mode ($self->{tls},	1598	# Net::SSLeay::CTX_set_mode ($ssl,
1371	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1599	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1372	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1600	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1601	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1373		1602
1374	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1375	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1376		1605
1377	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1378		1607
1379	$self->{filter_w} = sub {	1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1380	$_[0]{_tls_wbuf} .= ${$_[1]};	1609	if $self->{on_starttls};
1381	&_dotls;	1610
1382	};	1611	&_dotls; # need to trigger the initial handshake
1383	$self->{filter_r} = sub {	1612	$self->start_read; # make sure we actually do read
1384	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1385	&_dotls;
1386	};
1387	}	1613	}
1388		1614
1389	=item $handle->stoptls	1615	=item $handle->stoptls
1390		1616
1391	Destroys the SSL connection, if any. Partial read or write data will be	1617	Shuts down the SSL connection - this makes a proper EOF handshake by
1392	lost.	1618	sending a close notify to the other side, but since OpenSSL doesn't
		1619	support non-blocking shut downs, it is not possible to re-use the stream
		1620	afterwards.
1393		1621
1394	=cut	1622	=cut
1395		1623
1396	sub stoptls {	1624	sub stoptls {
1397	my ($self) = @_;	1625	my ($self) = @_;
1398		1626
1399	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1627	if ($self->{tls}) {
		1628	Net::SSLeay::shutdown ($self->{tls});
1400		1629
1401	delete $self->{_rbio};	1630	&_dotls;
1402	delete $self->{_wbio};	1631
1403	delete $self->{_tls_wbuf};	1632	# # we don't give a shit. no, we do, but we can't. no...#d#
1404	delete $self->{filter_r};	1633	# # we, we... have to use openssl :/#d#
1405	delete $self->{filter_w};	1634	# &_freetls;#d#
		1635	}
		1636	}
		1637
		1638	sub _freetls {
		1639	my ($self) = @_;
		1640
		1641	return unless $self->{tls};
		1642
		1643	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1644
		1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1406	}	1646	}
1407		1647
1408	sub DESTROY {	1648	sub DESTROY {
1409	my $self = shift;	1649	my ($self) = @_;
1410		1650
1411	$self->stoptls;	1651	&_freetls;
1412		1652
1413	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1653	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1414		1654
1415	if ($linger && length $self->{wbuf}) {	1655	if ($linger && length $self->{wbuf} && $self->{fh}) {
1416	my $fh = delete $self->{fh};	1656	my $fh = delete $self->{fh};
1417	my $wbuf = delete $self->{wbuf};	1657	my $wbuf = delete $self->{wbuf};
1418		1658
1419	my @linger;	1659	my @linger;
1420		1660
…		…
1431	@linger = ();	1671	@linger = ();
1432	});	1672	});
1433	}	1673	}
1434	}	1674	}
1435		1675
		1676	=item $handle->destroy
		1677
		1678	Shuts down the handle object as much as possible - this call ensures that
		1679	no further callbacks will be invoked and as many resources as possible
		1680	will be freed. You must not call any methods on the object afterwards.
		1681
		1682	Normally, you can just "forget" any references to an AnyEvent::Handle
		1683	object and it will simply shut down. This works in fatal error and EOF
		1684	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1685	callback, so when you want to destroy the AnyEvent::Handle object from
		1686	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1687	that case.
		1688
		1689	Destroying the handle object in this way has the advantage that callbacks
		1690	will be removed as well, so if those are the only reference holders (as
		1691	is common), then one doesn't need to do anything special to break any
		1692	reference cycles.
		1693
		1694	The handle might still linger in the background and write out remaining
		1695	data, as specified by the C<linger> option, however.
		1696
		1697	=cut
		1698
		1699	sub destroy {
		1700	my ($self) = @_;
		1701
		1702	$self->DESTROY;
		1703	%$self = ();
		1704	}
		1705
1436	=item AnyEvent::Handle::TLS_CTX	1706	=item AnyEvent::Handle::TLS_CTX
1437		1707
1438	This function creates and returns the Net::SSLeay::CTX object used by	1708	This function creates and returns the AnyEvent::TLS object used by default
1439	default for TLS mode.	1709	for TLS mode.
1440		1710
1441	The context is created like this:	1711	The context is created by calling L<AnyEvent::TLS> without any arguments.
1442
1443	Net::SSLeay::load_error_strings;
1444	Net::SSLeay::SSLeay_add_ssl_algorithms;
1445	Net::SSLeay::randomize;
1446
1447	my $CTX = Net::SSLeay::CTX_new;
1448
1449	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1450		1712
1451	=cut	1713	=cut
1452		1714
1453	our $TLS_CTX;	1715	our $TLS_CTX;
1454		1716
1455	sub TLS_CTX() {	1717	sub TLS_CTX() {
1456	$TLS_CTX \|\| do {	1718	$TLS_CTX \|\|= do {
1457	require Net::SSLeay;	1719	require AnyEvent::TLS;
1458		1720
1459	Net::SSLeay::load_error_strings ();	1721	new AnyEvent::TLS
1460	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1461	Net::SSLeay::randomize ();
1462
1463	$TLS_CTX = Net::SSLeay::CTX_new ();
1464
1465	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1466
1467	$TLS_CTX
1468	}	1722	}
1469	}	1723	}
1470		1724
1471	=back	1725	=back
		1726
		1727
		1728	=head1 NONFREQUENTLY ASKED QUESTIONS
		1729
		1730	=over 4
		1731
		1732	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1733	still get further invocations!
		1734
		1735	That's because AnyEvent::Handle keeps a reference to itself when handling
		1736	read or write callbacks.
		1737
		1738	It is only safe to "forget" the reference inside EOF or error callbacks,
		1739	from within all other callbacks, you need to explicitly call the C<<
		1740	->destroy >> method.
		1741
		1742	=item I get different callback invocations in TLS mode/Why can't I pause
		1743	reading?
		1744
		1745	Unlike, say, TCP, TLS connections do not consist of two independent
		1746	communication channels, one for each direction. Or put differently. The
		1747	read and write directions are not independent of each other: you cannot
		1748	write data unless you are also prepared to read, and vice versa.
		1749
		1750	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1751	callback invocations when you are not expecting any read data - the reason
		1752	is that AnyEvent::Handle always reads in TLS mode.
		1753
		1754	During the connection, you have to make sure that you always have a
		1755	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1756	connection (or when you no longer want to use it) you can call the
		1757	C<destroy> method.
		1758
		1759	=item How do I read data until the other side closes the connection?
		1760
		1761	If you just want to read your data into a perl scalar, the easiest way
		1762	to achieve this is by setting an C<on_read> callback that does nothing,
		1763	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1764	will be in C<$_[0]{rbuf}>:
		1765
		1766	$handle->on_read (sub { });
		1767	$handle->on_eof (undef);
		1768	$handle->on_error (sub {
		1769	my $data = delete $_[0]{rbuf};
		1770	});
		1771
		1772	The reason to use C<on_error> is that TCP connections, due to latencies
		1773	and packets loss, might get closed quite violently with an error, when in
		1774	fact, all data has been received.
		1775
		1776	It is usually better to use acknowledgements when transferring data,
		1777	to make sure the other side hasn't just died and you got the data
		1778	intact. This is also one reason why so many internet protocols have an
		1779	explicit QUIT command.
		1780
		1781	=item I don't want to destroy the handle too early - how do I wait until
		1782	all data has been written?
		1783
		1784	After writing your last bits of data, set the C<on_drain> callback
		1785	and destroy the handle in there - with the default setting of
		1786	C<low_water_mark> this will be called precisely when all data has been
		1787	written to the socket:
		1788
		1789	$handle->push_write (...);
		1790	$handle->on_drain (sub {
		1791	warn "all data submitted to the kernel\n";
		1792	undef $handle;
		1793	});
		1794
		1795	If you just want to queue some data and then signal EOF to the other side,
		1796	consider using C<< ->push_shutdown >> instead.
		1797
		1798	=item I want to contact a TLS/SSL server, I don't care about security.
		1799
		1800	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1801	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1802	parameter:
		1803
		1804	tcp_connect $host, $port, sub {
		1805	my ($fh) = @_;
		1806
		1807	my $handle = new AnyEvent::Handle
		1808	fh => $fh,
		1809	tls => "connect",
		1810	on_error => sub { ... };
		1811
		1812	$handle->push_write (...);
		1813	};
		1814
		1815	=item I want to contact a TLS/SSL server, I do care about security.
		1816
		1817	Then you should additionally enable certificate verification, including
		1818	peername verification, if the protocol you use supports it (see
		1819	L<AnyEvent::TLS>, C<verify_peername>).
		1820
		1821	E.g. for HTTPS:
		1822
		1823	tcp_connect $host, $port, sub {
		1824	my ($fh) = @_;
		1825
		1826	my $handle = new AnyEvent::Handle
		1827	fh => $fh,
		1828	peername => $host,
		1829	tls => "connect",
		1830	tls_ctx => { verify => 1, verify_peername => "https" },
		1831	...
		1832
		1833	Note that you must specify the hostname you connected to (or whatever
		1834	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1835	peername verification will be done.
		1836
		1837	The above will use the system-dependent default set of trusted CA
		1838	certificates. If you want to check against a specific CA, add the
		1839	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1840
		1841	tls_ctx => {
		1842	verify => 1,
		1843	verify_peername => "https",
		1844	ca_file => "my-ca-cert.pem",
		1845	},
		1846
		1847	=item I want to create a TLS/SSL server, how do I do that?
		1848
		1849	Well, you first need to get a server certificate and key. You have
		1850	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1851	self-signed certificate (cheap. check the search engine of your choice,
		1852	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1853	nice program for that purpose).
		1854
		1855	Then create a file with your private key (in PEM format, see
		1856	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1857	file should then look like this:
		1858
		1859	-----BEGIN RSA PRIVATE KEY-----
		1860	...header data
		1861	... lots of base64'y-stuff
		1862	-----END RSA PRIVATE KEY-----
		1863
		1864	-----BEGIN CERTIFICATE-----
		1865	... lots of base64'y-stuff
		1866	-----END CERTIFICATE-----
		1867
		1868	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1869	specify this file as C<cert_file>:
		1870
		1871	tcp_server undef, $port, sub {
		1872	my ($fh) = @_;
		1873
		1874	my $handle = new AnyEvent::Handle
		1875	fh => $fh,
		1876	tls => "accept",
		1877	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1878	...
		1879
		1880	When you have intermediate CA certificates that your clients might not
		1881	know about, just append them to the C<cert_file>.
		1882
		1883	=back
		1884
1472		1885
1473	=head1 SUBCLASSING AnyEvent::Handle	1886	=head1 SUBCLASSING AnyEvent::Handle
1474		1887
1475	In many cases, you might want to subclass AnyEvent::Handle.	1888	In many cases, you might want to subclass AnyEvent::Handle.
1476		1889

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC vs. Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC vs.
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC