[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.145 by root, Mon Jul 6 21:47:14 2009 UTC vs.
Revision 1.189 by root, Mon Sep 28 17:30:54 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
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 file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.8;
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 $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	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
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	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
58	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
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
60		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
61	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
62	argument.	49	argument.
63		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
64	=head1 METHODS	80	=head1 METHODS
65		81
66	=over 4	82	=over 4
67		83
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		85
70	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
71		87
72	=over 4	88	=over 4
73		89
74	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		91
76	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	93	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	95	that mode.
81		96
		97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		98
		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>.
		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
		114	=item on_prepare => $cb->($handle)
		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
		155	This is the error callback, which is called when, well, some error
		156	occured, such as not being able to resolve the hostname, failure to
		157	connect or a read error.
		158
		159	Some errors are fatal (which is indicated by C<$fatal> being true). On
		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>).
		176
		177	On callback entrance, the value of C<$!> contains the operating system
		178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
		180
		181	While not mandatory, it is I<highly> recommended to set this callback, as
		182	you will not be notified of errors otherwise. The default simply calls
		183	C<croak>.
		184
		185	=item on_read => $cb->($handle)
		186
		187	This sets the default read callback, which is called when data arrives
		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).
		191
		192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		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	When an EOF condition is detected then AnyEvent::Handle will first try to
		198	feed all the remaining data to the queued callbacks and C<on_read> before
		199	calling the C<on_eof> callback. If no progress can be made, then a fatal
		200	error will be raised (with C<$!> set to C<EPIPE>).
		201
		202	Note that, unlike requests in the read queue, an C<on_read> callback
		203	doesn't mean you I<require> some data: if there is an EOF and there
		204	are outstanding read requests then an error will be flagged. With an
		205	C<on_read> callback, the C<on_eof> callback will be invoked.
		206
82	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
83		208
84	Set the callback to be called when an end-of-file condition is detected,	209	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	210	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	211	connection cleanly, and there are no outstanding read requests in the
		212	queue (if there are read requests, then an EOF counts as an unexpected
		213	connection close and will be flagged as an error).
87		214
88	For sockets, this just means that the other side has stopped sending data,	215	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	216	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	217	callback and continue writing data, as only the read part has been shut
91	down.	218	down.
92		219
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	220	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	221	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		222
147	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
148		224
149	This sets the callback that is called when the write buffer becomes empty	225	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	226	(or when the callback is set and the buffer is empty already).
157	memory and push it into the queue, but instead only read more data from	233	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
159		235
160	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
161		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	243	many seconds pass without a successful read or write on the underlying
164	handle, the C<on_timeout> callback will be invoked (and if that one is	244	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
165	missing, a non-fatal C<ETIMEDOUT> error will be raised).	245	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		246	error will be raised).
		247
		248	There are three variants of the timeouts that work fully independent
		249	of each other, for both read and write, just read, and just write:
		250	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		251	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		252	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
166		253
167	Note that timeout processing is also active when you currently do not have	254	Note that timeout processing is also active when you currently do not have
168	any outstanding read or write requests: If you plan to keep the connection	255	any outstanding read or write requests: If you plan to keep the connection
169	idle then you should disable the timout temporarily or ignore the timeout	256	idle then you should disable the timout temporarily or ignore the timeout
170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	257	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
214	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
215		302
216	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
217	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
218		305
		306	=item keepalive => <boolean>
		307
		308	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		309	normally, TCP connections have no time-out once established, so TCP
		310	connections, once established, can stay alive forever even when the other
		311	side has long gone. TCP keepalives are a cheap way to take down long-lived
		312	TCP connections whent he other side becomes unreachable. While the default
		313	is OS-dependent, TCP keepalives usually kick in after around two hours,
		314	and, if the other side doesn't reply, take down the TCP connection some 10
		315	to 15 minutes later.
		316
		317	It is harmless to specify this option for file handles that do not support
		318	keepalives, and enabling it on connections that are potentially long-lived
		319	is usually a good idea.
		320
		321	=item oobinline => <boolean>
		322
		323	BSD majorly fucked up the implementation of TCP urgent data. The result
		324	is that almost no OS implements TCP according to the specs, and every OS
		325	implements it slightly differently.
		326
		327	If you want to handle TCP urgent data, then setting this flag (the default
		328	is enabled) gives you the most portable way of getting urgent data, by
		329	putting it into the stream.
		330
		331	Since BSD emulation of OOB data on top of TCP's urgent data can have
		332	security implications, AnyEvent::Handle sets this flag automatically
		333	unless explicitly specified. Note that setting this flag after
		334	establishing a connection I<may> be a bit too late (data loss could
		335	already have occured on BSD systems), but at least it will protect you
		336	from most attacks.
		337
219	=item read_size => <bytes>	338	=item read_size => <bytes>
220		339
221	The default read block size (the amount of bytes this module will	340	The default read block size (the amount of bytes this module will
222	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
223	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
256	C<undef>.	375	C<undef>.
257		376
258	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
259		378
260	When this parameter is given, it enables TLS (SSL) mode, that means	379	When this parameter is given, it enables TLS (SSL) mode, that means
261	AnyEvent will start a TLS handshake as soon as the conenction has been	380	AnyEvent will start a TLS handshake as soon as the connection has been
262	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
263		382
264	All TLS protocol errors will be signalled as C<EPROTO>, with an	383	All TLS protocol errors will be signalled as C<EPROTO>, with an
265	appropriate error message.	384	appropriate error message.
266		385
…		…
349		468
350	sub new {	469	sub new {
351	my $class = shift;	470	my $class = shift;
352	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
353		472
354	$self->{fh} or Carp::croak "mandatory argument fh is missing";	473	if ($self->{fh}) {
		474	$self->_start;
		475	return unless $self->{fh}; # could be gone by now
		476
		477	} elsif ($self->{connect}) {
		478	require AnyEvent::Socket;
		479
		480	$self->{peername} = $self->{connect}[0]
		481	unless exists $self->{peername};
		482
		483	$self->{_skip_drain_rbuf} = 1;
		484
		485	{
		486	Scalar::Util::weaken (my $self = $self);
		487
		488	$self->{_connect} =
		489	AnyEvent::Socket::tcp_connect (
		490	$self->{connect}[0],
		491	$self->{connect}[1],
		492	sub {
		493	my ($fh, $host, $port, $retry) = @_;
		494
		495	if ($fh) {
		496	$self->{fh} = $fh;
		497
		498	delete $self->{_skip_drain_rbuf};
		499	$self->_start;
		500
		501	$self->{on_connect}
		502	and $self->{on_connect}($self, $host, $port, sub {
		503	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		504	$self->{_skip_drain_rbuf} = 1;
		505	&$retry;
		506	});
		507
		508	} else {
		509	if ($self->{on_connect_error}) {
		510	$self->{on_connect_error}($self, "$!");
		511	$self->destroy;
		512	} else {
		513	$self->_error ($!, 1);
		514	}
		515	}
		516	},
		517	sub {
		518	local $self->{fh} = $_[0];
		519
		520	$self->{on_prepare}
		521	? $self->{on_prepare}->($self)
		522	: ()
		523	}
		524	);
		525	}
		526
		527	} else {
		528	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		529	}
		530
		531	$self
		532	}
		533
		534	sub _start {
		535	my ($self) = @_;
355		536
356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
357		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
358	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
359	$self->_timeout;
360		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
361	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
362		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
363	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
364	if $self->{tls};	553	if $self->{tls};
365		554
366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
367		556
368	$self->start_read	557	$self->start_read
369	if $self->{on_read};	558	if $self->{on_read} \|\| @{ $self->{_queue} };
370		559
371	$self->{fh} && $self	560	$self->_drain_wbuf;
372	}
373
374	sub _shutdown {
375	my ($self) = @_;
376
377	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
378	$self->{_eof} = 1; # tell starttls et. al to stop trying
379
380	&_freetls;
381	}	561	}
382		562
383	sub _error {	563	sub _error {
384	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
385		565
386	$self->_shutdown
387	if $fatal;
388
389	$! = $errno;	566	$! = $errno;
390	$message \|\|= "$!";	567	$message \|\|= "$!";
391		568
392	if ($self->{on_error}) {	569	if ($self->{on_error}) {
393	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
394	} elsif ($self->{fh}) {	571	$self->destroy if $fatal;
		572	} elsif ($self->{fh} \|\| $self->{connect}) {
		573	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	575	}
397	}	576	}
398		577
399	=item $fh = $handle->fh	578	=item $fh = $handle->fh
…		…
424	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
425	}	604	}
426		605
427	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
428		607
429	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431	argument and method.
432		609
433	=cut	610	=item $handle->on_wtimeout ($cb)
434		611
435	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
437	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
438		619
439	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
440		621
441	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
442	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
457	sub no_delay {	638	sub no_delay {
458	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
459		640
460	eval {	641	eval {
461	local $SIG{__DIE__};	642	local $SIG{__DIE__};
462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		644	if $_[0]{fh};
		645	};
		646	}
		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
463	};	696	};
464	}	697	}
465		698
466	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
467		700
…		…
477		710
478	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
479		712
480	=cut	713	=cut
481		714
482	sub on_starttls {	715	sub on_stoptls {
483	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
484	}	717	}
485		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
		727	}
		728
486	#############################################################################	729	#############################################################################
487		730
488	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
489		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
490	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
491		738
492	=cut	739	=item $handle->timeout_reset
493		740
494	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
495	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
496		764
497	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
498	$self->_timeout;	766	delete $self->{$tw}; &$cb;
499	}	767	};
500		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
501	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
502	# also check for time-outs	775	# also check for time-outs
503	sub _timeout {	776	$cb = sub {
504	my ($self) = @_;	777	my ($self) = @_;
505		778
506	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
508		781
509	# when would the timeout trigger?	782	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511		784
512	# now or in the past already?	785	# now or in the past already?
513	if ($after <= 0) {	786	if ($after <= 0) {
514	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
515		788
516	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
517	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
518	} else {	791	} else {
519	$self->_error (&Errno::ETIMEDOUT);	792	$self->_error (Errno::ETIMEDOUT);
		793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
520	}	800	}
521		801
522	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
523	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
524		804
525	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
526	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
527	}	811	}
528
529	Scalar::Util::weaken $self;
530	return unless $self; # ->error could have destroyed $self
531
532	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
533	delete $self->{_tw};
534	$self->_timeout;
535	});
536	} else {
537	delete $self->{_tw};
538	}	812	}
539	}	813	}
540		814
541	#############################################################################	815	#############################################################################
542		816
…		…
587	Scalar::Util::weaken $self;	861	Scalar::Util::weaken $self;
588		862
589	my $cb = sub {	863	my $cb = sub {
590	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
591		865
592	if ($len >= 0) {	866	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
594		868
595	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
596		870
597	$self->{on_drain}($self)	871	$self->{on_drain}($self)
598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	872	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
599	&& $self->{on_drain};	873	&& $self->{on_drain};
600		874
…		…
606		880
607	# try to write data immediately	881	# try to write data immediately
608	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
609		883
610	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
611	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
612	if length $self->{wbuf};	886	if length $self->{wbuf};
613	};	887	};
614	}	888	}
615		889
616	our %WH;	890	our %WH;
617		891
		892	# deprecated
618	sub register_write_type($$) {	893	sub register_write_type($$) {
619	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
620	}	895	}
621		896
622	sub push_write {	897	sub push_write {
623	my $self = shift;	898	my $self = shift;
624		899
625	if (@_ > 1) {	900	if (@_ > 1) {
626	my $type = shift;	901	my $type = shift;
627		902
		903	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
628	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	904	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
629	->($self, @_);	905	->($self, @_);
630	}	906	}
631		907
632	if ($self->{tls}) {	908	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	909	$self->{_tls_wbuf} .= $_[0];
634		910	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	911	} else {
637	$self->{wbuf} .= $_[0];	912	$self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	913	$self->_drain_wbuf if $self->{fh};
639	}	914	}
640	}	915	}
641		916
642	=item $handle->push_write (type => @args)	917	=item $handle->push_write (type => @args)
643		918
644	Instead of formatting your data yourself, you can also let this module do	919	Instead of formatting your data yourself, you can also let this module
645	the job by specifying a type and type-specific arguments.	920	do the job by specifying a type and type-specific arguments. You
		921	can also specify the (fully qualified) name of a package, in which
		922	case AnyEvent tries to load the package and then expects to find the
		923	C<anyevent_read_type> function inside (see "custom write types", below).
646		924
647	Predefined types are (if you have ideas for additional types, feel free to	925	Predefined types are (if you have ideas for additional types, feel free to
648	drop by and tell us):	926	drop by and tell us):
649		927
650	=over 4	928	=over 4
…		…
707	Other languages could read single lines terminated by a newline and pass	985	Other languages could read single lines terminated by a newline and pass
708	this line into their JSON decoder of choice.	986	this line into their JSON decoder of choice.
709		987
710	=cut	988	=cut
711		989
		990	sub json_coder() {
		991	eval { require JSON::XS; JSON::XS->new->utf8 }
		992	\|\| do { require JSON; JSON->new->utf8 }
		993	}
		994
712	register_write_type json => sub {	995	register_write_type json => sub {
713	my ($self, $ref) = @_;	996	my ($self, $ref) = @_;
714		997
715	require JSON;	998	my $json = $self->{json} \|\|= json_coder;
716		999
717	$self->{json} ? $self->{json}->encode ($ref)	1000	$json->encode ($ref)
718	: JSON::encode_json ($ref)
719	};	1001	};
720		1002
721	=item storable => $reference	1003	=item storable => $reference
722		1004
723	Freezes the given reference using L<Storable> and writes it to the	1005	Freezes the given reference using L<Storable> and writes it to the
…		…
758		1040
759	delete $self->{low_water_mark};	1041	delete $self->{low_water_mark};
760	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1042	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
761	}	1043	}
762		1044
763	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1045	=item custom write types - Package::anyevent_write_type $handle, @args
764		1046
765	This function (not method) lets you add your own types to C<push_write>.	1047	Instead of one of the predefined types, you can also specify the name of
		1048	a package. AnyEvent will try to load the package and then expects to find
		1049	a function named C<anyevent_write_type> inside. If it isn't found, it
		1050	progressively tries to load the parent package until it either finds the
		1051	function (good) or runs out of packages (bad).
		1052
766	Whenever the given C<type> is used, C<push_write> will invoke the code	1053	Whenever the given C<type> is used, C<push_write> will the function with
767	reference with the handle object and the remaining arguments.	1054	the handle object and the remaining arguments.
768		1055
769	The code reference is supposed to return a single octet string that will	1056	The function is supposed to return a single octet string that will be
770	be appended to the write buffer.	1057	appended to the write buffer, so you cna mentally treat this function as a
		1058	"arguments to on-the-wire-format" converter.
771		1059
772	Note that this is a function, and all types registered this way will be	1060	Example: implement a custom write type C<join> that joins the remaining
773	global, so try to use unique names.	1061	arguments using the first one.
		1062
		1063	$handle->push_write (My::Type => " ", 1,2,3);
		1064
		1065	# uses the following package, which can be defined in the "My::Type" or in
		1066	# the "My" modules to be auto-loaded, or just about anywhere when the
		1067	# My::Type::anyevent_write_type is defined before invoking it.
		1068
		1069	package My::Type;
		1070
		1071	sub anyevent_write_type {
		1072	my ($handle, $delim, @args) = @_;
		1073
		1074	join $delim, @args
		1075	}
774		1076
775	=cut	1077	=cut
776		1078
777	#############################################################################	1079	#############################################################################
778		1080
…		…
860	=cut	1162	=cut
861		1163
862	sub _drain_rbuf {	1164	sub _drain_rbuf {
863	my ($self) = @_;	1165	my ($self) = @_;
864		1166
		1167	# avoid recursion
		1168	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	1169	local $self->{_skip_drain_rbuf} = 1;
866
867	if (
868	defined $self->{rbuf_max}
869	&& $self->{rbuf_max} < length $self->{rbuf}
870	) {
871	$self->_error (&Errno::ENOSPC, 1), return;
872	}
873		1170
874	while () {	1171	while () {
875	# we need to use a separate tls read buffer, as we must not receive data while	1172	# we need to use a separate tls read buffer, as we must not receive data while
876	# we are draining the buffer, and this can only happen with TLS.	1173	# we are draining the buffer, and this can only happen with TLS.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1174	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1175	if exists $self->{_tls_rbuf};
878		1176
879	my $len = length $self->{rbuf};	1177	my $len = length $self->{rbuf};
880		1178
881	if (my $cb = shift @{ $self->{_queue} }) {	1179	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1180	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1181	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1182	# (not enough data and no data forthcoming)
885	$self->_error (&Errno::EPIPE, 1), return;	1183	$self->_error (Errno::EPIPE, 1), return
886	}	1184	if $self->{_eof};
887		1185
888	unshift @{ $self->{_queue} }, $cb;	1186	unshift @{ $self->{_queue} }, $cb;
889	last;	1187	last;
890	}	1188	}
891	} elsif ($self->{on_read}) {	1189	} elsif ($self->{on_read}) {
…		…
898	&& !@{ $self->{_queue} } # and the queue is still empty	1196	&& !@{ $self->{_queue} } # and the queue is still empty
899	&& $self->{on_read} # but we still have on_read	1197	&& $self->{on_read} # but we still have on_read
900	) {	1198	) {
901	# no further data will arrive	1199	# no further data will arrive
902	# so no progress can be made	1200	# so no progress can be made
903	$self->_error (&Errno::EPIPE, 1), return	1201	$self->_error (Errno::EPIPE, 1), return
904	if $self->{_eof};	1202	if $self->{_eof};
905		1203
906	last; # more data might arrive	1204	last; # more data might arrive
907	}	1205	}
908	} else {	1206	} else {
…		…
911	last;	1209	last;
912	}	1210	}
913	}	1211	}
914		1212
915	if ($self->{_eof}) {	1213	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1214	$self->{on_eof}
917	$self->{on_eof}($self)	1215	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1216	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	1217
		1218	return;
		1219	}
		1220
		1221	if (
		1222	defined $self->{rbuf_max}
		1223	&& $self->{rbuf_max} < length $self->{rbuf}
		1224	) {
		1225	$self->_error (Errno::ENOSPC, 1), return;
921	}	1226	}
922		1227
923	# may need to restart read watcher	1228	# may need to restart read watcher
924	unless ($self->{_rw}) {	1229	unless ($self->{_rw}) {
925	$self->start_read	1230	$self->start_read
…		…
937		1242
938	sub on_read {	1243	sub on_read {
939	my ($self, $cb) = @_;	1244	my ($self, $cb) = @_;
940		1245
941	$self->{on_read} = $cb;	1246	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1247	$self->_drain_rbuf if $cb;
943	}	1248	}
944		1249
945	=item $handle->rbuf	1250	=item $handle->rbuf
946		1251
947	Returns the read buffer (as a modifiable lvalue).	1252	Returns the read buffer (as a modifiable lvalue).
…		…
994	my $cb = pop;	1299	my $cb = pop;
995		1300
996	if (@_) {	1301	if (@_) {
997	my $type = shift;	1302	my $type = shift;
998		1303
		1304	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
999	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1305	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1000	->($self, $cb, @_);	1306	->($self, $cb, @_);
1001	}	1307	}
1002		1308
1003	push @{ $self->{_queue} }, $cb;	1309	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1310	$self->_drain_rbuf;
1005	}	1311	}
1006		1312
1007	sub unshift_read {	1313	sub unshift_read {
1008	my $self = shift;	1314	my $self = shift;
1009	my $cb = pop;	1315	my $cb = pop;
…		…
1013		1319
1014	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1320	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1015	->($self, $cb, @_);	1321	->($self, $cb, @_);
1016	}	1322	}
1017		1323
1018
1019	unshift @{ $self->{_queue} }, $cb;	1324	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1325	$self->_drain_rbuf;
1021	}	1326	}
1022		1327
1023	=item $handle->push_read (type => @args, $cb)	1328	=item $handle->push_read (type => @args, $cb)
1024		1329
1025	=item $handle->unshift_read (type => @args, $cb)	1330	=item $handle->unshift_read (type => @args, $cb)
1026		1331
1027	Instead of providing a callback that parses the data itself you can chose	1332	Instead of providing a callback that parses the data itself you can chose
1028	between a number of predefined parsing formats, for chunks of data, lines	1333	between a number of predefined parsing formats, for chunks of data, lines
1029	etc.	1334	etc. You can also specify the (fully qualified) name of a package, in
		1335	which case AnyEvent tries to load the package and then expects to find the
		1336	C<anyevent_read_type> function inside (see "custom read types", below).
1030		1337
1031	Predefined types are (if you have ideas for additional types, feel free to	1338	Predefined types are (if you have ideas for additional types, feel free to
1032	drop by and tell us):	1339	drop by and tell us):
1033		1340
1034	=over 4	1341	=over 4
…		…
1158	return 1;	1465	return 1;
1159	}	1466	}
1160		1467
1161	# reject	1468	# reject
1162	if ($reject && $$rbuf =~ $reject) {	1469	if ($reject && $$rbuf =~ $reject) {
1163	$self->_error (&Errno::EBADMSG);	1470	$self->_error (Errno::EBADMSG);
1164	}	1471	}
1165		1472
1166	# skip	1473	# skip
1167	if ($skip && $$rbuf =~ $skip) {	1474	if ($skip && $$rbuf =~ $skip) {
1168	$data .= substr $$rbuf, 0, $+[0], "";	1475	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1184	my ($self, $cb) = @_;	1491	my ($self, $cb) = @_;
1185		1492
1186	sub {	1493	sub {
1187	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1494	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1188	if ($_[0]{rbuf} =~ /[^0-9]/) {	1495	if ($_[0]{rbuf} =~ /[^0-9]/) {
1189	$self->_error (&Errno::EBADMSG);	1496	$self->_error (Errno::EBADMSG);
1190	}	1497	}
1191	return;	1498	return;
1192	}	1499	}
1193		1500
1194	my $len = $1;	1501	my $len = $1;
…		…
1197	my $string = $_[1];	1504	my $string = $_[1];
1198	$_[0]->unshift_read (chunk => 1, sub {	1505	$_[0]->unshift_read (chunk => 1, sub {
1199	if ($_[1] eq ",") {	1506	if ($_[1] eq ",") {
1200	$cb->($_[0], $string);	1507	$cb->($_[0], $string);
1201	} else {	1508	} else {
1202	$self->_error (&Errno::EBADMSG);	1509	$self->_error (Errno::EBADMSG);
1203	}	1510	}
1204	});	1511	});
1205	});	1512	});
1206		1513
1207	1	1514	1
…		…
1274	=cut	1581	=cut
1275		1582
1276	register_read_type json => sub {	1583	register_read_type json => sub {
1277	my ($self, $cb) = @_;	1584	my ($self, $cb) = @_;
1278		1585
1279	my $json = $self->{json} \|\|=	1586	my $json = $self->{json} \|\|= json_coder;
1280	eval { require JSON::XS; JSON::XS->new->utf8 }
1281	\|\| do { require JSON; JSON->new->utf8 };
1282		1587
1283	my $data;	1588	my $data;
1284	my $rbuf = \$self->{rbuf};	1589	my $rbuf = \$self->{rbuf};
1285		1590
1286	sub {	1591	sub {
…		…
1297	$json->incr_skip;	1602	$json->incr_skip;
1298		1603
1299	$self->{rbuf} = $json->incr_text;	1604	$self->{rbuf} = $json->incr_text;
1300	$json->incr_text = "";	1605	$json->incr_text = "";
1301		1606
1302	$self->_error (&Errno::EBADMSG);	1607	$self->_error (Errno::EBADMSG);
1303		1608
1304	()	1609	()
1305	} else {	1610	} else {
1306	$self->{rbuf} = "";	1611	$self->{rbuf} = "";
1307		1612
…		…
1344	# read remaining chunk	1649	# read remaining chunk
1345	$_[0]->unshift_read (chunk => $len, sub {	1650	$_[0]->unshift_read (chunk => $len, sub {
1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1651	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1347	$cb->($_[0], $ref);	1652	$cb->($_[0], $ref);
1348	} else {	1653	} else {
1349	$self->_error (&Errno::EBADMSG);	1654	$self->_error (Errno::EBADMSG);
1350	}	1655	}
1351	});	1656	});
1352	}	1657	}
1353		1658
1354	1	1659	1
1355	}	1660	}
1356	};	1661	};
1357		1662
1358	=back	1663	=back
1359		1664
1360	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1665	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1361		1666
1362	This function (not method) lets you add your own types to C<push_read>.	1667	Instead of one of the predefined types, you can also specify the name
		1668	of a package. AnyEvent will try to load the package and then expects to
		1669	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1670	progressively tries to load the parent package until it either finds the
		1671	function (good) or runs out of packages (bad).
1363		1672
1364	Whenever the given C<type> is used, C<push_read> will invoke the code	1673	Whenever this type is used, C<push_read> will invoke the function with the
1365	reference with the handle object, the callback and the remaining	1674	handle object, the original callback and the remaining arguments.
1366	arguments.
1367		1675
1368	The code reference is supposed to return a callback (usually a closure)	1676	The function is supposed to return a callback (usually a closure) that
1369	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1677	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1678	mentally treat the function as a "configurable read type to read callback"
		1679	converter.
1370		1680
1371	It should invoke the passed callback when it is done reading (remember to	1681	It should invoke the original callback when it is done reading (remember
1372	pass C<$handle> as first argument as all other callbacks do that).	1682	to pass C<$handle> as first argument as all other callbacks do that,
		1683	although there is no strict requirement on this).
1373		1684
1374	Note that this is a function, and all types registered this way will be
1375	global, so try to use unique names.
1376
1377	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1685	For examples, see the source of this module (F<perldoc -m
1378	search for C<register_read_type>)).	1686	AnyEvent::Handle>, search for C<register_read_type>)).
1379		1687
1380	=item $handle->stop_read	1688	=item $handle->stop_read
1381		1689
1382	=item $handle->start_read	1690	=item $handle->start_read
1383		1691
…		…
1406	my ($self) = @_;	1714	my ($self) = @_;
1407		1715
1408	unless ($self->{_rw} \|\| $self->{_eof}) {	1716	unless ($self->{_rw} \|\| $self->{_eof}) {
1409	Scalar::Util::weaken $self;	1717	Scalar::Util::weaken $self;
1410		1718
1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1719	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1720	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1721	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1414		1722
1415	if ($len > 0) {	1723	if ($len > 0) {
1416	$self->{_activity} = AnyEvent->now;	1724	$self->{_activity} = $self->{_ractivity} = AE::now;
1417		1725
1418	if ($self->{tls}) {	1726	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1727	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1728
1421	&_dotls ($self);	1729	&_dotls ($self);
1422	} else {	1730	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1731	$self->_drain_rbuf;
1424	}	1732	}
1425		1733
1426	} elsif (defined $len) {	1734	} elsif (defined $len) {
1427	delete $self->{_rw};	1735	delete $self->{_rw};
1428	$self->{_eof} = 1;	1736	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1737	$self->_drain_rbuf;
1430		1738
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1739	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1740	return $self->_error ($!, 1);
1433	}	1741	}
1434	});	1742	};
1435	}	1743	}
1436	}	1744	}
1437		1745
1438	our $ERROR_SYSCALL;	1746	our $ERROR_SYSCALL;
1439	our $ERROR_WANT_READ;	1747	our $ERROR_WANT_READ;
…		…
1452	if ($self->{_on_starttls}) {	1760	if ($self->{_on_starttls}) {
1453	(delete $self->{_on_starttls})->($self, undef, $err);	1761	(delete $self->{_on_starttls})->($self, undef, $err);
1454	&_freetls;	1762	&_freetls;
1455	} else {	1763	} else {
1456	&_freetls;	1764	&_freetls;
1457	$self->_error (&Errno::EPROTO, 1, $err);	1765	$self->_error (Errno::EPROTO, 1, $err);
1458	}	1766	}
1459	}	1767	}
1460		1768
1461	# poll the write BIO and send the data if applicable	1769	# poll the write BIO and send the data if applicable
1462	# also decode read data if possible	1770	# also decode read data if possible
…		…
1494	$self->{_eof} = 1;	1802	$self->{_eof} = 1;
1495	}	1803	}
1496	}	1804	}
1497		1805
1498	$self->{_tls_rbuf} .= $tmp;	1806	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1807	$self->_drain_rbuf;
1500	$self->{tls} or return; # tls session might have gone away in callback	1808	$self->{tls} or return; # tls session might have gone away in callback
1501	}	1809	}
1502		1810
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1811	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1812	return $self->_tls_error ($tmp)
…		…
1519		1827
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1828	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1521	object is created, you can also do that at a later time by calling	1829	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1830	C<starttls>.
1523		1831
		1832	Starting TLS is currently an asynchronous operation - when you push some
		1833	write data and then call C<< ->starttls >> then TLS negotiation will start
		1834	immediately, after which the queued write data is then sent.
		1835
1524	The first argument is the same as the C<tls> constructor argument (either	1836	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1837	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1838
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1839	The second argument is the optional C<AnyEvent::TLS> object that is used
1528	when AnyEvent::Handle has to create its own TLS connection object, or	1840	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1532	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1844	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1533	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1845	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1534	changed to your liking. Note that the handshake might have already started	1846	changed to your liking. Note that the handshake might have already started
1535	when this function returns.	1847	when this function returns.
1536		1848
1537	If it an error to start a TLS handshake more than once per	1849	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1538	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1850	handshakes on the same stream. Best do not attempt to use the stream after
		1851	stopping TLS.
1539		1852
1540	=cut	1853	=cut
1541		1854
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1855	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1856
1544	sub starttls {	1857	sub starttls {
1545	my ($self, $ssl, $ctx) = @_;	1858	my ($self, $tls, $ctx) = @_;
		1859
		1860	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1861	if $self->{tls};
		1862
		1863	$self->{tls} = $tls;
		1864	$self->{tls_ctx} = $ctx if @_ > 2;
		1865
		1866	return unless $self->{fh};
1546		1867
1547	require Net::SSLeay;	1868	require Net::SSLeay;
1548
1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1550	if $self->{tls};
1551		1869
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1870	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1871	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1872
		1873	$tls = delete $self->{tls};
1555	$ctx \|\|= $self->{tls_ctx};	1874	$ctx = $self->{tls_ctx};
		1875
		1876	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1877
1557	if ("HASH" eq ref $ctx) {	1878	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1879	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1880
1562	if ($ctx->{cache}) {	1881	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1882	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1883	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1565	} else {	1884	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1885	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1886	}
1568	}	1887	}
1569		1888
1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1889	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1890	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1572		1891
1573	# basically, this is deep magic (because SSL_read should have the same issues)	1892	# basically, this is deep magic (because SSL_read should have the same issues)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1893	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1894	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1895	# and mismaintained ssleay-module doesn't even offer them).
…		…
1583	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1902	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1903	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1904	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1905	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1587	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1906	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1907	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1589		1908
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1910	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1911
		1912	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1913
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1914	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1915
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1916	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1917	if $self->{on_starttls};
1597		1918
1598	&_dotls; # need to trigger the initial handshake	1919	&_dotls; # need to trigger the initial handshake
…		…
1601		1922
1602	=item $handle->stoptls	1923	=item $handle->stoptls
1603		1924
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1925	Shuts down the SSL connection - this makes a proper EOF handshake by
1605	sending a close notify to the other side, but since OpenSSL doesn't	1926	sending a close notify to the other side, but since OpenSSL doesn't
1606	support non-blocking shut downs, it is not possible to re-use the stream	1927	support non-blocking shut downs, it is not guarenteed that you can re-use
1607	afterwards.	1928	the stream afterwards.
1608		1929
1609	=cut	1930	=cut
1610		1931
1611	sub stoptls {	1932	sub stoptls {
1612	my ($self) = @_;	1933	my ($self) = @_;
…		…
1625	sub _freetls {	1946	sub _freetls {
1626	my ($self) = @_;	1947	my ($self) = @_;
1627		1948
1628	return unless $self->{tls};	1949	return unless $self->{tls};
1629		1950
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1951	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1952	if $self->{tls} > 0;
1631		1953
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1954	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1955	}
1634		1956
1635	sub DESTROY {	1957	sub DESTROY {
…		…
1637		1959
1638	&_freetls;	1960	&_freetls;
1639		1961
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1962	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		1963
1642	if ($linger && length $self->{wbuf}) {	1964	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	1965	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	1966	my $wbuf = delete $self->{wbuf};
1645		1967
1646	my @linger;	1968	my @linger;
1647		1969
1648	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1970	push @linger, AE::io $fh, 1, sub {
1649	my $len = syswrite $fh, $wbuf, length $wbuf;	1971	my $len = syswrite $fh, $wbuf, length $wbuf;
1650		1972
1651	if ($len > 0) {	1973	if ($len > 0) {
1652	substr $wbuf, 0, $len, "";	1974	substr $wbuf, 0, $len, "";
1653	} else {	1975	} else {
1654	@linger = (); # end	1976	@linger = (); # end
1655	}	1977	}
1656	});	1978	};
1657	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1979	push @linger, AE::timer $linger, 0, sub {
1658	@linger = ();	1980	@linger = ();
1659	});	1981	};
1660	}	1982	}
1661	}	1983	}
1662		1984
1663	=item $handle->destroy	1985	=item $handle->destroy
1664		1986
1665	Shuts down the handle object as much as possible - this call ensures that	1987	Shuts down the handle object as much as possible - this call ensures that
1666	no further callbacks will be invoked and as many resources as possible	1988	no further callbacks will be invoked and as many resources as possible
1667	will be freed. You must not call any methods on the object afterwards.	1989	will be freed. Any method you will call on the handle object after
		1990	destroying it in this way will be silently ignored (and it will return the
		1991	empty list).
1668		1992
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	1993	Normally, you can just "forget" any references to an AnyEvent::Handle
1670	object and it will simply shut down. This works in fatal error and EOF	1994	object and it will simply shut down. This works in fatal error and EOF
1671	callbacks, as well as code outside. It does I<NOT> work in a read or write	1995	callbacks, as well as code outside. It does I<NOT> work in a read or write
1672	callback, so when you want to destroy the AnyEvent::Handle object from	1996	callback, so when you want to destroy the AnyEvent::Handle object from
1673	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1997	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1674	that case.	1998	that case.
1675		1999
		2000	Destroying the handle object in this way has the advantage that callbacks
		2001	will be removed as well, so if those are the only reference holders (as
		2002	is common), then one doesn't need to do anything special to break any
		2003	reference cycles.
		2004
1676	The handle might still linger in the background and write out remaining	2005	The handle might still linger in the background and write out remaining
1677	data, as specified by the C<linger> option, however.	2006	data, as specified by the C<linger> option, however.
1678		2007
1679	=cut	2008	=cut
1680		2009
1681	sub destroy {	2010	sub destroy {
1682	my ($self) = @_;	2011	my ($self) = @_;
1683		2012
1684	$self->DESTROY;	2013	$self->DESTROY;
1685	%$self = ();	2014	%$self = ();
		2015	bless $self, "AnyEvent::Handle::destroyed";
		2016	}
		2017
		2018	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2019	#nop
1686	}	2020	}
1687		2021
1688	=item AnyEvent::Handle::TLS_CTX	2022	=item AnyEvent::Handle::TLS_CTX
1689		2023
1690	This function creates and returns the AnyEvent::TLS object used by default	2024	This function creates and returns the AnyEvent::TLS object used by default
…		…
1747		2081
1748	$handle->on_read (sub { });	2082	$handle->on_read (sub { });
1749	$handle->on_eof (undef);	2083	$handle->on_eof (undef);
1750	$handle->on_error (sub {	2084	$handle->on_error (sub {
1751	my $data = delete $_[0]{rbuf};	2085	my $data = delete $_[0]{rbuf};
1752	undef $handle;
1753	});	2086	});
1754		2087
1755	The reason to use C<on_error> is that TCP connections, due to latencies	2088	The reason to use C<on_error> is that TCP connections, due to latencies
1756	and packets loss, might get closed quite violently with an error, when in	2089	and packets loss, might get closed quite violently with an error, when in
1757	fact, all data has been received.	2090	fact, all data has been received.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.145 by root, Mon Jul 6 21:47:14 2009 UTC vs. Revision 1.189 by root, Mon Sep 28 17:30:54 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.145 by root, Mon Jul 6 21:47:14 2009 UTC vs.
Revision 1.189 by root, Mon Sep 28 17:30:54 2009 UTC