[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.142 by root, Mon Jul 6 20:24:47 2009 UTC

…		…
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.232;	19	our $VERSION = 4.452;
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");
…		…
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
66	=over 4	66	=over 4
67		67
68	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		69
70	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
75		75
…		…
84	Set the callback to be called when an end-of-file condition is detected,	84	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	86	connection cleanly.
87		87
88	For sockets, this just means that the other side has stopped sending data,	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	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	90	callback and continue writing data, as only the read part has been shut
91	down.	91	down.
92		92
93	While not mandatory, it is I<highly> recommended to set an eof callback,	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	94	otherwise you might end up with a closed socket while you are still
95	waiting for data.	95	waiting for data.
96		96
97	If an EOF condition has been detected but no C<on_eof> callback has been	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>.	98	set, then a fatal error will be raised with C<$!> set to <0>.
99		99
100	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal, $message)
101		101
102	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
103	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
104	connect or a read error.	104	connect or a read error.
105		105
106	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
107	fatal errors the handle object will be shut down and will not be usable	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	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	109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.	110	(C<EPIPE>) or I/O errors.
		111
		112	AnyEvent::Handle tries to find an appropriate error code for you to check
		113	against, but in some cases (TLS errors), this does not work well. It is
		114	recommended to always output the C<$message> argument in human-readable
		115	error messages (it's usually the same as C<"$!">).
111		116
112	Non-fatal errors can be retried by simply returning, but it is recommended	117	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	118	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	119	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		121
117	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		124	C<EPROTO>).
119		125
120	While not mandatory, it is I<highly> recommended to set this callback, as	126	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	127	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.	128	C<croak>.
123		129
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	133	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	134	callback will only be called when at least one octet of data is in the
129	read buffer).	135	read buffer).
130		136
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.	138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		139	must not enlarge or modify the read buffer, you can only remove data at
		140	the beginning from it.
133		141
134	When an EOF condition is detected then AnyEvent::Handle will first try to	142	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	143	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	144	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>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
152	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
153		161
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	162	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	163	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	164	handle, the C<on_timeout> callback will be invoked (and if that one is
157	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
158		166
159	Note that timeout processing is also active when you currently do not have	167	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	168	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	169	idle then you should disable the timout temporarily or ignore the timeout
162	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
163		172
164	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
165		174
166	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
167		176
…		…
171		180
172	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
173		182
174	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	183	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	184	when the read buffer ever (strictly) exceeds this size. This is useful to
176	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
177		186
178	For example, a server accepting connections from untrusted sources should	187	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	188	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	189	(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	190	amount of data without a callback ever being called as long as the line
182	isn't finished).	191	isn't finished).
183		192
184	=item autocork => <boolean>	193	=item autocork => <boolean>
185		194
186	When disabled (the default), then C<push_write> will try to immediately	195	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	196	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	197	a write watcher and wait for the next event loop iteration, but can
189	inefficient if you write multiple small chunks (this disadvantage is	198	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>).	199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
191		201
192	When enabled, then writes will always be queued till the next event loop	202	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,	203	iteration. This is efficient when you do many small writes per iteration,
194	but less efficient when you do a single write only.	204	but less efficient when you do a single write only per iteration (or when
		205	the write buffer often is full). It also increases write latency.
195		206
196	=item no_delay => <boolean>	207	=item no_delay => <boolean>
197		208
198	When doing small writes on sockets, your operating system kernel might	209	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	210	wait a bit for more data before actually sending it out. This is called
200	the Nagle algorithm, and usually it is beneficial.	211	the Nagle algorithm, and usually it is beneficial.
201		212
202	In some situations you want as low a delay as possible, which cna be	213	In some situations you want as low a delay as possible, which can be
203	accomplishd by setting this option to true.	214	accomplishd by setting this option to a true value.
204		215
205	The default is your opertaing system's default behaviour, this option	216	The default is your opertaing system's default behaviour (most likely
206	explicitly enables or disables it, if possible.	217	enabled), this option explicitly enables or disables it, if possible.
207		218
208	=item read_size => <bytes>	219	=item read_size => <bytes>
209		220
210	The default read block size (the amount of bytes this module will try to read	221	The default read block size (the amount of bytes this module will
211	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
212		224
213	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
214		226
215	Sets the amount of bytes (default: C<0>) that make up an "empty" write	227	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	228	buffer: If the write reaches this size or gets even samller it is
217	considered empty.	229	considered empty.
218		230
		231	Sometimes it can be beneficial (for performance reasons) to add data to
		232	the write buffer before it is fully drained, but this is a rare case, as
		233	the operating system kernel usually buffers data as well, so the default
		234	is good in almost all cases.
		235
219	=item linger => <seconds>	236	=item linger => <seconds>
220		237
221	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
222	AnyEvent::Handle object will check wether there is still outstanding write	239	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	240	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	241	socket. No errors will be reported (this mostly matches how the operating
225	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
226		243
227	This will not work for partial TLS data that could not yet been	244	This will not work for partial TLS data that could not be encoded
228	encoded. This data will be lost.	245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
		247
		248	=item peername => $string
		249
		250	A string used to identify the remote site - usually the DNS hostname
		251	(I<not> IDN!) used to create the connection, rarely the IP address.
		252
		253	Apart from being useful in error messages, this string is also used in TLS
		254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).
229		255
230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
231		257
232	When this parameter is given, it enables TLS (SSL) mode, that means it	258	When this parameter is given, it enables TLS (SSL) mode, that means
233	will start making tls handshake and will transparently encrypt/decrypt	259	AnyEvent will start a TLS handshake as soon as the conenction has been
234	data.	260	established and will transparently encrypt/decrypt data afterwards.
		261
		262	All TLS protocol errors will be signalled as C<EPROTO>, with an
		263	appropriate error message.
235		264
236	TLS mode requires Net::SSLeay to be installed (it will be loaded	265	TLS mode requires Net::SSLeay to be installed (it will be loaded
237	automatically when you try to create a TLS handle).	266	automatically when you try to create a TLS handle): this module doesn't
		267	have a dependency on that module, so if your module requires it, you have
		268	to add the dependency yourself.
238		269
239	For the TLS server side, use C<accept>, and for the TLS client side of a	270	Unlike TCP, TLS has a server and client side: for the TLS server side, use
240	connection, use C<connect> mode.	271	C<accept>, and for the TLS client side of a connection, use C<connect>
		272	mode.
241		273
242	You can also provide your own TLS connection object, but you have	274	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>	275	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	276	or C<Net::SSLeay::set_accept_state> on it before you pass it to
245	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
246		279
		280	At some future point, AnyEvent::Handle might switch to another TLS
		281	implementation, then the option to use your own session object will go
		282	away.
		283
		284	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		285	passing in the wrong integer will lead to certain crash. This most often
		286	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		287	segmentation fault.
		288
247	See the C<starttls> method if you need to start TLS negotiation later.	289	See the C<< ->starttls >> method for when need to start TLS negotiation later.
248		290
249	=item tls_ctx => $ssl_ctx	291	=item tls_ctx => $anyevent_tls
250		292
251	Use the given Net::SSLeay::CTX object to create the new TLS connection	293	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	294	(unless a connection object was specified directly). If this parameter is
253	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
254		296
		297	Instead of an object, you can also specify a hash reference with C<< key
		298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		299	new TLS context object.
		300
		301	=item on_starttls => $cb->($handle, $success)
		302
		303	This callback will be invoked when the TLS/SSL handshake has finished. If
		304	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		305	(C<on_stoptls> will not be called in this case).
		306
		307	The session in C<< $handle->{tls} >> can still be examined in this
		308	callback, even when the handshake was not successful.
		309
		310	=item on_stoptls => $cb->($handle)
		311
		312	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		313	set, then it will be invoked after freeing the TLS session. If it is not,
		314	then a TLS shutdown condition will be treated like a normal EOF condition
		315	on the handle.
		316
		317	The session in C<< $handle->{tls} >> can still be examined in this
		318	callback.
		319
		320	This callback will only be called on TLS shutdowns, not when the
		321	underlying handle signals EOF.
		322
255	=item json => JSON or JSON::XS object	323	=item json => JSON or JSON::XS object
256		324
257	This is the json coder object used by the C<json> read and write types.	325	This is the json coder object used by the C<json> read and write types.
258		326
259	If you don't supply it, then AnyEvent::Handle will create and use a	327	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.	328	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		329	texts.
261		330
262	Note that you are responsible to depend on the JSON module if you want to	331	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.	332	use this functionality, as AnyEvent does not have a dependency itself.
264		333
265	=item filter_r => $cb
266
267	=item filter_w => $cb
268
269	These exist, but are undocumented at this time.
270
271	=back	334	=back
272		335
273	=cut	336	=cut
274		337
275	sub new {	338	sub new {
276	my $class = shift;	339	my $class = shift;
277
278	my $self = bless { @_ }, $class;	340	my $self = bless { @_ }, $class;
279		341
280	$self->{fh} or Carp::croak "mandatory argument fh is missing";	342	$self->{fh} or Carp::croak "mandatory argument fh is missing";
281		343
282	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	344	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		345
289	$self->{_activity} = AnyEvent->now;	346	$self->{_activity} = AnyEvent->now;
290	$self->_timeout;	347	$self->_timeout;
291		348
		349	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		350
		351	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		352	if $self->{tls};
		353
292	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	354	$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};
294		355
295	$self->start_read	356	$self->start_read
296	if $self->{on_read};	357	if $self->{on_read};
297		358
298	$self	359	$self->{fh} && $self
299	}	360	}
300		361
301	sub _shutdown {	362	sub _shutdown {
302	my ($self) = @_;	363	my ($self) = @_;
303		364
304	delete $self->{_tw};	365	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
305	delete $self->{_rw};	366	$self->{_eof} = 1; # tell starttls et. al to stop trying
306	delete $self->{_ww};
307	delete $self->{fh};
308		367
309	$self->stoptls;	368	&_freetls;
310
311	delete $self->{on_read};
312	delete $self->{_queue};
313	}	369	}
314		370
315	sub _error {	371	sub _error {
316	my ($self, $errno, $fatal) = @_;	372	my ($self, $errno, $fatal, $message) = @_;
317		373
318	$self->_shutdown	374	$self->_shutdown
319	if $fatal;	375	if $fatal;
320		376
321	$! = $errno;	377	$! = $errno;
		378	$message \|\|= "$!";
322		379
323	if ($self->{on_error}) {	380	if ($self->{on_error}) {
324	$self->{on_error}($self, $fatal);	381	$self->{on_error}($self, $fatal, $message);
325	} else {	382	} elsif ($self->{fh}) {
326	Carp::croak "AnyEvent::Handle uncaught error: $!";	383	Carp::croak "AnyEvent::Handle uncaught error: $message";
327	}	384	}
328	}	385	}
329		386
330	=item $fh = $handle->fh	387	=item $fh = $handle->fh
331		388
332	This method returns the file handle of the L<AnyEvent::Handle> object.	389	This method returns the file handle used to create the L<AnyEvent::Handle> object.
333		390
334	=cut	391	=cut
335		392
336	sub fh { $_[0]{fh} }	393	sub fh { $_[0]{fh} }
337		394
…		…
355	$_[0]{on_eof} = $_[1];	412	$_[0]{on_eof} = $_[1];
356	}	413	}
357		414
358	=item $handle->on_timeout ($cb)	415	=item $handle->on_timeout ($cb)
359		416
360	Replace the current C<on_timeout> callback, or disables the callback	417	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	418	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
362	argument.	419	argument and method.
363		420
364	=cut	421	=cut
365		422
366	sub on_timeout {	423	sub on_timeout {
367	$_[0]{on_timeout} = $_[1];	424	$_[0]{on_timeout} = $_[1];
368	}	425	}
369		426
370	=item $handle->autocork ($boolean)	427	=item $handle->autocork ($boolean)
371		428
372	Enables or disables the current autocork behaviour (see C<autocork>	429	Enables or disables the current autocork behaviour (see C<autocork>
373	constructor argument).	430	constructor argument). Changes will only take effect on the next write.
374		431
375	=cut	432	=cut
		433
		434	sub autocork {
		435	$_[0]{autocork} = $_[1];
		436	}
376		437
377	=item $handle->no_delay ($boolean)	438	=item $handle->no_delay ($boolean)
378		439
379	Enables or disables the C<no_delay> setting (see constructor argument of	440	Enables or disables the C<no_delay> setting (see constructor argument of
380	the same name for details).	441	the same name for details).
…		…
386		447
387	eval {	448	eval {
388	local $SIG{__DIE__};	449	local $SIG{__DIE__};
389	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	450	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
390	};	451	};
		452	}
		453
		454	=item $handle->on_starttls ($cb)
		455
		456	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		457
		458	=cut
		459
		460	sub on_starttls {
		461	$_[0]{on_starttls} = $_[1];
		462	}
		463
		464	=item $handle->on_stoptls ($cb)
		465
		466	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		467
		468	=cut
		469
		470	sub on_starttls {
		471	$_[0]{on_stoptls} = $_[1];
391	}	472	}
392		473
393	#############################################################################	474	#############################################################################
394		475
395	=item $handle->timeout ($seconds)	476	=item $handle->timeout ($seconds)
…		…
473	my ($self, $cb) = @_;	554	my ($self, $cb) = @_;
474		555
475	$self->{on_drain} = $cb;	556	$self->{on_drain} = $cb;
476		557
477	$cb->($self)	558	$cb->($self)
478	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	559	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
479	}	560	}
480		561
481	=item $handle->push_write ($data)	562	=item $handle->push_write ($data)
482		563
483	Queues the given scalar to be written. You can push as much data as you	564	Queues the given scalar to be written. You can push as much data as you
…		…
500	substr $self->{wbuf}, 0, $len, "";	581	substr $self->{wbuf}, 0, $len, "";
501		582
502	$self->{_activity} = AnyEvent->now;	583	$self->{_activity} = AnyEvent->now;
503		584
504	$self->{on_drain}($self)	585	$self->{on_drain}($self)
505	if $self->{low_water_mark} >= length $self->{wbuf}	586	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
506	&& $self->{on_drain};	587	&& $self->{on_drain};
507		588
508	delete $self->{_ww} unless length $self->{wbuf};	589	delete $self->{_ww} unless length $self->{wbuf};
509	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	590	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
510	$self->_error ($!, 1);	591	$self->_error ($!, 1);
…		…
534		615
535	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	616	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
536	->($self, @_);	617	->($self, @_);
537	}	618	}
538		619
539	if ($self->{filter_w}) {	620	if ($self->{tls}) {
540	$self->{filter_w}($self, \$_[0]);	621	$self->{_tls_wbuf} .= $_[0];
		622
		623	&_dotls ($self);
541	} else {	624	} else {
542	$self->{wbuf} .= $_[0];	625	$self->{wbuf} .= $_[0];
543	$self->_drain_wbuf;	626	$self->_drain_wbuf;
544	}	627	}
545	}	628	}
…		…
562	=cut	645	=cut
563		646
564	register_write_type netstring => sub {	647	register_write_type netstring => sub {
565	my ($self, $string) = @_;	648	my ($self, $string) = @_;
566		649
567	sprintf "%d:%s,", (length $string), $string	650	(length $string) . ":$string,"
568	};	651	};
569		652
570	=item packstring => $format, $data	653	=item packstring => $format, $data
571		654
572	An octet string prefixed with an encoded length. The encoding C<$format>	655	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
637		720
638	pack "w/a*", Storable::nfreeze ($ref)	721	pack "w/a*", Storable::nfreeze ($ref)
639	};	722	};
640		723
641	=back	724	=back
		725
		726	=item $handle->push_shutdown
		727
		728	Sometimes you know you want to close the socket after writing your data
		729	before it was actually written. One way to do that is to replace your
		730	C<on_drain> handler by a callback that shuts down the socket (and set
		731	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		732	replaces the C<on_drain> callback with:
		733
		734	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		735
		736	This simply shuts down the write side and signals an EOF condition to the
		737	the peer.
		738
		739	You can rely on the normal read queue and C<on_eof> handling
		740	afterwards. This is the cleanest way to close a connection.
		741
		742	=cut
		743
		744	sub push_shutdown {
		745	my ($self) = @_;
		746
		747	delete $self->{low_water_mark};
		748	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		749	}
642		750
643	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	751	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
644		752
645	This function (not method) lets you add your own types to C<push_write>.	753	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	754	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
750	) {	858	) {
751	$self->_error (&Errno::ENOSPC, 1), return;	859	$self->_error (&Errno::ENOSPC, 1), return;
752	}	860	}
753		861
754	while () {	862	while () {
		863	# we need to use a separate tls read buffer, as we must not receive data while
		864	# we are draining the buffer, and this can only happen with TLS.
		865	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		866
755	my $len = length $self->{rbuf};	867	my $len = length $self->{rbuf};
756		868
757	if (my $cb = shift @{ $self->{_queue} }) {	869	if (my $cb = shift @{ $self->{_queue} }) {
758	unless ($cb->($self)) {	870	unless ($cb->($self)) {
759	if ($self->{_eof}) {	871	if ($self->{_eof}) {
…		…
781		893
782	last; # more data might arrive	894	last; # more data might arrive
783	}	895	}
784	} else {	896	} else {
785	# read side becomes idle	897	# read side becomes idle
786	delete $self->{_rw};	898	delete $self->{_rw} unless $self->{tls};
787	last;	899	last;
788	}	900	}
789	}	901	}
790		902
791	if ($self->{_eof}) {	903	if ($self->{_eof}) {
792	if ($self->{on_eof}) {	904	if ($self->{on_eof}) {
793	$self->{on_eof}($self)	905	$self->{on_eof}($self)
794	} else {	906	} else {
795	$self->_error (0, 1);	907	$self->_error (0, 1, "Unexpected end-of-file");
796	}	908	}
797	}	909	}
798		910
799	# may need to restart read watcher	911	# may need to restart read watcher
800	unless ($self->{_rw}) {	912	unless ($self->{_rw}) {
…		…
820		932
821	=item $handle->rbuf	933	=item $handle->rbuf
822		934
823	Returns the read buffer (as a modifiable lvalue).	935	Returns the read buffer (as a modifiable lvalue).
824		936
825	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	937	You can access the read buffer directly as the C<< ->{rbuf} >>
826	you want.	938	member, if you want. However, the only operation allowed on the
		939	read buffer (apart from looking at it) is removing data from its
		940	beginning. Otherwise modifying or appending to it is not allowed and will
		941	lead to hard-to-track-down bugs.
827		942
828	NOTE: The read buffer should only be used or modified if the C<on_read>,	943	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	944	C<push_read> or C<unshift_read> methods are used. The other read methods
830	automatically manage the read buffer.	945	automatically manage the read buffer.
831		946
…		…
1086	An octet string prefixed with an encoded length. The encoding C<$format>	1201	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	1202	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	1203	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1089	optional C<!>, C<< < >> or C<< > >> modifier).	1204	optional C<!>, C<< < >> or C<< > >> modifier).
1090		1205
1091	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1206	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1207	EPP uses a prefix of C<N> (4 octtes).
1092		1208
1093	Example: read a block of data prefixed by its length in BER-encoded	1209	Example: read a block of data prefixed by its length in BER-encoded
1094	format (very efficient).	1210	format (very efficient).
1095		1211
1096	$handle->push_read (packstring => "w", sub {	1212	$handle->push_read (packstring => "w", sub {
…		…
1126	}	1242	}
1127	};	1243	};
1128		1244
1129	=item json => $cb->($handle, $hash_or_arrayref)	1245	=item json => $cb->($handle, $hash_or_arrayref)
1130		1246
1131	Reads a JSON object or array, decodes it and passes it to the callback.	1247	Reads a JSON object or array, decodes it and passes it to the
		1248	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1132		1249
1133	If a C<json> object was passed to the constructor, then that will be used	1250	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.	1251	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1135		1252
1136	This read type uses the incremental parser available with JSON version	1253	This read type uses the incremental parser available with JSON version
…		…
1145	=cut	1262	=cut
1146		1263
1147	register_read_type json => sub {	1264	register_read_type json => sub {
1148	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
1149		1266
1150	require JSON;	1267	my $json = $self->{json} \|\|=
		1268	eval { require JSON::XS; JSON::XS->new->utf8 }
		1269	\|\| do { require JSON; JSON->new->utf8 };
1151		1270
1152	my $data;	1271	my $data;
1153	my $rbuf = \$self->{rbuf};	1272	my $rbuf = \$self->{rbuf};
1154		1273
1155	my $json = $self->{json} \|\|= JSON->new->utf8;
1156
1157	sub {	1274	sub {
1158	my $ref = $json->incr_parse ($self->{rbuf});	1275	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1159		1276
1160	if ($ref) {	1277	if ($ref) {
1161	$self->{rbuf} = $json->incr_text;	1278	$self->{rbuf} = $json->incr_text;
1162	$json->incr_text = "";	1279	$json->incr_text = "";
1163	$cb->($self, $ref);	1280	$cb->($self, $ref);
1164		1281
1165	1	1282	1
		1283	} elsif ($@) {
		1284	# error case
		1285	$json->incr_skip;
		1286
		1287	$self->{rbuf} = $json->incr_text;
		1288	$json->incr_text = "";
		1289
		1290	$self->_error (&Errno::EBADMSG);
		1291
		1292	()
1166	} else {	1293	} else {
1167	$self->{rbuf} = "";	1294	$self->{rbuf} = "";
		1295
1168	()	1296	()
1169	}	1297	}
1170	}	1298	}
1171	};	1299	};
1172		1300
…		…
1249	Note that AnyEvent::Handle will automatically C<start_read> for you when	1377	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	1378	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	1379	will automatically C<stop_read> for you when neither C<on_read> is set nor
1252	there are any read requests in the queue.	1380	there are any read requests in the queue.
1253		1381
		1382	These methods will have no effect when in TLS mode (as TLS doesn't support
		1383	half-duplex connections).
		1384
1254	=cut	1385	=cut
1255		1386
1256	sub stop_read {	1387	sub stop_read {
1257	my ($self) = @_;	1388	my ($self) = @_;
1258		1389
1259	delete $self->{_rw};	1390	delete $self->{_rw} unless $self->{tls};
1260	}	1391	}
1261		1392
1262	sub start_read {	1393	sub start_read {
1263	my ($self) = @_;	1394	my ($self) = @_;
1264		1395
1265	unless ($self->{_rw} \|\| $self->{_eof}) {	1396	unless ($self->{_rw} \|\| $self->{_eof}) {
1266	Scalar::Util::weaken $self;	1397	Scalar::Util::weaken $self;
1267		1398
1268	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1399	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1269	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1400	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1270	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1401	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1271		1402
1272	if ($len > 0) {	1403	if ($len > 0) {
1273	$self->{_activity} = AnyEvent->now;	1404	$self->{_activity} = AnyEvent->now;
1274		1405
1275	$self->{filter_r}	1406	if ($self->{tls}) {
1276	? $self->{filter_r}($self, $rbuf)	1407	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1277	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1408
		1409	&_dotls ($self);
		1410	} else {
		1411	$self->_drain_rbuf unless $self->{_in_drain};
		1412	}
1278		1413
1279	} elsif (defined $len) {	1414	} elsif (defined $len) {
1280	delete $self->{_rw};	1415	delete $self->{_rw};
1281	$self->{_eof} = 1;	1416	$self->{_eof} = 1;
1282	$self->_drain_rbuf unless $self->{_in_drain};	1417	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1286	}	1421	}
1287	});	1422	});
1288	}	1423	}
1289	}	1424	}
1290		1425
		1426	our $ERROR_SYSCALL;
		1427	our $ERROR_WANT_READ;
		1428
		1429	sub _tls_error {
		1430	my ($self, $err) = @_;
		1431
		1432	return $self->_error ($!, 1)
		1433	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1434
		1435	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1436
		1437	# reduce error string to look less scary
		1438	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1439
		1440	$self->_error (&Errno::EPROTO, 1, $err);
		1441	}
		1442
		1443	# poll the write BIO and send the data if applicable
		1444	# also decode read data if possible
		1445	# this is basiclaly our TLS state machine
		1446	# more efficient implementations are possible with openssl,
		1447	# but not with the buggy and incomplete Net::SSLeay.
1291	sub _dotls {	1448	sub _dotls {
1292	my ($self) = @_;	1449	my ($self) = @_;
1293		1450
1294	my $buf;	1451	my $tmp;
1295		1452
1296	if (length $self->{_tls_wbuf}) {	1453	if (length $self->{_tls_wbuf}) {
1297	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1454	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1298	substr $self->{_tls_wbuf}, 0, $len, "";	1455	substr $self->{_tls_wbuf}, 0, $tmp, "";
1299	}	1456	}
1300	}
1301		1457
		1458	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1459	return $self->_tls_error ($tmp)
		1460	if $tmp != $ERROR_WANT_READ
		1461	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1462	}
		1463
		1464	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1465	unless (length $tmp) {
		1466	&_freetls;
		1467	if ($self->{on_stoptls}) {
		1468	$self->{on_stoptls}($self);
		1469	return;
		1470	} else {
		1471	# let's treat SSL-eof as we treat normal EOF
		1472	delete $self->{_rw};
		1473	$self->{_eof} = 1;
		1474	}
		1475	}
		1476
		1477	$self->{_tls_rbuf} .= $tmp;
		1478	$self->_drain_rbuf unless $self->{_in_drain};
		1479	$self->{tls} or return; # tls session might have gone away in callback
		1480	}
		1481
		1482	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1483	return $self->_tls_error ($tmp)
		1484	if $tmp != $ERROR_WANT_READ
		1485	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1486
1302	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1487	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1303	$self->{wbuf} .= $buf;	1488	$self->{wbuf} .= $tmp;
1304	$self->_drain_wbuf;	1489	$self->_drain_wbuf;
1305	}	1490	}
1306		1491
1307	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1492	$self->{_on_starttls}
1308	if (length $buf) {	1493	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1309	$self->{rbuf} .= $buf;	1494	and (delete $self->{_on_starttls})->($self, 1);
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	}	1495	}
1331		1496
1332	=item $handle->starttls ($tls[, $tls_ctx])	1497	=item $handle->starttls ($tls[, $tls_ctx])
1333		1498
1334	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1499	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1336	C<starttls>.	1501	C<starttls>.
1337		1502
1338	The first argument is the same as the C<tls> constructor argument (either	1503	The first argument is the same as the C<tls> constructor argument (either
1339	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1504	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1340		1505
1341	The second argument is the optional C<Net::SSLeay::CTX> object that is	1506	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.	1507	when AnyEvent::Handle has to create its own TLS connection object, or
		1508	a hash reference with C<< key => value >> pairs that will be used to
		1509	construct a new context.
1343		1510
1344	The TLS connection object will end up in C<< $handle->{tls} >> after this	1511	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	1512	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1346	might have already started when this function returns.	1513	changed to your liking. Note that the handshake might have already started
		1514	when this function returns.
1347		1515
		1516	If it an error to start a TLS handshake more than once per
		1517	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1518
1348	=cut	1519	=cut
		1520
		1521	our %TLS_CACHE; #TODO not yet documented, should we?
1349		1522
1350	sub starttls {	1523	sub starttls {
1351	my ($self, $ssl, $ctx) = @_;	1524	my ($self, $ssl, $ctx) = @_;
1352		1525
1353	$self->stoptls;	1526	require Net::SSLeay;
1354		1527
1355	if ($ssl eq "accept") {	1528	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 ());	1529	if $self->{tls};
1357	Net::SSLeay::set_accept_state ($ssl);	1530
1358	} elsif ($ssl eq "connect") {	1531	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1359	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1532	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1360	Net::SSLeay::set_connect_state ($ssl);	1533
		1534	$ctx \|\|= $self->{tls_ctx};
		1535
		1536	if ("HASH" eq ref $ctx) {
		1537	require AnyEvent::TLS;
		1538
		1539	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1540
		1541	if ($ctx->{cache}) {
		1542	my $key = $ctx+0;
		1543	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1544	} else {
		1545	$ctx = new AnyEvent::TLS %$ctx;
		1546	}
		1547	}
1361	}	1548
1362		1549	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1363	$self->{tls} = $ssl;	1550	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1364		1551
1365	# basically, this is deep magic (because SSL_read should have the same issues)	1552	# 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".	1553	# but the openssl maintainers basically said: "trust us, it just works".
1367	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1554	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1368	# and mismaintained ssleay-module doesn't even offer them).	1555	# and mismaintained ssleay-module doesn't even offer them).
1369	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1556	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1557	#
		1558	# in short: this is a mess.
		1559	#
		1560	# note that we do not try to keep the length constant between writes as we are required to do.
		1561	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1562	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1563	# have identity issues in that area.
1370	Net::SSLeay::CTX_set_mode ($self->{tls},	1564	# Net::SSLeay::CTX_set_mode ($ssl,
1371	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1565	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1372	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1566	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1567	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1373		1568
1374	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1569	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1375	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1570	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1376		1571
1377	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1572	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1378		1573
1379	$self->{filter_w} = sub {	1574	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1380	$_[0]{_tls_wbuf} .= ${$_[1]};	1575	if exists $self->{on_starttls};
1381	&_dotls;	1576
1382	};	1577	&_dotls; # need to trigger the initial handshake
1383	$self->{filter_r} = sub {	1578	$self->start_read; # make sure we actually do read
1384	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1385	&_dotls;
1386	};
1387	}	1579	}
1388		1580
1389	=item $handle->stoptls	1581	=item $handle->stoptls
1390		1582
1391	Destroys the SSL connection, if any. Partial read or write data will be	1583	Shuts down the SSL connection - this makes a proper EOF handshake by
1392	lost.	1584	sending a close notify to the other side, but since OpenSSL doesn't
		1585	support non-blocking shut downs, it is not possible to re-use the stream
		1586	afterwards.
1393		1587
1394	=cut	1588	=cut
1395		1589
1396	sub stoptls {	1590	sub stoptls {
1397	my ($self) = @_;	1591	my ($self) = @_;
1398		1592
1399	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1593	if ($self->{tls}) {
		1594	Net::SSLeay::shutdown ($self->{tls});
1400		1595
1401	delete $self->{_rbio};	1596	&_dotls;
1402	delete $self->{_wbio};	1597
1403	delete $self->{_tls_wbuf};	1598	# # we don't give a shit. no, we do, but we can't. no...#d#
1404	delete $self->{filter_r};	1599	# # we, we... have to use openssl :/#d#
1405	delete $self->{filter_w};	1600	# &_freetls;#d#
		1601	}
		1602	}
		1603
		1604	sub _freetls {
		1605	my ($self) = @_;
		1606
		1607	return unless $self->{tls};
		1608
		1609	$self->{_on_starttls}
		1610	and (delete $self->{_on_starttls})->($self, undef);
		1611
		1612	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1613
		1614	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1406	}	1615	}
1407		1616
1408	sub DESTROY {	1617	sub DESTROY {
1409	my $self = shift;	1618	my ($self) = @_;
1410		1619
1411	$self->stoptls;	1620	&_freetls;
1412		1621
1413	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1622	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1414		1623
1415	if ($linger && length $self->{wbuf}) {	1624	if ($linger && length $self->{wbuf}) {
1416	my $fh = delete $self->{fh};	1625	my $fh = delete $self->{fh};
…		…
1431	@linger = ();	1640	@linger = ();
1432	});	1641	});
1433	}	1642	}
1434	}	1643	}
1435		1644
		1645	=item $handle->destroy
		1646
		1647	Shuts down the handle object as much as possible - this call ensures that
		1648	no further callbacks will be invoked and as many resources as possible
		1649	will be freed. You must not call any methods on the object afterwards.
		1650
		1651	Normally, you can just "forget" any references to an AnyEvent::Handle
		1652	object and it will simply shut down. This works in fatal error and EOF
		1653	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1654	callback, so when you want to destroy the AnyEvent::Handle object from
		1655	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1656	that case.
		1657
		1658	The handle might still linger in the background and write out remaining
		1659	data, as specified by the C<linger> option, however.
		1660
		1661	=cut
		1662
		1663	sub destroy {
		1664	my ($self) = @_;
		1665
		1666	$self->DESTROY;
		1667	%$self = ();
		1668	}
		1669
1436	=item AnyEvent::Handle::TLS_CTX	1670	=item AnyEvent::Handle::TLS_CTX
1437		1671
1438	This function creates and returns the Net::SSLeay::CTX object used by	1672	This function creates and returns the AnyEvent::TLS object used by default
1439	default for TLS mode.	1673	for TLS mode.
1440		1674
1441	The context is created like this:	1675	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		1676
1451	=cut	1677	=cut
1452		1678
1453	our $TLS_CTX;	1679	our $TLS_CTX;
1454		1680
1455	sub TLS_CTX() {	1681	sub TLS_CTX() {
1456	$TLS_CTX \|\| do {	1682	$TLS_CTX \|\|= do {
1457	require Net::SSLeay;	1683	require AnyEvent::TLS;
1458		1684
1459	Net::SSLeay::load_error_strings ();	1685	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	}	1686	}
1469	}	1687	}
1470		1688
1471	=back	1689	=back
		1690
		1691
		1692	=head1 NONFREQUENTLY ASKED QUESTIONS
		1693
		1694	=over 4
		1695
		1696	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1697	still get further invocations!
		1698
		1699	That's because AnyEvent::Handle keeps a reference to itself when handling
		1700	read or write callbacks.
		1701
		1702	It is only safe to "forget" the reference inside EOF or error callbacks,
		1703	from within all other callbacks, you need to explicitly call the C<<
		1704	->destroy >> method.
		1705
		1706	=item I get different callback invocations in TLS mode/Why can't I pause
		1707	reading?
		1708
		1709	Unlike, say, TCP, TLS connections do not consist of two independent
		1710	communication channels, one for each direction. Or put differently. The
		1711	read and write directions are not independent of each other: you cannot
		1712	write data unless you are also prepared to read, and vice versa.
		1713
		1714	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1715	callback invocations when you are not expecting any read data - the reason
		1716	is that AnyEvent::Handle always reads in TLS mode.
		1717
		1718	During the connection, you have to make sure that you always have a
		1719	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1720	connection (or when you no longer want to use it) you can call the
		1721	C<destroy> method.
		1722
		1723	=item How do I read data until the other side closes the connection?
		1724
		1725	If you just want to read your data into a perl scalar, the easiest way
		1726	to achieve this is by setting an C<on_read> callback that does nothing,
		1727	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1728	will be in C<$_[0]{rbuf}>:
		1729
		1730	$handle->on_read (sub { });
		1731	$handle->on_eof (undef);
		1732	$handle->on_error (sub {
		1733	my $data = delete $_[0]{rbuf};
		1734	undef $handle;
		1735	});
		1736
		1737	The reason to use C<on_error> is that TCP connections, due to latencies
		1738	and packets loss, might get closed quite violently with an error, when in
		1739	fact, all data has been received.
		1740
		1741	It is usually better to use acknowledgements when transferring data,
		1742	to make sure the other side hasn't just died and you got the data
		1743	intact. This is also one reason why so many internet protocols have an
		1744	explicit QUIT command.
		1745
		1746	=item I don't want to destroy the handle too early - how do I wait until
		1747	all data has been written?
		1748
		1749	After writing your last bits of data, set the C<on_drain> callback
		1750	and destroy the handle in there - with the default setting of
		1751	C<low_water_mark> this will be called precisely when all data has been
		1752	written to the socket:
		1753
		1754	$handle->push_write (...);
		1755	$handle->on_drain (sub {
		1756	warn "all data submitted to the kernel\n";
		1757	undef $handle;
		1758	});
		1759
		1760	=back
		1761
1472		1762
1473	=head1 SUBCLASSING AnyEvent::Handle	1763	=head1 SUBCLASSING AnyEvent::Handle
1474		1764
1475	In many cases, you might want to subclass AnyEvent::Handle.	1765	In many cases, you might want to subclass AnyEvent::Handle.
1476		1766

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.142 by root, Mon Jul 6 20:24:47 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.142 by root, Mon Jul 6 20:24:47 2009 UTC