ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs.
Revision 1.142 by root, Mon Jul 6 20:24:47 2009 UTC

1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
…		…
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	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
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called on EOF.	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
		86	connection cleanly.
81		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the EOF
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
82	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
83	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
84	waiting for data.	95	waiting for data.
85		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
		99
86	=item on_error => $cb->($handle)	100	=item on_error => $cb->($handle, $fatal, $message)
87		101
88	This is the fatal error callback, that is called when, well, a fatal error	102	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	103	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	104	connect or a read error.
91		105
92	The object will not be in a usable state when this callback has been	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
		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<"$!">).
		116
		117	Non-fatal errors can be retried by simply returning, but it is recommended
		118	to simply ignore this parameter and instead abondon the handle object
		119	when this callback is invoked. Examples of non-fatal errors are timeouts
		120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		121
95	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
97		124	C<EPROTO>).
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		125
101	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
102	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
103	die.	128	C<croak>.
104		129
105	=item on_read => $cb->($handle)	130	=item on_read => $cb->($handle)
106		131
107	This sets the default read callback, which is called when data arrives	132	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	133	and no read request is in the queue (unlike read queue callbacks, this
		134	callback will only be called when at least one octet of data is in the
		135	read buffer).
109		136
110	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 >>
111	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.
112		141
113	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
114	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
115	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
116	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
120	This sets the callback that is called when the write buffer becomes empty	149	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	150	(or when the callback is set and the buffer is empty already).
122		151
123	To append to the write buffer, use the C<< ->push_write >> method.	152	To append to the write buffer, use the C<< ->push_write >> method.
124		153
		154	This callback is useful when you don't want to put all of your write data
		155	into the queue at once, for example, when you want to write the contents
		156	of some file to the socket you might not want to read the whole file into
		157	memory and push it into the queue, but instead only read more data from
		158	the file when the write queue becomes empty.
		159
125	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
126		161
127	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
128	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
129	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
130	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
131		166
132	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
133	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
134	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
135	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
136		172
137	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
138		174
139	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
140		176
…		…
144		180
145	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
146		182
147	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>)
148	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
149	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
150		186
151	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
152	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
153	(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
154	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
155	isn't finished).	191	isn't finished).
156		192
		193	=item autocork => <boolean>
		194
		195	When disabled (the default), then C<push_write> will try to immediately
		196	write the data to the handle, if possible. This avoids having to register
		197	a write watcher and wait for the next event loop iteration, but can
		198	be inefficient if you write multiple small chunks (on the wire, this
		199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
		201
		202	When enabled, then writes will always be queued till the next event loop
		203	iteration. This is efficient when you do many small writes per iteration,
		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.
		206
		207	=item no_delay => <boolean>
		208
		209	When doing small writes on sockets, your operating system kernel might
		210	wait a bit for more data before actually sending it out. This is called
		211	the Nagle algorithm, and usually it is beneficial.
		212
		213	In some situations you want as low a delay as possible, which can be
		214	accomplishd by setting this option to a true value.
		215
		216	The default is your opertaing system's default behaviour (most likely
		217	enabled), this option explicitly enables or disables it, if possible.
		218
157	=item read_size => <bytes>	219	=item read_size => <bytes>
158		220
159	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
160	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
161		224
162	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
163		226
164	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
165	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
166	considered empty.	229	considered empty.
167		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
		236	=item linger => <seconds>
		237
		238	If non-zero (default: C<3600>), then the destructor of the
		239	AnyEvent::Handle object will check whether there is still outstanding
		240	write data and will install a watcher that will write this data to the
		241	socket. No errors will be reported (this mostly matches how the operating
		242	system treats outstanding data at socket close time).
		243
		244	This will not work for partial TLS data that could not be encoded
		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>).
		255
168	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
169		257
170	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
171	will start making tls handshake and will transparently encrypt/decrypt	259	AnyEvent will start a TLS handshake as soon as the conenction has been
172	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.
173		264
174	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
175	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.
176		269
177	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
178	connection, use C<connect> mode.	271	C<accept>, and for the TLS client side of a connection, use C<connect>
		272	mode.
179		273
180	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
181	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>
182	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
183	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
184		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
185	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.
186		290
187	=item tls_ctx => $ssl_ctx	291	=item tls_ctx => $anyevent_tls
188		292
189	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
190	(unless a connection object was specified directly). If this parameter is	294	(unless a connection object was specified directly). If this parameter is
191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
192		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
193	=item json => JSON or JSON::XS object	323	=item json => JSON or JSON::XS object
194		324
195	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.
196		326
197	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
198	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.
199		330
200	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
201	use this functionality, as AnyEvent does not have a dependency itself.	332	use this functionality, as AnyEvent does not have a dependency itself.
202		333
203	=item filter_r => $cb
204
205	=item filter_w => $cb
206
207	These exist, but are undocumented at this time.
208
209	=back	334	=back
210		335
211	=cut	336	=cut
212		337
213	sub new {	338	sub new {
214	my $class = shift;	339	my $class = shift;
215
216	my $self = bless { @_ }, $class;	340	my $self = bless { @_ }, $class;
217		341
218	$self->{fh} or Carp::croak "mandatory argument fh is missing";	342	$self->{fh} or Carp::croak "mandatory argument fh is missing";
219		343
220	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	344	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
221
222	if ($self->{tls}) {
223	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}
226
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231		345
232	$self->{_activity} = AnyEvent->now;	346	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	347	$self->_timeout;
234		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
		354	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		355
235	$self->start_read;	356	$self->start_read
		357	if $self->{on_read};
236		358
237	$self	359	$self->{fh} && $self
238	}	360	}
239		361
240	sub _shutdown {	362	sub _shutdown {
241	my ($self) = @_;	363	my ($self) = @_;
242		364
243	delete $self->{_tw};	365	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
244	delete $self->{_rw};	366	$self->{_eof} = 1; # tell starttls et. al to stop trying
245	delete $self->{_ww};
246	delete $self->{fh};
247	}
248		367
		368	&_freetls;
		369	}
		370
249	sub error {	371	sub _error {
250	my ($self) = @_;	372	my ($self, $errno, $fatal, $message) = @_;
251		373
252	{
253	local $!;
254	$self->_shutdown;	374	$self->_shutdown
255	}	375	if $fatal;
256		376
257	$self->{on_error}($self)	377	$! = $errno;
		378	$message ||= "$!";
		379
258	if $self->{on_error};	380	if ($self->{on_error}) {
259		381	$self->{on_error}($self, $fatal, $message);
		382	} elsif ($self->{fh}) {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	383	Carp::croak "AnyEvent::Handle uncaught error: $message";
		384	}
261	}	385	}
262		386
263	=item $fh = $handle->fh	387	=item $fh = $handle->fh
264		388
265	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.
266		390
267	=cut	391	=cut
268		392
269	sub fh { $_[0]{fh} }	393	sub fh { $_[0]{fh} }
270		394
…		…
288	$_[0]{on_eof} = $_[1];	412	$_[0]{on_eof} = $_[1];
289	}	413	}
290		414
291	=item $handle->on_timeout ($cb)	415	=item $handle->on_timeout ($cb)
292		416
293	Replace the current C<on_timeout> callback, or disables the callback	417	Replace the current C<on_timeout> callback, or disables the callback (but
294	(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
295	argument.	419	argument and method.
296		420
297	=cut	421	=cut
298		422
299	sub on_timeout {	423	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	424	$_[0]{on_timeout} = $_[1];
		425	}
		426
		427	=item $handle->autocork ($boolean)
		428
		429	Enables or disables the current autocork behaviour (see C<autocork>
		430	constructor argument). Changes will only take effect on the next write.
		431
		432	=cut
		433
		434	sub autocork {
		435	$_[0]{autocork} = $_[1];
		436	}
		437
		438	=item $handle->no_delay ($boolean)
		439
		440	Enables or disables the C<no_delay> setting (see constructor argument of
		441	the same name for details).
		442
		443	=cut
		444
		445	sub no_delay {
		446	$_[0]{no_delay} = $_[1];
		447
		448	eval {
		449	local $SIG{__DIE__};
		450	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		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];
301	}	472	}
302		473
303	#############################################################################	474	#############################################################################
304		475
305	=item $handle->timeout ($seconds)	476	=item $handle->timeout ($seconds)
…		…
329	# now or in the past already?	500	# now or in the past already?
330	if ($after <= 0) {	501	if ($after <= 0) {
331	$self->{_activity} = $NOW;	502	$self->{_activity} = $NOW;
332		503
333	if ($self->{on_timeout}) {	504	if ($self->{on_timeout}) {
334	$self->{on_timeout}->($self);	505	$self->{on_timeout}($self);
335	} else {	506	} else {
336	$! = Errno::ETIMEDOUT;	507	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	508	}
339		509
340	# callbakx could have changed timeout value, optimise	510	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	511	return unless $self->{timeout};
342		512
343	# calculate new after	513	# calculate new after
344	$after = $self->{timeout};	514	$after = $self->{timeout};
345	}	515	}
346		516
347	Scalar::Util::weaken $self;	517	Scalar::Util::weaken $self;
		518	return unless $self; # ->error could have destroyed $self
348		519
349	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {	520	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	521	delete $self->{_tw};
351	$self->_timeout;	522	$self->_timeout;
352	});	523	});
…		…
383	my ($self, $cb) = @_;	554	my ($self, $cb) = @_;
384		555
385	$self->{on_drain} = $cb;	556	$self->{on_drain} = $cb;
386		557
387	$cb->($self)	558	$cb->($self)
388	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	559	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
389	}	560	}
390		561
391	=item $handle->push_write ($data)	562	=item $handle->push_write ($data)
392		563
393	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
…		…
410	substr $self->{wbuf}, 0, $len, "";	581	substr $self->{wbuf}, 0, $len, "";
411		582
412	$self->{_activity} = AnyEvent->now;	583	$self->{_activity} = AnyEvent->now;
413		584
414	$self->{on_drain}($self)	585	$self->{on_drain}($self)
415	if $self->{low_water_mark} >= length $self->{wbuf}	586	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
416	&& $self->{on_drain};	587	&& $self->{on_drain};
417		588
418	delete $self->{_ww} unless length $self->{wbuf};	589	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	590	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	591	$self->_error ($!, 1);
421	}	592	}
422	};	593	};
423		594
424	# try to write data immediately	595	# try to write data immediately
425	$cb->();	596	$cb->() unless $self->{autocork};
426		597
427	# if still data left in wbuf, we need to poll	598	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	599	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	600	if length $self->{wbuf};
430	};	601	};
…		…
444		615
445	@_ = ($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")
446	->($self, @_);	617	->($self, @_);
447	}	618	}
448		619
449	if ($self->{filter_w}) {	620	if ($self->{tls}) {
450	$self->{filter_w}->($self, \$_[0]);	621	$self->{_tls_wbuf} .= $_[0];
		622
		623	&_dotls ($self);
451	} else {	624	} else {
452	$self->{wbuf} .= $_[0];	625	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	626	$self->_drain_wbuf;
454	}	627	}
455	}	628	}
456		629
457	=item $handle->push_write (type => @args)	630	=item $handle->push_write (type => @args)
458		631
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	632	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	633	the job by specifying a type and type-specific arguments.
463		634
464	Predefined types are (if you have ideas for additional types, feel free to	635	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	636	drop by and tell us):
…		…
469	=item netstring => $string	640	=item netstring => $string
470		641
471	Formats the given value as netstring	642	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	643	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		644
474	=back
475
476	=cut	645	=cut
477		646
478	register_write_type netstring => sub {	647	register_write_type netstring => sub {
479	my ($self, $string) = @_;	648	my ($self, $string) = @_;
480		649
481	sprintf "%d:%s,", (length $string), $string	650	(length $string) . ":$string,"
		651	};
		652
		653	=item packstring => $format, $data
		654
		655	An octet string prefixed with an encoded length. The encoding C<$format>
		656	uses the same format as a Perl C<pack> format, but must specify a single
		657	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		658	optional C<!>, C<< < >> or C<< > >> modifier).
		659
		660	=cut
		661
		662	register_write_type packstring => sub {
		663	my ($self, $format, $string) = @_;
		664
		665	pack "$format/a*", $string
482	};	666	};
483		667
484	=item json => $array_or_hashref	668	=item json => $array_or_hashref
485		669
486	Encodes the given hash or array reference into a JSON object. Unless you	670	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		704
521	$self->{json} ? $self->{json}->encode ($ref)	705	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	706	: JSON::encode_json ($ref)
523	};	707	};
524		708
		709	=item storable => $reference
		710
		711	Freezes the given reference using L<Storable> and writes it to the
		712	handle. Uses the C<nfreeze> format.
		713
		714	=cut
		715
		716	register_write_type storable => sub {
		717	my ($self, $ref) = @_;
		718
		719	require Storable;
		720
		721	pack "w/a*", Storable::nfreeze ($ref)
		722	};
		723
		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	}
		750
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	751	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		752
527	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>.
528	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
529	reference with the handle object and the remaining arguments.	755	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	775	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	776	a queue.
551		777
552	In the simple case, you just install an C<on_read> callback and whenever	778	In the simple case, you just install an C<on_read> callback and whenever
553	new data arrives, it will be called. You can then remove some data (if	779	new data arrives, it will be called. You can then remove some data (if
554	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	780	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	781	leave the data there if you want to accumulate more (e.g. when only a
		782	partial message has been received so far).
556		783
557	In the more complex case, you want to queue multiple callbacks. In this	784	In the more complex case, you want to queue multiple callbacks. In this
558	case, AnyEvent::Handle will call the first queued callback each time new	785	case, AnyEvent::Handle will call the first queued callback each time new
559	data arrives and removes it when it has done its job (see C<push_read>,	786	data arrives (also the first time it is queued) and removes it when it has
560	below).	787	done its job (see C<push_read>, below).
561		788
562	This way you can, for example, push three line-reads, followed by reading	789	This way you can, for example, push three line-reads, followed by reading
563	a chunk of data, and AnyEvent::Handle will execute them in order.	790	a chunk of data, and AnyEvent::Handle will execute them in order.
564		791
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	792	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	793	the specified number of bytes which give an XML datagram.
567		794
568	# in the default state, expect some header bytes	795	# in the default state, expect some header bytes
569	$handle->on_read (sub {	796	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	797	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	798	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	799	# header arrived, decode
573	my $len = unpack "N", $_[1];	800	my $len = unpack "N", $_[1];
574		801
575	# now read the payload	802	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	803	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	804	my $xml = $_[1];
578	# handle xml	805	# handle xml
579	});	806	});
580	});	807	});
581	});	808	});
582		809
583	Example 2: Implement a client for a protocol that replies either with	810	Example 2: Implement a client for a protocol that replies either with "OK"
584	"OK" and another line or "ERROR" for one request, and 64 bytes for the	811	and another line or "ERROR" for the first request that is sent, and 64
585	second request. Due tot he availability of a full queue, we can just	812	bytes for the second request. Due to the availability of a queue, we can
586	pipeline sending both requests and manipulate the queue as necessary in	813	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	814	in the callbacks.
588		815
589	# request one	816	When the first callback is called and sees an "OK" response, it will
		817	C<unshift> another line-read. This line-read will be queued I<before> the
		818	64-byte chunk callback.
		819
		820	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	821	$handle->push_write ("request 1\015\012");
591		822
592	# we expect "ERROR" or "OK" as response, so push a line read	823	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	824	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	825	# if we got an "OK", we have to _prepend_ another line,
595	# so it will be read before the second request reads its 64 bytes	826	# so it will be read before the second request reads its 64 bytes
596	# which are already in the queue when this callback is called	827	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	828	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	829	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	830	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	831	my $response = $_[1];
601	...	832	...
602	});	833	});
603	}	834	}
604	});	835	});
605		836
606	# request two	837	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	838	$handle->push_write ("request 2\015\012");
608		839
609	# simply read 64 bytes, always	840	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	841	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	842	my $response = $_[1];
612	...	843	...
613	});	844	});
614		845
615	=over 4	846	=over 4
616		847
617	=cut	848	=cut
618		849
619	sub _drain_rbuf {	850	sub _drain_rbuf {
620	my ($self) = @_;	851	my ($self) = @_;
		852
		853	local $self->{_in_drain} = 1;
621		854
622	if (	855	if (
623	defined $self->{rbuf_max}	856	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	857	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	858	) {
626	$! = &Errno::ENOSPC;	859	$self->_error (&Errno::ENOSPC, 1), return;
627	$self->error;
628	}	860	}
629		861
630	return if $self->{in_drain};	862	while () {
631	local $self->{in_drain} = 1;	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};
632		866
633	while (my $len = length $self->{rbuf}) {	867	my $len = length $self->{rbuf};
634	no strict 'refs';	868
635	if (my $cb = shift @{ $self->{_queue} }) {	869	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	870	unless ($cb->($self)) {
637	if ($self->{_eof}) {	871	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	872	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	873	$self->_error (&Errno::EPIPE, 1), return;
640	$self->error;
641	}	874	}
642		875
643	unshift @{ $self->{_queue} }, $cb;	876	unshift @{ $self->{_queue} }, $cb;
644	return;	877	last;
645	}	878	}
646	} elsif ($self->{on_read}) {	879	} elsif ($self->{on_read}) {
		880	last unless $len;
		881
647	$self->{on_read}($self);	882	$self->{on_read}($self);
648		883
649	if (	884	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	885	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	886	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	887	&& $self->{on_read} # but we still have on_read
654	) {	888	) {
		889	# no further data will arrive
655	# then no progress can be made	890	# so no progress can be made
656	$! = &Errno::EPIPE;	891	$self->_error (&Errno::EPIPE, 1), return
657	$self->error;	892	if $self->{_eof};
		893
		894	last; # more data might arrive
658	}	895	}
659	} else {	896	} else {
660	# read side becomes idle	897	# read side becomes idle
661	delete $self->{_rw};	898	delete $self->{_rw} unless $self->{tls};
662	return;	899	last;
663	}	900	}
664	}	901	}
665		902
666	if ($self->{_eof}) {	903	if ($self->{_eof}) {
667	$self->_shutdown;	904	if ($self->{on_eof}) {
668	$self->{on_eof}($self)	905	$self->{on_eof}($self)
669	if $self->{on_eof};	906	} else {
		907	$self->_error (0, 1, "Unexpected end-of-file");
		908	}
		909	}
		910
		911	# may need to restart read watcher
		912	unless ($self->{_rw}) {
		913	$self->start_read
		914	if $self->{on_read} || @{ $self->{_queue} };
670	}	915	}
671	}	916	}
672		917
673	=item $handle->on_read ($cb)	918	=item $handle->on_read ($cb)
674		919
…		…
680		925
681	sub on_read {	926	sub on_read {
682	my ($self, $cb) = @_;	927	my ($self, $cb) = @_;
683		928
684	$self->{on_read} = $cb;	929	$self->{on_read} = $cb;
		930	$self->_drain_rbuf if $cb && !$self->{_in_drain};
685	}	931	}
686		932
687	=item $handle->rbuf	933	=item $handle->rbuf
688		934
689	Returns the read buffer (as a modifiable lvalue).	935	Returns the read buffer (as a modifiable lvalue).
690		936
691	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} >>
692	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.
693		942
694	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>,
695	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
696	automatically manage the read buffer.	945	automatically manage the read buffer.
697		946
…		…
738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	987	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
739	->($self, $cb, @_);	988	->($self, $cb, @_);
740	}	989	}
741		990
742	push @{ $self->{_queue} }, $cb;	991	push @{ $self->{_queue} }, $cb;
743	$self->_drain_rbuf;	992	$self->_drain_rbuf unless $self->{_in_drain};
744	}	993	}
745		994
746	sub unshift_read {	995	sub unshift_read {
747	my $self = shift;	996	my $self = shift;
748	my $cb = pop;	997	my $cb = pop;
…		…
754	->($self, $cb, @_);	1003	->($self, $cb, @_);
755	}	1004	}
756		1005
757		1006
758	unshift @{ $self->{_queue} }, $cb;	1007	unshift @{ $self->{_queue} }, $cb;
759	$self->_drain_rbuf;	1008	$self->_drain_rbuf unless $self->{_in_drain};
760	}	1009	}
761		1010
762	=item $handle->push_read (type => @args, $cb)	1011	=item $handle->push_read (type => @args, $cb)
763		1012
764	=item $handle->unshift_read (type => @args, $cb)	1013	=item $handle->unshift_read (type => @args, $cb)
…		…
794	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1043	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
795	1	1044	1
796	}	1045	}
797	};	1046	};
798		1047
799	# compatibility with older API
800	sub push_read_chunk {
801	$_[0]->push_read (chunk => $_[1], $_[2]);
802	}
803
804	sub unshift_read_chunk {
805	$_[0]->unshift_read (chunk => $_[1], $_[2]);
806	}
807
808	=item line => [$eol, ]$cb->($handle, $line, $eol)	1048	=item line => [$eol, ]$cb->($handle, $line, $eol)
809		1049
810	The callback will be called only once a full line (including the end of	1050	The callback will be called only once a full line (including the end of
811	line marker, C<$eol>) has been read. This line (excluding the end of line	1051	line marker, C<$eol>) has been read. This line (excluding the end of line
812	marker) will be passed to the callback as second argument (C<$line>), and	1052	marker) will be passed to the callback as second argument (C<$line>), and
…		…
827	=cut	1067	=cut
828		1068
829	register_read_type line => sub {	1069	register_read_type line => sub {
830	my ($self, $cb, $eol) = @_;	1070	my ($self, $cb, $eol) = @_;
831		1071
832	$eol = qr|(\015?\012)| if @_ < 3;	1072	if (@_ < 3) {
833	$eol = quotemeta $eol unless ref $eol;	1073	# this is more than twice as fast as the generic code below
834	$eol = qr|^(.*?)($eol)|s;
835
836	sub {	1074	sub {
837	$_[0]{rbuf} =~ s/$eol// or return;	1075	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
838		1076
839	$cb->($_[0], $1, $2);	1077	$cb->($_[0], $1, $2);
840	1
841	}
842	};
843
844	# compatibility with older API
845	sub push_read_line {
846	my $self = shift;
847	$self->push_read (line => @_);
848	}
849
850	sub unshift_read_line {
851	my $self = shift;
852	$self->unshift_read (line => @_);
853	}
854
855	=item netstring => $cb->($handle, $string)
856
857	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
858
859	Throws an error with C<$!> set to EBADMSG on format violations.
860
861	=cut
862
863	register_read_type netstring => sub {
864	my ($self, $cb) = @_;
865
866	sub {
867	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
868	if ($_[0]{rbuf} =~ /[^0-9]/) {
869	$! = &Errno::EBADMSG;
870	$self->error;
871	}	1078	1
872	return;
873	}	1079	}
		1080	} else {
		1081	$eol = quotemeta $eol unless ref $eol;
		1082	$eol = qr|^(.*?)($eol)|s;
874		1083
875	my $len = $1;	1084	sub {
		1085	$_[0]{rbuf} =~ s/$eol// or return;
876		1086
877	$self->unshift_read (chunk => $len, sub {	1087	$cb->($_[0], $1, $2);
878	my $string = $_[1];
879	$_[0]->unshift_read (chunk => 1, sub {
880	if ($_[1] eq ",") {
881	$cb->($_[0], $string);
882	} else {
883	$! = &Errno::EBADMSG;
884	$self->error;
885	}
886	});	1088	1
887	});	1089	}
888
889	1
890	}	1090	}
891	};	1091	};
892		1092
893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1093	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
894		1094
…		…
946	return 1;	1146	return 1;
947	}	1147	}
948		1148
949	# reject	1149	# reject
950	if ($reject && $$rbuf =~ $reject) {	1150	if ($reject && $$rbuf =~ $reject) {
951	$! = &Errno::EBADMSG;	1151	$self->_error (&Errno::EBADMSG);
952	$self->error;
953	}	1152	}
954		1153
955	# skip	1154	# skip
956	if ($skip && $$rbuf =~ $skip) {	1155	if ($skip && $$rbuf =~ $skip) {
957	$data .= substr $$rbuf, 0, $+[0], "";	1156	$data .= substr $$rbuf, 0, $+[0], "";
…		…
959		1158
960	()	1159	()
961	}	1160	}
962	};	1161	};
963		1162
		1163	=item netstring => $cb->($handle, $string)
		1164
		1165	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1166
		1167	Throws an error with C<$!> set to EBADMSG on format violations.
		1168
		1169	=cut
		1170
		1171	register_read_type netstring => sub {
		1172	my ($self, $cb) = @_;
		1173
		1174	sub {
		1175	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1176	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1177	$self->_error (&Errno::EBADMSG);
		1178	}
		1179	return;
		1180	}
		1181
		1182	my $len = $1;
		1183
		1184	$self->unshift_read (chunk => $len, sub {
		1185	my $string = $_[1];
		1186	$_[0]->unshift_read (chunk => 1, sub {
		1187	if ($_[1] eq ",") {
		1188	$cb->($_[0], $string);
		1189	} else {
		1190	$self->_error (&Errno::EBADMSG);
		1191	}
		1192	});
		1193	});
		1194
		1195	1
		1196	}
		1197	};
		1198
		1199	=item packstring => $format, $cb->($handle, $string)
		1200
		1201	An octet string prefixed with an encoded length. The encoding C<$format>
		1202	uses the same format as a Perl C<pack> format, but must specify a single
		1203	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1204	optional C<!>, C<< < >> or C<< > >> modifier).
		1205
		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).
		1208
		1209	Example: read a block of data prefixed by its length in BER-encoded
		1210	format (very efficient).
		1211
		1212	$handle->push_read (packstring => "w", sub {
		1213	my ($handle, $data) = @_;
		1214	});
		1215
		1216	=cut
		1217
		1218	register_read_type packstring => sub {
		1219	my ($self, $cb, $format) = @_;
		1220
		1221	sub {
		1222	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1223	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1224	or return;
		1225
		1226	$format = length pack $format, $len;
		1227
		1228	# bypass unshift if we already have the remaining chunk
		1229	if ($format + $len <= length $_[0]{rbuf}) {
		1230	my $data = substr $_[0]{rbuf}, $format, $len;
		1231	substr $_[0]{rbuf}, 0, $format + $len, "";
		1232	$cb->($_[0], $data);
		1233	} else {
		1234	# remove prefix
		1235	substr $_[0]{rbuf}, 0, $format, "";
		1236
		1237	# read remaining chunk
		1238	$_[0]->unshift_read (chunk => $len, $cb);
		1239	}
		1240
		1241	1
		1242	}
		1243	};
		1244
964	=item json => $cb->($handle, $hash_or_arrayref)	1245	=item json => $cb->($handle, $hash_or_arrayref)
965		1246
966	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.
967		1249
968	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
969	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.
970		1252
971	This read type uses the incremental parser available with JSON version	1253	This read type uses the incremental parser available with JSON version
…		…
978	the C<json> write type description, above, for an actual example.	1260	the C<json> write type description, above, for an actual example.
979		1261
980	=cut	1262	=cut
981		1263
982	register_read_type json => sub {	1264	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1265	my ($self, $cb) = @_;
984		1266
985	require JSON;	1267	my $json = $self->{json} ||=
		1268	eval { require JSON::XS; JSON::XS->new->utf8 }
		1269	|| do { require JSON; JSON->new->utf8 };
986		1270
987	my $data;	1271	my $data;
988	my $rbuf = \$self->{rbuf};	1272	my $rbuf = \$self->{rbuf};
989		1273
990	my $json = $self->{json} ||= JSON->new->utf8;
991
992	sub {	1274	sub {
993	my $ref = $json->incr_parse ($self->{rbuf});	1275	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
994		1276
995	if ($ref) {	1277	if ($ref) {
996	$self->{rbuf} = $json->incr_text;	1278	$self->{rbuf} = $json->incr_text;
997	$json->incr_text = "";	1279	$json->incr_text = "";
998	$cb->($self, $ref);	1280	$cb->($self, $ref);
999		1281
1000	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	()
1001	} else {	1293	} else {
1002	$self->{rbuf} = "";	1294	$self->{rbuf} = "";
		1295
1003	()	1296	()
1004	}	1297	}
		1298	}
		1299	};
		1300
		1301	=item storable => $cb->($handle, $ref)
		1302
		1303	Deserialises a L<Storable> frozen representation as written by the
		1304	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1305	data).
		1306
		1307	Raises C<EBADMSG> error if the data could not be decoded.
		1308
		1309	=cut
		1310
		1311	register_read_type storable => sub {
		1312	my ($self, $cb) = @_;
		1313
		1314	require Storable;
		1315
		1316	sub {
		1317	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1318	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1319	or return;
		1320
		1321	my $format = length pack "w", $len;
		1322
		1323	# bypass unshift if we already have the remaining chunk
		1324	if ($format + $len <= length $_[0]{rbuf}) {
		1325	my $data = substr $_[0]{rbuf}, $format, $len;
		1326	substr $_[0]{rbuf}, 0, $format + $len, "";
		1327	$cb->($_[0], Storable::thaw ($data));
		1328	} else {
		1329	# remove prefix
		1330	substr $_[0]{rbuf}, 0, $format, "";
		1331
		1332	# read remaining chunk
		1333	$_[0]->unshift_read (chunk => $len, sub {
		1334	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1335	$cb->($_[0], $ref);
		1336	} else {
		1337	$self->_error (&Errno::EBADMSG);
		1338	}
		1339	});
		1340	}
		1341
		1342	1
1005	}	1343	}
1006	};	1344	};
1007		1345
1008	=back	1346	=back
1009		1347
…		…
1030	=item $handle->stop_read	1368	=item $handle->stop_read
1031		1369
1032	=item $handle->start_read	1370	=item $handle->start_read
1033		1371
1034	In rare cases you actually do not want to read anything from the	1372	In rare cases you actually do not want to read anything from the
1035	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1373	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1036	any queued callbacks will be executed then. To start reading again, call	1374	any queued callbacks will be executed then. To start reading again, call
1037	C<start_read>.	1375	C<start_read>.
1038		1376
		1377	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1378	you change the C<on_read> callback or push/unshift a read callback, and it
		1379	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1380	there are any read requests in the queue.
		1381
		1382	These methods will have no effect when in TLS mode (as TLS doesn't support
		1383	half-duplex connections).
		1384
1039	=cut	1385	=cut
1040		1386
1041	sub stop_read {	1387	sub stop_read {
1042	my ($self) = @_;	1388	my ($self) = @_;
1043		1389
1044	delete $self->{_rw};	1390	delete $self->{_rw} unless $self->{tls};
1045	}	1391	}
1046		1392
1047	sub start_read {	1393	sub start_read {
1048	my ($self) = @_;	1394	my ($self) = @_;
1049		1395
1050	unless ($self->{_rw} || $self->{_eof}) {	1396	unless ($self->{_rw} || $self->{_eof}) {
1051	Scalar::Util::weaken $self;	1397	Scalar::Util::weaken $self;
1052		1398
1053	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1399	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1054	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1400	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1055	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;
1056		1402
1057	if ($len > 0) {	1403	if ($len > 0) {
1058	$self->{_activity} = AnyEvent->now;	1404	$self->{_activity} = AnyEvent->now;
1059		1405
1060	$self->{filter_r}	1406	if ($self->{tls}) {
1061	? $self->{filter_r}->($self, $rbuf)	1407	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1062	: $self->_drain_rbuf;	1408
		1409	&_dotls ($self);
		1410	} else {
		1411	$self->_drain_rbuf unless $self->{_in_drain};
		1412	}
1063		1413
1064	} elsif (defined $len) {	1414	} elsif (defined $len) {
1065	delete $self->{_rw};	1415	delete $self->{_rw};
1066	$self->{_eof} = 1;	1416	$self->{_eof} = 1;
1067	$self->_drain_rbuf;	1417	$self->_drain_rbuf unless $self->{_in_drain};
1068		1418
1069	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1070	return $self->error;	1420	return $self->_error ($!, 1);
1071	}	1421	}
1072	});	1422	});
1073	}	1423	}
1074	}	1424	}
1075		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.
1076	sub _dotls {	1448	sub _dotls {
1077	my ($self) = @_;	1449	my ($self) = @_;
1078		1450
		1451	my $tmp;
		1452
1079	if (length $self->{_tls_wbuf}) {	1453	if (length $self->{_tls_wbuf}) {
1080	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1454	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1081	substr $self->{_tls_wbuf}, 0, $len, "";	1455	substr $self->{_tls_wbuf}, 0, $tmp, "";
1082	}	1456	}
1083	}
1084		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
1085	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1487	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1086	$self->{wbuf} .= $buf;	1488	$self->{wbuf} .= $tmp;
1087	$self->_drain_wbuf;	1489	$self->_drain_wbuf;
1088	}	1490	}
1089		1491
1090	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1492	$self->{_on_starttls}
1091	$self->{rbuf} .= $buf;	1493	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1092	$self->_drain_rbuf;	1494	and (delete $self->{_on_starttls})->($self, 1);
1093	}
1094
1095	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1096
1097	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1098	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1099	$self->error;
1100	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1101	$! = &Errno::EIO;
1102	$self->error;
1103	}
1104
1105	# all others are fine for our purposes
1106	}
1107	}	1495	}
1108		1496
1109	=item $handle->starttls ($tls[, $tls_ctx])	1497	=item $handle->starttls ($tls[, $tls_ctx])
1110		1498
1111	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1499	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1113	C<starttls>.	1501	C<starttls>.
1114		1502
1115	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
1116	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1504	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1117		1505
1118	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
1119	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.
1120		1510
1121	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
1122	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
1123	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.
1124		1515
1125	=cut	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).
1126		1518
1127	# TODO: maybe document...	1519	=cut
		1520
		1521	our %TLS_CACHE; #TODO not yet documented, should we?
		1522
1128	sub starttls {	1523	sub starttls {
1129	my ($self, $ssl, $ctx) = @_;	1524	my ($self, $ssl, $ctx) = @_;
1130		1525
1131	$self->stoptls;	1526	require Net::SSLeay;
1132		1527
1133	if ($ssl eq "accept") {	1528	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1134	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1529	if $self->{tls};
1135	Net::SSLeay::set_accept_state ($ssl);	1530
1136	} elsif ($ssl eq "connect") {	1531	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1137	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1532	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1138	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	}
1139	}	1548
1140		1549	$self->{tls_ctx} = $ctx || TLS_CTX ();
1141	$self->{tls} = $ssl;	1550	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1142		1551
1143	# 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)
1144	# but the openssl maintainers basically said: "trust us, it just works".	1553	# but the openssl maintainers basically said: "trust us, it just works".
1145	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1554	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1146	# and mismaintained ssleay-module doesn't even offer them).	1555	# and mismaintained ssleay-module doesn't even offer them).
1147	# 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.
1148	Net::SSLeay::CTX_set_mode ($self->{tls},	1564	# Net::SSLeay::CTX_set_mode ($ssl,
1149	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1565	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1150	| (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);
1151		1568
1152	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1569	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1153	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1570	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1154		1571
1155	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1572	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1156		1573
1157	$self->{filter_w} = sub {	1574	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1158	$_[0]{_tls_wbuf} .= ${$_[1]};	1575	if exists $self->{on_starttls};
1159	&_dotls;	1576
1160	};	1577	&_dotls; # need to trigger the initial handshake
1161	$self->{filter_r} = sub {	1578	$self->start_read; # make sure we actually do read
1162	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1163	&_dotls;
1164	};
1165	}	1579	}
1166		1580
1167	=item $handle->stoptls	1581	=item $handle->stoptls
1168		1582
1169	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
1170	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.
1171		1587
1172	=cut	1588	=cut
1173		1589
1174	sub stoptls {	1590	sub stoptls {
1175	my ($self) = @_;	1591	my ($self) = @_;
1176		1592
1177	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1593	if ($self->{tls}) {
		1594	Net::SSLeay::shutdown ($self->{tls});
1178		1595
1179	delete $self->{_rbio};	1596	&_dotls;
1180	delete $self->{_wbio};	1597
1181	delete $self->{_tls_wbuf};	1598	# # we don't give a shit. no, we do, but we can't. no...#d#
1182	delete $self->{filter_r};	1599	# # we, we... have to use openssl :/#d#
1183	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)};
1184	}	1615	}
1185		1616
1186	sub DESTROY {	1617	sub DESTROY {
1187	my $self = shift;	1618	my ($self) = @_;
1188		1619
1189	$self->stoptls;	1620	&_freetls;
		1621
		1622	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1623
		1624	if ($linger && length $self->{wbuf}) {
		1625	my $fh = delete $self->{fh};
		1626	my $wbuf = delete $self->{wbuf};
		1627
		1628	my @linger;
		1629
		1630	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1631	my $len = syswrite $fh, $wbuf, length $wbuf;
		1632
		1633	if ($len > 0) {
		1634	substr $wbuf, 0, $len, "";
		1635	} else {
		1636	@linger = (); # end
		1637	}
		1638	});
		1639	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1640	@linger = ();
		1641	});
		1642	}
		1643	}
		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 = ();
1190	}	1668	}
1191		1669
1192	=item AnyEvent::Handle::TLS_CTX	1670	=item AnyEvent::Handle::TLS_CTX
1193		1671
1194	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
1195	default for TLS mode.	1673	for TLS mode.
1196		1674
1197	The context is created like this:	1675	The context is created by calling L<AnyEvent::TLS> without any arguments.
1198
1199	Net::SSLeay::load_error_strings;
1200	Net::SSLeay::SSLeay_add_ssl_algorithms;
1201	Net::SSLeay::randomize;
1202
1203	my $CTX = Net::SSLeay::CTX_new;
1204
1205	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1206		1676
1207	=cut	1677	=cut
1208		1678
1209	our $TLS_CTX;	1679	our $TLS_CTX;
1210		1680
1211	sub TLS_CTX() {	1681	sub TLS_CTX() {
1212	$TLS_CTX || do {	1682	$TLS_CTX ||= do {
1213	require Net::SSLeay;	1683	require AnyEvent::TLS;
1214		1684
1215	Net::SSLeay::load_error_strings ();	1685	new AnyEvent::TLS
1216	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1217	Net::SSLeay::randomize ();
1218
1219	$TLS_CTX = Net::SSLeay::CTX_new ();
1220
1221	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1222
1223	$TLS_CTX
1224	}	1686	}
1225	}	1687	}
1226		1688
1227	=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
1228		1762
1229	=head1 SUBCLASSING AnyEvent::Handle	1763	=head1 SUBCLASSING AnyEvent::Handle
1230		1764
1231	In many cases, you might want to subclass AnyEvent::Handle.	1765	In many cases, you might want to subclass AnyEvent::Handle.
1232		1766
…		…
1236	=over 4	1770	=over 4
1237		1771
1238	=item * all constructor arguments become object members.	1772	=item * all constructor arguments become object members.
1239		1773
1240	At least initially, when you pass a C<tls>-argument to the constructor it	1774	At least initially, when you pass a C<tls>-argument to the constructor it
1241	will end up in C<< $handle->{tls} >>. Those members might be changes or	1775	will end up in C<< $handle->{tls} >>. Those members might be changed or
1242	mutated later on (for example C<tls> will hold the TLS connection object).	1776	mutated later on (for example C<tls> will hold the TLS connection object).
1243		1777
1244	=item * other object member names are prefixed with an C<_>.	1778	=item * other object member names are prefixed with an C<_>.
1245		1779
1246	All object members not explicitly documented (internal use) are prefixed	1780	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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