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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.194 by root, Thu May 20 21:22:21 2010 UTC

…		…
1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.86;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	warn "got error $msg\n";
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
…		…
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	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
49	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes or other stream things).
50	on sockets see L<AnyEvent::Util>.
51		37
52	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
53	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
54		40
55	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
56	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
57	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
58		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
59	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
60	argument.	49	argument.
61		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
62	=head1 METHODS	80	=head1 METHODS
63		81
64	=over 4	82	=over 4
65		83
66	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
67		85
68	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
69		87
70	=over 4	88	=over 4
71		89
72	=item fh => $filehandle [MANDATORY]
73
74	#=item fh => $filehandle [C<fh> or C<connect> 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	NOTE: The filehandle will be set to non-blocking mode (using	93	NOTE: The filehandle will be set to non-blocking mode (using
78	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
79	that mode.	95	that mode.
80		96
81	#=item connect => [$host, $service]	97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
82	#	98
83	# You have to specify either this parameter, or C<connect>, below.
84	#Try to connect to the specified host and service (port), using	99	Try to connect to the specified host and service (port), using
85	#C<AnyEvent::Socket::tcp_connect>.	100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
86	#	101	default C<peername>.
87	#When this	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.
88		206
89	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
90		208
91	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,
92	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
…		…
100	down.	218	down.
101		219
102	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
103	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>.
104		222
105	=item on_error => $cb->($handle, $fatal, $message)
106
107	This is the error callback, which is called when, well, some error
108	occured, such as not being able to resolve the hostname, failure to
109	connect or a read error.
110
111	Some errors are fatal (which is indicated by C<$fatal> being true). On
112	fatal errors the handle object will be destroyed (by a call to C<< ->
113	destroy >>) after invoking the error callback (which means you are free to
114	examine the handle object). Examples of fatal errors are an EOF condition
115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
116
117	AnyEvent::Handle tries to find an appropriate error code for you to check
118	against, but in some cases (TLS errors), this does not work well. It is
119	recommended to always output the C<$message> argument in human-readable
120	error messages (it's usually the same as C<"$!">).
121
122	Non-fatal errors can be retried by simply returning, but it is recommended
123	to simply ignore this parameter and instead abondon the handle object
124	when this callback is invoked. Examples of non-fatal errors are timeouts
125	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
126
127	On callback entrance, the value of C<$!> contains the operating system
128	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
129	C<EPROTO>).
130
131	While not mandatory, it is I<highly> recommended to set this callback, as
132	you will not be notified of errors otherwise. The default simply calls
133	C<croak>.
134
135	=item on_read => $cb->($handle)
136
137	This sets the default read callback, which is called when data arrives
138	and no read request is in the queue (unlike read queue callbacks, this
139	callback will only be called when at least one octet of data is in the
140	read buffer).
141
142	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
143	method or access the C<< $handle->{rbuf} >> member directly. Note that you
144	must not enlarge or modify the read buffer, you can only remove data at
145	the beginning from it.
146
147	When an EOF condition is detected then AnyEvent::Handle will first try to
148	feed all the remaining data to the queued callbacks and C<on_read> before
149	calling the C<on_eof> callback. If no progress can be made, then a fatal
150	error will be raised (with C<$!> set to C<EPIPE>).
151
152	Note that, unlike requests in the read queue, an C<on_read> callback
153	doesn't mean you I<require> some data: if there is an EOF and there
154	are outstanding read requests then an error will be flagged. With an
155	C<on_read> callback, the C<on_eof> callback will be invoked.
156
157	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
158		224
159	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
160	(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).
161		227
…		…
167	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
168	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
169		235
170	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
171		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
172	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
173	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
174	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
175	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>.
176		253
177	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
178	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
179	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
180	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
…		…
224	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
225		302
226	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
227	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
228		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
229	=item read_size => <bytes>	338	=item read_size => <bytes>
230		339
231	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
232	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
233	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
266	C<undef>.	375	C<undef>.
267		376
268	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
269		378
270	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
271	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
272	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
273		382
274	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
275	appropriate error message.	384	appropriate error message.
276		385
…		…
359		468
360	sub new {	469	sub new {
361	my $class = shift;	470	my $class = shift;
362	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
363		472
364	$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) = @_;
		536
		537	# too many clueless people try to use udp and similar sockets
		538	# with AnyEvent::Handle, do them a favour.
		539	if (Socket::SOCK_STREAM != unpack "I", getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ()) {
		540	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!";
		541	}
365		542
366	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	543	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
367		544
		545	$self->{_activity} =
		546	$self->{_ractivity} =
368	$self->{_activity} = AnyEvent->now;	547	$self->{_wactivity} = AE::now;
369	$self->_timeout;
370		548
		549	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		550	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		551	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		552
371	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	553	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		554	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
372		555
		556	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		557
373	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	558	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
374	if $self->{tls};	559	if $self->{tls};
375		560
376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	561	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
377		562
378	$self->start_read	563	$self->start_read
379	if $self->{on_read};	564	if $self->{on_read} \|\| @{ $self->{_queue} };
380		565
381	$self->{fh} && $self	566	$self->_drain_wbuf;
382	}	567	}
383
384	#sub _shutdown {
385	# my ($self) = @_;
386	#
387	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
388	# $self->{_eof} = 1; # tell starttls et. al to stop trying
389	#
390	# &_freetls;
391	#}
392		568
393	sub _error {	569	sub _error {
394	my ($self, $errno, $fatal, $message) = @_;	570	my ($self, $errno, $fatal, $message) = @_;
395		571
396	$! = $errno;	572	$! = $errno;
397	$message \|\|= "$!";	573	$message \|\|= "$!";
398		574
399	if ($self->{on_error}) {	575	if ($self->{on_error}) {
400	$self->{on_error}($self, $fatal, $message);	576	$self->{on_error}($self, $fatal, $message);
401	$self->destroy if $fatal;	577	$self->destroy if $fatal;
402	} elsif ($self->{fh}) {	578	} elsif ($self->{fh} \|\| $self->{connect}) {
403	$self->destroy;	579	$self->destroy;
404	Carp::croak "AnyEvent::Handle uncaught error: $message";	580	Carp::croak "AnyEvent::Handle uncaught error: $message";
405	}	581	}
406	}	582	}
407		583
…		…
433	$_[0]{on_eof} = $_[1];	609	$_[0]{on_eof} = $_[1];
434	}	610	}
435		611
436	=item $handle->on_timeout ($cb)	612	=item $handle->on_timeout ($cb)
437		613
438	Replace the current C<on_timeout> callback, or disables the callback (but	614	=item $handle->on_rtimeout ($cb)
439	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
440	argument and method.
441		615
442	=cut	616	=item $handle->on_wtimeout ($cb)
443		617
444	sub on_timeout {	618	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
445	$_[0]{on_timeout} = $_[1];	619	callback, or disables the callback (but not the timeout) if C<$cb> =
446	}	620	C<undef>. See the C<timeout> constructor argument and method.
		621
		622	=cut
		623
		624	# see below
447		625
448	=item $handle->autocork ($boolean)	626	=item $handle->autocork ($boolean)
449		627
450	Enables or disables the current autocork behaviour (see C<autocork>	628	Enables or disables the current autocork behaviour (see C<autocork>
451	constructor argument). Changes will only take effect on the next write.	629	constructor argument). Changes will only take effect on the next write.
…		…
466	sub no_delay {	644	sub no_delay {
467	$_[0]{no_delay} = $_[1];	645	$_[0]{no_delay} = $_[1];
468		646
469	eval {	647	eval {
470	local $SIG{__DIE__};	648	local $SIG{__DIE__};
471	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	649	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		650	if $_[0]{fh};
		651	};
		652	}
		653
		654	=item $handle->keepalive ($boolean)
		655
		656	Enables or disables the C<keepalive> setting (see constructor argument of
		657	the same name for details).
		658
		659	=cut
		660
		661	sub keepalive {
		662	$_[0]{keepalive} = $_[1];
		663
		664	eval {
		665	local $SIG{__DIE__};
		666	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		667	if $_[0]{fh};
		668	};
		669	}
		670
		671	=item $handle->oobinline ($boolean)
		672
		673	Enables or disables the C<oobinline> setting (see constructor argument of
		674	the same name for details).
		675
		676	=cut
		677
		678	sub oobinline {
		679	$_[0]{oobinline} = $_[1];
		680
		681	eval {
		682	local $SIG{__DIE__};
		683	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		684	if $_[0]{fh};
		685	};
		686	}
		687
		688	=item $handle->keepalive ($boolean)
		689
		690	Enables or disables the C<keepalive> setting (see constructor argument of
		691	the same name for details).
		692
		693	=cut
		694
		695	sub keepalive {
		696	$_[0]{keepalive} = $_[1];
		697
		698	eval {
		699	local $SIG{__DIE__};
		700	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		701	if $_[0]{fh};
472	};	702	};
473	}	703	}
474		704
475	=item $handle->on_starttls ($cb)	705	=item $handle->on_starttls ($cb)
476		706
…		…
486		716
487	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	717	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
488		718
489	=cut	719	=cut
490		720
491	sub on_starttls {	721	sub on_stoptls {
492	$_[0]{on_stoptls} = $_[1];	722	$_[0]{on_stoptls} = $_[1];
493	}	723	}
494		724
		725	=item $handle->rbuf_max ($max_octets)
		726
		727	Configures the C<rbuf_max> setting (C<undef> disables it).
		728
		729	=cut
		730
		731	sub rbuf_max {
		732	$_[0]{rbuf_max} = $_[1];
		733	}
		734
495	#############################################################################	735	#############################################################################
496		736
497	=item $handle->timeout ($seconds)	737	=item $handle->timeout ($seconds)
498		738
		739	=item $handle->rtimeout ($seconds)
		740
		741	=item $handle->wtimeout ($seconds)
		742
499	Configures (or disables) the inactivity timeout.	743	Configures (or disables) the inactivity timeout.
500		744
501	=cut	745	=item $handle->timeout_reset
502		746
503	sub timeout {	747	=item $handle->rtimeout_reset
		748
		749	=item $handle->wtimeout_reset
		750
		751	Reset the activity timeout, as if data was received or sent.
		752
		753	These methods are cheap to call.
		754
		755	=cut
		756
		757	for my $dir ("", "r", "w") {
		758	my $timeout = "${dir}timeout";
		759	my $tw = "_${dir}tw";
		760	my $on_timeout = "on_${dir}timeout";
		761	my $activity = "_${dir}activity";
		762	my $cb;
		763
		764	*$on_timeout = sub {
		765	$_[0]{$on_timeout} = $_[1];
		766	};
		767
		768	*$timeout = sub {
504	my ($self, $timeout) = @_;	769	my ($self, $new_value) = @_;
505		770
506	$self->{timeout} = $timeout;	771	$self->{$timeout} = $new_value;
507	$self->_timeout;	772	delete $self->{$tw}; &$cb;
508	}	773	};
509		774
		775	*{"${dir}timeout_reset"} = sub {
		776	$_[0]{$activity} = AE::now;
		777	};
		778
		779	# main workhorse:
510	# reset the timeout watcher, as neccessary	780	# reset the timeout watcher, as neccessary
511	# also check for time-outs	781	# also check for time-outs
512	sub _timeout {	782	$cb = sub {
513	my ($self) = @_;	783	my ($self) = @_;
514		784
515	if ($self->{timeout}) {	785	if ($self->{$timeout} && $self->{fh}) {
516	my $NOW = AnyEvent->now;	786	my $NOW = AE::now;
517		787
518	# when would the timeout trigger?	788	# when would the timeout trigger?
519	my $after = $self->{_activity} + $self->{timeout} - $NOW;	789	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
520		790
521	# now or in the past already?	791	# now or in the past already?
522	if ($after <= 0) {	792	if ($after <= 0) {
523	$self->{_activity} = $NOW;	793	$self->{$activity} = $NOW;
524		794
525	if ($self->{on_timeout}) {	795	if ($self->{$on_timeout}) {
526	$self->{on_timeout}($self);	796	$self->{$on_timeout}($self);
527	} else {	797	} else {
528	$self->_error (Errno::ETIMEDOUT);	798	$self->_error (Errno::ETIMEDOUT);
		799	}
		800
		801	# callback could have changed timeout value, optimise
		802	return unless $self->{$timeout};
		803
		804	# calculate new after
		805	$after = $self->{$timeout};
529	}	806	}
530		807
531	# callback could have changed timeout value, optimise	808	Scalar::Util::weaken $self;
532	return unless $self->{timeout};	809	return unless $self; # ->error could have destroyed $self
533		810
534	# calculate new after	811	$self->{$tw} \|\|= AE::timer $after, 0, sub {
535	$after = $self->{timeout};	812	delete $self->{$tw};
		813	$cb->($self);
		814	};
		815	} else {
		816	delete $self->{$tw};
536	}	817	}
537
538	Scalar::Util::weaken $self;
539	return unless $self; # ->error could have destroyed $self
540
541	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
542	delete $self->{_tw};
543	$self->_timeout;
544	});
545	} else {
546	delete $self->{_tw};
547	}	818	}
548	}	819	}
549		820
550	#############################################################################	821	#############################################################################
551		822
…		…
566		837
567	=item $handle->on_drain ($cb)	838	=item $handle->on_drain ($cb)
568		839
569	Sets the C<on_drain> callback or clears it (see the description of	840	Sets the C<on_drain> callback or clears it (see the description of
570	C<on_drain> in the constructor).	841	C<on_drain> in the constructor).
		842
		843	This method may invoke callbacks (and therefore the handle might be
		844	destroyed after it returns).
571		845
572	=cut	846	=cut
573		847
574	sub on_drain {	848	sub on_drain {
575	my ($self, $cb) = @_;	849	my ($self, $cb) = @_;
…		…
584		858
585	Queues the given scalar to be written. You can push as much data as you	859	Queues the given scalar to be written. You can push as much data as you
586	want (only limited by the available memory), as C<AnyEvent::Handle>	860	want (only limited by the available memory), as C<AnyEvent::Handle>
587	buffers it independently of the kernel.	861	buffers it independently of the kernel.
588		862
		863	This method may invoke callbacks (and therefore the handle might be
		864	destroyed after it returns).
		865
589	=cut	866	=cut
590		867
591	sub _drain_wbuf {	868	sub _drain_wbuf {
592	my ($self) = @_;	869	my ($self) = @_;
593		870
…		…
599	my $len = syswrite $self->{fh}, $self->{wbuf};	876	my $len = syswrite $self->{fh}, $self->{wbuf};
600		877
601	if (defined $len) {	878	if (defined $len) {
602	substr $self->{wbuf}, 0, $len, "";	879	substr $self->{wbuf}, 0, $len, "";
603		880
604	$self->{_activity} = AnyEvent->now;	881	$self->{_activity} = $self->{_wactivity} = AE::now;
605		882
606	$self->{on_drain}($self)	883	$self->{on_drain}($self)
607	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	884	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
608	&& $self->{on_drain};	885	&& $self->{on_drain};
609		886
…		…
615		892
616	# try to write data immediately	893	# try to write data immediately
617	$cb->() unless $self->{autocork};	894	$cb->() unless $self->{autocork};
618		895
619	# if still data left in wbuf, we need to poll	896	# if still data left in wbuf, we need to poll
620	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	897	$self->{_ww} = AE::io $self->{fh}, 1, $cb
621	if length $self->{wbuf};	898	if length $self->{wbuf};
622	};	899	};
623	}	900	}
624		901
625	our %WH;	902	our %WH;
626		903
		904	# deprecated
627	sub register_write_type($$) {	905	sub register_write_type($$) {
628	$WH{$_[0]} = $_[1];	906	$WH{$_[0]} = $_[1];
629	}	907	}
630		908
631	sub push_write {	909	sub push_write {
632	my $self = shift;	910	my $self = shift;
633		911
634	if (@_ > 1) {	912	if (@_ > 1) {
635	my $type = shift;	913	my $type = shift;
636		914
		915	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
637	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	916	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
638	->($self, @_);	917	->($self, @_);
639	}	918	}
640		919
		920	# we downgrade here to avoid hard-to-track-down bugs,
		921	# and diagnose the problem earlier and better.
		922
641	if ($self->{tls}) {	923	if ($self->{tls}) {
642	$self->{_tls_wbuf} .= $_[0];	924	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
643		925	&_dotls ($self) if $self->{fh};
644	&_dotls ($self);
645	} else {	926	} else {
646	$self->{wbuf} .= $_[0];	927	utf8::downgrade $self->{wbuf} .= $_[0];
647	$self->_drain_wbuf;	928	$self->_drain_wbuf if $self->{fh};
648	}	929	}
649	}	930	}
650		931
651	=item $handle->push_write (type => @args)	932	=item $handle->push_write (type => @args)
652		933
653	Instead of formatting your data yourself, you can also let this module do	934	Instead of formatting your data yourself, you can also let this module
654	the job by specifying a type and type-specific arguments.	935	do the job by specifying a type and type-specific arguments. You
		936	can also specify the (fully qualified) name of a package, in which
		937	case AnyEvent tries to load the package and then expects to find the
		938	C<anyevent_read_type> function inside (see "custom write types", below).
655		939
656	Predefined types are (if you have ideas for additional types, feel free to	940	Predefined types are (if you have ideas for additional types, feel free to
657	drop by and tell us):	941	drop by and tell us):
658		942
659	=over 4	943	=over 4
…		…
716	Other languages could read single lines terminated by a newline and pass	1000	Other languages could read single lines terminated by a newline and pass
717	this line into their JSON decoder of choice.	1001	this line into their JSON decoder of choice.
718		1002
719	=cut	1003	=cut
720		1004
		1005	sub json_coder() {
		1006	eval { require JSON::XS; JSON::XS->new->utf8 }
		1007	\|\| do { require JSON; JSON->new->utf8 }
		1008	}
		1009
721	register_write_type json => sub {	1010	register_write_type json => sub {
722	my ($self, $ref) = @_;	1011	my ($self, $ref) = @_;
723		1012
724	require JSON;	1013	my $json = $self->{json} \|\|= json_coder;
725		1014
726	$self->{json} ? $self->{json}->encode ($ref)	1015	$json->encode ($ref)
727	: JSON::encode_json ($ref)
728	};	1016	};
729		1017
730	=item storable => $reference	1018	=item storable => $reference
731		1019
732	Freezes the given reference using L<Storable> and writes it to the	1020	Freezes the given reference using L<Storable> and writes it to the
…		…
758	the peer.	1046	the peer.
759		1047
760	You can rely on the normal read queue and C<on_eof> handling	1048	You can rely on the normal read queue and C<on_eof> handling
761	afterwards. This is the cleanest way to close a connection.	1049	afterwards. This is the cleanest way to close a connection.
762		1050
		1051	This method may invoke callbacks (and therefore the handle might be
		1052	destroyed after it returns).
		1053
763	=cut	1054	=cut
764		1055
765	sub push_shutdown {	1056	sub push_shutdown {
766	my ($self) = @_;	1057	my ($self) = @_;
767		1058
768	delete $self->{low_water_mark};	1059	delete $self->{low_water_mark};
769	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1060	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
770	}	1061	}
771		1062
772	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1063	=item custom write types - Package::anyevent_write_type $handle, @args
773		1064
774	This function (not method) lets you add your own types to C<push_write>.	1065	Instead of one of the predefined types, you can also specify the name of
		1066	a package. AnyEvent will try to load the package and then expects to find
		1067	a function named C<anyevent_write_type> inside. If it isn't found, it
		1068	progressively tries to load the parent package until it either finds the
		1069	function (good) or runs out of packages (bad).
		1070
775	Whenever the given C<type> is used, C<push_write> will invoke the code	1071	Whenever the given C<type> is used, C<push_write> will the function with
776	reference with the handle object and the remaining arguments.	1072	the handle object and the remaining arguments.
777		1073
778	The code reference is supposed to return a single octet string that will	1074	The function is supposed to return a single octet string that will be
779	be appended to the write buffer.	1075	appended to the write buffer, so you cna mentally treat this function as a
		1076	"arguments to on-the-wire-format" converter.
780		1077
781	Note that this is a function, and all types registered this way will be	1078	Example: implement a custom write type C<join> that joins the remaining
782	global, so try to use unique names.	1079	arguments using the first one.
		1080
		1081	$handle->push_write (My::Type => " ", 1,2,3);
		1082
		1083	# uses the following package, which can be defined in the "My::Type" or in
		1084	# the "My" modules to be auto-loaded, or just about anywhere when the
		1085	# My::Type::anyevent_write_type is defined before invoking it.
		1086
		1087	package My::Type;
		1088
		1089	sub anyevent_write_type {
		1090	my ($handle, $delim, @args) = @_;
		1091
		1092	join $delim, @args
		1093	}
783		1094
784	=cut	1095	=cut
785		1096
786	#############################################################################	1097	#############################################################################
787		1098
…		…
869	=cut	1180	=cut
870		1181
871	sub _drain_rbuf {	1182	sub _drain_rbuf {
872	my ($self) = @_;	1183	my ($self) = @_;
873		1184
		1185	# avoid recursion
		1186	return if $self->{_skip_drain_rbuf};
874	local $self->{_in_drain} = 1;	1187	local $self->{_skip_drain_rbuf} = 1;
875
876	if (
877	defined $self->{rbuf_max}
878	&& $self->{rbuf_max} < length $self->{rbuf}
879	) {
880	$self->_error (Errno::ENOSPC, 1), return;
881	}
882		1188
883	while () {	1189	while () {
884	# we need to use a separate tls read buffer, as we must not receive data while	1190	# we need to use a separate tls read buffer, as we must not receive data while
885	# we are draining the buffer, and this can only happen with TLS.	1191	# we are draining the buffer, and this can only happen with TLS.
886	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1192	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1193	if exists $self->{_tls_rbuf};
887		1194
888	my $len = length $self->{rbuf};	1195	my $len = length $self->{rbuf};
889		1196
890	if (my $cb = shift @{ $self->{_queue} }) {	1197	if (my $cb = shift @{ $self->{_queue} }) {
891	unless ($cb->($self)) {	1198	unless ($cb->($self)) {
892	if ($self->{_eof}) {	1199	# no progress can be made
893	# no progress can be made (not enough data and no data forthcoming)	1200	# (not enough data and no data forthcoming)
894	$self->_error (Errno::EPIPE, 1), return;	1201	$self->_error (Errno::EPIPE, 1), return
895	}	1202	if $self->{_eof};
896		1203
897	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
898	last;	1205	last;
899	}	1206	}
900	} elsif ($self->{on_read}) {	1207	} elsif ($self->{on_read}) {
…		…
920	last;	1227	last;
921	}	1228	}
922	}	1229	}
923		1230
924	if ($self->{_eof}) {	1231	if ($self->{_eof}) {
925	if ($self->{on_eof}) {	1232	$self->{on_eof}
926	$self->{on_eof}($self)	1233	? $self->{on_eof}($self)
927	} else {
928	$self->_error (0, 1, "Unexpected end-of-file");	1234	: $self->_error (0, 1, "Unexpected end-of-file");
929	}	1235
		1236	return;
		1237	}
		1238
		1239	if (
		1240	defined $self->{rbuf_max}
		1241	&& $self->{rbuf_max} < length $self->{rbuf}
		1242	) {
		1243	$self->_error (Errno::ENOSPC, 1), return;
930	}	1244	}
931		1245
932	# may need to restart read watcher	1246	# may need to restart read watcher
933	unless ($self->{_rw}) {	1247	unless ($self->{_rw}) {
934	$self->start_read	1248	$self->start_read
…		…
940		1254
941	This replaces the currently set C<on_read> callback, or clears it (when	1255	This replaces the currently set C<on_read> callback, or clears it (when
942	the new callback is C<undef>). See the description of C<on_read> in the	1256	the new callback is C<undef>). See the description of C<on_read> in the
943	constructor.	1257	constructor.
944		1258
		1259	This method may invoke callbacks (and therefore the handle might be
		1260	destroyed after it returns).
		1261
945	=cut	1262	=cut
946		1263
947	sub on_read {	1264	sub on_read {
948	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
949		1266
950	$self->{on_read} = $cb;	1267	$self->{on_read} = $cb;
951	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1268	$self->_drain_rbuf if $cb;
952	}	1269	}
953		1270
954	=item $handle->rbuf	1271	=item $handle->rbuf
955		1272
956	Returns the read buffer (as a modifiable lvalue).	1273	Returns the read buffer (as a modifiable lvalue).
…		…
988		1305
989	If enough data was available, then the callback must remove all data it is	1306	If enough data was available, then the callback must remove all data it is
990	interested in (which can be none at all) and return a true value. After returning	1307	interested in (which can be none at all) and return a true value. After returning
991	true, it will be removed from the queue.	1308	true, it will be removed from the queue.
992		1309
		1310	These methods may invoke callbacks (and therefore the handle might be
		1311	destroyed after it returns).
		1312
993	=cut	1313	=cut
994		1314
995	our %RH;	1315	our %RH;
996		1316
997	sub register_read_type($$) {	1317	sub register_read_type($$) {
…		…
1003	my $cb = pop;	1323	my $cb = pop;
1004		1324
1005	if (@_) {	1325	if (@_) {
1006	my $type = shift;	1326	my $type = shift;
1007		1327
		1328	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1008	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1329	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1009	->($self, $cb, @_);	1330	->($self, $cb, @_);
1010	}	1331	}
1011		1332
1012	push @{ $self->{_queue} }, $cb;	1333	push @{ $self->{_queue} }, $cb;
1013	$self->_drain_rbuf unless $self->{_in_drain};	1334	$self->_drain_rbuf;
1014	}	1335	}
1015		1336
1016	sub unshift_read {	1337	sub unshift_read {
1017	my $self = shift;	1338	my $self = shift;
1018	my $cb = pop;	1339	my $cb = pop;
…		…
1022		1343
1023	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1344	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1024	->($self, $cb, @_);	1345	->($self, $cb, @_);
1025	}	1346	}
1026		1347
1027
1028	unshift @{ $self->{_queue} }, $cb;	1348	unshift @{ $self->{_queue} }, $cb;
1029	$self->_drain_rbuf unless $self->{_in_drain};	1349	$self->_drain_rbuf;
1030	}	1350	}
1031		1351
1032	=item $handle->push_read (type => @args, $cb)	1352	=item $handle->push_read (type => @args, $cb)
1033		1353
1034	=item $handle->unshift_read (type => @args, $cb)	1354	=item $handle->unshift_read (type => @args, $cb)
1035		1355
1036	Instead of providing a callback that parses the data itself you can chose	1356	Instead of providing a callback that parses the data itself you can chose
1037	between a number of predefined parsing formats, for chunks of data, lines	1357	between a number of predefined parsing formats, for chunks of data, lines
1038	etc.	1358	etc. You can also specify the (fully qualified) name of a package, in
		1359	which case AnyEvent tries to load the package and then expects to find the
		1360	C<anyevent_read_type> function inside (see "custom read types", below).
1039		1361
1040	Predefined types are (if you have ideas for additional types, feel free to	1362	Predefined types are (if you have ideas for additional types, feel free to
1041	drop by and tell us):	1363	drop by and tell us):
1042		1364
1043	=over 4	1365	=over 4
…		…
1283	=cut	1605	=cut
1284		1606
1285	register_read_type json => sub {	1607	register_read_type json => sub {
1286	my ($self, $cb) = @_;	1608	my ($self, $cb) = @_;
1287		1609
1288	my $json = $self->{json} \|\|=	1610	my $json = $self->{json} \|\|= json_coder;
1289	eval { require JSON::XS; JSON::XS->new->utf8 }
1290	\|\| do { require JSON; JSON->new->utf8 };
1291		1611
1292	my $data;	1612	my $data;
1293	my $rbuf = \$self->{rbuf};	1613	my $rbuf = \$self->{rbuf};
1294		1614
1295	sub {	1615	sub {
…		…
1364	}	1684	}
1365	};	1685	};
1366		1686
1367	=back	1687	=back
1368		1688
1369	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1689	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1370		1690
1371	This function (not method) lets you add your own types to C<push_read>.	1691	Instead of one of the predefined types, you can also specify the name
		1692	of a package. AnyEvent will try to load the package and then expects to
		1693	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1694	progressively tries to load the parent package until it either finds the
		1695	function (good) or runs out of packages (bad).
1372		1696
1373	Whenever the given C<type> is used, C<push_read> will invoke the code	1697	Whenever this type is used, C<push_read> will invoke the function with the
1374	reference with the handle object, the callback and the remaining	1698	handle object, the original callback and the remaining arguments.
1375	arguments.
1376		1699
1377	The code reference is supposed to return a callback (usually a closure)	1700	The function is supposed to return a callback (usually a closure) that
1378	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1701	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1702	mentally treat the function as a "configurable read type to read callback"
		1703	converter.
1379		1704
1380	It should invoke the passed callback when it is done reading (remember to	1705	It should invoke the original callback when it is done reading (remember
1381	pass C<$handle> as first argument as all other callbacks do that).	1706	to pass C<$handle> as first argument as all other callbacks do that,
		1707	although there is no strict requirement on this).
1382		1708
1383	Note that this is a function, and all types registered this way will be
1384	global, so try to use unique names.
1385
1386	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1709	For examples, see the source of this module (F<perldoc -m
1387	search for C<register_read_type>)).	1710	AnyEvent::Handle>, search for C<register_read_type>)).
1388		1711
1389	=item $handle->stop_read	1712	=item $handle->stop_read
1390		1713
1391	=item $handle->start_read	1714	=item $handle->start_read
1392		1715
…		…
1412	}	1735	}
1413		1736
1414	sub start_read {	1737	sub start_read {
1415	my ($self) = @_;	1738	my ($self) = @_;
1416		1739
1417	unless ($self->{_rw} \|\| $self->{_eof}) {	1740	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1418	Scalar::Util::weaken $self;	1741	Scalar::Util::weaken $self;
1419		1742
1420	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1743	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1421	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1744	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1422	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1423		1746
1424	if ($len > 0) {	1747	if ($len > 0) {
1425	$self->{_activity} = AnyEvent->now;	1748	$self->{_activity} = $self->{_ractivity} = AE::now;
1426		1749
1427	if ($self->{tls}) {	1750	if ($self->{tls}) {
1428	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1751	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1429		1752
1430	&_dotls ($self);	1753	&_dotls ($self);
1431	} else {	1754	} else {
1432	$self->_drain_rbuf unless $self->{_in_drain};	1755	$self->_drain_rbuf;
1433	}	1756	}
1434		1757
1435	} elsif (defined $len) {	1758	} elsif (defined $len) {
1436	delete $self->{_rw};	1759	delete $self->{_rw};
1437	$self->{_eof} = 1;	1760	$self->{_eof} = 1;
1438	$self->_drain_rbuf unless $self->{_in_drain};	1761	$self->_drain_rbuf;
1439		1762
1440	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1763	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1441	return $self->_error ($!, 1);	1764	return $self->_error ($!, 1);
1442	}	1765	}
1443	});	1766	};
1444	}	1767	}
1445	}	1768	}
1446		1769
1447	our $ERROR_SYSCALL;	1770	our $ERROR_SYSCALL;
1448	our $ERROR_WANT_READ;	1771	our $ERROR_WANT_READ;
…		…
1503	$self->{_eof} = 1;	1826	$self->{_eof} = 1;
1504	}	1827	}
1505	}	1828	}
1506		1829
1507	$self->{_tls_rbuf} .= $tmp;	1830	$self->{_tls_rbuf} .= $tmp;
1508	$self->_drain_rbuf unless $self->{_in_drain};	1831	$self->_drain_rbuf;
1509	$self->{tls} or return; # tls session might have gone away in callback	1832	$self->{tls} or return; # tls session might have gone away in callback
1510	}	1833	}
1511		1834
1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1835	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1513	return $self->_tls_error ($tmp)	1836	return $self->_tls_error ($tmp)
…		…
1515	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1838	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1516		1839
1517	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1840	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1518	$self->{wbuf} .= $tmp;	1841	$self->{wbuf} .= $tmp;
1519	$self->_drain_wbuf;	1842	$self->_drain_wbuf;
		1843	$self->{tls} or return; # tls session might have gone away in callback
1520	}	1844	}
1521		1845
1522	$self->{_on_starttls}	1846	$self->{_on_starttls}
1523	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1847	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1524	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1848	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1545	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1869	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1546	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1870	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1547	changed to your liking. Note that the handshake might have already started	1871	changed to your liking. Note that the handshake might have already started
1548	when this function returns.	1872	when this function returns.
1549		1873
1550	If it an error to start a TLS handshake more than once per	1874	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1551	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1875	handshakes on the same stream. Best do not attempt to use the stream after
		1876	stopping TLS.
		1877
		1878	This method may invoke callbacks (and therefore the handle might be
		1879	destroyed after it returns).
1552		1880
1553	=cut	1881	=cut
1554		1882
1555	our %TLS_CACHE; #TODO not yet documented, should we?	1883	our %TLS_CACHE; #TODO not yet documented, should we?
1556		1884
1557	sub starttls {	1885	sub starttls {
1558	my ($self, $ssl, $ctx) = @_;	1886	my ($self, $tls, $ctx) = @_;
		1887
		1888	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1889	if $self->{tls};
		1890
		1891	$self->{tls} = $tls;
		1892	$self->{tls_ctx} = $ctx if @_ > 2;
		1893
		1894	return unless $self->{fh};
1559		1895
1560	require Net::SSLeay;	1896	require Net::SSLeay;
1561
1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1563	if $self->{tls};
1564		1897
1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1898	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1899	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1567		1900
		1901	$tls = delete $self->{tls};
1568	$ctx \|\|= $self->{tls_ctx};	1902	$ctx = $self->{tls_ctx};
1569		1903
1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1904	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1571		1905
1572	if ("HASH" eq ref $ctx) {	1906	if ("HASH" eq ref $ctx) {
1573	require AnyEvent::TLS;	1907	require AnyEvent::TLS;
…		…
1579	$ctx = new AnyEvent::TLS %$ctx;	1913	$ctx = new AnyEvent::TLS %$ctx;
1580	}	1914	}
1581	}	1915	}
1582		1916
1583	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1917	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1584	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1918	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1585		1919
1586	# basically, this is deep magic (because SSL_read should have the same issues)	1920	# basically, this is deep magic (because SSL_read should have the same issues)
1587	# but the openssl maintainers basically said: "trust us, it just works".	1921	# but the openssl maintainers basically said: "trust us, it just works".
1588	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1922	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1589	# and mismaintained ssleay-module doesn't even offer them).	1923	# and mismaintained ssleay-module doesn't even offer them).
…		…
1596	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1930	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1597	# have identity issues in that area.	1931	# have identity issues in that area.
1598	# Net::SSLeay::CTX_set_mode ($ssl,	1932	# Net::SSLeay::CTX_set_mode ($ssl,
1599	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1933	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1600	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1934	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1601	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1935	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1602		1936
1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1937	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1938	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1605		1939
		1940	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1941
1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1942	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1607		1943
1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1944	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1609	if $self->{on_starttls};	1945	if $self->{on_starttls};
1610		1946
1611	&_dotls; # need to trigger the initial handshake	1947	&_dotls; # need to trigger the initial handshake
…		…
1614		1950
1615	=item $handle->stoptls	1951	=item $handle->stoptls
1616		1952
1617	Shuts down the SSL connection - this makes a proper EOF handshake by	1953	Shuts down the SSL connection - this makes a proper EOF handshake by
1618	sending a close notify to the other side, but since OpenSSL doesn't	1954	sending a close notify to the other side, but since OpenSSL doesn't
1619	support non-blocking shut downs, it is not possible to re-use the stream	1955	support non-blocking shut downs, it is not guaranteed that you can re-use
1620	afterwards.	1956	the stream afterwards.
		1957
		1958	This method may invoke callbacks (and therefore the handle might be
		1959	destroyed after it returns).
1621		1960
1622	=cut	1961	=cut
1623		1962
1624	sub stoptls {	1963	sub stoptls {
1625	my ($self) = @_;	1964	my ($self) = @_;
1626		1965
1627	if ($self->{tls}) {	1966	if ($self->{tls} && $self->{fh}) {
1628	Net::SSLeay::shutdown ($self->{tls});	1967	Net::SSLeay::shutdown ($self->{tls});
1629		1968
1630	&_dotls;	1969	&_dotls;
1631		1970
1632	# # we don't give a shit. no, we do, but we can't. no...#d#	1971	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1638	sub _freetls {	1977	sub _freetls {
1639	my ($self) = @_;	1978	my ($self) = @_;
1640		1979
1641	return unless $self->{tls};	1980	return unless $self->{tls};
1642		1981
1643	$self->{tls_ctx}->_put_session (delete $self->{tls});	1982	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1983	if $self->{tls} > 0;
1644		1984
1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1985	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1646	}	1986	}
1647		1987
1648	sub DESTROY {	1988	sub DESTROY {
…		…
1656	my $fh = delete $self->{fh};	1996	my $fh = delete $self->{fh};
1657	my $wbuf = delete $self->{wbuf};	1997	my $wbuf = delete $self->{wbuf};
1658		1998
1659	my @linger;	1999	my @linger;
1660		2000
1661	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2001	push @linger, AE::io $fh, 1, sub {
1662	my $len = syswrite $fh, $wbuf, length $wbuf;	2002	my $len = syswrite $fh, $wbuf, length $wbuf;
1663		2003
1664	if ($len > 0) {	2004	if ($len > 0) {
1665	substr $wbuf, 0, $len, "";	2005	substr $wbuf, 0, $len, "";
1666	} else {	2006	} else {
1667	@linger = (); # end	2007	@linger = (); # end
1668	}	2008	}
1669	});	2009	};
1670	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2010	push @linger, AE::timer $linger, 0, sub {
1671	@linger = ();	2011	@linger = ();
1672	});	2012	};
1673	}	2013	}
1674	}	2014	}
1675		2015
1676	=item $handle->destroy	2016	=item $handle->destroy
1677		2017
1678	Shuts down the handle object as much as possible - this call ensures that	2018	Shuts down the handle object as much as possible - this call ensures that
1679	no further callbacks will be invoked and as many resources as possible	2019	no further callbacks will be invoked and as many resources as possible
1680	will be freed. You must not call any methods on the object afterwards.	2020	will be freed. Any method you will call on the handle object after
		2021	destroying it in this way will be silently ignored (and it will return the
		2022	empty list).
1681		2023
1682	Normally, you can just "forget" any references to an AnyEvent::Handle	2024	Normally, you can just "forget" any references to an AnyEvent::Handle
1683	object and it will simply shut down. This works in fatal error and EOF	2025	object and it will simply shut down. This works in fatal error and EOF
1684	callbacks, as well as code outside. It does I<NOT> work in a read or write	2026	callbacks, as well as code outside. It does I<NOT> work in a read or write
1685	callback, so when you want to destroy the AnyEvent::Handle object from	2027	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1699	sub destroy {	2041	sub destroy {
1700	my ($self) = @_;	2042	my ($self) = @_;
1701		2043
1702	$self->DESTROY;	2044	$self->DESTROY;
1703	%$self = ();	2045	%$self = ();
		2046	bless $self, "AnyEvent::Handle::destroyed";
1704	}	2047	}
		2048
		2049	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2050	#nop
		2051	}
		2052
		2053	=item $handle->destroyed
		2054
		2055	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2056	->destroy >>, true otherwise.
		2057
		2058	Can be useful to decide whether the handle is still valid after some
		2059	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2060	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2061	can destroy the handle, so work can be avoided by checking sometimes:
		2062
		2063	$hdl->starttls ("accept");
		2064	return if $hdl->destroyed;
		2065	$hdl->push_write (...
		2066
		2067	Note that the call to C<push_write> will silently be ignored if the handle
		2068	has been destroyed, so often you can just ignore the possibility of the
		2069	handle being destroyed.
		2070
		2071	=cut
		2072
		2073	sub destroyed { 0 }
		2074	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1705		2075
1706	=item AnyEvent::Handle::TLS_CTX	2076	=item AnyEvent::Handle::TLS_CTX
1707		2077
1708	This function creates and returns the AnyEvent::TLS object used by default	2078	This function creates and returns the AnyEvent::TLS object used by default
1709	for TLS mode.	2079	for TLS mode.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs. Revision 1.194 by root, Thu May 20 21:22:21 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.194 by root, Thu May 20 21:22:21 2010 UTC