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

Diff Legend

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