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.12 by elmex, Thu May 15 09:03:43 2008 UTC vs.
Revision 1.197 by root, Tue Aug 31 00:59:55 2010 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict;
5
6	use AnyEvent ();
7	use AnyEvent::Util ();
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on filehandles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = '0.02';
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	12	my $hdl; $hdl = new AnyEvent::Handle
29
30	#TODO
31
32	# or use the constructor to pass the callback:
33
34	my $ae_fh2 =
35	AnyEvent::Handle->new (
36	fh => \*STDIN,	13	fh => \*STDIN,
37	on_eof => sub {	14	on_error => sub {
38	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
39	},	16	warn "got error $msg\n";
40	#TODO	17	$hdl->destroy;
		18	$cv->send;
41	);	19	};
42		20
43	$cv->wait;	21	# send some request line
		22	$hdl->push_write ("getinfo\015\012");
		23
		24	# read the response line
		25	$hdl->push_read (line => sub {
		26	my ($hdl, $line) = @_;
		27	warn "got line <$line>\n";
		28	$cv->send;
		29	});
		30
		31	$cv->recv;
44		32
45	=head1 DESCRIPTION	33	=head1 DESCRIPTION
46		34
47	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
48	filehandles (and sockets, see L<AnyEvent::Socket> for an easy way to make	36	stream-based filehandles (sockets, pipes or other stream things).
49	non-blocking resolves and connects).	37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
50		40
51	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
52	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
53	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
54		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
55	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
56	argument.	49	argument.
57		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
58	=head1 METHODS	80	=head1 METHODS
59		81
60	=over 4	82	=over 4
61		83
62	=item B<new (%args)>	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
63		85
64	The constructor supports these arguments (all as key => value pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
65		87
66	=over 4	88	=over 4
67		89
68	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
69		91
70	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
71
72	NOTE: The filehandle will be set to non-blocking (using	93	NOTE: The filehandle will be set to non-blocking mode (using
73	AnyEvent::Util::fh_nonblocking).	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		95	that mode.
74		96
75	=item on_eof => $cb->($self) [MANDATORY]	97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
76		98
77	Set the callback to be called on EOF.	99	Try to connect to the specified host and service (port), using
		100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		101	default C<peername>.
78		102
		103	You have to specify either this parameter, or C<fh>, above.
		104
		105	It is possible to push requests on the read and write queues, and modify
		106	properties of the stream, even while AnyEvent::Handle is connecting.
		107
		108	When this parameter is specified, then the C<on_prepare>,
		109	C<on_connect_error> and C<on_connect> callbacks will be called under the
		110	appropriate circumstances:
		111
		112	=over 4
		113
79	=item on_error => $cb->($self)	114	=item on_prepare => $cb->($handle)
80		115
		116	This (rarely used) callback is called before a new connection is
		117	attempted, but after the file handle has been created. It could be used to
		118	prepare the file handle with parameters required for the actual connect
		119	(as opposed to settings that can be changed when the connection is already
		120	established).
		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
		126	=item on_connect => $cb->($handle, $host, $port, $retry->())
		127
		128	This callback is called when a connection has been successfully established.
		129
		130	The actual numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	When, for some reason, the handle is not acceptable, then calling
		134	C<$retry> will continue with the next connection target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). At the time it is called the read and write queues, eof
		137	status, tls status and similar properties of the handle will have been
		138	reset.
		139
		140	In most cases, ignoring the C<$retry> parameter is the way to go.
		141
		142	=item on_connect_error => $cb->($handle, $message)
		143
		144	This callback is called when the connection could not be
		145	established. C<$!> will contain the relevant error code, and C<$message> a
		146	message describing it (usually the same as C<"$!">).
		147
		148	If this callback isn't specified, then C<on_error> will be called with a
		149	fatal error instead.
		150
		151	=back
		152
		153	=item on_error => $cb->($handle, $fatal, $message)
		154
81	This is the fatal error callback, that is called when, well, a fatal error	155	This is the error callback, which is called when, well, some error
82	ocurs, such as not being able to resolve the hostname, failure to connect	156	occured, such as not being able to resolve the hostname, failure to
83	or a read error.	157	connect or a read error.
84		158
85	The object will not be in a usable state when this callback has been	159	Some errors are fatal (which is indicated by C<$fatal> being true). On
86	called.	160	fatal errors the handle object will be destroyed (by a call to C<< ->
		161	destroy >>) after invoking the error callback (which means you are free to
		162	examine the handle object). Examples of fatal errors are an EOF condition
		163	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		164	cases where the other side can close the connection at their will it is
		165	often easiest to not report C<EPIPE> errors in this callback.
		166
		167	AnyEvent::Handle tries to find an appropriate error code for you to check
		168	against, but in some cases (TLS errors), this does not work well. It is
		169	recommended to always output the C<$message> argument in human-readable
		170	error messages (it's usually the same as C<"$!">).
		171
		172	Non-fatal errors can be retried by simply returning, but it is recommended
		173	to simply ignore this parameter and instead abondon the handle object
		174	when this callback is invoked. Examples of non-fatal errors are timeouts
		175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
87		176
88	On callback entrance, the value of C<$!> contains the operating system	177	On callback entrance, the value of C<$!> contains the operating system
89	error (or C<ENOSPC> or C<EPIPE>).	178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
90		180
91	While not mandatory, it is I<highly> recommended to set this callback, as	181	While not mandatory, it is I<highly> recommended to set this callback, as
92	you will not be notified of errors otherwise. The default simply calls	182	you will not be notified of errors otherwise. The default simply calls
93	die.	183	C<croak>.
94		184
95	=item on_read => $cb->($self)	185	=item on_read => $cb->($handle)
96		186
97	This sets the default read callback, which is called when data arrives	187	This sets the default read callback, which is called when data arrives
98	and no read request is in the queue.	188	and no read request is in the queue (unlike read queue callbacks, this
		189	callback will only be called when at least one octet of data is in the
		190	read buffer).
99		191
100	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
101	method or acces sthe C<$self->{rbuf}> member directly.	193	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		194	must not enlarge or modify the read buffer, you can only remove data at
		195	the beginning from it.
		196
		197	You can also call C<< ->push_read (...) >> or any other function that
		198	modifies the read queue. Or do both. Or ...
102		199
103	When an EOF condition is detected then AnyEvent::Handle will first try to	200	When an EOF condition is detected then AnyEvent::Handle will first try to
104	feed all the remaining data to the queued callbacks and C<on_read> before	201	feed all the remaining data to the queued callbacks and C<on_read> before
105	calling the C<on_eof> callback. If no progress can be made, then a fatal	202	calling the C<on_eof> callback. If no progress can be made, then a fatal
106	error will be raised (with C<$!> set to C<EPIPE>).	203	error will be raised (with C<$!> set to C<EPIPE>).
107		204
		205	Note that, unlike requests in the read queue, an C<on_read> callback
		206	doesn't mean you I<require> some data: if there is an EOF and there
		207	are outstanding read requests then an error will be flagged. With an
		208	C<on_read> callback, the C<on_eof> callback will be invoked.
		209
		210	=item on_eof => $cb->($handle)
		211
		212	Set the callback to be called when an end-of-file condition is detected,
		213	i.e. in the case of a socket, when the other side has closed the
		214	connection cleanly, and there are no outstanding read requests in the
		215	queue (if there are read requests, then an EOF counts as an unexpected
		216	connection close and will be flagged as an error).
		217
		218	For sockets, this just means that the other side has stopped sending data,
		219	you can still try to write data, and, in fact, one can return from the EOF
		220	callback and continue writing data, as only the read part has been shut
		221	down.
		222
		223	If an EOF condition has been detected but no C<on_eof> callback has been
		224	set, then a fatal error will be raised with C<$!> set to <0>.
		225
108	=item on_drain => $cb->()	226	=item on_drain => $cb->($handle)
109		227
110	This sets the callback that is called when the write buffer becomes empty	228	This sets the callback that is called when the write buffer becomes empty
111	(or when the callback is set and the buffer is empty already).	229	(or when the callback is set and the buffer is empty already).
112		230
113	To append to the write buffer, use the C<< ->push_write >> method.	231	To append to the write buffer, use the C<< ->push_write >> method.
114		232
		233	This callback is useful when you don't want to put all of your write data
		234	into the queue at once, for example, when you want to write the contents
		235	of some file to the socket you might not want to read the whole file into
		236	memory and push it into the queue, but instead only read more data from
		237	the file when the write queue becomes empty.
		238
		239	=item timeout => $fractional_seconds
		240
		241	=item rtimeout => $fractional_seconds
		242
		243	=item wtimeout => $fractional_seconds
		244
		245	If non-zero, then these enables an "inactivity" timeout: whenever this
		246	many seconds pass without a successful read or write on the underlying
		247	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
		248	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		249	error will be raised).
		250
		251	There are three variants of the timeouts that work fully independent
		252	of each other, for both read and write, just read, and just write:
		253	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		254	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		255	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		256
		257	Note that timeout processing is also active when you currently do not have
		258	any outstanding read or write requests: If you plan to keep the connection
		259	idle then you should disable the timout temporarily or ignore the timeout
		260	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		261	restart the timeout.
		262
		263	Zero (the default) disables this timeout.
		264
		265	=item on_timeout => $cb->($handle)
		266
		267	Called whenever the inactivity timeout passes. If you return from this
		268	callback, then the timeout will be reset as if some activity had happened,
		269	so this condition is not fatal in any way.
		270
115	=item rbuf_max => <bytes>	271	=item rbuf_max => <bytes>
116		272
117	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	273	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
118	when the read buffer ever (strictly) exceeds this size. This is useful to	274	when the read buffer ever (strictly) exceeds this size. This is useful to
119	avoid denial-of-service attacks.	275	avoid some forms of denial-of-service attacks.
120		276
121	For example, a server accepting connections from untrusted sources should	277	For example, a server accepting connections from untrusted sources should
122	be configured to accept only so-and-so much data that it cannot act on	278	be configured to accept only so-and-so much data that it cannot act on
123	(for example, when expecting a line, an attacker could send an unlimited	279	(for example, when expecting a line, an attacker could send an unlimited
124	amount of data without a callback ever being called as long as the line	280	amount of data without a callback ever being called as long as the line
125	isn't finished).	281	isn't finished).
126		282
		283	=item autocork => <boolean>
		284
		285	When disabled (the default), then C<push_write> will try to immediately
		286	write the data to the handle, if possible. This avoids having to register
		287	a write watcher and wait for the next event loop iteration, but can
		288	be inefficient if you write multiple small chunks (on the wire, this
		289	disadvantage is usually avoided by your kernel's nagle algorithm, see
		290	C<no_delay>, but this option can save costly syscalls).
		291
		292	When enabled, then writes will always be queued till the next event loop
		293	iteration. This is efficient when you do many small writes per iteration,
		294	but less efficient when you do a single write only per iteration (or when
		295	the write buffer often is full). It also increases write latency.
		296
		297	=item no_delay => <boolean>
		298
		299	When doing small writes on sockets, your operating system kernel might
		300	wait a bit for more data before actually sending it out. This is called
		301	the Nagle algorithm, and usually it is beneficial.
		302
		303	In some situations you want as low a delay as possible, which can be
		304	accomplishd by setting this option to a true value.
		305
		306	The default is your opertaing system's default behaviour (most likely
		307	enabled), this option explicitly enables or disables it, if possible.
		308
		309	=item keepalive => <boolean>
		310
		311	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		312	normally, TCP connections have no time-out once established, so TCP
		313	connections, once established, can stay alive forever even when the other
		314	side has long gone. TCP keepalives are a cheap way to take down long-lived
		315	TCP connections whent he other side becomes unreachable. While the default
		316	is OS-dependent, TCP keepalives usually kick in after around two hours,
		317	and, if the other side doesn't reply, take down the TCP connection some 10
		318	to 15 minutes later.
		319
		320	It is harmless to specify this option for file handles that do not support
		321	keepalives, and enabling it on connections that are potentially long-lived
		322	is usually a good idea.
		323
		324	=item oobinline => <boolean>
		325
		326	BSD majorly fucked up the implementation of TCP urgent data. The result
		327	is that almost no OS implements TCP according to the specs, and every OS
		328	implements it slightly differently.
		329
		330	If you want to handle TCP urgent data, then setting this flag (the default
		331	is enabled) gives you the most portable way of getting urgent data, by
		332	putting it into the stream.
		333
		334	Since BSD emulation of OOB data on top of TCP's urgent data can have
		335	security implications, AnyEvent::Handle sets this flag automatically
		336	unless explicitly specified. Note that setting this flag after
		337	establishing a connection I<may> be a bit too late (data loss could
		338	already have occured on BSD systems), but at least it will protect you
		339	from most attacks.
		340
127	=item read_size => <bytes>	341	=item read_size => <bytes>
128		342
129	The default read block size (the amount of bytes this module will try to read	343	The default read block size (the amount of bytes this module will
130	on each [loop iteration). Default: C<4096>.	344	try to read during each loop iteration, which affects memory
		345	requirements). Default: C<8192>.
131		346
132	=item low_water_mark => <bytes>	347	=item low_water_mark => <bytes>
133		348
134	Sets the amount of bytes (default: C<0>) that make up an "empty" write	349	Sets the amount of bytes (default: C<0>) that make up an "empty" write
135	buffer: If the write reaches this size or gets even samller it is	350	buffer: If the write reaches this size or gets even samller it is
136	considered empty.	351	considered empty.
137		352
		353	Sometimes it can be beneficial (for performance reasons) to add data to
		354	the write buffer before it is fully drained, but this is a rare case, as
		355	the operating system kernel usually buffers data as well, so the default
		356	is good in almost all cases.
		357
		358	=item linger => <seconds>
		359
		360	If non-zero (default: C<3600>), then the destructor of the
		361	AnyEvent::Handle object will check whether there is still outstanding
		362	write data and will install a watcher that will write this data to the
		363	socket. No errors will be reported (this mostly matches how the operating
		364	system treats outstanding data at socket close time).
		365
		366	This will not work for partial TLS data that could not be encoded
		367	yet. This data will be lost. Calling the C<stoptls> method in time might
		368	help.
		369
		370	=item peername => $string
		371
		372	A string used to identify the remote site - usually the DNS hostname
		373	(I<not> IDN!) used to create the connection, rarely the IP address.
		374
		375	Apart from being useful in error messages, this string is also used in TLS
		376	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		377	verification will be skipped when C<peername> is not specified or
		378	C<undef>.
		379
		380	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
		381
		382	When this parameter is given, it enables TLS (SSL) mode, that means
		383	AnyEvent will start a TLS handshake as soon as the connection has been
		384	established and will transparently encrypt/decrypt data afterwards.
		385
		386	All TLS protocol errors will be signalled as C<EPROTO>, with an
		387	appropriate error message.
		388
		389	TLS mode requires Net::SSLeay to be installed (it will be loaded
		390	automatically when you try to create a TLS handle): this module doesn't
		391	have a dependency on that module, so if your module requires it, you have
		392	to add the dependency yourself.
		393
		394	Unlike TCP, TLS has a server and client side: for the TLS server side, use
		395	C<accept>, and for the TLS client side of a connection, use C<connect>
		396	mode.
		397
		398	You can also provide your own TLS connection object, but you have
		399	to make sure that you call either C<Net::SSLeay::set_connect_state>
		400	or C<Net::SSLeay::set_accept_state> on it before you pass it to
		401	AnyEvent::Handle. Also, this module will take ownership of this connection
		402	object.
		403
		404	At some future point, AnyEvent::Handle might switch to another TLS
		405	implementation, then the option to use your own session object will go
		406	away.
		407
		408	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		409	passing in the wrong integer will lead to certain crash. This most often
		410	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		411	segmentation fault.
		412
		413	See the C<< ->starttls >> method for when need to start TLS negotiation later.
		414
		415	=item tls_ctx => $anyevent_tls
		416
		417	Use the given C<AnyEvent::TLS> object to create the new TLS connection
		418	(unless a connection object was specified directly). If this parameter is
		419	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		420
		421	Instead of an object, you can also specify a hash reference with C<< key
		422	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		423	new TLS context object.
		424
		425	=item on_starttls => $cb->($handle, $success[, $error_message])
		426
		427	This callback will be invoked when the TLS/SSL handshake has finished. If
		428	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		429	(C<on_stoptls> will not be called in this case).
		430
		431	The session in C<< $handle->{tls} >> can still be examined in this
		432	callback, even when the handshake was not successful.
		433
		434	TLS handshake failures will not cause C<on_error> to be invoked when this
		435	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		436
		437	Without this callback, handshake failures lead to C<on_error> being
		438	called, as normal.
		439
		440	Note that you cannot call C<starttls> right again in this callback. If you
		441	need to do that, start an zero-second timer instead whose callback can
		442	then call C<< ->starttls >> again.
		443
		444	=item on_stoptls => $cb->($handle)
		445
		446	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		447	set, then it will be invoked after freeing the TLS session. If it is not,
		448	then a TLS shutdown condition will be treated like a normal EOF condition
		449	on the handle.
		450
		451	The session in C<< $handle->{tls} >> can still be examined in this
		452	callback.
		453
		454	This callback will only be called on TLS shutdowns, not when the
		455	underlying handle signals EOF.
		456
		457	=item json => JSON or JSON::XS object
		458
		459	This is the json coder object used by the C<json> read and write types.
		460
		461	If you don't supply it, then AnyEvent::Handle will create and use a
		462	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		463	texts.
		464
		465	Note that you are responsible to depend on the JSON module if you want to
		466	use this functionality, as AnyEvent does not have a dependency itself.
		467
138	=back	468	=back
139		469
140	=cut	470	=cut
141		471
142	sub new {	472	sub new {
143	my $class = shift;	473	my $class = shift;
144
145	my $self = bless { @_ }, $class;	474	my $self = bless { @_ }, $class;
146		475
147	$self->{fh} or Carp::croak "mandatory argument fh is missing";	476	if ($self->{fh}) {
		477	$self->_start;
		478	return unless $self->{fh}; # could be gone by now
		479
		480	} elsif ($self->{connect}) {
		481	require AnyEvent::Socket;
		482
		483	$self->{peername} = $self->{connect}[0]
		484	unless exists $self->{peername};
		485
		486	$self->{_skip_drain_rbuf} = 1;
		487
		488	{
		489	Scalar::Util::weaken (my $self = $self);
		490
		491	$self->{_connect} =
		492	AnyEvent::Socket::tcp_connect (
		493	$self->{connect}[0],
		494	$self->{connect}[1],
		495	sub {
		496	my ($fh, $host, $port, $retry) = @_;
		497
		498	if ($fh) {
		499	$self->{fh} = $fh;
		500
		501	delete $self->{_skip_drain_rbuf};
		502	$self->_start;
		503
		504	$self->{on_connect}
		505	and $self->{on_connect}($self, $host, $port, sub {
		506	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		507	$self->{_skip_drain_rbuf} = 1;
		508	&$retry;
		509	});
		510
		511	} else {
		512	if ($self->{on_connect_error}) {
		513	$self->{on_connect_error}($self, "$!");
		514	$self->destroy;
		515	} else {
		516	$self->_error ($!, 1);
		517	}
		518	}
		519	},
		520	sub {
		521	local $self->{fh} = $_[0];
		522
		523	$self->{on_prepare}
		524	? $self->{on_prepare}->($self)
		525	: ()
		526	}
		527	);
		528	}
		529
		530	} else {
		531	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		532	}
		533
		534	$self
		535	}
		536
		537	sub _start {
		538	my ($self) = @_;
		539
		540	# too many clueless people try to use udp and similar sockets
		541	# with AnyEvent::Handle, do them a favour.
		542	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		543	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		544	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
148		545
149	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	546	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
150		547
151	$self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing");	548	$self->{_activity} =
		549	$self->{_ractivity} =
		550	$self->{_wactivity} = AE::now;
152		551
153	$self->on_error (delete $self->{on_error}) if $self->{on_error};	552	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		553	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		554	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		555
		556	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		557	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		558
		559	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		560
		561	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		562	if $self->{tls};
		563
154	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	564	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
155	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
156		565
157	$self->start_read;	566	$self->start_read
		567	if $self->{on_read} || @{ $self->{_queue} };
158		568
159	$self	569	$self->_drain_wbuf;
160	}	570	}
161		571
162	sub _shutdown {
163	my ($self) = @_;
164
165	delete $self->{rw};
166	delete $self->{ww};
167	delete $self->{fh};
168	}
169
170	sub error {	572	sub _error {
171	my ($self) = @_;	573	my ($self, $errno, $fatal, $message) = @_;
172		574
173	{	575	$! = $errno;
174	local $!;	576	$message ||= "$!";
175	$self->_shutdown;
176	}
177		577
178	if ($self->{on_error}) {	578	if ($self->{on_error}) {
179	$self->{on_error}($self);	579	$self->{on_error}($self, $fatal, $message);
180	} else {	580	$self->destroy if $fatal;
		581	} elsif ($self->{fh} || $self->{connect}) {
		582	$self->destroy;
181	die "AnyEvent::Handle uncaught fatal error: $!";	583	Carp::croak "AnyEvent::Handle uncaught error: $message";
182	}	584	}
183	}	585	}
184		586
185	=item $fh = $handle->fh	587	=item $fh = $handle->fh
186		588
187	This method returns the filehandle of the L<AnyEvent::Handle> object.	589	This method returns the file handle used to create the L<AnyEvent::Handle> object.
188		590
189	=cut	591	=cut
190		592
191	sub fh { $_[0]->{fh} }	593	sub fh { $_[0]{fh} }
192		594
193	=item $handle->on_error ($cb)	595	=item $handle->on_error ($cb)
194		596
195	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	597	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
196		598
…		…
208		610
209	sub on_eof {	611	sub on_eof {
210	$_[0]{on_eof} = $_[1];	612	$_[0]{on_eof} = $_[1];
211	}	613	}
212		614
		615	=item $handle->on_timeout ($cb)
		616
		617	=item $handle->on_rtimeout ($cb)
		618
		619	=item $handle->on_wtimeout ($cb)
		620
		621	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
		622	callback, or disables the callback (but not the timeout) if C<$cb> =
		623	C<undef>. See the C<timeout> constructor argument and method.
		624
		625	=cut
		626
		627	# see below
		628
		629	=item $handle->autocork ($boolean)
		630
		631	Enables or disables the current autocork behaviour (see C<autocork>
		632	constructor argument). Changes will only take effect on the next write.
		633
		634	=cut
		635
		636	sub autocork {
		637	$_[0]{autocork} = $_[1];
		638	}
		639
		640	=item $handle->no_delay ($boolean)
		641
		642	Enables or disables the C<no_delay> setting (see constructor argument of
		643	the same name for details).
		644
		645	=cut
		646
		647	sub no_delay {
		648	$_[0]{no_delay} = $_[1];
		649
		650	eval {
		651	local $SIG{__DIE__};
		652	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		653	if $_[0]{fh};
		654	};
		655	}
		656
		657	=item $handle->keepalive ($boolean)
		658
		659	Enables or disables the C<keepalive> setting (see constructor argument of
		660	the same name for details).
		661
		662	=cut
		663
		664	sub keepalive {
		665	$_[0]{keepalive} = $_[1];
		666
		667	eval {
		668	local $SIG{__DIE__};
		669	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		670	if $_[0]{fh};
		671	};
		672	}
		673
		674	=item $handle->oobinline ($boolean)
		675
		676	Enables or disables the C<oobinline> setting (see constructor argument of
		677	the same name for details).
		678
		679	=cut
		680
		681	sub oobinline {
		682	$_[0]{oobinline} = $_[1];
		683
		684	eval {
		685	local $SIG{__DIE__};
		686	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		687	if $_[0]{fh};
		688	};
		689	}
		690
		691	=item $handle->keepalive ($boolean)
		692
		693	Enables or disables the C<keepalive> setting (see constructor argument of
		694	the same name for details).
		695
		696	=cut
		697
		698	sub keepalive {
		699	$_[0]{keepalive} = $_[1];
		700
		701	eval {
		702	local $SIG{__DIE__};
		703	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		704	if $_[0]{fh};
		705	};
		706	}
		707
		708	=item $handle->on_starttls ($cb)
		709
		710	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		711
		712	=cut
		713
		714	sub on_starttls {
		715	$_[0]{on_starttls} = $_[1];
		716	}
		717
		718	=item $handle->on_stoptls ($cb)
		719
		720	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		721
		722	=cut
		723
		724	sub on_stoptls {
		725	$_[0]{on_stoptls} = $_[1];
		726	}
		727
		728	=item $handle->rbuf_max ($max_octets)
		729
		730	Configures the C<rbuf_max> setting (C<undef> disables it).
		731
		732	=cut
		733
		734	sub rbuf_max {
		735	$_[0]{rbuf_max} = $_[1];
		736	}
		737
		738	#############################################################################
		739
		740	=item $handle->timeout ($seconds)
		741
		742	=item $handle->rtimeout ($seconds)
		743
		744	=item $handle->wtimeout ($seconds)
		745
		746	Configures (or disables) the inactivity timeout.
		747
		748	=item $handle->timeout_reset
		749
		750	=item $handle->rtimeout_reset
		751
		752	=item $handle->wtimeout_reset
		753
		754	Reset the activity timeout, as if data was received or sent.
		755
		756	These methods are cheap to call.
		757
		758	=cut
		759
		760	for my $dir ("", "r", "w") {
		761	my $timeout = "${dir}timeout";
		762	my $tw = "_${dir}tw";
		763	my $on_timeout = "on_${dir}timeout";
		764	my $activity = "_${dir}activity";
		765	my $cb;
		766
		767	*$on_timeout = sub {
		768	$_[0]{$on_timeout} = $_[1];
		769	};
		770
		771	*$timeout = sub {
		772	my ($self, $new_value) = @_;
		773
		774	$self->{$timeout} = $new_value;
		775	delete $self->{$tw}; &$cb;
		776	};
		777
		778	*{"${dir}timeout_reset"} = sub {
		779	$_[0]{$activity} = AE::now;
		780	};
		781
		782	# main workhorse:
		783	# reset the timeout watcher, as neccessary
		784	# also check for time-outs
		785	$cb = sub {
		786	my ($self) = @_;
		787
		788	if ($self->{$timeout} && $self->{fh}) {
		789	my $NOW = AE::now;
		790
		791	# when would the timeout trigger?
		792	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
		793
		794	# now or in the past already?
		795	if ($after <= 0) {
		796	$self->{$activity} = $NOW;
		797
		798	if ($self->{$on_timeout}) {
		799	$self->{$on_timeout}($self);
		800	} else {
		801	$self->_error (Errno::ETIMEDOUT);
		802	}
		803
		804	# callback could have changed timeout value, optimise
		805	return unless $self->{$timeout};
		806
		807	# calculate new after
		808	$after = $self->{$timeout};
		809	}
		810
		811	Scalar::Util::weaken $self;
		812	return unless $self; # ->error could have destroyed $self
		813
		814	$self->{$tw} ||= AE::timer $after, 0, sub {
		815	delete $self->{$tw};
		816	$cb->($self);
		817	};
		818	} else {
		819	delete $self->{$tw};
		820	}
		821	}
		822	}
		823
213	#############################################################################	824	#############################################################################
214		825
215	=back	826	=back
216		827
217	=head2 WRITE QUEUE	828	=head2 WRITE QUEUE
…		…
220	for reading.	831	for reading.
221		832
222	The write queue is very simple: you can add data to its end, and	833	The write queue is very simple: you can add data to its end, and
223	AnyEvent::Handle will automatically try to get rid of it for you.	834	AnyEvent::Handle will automatically try to get rid of it for you.
224		835
225	When data could be writtena nd the write buffer is shorter then the low	836	When data could be written and the write buffer is shorter then the low
226	water mark, the C<on_drain> callback will be invoked.	837	water mark, the C<on_drain> callback will be invoked.
227		838
228	=over 4	839	=over 4
229		840
230	=item $handle->on_drain ($cb)	841	=item $handle->on_drain ($cb)
231		842
232	Sets the C<on_drain> callback or clears it (see the description of	843	Sets the C<on_drain> callback or clears it (see the description of
233	C<on_drain> in the constructor).	844	C<on_drain> in the constructor).
234		845
		846	This method may invoke callbacks (and therefore the handle might be
		847	destroyed after it returns).
		848
235	=cut	849	=cut
236		850
237	sub on_drain {	851	sub on_drain {
238	my ($self, $cb) = @_;	852	my ($self, $cb) = @_;
239		853
240	$self->{on_drain} = $cb;	854	$self->{on_drain} = $cb;
241		855
242	$cb->($self)	856	$cb->($self)
243	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	857	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
244	}	858	}
245		859
246	=item $handle->push_write ($data)	860	=item $handle->push_write ($data)
247		861
248	Queues the given scalar to be written. You can push as much data as you	862	Queues the given scalar to be written. You can push as much data as you
249	want (only limited by the available memory), as C<AnyEvent::Handle>	863	want (only limited by the available memory), as C<AnyEvent::Handle>
250	buffers it independently of the kernel.	864	buffers it independently of the kernel.
251		865
252	=cut	866	This method may invoke callbacks (and therefore the handle might be
		867	destroyed after it returns).
253		868
254	sub push_write {	869	=cut
		870
		871	sub _drain_wbuf {
255	my ($self, $data) = @_;	872	my ($self) = @_;
256		873
257	$self->{wbuf} .= $data;	874	if (!$self->{_ww} && length $self->{wbuf}) {
258		875
259	unless ($self->{ww}) {
260	Scalar::Util::weaken $self;	876	Scalar::Util::weaken $self;
		877
261	my $cb = sub {	878	my $cb = sub {
262	my $len = syswrite $self->{fh}, $self->{wbuf};	879	my $len = syswrite $self->{fh}, $self->{wbuf};
263		880
264	if ($len > 0) {	881	if (defined $len) {
265	substr $self->{wbuf}, 0, $len, "";	882	substr $self->{wbuf}, 0, $len, "";
266		883
		884	$self->{_activity} = $self->{_wactivity} = AE::now;
267		885
268	$self->{on_drain}($self)	886	$self->{on_drain}($self)
269	if $self->{low_water_mark} >= length $self->{wbuf}	887	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
270	&& $self->{on_drain};	888	&& $self->{on_drain};
271		889
272	delete $self->{ww} unless length $self->{wbuf};	890	delete $self->{_ww} unless length $self->{wbuf};
273	} elsif ($! != EAGAIN && $! != EINTR) {	891	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
274	$self->error;	892	$self->_error ($!, 1);
275	}	893	}
276	};	894	};
277		895
278	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	896	# try to write data immediately
		897	$cb->() unless $self->{autocork};
279		898
280	$cb->($self);	899	# if still data left in wbuf, we need to poll
		900	$self->{_ww} = AE::io $self->{fh}, 1, $cb
		901	if length $self->{wbuf};
281	};	902	};
282	}	903	}
		904
		905	our %WH;
		906
		907	# deprecated
		908	sub register_write_type($$) {
		909	$WH{$_[0]} = $_[1];
		910	}
		911
		912	sub push_write {
		913	my $self = shift;
		914
		915	if (@_ > 1) {
		916	my $type = shift;
		917
		918	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
		919	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
		920	->($self, @_);
		921	}
		922
		923	# we downgrade here to avoid hard-to-track-down bugs,
		924	# and diagnose the problem earlier and better.
		925
		926	if ($self->{tls}) {
		927	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
		928	&_dotls ($self) if $self->{fh};
		929	} else {
		930	utf8::downgrade $self->{wbuf} .= $_[0];
		931	$self->_drain_wbuf if $self->{fh};
		932	}
		933	}
		934
		935	=item $handle->push_write (type => @args)
		936
		937	Instead of formatting your data yourself, you can also let this module
		938	do the job by specifying a type and type-specific arguments. You
		939	can also specify the (fully qualified) name of a package, in which
		940	case AnyEvent tries to load the package and then expects to find the
		941	C<anyevent_write_type> function inside (see "custom write types", below).
		942
		943	Predefined types are (if you have ideas for additional types, feel free to
		944	drop by and tell us):
		945
		946	=over 4
		947
		948	=item netstring => $string
		949
		950	Formats the given value as netstring
		951	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		952
		953	=cut
		954
		955	register_write_type netstring => sub {
		956	my ($self, $string) = @_;
		957
		958	(length $string) . ":$string,"
		959	};
		960
		961	=item packstring => $format, $data
		962
		963	An octet string prefixed with an encoded length. The encoding C<$format>
		964	uses the same format as a Perl C<pack> format, but must specify a single
		965	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		966	optional C<!>, C<< < >> or C<< > >> modifier).
		967
		968	=cut
		969
		970	register_write_type packstring => sub {
		971	my ($self, $format, $string) = @_;
		972
		973	pack "$format/a*", $string
		974	};
		975
		976	=item json => $array_or_hashref
		977
		978	Encodes the given hash or array reference into a JSON object. Unless you
		979	provide your own JSON object, this means it will be encoded to JSON text
		980	in UTF-8.
		981
		982	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		983	one end of a handle and read them at the other end without using any
		984	additional framing.
		985
		986	The generated JSON text is guaranteed not to contain any newlines: While
		987	this module doesn't need delimiters after or between JSON texts to be
		988	able to read them, many other languages depend on that.
		989
		990	A simple RPC protocol that interoperates easily with others is to send
		991	JSON arrays (or objects, although arrays are usually the better choice as
		992	they mimic how function argument passing works) and a newline after each
		993	JSON text:
		994
		995	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		996	$handle->push_write ("\012");
		997
		998	An AnyEvent::Handle receiver would simply use the C<json> read type and
		999	rely on the fact that the newline will be skipped as leading whitespace:
		1000
		1001	$handle->push_read (json => sub { my $array = $_[1]; ... });
		1002
		1003	Other languages could read single lines terminated by a newline and pass
		1004	this line into their JSON decoder of choice.
		1005
		1006	=cut
		1007
		1008	sub json_coder() {
		1009	eval { require JSON::XS; JSON::XS->new->utf8 }
		1010	|| do { require JSON; JSON->new->utf8 }
		1011	}
		1012
		1013	register_write_type json => sub {
		1014	my ($self, $ref) = @_;
		1015
		1016	my $json = $self->{json} ||= json_coder;
		1017
		1018	$json->encode ($ref)
		1019	};
		1020
		1021	=item storable => $reference
		1022
		1023	Freezes the given reference using L<Storable> and writes it to the
		1024	handle. Uses the C<nfreeze> format.
		1025
		1026	=cut
		1027
		1028	register_write_type storable => sub {
		1029	my ($self, $ref) = @_;
		1030
		1031	require Storable;
		1032
		1033	pack "w/a*", Storable::nfreeze ($ref)
		1034	};
		1035
		1036	=back
		1037
		1038	=item $handle->push_shutdown
		1039
		1040	Sometimes you know you want to close the socket after writing your data
		1041	before it was actually written. One way to do that is to replace your
		1042	C<on_drain> handler by a callback that shuts down the socket (and set
		1043	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1044	replaces the C<on_drain> callback with:
		1045
		1046	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1047
		1048	This simply shuts down the write side and signals an EOF condition to the
		1049	the peer.
		1050
		1051	You can rely on the normal read queue and C<on_eof> handling
		1052	afterwards. This is the cleanest way to close a connection.
		1053
		1054	This method may invoke callbacks (and therefore the handle might be
		1055	destroyed after it returns).
		1056
		1057	=cut
		1058
		1059	sub push_shutdown {
		1060	my ($self) = @_;
		1061
		1062	delete $self->{low_water_mark};
		1063	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1064	}
		1065
		1066	=item custom write types - Package::anyevent_write_type $handle, @args
		1067
		1068	Instead of one of the predefined types, you can also specify the name of
		1069	a package. AnyEvent will try to load the package and then expects to find
		1070	a function named C<anyevent_write_type> inside. If it isn't found, it
		1071	progressively tries to load the parent package until it either finds the
		1072	function (good) or runs out of packages (bad).
		1073
		1074	Whenever the given C<type> is used, C<push_write> will the function with
		1075	the handle object and the remaining arguments.
		1076
		1077	The function is supposed to return a single octet string that will be
		1078	appended to the write buffer, so you cna mentally treat this function as a
		1079	"arguments to on-the-wire-format" converter.
		1080
		1081	Example: implement a custom write type C<join> that joins the remaining
		1082	arguments using the first one.
		1083
		1084	$handle->push_write (My::Type => " ", 1,2,3);
		1085
		1086	# uses the following package, which can be defined in the "My::Type" or in
		1087	# the "My" modules to be auto-loaded, or just about anywhere when the
		1088	# My::Type::anyevent_write_type is defined before invoking it.
		1089
		1090	package My::Type;
		1091
		1092	sub anyevent_write_type {
		1093	my ($handle, $delim, @args) = @_;
		1094
		1095	join $delim, @args
		1096	}
		1097
		1098	=cut
283		1099
284	#############################################################################	1100	#############################################################################
285		1101
286	=back	1102	=back
287		1103
…		…
294	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1110	ways, the "simple" way, using only C<on_read> and the "complex" way, using
295	a queue.	1111	a queue.
296		1112
297	In the simple case, you just install an C<on_read> callback and whenever	1113	In the simple case, you just install an C<on_read> callback and whenever
298	new data arrives, it will be called. You can then remove some data (if	1114	new data arrives, it will be called. You can then remove some data (if
299	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	1115	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
300	or not.	1116	leave the data there if you want to accumulate more (e.g. when only a
		1117	partial message has been received so far), or change the read queue with
		1118	e.g. C<push_read>.
301		1119
302	In the more complex case, you want to queue multiple callbacks. In this	1120	In the more complex case, you want to queue multiple callbacks. In this
303	case, AnyEvent::Handle will call the first queued callback each time new	1121	case, AnyEvent::Handle will call the first queued callback each time new
304	data arrives and removes it when it has done its job (see C<push_read>,	1122	data arrives (also the first time it is queued) and removes it when it has
305	below).	1123	done its job (see C<push_read>, below).
306		1124
307	This way you can, for example, push three line-reads, followed by reading	1125	This way you can, for example, push three line-reads, followed by reading
308	a chunk of data, and AnyEvent::Handle will execute them in order.	1126	a chunk of data, and AnyEvent::Handle will execute them in order.
309		1127
310	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	1128	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
311	the specified number of bytes which give an XML datagram.	1129	the specified number of bytes which give an XML datagram.
312		1130
313	# in the default state, expect some header bytes	1131	# in the default state, expect some header bytes
314	$handle->on_read (sub {	1132	$handle->on_read (sub {
315	# some data is here, now queue the length-header-read (4 octets)	1133	# some data is here, now queue the length-header-read (4 octets)
316	shift->unshift_read_chunk (4, sub {	1134	shift->unshift_read (chunk => 4, sub {
317	# header arrived, decode	1135	# header arrived, decode
318	my $len = unpack "N", $_[1];	1136	my $len = unpack "N", $_[1];
319		1137
320	# now read the payload	1138	# now read the payload
321	shift->unshift_read_chunk ($len, sub {	1139	shift->unshift_read (chunk => $len, sub {
322	my $xml = $_[1];	1140	my $xml = $_[1];
323	# handle xml	1141	# handle xml
324	});	1142	});
325	});	1143	});
326	});	1144	});
327		1145
328	Example 2: Implement a client for a protocol that replies either with	1146	Example 2: Implement a client for a protocol that replies either with "OK"
329	"OK" and another line or "ERROR" for one request, and 64 bytes for the	1147	and another line or "ERROR" for the first request that is sent, and 64
330	second request. Due tot he availability of a full queue, we can just	1148	bytes for the second request. Due to the availability of a queue, we can
331	pipeline sending both requests and manipulate the queue as necessary in	1149	just pipeline sending both requests and manipulate the queue as necessary
332	the callbacks:	1150	in the callbacks.
333		1151
334	# request one	1152	When the first callback is called and sees an "OK" response, it will
		1153	C<unshift> another line-read. This line-read will be queued I<before> the
		1154	64-byte chunk callback.
		1155
		1156	# request one, returns either "OK + extra line" or "ERROR"
335	$handle->push_write ("request 1\015\012");	1157	$handle->push_write ("request 1\015\012");
336		1158
337	# we expect "ERROR" or "OK" as response, so push a line read	1159	# we expect "ERROR" or "OK" as response, so push a line read
338	$handle->push_read_line (sub {	1160	$handle->push_read (line => sub {
339	# if we got an "OK", we have to _prepend_ another line,	1161	# if we got an "OK", we have to _prepend_ another line,
340	# so it will be read before the second request reads its 64 bytes	1162	# so it will be read before the second request reads its 64 bytes
341	# which are already in the queue when this callback is called	1163	# which are already in the queue when this callback is called
342	# we don't do this in case we got an error	1164	# we don't do this in case we got an error
343	if ($_[1] eq "OK") {	1165	if ($_[1] eq "OK") {
344	$_[0]->unshift_read_line (sub {	1166	$_[0]->unshift_read (line => sub {
345	my $response = $_[1];	1167	my $response = $_[1];
346	...	1168	...
347	});	1169	});
348	}	1170	}
349	});	1171	});
350		1172
351	# request two	1173	# request two, simply returns 64 octets
352	$handle->push_write ("request 2\015\012");	1174	$handle->push_write ("request 2\015\012");
353		1175
354	# simply read 64 bytes, always	1176	# simply read 64 bytes, always
355	$handle->push_read_chunk (64, sub {	1177	$handle->push_read (chunk => 64, sub {
356	my $response = $_[1];	1178	my $response = $_[1];
357	...	1179	...
358	});	1180	});
359		1181
360	=over 4	1182	=over 4
…		…
362	=cut	1184	=cut
363		1185
364	sub _drain_rbuf {	1186	sub _drain_rbuf {
365	my ($self) = @_;	1187	my ($self) = @_;
366		1188
		1189	# avoid recursion
367	return if $self->{in_drain};	1190	return if $self->{_skip_drain_rbuf};
368	local $self->{in_drain} = 1;	1191	local $self->{_skip_drain_rbuf} = 1;
369		1192
		1193	while () {
		1194	# we need to use a separate tls read buffer, as we must not receive data while
		1195	# we are draining the buffer, and this can only happen with TLS.
		1196	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1197	if exists $self->{_tls_rbuf};
		1198
370	while (my $len = length $self->{rbuf}) {	1199	my $len = length $self->{rbuf};
371	no strict 'refs';	1200
372	if (my $cb = shift @{ $self->{queue} }) {	1201	if (my $cb = shift @{ $self->{_queue} }) {
373	if (!$cb->($self)) {	1202	unless ($cb->($self)) {
		1203	# no progress can be made
		1204	# (not enough data and no data forthcoming)
		1205	$self->_error (Errno::EPIPE, 1), return
374	if ($self->{eof}) {	1206	if $self->{_eof};
375	# no progress can be made (not enough data and no data forthcoming)
376	$! = &Errno::EPIPE; return $self->error;
377	}
378		1207
379	unshift @{ $self->{queue} }, $cb;	1208	unshift @{ $self->{_queue} }, $cb;
380	return;	1209	last;
381	}	1210	}
382	} elsif ($self->{on_read}) {	1211	} elsif ($self->{on_read}) {
		1212	last unless $len;
		1213
383	$self->{on_read}($self);	1214	$self->{on_read}($self);
384		1215
385	if (	1216	if (
386	$self->{eof} # if no further data will arrive
387	&& $len == length $self->{rbuf} # and no data has been consumed	1217	$len == length $self->{rbuf} # if no data has been consumed
388	&& !@{ $self->{queue} } # and the queue is still empty	1218	&& !@{ $self->{_queue} } # and the queue is still empty
389	&& $self->{on_read} # and we still want to read data	1219	&& $self->{on_read} # but we still have on_read
390	) {	1220	) {
		1221	# no further data will arrive
391	# then no progress can be made	1222	# so no progress can be made
392	$! = &Errno::EPIPE; return $self->error;	1223	$self->_error (Errno::EPIPE, 1), return
		1224	if $self->{_eof};
		1225
		1226	last; # more data might arrive
393	}	1227	}
394	} else {	1228	} else {
395	# read side becomes idle	1229	# read side becomes idle
396	delete $self->{rw};	1230	delete $self->{_rw} unless $self->{tls};
397	return;	1231	last;
398	}	1232	}
399	}	1233	}
400		1234
401	if ($self->{eof}) {	1235	if ($self->{_eof}) {
402	$self->_shutdown;	1236	$self->{on_eof}
403	$self->{on_eof}($self);	1237	? $self->{on_eof}($self)
		1238	: $self->_error (0, 1, "Unexpected end-of-file");
		1239
		1240	return;
		1241	}
		1242
		1243	if (
		1244	defined $self->{rbuf_max}
		1245	&& $self->{rbuf_max} < length $self->{rbuf}
		1246	) {
		1247	$self->_error (Errno::ENOSPC, 1), return;
		1248	}
		1249
		1250	# may need to restart read watcher
		1251	unless ($self->{_rw}) {
		1252	$self->start_read
		1253	if $self->{on_read} || @{ $self->{_queue} };
404	}	1254	}
405	}	1255	}
406		1256
407	=item $handle->on_read ($cb)	1257	=item $handle->on_read ($cb)
408		1258
409	This replaces the currently set C<on_read> callback, or clears it (when	1259	This replaces the currently set C<on_read> callback, or clears it (when
410	the new callback is C<undef>). See the description of C<on_read> in the	1260	the new callback is C<undef>). See the description of C<on_read> in the
411	constructor.	1261	constructor.
412		1262
		1263	This method may invoke callbacks (and therefore the handle might be
		1264	destroyed after it returns).
		1265
413	=cut	1266	=cut
414		1267
415	sub on_read {	1268	sub on_read {
416	my ($self, $cb) = @_;	1269	my ($self, $cb) = @_;
417		1270
418	$self->{on_read} = $cb;	1271	$self->{on_read} = $cb;
		1272	$self->_drain_rbuf if $cb;
419	}	1273	}
420		1274
421	=item $handle->rbuf	1275	=item $handle->rbuf
422		1276
423	Returns the read buffer (as a modifiable lvalue).	1277	Returns the read buffer (as a modifiable lvalue).
424		1278
425	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1279	You can access the read buffer directly as the C<< ->{rbuf} >>
426	you want.	1280	member, if you want. However, the only operation allowed on the
		1281	read buffer (apart from looking at it) is removing data from its
		1282	beginning. Otherwise modifying or appending to it is not allowed and will
		1283	lead to hard-to-track-down bugs.
427		1284
428	NOTE: The read buffer should only be used or modified if the C<on_read>,	1285	NOTE: The read buffer should only be used or modified if the C<on_read>,
429	C<push_read> or C<unshift_read> methods are used. The other read methods	1286	C<push_read> or C<unshift_read> methods are used. The other read methods
430	automatically manage the read buffer.	1287	automatically manage the read buffer.
431		1288
…		…
442	Append the given callback to the end of the queue (C<push_read>) or	1299	Append the given callback to the end of the queue (C<push_read>) or
443	prepend it (C<unshift_read>).	1300	prepend it (C<unshift_read>).
444		1301
445	The callback is called each time some additional read data arrives.	1302	The callback is called each time some additional read data arrives.
446		1303
447	It must check wether enough data is in the read buffer already.	1304	It must check whether enough data is in the read buffer already.
448		1305
449	If not enough data is available, it must return the empty list or a false	1306	If not enough data is available, it must return the empty list or a false
450	value, in which case it will be called repeatedly until enough data is	1307	value, in which case it will be called repeatedly until enough data is
451	available (or an error condition is detected).	1308	available (or an error condition is detected).
452		1309
453	If enough data was available, then the callback must remove all data it is	1310	If enough data was available, then the callback must remove all data it is
454	interested in (which can be none at all) and return a true value. After returning	1311	interested in (which can be none at all) and return a true value. After returning
455	true, it will be removed from the queue.	1312	true, it will be removed from the queue.
456		1313
		1314	These methods may invoke callbacks (and therefore the handle might be
		1315	destroyed after it returns).
		1316
457	=cut	1317	=cut
		1318
		1319	our %RH;
		1320
		1321	sub register_read_type($$) {
		1322	$RH{$_[0]} = $_[1];
		1323	}
458		1324
459	sub push_read {	1325	sub push_read {
460	my ($self, $cb) = @_;	1326	my $self = shift;
		1327	my $cb = pop;
461		1328
		1329	if (@_) {
		1330	my $type = shift;
		1331
		1332	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
		1333	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
		1334	->($self, $cb, @_);
		1335	}
		1336
462	push @{ $self->{queue} }, $cb;	1337	push @{ $self->{_queue} }, $cb;
463	$self->_drain_rbuf;	1338	$self->_drain_rbuf;
464	}	1339	}
465		1340
466	sub unshift_read {	1341	sub unshift_read {
467	my ($self, $cb) = @_;	1342	my $self = shift;
		1343	my $cb = pop;
468		1344
		1345	if (@_) {
		1346	my $type = shift;
		1347
		1348	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		1349	->($self, $cb, @_);
		1350	}
		1351
469	push @{ $self->{queue} }, $cb;	1352	unshift @{ $self->{_queue} }, $cb;
470	$self->_drain_rbuf;	1353	$self->_drain_rbuf;
471	}	1354	}
472		1355
473	=item $handle->push_read_chunk ($len, $cb->($self, $data))	1356	=item $handle->push_read (type => @args, $cb)
474		1357
475	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	1358	=item $handle->unshift_read (type => @args, $cb)
476		1359
477	Append the given callback to the end of the queue (C<push_read_chunk>) or	1360	Instead of providing a callback that parses the data itself you can chose
478	prepend it (C<unshift_read_chunk>).	1361	between a number of predefined parsing formats, for chunks of data, lines
		1362	etc. You can also specify the (fully qualified) name of a package, in
		1363	which case AnyEvent tries to load the package and then expects to find the
		1364	C<anyevent_read_type> function inside (see "custom read types", below).
479		1365
480	The callback will be called only once C<$len> bytes have been read, and	1366	Predefined types are (if you have ideas for additional types, feel free to
481	these C<$len> bytes will be passed to the callback.	1367	drop by and tell us):
482		1368
483	=cut	1369	=over 4
484		1370
485	sub _read_chunk($$) {	1371	=item chunk => $octets, $cb->($handle, $data)
		1372
		1373	Invoke the callback only once C<$octets> bytes have been read. Pass the
		1374	data read to the callback. The callback will never be called with less
		1375	data.
		1376
		1377	Example: read 2 bytes.
		1378
		1379	$handle->push_read (chunk => 2, sub {
		1380	warn "yay ", unpack "H*", $_[1];
		1381	});
		1382
		1383	=cut
		1384
		1385	register_read_type chunk => sub {
486	my ($self, $len, $cb) = @_;	1386	my ($self, $cb, $len) = @_;
487		1387
488	sub {	1388	sub {
489	$len <= length $_[0]{rbuf} or return;	1389	$len <= length $_[0]{rbuf} or return;
490	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1390	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
491	1	1391	1
492	}	1392	}
493	}	1393	};
494		1394
495	sub push_read_chunk {	1395	=item line => [$eol, ]$cb->($handle, $line, $eol)
496	$_[0]->push_read (&_read_chunk);
497	}
498
499
500	sub unshift_read_chunk {
501	$_[0]->unshift_read (&_read_chunk);
502	}
503
504	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))
505
506	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
507
508	Append the given callback to the end of the queue (C<push_read_line>) or
509	prepend it (C<unshift_read_line>).
510		1396
511	The callback will be called only once a full line (including the end of	1397	The callback will be called only once a full line (including the end of
512	line marker, C<$eol>) has been read. This line (excluding the end of line	1398	line marker, C<$eol>) has been read. This line (excluding the end of line
513	marker) will be passed to the callback as second argument (C<$line>), and	1399	marker) will be passed to the callback as second argument (C<$line>), and
514	the end of line marker as the third argument (C<$eol>).	1400	the end of line marker as the third argument (C<$eol>).
…		…
525	Partial lines at the end of the stream will never be returned, as they are	1411	Partial lines at the end of the stream will never be returned, as they are
526	not marked by the end of line marker.	1412	not marked by the end of line marker.
527		1413
528	=cut	1414	=cut
529		1415
530	sub _read_line($$) {	1416	register_read_type line => sub {
531	my $self = shift;	1417	my ($self, $cb, $eol) = @_;
532	my $cb = pop;
533	my $eol = @_ ? shift : qr|(\015?\012)|;
534	my $pos;
535		1418
		1419	if (@_ < 3) {
		1420	# this is more than twice as fast as the generic code below
		1421	sub {
		1422	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1423
		1424	$cb->($_[0], $1, $2);
		1425	1
		1426	}
		1427	} else {
536	$eol = qr|(\Q$eol\E)| unless ref $eol;	1428	$eol = quotemeta $eol unless ref $eol;
537	$eol = qr|^(.*?)($eol)|;	1429	$eol = qr|^(.*?)($eol)|s;
		1430
		1431	sub {
		1432	$_[0]{rbuf} =~ s/$eol// or return;
		1433
		1434	$cb->($_[0], $1, $2);
		1435	1
		1436	}
		1437	}
		1438	};
		1439
		1440	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		1441
		1442	Makes a regex match against the regex object C<$accept> and returns
		1443	everything up to and including the match.
		1444
		1445	Example: read a single line terminated by '\n'.
		1446
		1447	$handle->push_read (regex => qr<\n>, sub { ... });
		1448
		1449	If C<$reject> is given and not undef, then it determines when the data is
		1450	to be rejected: it is matched against the data when the C<$accept> regex
		1451	does not match and generates an C<EBADMSG> error when it matches. This is
		1452	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		1453	receive buffer overflow).
		1454
		1455	Example: expect a single decimal number followed by whitespace, reject
		1456	anything else (not the use of an anchor).
		1457
		1458	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		1459
		1460	If C<$skip> is given and not C<undef>, then it will be matched against
		1461	the receive buffer when neither C<$accept> nor C<$reject> match,
		1462	and everything preceding and including the match will be accepted
		1463	unconditionally. This is useful to skip large amounts of data that you
		1464	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		1465	have to start matching from the beginning. This is purely an optimisation
		1466	and is usually worth only when you expect more than a few kilobytes.
		1467
		1468	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		1469	expect the header to be very large (it isn't in practise, but...), we use
		1470	a skip regex to skip initial portions. The skip regex is tricky in that
		1471	it only accepts something not ending in either \015 or \012, as these are
		1472	required for the accept regex.
		1473
		1474	$handle->push_read (regex =>
		1475	qr<\015\012\015\012>,
		1476	undef, # no reject
		1477	qr<^.*[^\015\012]>,
		1478	sub { ... });
		1479
		1480	=cut
		1481
		1482	register_read_type regex => sub {
		1483	my ($self, $cb, $accept, $reject, $skip) = @_;
		1484
		1485	my $data;
		1486	my $rbuf = \$self->{rbuf};
538		1487
539	sub {	1488	sub {
540	$_[0]{rbuf} =~ s/$eol// or return;	1489	# accept
		1490	if ($$rbuf =~ $accept) {
		1491	$data .= substr $$rbuf, 0, $+[0], "";
		1492	$cb->($self, $data);
		1493	return 1;
		1494	}
		1495
		1496	# reject
		1497	if ($reject && $$rbuf =~ $reject) {
		1498	$self->_error (Errno::EBADMSG);
		1499	}
541		1500
542	$cb->($_[0], $1, $2);	1501	# skip
		1502	if ($skip && $$rbuf =~ $skip) {
		1503	$data .= substr $$rbuf, 0, $+[0], "";
		1504	}
		1505
		1506	()
		1507	}
		1508	};
		1509
		1510	=item netstring => $cb->($handle, $string)
		1511
		1512	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1513
		1514	Throws an error with C<$!> set to EBADMSG on format violations.
		1515
		1516	=cut
		1517
		1518	register_read_type netstring => sub {
		1519	my ($self, $cb) = @_;
		1520
		1521	sub {
		1522	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1523	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1524	$self->_error (Errno::EBADMSG);
		1525	}
		1526	return;
		1527	}
		1528
		1529	my $len = $1;
		1530
		1531	$self->unshift_read (chunk => $len, sub {
		1532	my $string = $_[1];
		1533	$_[0]->unshift_read (chunk => 1, sub {
		1534	if ($_[1] eq ",") {
		1535	$cb->($_[0], $string);
		1536	} else {
		1537	$self->_error (Errno::EBADMSG);
		1538	}
		1539	});
		1540	});
		1541
543	1	1542	1
544	}	1543	}
545	}	1544	};
546		1545
547	sub push_read_line {	1546	=item packstring => $format, $cb->($handle, $string)
548	$_[0]->push_read (&_read_line);
549	}
550		1547
551	sub unshift_read_line {	1548	An octet string prefixed with an encoded length. The encoding C<$format>
552	$_[0]->unshift_read (&_read_line);	1549	uses the same format as a Perl C<pack> format, but must specify a single
553	}	1550	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1551	optional C<!>, C<< < >> or C<< > >> modifier).
		1552
		1553	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1554	EPP uses a prefix of C<N> (4 octtes).
		1555
		1556	Example: read a block of data prefixed by its length in BER-encoded
		1557	format (very efficient).
		1558
		1559	$handle->push_read (packstring => "w", sub {
		1560	my ($handle, $data) = @_;
		1561	});
		1562
		1563	=cut
		1564
		1565	register_read_type packstring => sub {
		1566	my ($self, $cb, $format) = @_;
		1567
		1568	sub {
		1569	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1570	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1571	or return;
		1572
		1573	$format = length pack $format, $len;
		1574
		1575	# bypass unshift if we already have the remaining chunk
		1576	if ($format + $len <= length $_[0]{rbuf}) {
		1577	my $data = substr $_[0]{rbuf}, $format, $len;
		1578	substr $_[0]{rbuf}, 0, $format + $len, "";
		1579	$cb->($_[0], $data);
		1580	} else {
		1581	# remove prefix
		1582	substr $_[0]{rbuf}, 0, $format, "";
		1583
		1584	# read remaining chunk
		1585	$_[0]->unshift_read (chunk => $len, $cb);
		1586	}
		1587
		1588	1
		1589	}
		1590	};
		1591
		1592	=item json => $cb->($handle, $hash_or_arrayref)
		1593
		1594	Reads a JSON object or array, decodes it and passes it to the
		1595	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
		1596
		1597	If a C<json> object was passed to the constructor, then that will be used
		1598	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1599
		1600	This read type uses the incremental parser available with JSON version
		1601	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1602	dependency on your own: this module will load the JSON module, but
		1603	AnyEvent does not depend on it itself.
		1604
		1605	Since JSON texts are fully self-delimiting, the C<json> read and write
		1606	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1607	the C<json> write type description, above, for an actual example.
		1608
		1609	=cut
		1610
		1611	register_read_type json => sub {
		1612	my ($self, $cb) = @_;
		1613
		1614	my $json = $self->{json} ||= json_coder;
		1615
		1616	my $data;
		1617	my $rbuf = \$self->{rbuf};
		1618
		1619	sub {
		1620	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
		1621
		1622	if ($ref) {
		1623	$self->{rbuf} = $json->incr_text;
		1624	$json->incr_text = "";
		1625	$cb->($self, $ref);
		1626
		1627	1
		1628	} elsif ($@) {
		1629	# error case
		1630	$json->incr_skip;
		1631
		1632	$self->{rbuf} = $json->incr_text;
		1633	$json->incr_text = "";
		1634
		1635	$self->_error (Errno::EBADMSG);
		1636
		1637	()
		1638	} else {
		1639	$self->{rbuf} = "";
		1640
		1641	()
		1642	}
		1643	}
		1644	};
		1645
		1646	=item storable => $cb->($handle, $ref)
		1647
		1648	Deserialises a L<Storable> frozen representation as written by the
		1649	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1650	data).
		1651
		1652	Raises C<EBADMSG> error if the data could not be decoded.
		1653
		1654	=cut
		1655
		1656	register_read_type storable => sub {
		1657	my ($self, $cb) = @_;
		1658
		1659	require Storable;
		1660
		1661	sub {
		1662	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1663	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1664	or return;
		1665
		1666	my $format = length pack "w", $len;
		1667
		1668	# bypass unshift if we already have the remaining chunk
		1669	if ($format + $len <= length $_[0]{rbuf}) {
		1670	my $data = substr $_[0]{rbuf}, $format, $len;
		1671	substr $_[0]{rbuf}, 0, $format + $len, "";
		1672	$cb->($_[0], Storable::thaw ($data));
		1673	} else {
		1674	# remove prefix
		1675	substr $_[0]{rbuf}, 0, $format, "";
		1676
		1677	# read remaining chunk
		1678	$_[0]->unshift_read (chunk => $len, sub {
		1679	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1680	$cb->($_[0], $ref);
		1681	} else {
		1682	$self->_error (Errno::EBADMSG);
		1683	}
		1684	});
		1685	}
		1686
		1687	1
		1688	}
		1689	};
		1690
		1691	=back
		1692
		1693	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
		1694
		1695	Instead of one of the predefined types, you can also specify the name
		1696	of a package. AnyEvent will try to load the package and then expects to
		1697	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1698	progressively tries to load the parent package until it either finds the
		1699	function (good) or runs out of packages (bad).
		1700
		1701	Whenever this type is used, C<push_read> will invoke the function with the
		1702	handle object, the original callback and the remaining arguments.
		1703
		1704	The function is supposed to return a callback (usually a closure) that
		1705	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1706	mentally treat the function as a "configurable read type to read callback"
		1707	converter.
		1708
		1709	It should invoke the original callback when it is done reading (remember
		1710	to pass C<$handle> as first argument as all other callbacks do that,
		1711	although there is no strict requirement on this).
		1712
		1713	For examples, see the source of this module (F<perldoc -m
		1714	AnyEvent::Handle>, search for C<register_read_type>)).
554		1715
555	=item $handle->stop_read	1716	=item $handle->stop_read
556		1717
557	=item $handle->start_read	1718	=item $handle->start_read
558		1719
559	In rare cases you actually do not want to read anything form the	1720	In rare cases you actually do not want to read anything from the
560	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1721	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
561	any queued callbacks will be executed then. To start readign again, call	1722	any queued callbacks will be executed then. To start reading again, call
562	C<start_read>.	1723	C<start_read>.
		1724
		1725	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1726	you change the C<on_read> callback or push/unshift a read callback, and it
		1727	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1728	there are any read requests in the queue.
		1729
		1730	These methods will have no effect when in TLS mode (as TLS doesn't support
		1731	half-duplex connections).
563		1732
564	=cut	1733	=cut
565		1734
566	sub stop_read {	1735	sub stop_read {
567	my ($self) = @_;	1736	my ($self) = @_;
568		1737
569	delete $self->{rw};	1738	delete $self->{_rw} unless $self->{tls};
570	}	1739	}
571		1740
572	sub start_read {	1741	sub start_read {
573	my ($self) = @_;	1742	my ($self) = @_;
574		1743
575	unless ($self->{rw} || $self->{eof}) {	1744	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
576	Scalar::Util::weaken $self;	1745	Scalar::Util::weaken $self;
577		1746
578	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1747	$self->{_rw} = AE::io $self->{fh}, 0, sub {
		1748	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
579	my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} || 8192, length $self->{rbuf};	1749	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
580		1750
581	if ($len > 0) {	1751	if ($len > 0) {
582	if (defined $self->{rbuf_max}) {	1752	$self->{_activity} = $self->{_ractivity} = AE::now;
583	if ($self->{rbuf_max} < length $self->{rbuf}) {	1753
584	$! = &Errno::ENOSPC; return $self->error;	1754	if ($self->{tls}) {
585	}	1755	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1756
		1757	&_dotls ($self);
		1758	} else {
		1759	$self->_drain_rbuf;
586	}	1760	}
587		1761
588	} elsif (defined $len) {	1762	} elsif (defined $len) {
589	$self->{eof} = 1;
590	delete $self->{rw};	1763	delete $self->{_rw};
		1764	$self->{_eof} = 1;
		1765	$self->_drain_rbuf;
591		1766
592	} elsif ($! != EAGAIN && $! != EINTR) {	1767	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
593	return $self->error;	1768	return $self->_error ($!, 1);
594	}	1769	}
		1770	};
		1771	}
		1772	}
595		1773
		1774	our $ERROR_SYSCALL;
		1775	our $ERROR_WANT_READ;
		1776
		1777	sub _tls_error {
		1778	my ($self, $err) = @_;
		1779
		1780	return $self->_error ($!, 1)
		1781	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1782
		1783	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1784
		1785	# reduce error string to look less scary
		1786	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1787
		1788	if ($self->{_on_starttls}) {
		1789	(delete $self->{_on_starttls})->($self, undef, $err);
		1790	&_freetls;
		1791	} else {
		1792	&_freetls;
		1793	$self->_error (Errno::EPROTO, 1, $err);
		1794	}
		1795	}
		1796
		1797	# poll the write BIO and send the data if applicable
		1798	# also decode read data if possible
		1799	# this is basiclaly our TLS state machine
		1800	# more efficient implementations are possible with openssl,
		1801	# but not with the buggy and incomplete Net::SSLeay.
		1802	sub _dotls {
		1803	my ($self) = @_;
		1804
		1805	my $tmp;
		1806
		1807	if (length $self->{_tls_wbuf}) {
		1808	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
		1809	substr $self->{_tls_wbuf}, 0, $tmp, "";
		1810	}
		1811
		1812	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1813	return $self->_tls_error ($tmp)
		1814	if $tmp != $ERROR_WANT_READ
		1815	&& ($tmp != $ERROR_SYSCALL || $!);
		1816	}
		1817
		1818	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1819	unless (length $tmp) {
		1820	$self->{_on_starttls}
		1821	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1822	&_freetls;
		1823
		1824	if ($self->{on_stoptls}) {
		1825	$self->{on_stoptls}($self);
		1826	return;
		1827	} else {
		1828	# let's treat SSL-eof as we treat normal EOF
		1829	delete $self->{_rw};
		1830	$self->{_eof} = 1;
		1831	}
		1832	}
		1833
		1834	$self->{_tls_rbuf} .= $tmp;
596	$self->_drain_rbuf;	1835	$self->_drain_rbuf;
		1836	$self->{tls} or return; # tls session might have gone away in callback
		1837	}
		1838
		1839	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1840	return $self->_tls_error ($tmp)
		1841	if $tmp != $ERROR_WANT_READ
		1842	&& ($tmp != $ERROR_SYSCALL || $!);
		1843
		1844	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1845	$self->{wbuf} .= $tmp;
		1846	$self->_drain_wbuf;
		1847	$self->{tls} or return; # tls session might have gone away in callback
		1848	}
		1849
		1850	$self->{_on_starttls}
		1851	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1852	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
		1853	}
		1854
		1855	=item $handle->starttls ($tls[, $tls_ctx])
		1856
		1857	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		1858	object is created, you can also do that at a later time by calling
		1859	C<starttls>.
		1860
		1861	Starting TLS is currently an asynchronous operation - when you push some
		1862	write data and then call C<< ->starttls >> then TLS negotiation will start
		1863	immediately, after which the queued write data is then sent.
		1864
		1865	The first argument is the same as the C<tls> constructor argument (either
		1866	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1867
		1868	The second argument is the optional C<AnyEvent::TLS> object that is used
		1869	when AnyEvent::Handle has to create its own TLS connection object, or
		1870	a hash reference with C<< key => value >> pairs that will be used to
		1871	construct a new context.
		1872
		1873	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
		1874	context in C<< $handle->{tls_ctx} >> after this call and can be used or
		1875	changed to your liking. Note that the handshake might have already started
		1876	when this function returns.
		1877
		1878	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1879	handshakes on the same stream. Best do not attempt to use the stream after
		1880	stopping TLS.
		1881
		1882	This method may invoke callbacks (and therefore the handle might be
		1883	destroyed after it returns).
		1884
		1885	=cut
		1886
		1887	our %TLS_CACHE; #TODO not yet documented, should we?
		1888
		1889	sub starttls {
		1890	my ($self, $tls, $ctx) = @_;
		1891
		1892	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1893	if $self->{tls};
		1894
		1895	$self->{tls} = $tls;
		1896	$self->{tls_ctx} = $ctx if @_ > 2;
		1897
		1898	return unless $self->{fh};
		1899
		1900	require Net::SSLeay;
		1901
		1902	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1903	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1904
		1905	$tls = delete $self->{tls};
		1906	$ctx = $self->{tls_ctx};
		1907
		1908	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1909
		1910	if ("HASH" eq ref $ctx) {
		1911	require AnyEvent::TLS;
		1912
		1913	if ($ctx->{cache}) {
		1914	my $key = $ctx+0;
		1915	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1916	} else {
		1917	$ctx = new AnyEvent::TLS %$ctx;
		1918	}
		1919	}
		1920
		1921	$self->{tls_ctx} = $ctx || TLS_CTX ();
		1922	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
		1923
		1924	# basically, this is deep magic (because SSL_read should have the same issues)
		1925	# but the openssl maintainers basically said: "trust us, it just works".
		1926	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		1927	# and mismaintained ssleay-module doesn't even offer them).
		1928	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1929	#
		1930	# in short: this is a mess.
		1931	#
		1932	# note that we do not try to keep the length constant between writes as we are required to do.
		1933	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1934	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1935	# have identity issues in that area.
		1936	# Net::SSLeay::CTX_set_mode ($ssl,
		1937	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
		1938	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1939	Net::SSLeay::CTX_set_mode ($tls, 1|2);
		1940
		1941	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1942	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1943
		1944	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1945
		1946	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1947
		1948	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1949	if $self->{on_starttls};
		1950
		1951	&_dotls; # need to trigger the initial handshake
		1952	$self->start_read; # make sure we actually do read
		1953	}
		1954
		1955	=item $handle->stoptls
		1956
		1957	Shuts down the SSL connection - this makes a proper EOF handshake by
		1958	sending a close notify to the other side, but since OpenSSL doesn't
		1959	support non-blocking shut downs, it is not guaranteed that you can re-use
		1960	the stream afterwards.
		1961
		1962	This method may invoke callbacks (and therefore the handle might be
		1963	destroyed after it returns).
		1964
		1965	=cut
		1966
		1967	sub stoptls {
		1968	my ($self) = @_;
		1969
		1970	if ($self->{tls} && $self->{fh}) {
		1971	Net::SSLeay::shutdown ($self->{tls});
		1972
		1973	&_dotls;
		1974
		1975	# # we don't give a shit. no, we do, but we can't. no...#d#
		1976	# # we, we... have to use openssl :/#d#
		1977	# &_freetls;#d#
		1978	}
		1979	}
		1980
		1981	sub _freetls {
		1982	my ($self) = @_;
		1983
		1984	return unless $self->{tls};
		1985
		1986	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1987	if $self->{tls} > 0;
		1988
		1989	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
		1990	}
		1991
		1992	sub DESTROY {
		1993	my ($self) = @_;
		1994
		1995	&_freetls;
		1996
		1997	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1998
		1999	if ($linger && length $self->{wbuf} && $self->{fh}) {
		2000	my $fh = delete $self->{fh};
		2001	my $wbuf = delete $self->{wbuf};
		2002
		2003	my @linger;
		2004
		2005	push @linger, AE::io $fh, 1, sub {
		2006	my $len = syswrite $fh, $wbuf, length $wbuf;
		2007
		2008	if ($len > 0) {
		2009	substr $wbuf, 0, $len, "";
		2010	} else {
		2011	@linger = (); # end
		2012	}
597	});	2013	};
		2014	push @linger, AE::timer $linger, 0, sub {
		2015	@linger = ();
		2016	};
		2017	}
		2018	}
		2019
		2020	=item $handle->destroy
		2021
		2022	Shuts down the handle object as much as possible - this call ensures that
		2023	no further callbacks will be invoked and as many resources as possible
		2024	will be freed. Any method you will call on the handle object after
		2025	destroying it in this way will be silently ignored (and it will return the
		2026	empty list).
		2027
		2028	Normally, you can just "forget" any references to an AnyEvent::Handle
		2029	object and it will simply shut down. This works in fatal error and EOF
		2030	callbacks, as well as code outside. It does I<NOT> work in a read or write
		2031	callback, so when you want to destroy the AnyEvent::Handle object from
		2032	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2033	that case.
		2034
		2035	Destroying the handle object in this way has the advantage that callbacks
		2036	will be removed as well, so if those are the only reference holders (as
		2037	is common), then one doesn't need to do anything special to break any
		2038	reference cycles.
		2039
		2040	The handle might still linger in the background and write out remaining
		2041	data, as specified by the C<linger> option, however.
		2042
		2043	=cut
		2044
		2045	sub destroy {
		2046	my ($self) = @_;
		2047
		2048	$self->DESTROY;
		2049	%$self = ();
		2050	bless $self, "AnyEvent::Handle::destroyed";
		2051	}
		2052
		2053	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2054	#nop
		2055	}
		2056
		2057	=item $handle->destroyed
		2058
		2059	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2060	->destroy >>, true otherwise.
		2061
		2062	Can be useful to decide whether the handle is still valid after some
		2063	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2064	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2065	can destroy the handle, so work can be avoided by checking sometimes:
		2066
		2067	$hdl->starttls ("accept");
		2068	return if $hdl->destroyed;
		2069	$hdl->push_write (...
		2070
		2071	Note that the call to C<push_write> will silently be ignored if the handle
		2072	has been destroyed, so often you can just ignore the possibility of the
		2073	handle being destroyed.
		2074
		2075	=cut
		2076
		2077	sub destroyed { 0 }
		2078	sub AnyEvent::Handle::destroyed::destroyed { 1 }
		2079
		2080	=item AnyEvent::Handle::TLS_CTX
		2081
		2082	This function creates and returns the AnyEvent::TLS object used by default
		2083	for TLS mode.
		2084
		2085	The context is created by calling L<AnyEvent::TLS> without any arguments.
		2086
		2087	=cut
		2088
		2089	our $TLS_CTX;
		2090
		2091	sub TLS_CTX() {
		2092	$TLS_CTX ||= do {
		2093	require AnyEvent::TLS;
		2094
		2095	new AnyEvent::TLS
598	}	2096	}
599	}	2097	}
600		2098
601	=back	2099	=back
602		2100
		2101
		2102	=head1 NONFREQUENTLY ASKED QUESTIONS
		2103
		2104	=over 4
		2105
		2106	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2107	still get further invocations!
		2108
		2109	That's because AnyEvent::Handle keeps a reference to itself when handling
		2110	read or write callbacks.
		2111
		2112	It is only safe to "forget" the reference inside EOF or error callbacks,
		2113	from within all other callbacks, you need to explicitly call the C<<
		2114	->destroy >> method.
		2115
		2116	=item I get different callback invocations in TLS mode/Why can't I pause
		2117	reading?
		2118
		2119	Unlike, say, TCP, TLS connections do not consist of two independent
		2120	communication channels, one for each direction. Or put differently. The
		2121	read and write directions are not independent of each other: you cannot
		2122	write data unless you are also prepared to read, and vice versa.
		2123
		2124	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		2125	callback invocations when you are not expecting any read data - the reason
		2126	is that AnyEvent::Handle always reads in TLS mode.
		2127
		2128	During the connection, you have to make sure that you always have a
		2129	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2130	connection (or when you no longer want to use it) you can call the
		2131	C<destroy> method.
		2132
		2133	=item How do I read data until the other side closes the connection?
		2134
		2135	If you just want to read your data into a perl scalar, the easiest way
		2136	to achieve this is by setting an C<on_read> callback that does nothing,
		2137	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2138	will be in C<$_[0]{rbuf}>:
		2139
		2140	$handle->on_read (sub { });
		2141	$handle->on_eof (undef);
		2142	$handle->on_error (sub {
		2143	my $data = delete $_[0]{rbuf};
		2144	});
		2145
		2146	The reason to use C<on_error> is that TCP connections, due to latencies
		2147	and packets loss, might get closed quite violently with an error, when in
		2148	fact, all data has been received.
		2149
		2150	It is usually better to use acknowledgements when transferring data,
		2151	to make sure the other side hasn't just died and you got the data
		2152	intact. This is also one reason why so many internet protocols have an
		2153	explicit QUIT command.
		2154
		2155	=item I don't want to destroy the handle too early - how do I wait until
		2156	all data has been written?
		2157
		2158	After writing your last bits of data, set the C<on_drain> callback
		2159	and destroy the handle in there - with the default setting of
		2160	C<low_water_mark> this will be called precisely when all data has been
		2161	written to the socket:
		2162
		2163	$handle->push_write (...);
		2164	$handle->on_drain (sub {
		2165	warn "all data submitted to the kernel\n";
		2166	undef $handle;
		2167	});
		2168
		2169	If you just want to queue some data and then signal EOF to the other side,
		2170	consider using C<< ->push_shutdown >> instead.
		2171
		2172	=item I want to contact a TLS/SSL server, I don't care about security.
		2173
		2174	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2175	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2176	parameter:
		2177
		2178	tcp_connect $host, $port, sub {
		2179	my ($fh) = @_;
		2180
		2181	my $handle = new AnyEvent::Handle
		2182	fh => $fh,
		2183	tls => "connect",
		2184	on_error => sub { ... };
		2185
		2186	$handle->push_write (...);
		2187	};
		2188
		2189	=item I want to contact a TLS/SSL server, I do care about security.
		2190
		2191	Then you should additionally enable certificate verification, including
		2192	peername verification, if the protocol you use supports it (see
		2193	L<AnyEvent::TLS>, C<verify_peername>).
		2194
		2195	E.g. for HTTPS:
		2196
		2197	tcp_connect $host, $port, sub {
		2198	my ($fh) = @_;
		2199
		2200	my $handle = new AnyEvent::Handle
		2201	fh => $fh,
		2202	peername => $host,
		2203	tls => "connect",
		2204	tls_ctx => { verify => 1, verify_peername => "https" },
		2205	...
		2206
		2207	Note that you must specify the hostname you connected to (or whatever
		2208	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2209	peername verification will be done.
		2210
		2211	The above will use the system-dependent default set of trusted CA
		2212	certificates. If you want to check against a specific CA, add the
		2213	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2214
		2215	tls_ctx => {
		2216	verify => 1,
		2217	verify_peername => "https",
		2218	ca_file => "my-ca-cert.pem",
		2219	},
		2220
		2221	=item I want to create a TLS/SSL server, how do I do that?
		2222
		2223	Well, you first need to get a server certificate and key. You have
		2224	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2225	self-signed certificate (cheap. check the search engine of your choice,
		2226	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2227	nice program for that purpose).
		2228
		2229	Then create a file with your private key (in PEM format, see
		2230	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2231	file should then look like this:
		2232
		2233	-----BEGIN RSA PRIVATE KEY-----
		2234	...header data
		2235	... lots of base64'y-stuff
		2236	-----END RSA PRIVATE KEY-----
		2237
		2238	-----BEGIN CERTIFICATE-----
		2239	... lots of base64'y-stuff
		2240	-----END CERTIFICATE-----
		2241
		2242	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2243	specify this file as C<cert_file>:
		2244
		2245	tcp_server undef, $port, sub {
		2246	my ($fh) = @_;
		2247
		2248	my $handle = new AnyEvent::Handle
		2249	fh => $fh,
		2250	tls => "accept",
		2251	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2252	...
		2253
		2254	When you have intermediate CA certificates that your clients might not
		2255	know about, just append them to the C<cert_file>.
		2256
		2257	=back
		2258
		2259
		2260	=head1 SUBCLASSING AnyEvent::Handle
		2261
		2262	In many cases, you might want to subclass AnyEvent::Handle.
		2263
		2264	To make this easier, a given version of AnyEvent::Handle uses these
		2265	conventions:
		2266
		2267	=over 4
		2268
		2269	=item * all constructor arguments become object members.
		2270
		2271	At least initially, when you pass a C<tls>-argument to the constructor it
		2272	will end up in C<< $handle->{tls} >>. Those members might be changed or
		2273	mutated later on (for example C<tls> will hold the TLS connection object).
		2274
		2275	=item * other object member names are prefixed with an C<_>.
		2276
		2277	All object members not explicitly documented (internal use) are prefixed
		2278	with an underscore character, so the remaining non-C<_>-namespace is free
		2279	for use for subclasses.
		2280
		2281	=item * all members not documented here and not prefixed with an underscore
		2282	are free to use in subclasses.
		2283
		2284	Of course, new versions of AnyEvent::Handle may introduce more "public"
		2285	member variables, but thats just life, at least it is documented.
		2286
		2287	=back
		2288
603	=head1 AUTHOR	2289	=head1 AUTHOR
604		2290
605	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2291	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
606		2292
607	=cut	2293	=cut

Diff Legend

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