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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs. Revision 1.185 by root, Thu Sep 3 19:48:27 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.185 by root, Thu Sep 3 19:48:27 2009 UTC