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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC vs.
Revision 1.137 by root, Sat Jul 4 23:58:52 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");
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
60		63
61	=head1 METHODS	64	=head1 METHODS
62		65
63	=over 4	66	=over 4
64		67
65	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		69
67	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
68		71
69	=over 4	72	=over 4
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
…		…
81	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,
82	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
83	connection cleanly.	86	connection cleanly.
84		87
85	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,
86	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
87	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
88	down.	91	down.
89		92
90	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,
91	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
92	waiting for data.	95	waiting for data.
93		96
94	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
95	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>.
96		99
97	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal, $message)
98		101
99	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
100	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
101	connect or a read error.	104	connect or a read error.
102		105
103	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
104	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
105	(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
106	errors are an EOF condition with active (but unsatisifable) read watchers	109	errors are an EOF condition with active (but unsatisifable) read watchers
107	(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<"$!">).
108		116
109	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
110	to simply ignore this parameter and instead abondon the handle object	118	to simply ignore this parameter and instead abondon the handle object
111	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
112	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
113		121
114	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
115	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>).
116		125
117	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
118	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
119	C<croak>.	128	C<croak>.
120		129
…		…
124	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
125	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
126	read buffer).	135	read buffer).
127		136
128	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 >>
129	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.
130		141
131	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
132	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
133	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
134	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
149	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
150		161
151	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
152	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
153	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
154	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
155		166
156	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
157	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
158	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
159	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
160		172
161	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
162		174
163	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
164		176
…		…
168		180
169	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
170		182
171	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>)
172	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
173	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
174		186
175	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
176	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
177	(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
178	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
179	isn't finished).	191	isn't finished).
180		192
181	=item autocork => <boolean>	193	=item autocork => <boolean>
182		194
183	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
184	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
185	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
186	inefficient if you write multiple small chunks (this disadvantage is	198	be inefficient if you write multiple small chunks (on the wire, this
187	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).
188		201
189	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
190	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,
191	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.
192		206
193	=item no_delay => <boolean>	207	=item no_delay => <boolean>
194		208
195	When doing small writes on sockets, your operating system kernel might	209	When doing small writes on sockets, your operating system kernel might
196	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
197	the Nagle algorithm, and usually it is beneficial.	211	the Nagle algorithm, and usually it is beneficial.
198		212
199	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
200	accomplishd by setting this option to true.	214	accomplishd by setting this option to a true value.
201		215
202	The default is your opertaing system's default behaviour, this option	216	The default is your opertaing system's default behaviour (most likely
203	explicitly enables or disables it, if possible.	217	enabled), this option explicitly enables or disables it, if possible.
204		218
205	=item read_size => <bytes>	219	=item read_size => <bytes>
206		220
207	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
208	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
209		224
210	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
211		226
212	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
213	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
214	considered empty.	229	considered empty.
215		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
216	=item linger => <seconds>	236	=item linger => <seconds>
217		237
218	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
219	AnyEvent::Handle object will check wether there is still outstanding write	239	AnyEvent::Handle object will check whether there is still outstanding
220	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
221	will be reported (this mostly matches how the operating system treats	241	socket. No errors will be reported (this mostly matches how the operating
222	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
223		243
224	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
225	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	common name verification (see C<verify_cn> in L<AnyEvent::TLS>).
226		255
227	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
228		257
229	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
230	will start making tls handshake and will transparently encrypt/decrypt	259	AnyEvent will start a TLS handshake as soon as the conenction has been
231	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.
232		264
233	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
234	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.
235		269
236	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
237	connection, use C<connect> mode.	271	C<accept>, and for the TLS client side of a connection, use C<connect>
		272	mode.
238		273
239	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
240	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>
241	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
242	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
243		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
244	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.
245		290
246	=item tls_ctx => $ssl_ctx	291	=item tls_ctx => $anyevent_tls
247		292
248	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
249	(unless a connection object was specified directly). If this parameter is	294	(unless a connection object was specified directly). If this parameter is
250	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
251		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
252	=item json => JSON or JSON::XS object	301	=item json => JSON or JSON::XS object
253		302
254	This is the json coder object used by the C<json> read and write types.	303	This is the json coder object used by the C<json> read and write types.
255		304
256	If you don't supply it, then AnyEvent::Handle will create and use a	305	If you don't supply it, then AnyEvent::Handle will create and use a
257	suitable one, which will write and expect UTF-8 encoded JSON texts.	306	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		307	texts.
258		308
259	Note that you are responsible to depend on the JSON module if you want to	309	Note that you are responsible to depend on the JSON module if you want to
260	use this functionality, as AnyEvent does not have a dependency itself.	310	use this functionality, as AnyEvent does not have a dependency itself.
261		311
262	=item filter_r => $cb
263
264	=item filter_w => $cb
265
266	These exist, but are undocumented at this time.
267
268	=back	312	=back
269		313
270	=cut	314	=cut
271		315
272	sub new {	316	sub new {
273	my $class = shift;	317	my $class = shift;
274
275	my $self = bless { @_ }, $class;	318	my $self = bless { @_ }, $class;
276		319
277	$self->{fh} or Carp::croak "mandatory argument fh is missing";	320	$self->{fh} or Carp::croak "mandatory argument fh is missing";
278		321
279	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
280
281	if ($self->{tls}) {
282	require Net::SSLeay;
283	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
284	}
285		323
286	$self->{_activity} = AnyEvent->now;	324	$self->{_activity} = AnyEvent->now;
287	$self->_timeout;	325	$self->_timeout;
288		326
		327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		328
		329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		330	if $self->{tls};
		331
289	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
290	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
291		333
292	$self->start_read	334	$self->start_read
293	if $self->{on_read};	335	if $self->{on_read};
294		336
295	$self	337	$self->{fh} && $self
296	}	338	}
297		339
298	sub _shutdown {	340	sub _shutdown {
299	my ($self) = @_;	341	my ($self) = @_;
300		342
301	delete $self->{_tw};	343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
302	delete $self->{_rw};	344	$self->{_eof} = 1; # tell starttls et. al to stop trying
303	delete $self->{_ww};
304	delete $self->{fh};
305		345
306	$self->stoptls;	346	&_freetls;
307
308	delete $self->{on_read};
309	delete $self->{_queue};
310	}	347	}
311		348
312	sub _error {	349	sub _error {
313	my ($self, $errno, $fatal) = @_;	350	my ($self, $errno, $fatal, $message) = @_;
314		351
315	$self->_shutdown	352	$self->_shutdown
316	if $fatal;	353	if $fatal;
317		354
318	$! = $errno;	355	$! = $errno;
		356	$message \|\|= "$!";
319		357
320	if ($self->{on_error}) {	358	if ($self->{on_error}) {
321	$self->{on_error}($self, $fatal);	359	$self->{on_error}($self, $fatal, $message);
322	} else {	360	} elsif ($self->{fh}) {
323	Carp::croak "AnyEvent::Handle uncaught error: $!";	361	Carp::croak "AnyEvent::Handle uncaught error: $message";
324	}	362	}
325	}	363	}
326		364
327	=item $fh = $handle->fh	365	=item $fh = $handle->fh
328		366
329	This method returns the file handle of the L<AnyEvent::Handle> object.	367	This method returns the file handle used to create the L<AnyEvent::Handle> object.
330		368
331	=cut	369	=cut
332		370
333	sub fh { $_[0]{fh} }	371	sub fh { $_[0]{fh} }
334		372
…		…
352	$_[0]{on_eof} = $_[1];	390	$_[0]{on_eof} = $_[1];
353	}	391	}
354		392
355	=item $handle->on_timeout ($cb)	393	=item $handle->on_timeout ($cb)
356		394
357	Replace the current C<on_timeout> callback, or disables the callback	395	Replace the current C<on_timeout> callback, or disables the callback (but
358	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	396	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
359	argument.	397	argument and method.
360		398
361	=cut	399	=cut
362		400
363	sub on_timeout {	401	sub on_timeout {
364	$_[0]{on_timeout} = $_[1];	402	$_[0]{on_timeout} = $_[1];
365	}	403	}
366		404
367	=item $handle->autocork ($boolean)	405	=item $handle->autocork ($boolean)
368		406
369	Enables or disables the current autocork behaviour (see C<autocork>	407	Enables or disables the current autocork behaviour (see C<autocork>
370	constructor argument).	408	constructor argument). Changes will only take effect on the next write.
371		409
372	=cut	410	=cut
		411
		412	sub autocork {
		413	$_[0]{autocork} = $_[1];
		414	}
373		415
374	=item $handle->no_delay ($boolean)	416	=item $handle->no_delay ($boolean)
375		417
376	Enables or disables the C<no_delay> setting (see constructor argument of	418	Enables or disables the C<no_delay> setting (see constructor argument of
377	the same name for details).	419	the same name for details).
…		…
470	my ($self, $cb) = @_;	512	my ($self, $cb) = @_;
471		513
472	$self->{on_drain} = $cb;	514	$self->{on_drain} = $cb;
473		515
474	$cb->($self)	516	$cb->($self)
475	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	517	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
476	}	518	}
477		519
478	=item $handle->push_write ($data)	520	=item $handle->push_write ($data)
479		521
480	Queues the given scalar to be written. You can push as much data as you	522	Queues the given scalar to be written. You can push as much data as you
…		…
497	substr $self->{wbuf}, 0, $len, "";	539	substr $self->{wbuf}, 0, $len, "";
498		540
499	$self->{_activity} = AnyEvent->now;	541	$self->{_activity} = AnyEvent->now;
500		542
501	$self->{on_drain}($self)	543	$self->{on_drain}($self)
502	if $self->{low_water_mark} >= length $self->{wbuf}	544	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
503	&& $self->{on_drain};	545	&& $self->{on_drain};
504		546
505	delete $self->{_ww} unless length $self->{wbuf};	547	delete $self->{_ww} unless length $self->{wbuf};
506	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
507	$self->_error ($!, 1);	549	$self->_error ($!, 1);
…		…
531		573
532	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	574	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
533	->($self, @_);	575	->($self, @_);
534	}	576	}
535		577
536	if ($self->{filter_w}) {	578	if ($self->{tls}) {
537	$self->{filter_w}($self, \$_[0]);	579	$self->{_tls_wbuf} .= $_[0];
		580
		581	&_dotls ($self);
538	} else {	582	} else {
539	$self->{wbuf} .= $_[0];	583	$self->{wbuf} .= $_[0];
540	$self->_drain_wbuf;	584	$self->_drain_wbuf;
541	}	585	}
542	}	586	}
…		…
559	=cut	603	=cut
560		604
561	register_write_type netstring => sub {	605	register_write_type netstring => sub {
562	my ($self, $string) = @_;	606	my ($self, $string) = @_;
563		607
564	sprintf "%d:%s,", (length $string), $string	608	(length $string) . ":$string,"
565	};	609	};
566		610
567	=item packstring => $format, $data	611	=item packstring => $format, $data
568		612
569	An octet string prefixed with an encoded length. The encoding C<$format>	613	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
634		678
635	pack "w/a*", Storable::nfreeze ($ref)	679	pack "w/a*", Storable::nfreeze ($ref)
636	};	680	};
637		681
638	=back	682	=back
		683
		684	=item $handle->push_shutdown
		685
		686	Sometimes you know you want to close the socket after writing your data
		687	before it was actually written. One way to do that is to replace your
		688	C<on_drain> handler by a callback that shuts down the socket. This method
		689	is a shorthand for just that, and replaces the C<on_drain> callback with:
		690
		691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		692
		693	This simply shuts down the write side and signals an EOF condition to the
		694	the peer.
		695
		696	You can rely on the normal read queue and C<on_eof> handling
		697	afterwards. This is the cleanest way to close a connection.
		698
		699	=cut
		700
		701	sub push_shutdown {
		702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };
		703	}
639		704
640	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
641		706
642	This function (not method) lets you add your own types to C<push_write>.	707	This function (not method) lets you add your own types to C<push_write>.
643	Whenever the given C<type> is used, C<push_write> will invoke the code	708	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
747	) {	812	) {
748	$self->_error (&Errno::ENOSPC, 1), return;	813	$self->_error (&Errno::ENOSPC, 1), return;
749	}	814	}
750		815
751	while () {	816	while () {
		817	# we need to use a separate tls read buffer, as we must not receive data while
		818	# we are draining the buffer, and this can only happen with TLS.
		819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		820
752	my $len = length $self->{rbuf};	821	my $len = length $self->{rbuf};
753		822
754	if (my $cb = shift @{ $self->{_queue} }) {	823	if (my $cb = shift @{ $self->{_queue} }) {
755	unless ($cb->($self)) {	824	unless ($cb->($self)) {
756	if ($self->{_eof}) {	825	if ($self->{_eof}) {
…		…
778		847
779	last; # more data might arrive	848	last; # more data might arrive
780	}	849	}
781	} else {	850	} else {
782	# read side becomes idle	851	# read side becomes idle
783	delete $self->{_rw};	852	delete $self->{_rw} unless $self->{tls};
784	last;	853	last;
785	}	854	}
786	}	855	}
787		856
788	if ($self->{_eof}) {	857	if ($self->{_eof}) {
…		…
817		886
818	=item $handle->rbuf	887	=item $handle->rbuf
819		888
820	Returns the read buffer (as a modifiable lvalue).	889	Returns the read buffer (as a modifiable lvalue).
821		890
822	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	891	You can access the read buffer directly as the C<< ->{rbuf} >>
823	you want.	892	member, if you want. However, the only operation allowed on the
		893	read buffer (apart from looking at it) is removing data from its
		894	beginning. Otherwise modifying or appending to it is not allowed and will
		895	lead to hard-to-track-down bugs.
824		896
825	NOTE: The read buffer should only be used or modified if the C<on_read>,	897	NOTE: The read buffer should only be used or modified if the C<on_read>,
826	C<push_read> or C<unshift_read> methods are used. The other read methods	898	C<push_read> or C<unshift_read> methods are used. The other read methods
827	automatically manage the read buffer.	899	automatically manage the read buffer.
828		900
…		…
1083	An octet string prefixed with an encoded length. The encoding C<$format>	1155	An octet string prefixed with an encoded length. The encoding C<$format>
1084	uses the same format as a Perl C<pack> format, but must specify a single	1156	uses the same format as a Perl C<pack> format, but must specify a single
1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1157	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1086	optional C<!>, C<< < >> or C<< > >> modifier).	1158	optional C<!>, C<< < >> or C<< > >> modifier).
1087		1159
1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1160	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1161	EPP uses a prefix of C<N> (4 octtes).
1089		1162
1090	Example: read a block of data prefixed by its length in BER-encoded	1163	Example: read a block of data prefixed by its length in BER-encoded
1091	format (very efficient).	1164	format (very efficient).
1092		1165
1093	$handle->push_read (packstring => "w", sub {	1166	$handle->push_read (packstring => "w", sub {
…		…
1123	}	1196	}
1124	};	1197	};
1125		1198
1126	=item json => $cb->($handle, $hash_or_arrayref)	1199	=item json => $cb->($handle, $hash_or_arrayref)
1127		1200
1128	Reads a JSON object or array, decodes it and passes it to the callback.	1201	Reads a JSON object or array, decodes it and passes it to the
		1202	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1129		1203
1130	If a C<json> object was passed to the constructor, then that will be used	1204	If a C<json> object was passed to the constructor, then that will be used
1131	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1205	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1132		1206
1133	This read type uses the incremental parser available with JSON version	1207	This read type uses the incremental parser available with JSON version
…		…
1142	=cut	1216	=cut
1143		1217
1144	register_read_type json => sub {	1218	register_read_type json => sub {
1145	my ($self, $cb) = @_;	1219	my ($self, $cb) = @_;
1146		1220
1147	require JSON;	1221	my $json = $self->{json} \|\|=
		1222	eval { require JSON::XS; JSON::XS->new->utf8 }
		1223	\|\| do { require JSON; JSON->new->utf8 };
1148		1224
1149	my $data;	1225	my $data;
1150	my $rbuf = \$self->{rbuf};	1226	my $rbuf = \$self->{rbuf};
1151		1227
1152	my $json = $self->{json} \|\|= JSON->new->utf8;
1153
1154	sub {	1228	sub {
1155	my $ref = $json->incr_parse ($self->{rbuf});	1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1156		1230
1157	if ($ref) {	1231	if ($ref) {
1158	$self->{rbuf} = $json->incr_text;	1232	$self->{rbuf} = $json->incr_text;
1159	$json->incr_text = "";	1233	$json->incr_text = "";
1160	$cb->($self, $ref);	1234	$cb->($self, $ref);
1161		1235
1162	1	1236	1
		1237	} elsif ($@) {
		1238	# error case
		1239	$json->incr_skip;
		1240
		1241	$self->{rbuf} = $json->incr_text;
		1242	$json->incr_text = "";
		1243
		1244	$self->_error (&Errno::EBADMSG);
		1245
		1246	()
1163	} else {	1247	} else {
1164	$self->{rbuf} = "";	1248	$self->{rbuf} = "";
		1249
1165	()	1250	()
1166	}	1251	}
1167	}	1252	}
1168	};	1253	};
1169		1254
…		…
1246	Note that AnyEvent::Handle will automatically C<start_read> for you when	1331	Note that AnyEvent::Handle will automatically C<start_read> for you when
1247	you change the C<on_read> callback or push/unshift a read callback, and it	1332	you change the C<on_read> callback or push/unshift a read callback, and it
1248	will automatically C<stop_read> for you when neither C<on_read> is set nor	1333	will automatically C<stop_read> for you when neither C<on_read> is set nor
1249	there are any read requests in the queue.	1334	there are any read requests in the queue.
1250		1335
		1336	These methods will have no effect when in TLS mode (as TLS doesn't support
		1337	half-duplex connections).
		1338
1251	=cut	1339	=cut
1252		1340
1253	sub stop_read {	1341	sub stop_read {
1254	my ($self) = @_;	1342	my ($self) = @_;
1255		1343
1256	delete $self->{_rw};	1344	delete $self->{_rw} unless $self->{tls};
1257	}	1345	}
1258		1346
1259	sub start_read {	1347	sub start_read {
1260	my ($self) = @_;	1348	my ($self) = @_;
1261		1349
1262	unless ($self->{_rw} \|\| $self->{_eof}) {	1350	unless ($self->{_rw} \|\| $self->{_eof}) {
1263	Scalar::Util::weaken $self;	1351	Scalar::Util::weaken $self;
1264		1352
1265	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1266	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1267	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1355	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1268		1356
1269	if ($len > 0) {	1357	if ($len > 0) {
1270	$self->{_activity} = AnyEvent->now;	1358	$self->{_activity} = AnyEvent->now;
1271		1359
1272	$self->{filter_r}	1360	if ($self->{tls}) {
1273	? $self->{filter_r}($self, $rbuf)	1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1274	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1362
		1363	&_dotls ($self);
		1364	} else {
		1365	$self->_drain_rbuf unless $self->{_in_drain};
		1366	}
1275		1367
1276	} elsif (defined $len) {	1368	} elsif (defined $len) {
1277	delete $self->{_rw};	1369	delete $self->{_rw};
1278	$self->{_eof} = 1;	1370	$self->{_eof} = 1;
1279	$self->_drain_rbuf unless $self->{_in_drain};	1371	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1283	}	1375	}
1284	});	1376	});
1285	}	1377	}
1286	}	1378	}
1287		1379
		1380	our $ERROR_SYSCALL;
		1381	our $ERROR_WANT_READ;
		1382	our $ERROR_ZERO_RETURN;
		1383
		1384	sub _tls_error {
		1385	my ($self, $err) = @_;
		1386
		1387	return $self->_error ($!, 1)
		1388	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1389
		1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1391
		1392	# reduce error string to look less scary
		1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1394
		1395	$self->_error (&Errno::EPROTO, 1, $err);
		1396	}
		1397
		1398	# poll the write BIO and send the data if applicable
		1399	# also decode read data if possible
		1400	# this is basiclaly our TLS state machine
		1401	# more efficient implementations are possible with openssl,
		1402	# but not with the buggy and incomplete Net::SSLeay.
1288	sub _dotls {	1403	sub _dotls {
1289	my ($self) = @_;	1404	my ($self) = @_;
1290		1405
1291	my $buf;	1406	my $tmp;
1292		1407
1293	if (length $self->{_tls_wbuf}) {	1408	if (length $self->{_tls_wbuf}) {
1294	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1409	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1295	substr $self->{_tls_wbuf}, 0, $len, "";	1410	substr $self->{_tls_wbuf}, 0, $tmp, "";
1296	}	1411	}
1297	}
1298		1412
		1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1414	return $self->_tls_error ($tmp)
		1415	if $tmp != $ERROR_WANT_READ
		1416	&& ($tmp != $ERROR_SYSCALL \|\| $!)
		1417	&& $tmp != $ERROR_ZERO_RETURN;
		1418	}
		1419
		1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1421	unless (length $tmp) {
		1422	# let's treat SSL-eof as we treat normal EOF
		1423	delete $self->{_rw};
		1424	$self->{_eof} = 1;
		1425	&_freetls;
		1426	}
		1427
		1428	$self->{_tls_rbuf} .= $tmp;
		1429	$self->_drain_rbuf unless $self->{_in_drain};
		1430	$self->{tls} or return; # tls session might have gone away in callback
		1431	}
		1432
		1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1434	return $self->_tls_error ($tmp)
		1435	if $tmp != $ERROR_WANT_READ
		1436	&& ($tmp != $ERROR_SYSCALL \|\| $!)
		1437	&& $tmp != $ERROR_ZERO_RETURN;
		1438
1299	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1300	$self->{wbuf} .= $buf;	1440	$self->{wbuf} .= $tmp;
1301	$self->_drain_wbuf;	1441	$self->_drain_wbuf;
1302	}
1303
1304	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1305	if (length $buf) {
1306	$self->{rbuf} .= $buf;
1307	$self->_drain_rbuf unless $self->{_in_drain};
1308	} else {
1309	# let's treat SSL-eof as we treat normal EOF
1310	$self->{_eof} = 1;
1311	$self->_shutdown;
1312	return;
1313	}
1314	}
1315
1316	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1317
1318	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1319	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1320	return $self->_error ($!, 1);
1321	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1322	return $self->_error (&Errno::EIO, 1);
1323	}
1324
1325	# all others are fine for our purposes
1326	}	1442	}
1327	}	1443	}
1328		1444
1329	=item $handle->starttls ($tls[, $tls_ctx])	1445	=item $handle->starttls ($tls[, $tls_ctx])
1330		1446
…		…
1333	C<starttls>.	1449	C<starttls>.
1334		1450
1335	The first argument is the same as the C<tls> constructor argument (either	1451	The first argument is the same as the C<tls> constructor argument (either
1336	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1337		1453
1338	The second argument is the optional C<Net::SSLeay::CTX> object that is	1454	The second argument is the optional C<AnyEvent::TLS> object that is used
1339	used when AnyEvent::Handle has to create its own TLS connection object.	1455	when AnyEvent::Handle has to create its own TLS connection object, or
		1456	a hash reference with C<< key => value >> pairs that will be used to
		1457	construct a new context.
1340		1458
1341	The TLS connection object will end up in C<< $handle->{tls} >> after this	1459	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1342	call and can be used or changed to your liking. Note that the handshake	1460	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1343	might have already started when this function returns.	1461	changed to your liking. Note that the handshake might have already started
		1462	when this function returns.
1344		1463
		1464	If it an error to start a TLS handshake more than once per
		1465	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1466
1345	=cut	1467	=cut
		1468
		1469	our %TLS_CACHE; #TODO not yet documented, should we?
1346		1470
1347	sub starttls {	1471	sub starttls {
1348	my ($self, $ssl, $ctx) = @_;	1472	my ($self, $ssl, $ctx) = @_;
1349		1473
1350	$self->stoptls;	1474	require Net::SSLeay;
1351		1475
1352	if ($ssl eq "accept") {	1476	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1353	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1477	if $self->{tls};
1354	Net::SSLeay::set_accept_state ($ssl);	1478
1355	} elsif ($ssl eq "connect") {	1479	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1356	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1357	Net::SSLeay::set_connect_state ($ssl);	1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
		1482
		1483	$ctx \|\|= $self->{tls_ctx};
		1484
		1485	if ("HASH" eq ref $ctx) {
		1486	require AnyEvent::TLS;
		1487
		1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1489
		1490	if ($ctx->{cache}) {
		1491	my $key = $ctx+0;
		1492	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1493	} else {
		1494	$ctx = new AnyEvent::TLS %$ctx;
		1495	}
		1496	}
1358	}	1497
1359		1498	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1360	$self->{tls} = $ssl;	1499	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1361		1500
1362	# basically, this is deep magic (because SSL_read should have the same issues)	1501	# basically, this is deep magic (because SSL_read should have the same issues)
1363	# but the openssl maintainers basically said: "trust us, it just works".	1502	# but the openssl maintainers basically said: "trust us, it just works".
1364	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1503	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1365	# and mismaintained ssleay-module doesn't even offer them).	1504	# and mismaintained ssleay-module doesn't even offer them).
1366	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1505	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1506	#
		1507	# in short: this is a mess.
		1508	#
		1509	# note that we do not try to keep the length constant between writes as we are required to do.
		1510	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1511	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1512	# have identity issues in that area.
1367	Net::SSLeay::CTX_set_mode ($self->{tls},	1513	# Net::SSLeay::CTX_set_mode ($ssl,
1368	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1514	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1369	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1515	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1516	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1370		1517
1371	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1372	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1373		1520
1374	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1375		1522
1376	$self->{filter_w} = sub {	1523	&_dotls; # need to trigger the initial handshake
1377	$_[0]{_tls_wbuf} .= ${$_[1]};	1524	$self->start_read; # make sure we actually do read
1378	&_dotls;
1379	};
1380	$self->{filter_r} = sub {
1381	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1382	&_dotls;
1383	};
1384	}	1525	}
1385		1526
1386	=item $handle->stoptls	1527	=item $handle->stoptls
1387		1528
1388	Destroys the SSL connection, if any. Partial read or write data will be	1529	Shuts down the SSL connection - this makes a proper EOF handshake by
1389	lost.	1530	sending a close notify to the other side, but since OpenSSL doesn't
		1531	support non-blocking shut downs, it is not possible to re-use the stream
		1532	afterwards.
1390		1533
1391	=cut	1534	=cut
1392		1535
1393	sub stoptls {	1536	sub stoptls {
1394	my ($self) = @_;	1537	my ($self) = @_;
1395		1538
1396	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1539	if ($self->{tls}) {
		1540	Net::SSLeay::shutdown ($self->{tls});
1397		1541
1398	delete $self->{_rbio};	1542	&_dotls;
1399	delete $self->{_wbio};	1543
1400	delete $self->{_tls_wbuf};	1544	# we don't give a shit. no, we do, but we can't. no...
1401	delete $self->{filter_r};	1545	# we, we... have to use openssl :/
1402	delete $self->{filter_w};	1546	&_freetls;
		1547	}
		1548	}
		1549
		1550	sub _freetls {
		1551	my ($self) = @_;
		1552
		1553	return unless $self->{tls};
		1554
		1555	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1556
		1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1403	}	1558	}
1404		1559
1405	sub DESTROY {	1560	sub DESTROY {
1406	my $self = shift;	1561	my ($self) = @_;
1407		1562
1408	$self->stoptls;	1563	&_freetls;
1409		1564
1410	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1411		1566
1412	if ($linger && length $self->{wbuf}) {	1567	if ($linger && length $self->{wbuf}) {
1413	my $fh = delete $self->{fh};	1568	my $fh = delete $self->{fh};
…		…
1428	@linger = ();	1583	@linger = ();
1429	});	1584	});
1430	}	1585	}
1431	}	1586	}
1432		1587
		1588	=item $handle->destroy
		1589
		1590	Shuts down the handle object as much as possible - this call ensures that
		1591	no further callbacks will be invoked and resources will be freed as much
		1592	as possible. You must not call any methods on the object afterwards.
		1593
		1594	Normally, you can just "forget" any references to an AnyEvent::Handle
		1595	object and it will simply shut down. This works in fatal error and EOF
		1596	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1597	callback, so when you want to destroy the AnyEvent::Handle object from
		1598	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1599	that case.
		1600
		1601	The handle might still linger in the background and write out remaining
		1602	data, as specified by the C<linger> option, however.
		1603
		1604	=cut
		1605
		1606	sub destroy {
		1607	my ($self) = @_;
		1608
		1609	$self->DESTROY;
		1610	%$self = ();
		1611	}
		1612
1433	=item AnyEvent::Handle::TLS_CTX	1613	=item AnyEvent::Handle::TLS_CTX
1434		1614
1435	This function creates and returns the Net::SSLeay::CTX object used by	1615	This function creates and returns the AnyEvent::TLS object used by default
1436	default for TLS mode.	1616	for TLS mode.
1437		1617
1438	The context is created like this:	1618	The context is created by calling L<AnyEvent::TLS> without any arguments.
1439
1440	Net::SSLeay::load_error_strings;
1441	Net::SSLeay::SSLeay_add_ssl_algorithms;
1442	Net::SSLeay::randomize;
1443
1444	my $CTX = Net::SSLeay::CTX_new;
1445
1446	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1447		1619
1448	=cut	1620	=cut
1449		1621
1450	our $TLS_CTX;	1622	our $TLS_CTX;
1451		1623
1452	sub TLS_CTX() {	1624	sub TLS_CTX() {
1453	$TLS_CTX \|\| do {	1625	$TLS_CTX \|\|= do {
1454	require Net::SSLeay;	1626	require AnyEvent::TLS;
1455		1627
1456	Net::SSLeay::load_error_strings ();	1628	new AnyEvent::TLS
1457	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1458	Net::SSLeay::randomize ();
1459
1460	$TLS_CTX = Net::SSLeay::CTX_new ();
1461
1462	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1463
1464	$TLS_CTX
1465	}	1629	}
1466	}	1630	}
1467		1631
1468	=back	1632	=back
		1633
		1634
		1635	=head1 NONFREQUENTLY ASKED QUESTIONS
		1636
		1637	=over 4
		1638
		1639	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1640	still get further invocations!
		1641
		1642	That's because AnyEvent::Handle keeps a reference to itself when handling
		1643	read or write callbacks.
		1644
		1645	It is only safe to "forget" the reference inside EOF or error callbacks,
		1646	from within all other callbacks, you need to explicitly call the C<<
		1647	->destroy >> method.
		1648
		1649	=item I get different callback invocations in TLS mode/Why can't I pause
		1650	reading?
		1651
		1652	Unlike, say, TCP, TLS connections do not consist of two independent
		1653	communication channels, one for each direction. Or put differently. The
		1654	read and write directions are not independent of each other: you cannot
		1655	write data unless you are also prepared to read, and vice versa.
		1656
		1657	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1658	callback invocations when you are not expecting any read data - the reason
		1659	is that AnyEvent::Handle always reads in TLS mode.
		1660
		1661	During the connection, you have to make sure that you always have a
		1662	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1663	connection (or when you no longer want to use it) you can call the
		1664	C<destroy> method.
		1665
		1666	=item How do I read data until the other side closes the connection?
		1667
		1668	If you just want to read your data into a perl scalar, the easiest way
		1669	to achieve this is by setting an C<on_read> callback that does nothing,
		1670	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1671	will be in C<$_[0]{rbuf}>:
		1672
		1673	$handle->on_read (sub { });
		1674	$handle->on_eof (undef);
		1675	$handle->on_error (sub {
		1676	my $data = delete $_[0]{rbuf};
		1677	undef $handle;
		1678	});
		1679
		1680	The reason to use C<on_error> is that TCP connections, due to latencies
		1681	and packets loss, might get closed quite violently with an error, when in
		1682	fact, all data has been received.
		1683
		1684	It is usually better to use acknowledgements when transferring data,
		1685	to make sure the other side hasn't just died and you got the data
		1686	intact. This is also one reason why so many internet protocols have an
		1687	explicit QUIT command.
		1688
		1689	=item I don't want to destroy the handle too early - how do I wait until
		1690	all data has been written?
		1691
		1692	After writing your last bits of data, set the C<on_drain> callback
		1693	and destroy the handle in there - with the default setting of
		1694	C<low_water_mark> this will be called precisely when all data has been
		1695	written to the socket:
		1696
		1697	$handle->push_write (...);
		1698	$handle->on_drain (sub {
		1699	warn "all data submitted to the kernel\n";
		1700	undef $handle;
		1701	});
		1702
		1703	=back
		1704
1469		1705
1470	=head1 SUBCLASSING AnyEvent::Handle	1706	=head1 SUBCLASSING AnyEvent::Handle
1471		1707
1472	In many cases, you might want to subclass AnyEvent::Handle.	1708	In many cases, you might want to subclass AnyEvent::Handle.
1473		1709

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC vs. Revision 1.137 by root, Sat Jul 4 23:58:52 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC vs.
Revision 1.137 by root, Sat Jul 4 23:58:52 2009 UTC