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.33 by root, Sun May 25 03:03:51 2008 UTC vs.
Revision 1.149 by root, Thu Jul 16 03:48:33 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(WSAWOULDBLOCK);	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	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	19	our $VERSION = 4.82;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $handle =	28	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	29	fh => \*STDIN,
31	on_eof => sub {	30	on_error => sub {
32	$cv->broadcast;	31	warn "got error $_[2]\n";
33	},	32	$cv->send;
34	);	33	);
35		34
36	# send some request line	35	# send some request line
37	$handle->push_write ("getinfo\015\012");	36	$hdl->push_write ("getinfo\015\012");
38		37
39	# read the response line	38	# read the response line
40	$handle->push_read (line => sub {	39	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	40	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	41	warn "got line <$line>\n";
43	$cv->send;	42	$cv->send;
44	});	43	});
45		44
46	$cv->recv;	45	$cv->recv;
47		46
…		…
49		48
50	This module is a helper module to make it easier to do event-based I/O on	49	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	50	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	51	on sockets see L<AnyEvent::Util>.
53		52
		53	The L<AnyEvent::Intro> tutorial contains some well-documented
		54	AnyEvent::Handle examples.
		55
54	In the following, when the documentation refers to of "bytes" then this	56	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	57	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	58	treatment of characters applies to this module as well.
57		59
58	All callbacks will be invoked with the handle object as their first	60	All callbacks will be invoked with the handle object as their first
…		…
60		62
61	=head1 METHODS	63	=head1 METHODS
62		64
63	=over 4	65	=over 4
64		66
65	=item B<new (%args)>	67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		68
67	The constructor supports these arguments (all as key => value pairs).	69	The constructor supports these arguments (all as C<< key => value >> pairs).
68		70
69	=over 4	71	=over 4
70		72
71	=item fh => $filehandle [MANDATORY]	73	=item fh => $filehandle [MANDATORY]
72		74
73	The filehandle this L<AnyEvent::Handle> object will operate on.	75	The filehandle this L<AnyEvent::Handle> object will operate on.
74		76
75	NOTE: The filehandle will be set to non-blocking (using	77	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		79	that mode.
77		80
78	=item on_eof => $cb->($self)	81	=item on_eof => $cb->($handle)
79		82
80	Set the callback to be called on EOF.	83	Set the callback to be called when an end-of-file condition is detected,
		84	i.e. in the case of a socket, when the other side has closed the
		85	connection cleanly.
81		86
		87	For sockets, this just means that the other side has stopped sending data,
		88	you can still try to write data, and, in fact, one can return from the EOF
		89	callback and continue writing data, as only the read part has been shut
		90	down.
		91
82	While not mandatory, it is highly recommended to set an eof callback,	92	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	93	otherwise you might end up with a closed socket while you are still
84	waiting for data.	94	waiting for data.
85		95
86	=item on_error => $cb->($self)	96	If an EOF condition has been detected but no C<on_eof> callback has been
		97	set, then a fatal error will be raised with C<$!> set to <0>.
87		98
		99	=item on_error => $cb->($handle, $fatal, $message)
		100
88	This is the fatal error callback, that is called when, well, a fatal error	101	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	102	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	103	connect or a read error.
91		104
92	The object will not be in a usable state when this callback has been	105	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	106	fatal errors the handle object will be destroyed (by a call to C<< ->
		107	destroy >>) after invoking the error callback (which means you are free to
		108	examine the handle object). Examples of fatal errors are an EOF condition
		109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		110
		111	AnyEvent::Handle tries to find an appropriate error code for you to check
		112	against, but in some cases (TLS errors), this does not work well. It is
		113	recommended to always output the C<$message> argument in human-readable
		114	error messages (it's usually the same as C<"$!">).
		115
		116	Non-fatal errors can be retried by simply returning, but it is recommended
		117	to simply ignore this parameter and instead abondon the handle object
		118	when this callback is invoked. Examples of non-fatal errors are timeouts
		119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		120
95	On callback entrance, the value of C<$!> contains the operating system	121	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		123	C<EPROTO>).
97		124
98	While not mandatory, it is I<highly> recommended to set this callback, as	125	While not mandatory, it is I<highly> recommended to set this callback, as
99	you will not be notified of errors otherwise. The default simply calls	126	you will not be notified of errors otherwise. The default simply calls
100	die.	127	C<croak>.
101		128
102	=item on_read => $cb->($self)	129	=item on_read => $cb->($handle)
103		130
104	This sets the default read callback, which is called when data arrives	131	This sets the default read callback, which is called when data arrives
105	and no read request is in the queue.	132	and no read request is in the queue (unlike read queue callbacks, this
		133	callback will only be called when at least one octet of data is in the
		134	read buffer).
106		135
107	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
108	method or access the C<$self->{rbuf}> member directly.	137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		138	must not enlarge or modify the read buffer, you can only remove data at
		139	the beginning from it.
109		140
110	When an EOF condition is detected then AnyEvent::Handle will first try to	141	When an EOF condition is detected then AnyEvent::Handle will first try to
111	feed all the remaining data to the queued callbacks and C<on_read> before	142	feed all the remaining data to the queued callbacks and C<on_read> before
112	calling the C<on_eof> callback. If no progress can be made, then a fatal	143	calling the C<on_eof> callback. If no progress can be made, then a fatal
113	error will be raised (with C<$!> set to C<EPIPE>).	144	error will be raised (with C<$!> set to C<EPIPE>).
114		145
115	=item on_drain => $cb->()	146	=item on_drain => $cb->($handle)
116		147
117	This sets the callback that is called when the write buffer becomes empty	148	This sets the callback that is called when the write buffer becomes empty
118	(or when the callback is set and the buffer is empty already).	149	(or when the callback is set and the buffer is empty already).
119		150
120	To append to the write buffer, use the C<< ->push_write >> method.	151	To append to the write buffer, use the C<< ->push_write >> method.
121		152
		153	This callback is useful when you don't want to put all of your write data
		154	into the queue at once, for example, when you want to write the contents
		155	of some file to the socket you might not want to read the whole file into
		156	memory and push it into the queue, but instead only read more data from
		157	the file when the write queue becomes empty.
		158
		159	=item timeout => $fractional_seconds
		160
		161	If non-zero, then this enables an "inactivity" timeout: whenever this many
		162	seconds pass without a successful read or write on the underlying file
		163	handle, the C<on_timeout> callback will be invoked (and if that one is
		164	missing, a non-fatal C<ETIMEDOUT> error will be raised).
		165
		166	Note that timeout processing is also active when you currently do not have
		167	any outstanding read or write requests: If you plan to keep the connection
		168	idle then you should disable the timout temporarily or ignore the timeout
		169	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		170	restart the timeout.
		171
		172	Zero (the default) disables this timeout.
		173
		174	=item on_timeout => $cb->($handle)
		175
		176	Called whenever the inactivity timeout passes. If you return from this
		177	callback, then the timeout will be reset as if some activity had happened,
		178	so this condition is not fatal in any way.
		179
122	=item rbuf_max => <bytes>	180	=item rbuf_max => <bytes>
123		181
124	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	182	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
125	when the read buffer ever (strictly) exceeds this size. This is useful to	183	when the read buffer ever (strictly) exceeds this size. This is useful to
126	avoid denial-of-service attacks.	184	avoid some forms of denial-of-service attacks.
127		185
128	For example, a server accepting connections from untrusted sources should	186	For example, a server accepting connections from untrusted sources should
129	be configured to accept only so-and-so much data that it cannot act on	187	be configured to accept only so-and-so much data that it cannot act on
130	(for example, when expecting a line, an attacker could send an unlimited	188	(for example, when expecting a line, an attacker could send an unlimited
131	amount of data without a callback ever being called as long as the line	189	amount of data without a callback ever being called as long as the line
132	isn't finished).	190	isn't finished).
133		191
		192	=item autocork => <boolean>
		193
		194	When disabled (the default), then C<push_write> will try to immediately
		195	write the data to the handle, if possible. This avoids having to register
		196	a write watcher and wait for the next event loop iteration, but can
		197	be inefficient if you write multiple small chunks (on the wire, this
		198	disadvantage is usually avoided by your kernel's nagle algorithm, see
		199	C<no_delay>, but this option can save costly syscalls).
		200
		201	When enabled, then writes will always be queued till the next event loop
		202	iteration. This is efficient when you do many small writes per iteration,
		203	but less efficient when you do a single write only per iteration (or when
		204	the write buffer often is full). It also increases write latency.
		205
		206	=item no_delay => <boolean>
		207
		208	When doing small writes on sockets, your operating system kernel might
		209	wait a bit for more data before actually sending it out. This is called
		210	the Nagle algorithm, and usually it is beneficial.
		211
		212	In some situations you want as low a delay as possible, which can be
		213	accomplishd by setting this option to a true value.
		214
		215	The default is your opertaing system's default behaviour (most likely
		216	enabled), this option explicitly enables or disables it, if possible.
		217
134	=item read_size => <bytes>	218	=item read_size => <bytes>
135		219
136	The default read block size (the amount of bytes this module will try to read	220	The default read block size (the amount of bytes this module will
137	on each [loop iteration). Default: C<4096>.	221	try to read during each loop iteration, which affects memory
		222	requirements). Default: C<8192>.
138		223
139	=item low_water_mark => <bytes>	224	=item low_water_mark => <bytes>
140		225
141	Sets the amount of bytes (default: C<0>) that make up an "empty" write	226	Sets the amount of bytes (default: C<0>) that make up an "empty" write
142	buffer: If the write reaches this size or gets even samller it is	227	buffer: If the write reaches this size or gets even samller it is
143	considered empty.	228	considered empty.
144		229
		230	Sometimes it can be beneficial (for performance reasons) to add data to
		231	the write buffer before it is fully drained, but this is a rare case, as
		232	the operating system kernel usually buffers data as well, so the default
		233	is good in almost all cases.
		234
		235	=item linger => <seconds>
		236
		237	If non-zero (default: C<3600>), then the destructor of the
		238	AnyEvent::Handle object will check whether there is still outstanding
		239	write data and will install a watcher that will write this data to the
		240	socket. No errors will be reported (this mostly matches how the operating
		241	system treats outstanding data at socket close time).
		242
		243	This will not work for partial TLS data that could not be encoded
		244	yet. This data will be lost. Calling the C<stoptls> method in time might
		245	help.
		246
		247	=item peername => $string
		248
		249	A string used to identify the remote site - usually the DNS hostname
		250	(I<not> IDN!) used to create the connection, rarely the IP address.
		251
		252	Apart from being useful in error messages, this string is also used in TLS
		253	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		254	verification will be skipped when C<peername> is not specified or
		255	C<undef>.
		256
145	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	257	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
146		258
147	When this parameter is given, it enables TLS (SSL) mode, that means it	259	When this parameter is given, it enables TLS (SSL) mode, that means
148	will start making tls handshake and will transparently encrypt/decrypt	260	AnyEvent will start a TLS handshake as soon as the conenction has been
149	data.	261	established and will transparently encrypt/decrypt data afterwards.
		262
		263	All TLS protocol errors will be signalled as C<EPROTO>, with an
		264	appropriate error message.
150		265
151	TLS mode requires Net::SSLeay to be installed (it will be loaded	266	TLS mode requires Net::SSLeay to be installed (it will be loaded
152	automatically when you try to create a TLS handle).	267	automatically when you try to create a TLS handle): this module doesn't
		268	have a dependency on that module, so if your module requires it, you have
		269	to add the dependency yourself.
153		270
154	For the TLS server side, use C<accept>, and for the TLS client side of a	271	Unlike TCP, TLS has a server and client side: for the TLS server side, use
155	connection, use C<connect> mode.	272	C<accept>, and for the TLS client side of a connection, use C<connect>
		273	mode.
156		274
157	You can also provide your own TLS connection object, but you have	275	You can also provide your own TLS connection object, but you have
158	to make sure that you call either C<Net::SSLeay::set_connect_state>	276	to make sure that you call either C<Net::SSLeay::set_connect_state>
159	or C<Net::SSLeay::set_accept_state> on it before you pass it to	277	or C<Net::SSLeay::set_accept_state> on it before you pass it to
160	AnyEvent::Handle.	278	AnyEvent::Handle. Also, this module will take ownership of this connection
		279	object.
161		280
		281	At some future point, AnyEvent::Handle might switch to another TLS
		282	implementation, then the option to use your own session object will go
		283	away.
		284
		285	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		286	passing in the wrong integer will lead to certain crash. This most often
		287	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		288	segmentation fault.
		289
162	See the C<starttls> method if you need to start TLs negotiation later.	290	See the C<< ->starttls >> method for when need to start TLS negotiation later.
163		291
164	=item tls_ctx => $ssl_ctx	292	=item tls_ctx => $anyevent_tls
165		293
166	Use the given Net::SSLeay::CTX object to create the new TLS connection	294	Use the given C<AnyEvent::TLS> object to create the new TLS connection
167	(unless a connection object was specified directly). If this parameter is	295	(unless a connection object was specified directly). If this parameter is
168	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	296	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
169		297
		298	Instead of an object, you can also specify a hash reference with C<< key
		299	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		300	new TLS context object.
		301
		302	=item on_starttls => $cb->($handle, $success[, $error_message])
		303
		304	This callback will be invoked when the TLS/SSL handshake has finished. If
		305	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		306	(C<on_stoptls> will not be called in this case).
		307
		308	The session in C<< $handle->{tls} >> can still be examined in this
		309	callback, even when the handshake was not successful.
		310
		311	TLS handshake failures will not cause C<on_error> to be invoked when this
		312	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		313
		314	Without this callback, handshake failures lead to C<on_error> being
		315	called, as normal.
		316
		317	Note that you cannot call C<starttls> right again in this callback. If you
		318	need to do that, start an zero-second timer instead whose callback can
		319	then call C<< ->starttls >> again.
		320
		321	=item on_stoptls => $cb->($handle)
		322
		323	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		324	set, then it will be invoked after freeing the TLS session. If it is not,
		325	then a TLS shutdown condition will be treated like a normal EOF condition
		326	on the handle.
		327
		328	The session in C<< $handle->{tls} >> can still be examined in this
		329	callback.
		330
		331	This callback will only be called on TLS shutdowns, not when the
		332	underlying handle signals EOF.
		333
		334	=item json => JSON or JSON::XS object
		335
		336	This is the json coder object used by the C<json> read and write types.
		337
		338	If you don't supply it, then AnyEvent::Handle will create and use a
		339	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		340	texts.
		341
		342	Note that you are responsible to depend on the JSON module if you want to
		343	use this functionality, as AnyEvent does not have a dependency itself.
		344
170	=back	345	=back
171		346
172	=cut	347	=cut
173		348
174	sub new {	349	sub new {
175	my $class = shift;	350	my $class = shift;
176
177	my $self = bless { @_ }, $class;	351	my $self = bless { @_ }, $class;
178		352
179	$self->{fh} or Carp::croak "mandatory argument fh is missing";	353	$self->{fh} or Carp::croak "mandatory argument fh is missing";
180		354
181	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	355	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
182		356
183	if ($self->{tls}) {	357	$self->{_activity} = AnyEvent->now;
184	require Net::SSLeay;	358	$self->_timeout;
		359
		360	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		361
185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	362	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
186	}	363	if $self->{tls};
187		364
188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
189	$self->on_error (delete $self->{on_error}) if $self->{on_error};
190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	365	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
192		366
193	$self->start_read;	367	$self->start_read
		368	if $self->{on_read};
194		369
195	$self	370	$self->{fh} && $self
196	}	371	}
197		372
198	sub _shutdown {	373	#sub _shutdown {
199	my ($self) = @_;	374	# my ($self) = @_;
		375	#
		376	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
		377	# $self->{_eof} = 1; # tell starttls et. al to stop trying
		378	#
		379	# &_freetls;
		380	#}
200		381
201	delete $self->{rw};
202	delete $self->{ww};
203	delete $self->{fh};
204	}
205
206	sub error {	382	sub _error {
207	my ($self) = @_;	383	my ($self, $errno, $fatal, $message) = @_;
208		384
209	{	385	$! = $errno;
210	local $!;	386	$message ||= "$!";
211	$self->_shutdown;
212	}
213		387
214	if ($self->{on_error}) {	388	if ($self->{on_error}) {
215	$self->{on_error}($self);	389	$self->{on_error}($self, $fatal, $message);
216	} else {	390	$self->destroy;
		391	} elsif ($self->{fh}) {
		392	$self->destroy;
217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	393	Carp::croak "AnyEvent::Handle uncaught error: $message";
218	}	394	}
219	}	395	}
220		396
221	=item $fh = $handle->fh	397	=item $fh = $handle->fh
222		398
223	This method returns the file handle of the L<AnyEvent::Handle> object.	399	This method returns the file handle used to create the L<AnyEvent::Handle> object.
224		400
225	=cut	401	=cut
226		402
227	sub fh { $_[0]->{fh} }	403	sub fh { $_[0]{fh} }
228		404
229	=item $handle->on_error ($cb)	405	=item $handle->on_error ($cb)
230		406
231	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	407	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
232		408
…		…
244		420
245	sub on_eof {	421	sub on_eof {
246	$_[0]{on_eof} = $_[1];	422	$_[0]{on_eof} = $_[1];
247	}	423	}
248		424
		425	=item $handle->on_timeout ($cb)
		426
		427	Replace the current C<on_timeout> callback, or disables the callback (but
		428	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
		429	argument and method.
		430
		431	=cut
		432
		433	sub on_timeout {
		434	$_[0]{on_timeout} = $_[1];
		435	}
		436
		437	=item $handle->autocork ($boolean)
		438
		439	Enables or disables the current autocork behaviour (see C<autocork>
		440	constructor argument). Changes will only take effect on the next write.
		441
		442	=cut
		443
		444	sub autocork {
		445	$_[0]{autocork} = $_[1];
		446	}
		447
		448	=item $handle->no_delay ($boolean)
		449
		450	Enables or disables the C<no_delay> setting (see constructor argument of
		451	the same name for details).
		452
		453	=cut
		454
		455	sub no_delay {
		456	$_[0]{no_delay} = $_[1];
		457
		458	eval {
		459	local $SIG{__DIE__};
		460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		461	};
		462	}
		463
		464	=item $handle->on_starttls ($cb)
		465
		466	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		467
		468	=cut
		469
		470	sub on_starttls {
		471	$_[0]{on_starttls} = $_[1];
		472	}
		473
		474	=item $handle->on_stoptls ($cb)
		475
		476	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		477
		478	=cut
		479
		480	sub on_starttls {
		481	$_[0]{on_stoptls} = $_[1];
		482	}
		483
		484	#############################################################################
		485
		486	=item $handle->timeout ($seconds)
		487
		488	Configures (or disables) the inactivity timeout.
		489
		490	=cut
		491
		492	sub timeout {
		493	my ($self, $timeout) = @_;
		494
		495	$self->{timeout} = $timeout;
		496	$self->_timeout;
		497	}
		498
		499	# reset the timeout watcher, as neccessary
		500	# also check for time-outs
		501	sub _timeout {
		502	my ($self) = @_;
		503
		504	if ($self->{timeout}) {
		505	my $NOW = AnyEvent->now;
		506
		507	# when would the timeout trigger?
		508	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		509
		510	# now or in the past already?
		511	if ($after <= 0) {
		512	$self->{_activity} = $NOW;
		513
		514	if ($self->{on_timeout}) {
		515	$self->{on_timeout}($self);
		516	} else {
		517	$self->_error (&Errno::ETIMEDOUT);
		518	}
		519
		520	# callback could have changed timeout value, optimise
		521	return unless $self->{timeout};
		522
		523	# calculate new after
		524	$after = $self->{timeout};
		525	}
		526
		527	Scalar::Util::weaken $self;
		528	return unless $self; # ->error could have destroyed $self
		529
		530	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		531	delete $self->{_tw};
		532	$self->_timeout;
		533	});
		534	} else {
		535	delete $self->{_tw};
		536	}
		537	}
		538
249	#############################################################################	539	#############################################################################
250		540
251	=back	541	=back
252		542
253	=head2 WRITE QUEUE	543	=head2 WRITE QUEUE
…		…
274	my ($self, $cb) = @_;	564	my ($self, $cb) = @_;
275		565
276	$self->{on_drain} = $cb;	566	$self->{on_drain} = $cb;
277		567
278	$cb->($self)	568	$cb->($self)
279	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	569	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
280	}	570	}
281		571
282	=item $handle->push_write ($data)	572	=item $handle->push_write ($data)
283		573
284	Queues the given scalar to be written. You can push as much data as you	574	Queues the given scalar to be written. You can push as much data as you
…		…
288	=cut	578	=cut
289		579
290	sub _drain_wbuf {	580	sub _drain_wbuf {
291	my ($self) = @_;	581	my ($self) = @_;
292		582
293	if (!$self->{ww} && length $self->{wbuf}) {	583	if (!$self->{_ww} && length $self->{wbuf}) {
		584
294	Scalar::Util::weaken $self;	585	Scalar::Util::weaken $self;
		586
295	my $cb = sub {	587	my $cb = sub {
296	my $len = syswrite $self->{fh}, $self->{wbuf};	588	my $len = syswrite $self->{fh}, $self->{wbuf};
297		589
298	if ($len >= 0) {	590	if (defined $len) {
299	substr $self->{wbuf}, 0, $len, "";	591	substr $self->{wbuf}, 0, $len, "";
300		592
		593	$self->{_activity} = AnyEvent->now;
		594
301	$self->{on_drain}($self)	595	$self->{on_drain}($self)
302	if $self->{low_water_mark} >= length $self->{wbuf}	596	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
303	&& $self->{on_drain};	597	&& $self->{on_drain};
304		598
305	delete $self->{ww} unless length $self->{wbuf};	599	delete $self->{_ww} unless length $self->{wbuf};
306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	600	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
307	$self->error;	601	$self->_error ($!, 1);
308	}	602	}
309	};	603	};
310		604
		605	# try to write data immediately
		606	$cb->() unless $self->{autocork};
		607
		608	# if still data left in wbuf, we need to poll
311	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	609	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
312		610	if length $self->{wbuf};
313	$cb->($self);
314	};	611	};
315	}	612	}
316		613
317	our %WH;	614	our %WH;
318		615
…		…
328		625
329	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	626	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
330	->($self, @_);	627	->($self, @_);
331	}	628	}
332		629
333	if ($self->{filter_w}) {	630	if ($self->{tls}) {
334	$self->{filter_w}->($self, \$_[0]);	631	$self->{_tls_wbuf} .= $_[0];
		632
		633	&_dotls ($self);
335	} else {	634	} else {
336	$self->{wbuf} .= $_[0];	635	$self->{wbuf} .= $_[0];
337	$self->_drain_wbuf;	636	$self->_drain_wbuf;
338	}	637	}
339	}	638	}
340		639
341	=item $handle->push_write (type => @args)	640	=item $handle->push_write (type => @args)
342		641
343	=item $handle->unshift_write (type => @args)
344
345	Instead of formatting your data yourself, you can also let this module do	642	Instead of formatting your data yourself, you can also let this module do
346	the job by specifying a type and type-specific arguments.	643	the job by specifying a type and type-specific arguments.
347		644
348	Predefined types are (if you have ideas for additional types, feel free to	645	Predefined types are (if you have ideas for additional types, feel free to
349	drop by and tell us):	646	drop by and tell us):
…		…
353	=item netstring => $string	650	=item netstring => $string
354		651
355	Formats the given value as netstring	652	Formats the given value as netstring
356	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	653	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
357		654
358	=back
359
360	=cut	655	=cut
361		656
362	register_write_type netstring => sub {	657	register_write_type netstring => sub {
363	my ($self, $string) = @_;	658	my ($self, $string) = @_;
364		659
365	sprintf "%d:%s,", (length $string), $string	660	(length $string) . ":$string,"
366	};	661	};
367		662
		663	=item packstring => $format, $data
		664
		665	An octet string prefixed with an encoded length. The encoding C<$format>
		666	uses the same format as a Perl C<pack> format, but must specify a single
		667	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		668	optional C<!>, C<< < >> or C<< > >> modifier).
		669
		670	=cut
		671
		672	register_write_type packstring => sub {
		673	my ($self, $format, $string) = @_;
		674
		675	pack "$format/a*", $string
		676	};
		677
		678	=item json => $array_or_hashref
		679
		680	Encodes the given hash or array reference into a JSON object. Unless you
		681	provide your own JSON object, this means it will be encoded to JSON text
		682	in UTF-8.
		683
		684	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		685	one end of a handle and read them at the other end without using any
		686	additional framing.
		687
		688	The generated JSON text is guaranteed not to contain any newlines: While
		689	this module doesn't need delimiters after or between JSON texts to be
		690	able to read them, many other languages depend on that.
		691
		692	A simple RPC protocol that interoperates easily with others is to send
		693	JSON arrays (or objects, although arrays are usually the better choice as
		694	they mimic how function argument passing works) and a newline after each
		695	JSON text:
		696
		697	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		698	$handle->push_write ("\012");
		699
		700	An AnyEvent::Handle receiver would simply use the C<json> read type and
		701	rely on the fact that the newline will be skipped as leading whitespace:
		702
		703	$handle->push_read (json => sub { my $array = $_[1]; ... });
		704
		705	Other languages could read single lines terminated by a newline and pass
		706	this line into their JSON decoder of choice.
		707
		708	=cut
		709
		710	register_write_type json => sub {
		711	my ($self, $ref) = @_;
		712
		713	require JSON;
		714
		715	$self->{json} ? $self->{json}->encode ($ref)
		716	: JSON::encode_json ($ref)
		717	};
		718
		719	=item storable => $reference
		720
		721	Freezes the given reference using L<Storable> and writes it to the
		722	handle. Uses the C<nfreeze> format.
		723
		724	=cut
		725
		726	register_write_type storable => sub {
		727	my ($self, $ref) = @_;
		728
		729	require Storable;
		730
		731	pack "w/a*", Storable::nfreeze ($ref)
		732	};
		733
		734	=back
		735
		736	=item $handle->push_shutdown
		737
		738	Sometimes you know you want to close the socket after writing your data
		739	before it was actually written. One way to do that is to replace your
		740	C<on_drain> handler by a callback that shuts down the socket (and set
		741	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		742	replaces the C<on_drain> callback with:
		743
		744	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		745
		746	This simply shuts down the write side and signals an EOF condition to the
		747	the peer.
		748
		749	You can rely on the normal read queue and C<on_eof> handling
		750	afterwards. This is the cleanest way to close a connection.
		751
		752	=cut
		753
		754	sub push_shutdown {
		755	my ($self) = @_;
		756
		757	delete $self->{low_water_mark};
		758	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		759	}
		760
368	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	761	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
369		762
370	This function (not method) lets you add your own types to C<push_write>.	763	This function (not method) lets you add your own types to C<push_write>.
371	Whenever the given C<type> is used, C<push_write> will invoke the code	764	Whenever the given C<type> is used, C<push_write> will invoke the code
372	reference with the handle object and the remaining arguments.	765	reference with the handle object and the remaining arguments.
373		766
…		…
392	ways, the "simple" way, using only C<on_read> and the "complex" way, using	785	ways, the "simple" way, using only C<on_read> and the "complex" way, using
393	a queue.	786	a queue.
394		787
395	In the simple case, you just install an C<on_read> callback and whenever	788	In the simple case, you just install an C<on_read> callback and whenever
396	new data arrives, it will be called. You can then remove some data (if	789	new data arrives, it will be called. You can then remove some data (if
397	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	790	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
398	or not.	791	leave the data there if you want to accumulate more (e.g. when only a
		792	partial message has been received so far).
399		793
400	In the more complex case, you want to queue multiple callbacks. In this	794	In the more complex case, you want to queue multiple callbacks. In this
401	case, AnyEvent::Handle will call the first queued callback each time new	795	case, AnyEvent::Handle will call the first queued callback each time new
402	data arrives and removes it when it has done its job (see C<push_read>,	796	data arrives (also the first time it is queued) and removes it when it has
403	below).	797	done its job (see C<push_read>, below).
404		798
405	This way you can, for example, push three line-reads, followed by reading	799	This way you can, for example, push three line-reads, followed by reading
406	a chunk of data, and AnyEvent::Handle will execute them in order.	800	a chunk of data, and AnyEvent::Handle will execute them in order.
407		801
408	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	802	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
409	the specified number of bytes which give an XML datagram.	803	the specified number of bytes which give an XML datagram.
410		804
411	# in the default state, expect some header bytes	805	# in the default state, expect some header bytes
412	$handle->on_read (sub {	806	$handle->on_read (sub {
413	# some data is here, now queue the length-header-read (4 octets)	807	# some data is here, now queue the length-header-read (4 octets)
414	shift->unshift_read_chunk (4, sub {	808	shift->unshift_read (chunk => 4, sub {
415	# header arrived, decode	809	# header arrived, decode
416	my $len = unpack "N", $_[1];	810	my $len = unpack "N", $_[1];
417		811
418	# now read the payload	812	# now read the payload
419	shift->unshift_read_chunk ($len, sub {	813	shift->unshift_read (chunk => $len, sub {
420	my $xml = $_[1];	814	my $xml = $_[1];
421	# handle xml	815	# handle xml
422	});	816	});
423	});	817	});
424	});	818	});
425		819
426	Example 2: Implement a client for a protocol that replies either with	820	Example 2: Implement a client for a protocol that replies either with "OK"
427	"OK" and another line or "ERROR" for one request, and 64 bytes for the	821	and another line or "ERROR" for the first request that is sent, and 64
428	second request. Due tot he availability of a full queue, we can just	822	bytes for the second request. Due to the availability of a queue, we can
429	pipeline sending both requests and manipulate the queue as necessary in	823	just pipeline sending both requests and manipulate the queue as necessary
430	the callbacks:	824	in the callbacks.
431		825
432	# request one	826	When the first callback is called and sees an "OK" response, it will
		827	C<unshift> another line-read. This line-read will be queued I<before> the
		828	64-byte chunk callback.
		829
		830	# request one, returns either "OK + extra line" or "ERROR"
433	$handle->push_write ("request 1\015\012");	831	$handle->push_write ("request 1\015\012");
434		832
435	# we expect "ERROR" or "OK" as response, so push a line read	833	# we expect "ERROR" or "OK" as response, so push a line read
436	$handle->push_read_line (sub {	834	$handle->push_read (line => sub {
437	# if we got an "OK", we have to _prepend_ another line,	835	# if we got an "OK", we have to _prepend_ another line,
438	# so it will be read before the second request reads its 64 bytes	836	# so it will be read before the second request reads its 64 bytes
439	# which are already in the queue when this callback is called	837	# which are already in the queue when this callback is called
440	# we don't do this in case we got an error	838	# we don't do this in case we got an error
441	if ($_[1] eq "OK") {	839	if ($_[1] eq "OK") {
442	$_[0]->unshift_read_line (sub {	840	$_[0]->unshift_read (line => sub {
443	my $response = $_[1];	841	my $response = $_[1];
444	...	842	...
445	});	843	});
446	}	844	}
447	});	845	});
448		846
449	# request two	847	# request two, simply returns 64 octets
450	$handle->push_write ("request 2\015\012");	848	$handle->push_write ("request 2\015\012");
451		849
452	# simply read 64 bytes, always	850	# simply read 64 bytes, always
453	$handle->push_read_chunk (64, sub {	851	$handle->push_read (chunk => 64, sub {
454	my $response = $_[1];	852	my $response = $_[1];
455	...	853	...
456	});	854	});
457		855
458	=over 4	856	=over 4
459		857
460	=cut	858	=cut
461		859
462	sub _drain_rbuf {	860	sub _drain_rbuf {
463	my ($self) = @_;	861	my ($self) = @_;
		862
		863	local $self->{_in_drain} = 1;
464		864
465	if (	865	if (
466	defined $self->{rbuf_max}	866	defined $self->{rbuf_max}
467	&& $self->{rbuf_max} < length $self->{rbuf}	867	&& $self->{rbuf_max} < length $self->{rbuf}
468	) {	868	) {
469	$! = &Errno::ENOSPC; return $self->error;	869	$self->_error (&Errno::ENOSPC, 1), return;
470	}	870	}
471		871
472	return if $self->{in_drain};	872	while () {
473	local $self->{in_drain} = 1;	873	# we need to use a separate tls read buffer, as we must not receive data while
		874	# we are draining the buffer, and this can only happen with TLS.
		875	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
474		876
475	while (my $len = length $self->{rbuf}) {	877	my $len = length $self->{rbuf};
476	no strict 'refs';	878
477	if (my $cb = shift @{ $self->{queue} }) {	879	if (my $cb = shift @{ $self->{_queue} }) {
478	unless ($cb->($self)) {	880	unless ($cb->($self)) {
479	if ($self->{eof}) {	881	if ($self->{_eof}) {
480	# no progress can be made (not enough data and no data forthcoming)	882	# no progress can be made (not enough data and no data forthcoming)
481	$! = &Errno::EPIPE; return $self->error;	883	$self->_error (&Errno::EPIPE, 1), return;
482	}	884	}
483		885
484	unshift @{ $self->{queue} }, $cb;	886	unshift @{ $self->{_queue} }, $cb;
485	return;	887	last;
486	}	888	}
487	} elsif ($self->{on_read}) {	889	} elsif ($self->{on_read}) {
		890	last unless $len;
		891
488	$self->{on_read}($self);	892	$self->{on_read}($self);
489		893
490	if (	894	if (
491	$self->{eof} # if no further data will arrive
492	&& $len == length $self->{rbuf} # and no data has been consumed	895	$len == length $self->{rbuf} # if no data has been consumed
493	&& !@{ $self->{queue} } # and the queue is still empty	896	&& !@{ $self->{_queue} } # and the queue is still empty
494	&& $self->{on_read} # and we still want to read data	897	&& $self->{on_read} # but we still have on_read
495	) {	898	) {
		899	# no further data will arrive
496	# then no progress can be made	900	# so no progress can be made
497	$! = &Errno::EPIPE; return $self->error;	901	$self->_error (&Errno::EPIPE, 1), return
		902	if $self->{_eof};
		903
		904	last; # more data might arrive
498	}	905	}
499	} else {	906	} else {
500	# read side becomes idle	907	# read side becomes idle
501	delete $self->{rw};	908	delete $self->{_rw} unless $self->{tls};
502	return;	909	last;
503	}	910	}
504	}	911	}
505		912
506	if ($self->{eof}) {	913	if ($self->{_eof}) {
507	$self->_shutdown;	914	if ($self->{on_eof}) {
508	$self->{on_eof}($self)	915	$self->{on_eof}($self)
509	if $self->{on_eof};	916	} else {
		917	$self->_error (0, 1, "Unexpected end-of-file");
		918	}
		919	}
		920
		921	# may need to restart read watcher
		922	unless ($self->{_rw}) {
		923	$self->start_read
		924	if $self->{on_read} || @{ $self->{_queue} };
510	}	925	}
511	}	926	}
512		927
513	=item $handle->on_read ($cb)	928	=item $handle->on_read ($cb)
514		929
…		…
520		935
521	sub on_read {	936	sub on_read {
522	my ($self, $cb) = @_;	937	my ($self, $cb) = @_;
523		938
524	$self->{on_read} = $cb;	939	$self->{on_read} = $cb;
		940	$self->_drain_rbuf if $cb && !$self->{_in_drain};
525	}	941	}
526		942
527	=item $handle->rbuf	943	=item $handle->rbuf
528		944
529	Returns the read buffer (as a modifiable lvalue).	945	Returns the read buffer (as a modifiable lvalue).
530		946
531	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	947	You can access the read buffer directly as the C<< ->{rbuf} >>
532	you want.	948	member, if you want. However, the only operation allowed on the
		949	read buffer (apart from looking at it) is removing data from its
		950	beginning. Otherwise modifying or appending to it is not allowed and will
		951	lead to hard-to-track-down bugs.
533		952
534	NOTE: The read buffer should only be used or modified if the C<on_read>,	953	NOTE: The read buffer should only be used or modified if the C<on_read>,
535	C<push_read> or C<unshift_read> methods are used. The other read methods	954	C<push_read> or C<unshift_read> methods are used. The other read methods
536	automatically manage the read buffer.	955	automatically manage the read buffer.
537		956
…		…
577		996
578	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	997	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
579	->($self, $cb, @_);	998	->($self, $cb, @_);
580	}	999	}
581		1000
582	push @{ $self->{queue} }, $cb;	1001	push @{ $self->{_queue} }, $cb;
583	$self->_drain_rbuf;	1002	$self->_drain_rbuf unless $self->{_in_drain};
584	}	1003	}
585		1004
586	sub unshift_read {	1005	sub unshift_read {
587	my $self = shift;	1006	my $self = shift;
588	my $cb = pop;	1007	my $cb = pop;
…		…
593	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1012	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
594	->($self, $cb, @_);	1013	->($self, $cb, @_);
595	}	1014	}
596		1015
597		1016
598	unshift @{ $self->{queue} }, $cb;	1017	unshift @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	1018	$self->_drain_rbuf unless $self->{_in_drain};
600	}	1019	}
601		1020
602	=item $handle->push_read (type => @args, $cb)	1021	=item $handle->push_read (type => @args, $cb)
603		1022
604	=item $handle->unshift_read (type => @args, $cb)	1023	=item $handle->unshift_read (type => @args, $cb)
…		…
610	Predefined types are (if you have ideas for additional types, feel free to	1029	Predefined types are (if you have ideas for additional types, feel free to
611	drop by and tell us):	1030	drop by and tell us):
612		1031
613	=over 4	1032	=over 4
614		1033
615	=item chunk => $octets, $cb->($self, $data)	1034	=item chunk => $octets, $cb->($handle, $data)
616		1035
617	Invoke the callback only once C<$octets> bytes have been read. Pass the	1036	Invoke the callback only once C<$octets> bytes have been read. Pass the
618	data read to the callback. The callback will never be called with less	1037	data read to the callback. The callback will never be called with less
619	data.	1038	data.
620		1039
…		…
634	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1053	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
635	1	1054	1
636	}	1055	}
637	};	1056	};
638		1057
639	# compatibility with older API
640	sub push_read_chunk {
641	$_[0]->push_read (chunk => $_[1], $_[2]);
642	}
643
644	sub unshift_read_chunk {
645	$_[0]->unshift_read (chunk => $_[1], $_[2]);
646	}
647
648	=item line => [$eol, ]$cb->($self, $line, $eol)	1058	=item line => [$eol, ]$cb->($handle, $line, $eol)
649		1059
650	The callback will be called only once a full line (including the end of	1060	The callback will be called only once a full line (including the end of
651	line marker, C<$eol>) has been read. This line (excluding the end of line	1061	line marker, C<$eol>) has been read. This line (excluding the end of line
652	marker) will be passed to the callback as second argument (C<$line>), and	1062	marker) will be passed to the callback as second argument (C<$line>), and
653	the end of line marker as the third argument (C<$eol>).	1063	the end of line marker as the third argument (C<$eol>).
…		…
667	=cut	1077	=cut
668		1078
669	register_read_type line => sub {	1079	register_read_type line => sub {
670	my ($self, $cb, $eol) = @_;	1080	my ($self, $cb, $eol) = @_;
671		1081
672	$eol = qr|(\015?\012)| if @_ < 3;	1082	if (@_ < 3) {
		1083	# this is more than twice as fast as the generic code below
		1084	sub {
		1085	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1086
		1087	$cb->($_[0], $1, $2);
		1088	1
		1089	}
		1090	} else {
673	$eol = quotemeta $eol unless ref $eol;	1091	$eol = quotemeta $eol unless ref $eol;
674	$eol = qr|^(.*?)($eol)|s;	1092	$eol = qr|^(.*?)($eol)|s;
		1093
		1094	sub {
		1095	$_[0]{rbuf} =~ s/$eol// or return;
		1096
		1097	$cb->($_[0], $1, $2);
		1098	1
		1099	}
		1100	}
		1101	};
		1102
		1103	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		1104
		1105	Makes a regex match against the regex object C<$accept> and returns
		1106	everything up to and including the match.
		1107
		1108	Example: read a single line terminated by '\n'.
		1109
		1110	$handle->push_read (regex => qr<\n>, sub { ... });
		1111
		1112	If C<$reject> is given and not undef, then it determines when the data is
		1113	to be rejected: it is matched against the data when the C<$accept> regex
		1114	does not match and generates an C<EBADMSG> error when it matches. This is
		1115	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		1116	receive buffer overflow).
		1117
		1118	Example: expect a single decimal number followed by whitespace, reject
		1119	anything else (not the use of an anchor).
		1120
		1121	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		1122
		1123	If C<$skip> is given and not C<undef>, then it will be matched against
		1124	the receive buffer when neither C<$accept> nor C<$reject> match,
		1125	and everything preceding and including the match will be accepted
		1126	unconditionally. This is useful to skip large amounts of data that you
		1127	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		1128	have to start matching from the beginning. This is purely an optimisation
		1129	and is usually worth only when you expect more than a few kilobytes.
		1130
		1131	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		1132	expect the header to be very large (it isn't in practise, but...), we use
		1133	a skip regex to skip initial portions. The skip regex is tricky in that
		1134	it only accepts something not ending in either \015 or \012, as these are
		1135	required for the accept regex.
		1136
		1137	$handle->push_read (regex =>
		1138	qr<\015\012\015\012>,
		1139	undef, # no reject
		1140	qr<^.*[^\015\012]>,
		1141	sub { ... });
		1142
		1143	=cut
		1144
		1145	register_read_type regex => sub {
		1146	my ($self, $cb, $accept, $reject, $skip) = @_;
		1147
		1148	my $data;
		1149	my $rbuf = \$self->{rbuf};
675		1150
676	sub {	1151	sub {
677	$_[0]{rbuf} =~ s/$eol// or return;	1152	# accept
678		1153	if ($$rbuf =~ $accept) {
679	$cb->($_[0], $1, $2);	1154	$data .= substr $$rbuf, 0, $+[0], "";
		1155	$cb->($self, $data);
		1156	return 1;
		1157	}
680	1	1158
		1159	# reject
		1160	if ($reject && $$rbuf =~ $reject) {
		1161	$self->_error (&Errno::EBADMSG);
		1162	}
		1163
		1164	# skip
		1165	if ($skip && $$rbuf =~ $skip) {
		1166	$data .= substr $$rbuf, 0, $+[0], "";
		1167	}
		1168
		1169	()
681	}	1170	}
682	};	1171	};
683		1172
684	# compatibility with older API
685	sub push_read_line {
686	my $self = shift;
687	$self->push_read (line => @_);
688	}
689
690	sub unshift_read_line {
691	my $self = shift;
692	$self->unshift_read (line => @_);
693	}
694
695	=item netstring => $cb->($string)	1173	=item netstring => $cb->($handle, $string)
696		1174
697	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	1175	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
698		1176
699	Throws an error with C<$!> set to EBADMSG on format violations.	1177	Throws an error with C<$!> set to EBADMSG on format violations.
700		1178
…		…
704	my ($self, $cb) = @_;	1182	my ($self, $cb) = @_;
705		1183
706	sub {	1184	sub {
707	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1185	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
708	if ($_[0]{rbuf} =~ /[^0-9]/) {	1186	if ($_[0]{rbuf} =~ /[^0-9]/) {
709	$! = &Errno::EBADMSG;	1187	$self->_error (&Errno::EBADMSG);
710	$self->error;
711	}	1188	}
712	return;	1189	return;
713	}	1190	}
714		1191
715	my $len = $1;	1192	my $len = $1;
…		…
718	my $string = $_[1];	1195	my $string = $_[1];
719	$_[0]->unshift_read (chunk => 1, sub {	1196	$_[0]->unshift_read (chunk => 1, sub {
720	if ($_[1] eq ",") {	1197	if ($_[1] eq ",") {
721	$cb->($_[0], $string);	1198	$cb->($_[0], $string);
722	} else {	1199	} else {
723	$! = &Errno::EBADMSG;	1200	$self->_error (&Errno::EBADMSG);
724	$self->error;
725	}	1201	}
726	});	1202	});
727	});	1203	});
728		1204
729	1	1205	1
730	}	1206	}
731	};	1207	};
732		1208
		1209	=item packstring => $format, $cb->($handle, $string)
		1210
		1211	An octet string prefixed with an encoded length. The encoding C<$format>
		1212	uses the same format as a Perl C<pack> format, but must specify a single
		1213	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1214	optional C<!>, C<< < >> or C<< > >> modifier).
		1215
		1216	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1217	EPP uses a prefix of C<N> (4 octtes).
		1218
		1219	Example: read a block of data prefixed by its length in BER-encoded
		1220	format (very efficient).
		1221
		1222	$handle->push_read (packstring => "w", sub {
		1223	my ($handle, $data) = @_;
		1224	});
		1225
		1226	=cut
		1227
		1228	register_read_type packstring => sub {
		1229	my ($self, $cb, $format) = @_;
		1230
		1231	sub {
		1232	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1233	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1234	or return;
		1235
		1236	$format = length pack $format, $len;
		1237
		1238	# bypass unshift if we already have the remaining chunk
		1239	if ($format + $len <= length $_[0]{rbuf}) {
		1240	my $data = substr $_[0]{rbuf}, $format, $len;
		1241	substr $_[0]{rbuf}, 0, $format + $len, "";
		1242	$cb->($_[0], $data);
		1243	} else {
		1244	# remove prefix
		1245	substr $_[0]{rbuf}, 0, $format, "";
		1246
		1247	# read remaining chunk
		1248	$_[0]->unshift_read (chunk => $len, $cb);
		1249	}
		1250
		1251	1
		1252	}
		1253	};
		1254
		1255	=item json => $cb->($handle, $hash_or_arrayref)
		1256
		1257	Reads a JSON object or array, decodes it and passes it to the
		1258	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
		1259
		1260	If a C<json> object was passed to the constructor, then that will be used
		1261	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1262
		1263	This read type uses the incremental parser available with JSON version
		1264	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1265	dependency on your own: this module will load the JSON module, but
		1266	AnyEvent does not depend on it itself.
		1267
		1268	Since JSON texts are fully self-delimiting, the C<json> read and write
		1269	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1270	the C<json> write type description, above, for an actual example.
		1271
		1272	=cut
		1273
		1274	register_read_type json => sub {
		1275	my ($self, $cb) = @_;
		1276
		1277	my $json = $self->{json} ||=
		1278	eval { require JSON::XS; JSON::XS->new->utf8 }
		1279	|| do { require JSON; JSON->new->utf8 };
		1280
		1281	my $data;
		1282	my $rbuf = \$self->{rbuf};
		1283
		1284	sub {
		1285	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
		1286
		1287	if ($ref) {
		1288	$self->{rbuf} = $json->incr_text;
		1289	$json->incr_text = "";
		1290	$cb->($self, $ref);
		1291
		1292	1
		1293	} elsif ($@) {
		1294	# error case
		1295	$json->incr_skip;
		1296
		1297	$self->{rbuf} = $json->incr_text;
		1298	$json->incr_text = "";
		1299
		1300	$self->_error (&Errno::EBADMSG);
		1301
		1302	()
		1303	} else {
		1304	$self->{rbuf} = "";
		1305
		1306	()
		1307	}
		1308	}
		1309	};
		1310
		1311	=item storable => $cb->($handle, $ref)
		1312
		1313	Deserialises a L<Storable> frozen representation as written by the
		1314	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1315	data).
		1316
		1317	Raises C<EBADMSG> error if the data could not be decoded.
		1318
		1319	=cut
		1320
		1321	register_read_type storable => sub {
		1322	my ($self, $cb) = @_;
		1323
		1324	require Storable;
		1325
		1326	sub {
		1327	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1328	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1329	or return;
		1330
		1331	my $format = length pack "w", $len;
		1332
		1333	# bypass unshift if we already have the remaining chunk
		1334	if ($format + $len <= length $_[0]{rbuf}) {
		1335	my $data = substr $_[0]{rbuf}, $format, $len;
		1336	substr $_[0]{rbuf}, 0, $format + $len, "";
		1337	$cb->($_[0], Storable::thaw ($data));
		1338	} else {
		1339	# remove prefix
		1340	substr $_[0]{rbuf}, 0, $format, "";
		1341
		1342	# read remaining chunk
		1343	$_[0]->unshift_read (chunk => $len, sub {
		1344	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1345	$cb->($_[0], $ref);
		1346	} else {
		1347	$self->_error (&Errno::EBADMSG);
		1348	}
		1349	});
		1350	}
		1351
		1352	1
		1353	}
		1354	};
		1355
733	=back	1356	=back
734		1357
735	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1358	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
736		1359
737	This function (not method) lets you add your own types to C<push_read>.	1360	This function (not method) lets you add your own types to C<push_read>.
738		1361
739	Whenever the given C<type> is used, C<push_read> will invoke the code	1362	Whenever the given C<type> is used, C<push_read> will invoke the code
740	reference with the handle object, the callback and the remaining	1363	reference with the handle object, the callback and the remaining
…		…
742		1365
743	The code reference is supposed to return a callback (usually a closure)	1366	The code reference is supposed to return a callback (usually a closure)
744	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1367	that works as a plain read callback (see C<< ->push_read ($cb) >>).
745		1368
746	It should invoke the passed callback when it is done reading (remember to	1369	It should invoke the passed callback when it is done reading (remember to
747	pass C<$self> as first argument as all other callbacks do that).	1370	pass C<$handle> as first argument as all other callbacks do that).
748		1371
749	Note that this is a function, and all types registered this way will be	1372	Note that this is a function, and all types registered this way will be
750	global, so try to use unique names.	1373	global, so try to use unique names.
751		1374
752	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1375	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
755	=item $handle->stop_read	1378	=item $handle->stop_read
756		1379
757	=item $handle->start_read	1380	=item $handle->start_read
758		1381
759	In rare cases you actually do not want to read anything from the	1382	In rare cases you actually do not want to read anything from the
760	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1383	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
761	any queued callbacks will be executed then. To start reading again, call	1384	any queued callbacks will be executed then. To start reading again, call
762	C<start_read>.	1385	C<start_read>.
763		1386
		1387	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1388	you change the C<on_read> callback or push/unshift a read callback, and it
		1389	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1390	there are any read requests in the queue.
		1391
		1392	These methods will have no effect when in TLS mode (as TLS doesn't support
		1393	half-duplex connections).
		1394
764	=cut	1395	=cut
765		1396
766	sub stop_read {	1397	sub stop_read {
767	my ($self) = @_;	1398	my ($self) = @_;
768		1399
769	delete $self->{rw};	1400	delete $self->{_rw} unless $self->{tls};
770	}	1401	}
771		1402
772	sub start_read {	1403	sub start_read {
773	my ($self) = @_;	1404	my ($self) = @_;
774		1405
775	unless ($self->{rw} || $self->{eof}) {	1406	unless ($self->{_rw} || $self->{_eof}) {
776	Scalar::Util::weaken $self;	1407	Scalar::Util::weaken $self;
777		1408
778	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1409	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
779	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1410	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
780	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1411	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
781		1412
782	if ($len > 0) {	1413	if ($len > 0) {
783	$self->{filter_r}	1414	$self->{_activity} = AnyEvent->now;
784	? $self->{filter_r}->($self, $rbuf)	1415
785	: $self->_drain_rbuf;	1416	if ($self->{tls}) {
		1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1418
		1419	&_dotls ($self);
		1420	} else {
		1421	$self->_drain_rbuf unless $self->{_in_drain};
		1422	}
786		1423
787	} elsif (defined $len) {	1424	} elsif (defined $len) {
788	delete $self->{rw};	1425	delete $self->{_rw};
789	$self->{eof} = 1;	1426	$self->{_eof} = 1;
790	$self->_drain_rbuf;	1427	$self->_drain_rbuf unless $self->{_in_drain};
791		1428
792	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1429	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
793	return $self->error;	1430	return $self->_error ($!, 1);
794	}	1431	}
795	});	1432	});
796	}	1433	}
797	}	1434	}
798		1435
		1436	our $ERROR_SYSCALL;
		1437	our $ERROR_WANT_READ;
		1438
		1439	sub _tls_error {
		1440	my ($self, $err) = @_;
		1441
		1442	return $self->_error ($!, 1)
		1443	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1444
		1445	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1446
		1447	# reduce error string to look less scary
		1448	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1449
		1450	if ($self->{_on_starttls}) {
		1451	(delete $self->{_on_starttls})->($self, undef, $err);
		1452	&_freetls;
		1453	} else {
		1454	&_freetls;
		1455	$self->_error (&Errno::EPROTO, 1, $err);
		1456	}
		1457	}
		1458
		1459	# poll the write BIO and send the data if applicable
		1460	# also decode read data if possible
		1461	# this is basiclaly our TLS state machine
		1462	# more efficient implementations are possible with openssl,
		1463	# but not with the buggy and incomplete Net::SSLeay.
799	sub _dotls {	1464	sub _dotls {
800	my ($self) = @_;	1465	my ($self) = @_;
801		1466
		1467	my $tmp;
		1468
802	if (length $self->{tls_wbuf}) {	1469	if (length $self->{_tls_wbuf}) {
803	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1470	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
804	substr $self->{tls_wbuf}, 0, $len, "";	1471	substr $self->{_tls_wbuf}, 0, $tmp, "";
805	}	1472	}
806	}
807		1473
		1474	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1475	return $self->_tls_error ($tmp)
		1476	if $tmp != $ERROR_WANT_READ
		1477	&& ($tmp != $ERROR_SYSCALL || $!);
		1478	}
		1479
808	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1480	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1481	unless (length $tmp) {
		1482	$self->{_on_starttls}
		1483	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1484	&_freetls;
		1485
		1486	if ($self->{on_stoptls}) {
		1487	$self->{on_stoptls}($self);
		1488	return;
		1489	} else {
		1490	# let's treat SSL-eof as we treat normal EOF
		1491	delete $self->{_rw};
		1492	$self->{_eof} = 1;
		1493	}
		1494	}
		1495
		1496	$self->{_tls_rbuf} .= $tmp;
		1497	$self->_drain_rbuf unless $self->{_in_drain};
		1498	$self->{tls} or return; # tls session might have gone away in callback
		1499	}
		1500
		1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1502	return $self->_tls_error ($tmp)
		1503	if $tmp != $ERROR_WANT_READ
		1504	&& ($tmp != $ERROR_SYSCALL || $!);
		1505
		1506	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
809	$self->{wbuf} .= $buf;	1507	$self->{wbuf} .= $tmp;
810	$self->_drain_wbuf;	1508	$self->_drain_wbuf;
811	}	1509	}
812		1510
813	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1511	$self->{_on_starttls}
814	$self->{rbuf} .= $buf;	1512	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
815	$self->_drain_rbuf;	1513	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
816	}
817
818	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
819
820	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
821	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
822	$self->error;
823	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
824	$! = &Errno::EIO;
825	$self->error;
826	}
827
828	# all others are fine for our purposes
829	}
830	}	1514	}
831		1515
832	=item $handle->starttls ($tls[, $tls_ctx])	1516	=item $handle->starttls ($tls[, $tls_ctx])
833		1517
834	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
836	C<starttls>.	1520	C<starttls>.
837		1521
838	The first argument is the same as the C<tls> constructor argument (either	1522	The first argument is the same as the C<tls> constructor argument (either
839	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
840		1524
841	The second argument is the optional C<Net::SSLeay::CTX> object that is	1525	The second argument is the optional C<AnyEvent::TLS> object that is used
842	used when AnyEvent::Handle has to create its own TLS connection object.	1526	when AnyEvent::Handle has to create its own TLS connection object, or
		1527	a hash reference with C<< key => value >> pairs that will be used to
		1528	construct a new context.
843		1529
844	=cut	1530	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
		1531	context in C<< $handle->{tls_ctx} >> after this call and can be used or
		1532	changed to your liking. Note that the handshake might have already started
		1533	when this function returns.
845		1534
846	# TODO: maybe document...	1535	If it an error to start a TLS handshake more than once per
		1536	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1537
		1538	=cut
		1539
		1540	our %TLS_CACHE; #TODO not yet documented, should we?
		1541
847	sub starttls {	1542	sub starttls {
848	my ($self, $ssl, $ctx) = @_;	1543	my ($self, $ssl, $ctx) = @_;
849		1544
850	$self->stoptls;	1545	require Net::SSLeay;
851		1546
852	if ($ssl eq "accept") {	1547	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
853	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1548	if $self->{tls};
854	Net::SSLeay::set_accept_state ($ssl);	1549
855	} elsif ($ssl eq "connect") {	1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
856	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
857	Net::SSLeay::set_connect_state ($ssl);	1552
		1553	$ctx ||= $self->{tls_ctx};
		1554
		1555	if ("HASH" eq ref $ctx) {
		1556	require AnyEvent::TLS;
		1557
		1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1559
		1560	if ($ctx->{cache}) {
		1561	my $key = $ctx+0;
		1562	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1563	} else {
		1564	$ctx = new AnyEvent::TLS %$ctx;
		1565	}
		1566	}
858	}	1567
859		1568	$self->{tls_ctx} = $ctx || TLS_CTX ();
860	$self->{tls} = $ssl;	1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
861		1570
862	# basically, this is deep magic (because SSL_read should have the same issues)	1571	# basically, this is deep magic (because SSL_read should have the same issues)
863	# but the openssl maintainers basically said: "trust us, it just works".	1572	# but the openssl maintainers basically said: "trust us, it just works".
864	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
865	# and mismaintained ssleay-module doesn't even offer them).	1574	# and mismaintained ssleay-module doesn't even offer them).
866	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1575	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1576	#
		1577	# in short: this is a mess.
		1578	#
		1579	# note that we do not try to keep the length constant between writes as we are required to do.
		1580	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1581	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1582	# have identity issues in that area.
867	Net::SSLeay::CTX_set_mode ($self->{tls},	1583	# Net::SSLeay::CTX_set_mode ($ssl,
868	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
869	| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1585	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1586	Net::SSLeay::CTX_set_mode ($ssl, 1|2);
870		1587
871	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
873		1590
874	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
875		1592
876	$self->{filter_w} = sub {	1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
877	$_[0]{tls_wbuf} .= ${$_[1]};	1594	if $self->{on_starttls};
878	&_dotls;	1595
879	};	1596	&_dotls; # need to trigger the initial handshake
880	$self->{filter_r} = sub {	1597	$self->start_read; # make sure we actually do read
881	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
882	&_dotls;
883	};
884	}	1598	}
885		1599
886	=item $handle->stoptls	1600	=item $handle->stoptls
887		1601
888	Destroys the SSL connection, if any. Partial read or write data will be	1602	Shuts down the SSL connection - this makes a proper EOF handshake by
889	lost.	1603	sending a close notify to the other side, but since OpenSSL doesn't
		1604	support non-blocking shut downs, it is not possible to re-use the stream
		1605	afterwards.
890		1606
891	=cut	1607	=cut
892		1608
893	sub stoptls {	1609	sub stoptls {
894	my ($self) = @_;	1610	my ($self) = @_;
895		1611
896	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1612	if ($self->{tls}) {
897	delete $self->{tls_rbio};	1613	Net::SSLeay::shutdown ($self->{tls});
898	delete $self->{tls_wbio};	1614
899	delete $self->{tls_wbuf};	1615	&_dotls;
900	delete $self->{filter_r};	1616
901	delete $self->{filter_w};	1617	# # we don't give a shit. no, we do, but we can't. no...#d#
		1618	# # we, we... have to use openssl :/#d#
		1619	# &_freetls;#d#
		1620	}
		1621	}
		1622
		1623	sub _freetls {
		1624	my ($self) = @_;
		1625
		1626	return unless $self->{tls};
		1627
		1628	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1629
		1630	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
902	}	1631	}
903		1632
904	sub DESTROY {	1633	sub DESTROY {
905	my $self = shift;	1634	my ($self) = @_;
906		1635
907	$self->stoptls;	1636	&_freetls;
		1637
		1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1639
		1640	if ($linger && length $self->{wbuf}) {
		1641	my $fh = delete $self->{fh};
		1642	my $wbuf = delete $self->{wbuf};
		1643
		1644	my @linger;
		1645
		1646	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1647	my $len = syswrite $fh, $wbuf, length $wbuf;
		1648
		1649	if ($len > 0) {
		1650	substr $wbuf, 0, $len, "";
		1651	} else {
		1652	@linger = (); # end
		1653	}
		1654	});
		1655	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1656	@linger = ();
		1657	});
		1658	}
		1659	}
		1660
		1661	=item $handle->destroy
		1662
		1663	Shuts down the handle object as much as possible - this call ensures that
		1664	no further callbacks will be invoked and as many resources as possible
		1665	will be freed. You must not call any methods on the object afterwards.
		1666
		1667	Normally, you can just "forget" any references to an AnyEvent::Handle
		1668	object and it will simply shut down. This works in fatal error and EOF
		1669	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1670	callback, so when you want to destroy the AnyEvent::Handle object from
		1671	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1672	that case.
		1673
		1674	Destroying the handle object in this way has the advantage that callbacks
		1675	will be removed as well, so if those are the only reference holders (as
		1676	is common), then one doesn't need to do anything special to break any
		1677	reference cycles.
		1678
		1679	The handle might still linger in the background and write out remaining
		1680	data, as specified by the C<linger> option, however.
		1681
		1682	=cut
		1683
		1684	sub destroy {
		1685	my ($self) = @_;
		1686
		1687	$self->DESTROY;
		1688	%$self = ();
908	}	1689	}
909		1690
910	=item AnyEvent::Handle::TLS_CTX	1691	=item AnyEvent::Handle::TLS_CTX
911		1692
912	This function creates and returns the Net::SSLeay::CTX object used by	1693	This function creates and returns the AnyEvent::TLS object used by default
913	default for TLS mode.	1694	for TLS mode.
914		1695
915	The context is created like this:	1696	The context is created by calling L<AnyEvent::TLS> without any arguments.
916
917	Net::SSLeay::load_error_strings;
918	Net::SSLeay::SSLeay_add_ssl_algorithms;
919	Net::SSLeay::randomize;
920
921	my $CTX = Net::SSLeay::CTX_new;
922
923	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
924		1697
925	=cut	1698	=cut
926		1699
927	our $TLS_CTX;	1700	our $TLS_CTX;
928		1701
929	sub TLS_CTX() {	1702	sub TLS_CTX() {
930	$TLS_CTX || do {	1703	$TLS_CTX ||= do {
931	require Net::SSLeay;	1704	require AnyEvent::TLS;
932		1705
933	Net::SSLeay::load_error_strings ();	1706	new AnyEvent::TLS
934	Net::SSLeay::SSLeay_add_ssl_algorithms ();
935	Net::SSLeay::randomize ();
936
937	$TLS_CTX = Net::SSLeay::CTX_new ();
938
939	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
940
941	$TLS_CTX
942	}	1707	}
943	}	1708	}
944		1709
945	=back	1710	=back
946		1711
		1712
		1713	=head1 NONFREQUENTLY ASKED QUESTIONS
		1714
		1715	=over 4
		1716
		1717	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1718	still get further invocations!
		1719
		1720	That's because AnyEvent::Handle keeps a reference to itself when handling
		1721	read or write callbacks.
		1722
		1723	It is only safe to "forget" the reference inside EOF or error callbacks,
		1724	from within all other callbacks, you need to explicitly call the C<<
		1725	->destroy >> method.
		1726
		1727	=item I get different callback invocations in TLS mode/Why can't I pause
		1728	reading?
		1729
		1730	Unlike, say, TCP, TLS connections do not consist of two independent
		1731	communication channels, one for each direction. Or put differently. The
		1732	read and write directions are not independent of each other: you cannot
		1733	write data unless you are also prepared to read, and vice versa.
		1734
		1735	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1736	callback invocations when you are not expecting any read data - the reason
		1737	is that AnyEvent::Handle always reads in TLS mode.
		1738
		1739	During the connection, you have to make sure that you always have a
		1740	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1741	connection (or when you no longer want to use it) you can call the
		1742	C<destroy> method.
		1743
		1744	=item How do I read data until the other side closes the connection?
		1745
		1746	If you just want to read your data into a perl scalar, the easiest way
		1747	to achieve this is by setting an C<on_read> callback that does nothing,
		1748	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1749	will be in C<$_[0]{rbuf}>:
		1750
		1751	$handle->on_read (sub { });
		1752	$handle->on_eof (undef);
		1753	$handle->on_error (sub {
		1754	my $data = delete $_[0]{rbuf};
		1755	});
		1756
		1757	The reason to use C<on_error> is that TCP connections, due to latencies
		1758	and packets loss, might get closed quite violently with an error, when in
		1759	fact, all data has been received.
		1760
		1761	It is usually better to use acknowledgements when transferring data,
		1762	to make sure the other side hasn't just died and you got the data
		1763	intact. This is also one reason why so many internet protocols have an
		1764	explicit QUIT command.
		1765
		1766	=item I don't want to destroy the handle too early - how do I wait until
		1767	all data has been written?
		1768
		1769	After writing your last bits of data, set the C<on_drain> callback
		1770	and destroy the handle in there - with the default setting of
		1771	C<low_water_mark> this will be called precisely when all data has been
		1772	written to the socket:
		1773
		1774	$handle->push_write (...);
		1775	$handle->on_drain (sub {
		1776	warn "all data submitted to the kernel\n";
		1777	undef $handle;
		1778	});
		1779
		1780	If you just want to queue some data and then signal EOF to the other side,
		1781	consider using C<< ->push_shutdown >> instead.
		1782
		1783	=item I want to contact a TLS/SSL server, I don't care about security.
		1784
		1785	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1786	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1787	parameter:
		1788
		1789	tcp_connect $host, $port, sub {
		1790	my ($fh) = @_;
		1791
		1792	my $handle = new AnyEvent::Handle
		1793	fh => $fh,
		1794	tls => "connect",
		1795	on_error => sub { ... };
		1796
		1797	$handle->push_write (...);
		1798	};
		1799
		1800	=item I want to contact a TLS/SSL server, I do care about security.
		1801
		1802	Then you should additionally enable certificate verification, including
		1803	peername verification, if the protocol you use supports it (see
		1804	L<AnyEvent::TLS>, C<verify_peername>).
		1805
		1806	E.g. for HTTPS:
		1807
		1808	tcp_connect $host, $port, sub {
		1809	my ($fh) = @_;
		1810
		1811	my $handle = new AnyEvent::Handle
		1812	fh => $fh,
		1813	peername => $host,
		1814	tls => "connect",
		1815	tls_ctx => { verify => 1, verify_peername => "https" },
		1816	...
		1817
		1818	Note that you must specify the hostname you connected to (or whatever
		1819	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1820	peername verification will be done.
		1821
		1822	The above will use the system-dependent default set of trusted CA
		1823	certificates. If you want to check against a specific CA, add the
		1824	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1825
		1826	tls_ctx => {
		1827	verify => 1,
		1828	verify_peername => "https",
		1829	ca_file => "my-ca-cert.pem",
		1830	},
		1831
		1832	=item I want to create a TLS/SSL server, how do I do that?
		1833
		1834	Well, you first need to get a server certificate and key. You have
		1835	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1836	self-signed certificate (cheap. check the search engine of your choice,
		1837	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1838	nice program for that purpose).
		1839
		1840	Then create a file with your private key (in PEM format, see
		1841	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1842	file should then look like this:
		1843
		1844	-----BEGIN RSA PRIVATE KEY-----
		1845	...header data
		1846	... lots of base64'y-stuff
		1847	-----END RSA PRIVATE KEY-----
		1848
		1849	-----BEGIN CERTIFICATE-----
		1850	... lots of base64'y-stuff
		1851	-----END CERTIFICATE-----
		1852
		1853	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1854	specify this file as C<cert_file>:
		1855
		1856	tcp_server undef, $port, sub {
		1857	my ($fh) = @_;
		1858
		1859	my $handle = new AnyEvent::Handle
		1860	fh => $fh,
		1861	tls => "accept",
		1862	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1863	...
		1864
		1865	When you have intermediate CA certificates that your clients might not
		1866	know about, just append them to the C<cert_file>.
		1867
		1868	=back
		1869
		1870
		1871	=head1 SUBCLASSING AnyEvent::Handle
		1872
		1873	In many cases, you might want to subclass AnyEvent::Handle.
		1874
		1875	To make this easier, a given version of AnyEvent::Handle uses these
		1876	conventions:
		1877
		1878	=over 4
		1879
		1880	=item * all constructor arguments become object members.
		1881
		1882	At least initially, when you pass a C<tls>-argument to the constructor it
		1883	will end up in C<< $handle->{tls} >>. Those members might be changed or
		1884	mutated later on (for example C<tls> will hold the TLS connection object).
		1885
		1886	=item * other object member names are prefixed with an C<_>.
		1887
		1888	All object members not explicitly documented (internal use) are prefixed
		1889	with an underscore character, so the remaining non-C<_>-namespace is free
		1890	for use for subclasses.
		1891
		1892	=item * all members not documented here and not prefixed with an underscore
		1893	are free to use in subclasses.
		1894
		1895	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1896	member variables, but thats just life, at least it is documented.
		1897
		1898	=back
		1899
947	=head1 AUTHOR	1900	=head1 AUTHOR
948		1901
949	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1902	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
950		1903
951	=cut	1904	=cut

Diff Legend

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