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.24 by root, Sat May 24 15:11:46 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 ();	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
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	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.452;
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
24		22
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->send;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
51	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
52		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
53	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
54	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
55	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
56		60
57	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
…		…
59		63
60	=head1 METHODS	64	=head1 METHODS
61		65
62	=over 4	66	=over 4
63		67
64	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
65		69
66	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
67		71
68	=over 4	72	=over 4
69		73
70	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
71		75
72	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
73		77
74	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
75	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
76		81
77	=item on_eof => $cb->($self)	82	=item on_eof => $cb->($handle)
78		83
79	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.
80		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
81	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,
82	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
83	waiting for data.	95	waiting for data.
84		96
85	=item on_error => $cb->($self)	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>.
86		99
		100	=item on_error => $cb->($handle, $fatal, $message)
		101
87	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
88	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
89	or a read error.	104	connect or a read error.
90		105
91	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
92	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>).
93		121
94	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		124	C<EPROTO>).
96		125
97	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
98	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
99	die.	128	C<croak>.
100		129
101	=item on_read => $cb->($self)	130	=item on_read => $cb->($handle)
102		131
103	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
104	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).
105		136
106	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 >>
107	method or access the C<$self->{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.
108		141
109	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
110	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
111	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
112	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
113		146
114	=item on_drain => $cb->()	147	=item on_drain => $cb->($handle)
115		148
116	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
117	(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).
118		151
119	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.
120		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
		160	=item timeout => $fractional_seconds
		161
		162	If non-zero, then this enables an "inactivity" timeout: whenever this many
		163	seconds pass without a successful read or write on the underlying file
		164	handle, the C<on_timeout> callback will be invoked (and if that one is
		165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
		166
		167	Note that timeout processing is also active when you currently do not have
		168	any outstanding read or write requests: If you plan to keep the connection
		169	idle then you should disable the timout temporarily or ignore the timeout
		170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
		172
		173	Zero (the default) disables this timeout.
		174
		175	=item on_timeout => $cb->($handle)
		176
		177	Called whenever the inactivity timeout passes. If you return from this
		178	callback, then the timeout will be reset as if some activity had happened,
		179	so this condition is not fatal in any way.
		180
121	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
122		182
123	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>)
124	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
125	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
126		186
127	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
128	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
129	(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
130	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
131	isn't finished).	191	isn't finished).
132		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
133	=item read_size => <bytes>	219	=item read_size => <bytes>
134		220
135	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
136	on each [loop iteration). Default: C<4096>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
137		224
138	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
139		226
140	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
141	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
142	considered empty.	229	considered empty.
143		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
144	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
145		257
146	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
147	will start making tls handshake and will transparently encrypt/decrypt	259	AnyEvent will start a TLS handshake as soon as the conenction has been
148	data.	260	established and will transparently encrypt/decrypt data afterwards.
149		261
150	For the TLS server side, use C<accept>, and for the TLS client side of a	262	All TLS protocol errors will be signalled as C<EPROTO>, with an
151	connection, use C<connect> mode.	263	appropriate error message.
		264
		265	TLS mode requires Net::SSLeay to be installed (it will be loaded
		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.
		269
		270	Unlike TCP, TLS has a server and client side: for the TLS server side, use
		271	C<accept>, and for the TLS client side of a connection, use C<connect>
		272	mode.
152		273
153	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
154	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>
155	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
156	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
157		279
158	=item tls_ctx => $ssl_ctx	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.
159		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
		289	See the C<< ->starttls >> method for when need to start TLS negotiation later.
		290
		291	=item tls_ctx => $anyevent_tls
		292
160	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
161	(unless a connection object was specified directly). If this parameter is	294	(unless a connection object was specified directly). If this parameter is
162	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
163		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
		323	=item json => JSON or JSON::XS object
		324
		325	This is the json coder object used by the C<json> read and write types.
		326
		327	If you don't supply it, then AnyEvent::Handle will create and use a
		328	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		329	texts.
		330
		331	Note that you are responsible to depend on the JSON module if you want to
		332	use this functionality, as AnyEvent does not have a dependency itself.
		333
164	=back	334	=back
165		335
166	=cut	336	=cut
167		337
168	sub new {	338	sub new {
169	my $class = shift;	339	my $class = shift;
170
171	my $self = bless { @_ }, $class;	340	my $self = bless { @_ }, $class;
172		341
173	$self->{fh} or Carp::croak "mandatory argument fh is missing";	342	$self->{fh} or Carp::croak "mandatory argument fh is missing";
174		343
175	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	344	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
176		345
177	if ($self->{tls}) {	346	$self->{_activity} = AnyEvent->now;
178	require Net::SSLeay;	347	$self->_timeout;
		348
		349	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		350
179	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	351	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
180	}	352	if $self->{tls};
181		353
182	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
183	$self->on_error (delete $self->{on_error}) if $self->{on_error};
184	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	354	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
185	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
186		355
187	$self->start_read;	356	$self->start_read
		357	if $self->{on_read};
188		358
189	$self	359	$self->{fh} && $self
190	}	360	}
191		361
192	sub _shutdown {	362	sub _shutdown {
193	my ($self) = @_;	363	my ($self) = @_;
194		364
195	delete $self->{rw};	365	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
196	delete $self->{ww};	366	$self->{_eof} = 1; # tell starttls et. al to stop trying
197	delete $self->{fh};
198	}
199		367
		368	&_freetls;
		369	}
		370
200	sub error {	371	sub _error {
201	my ($self) = @_;	372	my ($self, $errno, $fatal, $message) = @_;
202		373
203	{
204	local $!;
205	$self->_shutdown;	374	$self->_shutdown
206	}	375	if $fatal;
		376
		377	$! = $errno;
		378	$message ||= "$!";
207		379
208	if ($self->{on_error}) {	380	if ($self->{on_error}) {
209	$self->{on_error}($self);	381	$self->{on_error}($self, $fatal, $message);
210	} else {	382	} elsif ($self->{fh}) {
211	die "AnyEvent::Handle uncaught fatal error: $!";	383	Carp::croak "AnyEvent::Handle uncaught error: $message";
212	}	384	}
213	}	385	}
214		386
215	=item $fh = $handle->fh	387	=item $fh = $handle->fh
216		388
217	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.
218		390
219	=cut	391	=cut
220		392
221	sub fh { $_[0]->{fh} }	393	sub fh { $_[0]{fh} }
222		394
223	=item $handle->on_error ($cb)	395	=item $handle->on_error ($cb)
224		396
225	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	397	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
226		398
…		…
238		410
239	sub on_eof {	411	sub on_eof {
240	$_[0]{on_eof} = $_[1];	412	$_[0]{on_eof} = $_[1];
241	}	413	}
242		414
		415	=item $handle->on_timeout ($cb)
		416
		417	Replace the current C<on_timeout> callback, or disables the callback (but
		418	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
		419	argument and method.
		420
		421	=cut
		422
		423	sub on_timeout {
		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];
		472	}
		473
		474	#############################################################################
		475
		476	=item $handle->timeout ($seconds)
		477
		478	Configures (or disables) the inactivity timeout.
		479
		480	=cut
		481
		482	sub timeout {
		483	my ($self, $timeout) = @_;
		484
		485	$self->{timeout} = $timeout;
		486	$self->_timeout;
		487	}
		488
		489	# reset the timeout watcher, as neccessary
		490	# also check for time-outs
		491	sub _timeout {
		492	my ($self) = @_;
		493
		494	if ($self->{timeout}) {
		495	my $NOW = AnyEvent->now;
		496
		497	# when would the timeout trigger?
		498	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		499
		500	# now or in the past already?
		501	if ($after <= 0) {
		502	$self->{_activity} = $NOW;
		503
		504	if ($self->{on_timeout}) {
		505	$self->{on_timeout}($self);
		506	} else {
		507	$self->_error (&Errno::ETIMEDOUT);
		508	}
		509
		510	# callback could have changed timeout value, optimise
		511	return unless $self->{timeout};
		512
		513	# calculate new after
		514	$after = $self->{timeout};
		515	}
		516
		517	Scalar::Util::weaken $self;
		518	return unless $self; # ->error could have destroyed $self
		519
		520	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		521	delete $self->{_tw};
		522	$self->_timeout;
		523	});
		524	} else {
		525	delete $self->{_tw};
		526	}
		527	}
		528
243	#############################################################################	529	#############################################################################
244		530
245	=back	531	=back
246		532
247	=head2 WRITE QUEUE	533	=head2 WRITE QUEUE
…		…
268	my ($self, $cb) = @_;	554	my ($self, $cb) = @_;
269		555
270	$self->{on_drain} = $cb;	556	$self->{on_drain} = $cb;
271		557
272	$cb->($self)	558	$cb->($self)
273	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	559	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
274	}	560	}
275		561
276	=item $handle->push_write ($data)	562	=item $handle->push_write ($data)
277		563
278	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
…		…
282	=cut	568	=cut
283		569
284	sub _drain_wbuf {	570	sub _drain_wbuf {
285	my ($self) = @_;	571	my ($self) = @_;
286		572
287	unless ($self->{ww}) {	573	if (!$self->{_ww} && length $self->{wbuf}) {
		574
288	Scalar::Util::weaken $self;	575	Scalar::Util::weaken $self;
		576
289	my $cb = sub {	577	my $cb = sub {
290	my $len = syswrite $self->{fh}, $self->{wbuf};	578	my $len = syswrite $self->{fh}, $self->{wbuf};
291		579
292	if ($len > 0) {	580	if ($len >= 0) {
293	substr $self->{wbuf}, 0, $len, "";	581	substr $self->{wbuf}, 0, $len, "";
294		582
		583	$self->{_activity} = AnyEvent->now;
		584
295	$self->{on_drain}($self)	585	$self->{on_drain}($self)
296	if $self->{low_water_mark} >= length $self->{wbuf}	586	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
297	&& $self->{on_drain};	587	&& $self->{on_drain};
298		588
299	delete $self->{ww} unless length $self->{wbuf};	589	delete $self->{_ww} unless length $self->{wbuf};
300	} elsif ($! != EAGAIN && $! != EINTR) {	590	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
301	$self->error;	591	$self->_error ($!, 1);
302	}	592	}
303	};	593	};
304		594
		595	# try to write data immediately
		596	$cb->() unless $self->{autocork};
		597
		598	# if still data left in wbuf, we need to poll
305	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	599	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
306		600	if length $self->{wbuf};
307	$cb->($self);
308	};	601	};
		602	}
		603
		604	our %WH;
		605
		606	sub register_write_type($$) {
		607	$WH{$_[0]} = $_[1];
309	}	608	}
310		609
311	sub push_write {	610	sub push_write {
312	my $self = shift;	611	my $self = shift;
313		612
		613	if (@_ > 1) {
		614	my $type = shift;
		615
		616	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		617	->($self, @_);
		618	}
		619
314	if ($self->{filter_w}) {	620	if ($self->{tls}) {
315	$self->{filter_w}->($self, \$_[0]);	621	$self->{_tls_wbuf} .= $_[0];
		622
		623	&_dotls ($self);
316	} else {	624	} else {
317	$self->{wbuf} .= $_[0];	625	$self->{wbuf} .= $_[0];
318	$self->_drain_wbuf;	626	$self->_drain_wbuf;
319	}	627	}
320	}	628	}
321		629
		630	=item $handle->push_write (type => @args)
		631
		632	Instead of formatting your data yourself, you can also let this module do
		633	the job by specifying a type and type-specific arguments.
		634
		635	Predefined types are (if you have ideas for additional types, feel free to
		636	drop by and tell us):
		637
		638	=over 4
		639
		640	=item netstring => $string
		641
		642	Formats the given value as netstring
		643	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		644
		645	=cut
		646
		647	register_write_type netstring => sub {
		648	my ($self, $string) = @_;
		649
		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
		666	};
		667
		668	=item json => $array_or_hashref
		669
		670	Encodes the given hash or array reference into a JSON object. Unless you
		671	provide your own JSON object, this means it will be encoded to JSON text
		672	in UTF-8.
		673
		674	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		675	one end of a handle and read them at the other end without using any
		676	additional framing.
		677
		678	The generated JSON text is guaranteed not to contain any newlines: While
		679	this module doesn't need delimiters after or between JSON texts to be
		680	able to read them, many other languages depend on that.
		681
		682	A simple RPC protocol that interoperates easily with others is to send
		683	JSON arrays (or objects, although arrays are usually the better choice as
		684	they mimic how function argument passing works) and a newline after each
		685	JSON text:
		686
		687	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		688	$handle->push_write ("\012");
		689
		690	An AnyEvent::Handle receiver would simply use the C<json> read type and
		691	rely on the fact that the newline will be skipped as leading whitespace:
		692
		693	$handle->push_read (json => sub { my $array = $_[1]; ... });
		694
		695	Other languages could read single lines terminated by a newline and pass
		696	this line into their JSON decoder of choice.
		697
		698	=cut
		699
		700	register_write_type json => sub {
		701	my ($self, $ref) = @_;
		702
		703	require JSON;
		704
		705	$self->{json} ? $self->{json}->encode ($ref)
		706	: JSON::encode_json ($ref)
		707	};
		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
		751	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		752
		753	This function (not method) lets you add your own types to C<push_write>.
		754	Whenever the given C<type> is used, C<push_write> will invoke the code
		755	reference with the handle object and the remaining arguments.
		756
		757	The code reference is supposed to return a single octet string that will
		758	be appended to the write buffer.
		759
		760	Note that this is a function, and all types registered this way will be
		761	global, so try to use unique names.
		762
		763	=cut
		764
322	#############################################################################	765	#############################################################################
323		766
324	=back	767	=back
325		768
326	=head2 READ QUEUE	769	=head2 READ QUEUE
…		…
332	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
333	a queue.	776	a queue.
334		777
335	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
336	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
337	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
338	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).
339		783
340	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
341	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
342	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
343	below).	787	done its job (see C<push_read>, below).
344		788
345	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
346	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.
347		791
348	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
349	the specified number of bytes which give an XML datagram.	793	the specified number of bytes which give an XML datagram.
350		794
351	# in the default state, expect some header bytes	795	# in the default state, expect some header bytes
352	$handle->on_read (sub {	796	$handle->on_read (sub {
353	# 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)
354	shift->unshift_read_chunk (4, sub {	798	shift->unshift_read (chunk => 4, sub {
355	# header arrived, decode	799	# header arrived, decode
356	my $len = unpack "N", $_[1];	800	my $len = unpack "N", $_[1];
357		801
358	# now read the payload	802	# now read the payload
359	shift->unshift_read_chunk ($len, sub {	803	shift->unshift_read (chunk => $len, sub {
360	my $xml = $_[1];	804	my $xml = $_[1];
361	# handle xml	805	# handle xml
362	});	806	});
363	});	807	});
364	});	808	});
365		809
366	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"
367	"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
368	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
369	pipeline sending both requests and manipulate the queue as necessary in	813	just pipeline sending both requests and manipulate the queue as necessary
370	the callbacks:	814	in the callbacks.
371		815
372	# 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"
373	$handle->push_write ("request 1\015\012");	821	$handle->push_write ("request 1\015\012");
374		822
375	# 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
376	$handle->push_read_line (sub {	824	$handle->push_read (line => sub {
377	# if we got an "OK", we have to _prepend_ another line,	825	# if we got an "OK", we have to _prepend_ another line,
378	# 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
379	# which are already in the queue when this callback is called	827	# which are already in the queue when this callback is called
380	# we don't do this in case we got an error	828	# we don't do this in case we got an error
381	if ($_[1] eq "OK") {	829	if ($_[1] eq "OK") {
382	$_[0]->unshift_read_line (sub {	830	$_[0]->unshift_read (line => sub {
383	my $response = $_[1];	831	my $response = $_[1];
384	...	832	...
385	});	833	});
386	}	834	}
387	});	835	});
388		836
389	# request two	837	# request two, simply returns 64 octets
390	$handle->push_write ("request 2\015\012");	838	$handle->push_write ("request 2\015\012");
391		839
392	# simply read 64 bytes, always	840	# simply read 64 bytes, always
393	$handle->push_read_chunk (64, sub {	841	$handle->push_read (chunk => 64, sub {
394	my $response = $_[1];	842	my $response = $_[1];
395	...	843	...
396	});	844	});
397		845
398	=over 4	846	=over 4
399		847
400	=cut	848	=cut
401		849
402	sub _drain_rbuf {	850	sub _drain_rbuf {
403	my ($self) = @_;	851	my ($self) = @_;
		852
		853	local $self->{_in_drain} = 1;
404		854
405	if (	855	if (
406	defined $self->{rbuf_max}	856	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	857	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	858	) {
409	$! = &Errno::ENOSPC; return $self->error;	859	$self->_error (&Errno::ENOSPC, 1), return;
410	}	860	}
411		861
412	return if $self->{in_drain};	862	while () {
413	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};
414		866
415	while (my $len = length $self->{rbuf}) {	867	my $len = length $self->{rbuf};
416	no strict 'refs';	868
417	if (my $cb = shift @{ $self->{queue} }) {	869	if (my $cb = shift @{ $self->{_queue} }) {
418	if (!$cb->($self)) {	870	unless ($cb->($self)) {
419	if ($self->{eof}) {	871	if ($self->{_eof}) {
420	# 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)
421	$! = &Errno::EPIPE; return $self->error;	873	$self->_error (&Errno::EPIPE, 1), return;
422	}	874	}
423		875
424	unshift @{ $self->{queue} }, $cb;	876	unshift @{ $self->{_queue} }, $cb;
425	return;	877	last;
426	}	878	}
427	} elsif ($self->{on_read}) {	879	} elsif ($self->{on_read}) {
		880	last unless $len;
		881
428	$self->{on_read}($self);	882	$self->{on_read}($self);
429		883
430	if (	884	if (
431	$self->{eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed	885	$len == length $self->{rbuf} # if no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty	886	&& !@{ $self->{_queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data	887	&& $self->{on_read} # but we still have on_read
435	) {	888	) {
		889	# no further data will arrive
436	# then no progress can be made	890	# so no progress can be made
437	$! = &Errno::EPIPE; return $self->error;	891	$self->_error (&Errno::EPIPE, 1), return
		892	if $self->{_eof};
		893
		894	last; # more data might arrive
438	}	895	}
439	} else {	896	} else {
440	# read side becomes idle	897	# read side becomes idle
441	delete $self->{rw};	898	delete $self->{_rw} unless $self->{tls};
442	return;	899	last;
443	}	900	}
444	}	901	}
445		902
446	if ($self->{eof}) {	903	if ($self->{_eof}) {
447	$self->_shutdown;	904	if ($self->{on_eof}) {
448	$self->{on_eof}($self)	905	$self->{on_eof}($self)
449	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} };
450	}	915	}
451	}	916	}
452		917
453	=item $handle->on_read ($cb)	918	=item $handle->on_read ($cb)
454		919
…		…
460		925
461	sub on_read {	926	sub on_read {
462	my ($self, $cb) = @_;	927	my ($self, $cb) = @_;
463		928
464	$self->{on_read} = $cb;	929	$self->{on_read} = $cb;
		930	$self->_drain_rbuf if $cb && !$self->{_in_drain};
465	}	931	}
466		932
467	=item $handle->rbuf	933	=item $handle->rbuf
468		934
469	Returns the read buffer (as a modifiable lvalue).	935	Returns the read buffer (as a modifiable lvalue).
470		936
471	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} >>
472	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.
473		942
474	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>,
475	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
476	automatically manage the read buffer.	945	automatically manage the read buffer.
477		946
…		…
500	interested in (which can be none at all) and return a true value. After returning	969	interested in (which can be none at all) and return a true value. After returning
501	true, it will be removed from the queue.	970	true, it will be removed from the queue.
502		971
503	=cut	972	=cut
504		973
		974	our %RH;
		975
		976	sub register_read_type($$) {
		977	$RH{$_[0]} = $_[1];
		978	}
		979
505	sub push_read {	980	sub push_read {
506	my ($self, $cb) = @_;	981	my $self = shift;
		982	my $cb = pop;
507		983
		984	if (@_) {
		985	my $type = shift;
		986
		987	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		988	->($self, $cb, @_);
		989	}
		990
508	push @{ $self->{queue} }, $cb;	991	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	992	$self->_drain_rbuf unless $self->{_in_drain};
510	}	993	}
511		994
512	sub unshift_read {	995	sub unshift_read {
513	my ($self, $cb) = @_;	996	my $self = shift;
		997	my $cb = pop;
514		998
		999	if (@_) {
		1000	my $type = shift;
		1001
		1002	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		1003	->($self, $cb, @_);
		1004	}
		1005
		1006
515	push @{ $self->{queue} }, $cb;	1007	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	1008	$self->_drain_rbuf unless $self->{_in_drain};
517	}	1009	}
518		1010
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	1011	=item $handle->push_read (type => @args, $cb)
520		1012
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	1013	=item $handle->unshift_read (type => @args, $cb)
522		1014
523	Append the given callback to the end of the queue (C<push_read_chunk>) or	1015	Instead of providing a callback that parses the data itself you can chose
524	prepend it (C<unshift_read_chunk>).	1016	between a number of predefined parsing formats, for chunks of data, lines
		1017	etc.
525		1018
526	The callback will be called only once C<$len> bytes have been read, and	1019	Predefined types are (if you have ideas for additional types, feel free to
527	these C<$len> bytes will be passed to the callback.	1020	drop by and tell us):
528		1021
529	=cut	1022	=over 4
530		1023
531	sub _read_chunk($$) {	1024	=item chunk => $octets, $cb->($handle, $data)
		1025
		1026	Invoke the callback only once C<$octets> bytes have been read. Pass the
		1027	data read to the callback. The callback will never be called with less
		1028	data.
		1029
		1030	Example: read 2 bytes.
		1031
		1032	$handle->push_read (chunk => 2, sub {
		1033	warn "yay ", unpack "H*", $_[1];
		1034	});
		1035
		1036	=cut
		1037
		1038	register_read_type chunk => sub {
532	my ($self, $len, $cb) = @_;	1039	my ($self, $cb, $len) = @_;
533		1040
534	sub {	1041	sub {
535	$len <= length $_[0]{rbuf} or return;	1042	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1043	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	1044	1
538	}	1045	}
539	}	1046	};
540		1047
541	sub push_read_chunk {	1048	=item line => [$eol, ]$cb->($handle, $line, $eol)
542	$_[0]->push_read (&_read_chunk);
543	}
544
545
546	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);
548	}
549
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))
551
552	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
553
554	Append the given callback to the end of the queue (C<push_read_line>) or
555	prepend it (C<unshift_read_line>).
556		1049
557	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
558	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
559	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
560	the end of line marker as the third argument (C<$eol>).	1053	the end of line marker as the third argument (C<$eol>).
…		…
571	Partial lines at the end of the stream will never be returned, as they are	1064	Partial lines at the end of the stream will never be returned, as they are
572	not marked by the end of line marker.	1065	not marked by the end of line marker.
573		1066
574	=cut	1067	=cut
575		1068
576	sub _read_line($$) {	1069	register_read_type line => sub {
577	my $self = shift;	1070	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr|(\015?\012)|;
580	my $pos;
581		1071
		1072	if (@_ < 3) {
		1073	# this is more than twice as fast as the generic code below
		1074	sub {
		1075	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1076
		1077	$cb->($_[0], $1, $2);
		1078	1
		1079	}
		1080	} else {
582	$eol = quotemeta $eol unless ref $eol;	1081	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr|^(.*?)($eol)|s;	1082	$eol = qr|^(.*?)($eol)|s;
		1083
		1084	sub {
		1085	$_[0]{rbuf} =~ s/$eol// or return;
		1086
		1087	$cb->($_[0], $1, $2);
		1088	1
		1089	}
		1090	}
		1091	};
		1092
		1093	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		1094
		1095	Makes a regex match against the regex object C<$accept> and returns
		1096	everything up to and including the match.
		1097
		1098	Example: read a single line terminated by '\n'.
		1099
		1100	$handle->push_read (regex => qr<\n>, sub { ... });
		1101
		1102	If C<$reject> is given and not undef, then it determines when the data is
		1103	to be rejected: it is matched against the data when the C<$accept> regex
		1104	does not match and generates an C<EBADMSG> error when it matches. This is
		1105	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		1106	receive buffer overflow).
		1107
		1108	Example: expect a single decimal number followed by whitespace, reject
		1109	anything else (not the use of an anchor).
		1110
		1111	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		1112
		1113	If C<$skip> is given and not C<undef>, then it will be matched against
		1114	the receive buffer when neither C<$accept> nor C<$reject> match,
		1115	and everything preceding and including the match will be accepted
		1116	unconditionally. This is useful to skip large amounts of data that you
		1117	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		1118	have to start matching from the beginning. This is purely an optimisation
		1119	and is usually worth only when you expect more than a few kilobytes.
		1120
		1121	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		1122	expect the header to be very large (it isn't in practise, but...), we use
		1123	a skip regex to skip initial portions. The skip regex is tricky in that
		1124	it only accepts something not ending in either \015 or \012, as these are
		1125	required for the accept regex.
		1126
		1127	$handle->push_read (regex =>
		1128	qr<\015\012\015\012>,
		1129	undef, # no reject
		1130	qr<^.*[^\015\012]>,
		1131	sub { ... });
		1132
		1133	=cut
		1134
		1135	register_read_type regex => sub {
		1136	my ($self, $cb, $accept, $reject, $skip) = @_;
		1137
		1138	my $data;
		1139	my $rbuf = \$self->{rbuf};
584		1140
585	sub {	1141	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	1142	# accept
		1143	if ($$rbuf =~ $accept) {
		1144	$data .= substr $$rbuf, 0, $+[0], "";
		1145	$cb->($self, $data);
		1146	return 1;
		1147	}
		1148
		1149	# reject
		1150	if ($reject && $$rbuf =~ $reject) {
		1151	$self->_error (&Errno::EBADMSG);
		1152	}
587		1153
588	$cb->($_[0], $1, $2);	1154	# skip
		1155	if ($skip && $$rbuf =~ $skip) {
		1156	$data .= substr $$rbuf, 0, $+[0], "";
		1157	}
		1158
		1159	()
		1160	}
		1161	};
		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
589	1	1195	1
590	}	1196	}
591	}	1197	};
592		1198
593	sub push_read_line {	1199	=item packstring => $format, $cb->($handle, $string)
594	$_[0]->push_read (&_read_line);
595	}
596		1200
597	sub unshift_read_line {	1201	An octet string prefixed with an encoded length. The encoding C<$format>
598	$_[0]->unshift_read (&_read_line);	1202	uses the same format as a Perl C<pack> format, but must specify a single
599	}	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
		1245	=item json => $cb->($handle, $hash_or_arrayref)
		1246
		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.
		1249
		1250	If a C<json> object was passed to the constructor, then that will be used
		1251	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1252
		1253	This read type uses the incremental parser available with JSON version
		1254	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1255	dependency on your own: this module will load the JSON module, but
		1256	AnyEvent does not depend on it itself.
		1257
		1258	Since JSON texts are fully self-delimiting, the C<json> read and write
		1259	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1260	the C<json> write type description, above, for an actual example.
		1261
		1262	=cut
		1263
		1264	register_read_type json => sub {
		1265	my ($self, $cb) = @_;
		1266
		1267	my $json = $self->{json} ||=
		1268	eval { require JSON::XS; JSON::XS->new->utf8 }
		1269	|| do { require JSON; JSON->new->utf8 };
		1270
		1271	my $data;
		1272	my $rbuf = \$self->{rbuf};
		1273
		1274	sub {
		1275	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
		1276
		1277	if ($ref) {
		1278	$self->{rbuf} = $json->incr_text;
		1279	$json->incr_text = "";
		1280	$cb->($self, $ref);
		1281
		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	()
		1293	} else {
		1294	$self->{rbuf} = "";
		1295
		1296	()
		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
		1343	}
		1344	};
		1345
		1346	=back
		1347
		1348	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1349
		1350	This function (not method) lets you add your own types to C<push_read>.
		1351
		1352	Whenever the given C<type> is used, C<push_read> will invoke the code
		1353	reference with the handle object, the callback and the remaining
		1354	arguments.
		1355
		1356	The code reference is supposed to return a callback (usually a closure)
		1357	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1358
		1359	It should invoke the passed callback when it is done reading (remember to
		1360	pass C<$handle> as first argument as all other callbacks do that).
		1361
		1362	Note that this is a function, and all types registered this way will be
		1363	global, so try to use unique names.
		1364
		1365	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1366	search for C<register_read_type>)).
600		1367
601	=item $handle->stop_read	1368	=item $handle->stop_read
602		1369
603	=item $handle->start_read	1370	=item $handle->start_read
604		1371
605	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
606	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
607	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
608	C<start_read>.	1375	C<start_read>.
609		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
610	=cut	1385	=cut
611		1386
612	sub stop_read {	1387	sub stop_read {
613	my ($self) = @_;	1388	my ($self) = @_;
614		1389
615	delete $self->{rw};	1390	delete $self->{_rw} unless $self->{tls};
616	}	1391	}
617		1392
618	sub start_read {	1393	sub start_read {
619	my ($self) = @_;	1394	my ($self) = @_;
620		1395
621	unless ($self->{rw} || $self->{eof}) {	1396	unless ($self->{_rw} || $self->{_eof}) {
622	Scalar::Util::weaken $self;	1397	Scalar::Util::weaken $self;
623		1398
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1399	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1400	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
626	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;
627		1402
628	if ($len > 0) {	1403	if ($len > 0) {
629	$self->{filter_r}	1404	$self->{_activity} = AnyEvent->now;
630	? $self->{filter_r}->($self, $rbuf)	1405
631	: $self->_drain_rbuf;	1406	if ($self->{tls}) {
		1407	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1408
		1409	&_dotls ($self);
		1410	} else {
		1411	$self->_drain_rbuf unless $self->{_in_drain};
		1412	}
632		1413
633	} elsif (defined $len) {	1414	} elsif (defined $len) {
634	delete $self->{rw};	1415	delete $self->{_rw};
635	$self->{eof} = 1;	1416	$self->{_eof} = 1;
636	$self->_drain_rbuf;	1417	$self->_drain_rbuf unless $self->{_in_drain};
637		1418
638	} elsif ($! != EAGAIN && $! != EINTR) {	1419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
639	return $self->error;	1420	return $self->_error ($!, 1);
640	}	1421	}
641	});	1422	});
642	}	1423	}
643	}	1424	}
644		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.
645	sub _dotls {	1448	sub _dotls {
646	my ($self) = @_;	1449	my ($self) = @_;
647		1450
		1451	my $tmp;
		1452
648	if (length $self->{tls_wbuf}) {	1453	if (length $self->{_tls_wbuf}) {
649	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1454	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "";	1455	substr $self->{_tls_wbuf}, 0, $tmp, "";
651	}	1456	}
652	}
653		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
654	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	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
		1487	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
655	$self->{wbuf} .= $buf;	1488	$self->{wbuf} .= $tmp;
656	$self->_drain_wbuf;	1489	$self->_drain_wbuf;
657	}	1490	}
658		1491
659	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1492	$self->{_on_starttls}
660	$self->{rbuf} .= $buf;	1493	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
661	$self->_drain_rbuf;	1494	and (delete $self->{_on_starttls})->($self, 1);
662	}
663
664	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
665
666	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
667	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
668	$self->error;
669	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
670	$! = &Errno::EIO;
671	$self->error;
672	}
673
674	# all others are fine for our purposes
675	}
676	}	1495	}
677		1496
678	# TODO: maybe document...	1497	=item $handle->starttls ($tls[, $tls_ctx])
		1498
		1499	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		1500	object is created, you can also do that at a later time by calling
		1501	C<starttls>.
		1502
		1503	The first argument is the same as the C<tls> constructor argument (either
		1504	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1505
		1506	The second argument is the optional C<AnyEvent::TLS> object that is used
		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.
		1510
		1511	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
		1512	context in C<< $handle->{tls_ctx} >> after this call and can be used or
		1513	changed to your liking. Note that the handshake might have already started
		1514	when this function returns.
		1515
		1516	If it an error to start a TLS handshake more than once per
		1517	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1518
		1519	=cut
		1520
		1521	our %TLS_CACHE; #TODO not yet documented, should we?
		1522
679	sub starttls {	1523	sub starttls {
680	my ($self, $ssl, $ctx) = @_;	1524	my ($self, $ssl, $ctx) = @_;
681		1525
682	if ($ssl eq "accept") {	1526	require Net::SSLeay;
683	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1527
684	Net::SSLeay::set_accept_state ($ssl);	1528	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
685	} elsif ($ssl eq "connect") {	1529	if $self->{tls};
686	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1530
687	Net::SSLeay::set_connect_state ($ssl);	1531	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1532	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		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	}
688	}	1548
689		1549	$self->{tls_ctx} = $ctx || TLS_CTX ();
690	$self->{tls} = $ssl;	1550	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
691		1551
692	# 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)
693	# but the openssl maintainers basically said: "trust us, it just works".	1553	# but the openssl maintainers basically said: "trust us, it just works".
694	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1554	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
695	# and mismaintained ssleay-module doesn't even offer them).	1555	# and mismaintained ssleay-module doesn't even offer them).
		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.
696	Net::SSLeay::CTX_set_mode ($self->{tls},	1564	# Net::SSLeay::CTX_set_mode ($ssl,
697	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1565	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
698	| (eval { 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);
699		1568
700	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1569	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
701	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1570	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
702		1571
703	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1572	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
704		1573
705	$self->{filter_w} = sub {	1574	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
706	$_[0]{tls_wbuf} .= ${$_[1]};	1575	if exists $self->{on_starttls};
		1576
		1577	&_dotls; # need to trigger the initial handshake
		1578	$self->start_read; # make sure we actually do read
		1579	}
		1580
		1581	=item $handle->stoptls
		1582
		1583	Shuts down the SSL connection - this makes a proper EOF handshake by
		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.
		1587
		1588	=cut
		1589
		1590	sub stoptls {
		1591	my ($self) = @_;
		1592
		1593	if ($self->{tls}) {
		1594	Net::SSLeay::shutdown ($self->{tls});
		1595
707	&_dotls;	1596	&_dotls;
		1597
		1598	# # we don't give a shit. no, we do, but we can't. no...#d#
		1599	# # we, we... have to use openssl :/#d#
		1600	# &_freetls;#d#
708	};	1601	}
709	$self->{filter_r} = sub {	1602	}
710	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1603
711	&_dotls;	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});
712	};	1613
		1614	delete @$self{qw(_rbio _wbio _tls_wbuf)};
713	}	1615	}
714		1616
715	sub DESTROY {	1617	sub DESTROY {
716	my $self = shift;	1618	my ($self) = @_;
717		1619
718	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	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 = ();
719	}	1668	}
720		1669
721	=item AnyEvent::Handle::TLS_CTX	1670	=item AnyEvent::Handle::TLS_CTX
722		1671
723	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
724	default for TLS mode.	1673	for TLS mode.
725		1674
726	The context is created like this:	1675	The context is created by calling L<AnyEvent::TLS> without any arguments.
727
728	Net::SSLeay::load_error_strings;
729	Net::SSLeay::SSLeay_add_ssl_algorithms;
730	Net::SSLeay::randomize;
731
732	my $CTX = Net::SSLeay::CTX_new;
733
734	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
735		1676
736	=cut	1677	=cut
737		1678
738	our $TLS_CTX;	1679	our $TLS_CTX;
739		1680
740	sub TLS_CTX() {	1681	sub TLS_CTX() {
741	$TLS_CTX || do {	1682	$TLS_CTX ||= do {
742	require Net::SSLeay;	1683	require AnyEvent::TLS;
743		1684
744	Net::SSLeay::load_error_strings ();	1685	new AnyEvent::TLS
745	Net::SSLeay::SSLeay_add_ssl_algorithms ();
746	Net::SSLeay::randomize ();
747
748	$TLS_CTX = Net::SSLeay::CTX_new ();
749
750	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
751
752	$TLS_CTX
753	}	1686	}
754	}	1687	}
755		1688
756	=back	1689	=back
757		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
		1762
		1763	=head1 SUBCLASSING AnyEvent::Handle
		1764
		1765	In many cases, you might want to subclass AnyEvent::Handle.
		1766
		1767	To make this easier, a given version of AnyEvent::Handle uses these
		1768	conventions:
		1769
		1770	=over 4
		1771
		1772	=item * all constructor arguments become object members.
		1773
		1774	At least initially, when you pass a C<tls>-argument to the constructor it
		1775	will end up in C<< $handle->{tls} >>. Those members might be changed or
		1776	mutated later on (for example C<tls> will hold the TLS connection object).
		1777
		1778	=item * other object member names are prefixed with an C<_>.
		1779
		1780	All object members not explicitly documented (internal use) are prefixed
		1781	with an underscore character, so the remaining non-C<_>-namespace is free
		1782	for use for subclasses.
		1783
		1784	=item * all members not documented here and not prefixed with an underscore
		1785	are free to use in subclasses.
		1786
		1787	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1788	member variables, but thats just life, at least it is documented.
		1789
		1790	=back
		1791
758	=head1 AUTHOR	1792	=head1 AUTHOR
759		1793
760	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1794	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
761		1795
762	=cut	1796	=cut

Diff Legend

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