[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.192 by root, Fri Mar 12 23:22:14 2010 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");
37		23
38	# read the response line	24	# read the response line
…		…
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::Handle 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 connection target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). At the time it is called the read and write queues, eof
		137	status, tls status and similar properties of the handle will have been
		138	reset.
		139
		140	In most cases, ignoring the C<$retry> parameter is the way to go.
		141
		142	=item on_connect_error => $cb->($handle, $message)
		143
		144	This callback is called when the connection could not be
		145	established. C<$!> will contain the relevant error code, and C<$message> a
		146	message describing it (usually the same as C<"$!">).
		147
		148	If this callback isn't specified, then C<on_error> will be called with a
		149	fatal error instead.
		150
		151	=back
		152
		153	=item on_error => $cb->($handle, $fatal, $message)
		154
		155	This is the error callback, which is called when, well, some error
		156	occured, such as not being able to resolve the hostname, failure to
		157	connect or a read error.
		158
		159	Some errors are fatal (which is indicated by C<$fatal> being true). On
		160	fatal errors the handle object will be destroyed (by a call to C<< ->
		161	destroy >>) after invoking the error callback (which means you are free to
		162	examine the handle object). Examples of fatal errors are an EOF condition
		163	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		164	cases where the other side can close the connection at their will it is
		165	often easiest to not report C<EPIPE> errors in this callback.
		166
		167	AnyEvent::Handle tries to find an appropriate error code for you to check
		168	against, but in some cases (TLS errors), this does not work well. It is
		169	recommended to always output the C<$message> argument in human-readable
		170	error messages (it's usually the same as C<"$!">).
		171
		172	Non-fatal errors can be retried by simply returning, but it is recommended
		173	to simply ignore this parameter and instead abondon the handle object
		174	when this callback is invoked. Examples of non-fatal errors are timeouts
		175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		176
		177	On callback entrance, the value of C<$!> contains the operating system
		178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
		180
		181	While not mandatory, it is I<highly> recommended to set this callback, as
		182	you will not be notified of errors otherwise. The default simply calls
		183	C<croak>.
		184
		185	=item on_read => $cb->($handle)
		186
		187	This sets the default read callback, which is called when data arrives
		188	and no read request is in the queue (unlike read queue callbacks, this
		189	callback will only be called when at least one octet of data is in the
		190	read buffer).
		191
		192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		193	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		194	must not enlarge or modify the read buffer, you can only remove data at
		195	the beginning from it.
		196
		197	When an EOF condition is detected then AnyEvent::Handle will first try to
		198	feed all the remaining data to the queued callbacks and C<on_read> before
		199	calling the C<on_eof> callback. If no progress can be made, then a fatal
		200	error will be raised (with C<$!> set to C<EPIPE>).
		201
		202	Note that, unlike requests in the read queue, an C<on_read> callback
		203	doesn't mean you I<require> some data: if there is an EOF and there
		204	are outstanding read requests then an error will be flagged. With an
		205	C<on_read> callback, the C<on_eof> callback will be invoked.
		206
81	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
82		208
83	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,
84	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
85	connection cleanly.	211	connection cleanly, and there are no outstanding read requests in the
		212	queue (if there are read requests, then an EOF counts as an unexpected
		213	connection close and will be flagged as an error).
86		214
87	For sockets, this just means that the other side has stopped sending data,	215	For sockets, this just means that the other side has stopped sending data,
88	you can still try to write data, and, in fact, one can return from the EOF	216	you can still try to write data, and, in fact, one can return from the EOF
89	callback and continue writing data, as only the read part has been shut	217	callback and continue writing data, as only the read part has been shut
90	down.	218	down.
91		219
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	220	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>.	221	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		222
146	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
147		224
148	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
149	(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).
…		…
156	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
157	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
158		235
159	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
160		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
161	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
162	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
163	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
164	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>.
165		253
166	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
167	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
168	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
169	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
…		…
213	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
214		302
215	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
216	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
217		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
218	=item read_size => <bytes>	338	=item read_size => <bytes>
219		339
220	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
221	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
222	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
255	C<undef>.	375	C<undef>.
256		376
257	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
258		378
259	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
260	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
261	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
262		382
263	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
264	appropriate error message.	384	appropriate error message.
265		385
…		…
348		468
349	sub new {	469	sub new {
350	my $class = shift;	470	my $class = shift;
351	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
352		472
353	$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) = @_;
354		536
355	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
356		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
357	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
358	$self->_timeout;
359		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
360	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
361		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
362	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
363	if $self->{tls};	553	if $self->{tls};
364		554
365	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
366		556
367	$self->start_read	557	$self->start_read
368	if $self->{on_read};	558	if $self->{on_read} \|\| @{ $self->{_queue} };
369		559
370	$self->{fh} && $self	560	$self->_drain_wbuf;
371	}	561	}
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		562
382	sub _error {	563	sub _error {
383	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
384		565
385	$! = $errno;	566	$! = $errno;
386	$message \|\|= "$!";	567	$message \|\|= "$!";
387		568
388	if ($self->{on_error}) {	569	if ($self->{on_error}) {
389	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
390	$self->destroy;	571	$self->destroy if $fatal;
391	} elsif ($self->{fh}) {	572	} elsif ($self->{fh} \|\| $self->{connect}) {
392	$self->destroy;	573	$self->destroy;
393	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
394	}	575	}
395	}	576	}
396		577
…		…
422	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
423	}	604	}
424		605
425	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
426		607
427	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
428	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
429	argument and method.
430		609
431	=cut	610	=item $handle->on_wtimeout ($cb)
432		611
433	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
434	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
435	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
436		619
437	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
438		621
439	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
440	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
455	sub no_delay {	638	sub no_delay {
456	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
457		640
458	eval {	641	eval {
459	local $SIG{__DIE__};	642	local $SIG{__DIE__};
460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		644	if $_[0]{fh};
		645	};
		646	}
		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
461	};	696	};
462	}	697	}
463		698
464	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
465		700
…		…
475		710
476	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
477		712
478	=cut	713	=cut
479		714
480	sub on_starttls {	715	sub on_stoptls {
481	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
482	}	717	}
483		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
		727	}
		728
484	#############################################################################	729	#############################################################################
485		730
486	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
487		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
488	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
489		738
490	=cut	739	=item $handle->timeout_reset
491		740
492	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
493	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
494		764
495	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
496	$self->_timeout;	766	delete $self->{$tw}; &$cb;
497	}	767	};
498		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
499	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
500	# also check for time-outs	775	# also check for time-outs
501	sub _timeout {	776	$cb = sub {
502	my ($self) = @_;	777	my ($self) = @_;
503		778
504	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
505	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
506		781
507	# when would the timeout trigger?	782	# when would the timeout trigger?
508	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
509		784
510	# now or in the past already?	785	# now or in the past already?
511	if ($after <= 0) {	786	if ($after <= 0) {
512	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
513		788
514	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
515	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
516	} else {	791	} else {
517	$self->_error (&Errno::ETIMEDOUT);	792	$self->_error (Errno::ETIMEDOUT);
		793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
518	}	800	}
519		801
520	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
521	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
522		804
523	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
524	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
525	}	811	}
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	}	812	}
537	}	813	}
538		814
539	#############################################################################	815	#############################################################################
540		816
…		…
588	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
589		865
590	if (defined $len) {	866	if (defined $len) {
591	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
592		868
593	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
594		870
595	$self->{on_drain}($self)	871	$self->{on_drain}($self)
596	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	872	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
597	&& $self->{on_drain};	873	&& $self->{on_drain};
598		874
…		…
604		880
605	# try to write data immediately	881	# try to write data immediately
606	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
607		883
608	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
609	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
610	if length $self->{wbuf};	886	if length $self->{wbuf};
611	};	887	};
612	}	888	}
613		889
614	our %WH;	890	our %WH;
615		891
		892	# deprecated
616	sub register_write_type($$) {	893	sub register_write_type($$) {
617	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
618	}	895	}
619		896
620	sub push_write {	897	sub push_write {
621	my $self = shift;	898	my $self = shift;
622		899
623	if (@_ > 1) {	900	if (@_ > 1) {
624	my $type = shift;	901	my $type = shift;
625		902
		903	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
626	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	904	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
627	->($self, @_);	905	->($self, @_);
628	}	906	}
629		907
		908	# we downgrade here to avoid hard-to-track-down bugs,
		909	# and diagnose the problem earlier and better.
		910
630	if ($self->{tls}) {	911	if ($self->{tls}) {
631	$self->{_tls_wbuf} .= $_[0];	912	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
632		913	&_dotls ($self) if $self->{fh};
633	&_dotls ($self);
634	} else {	914	} else {
635	$self->{wbuf} .= $_[0];	915	utf8::downgrade $self->{wbuf} .= $_[0];
636	$self->_drain_wbuf;	916	$self->_drain_wbuf if $self->{fh};
637	}	917	}
638	}	918	}
639		919
640	=item $handle->push_write (type => @args)	920	=item $handle->push_write (type => @args)
641		921
642	Instead of formatting your data yourself, you can also let this module do	922	Instead of formatting your data yourself, you can also let this module
643	the job by specifying a type and type-specific arguments.	923	do the job by specifying a type and type-specific arguments. You
		924	can also specify the (fully qualified) name of a package, in which
		925	case AnyEvent tries to load the package and then expects to find the
		926	C<anyevent_read_type> function inside (see "custom write types", below).
644		927
645	Predefined types are (if you have ideas for additional types, feel free to	928	Predefined types are (if you have ideas for additional types, feel free to
646	drop by and tell us):	929	drop by and tell us):
647		930
648	=over 4	931	=over 4
…		…
705	Other languages could read single lines terminated by a newline and pass	988	Other languages could read single lines terminated by a newline and pass
706	this line into their JSON decoder of choice.	989	this line into their JSON decoder of choice.
707		990
708	=cut	991	=cut
709		992
		993	sub json_coder() {
		994	eval { require JSON::XS; JSON::XS->new->utf8 }
		995	\|\| do { require JSON; JSON->new->utf8 }
		996	}
		997
710	register_write_type json => sub {	998	register_write_type json => sub {
711	my ($self, $ref) = @_;	999	my ($self, $ref) = @_;
712		1000
713	require JSON;	1001	my $json = $self->{json} \|\|= json_coder;
714		1002
715	$self->{json} ? $self->{json}->encode ($ref)	1003	$json->encode ($ref)
716	: JSON::encode_json ($ref)
717	};	1004	};
718		1005
719	=item storable => $reference	1006	=item storable => $reference
720		1007
721	Freezes the given reference using L<Storable> and writes it to the	1008	Freezes the given reference using L<Storable> and writes it to the
…		…
756		1043
757	delete $self->{low_water_mark};	1044	delete $self->{low_water_mark};
758	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1045	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
759	}	1046	}
760		1047
761	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1048	=item custom write types - Package::anyevent_write_type $handle, @args
762		1049
763	This function (not method) lets you add your own types to C<push_write>.	1050	Instead of one of the predefined types, you can also specify the name of
		1051	a package. AnyEvent will try to load the package and then expects to find
		1052	a function named C<anyevent_write_type> inside. If it isn't found, it
		1053	progressively tries to load the parent package until it either finds the
		1054	function (good) or runs out of packages (bad).
		1055
764	Whenever the given C<type> is used, C<push_write> will invoke the code	1056	Whenever the given C<type> is used, C<push_write> will the function with
765	reference with the handle object and the remaining arguments.	1057	the handle object and the remaining arguments.
766		1058
767	The code reference is supposed to return a single octet string that will	1059	The function is supposed to return a single octet string that will be
768	be appended to the write buffer.	1060	appended to the write buffer, so you cna mentally treat this function as a
		1061	"arguments to on-the-wire-format" converter.
769		1062
770	Note that this is a function, and all types registered this way will be	1063	Example: implement a custom write type C<join> that joins the remaining
771	global, so try to use unique names.	1064	arguments using the first one.
		1065
		1066	$handle->push_write (My::Type => " ", 1,2,3);
		1067
		1068	# uses the following package, which can be defined in the "My::Type" or in
		1069	# the "My" modules to be auto-loaded, or just about anywhere when the
		1070	# My::Type::anyevent_write_type is defined before invoking it.
		1071
		1072	package My::Type;
		1073
		1074	sub anyevent_write_type {
		1075	my ($handle, $delim, @args) = @_;
		1076
		1077	join $delim, @args
		1078	}
772		1079
773	=cut	1080	=cut
774		1081
775	#############################################################################	1082	#############################################################################
776		1083
…		…
858	=cut	1165	=cut
859		1166
860	sub _drain_rbuf {	1167	sub _drain_rbuf {
861	my ($self) = @_;	1168	my ($self) = @_;
862		1169
		1170	# avoid recursion
		1171	return if $self->{_skip_drain_rbuf};
863	local $self->{_in_drain} = 1;	1172	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		1173
872	while () {	1174	while () {
873	# we need to use a separate tls read buffer, as we must not receive data while	1175	# 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.	1176	# we are draining the buffer, and this can only happen with TLS.
875	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1177	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1178	if exists $self->{_tls_rbuf};
876		1179
877	my $len = length $self->{rbuf};	1180	my $len = length $self->{rbuf};
878		1181
879	if (my $cb = shift @{ $self->{_queue} }) {	1182	if (my $cb = shift @{ $self->{_queue} }) {
880	unless ($cb->($self)) {	1183	unless ($cb->($self)) {
881	if ($self->{_eof}) {	1184	# no progress can be made
882	# no progress can be made (not enough data and no data forthcoming)	1185	# (not enough data and no data forthcoming)
883	$self->_error (&Errno::EPIPE, 1), return;	1186	$self->_error (Errno::EPIPE, 1), return
884	}	1187	if $self->{_eof};
885		1188
886	unshift @{ $self->{_queue} }, $cb;	1189	unshift @{ $self->{_queue} }, $cb;
887	last;	1190	last;
888	}	1191	}
889	} elsif ($self->{on_read}) {	1192	} elsif ($self->{on_read}) {
…		…
896	&& !@{ $self->{_queue} } # and the queue is still empty	1199	&& !@{ $self->{_queue} } # and the queue is still empty
897	&& $self->{on_read} # but we still have on_read	1200	&& $self->{on_read} # but we still have on_read
898	) {	1201	) {
899	# no further data will arrive	1202	# no further data will arrive
900	# so no progress can be made	1203	# so no progress can be made
901	$self->_error (&Errno::EPIPE, 1), return	1204	$self->_error (Errno::EPIPE, 1), return
902	if $self->{_eof};	1205	if $self->{_eof};
903		1206
904	last; # more data might arrive	1207	last; # more data might arrive
905	}	1208	}
906	} else {	1209	} else {
…		…
909	last;	1212	last;
910	}	1213	}
911	}	1214	}
912		1215
913	if ($self->{_eof}) {	1216	if ($self->{_eof}) {
914	if ($self->{on_eof}) {	1217	$self->{on_eof}
915	$self->{on_eof}($self)	1218	? $self->{on_eof}($self)
916	} else {
917	$self->_error (0, 1, "Unexpected end-of-file");	1219	: $self->_error (0, 1, "Unexpected end-of-file");
918	}	1220
		1221	return;
		1222	}
		1223
		1224	if (
		1225	defined $self->{rbuf_max}
		1226	&& $self->{rbuf_max} < length $self->{rbuf}
		1227	) {
		1228	$self->_error (Errno::ENOSPC, 1), return;
919	}	1229	}
920		1230
921	# may need to restart read watcher	1231	# may need to restart read watcher
922	unless ($self->{_rw}) {	1232	unless ($self->{_rw}) {
923	$self->start_read	1233	$self->start_read
…		…
935		1245
936	sub on_read {	1246	sub on_read {
937	my ($self, $cb) = @_;	1247	my ($self, $cb) = @_;
938		1248
939	$self->{on_read} = $cb;	1249	$self->{on_read} = $cb;
940	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1250	$self->_drain_rbuf if $cb;
941	}	1251	}
942		1252
943	=item $handle->rbuf	1253	=item $handle->rbuf
944		1254
945	Returns the read buffer (as a modifiable lvalue).	1255	Returns the read buffer (as a modifiable lvalue).
…		…
992	my $cb = pop;	1302	my $cb = pop;
993		1303
994	if (@_) {	1304	if (@_) {
995	my $type = shift;	1305	my $type = shift;
996		1306
		1307	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
997	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1308	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
998	->($self, $cb, @_);	1309	->($self, $cb, @_);
999	}	1310	}
1000		1311
1001	push @{ $self->{_queue} }, $cb;	1312	push @{ $self->{_queue} }, $cb;
1002	$self->_drain_rbuf unless $self->{_in_drain};	1313	$self->_drain_rbuf;
1003	}	1314	}
1004		1315
1005	sub unshift_read {	1316	sub unshift_read {
1006	my $self = shift;	1317	my $self = shift;
1007	my $cb = pop;	1318	my $cb = pop;
…		…
1011		1322
1012	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1323	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1013	->($self, $cb, @_);	1324	->($self, $cb, @_);
1014	}	1325	}
1015		1326
1016
1017	unshift @{ $self->{_queue} }, $cb;	1327	unshift @{ $self->{_queue} }, $cb;
1018	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf;
1019	}	1329	}
1020		1330
1021	=item $handle->push_read (type => @args, $cb)	1331	=item $handle->push_read (type => @args, $cb)
1022		1332
1023	=item $handle->unshift_read (type => @args, $cb)	1333	=item $handle->unshift_read (type => @args, $cb)
1024		1334
1025	Instead of providing a callback that parses the data itself you can chose	1335	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	1336	between a number of predefined parsing formats, for chunks of data, lines
1027	etc.	1337	etc. You can also specify the (fully qualified) name of a package, in
		1338	which case AnyEvent tries to load the package and then expects to find the
		1339	C<anyevent_read_type> function inside (see "custom read types", below).
1028		1340
1029	Predefined types are (if you have ideas for additional types, feel free to	1341	Predefined types are (if you have ideas for additional types, feel free to
1030	drop by and tell us):	1342	drop by and tell us):
1031		1343
1032	=over 4	1344	=over 4
…		…
1156	return 1;	1468	return 1;
1157	}	1469	}
1158		1470
1159	# reject	1471	# reject
1160	if ($reject && $$rbuf =~ $reject) {	1472	if ($reject && $$rbuf =~ $reject) {
1161	$self->_error (&Errno::EBADMSG);	1473	$self->_error (Errno::EBADMSG);
1162	}	1474	}
1163		1475
1164	# skip	1476	# skip
1165	if ($skip && $$rbuf =~ $skip) {	1477	if ($skip && $$rbuf =~ $skip) {
1166	$data .= substr $$rbuf, 0, $+[0], "";	1478	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1182	my ($self, $cb) = @_;	1494	my ($self, $cb) = @_;
1183		1495
1184	sub {	1496	sub {
1185	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1497	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1186	if ($_[0]{rbuf} =~ /[^0-9]/) {	1498	if ($_[0]{rbuf} =~ /[^0-9]/) {
1187	$self->_error (&Errno::EBADMSG);	1499	$self->_error (Errno::EBADMSG);
1188	}	1500	}
1189	return;	1501	return;
1190	}	1502	}
1191		1503
1192	my $len = $1;	1504	my $len = $1;
…		…
1195	my $string = $_[1];	1507	my $string = $_[1];
1196	$_[0]->unshift_read (chunk => 1, sub {	1508	$_[0]->unshift_read (chunk => 1, sub {
1197	if ($_[1] eq ",") {	1509	if ($_[1] eq ",") {
1198	$cb->($_[0], $string);	1510	$cb->($_[0], $string);
1199	} else {	1511	} else {
1200	$self->_error (&Errno::EBADMSG);	1512	$self->_error (Errno::EBADMSG);
1201	}	1513	}
1202	});	1514	});
1203	});	1515	});
1204		1516
1205	1	1517	1
…		…
1272	=cut	1584	=cut
1273		1585
1274	register_read_type json => sub {	1586	register_read_type json => sub {
1275	my ($self, $cb) = @_;	1587	my ($self, $cb) = @_;
1276		1588
1277	my $json = $self->{json} \|\|=	1589	my $json = $self->{json} \|\|= json_coder;
1278	eval { require JSON::XS; JSON::XS->new->utf8 }
1279	\|\| do { require JSON; JSON->new->utf8 };
1280		1590
1281	my $data;	1591	my $data;
1282	my $rbuf = \$self->{rbuf};	1592	my $rbuf = \$self->{rbuf};
1283		1593
1284	sub {	1594	sub {
…		…
1295	$json->incr_skip;	1605	$json->incr_skip;
1296		1606
1297	$self->{rbuf} = $json->incr_text;	1607	$self->{rbuf} = $json->incr_text;
1298	$json->incr_text = "";	1608	$json->incr_text = "";
1299		1609
1300	$self->_error (&Errno::EBADMSG);	1610	$self->_error (Errno::EBADMSG);
1301		1611
1302	()	1612	()
1303	} else {	1613	} else {
1304	$self->{rbuf} = "";	1614	$self->{rbuf} = "";
1305		1615
…		…
1342	# read remaining chunk	1652	# read remaining chunk
1343	$_[0]->unshift_read (chunk => $len, sub {	1653	$_[0]->unshift_read (chunk => $len, sub {
1344	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1654	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1345	$cb->($_[0], $ref);	1655	$cb->($_[0], $ref);
1346	} else {	1656	} else {
1347	$self->_error (&Errno::EBADMSG);	1657	$self->_error (Errno::EBADMSG);
1348	}	1658	}
1349	});	1659	});
1350	}	1660	}
1351		1661
1352	1	1662	1
1353	}	1663	}
1354	};	1664	};
1355		1665
1356	=back	1666	=back
1357		1667
1358	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1668	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1359		1669
1360	This function (not method) lets you add your own types to C<push_read>.	1670	Instead of one of the predefined types, you can also specify the name
		1671	of a package. AnyEvent will try to load the package and then expects to
		1672	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1673	progressively tries to load the parent package until it either finds the
		1674	function (good) or runs out of packages (bad).
1361		1675
1362	Whenever the given C<type> is used, C<push_read> will invoke the code	1676	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	1677	handle object, the original callback and the remaining arguments.
1364	arguments.
1365		1678
1366	The code reference is supposed to return a callback (usually a closure)	1679	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) >>).	1680	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1681	mentally treat the function as a "configurable read type to read callback"
		1682	converter.
1368		1683
1369	It should invoke the passed callback when it is done reading (remember to	1684	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).	1685	to pass C<$handle> as first argument as all other callbacks do that,
		1686	although there is no strict requirement on this).
1371		1687
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>,	1688	For examples, see the source of this module (F<perldoc -m
1376	search for C<register_read_type>)).	1689	AnyEvent::Handle>, search for C<register_read_type>)).
1377		1690
1378	=item $handle->stop_read	1691	=item $handle->stop_read
1379		1692
1380	=item $handle->start_read	1693	=item $handle->start_read
1381		1694
…		…
1401	}	1714	}
1402		1715
1403	sub start_read {	1716	sub start_read {
1404	my ($self) = @_;	1717	my ($self) = @_;
1405		1718
1406	unless ($self->{_rw} \|\| $self->{_eof}) {	1719	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1407	Scalar::Util::weaken $self;	1720	Scalar::Util::weaken $self;
1408		1721
1409	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1722	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1410	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1723	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1411	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1724	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1412		1725
1413	if ($len > 0) {	1726	if ($len > 0) {
1414	$self->{_activity} = AnyEvent->now;	1727	$self->{_activity} = $self->{_ractivity} = AE::now;
1415		1728
1416	if ($self->{tls}) {	1729	if ($self->{tls}) {
1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1730	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1418		1731
1419	&_dotls ($self);	1732	&_dotls ($self);
1420	} else {	1733	} else {
1421	$self->_drain_rbuf unless $self->{_in_drain};	1734	$self->_drain_rbuf;
1422	}	1735	}
1423		1736
1424	} elsif (defined $len) {	1737	} elsif (defined $len) {
1425	delete $self->{_rw};	1738	delete $self->{_rw};
1426	$self->{_eof} = 1;	1739	$self->{_eof} = 1;
1427	$self->_drain_rbuf unless $self->{_in_drain};	1740	$self->_drain_rbuf;
1428		1741
1429	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1742	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1430	return $self->_error ($!, 1);	1743	return $self->_error ($!, 1);
1431	}	1744	}
1432	});	1745	};
1433	}	1746	}
1434	}	1747	}
1435		1748
1436	our $ERROR_SYSCALL;	1749	our $ERROR_SYSCALL;
1437	our $ERROR_WANT_READ;	1750	our $ERROR_WANT_READ;
…		…
1450	if ($self->{_on_starttls}) {	1763	if ($self->{_on_starttls}) {
1451	(delete $self->{_on_starttls})->($self, undef, $err);	1764	(delete $self->{_on_starttls})->($self, undef, $err);
1452	&_freetls;	1765	&_freetls;
1453	} else {	1766	} else {
1454	&_freetls;	1767	&_freetls;
1455	$self->_error (&Errno::EPROTO, 1, $err);	1768	$self->_error (Errno::EPROTO, 1, $err);
1456	}	1769	}
1457	}	1770	}
1458		1771
1459	# poll the write BIO and send the data if applicable	1772	# poll the write BIO and send the data if applicable
1460	# also decode read data if possible	1773	# also decode read data if possible
…		…
1492	$self->{_eof} = 1;	1805	$self->{_eof} = 1;
1493	}	1806	}
1494	}	1807	}
1495		1808
1496	$self->{_tls_rbuf} .= $tmp;	1809	$self->{_tls_rbuf} .= $tmp;
1497	$self->_drain_rbuf unless $self->{_in_drain};	1810	$self->_drain_rbuf;
1498	$self->{tls} or return; # tls session might have gone away in callback	1811	$self->{tls} or return; # tls session might have gone away in callback
1499	}	1812	}
1500		1813
1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1814	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1502	return $self->_tls_error ($tmp)	1815	return $self->_tls_error ($tmp)
…		…
1504	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1817	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1505		1818
1506	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1819	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1507	$self->{wbuf} .= $tmp;	1820	$self->{wbuf} .= $tmp;
1508	$self->_drain_wbuf;	1821	$self->_drain_wbuf;
		1822	$self->{tls} or return; # tls session might have gone away in callback
1509	}	1823	}
1510		1824
1511	$self->{_on_starttls}	1825	$self->{_on_starttls}
1512	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1826	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1513	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1827	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1516	=item $handle->starttls ($tls[, $tls_ctx])	1830	=item $handle->starttls ($tls[, $tls_ctx])
1517		1831
1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1832	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	1833	object is created, you can also do that at a later time by calling
1520	C<starttls>.	1834	C<starttls>.
		1835
		1836	Starting TLS is currently an asynchronous operation - when you push some
		1837	write data and then call C<< ->starttls >> then TLS negotiation will start
		1838	immediately, after which the queued write data is then sent.
1521		1839
1522	The first argument is the same as the C<tls> constructor argument (either	1840	The first argument is the same as the C<tls> constructor argument (either
1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1841	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1524		1842
1525	The second argument is the optional C<AnyEvent::TLS> object that is used	1843	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1530	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1848	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	1849	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	1850	changed to your liking. Note that the handshake might have already started
1533	when this function returns.	1851	when this function returns.
1534		1852
1535	If it an error to start a TLS handshake more than once per	1853	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).	1854	handshakes on the same stream. Best do not attempt to use the stream after
		1855	stopping TLS.
1537		1856
1538	=cut	1857	=cut
1539		1858
1540	our %TLS_CACHE; #TODO not yet documented, should we?	1859	our %TLS_CACHE; #TODO not yet documented, should we?
1541		1860
1542	sub starttls {	1861	sub starttls {
1543	my ($self, $ssl, $ctx) = @_;	1862	my ($self, $tls, $ctx) = @_;
		1863
		1864	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1865	if $self->{tls};
		1866
		1867	$self->{tls} = $tls;
		1868	$self->{tls_ctx} = $ctx if @_ > 2;
		1869
		1870	return unless $self->{fh};
1544		1871
1545	require Net::SSLeay;	1872	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		1873
1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1874	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1875	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1552		1876
		1877	$tls = delete $self->{tls};
1553	$ctx \|\|= $self->{tls_ctx};	1878	$ctx = $self->{tls_ctx};
		1879
		1880	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1554		1881
1555	if ("HASH" eq ref $ctx) {	1882	if ("HASH" eq ref $ctx) {
1556	require AnyEvent::TLS;	1883	require AnyEvent::TLS;
1557
1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1559		1884
1560	if ($ctx->{cache}) {	1885	if ($ctx->{cache}) {
1561	my $key = $ctx+0;	1886	my $key = $ctx+0;
1562	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1887	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1563	} else {	1888	} else {
1564	$ctx = new AnyEvent::TLS %$ctx;	1889	$ctx = new AnyEvent::TLS %$ctx;
1565	}	1890	}
1566	}	1891	}
1567		1892
1568	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1893	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1894	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1570		1895
1571	# basically, this is deep magic (because SSL_read should have the same issues)	1896	# 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".	1897	# but the openssl maintainers basically said: "trust us, it just works".
1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1898	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1574	# and mismaintained ssleay-module doesn't even offer them).	1899	# 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	1906	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1582	# have identity issues in that area.	1907	# have identity issues in that area.
1583	# Net::SSLeay::CTX_set_mode ($ssl,	1908	# Net::SSLeay::CTX_set_mode ($ssl,
1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1909	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1585	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1910	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1586	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1911	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1587		1912
1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1913	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1914	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1590		1915
		1916	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1917
1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1918	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1592		1919
1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1920	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1594	if $self->{on_starttls};	1921	if $self->{on_starttls};
1595		1922
1596	&_dotls; # need to trigger the initial handshake	1923	&_dotls; # need to trigger the initial handshake
…		…
1599		1926
1600	=item $handle->stoptls	1927	=item $handle->stoptls
1601		1928
1602	Shuts down the SSL connection - this makes a proper EOF handshake by	1929	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	1930	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	1931	support non-blocking shut downs, it is not guaranteed that you can re-use
1605	afterwards.	1932	the stream afterwards.
1606		1933
1607	=cut	1934	=cut
1608		1935
1609	sub stoptls {	1936	sub stoptls {
1610	my ($self) = @_;	1937	my ($self) = @_;
1611		1938
1612	if ($self->{tls}) {	1939	if ($self->{tls} && $self->{fh}) {
1613	Net::SSLeay::shutdown ($self->{tls});	1940	Net::SSLeay::shutdown ($self->{tls});
1614		1941
1615	&_dotls;	1942	&_dotls;
1616		1943
1617	# # we don't give a shit. no, we do, but we can't. no...#d#	1944	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1623	sub _freetls {	1950	sub _freetls {
1624	my ($self) = @_;	1951	my ($self) = @_;
1625		1952
1626	return unless $self->{tls};	1953	return unless $self->{tls};
1627		1954
1628	$self->{tls_ctx}->_put_session (delete $self->{tls});	1955	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1956	if $self->{tls} > 0;
1629		1957
1630	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1958	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1631	}	1959	}
1632		1960
1633	sub DESTROY {	1961	sub DESTROY {
…		…
1635		1963
1636	&_freetls;	1964	&_freetls;
1637		1965
1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1966	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1639		1967
1640	if ($linger && length $self->{wbuf}) {	1968	if ($linger && length $self->{wbuf} && $self->{fh}) {
1641	my $fh = delete $self->{fh};	1969	my $fh = delete $self->{fh};
1642	my $wbuf = delete $self->{wbuf};	1970	my $wbuf = delete $self->{wbuf};
1643		1971
1644	my @linger;	1972	my @linger;
1645		1973
1646	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1974	push @linger, AE::io $fh, 1, sub {
1647	my $len = syswrite $fh, $wbuf, length $wbuf;	1975	my $len = syswrite $fh, $wbuf, length $wbuf;
1648		1976
1649	if ($len > 0) {	1977	if ($len > 0) {
1650	substr $wbuf, 0, $len, "";	1978	substr $wbuf, 0, $len, "";
1651	} else {	1979	} else {
1652	@linger = (); # end	1980	@linger = (); # end
1653	}	1981	}
1654	});	1982	};
1655	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1983	push @linger, AE::timer $linger, 0, sub {
1656	@linger = ();	1984	@linger = ();
1657	});	1985	};
1658	}	1986	}
1659	}	1987	}
1660		1988
1661	=item $handle->destroy	1989	=item $handle->destroy
1662		1990
1663	Shuts down the handle object as much as possible - this call ensures that	1991	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	1992	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.	1993	will be freed. Any method you will call on the handle object after
		1994	destroying it in this way will be silently ignored (and it will return the
		1995	empty list).
1666		1996
1667	Normally, you can just "forget" any references to an AnyEvent::Handle	1997	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	1998	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	1999	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	2000	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1684	sub destroy {	2014	sub destroy {
1685	my ($self) = @_;	2015	my ($self) = @_;
1686		2016
1687	$self->DESTROY;	2017	$self->DESTROY;
1688	%$self = ();	2018	%$self = ();
		2019	bless $self, "AnyEvent::Handle::destroyed";
1689	}	2020	}
		2021
		2022	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2023	#nop
		2024	}
		2025
		2026	=item $handle->destroyed
		2027
		2028	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2029	->destroy >>, true otherwise.
		2030
		2031	Can be useful to decide whether the handle is still valid after some
		2032	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2033	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2034	can destroy the handle, so work can be avoided by checking sometimes:
		2035
		2036	$hdl->starttls ("accept");
		2037	return if $hdl->destroyed;
		2038	$hdl->push_write (...
		2039
		2040	Note that the call to C<push_write> will silently be ignored if the handle
		2041	has been destroyed, so often you can just ignore the possibility of the
		2042	handle being destroyed.
		2043
		2044	=cut
		2045
		2046	sub destroyed { 0 }
		2047	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1690		2048
1691	=item AnyEvent::Handle::TLS_CTX	2049	=item AnyEvent::Handle::TLS_CTX
1692		2050
1693	This function creates and returns the AnyEvent::TLS object used by default	2051	This function creates and returns the AnyEvent::TLS object used by default
1694	for TLS mode.	2052	for TLS mode.

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.192 by root, Fri Mar 12 23:22:14 2010 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.192 by root, Fri Mar 12 23:22:14 2010 UTC