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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.63 by root, Fri Jun 6 11:00:32 2008 UTC vs.
Revision 1.142 by root, Mon Jul 6 20:24:47 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.14;	19	our $VERSION = 4.452;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
60		63
61	=head1 METHODS	64	=head1 METHODS
62		65
63	=over 4	66	=over 4
64		67
65	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		69
67	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
68		71
69	=over 4	72	=over 4
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detcted,	84	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the EOF
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
85	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
86	waiting for data.	95	waiting for data.
87		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal, $message)
89		101
90	This is the error callback, which is called when, well, some error	102	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
		112	AnyEvent::Handle tries to find an appropriate error code for you to check
		113	against, but in some cases (TLS errors), this does not work well. It is
		114	recommended to always output the C<$message> argument in human-readable
		115	error messages (it's usually the same as C<"$!">).
		116
96	usable. Non-fatal errors can be retried by simply returning, but it is	117	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	118	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	119	when this callback is invoked. Examples of non-fatal errors are timeouts
		120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		121
100	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		124	C<EPROTO>).
102		125
103	While not mandatory, it is I<highly> recommended to set this callback, as	126	While not mandatory, it is I<highly> recommended to set this callback, as
104	you will not be notified of errors otherwise. The default simply calls	127	you will not be notified of errors otherwise. The default simply calls
105	C<croak>.	128	C<croak>.
106		129
…		…
110	and no read request is in the queue (unlike read queue callbacks, this	133	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	134	callback will only be called when at least one octet of data is in the
112	read buffer).	135	read buffer).
113		136
114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
115	method or access the C<$handle->{rbuf}> member directly.	138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		139	must not enlarge or modify the read buffer, you can only remove data at
		140	the beginning from it.
116		141
117	When an EOF condition is detected then AnyEvent::Handle will first try to	142	When an EOF condition is detected then AnyEvent::Handle will first try to
118	feed all the remaining data to the queued callbacks and C<on_read> before	143	feed all the remaining data to the queued callbacks and C<on_read> before
119	calling the C<on_eof> callback. If no progress can be made, then a fatal	144	calling the C<on_eof> callback. If no progress can be made, then a fatal
120	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
124	This sets the callback that is called when the write buffer becomes empty	149	This sets the callback that is called when the write buffer becomes empty
125	(or when the callback is set and the buffer is empty already).	150	(or when the callback is set and the buffer is empty already).
126		151
127	To append to the write buffer, use the C<< ->push_write >> method.	152	To append to the write buffer, use the C<< ->push_write >> method.
128		153
		154	This callback is useful when you don't want to put all of your write data
		155	into the queue at once, for example, when you want to write the contents
		156	of some file to the socket you might not want to read the whole file into
		157	memory and push it into the queue, but instead only read more data from
		158	the file when the write queue becomes empty.
		159
129	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
130		161
131	If non-zero, then this enables an "inactivity" timeout: whenever this many	162	If non-zero, then this enables an "inactivity" timeout: whenever this many
132	seconds pass without a successful read or write on the underlying file	163	seconds pass without a successful read or write on the underlying file
133	handle, the C<on_timeout> callback will be invoked (and if that one is	164	handle, the C<on_timeout> callback will be invoked (and if that one is
134	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		166
136	Note that timeout processing is also active when you currently do not have	167	Note that timeout processing is also active when you currently do not have
137	any outstanding read or write requests: If you plan to keep the connection	168	any outstanding read or write requests: If you plan to keep the connection
138	idle then you should disable the timout temporarily or ignore the timeout	169	idle then you should disable the timout temporarily or ignore the timeout
139	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
140		172
141	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
142		174
143	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
144		176
…		…
148		180
149	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
150		182
151	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	183	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
152	when the read buffer ever (strictly) exceeds this size. This is useful to	184	when the read buffer ever (strictly) exceeds this size. This is useful to
153	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
154		186
155	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
156	be configured to accept only so-and-so much data that it cannot act on	188	be configured to accept only so-and-so much data that it cannot act on
157	(for example, when expecting a line, an attacker could send an unlimited	189	(for example, when expecting a line, an attacker could send an unlimited
158	amount of data without a callback ever being called as long as the line	190	amount of data without a callback ever being called as long as the line
159	isn't finished).	191	isn't finished).
160		192
		193	=item autocork => <boolean>
		194
		195	When disabled (the default), then C<push_write> will try to immediately
		196	write the data to the handle, if possible. This avoids having to register
		197	a write watcher and wait for the next event loop iteration, but can
		198	be inefficient if you write multiple small chunks (on the wire, this
		199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
		201
		202	When enabled, then writes will always be queued till the next event loop
		203	iteration. This is efficient when you do many small writes per iteration,
		204	but less efficient when you do a single write only per iteration (or when
		205	the write buffer often is full). It also increases write latency.
		206
		207	=item no_delay => <boolean>
		208
		209	When doing small writes on sockets, your operating system kernel might
		210	wait a bit for more data before actually sending it out. This is called
		211	the Nagle algorithm, and usually it is beneficial.
		212
		213	In some situations you want as low a delay as possible, which can be
		214	accomplishd by setting this option to a true value.
		215
		216	The default is your opertaing system's default behaviour (most likely
		217	enabled), this option explicitly enables or disables it, if possible.
		218
161	=item read_size => <bytes>	219	=item read_size => <bytes>
162		220
163	The default read block size (the amount of bytes this module will try to read	221	The default read block size (the amount of bytes this module will
164	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
165		224
166	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
167		226
168	Sets the amount of bytes (default: C<0>) that make up an "empty" write	227	Sets the amount of bytes (default: C<0>) that make up an "empty" write
169	buffer: If the write reaches this size or gets even samller it is	228	buffer: If the write reaches this size or gets even samller it is
170	considered empty.	229	considered empty.
171		230
		231	Sometimes it can be beneficial (for performance reasons) to add data to
		232	the write buffer before it is fully drained, but this is a rare case, as
		233	the operating system kernel usually buffers data as well, so the default
		234	is good in almost all cases.
		235
172	=item linger => <seconds>	236	=item linger => <seconds>
173		237
174	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	239	AnyEvent::Handle object will check whether there is still outstanding
176	data and will install a watcher that will write out this data. No errors	240	write data and will install a watcher that will write this data to the
177	will be reported (this mostly matches how the operating system treats	241	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
179		243
180	This will not work for partial TLS data that could not yet been	244	This will not work for partial TLS data that could not be encoded
181	encoded. This data will be lost.	245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
		247
		248	=item peername => $string
		249
		250	A string used to identify the remote site - usually the DNS hostname
		251	(I<not> IDN!) used to create the connection, rarely the IP address.
		252
		253	Apart from being useful in error messages, this string is also used in TLS
		254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).
182		255
183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
184		257
185	When this parameter is given, it enables TLS (SSL) mode, that means it	258	When this parameter is given, it enables TLS (SSL) mode, that means
186	will start making tls handshake and will transparently encrypt/decrypt	259	AnyEvent will start a TLS handshake as soon as the conenction has been
187	data.	260	established and will transparently encrypt/decrypt data afterwards.
		261
		262	All TLS protocol errors will be signalled as C<EPROTO>, with an
		263	appropriate error message.
188		264
189	TLS mode requires Net::SSLeay to be installed (it will be loaded	265	TLS mode requires Net::SSLeay to be installed (it will be loaded
190	automatically when you try to create a TLS handle).	266	automatically when you try to create a TLS handle): this module doesn't
		267	have a dependency on that module, so if your module requires it, you have
		268	to add the dependency yourself.
191		269
192	For the TLS server side, use C<accept>, and for the TLS client side of a	270	Unlike TCP, TLS has a server and client side: for the TLS server side, use
193	connection, use C<connect> mode.	271	C<accept>, and for the TLS client side of a connection, use C<connect>
		272	mode.
194		273
195	You can also provide your own TLS connection object, but you have	274	You can also provide your own TLS connection object, but you have
196	to make sure that you call either C<Net::SSLeay::set_connect_state>	275	to make sure that you call either C<Net::SSLeay::set_connect_state>
197	or C<Net::SSLeay::set_accept_state> on it before you pass it to	276	or C<Net::SSLeay::set_accept_state> on it before you pass it to
198	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
199		279
		280	At some future point, AnyEvent::Handle might switch to another TLS
		281	implementation, then the option to use your own session object will go
		282	away.
		283
		284	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		285	passing in the wrong integer will lead to certain crash. This most often
		286	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		287	segmentation fault.
		288
200	See the C<starttls> method if you need to start TLs negotiation later.	289	See the C<< ->starttls >> method for when need to start TLS negotiation later.
201		290
202	=item tls_ctx => $ssl_ctx	291	=item tls_ctx => $anyevent_tls
203		292
204	Use the given Net::SSLeay::CTX object to create the new TLS connection	293	Use the given C<AnyEvent::TLS> object to create the new TLS connection
205	(unless a connection object was specified directly). If this parameter is	294	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		296
		297	Instead of an object, you can also specify a hash reference with C<< key
		298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		299	new TLS context object.
		300
		301	=item on_starttls => $cb->($handle, $success)
		302
		303	This callback will be invoked when the TLS/SSL handshake has finished. If
		304	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		305	(C<on_stoptls> will not be called in this case).
		306
		307	The session in C<< $handle->{tls} >> can still be examined in this
		308	callback, even when the handshake was not successful.
		309
		310	=item on_stoptls => $cb->($handle)
		311
		312	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		313	set, then it will be invoked after freeing the TLS session. If it is not,
		314	then a TLS shutdown condition will be treated like a normal EOF condition
		315	on the handle.
		316
		317	The session in C<< $handle->{tls} >> can still be examined in this
		318	callback.
		319
		320	This callback will only be called on TLS shutdowns, not when the
		321	underlying handle signals EOF.
		322
208	=item json => JSON or JSON::XS object	323	=item json => JSON or JSON::XS object
209		324
210	This is the json coder object used by the C<json> read and write types.	325	This is the json coder object used by the C<json> read and write types.
211		326
212	If you don't supply it, then AnyEvent::Handle will create and use a	327	If you don't supply it, then AnyEvent::Handle will create and use a
213	suitable one, which will write and expect UTF-8 encoded JSON texts.	328	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		329	texts.
214		330
215	Note that you are responsible to depend on the JSON module if you want to	331	Note that you are responsible to depend on the JSON module if you want to
216	use this functionality, as AnyEvent does not have a dependency itself.	332	use this functionality, as AnyEvent does not have a dependency itself.
217		333
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223
224	=back	334	=back
225		335
226	=cut	336	=cut
227		337
228	sub new {	338	sub new {
229	my $class = shift;	339	my $class = shift;
230
231	my $self = bless { @_ }, $class;	340	my $self = bless { @_ }, $class;
232		341
233	$self->{fh} or Carp::croak "mandatory argument fh is missing";	342	$self->{fh} or Carp::croak "mandatory argument fh is missing";
234		343
235	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	344	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
236
237	if ($self->{tls}) {
238	require Net::SSLeay;
239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
240	}
241		345
242	$self->{_activity} = AnyEvent->now;	346	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;	347	$self->_timeout;
244		348
		349	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		350
		351	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		352	if $self->{tls};
		353
245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	354	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
246		355
247	$self	356	$self->start_read
		357	if $self->{on_read};
		358
		359	$self->{fh} && $self
248	}	360	}
249		361
250	sub _shutdown {	362	sub _shutdown {
251	my ($self) = @_;	363	my ($self) = @_;
252		364
253	delete $self->{_tw};	365	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
254	delete $self->{_rw};	366	$self->{_eof} = 1; # tell starttls et. al to stop trying
255	delete $self->{_ww};
256	delete $self->{fh};
257		367
258	$self->stoptls;	368	&_freetls;
259	}	369	}
260		370
261	sub _error {	371	sub _error {
262	my ($self, $errno, $fatal) = @_;	372	my ($self, $errno, $fatal, $message) = @_;
263		373
264	$self->_shutdown	374	$self->_shutdown
265	if $fatal;	375	if $fatal;
266		376
267	$! = $errno;	377	$! = $errno;
		378	$message \|\|= "$!";
268		379
269	if ($self->{on_error}) {	380	if ($self->{on_error}) {
270	$self->{on_error}($self, $fatal);	381	$self->{on_error}($self, $fatal, $message);
271	} else {	382	} elsif ($self->{fh}) {
272	Carp::croak "AnyEvent::Handle uncaught error: $!";	383	Carp::croak "AnyEvent::Handle uncaught error: $message";
273	}	384	}
274	}	385	}
275		386
276	=item $fh = $handle->fh	387	=item $fh = $handle->fh
277		388
278	This method returns the file handle of the L<AnyEvent::Handle> object.	389	This method returns the file handle used to create the L<AnyEvent::Handle> object.
279		390
280	=cut	391	=cut
281		392
282	sub fh { $_[0]{fh} }	393	sub fh { $_[0]{fh} }
283		394
…		…
301	$_[0]{on_eof} = $_[1];	412	$_[0]{on_eof} = $_[1];
302	}	413	}
303		414
304	=item $handle->on_timeout ($cb)	415	=item $handle->on_timeout ($cb)
305		416
306	Replace the current C<on_timeout> callback, or disables the callback	417	Replace the current C<on_timeout> callback, or disables the callback (but
307	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	418	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
308	argument.	419	argument and method.
309		420
310	=cut	421	=cut
311		422
312	sub on_timeout {	423	sub on_timeout {
313	$_[0]{on_timeout} = $_[1];	424	$_[0]{on_timeout} = $_[1];
		425	}
		426
		427	=item $handle->autocork ($boolean)
		428
		429	Enables or disables the current autocork behaviour (see C<autocork>
		430	constructor argument). Changes will only take effect on the next write.
		431
		432	=cut
		433
		434	sub autocork {
		435	$_[0]{autocork} = $_[1];
		436	}
		437
		438	=item $handle->no_delay ($boolean)
		439
		440	Enables or disables the C<no_delay> setting (see constructor argument of
		441	the same name for details).
		442
		443	=cut
		444
		445	sub no_delay {
		446	$_[0]{no_delay} = $_[1];
		447
		448	eval {
		449	local $SIG{__DIE__};
		450	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		451	};
		452	}
		453
		454	=item $handle->on_starttls ($cb)
		455
		456	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		457
		458	=cut
		459
		460	sub on_starttls {
		461	$_[0]{on_starttls} = $_[1];
		462	}
		463
		464	=item $handle->on_stoptls ($cb)
		465
		466	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		467
		468	=cut
		469
		470	sub on_starttls {
		471	$_[0]{on_stoptls} = $_[1];
314	}	472	}
315		473
316	#############################################################################	474	#############################################################################
317		475
318	=item $handle->timeout ($seconds)	476	=item $handle->timeout ($seconds)
…		…
396	my ($self, $cb) = @_;	554	my ($self, $cb) = @_;
397		555
398	$self->{on_drain} = $cb;	556	$self->{on_drain} = $cb;
399		557
400	$cb->($self)	558	$cb->($self)
401	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	559	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
402	}	560	}
403		561
404	=item $handle->push_write ($data)	562	=item $handle->push_write ($data)
405		563
406	Queues the given scalar to be written. You can push as much data as you	564	Queues the given scalar to be written. You can push as much data as you
…		…
423	substr $self->{wbuf}, 0, $len, "";	581	substr $self->{wbuf}, 0, $len, "";
424		582
425	$self->{_activity} = AnyEvent->now;	583	$self->{_activity} = AnyEvent->now;
426		584
427	$self->{on_drain}($self)	585	$self->{on_drain}($self)
428	if $self->{low_water_mark} >= length $self->{wbuf}	586	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
429	&& $self->{on_drain};	587	&& $self->{on_drain};
430		588
431	delete $self->{_ww} unless length $self->{wbuf};	589	delete $self->{_ww} unless length $self->{wbuf};
432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	590	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
433	$self->_error ($!, 1);	591	$self->_error ($!, 1);
434	}	592	}
435	};	593	};
436		594
437	# try to write data immediately	595	# try to write data immediately
438	$cb->();	596	$cb->() unless $self->{autocork};
439		597
440	# if still data left in wbuf, we need to poll	598	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	599	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
442	if length $self->{wbuf};	600	if length $self->{wbuf};
443	};	601	};
…		…
457		615
458	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	616	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
459	->($self, @_);	617	->($self, @_);
460	}	618	}
461		619
462	if ($self->{filter_w}) {	620	if ($self->{tls}) {
463	$self->{filter_w}($self, \$_[0]);	621	$self->{_tls_wbuf} .= $_[0];
		622
		623	&_dotls ($self);
464	} else {	624	} else {
465	$self->{wbuf} .= $_[0];	625	$self->{wbuf} .= $_[0];
466	$self->_drain_wbuf;	626	$self->_drain_wbuf;
467	}	627	}
468	}	628	}
…		…
485	=cut	645	=cut
486		646
487	register_write_type netstring => sub {	647	register_write_type netstring => sub {
488	my ($self, $string) = @_;	648	my ($self, $string) = @_;
489		649
490	sprintf "%d:%s,", (length $string), $string	650	(length $string) . ":$string,"
491	};	651	};
492		652
493	=item packstring => $format, $data	653	=item packstring => $format, $data
494		654
495	An octet string prefixed with an encoded length. The encoding C<$format>	655	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
500	=cut	660	=cut
501		661
502	register_write_type packstring => sub {	662	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	663	my ($self, $format, $string) = @_;
504		664
505	pack "$format/a", $string	665	pack "$format/a*", $string
506	};	666	};
507		667
508	=item json => $array_or_hashref	668	=item json => $array_or_hashref
509		669
510	Encodes the given hash or array reference into a JSON object. Unless you	670	Encodes the given hash or array reference into a JSON object. Unless you
…		…
556	register_write_type storable => sub {	716	register_write_type storable => sub {
557	my ($self, $ref) = @_;	717	my ($self, $ref) = @_;
558		718
559	require Storable;	719	require Storable;
560		720
561	pack "w/a", Storable::nfreeze ($ref)	721	pack "w/a*", Storable::nfreeze ($ref)
562	};	722	};
563		723
564	=back	724	=back
		725
		726	=item $handle->push_shutdown
		727
		728	Sometimes you know you want to close the socket after writing your data
		729	before it was actually written. One way to do that is to replace your
		730	C<on_drain> handler by a callback that shuts down the socket (and set
		731	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		732	replaces the C<on_drain> callback with:
		733
		734	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		735
		736	This simply shuts down the write side and signals an EOF condition to the
		737	the peer.
		738
		739	You can rely on the normal read queue and C<on_eof> handling
		740	afterwards. This is the cleanest way to close a connection.
		741
		742	=cut
		743
		744	sub push_shutdown {
		745	my ($self) = @_;
		746
		747	delete $self->{low_water_mark};
		748	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		749	}
565		750
566	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	751	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
567		752
568	This function (not method) lets you add your own types to C<push_write>.	753	This function (not method) lets you add your own types to C<push_write>.
569	Whenever the given C<type> is used, C<push_write> will invoke the code	754	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
590	ways, the "simple" way, using only C<on_read> and the "complex" way, using	775	ways, the "simple" way, using only C<on_read> and the "complex" way, using
591	a queue.	776	a queue.
592		777
593	In the simple case, you just install an C<on_read> callback and whenever	778	In the simple case, you just install an C<on_read> callback and whenever
594	new data arrives, it will be called. You can then remove some data (if	779	new data arrives, it will be called. You can then remove some data (if
595	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	780	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
596	or not.	781	leave the data there if you want to accumulate more (e.g. when only a
		782	partial message has been received so far).
597		783
598	In the more complex case, you want to queue multiple callbacks. In this	784	In the more complex case, you want to queue multiple callbacks. In this
599	case, AnyEvent::Handle will call the first queued callback each time new	785	case, AnyEvent::Handle will call the first queued callback each time new
600	data arrives (also the first time it is queued) and removes it when it has	786	data arrives (also the first time it is queued) and removes it when it has
601	done its job (see C<push_read>, below).	787	done its job (see C<push_read>, below).
…		…
619	# handle xml	805	# handle xml
620	});	806	});
621	});	807	});
622	});	808	});
623		809
624	Example 2: Implement a client for a protocol that replies either with	810	Example 2: Implement a client for a protocol that replies either with "OK"
625	"OK" and another line or "ERROR" for one request, and 64 bytes for the	811	and another line or "ERROR" for the first request that is sent, and 64
626	second request. Due tot he availability of a full queue, we can just	812	bytes for the second request. Due to the availability of a queue, we can
627	pipeline sending both requests and manipulate the queue as necessary in	813	just pipeline sending both requests and manipulate the queue as necessary
628	the callbacks:	814	in the callbacks.
629		815
630	# request one	816	When the first callback is called and sees an "OK" response, it will
		817	C<unshift> another line-read. This line-read will be queued I<before> the
		818	64-byte chunk callback.
		819
		820	# request one, returns either "OK + extra line" or "ERROR"
631	$handle->push_write ("request 1\015\012");	821	$handle->push_write ("request 1\015\012");
632		822
633	# we expect "ERROR" or "OK" as response, so push a line read	823	# we expect "ERROR" or "OK" as response, so push a line read
634	$handle->push_read (line => sub {	824	$handle->push_read (line => sub {
635	# if we got an "OK", we have to _prepend_ another line,	825	# if we got an "OK", we have to _prepend_ another line,
…		…
642	...	832	...
643	});	833	});
644	}	834	}
645	});	835	});
646		836
647	# request two	837	# request two, simply returns 64 octets
648	$handle->push_write ("request 2\015\012");	838	$handle->push_write ("request 2\015\012");
649		839
650	# simply read 64 bytes, always	840	# simply read 64 bytes, always
651	$handle->push_read (chunk => 64, sub {	841	$handle->push_read (chunk => 64, sub {
652	my $response = $_[1];	842	my $response = $_[1];
…		…
664		854
665	if (	855	if (
666	defined $self->{rbuf_max}	856	defined $self->{rbuf_max}
667	&& $self->{rbuf_max} < length $self->{rbuf}	857	&& $self->{rbuf_max} < length $self->{rbuf}
668	) {	858	) {
669	return $self->_error (&Errno::ENOSPC, 1);	859	$self->_error (&Errno::ENOSPC, 1), return;
670	}	860	}
671		861
672	while () {	862	while () {
673	no strict 'refs';	863	# we need to use a separate tls read buffer, as we must not receive data while
		864	# we are draining the buffer, and this can only happen with TLS.
		865	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
674		866
675	my $len = length $self->{rbuf};	867	my $len = length $self->{rbuf};
676		868
677	if (my $cb = shift @{ $self->{_queue} }) {	869	if (my $cb = shift @{ $self->{_queue} }) {
678	unless ($cb->($self)) {	870	unless ($cb->($self)) {
679	if ($self->{_eof}) {	871	if ($self->{_eof}) {
680	# no progress can be made (not enough data and no data forthcoming)	872	# no progress can be made (not enough data and no data forthcoming)
681	$self->_error (&Errno::EPIPE, 1), last;	873	$self->_error (&Errno::EPIPE, 1), return;
682	}	874	}
683		875
684	unshift @{ $self->{_queue} }, $cb;	876	unshift @{ $self->{_queue} }, $cb;
685	last;	877	last;
686	}	878	}
…		…
694	&& !@{ $self->{_queue} } # and the queue is still empty	886	&& !@{ $self->{_queue} } # and the queue is still empty
695	&& $self->{on_read} # but we still have on_read	887	&& $self->{on_read} # but we still have on_read
696	) {	888	) {
697	# no further data will arrive	889	# no further data will arrive
698	# so no progress can be made	890	# so no progress can be made
699	$self->_error (&Errno::EPIPE, 1), last	891	$self->_error (&Errno::EPIPE, 1), return
700	if $self->{_eof};	892	if $self->{_eof};
701		893
702	last; # more data might arrive	894	last; # more data might arrive
703	}	895	}
704	} else {	896	} else {
705	# read side becomes idle	897	# read side becomes idle
706	delete $self->{_rw};	898	delete $self->{_rw} unless $self->{tls};
707	last;	899	last;
708	}	900	}
709	}	901	}
710		902
		903	if ($self->{_eof}) {
		904	if ($self->{on_eof}) {
711	$self->{on_eof}($self)	905	$self->{on_eof}($self)
712	if $self->{_eof} && $self->{on_eof};	906	} else {
		907	$self->_error (0, 1, "Unexpected end-of-file");
		908	}
		909	}
713		910
714	# may need to restart read watcher	911	# may need to restart read watcher
715	unless ($self->{_rw}) {	912	unless ($self->{_rw}) {
716	$self->start_read	913	$self->start_read
717	if $self->{on_read} \|\| @{ $self->{_queue} };	914	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
735		932
736	=item $handle->rbuf	933	=item $handle->rbuf
737		934
738	Returns the read buffer (as a modifiable lvalue).	935	Returns the read buffer (as a modifiable lvalue).
739		936
740	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	937	You can access the read buffer directly as the C<< ->{rbuf} >>
741	you want.	938	member, if you want. However, the only operation allowed on the
		939	read buffer (apart from looking at it) is removing data from its
		940	beginning. Otherwise modifying or appending to it is not allowed and will
		941	lead to hard-to-track-down bugs.
742		942
743	NOTE: The read buffer should only be used or modified if the C<on_read>,	943	NOTE: The read buffer should only be used or modified if the C<on_read>,
744	C<push_read> or C<unshift_read> methods are used. The other read methods	944	C<push_read> or C<unshift_read> methods are used. The other read methods
745	automatically manage the read buffer.	945	automatically manage the read buffer.
746		946
…		…
843	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1043	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
844	1	1044	1
845	}	1045	}
846	};	1046	};
847		1047
848	# compatibility with older API
849	sub push_read_chunk {
850	$_[0]->push_read (chunk => $_[1], $_[2]);
851	}
852
853	sub unshift_read_chunk {
854	$_[0]->unshift_read (chunk => $_[1], $_[2]);
855	}
856
857	=item line => [$eol, ]$cb->($handle, $line, $eol)	1048	=item line => [$eol, ]$cb->($handle, $line, $eol)
858		1049
859	The callback will be called only once a full line (including the end of	1050	The callback will be called only once a full line (including the end of
860	line marker, C<$eol>) has been read. This line (excluding the end of line	1051	line marker, C<$eol>) has been read. This line (excluding the end of line
861	marker) will be passed to the callback as second argument (C<$line>), and	1052	marker) will be passed to the callback as second argument (C<$line>), and
…		…
876	=cut	1067	=cut
877		1068
878	register_read_type line => sub {	1069	register_read_type line => sub {
879	my ($self, $cb, $eol) = @_;	1070	my ($self, $cb, $eol) = @_;
880		1071
881	$eol = qr\|(\015?\012)\| if @_ < 3;	1072	if (@_ < 3) {
		1073	# this is more than twice as fast as the generic code below
		1074	sub {
		1075	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1076
		1077	$cb->($_[0], $1, $2);
		1078	1
		1079	}
		1080	} else {
882	$eol = quotemeta $eol unless ref $eol;	1081	$eol = quotemeta $eol unless ref $eol;
883	$eol = qr\|^(.*?)($eol)\|s;	1082	$eol = qr\|^(.*?)($eol)\|s;
884		1083
885	sub {	1084	sub {
886	$_[0]{rbuf} =~ s/$eol// or return;	1085	$_[0]{rbuf} =~ s/$eol// or return;
887		1086
888	$cb->($_[0], $1, $2);	1087	$cb->($_[0], $1, $2);
		1088	1
889	1	1089	}
890	}	1090	}
891	};	1091	};
892
893	# compatibility with older API
894	sub push_read_line {
895	my $self = shift;
896	$self->push_read (line => @_);
897	}
898
899	sub unshift_read_line {
900	my $self = shift;
901	$self->unshift_read (line => @_);
902	}
903		1092
904	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1093	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
905		1094
906	Makes a regex match against the regex object C<$accept> and returns	1095	Makes a regex match against the regex object C<$accept> and returns
907	everything up to and including the match.	1096	everything up to and including the match.
…		…
1012	An octet string prefixed with an encoded length. The encoding C<$format>	1201	An octet string prefixed with an encoded length. The encoding C<$format>
1013	uses the same format as a Perl C<pack> format, but must specify a single	1202	uses the same format as a Perl C<pack> format, but must specify a single
1014	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1203	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1015	optional C<!>, C<< < >> or C<< > >> modifier).	1204	optional C<!>, C<< < >> or C<< > >> modifier).
1016		1205
1017	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1206	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1207	EPP uses a prefix of C<N> (4 octtes).
1018		1208
1019	Example: read a block of data prefixed by its length in BER-encoded	1209	Example: read a block of data prefixed by its length in BER-encoded
1020	format (very efficient).	1210	format (very efficient).
1021		1211
1022	$handle->push_read (packstring => "w", sub {	1212	$handle->push_read (packstring => "w", sub {
…		…
1028	register_read_type packstring => sub {	1218	register_read_type packstring => sub {
1029	my ($self, $cb, $format) = @_;	1219	my ($self, $cb, $format) = @_;
1030		1220
1031	sub {	1221	sub {
1032	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1222	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1033	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1223	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1034	or return;	1224	or return;
1035		1225
		1226	$format = length pack $format, $len;
		1227
		1228	# bypass unshift if we already have the remaining chunk
		1229	if ($format + $len <= length $_[0]{rbuf}) {
		1230	my $data = substr $_[0]{rbuf}, $format, $len;
		1231	substr $_[0]{rbuf}, 0, $format + $len, "";
		1232	$cb->($_[0], $data);
		1233	} else {
1036	# remove prefix	1234	# remove prefix
1037	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1235	substr $_[0]{rbuf}, 0, $format, "";
1038		1236
1039	# read rest	1237	# read remaining chunk
1040	$_[0]->unshift_read (chunk => $len, $cb);	1238	$_[0]->unshift_read (chunk => $len, $cb);
		1239	}
1041		1240
1042	1	1241	1
1043	}	1242	}
1044	};	1243	};
1045		1244
1046	=item json => $cb->($handle, $hash_or_arrayref)	1245	=item json => $cb->($handle, $hash_or_arrayref)
1047		1246
1048	Reads a JSON object or array, decodes it and passes it to the callback.	1247	Reads a JSON object or array, decodes it and passes it to the
		1248	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1049		1249
1050	If a C<json> object was passed to the constructor, then that will be used	1250	If a C<json> object was passed to the constructor, then that will be used
1051	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1251	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1052		1252
1053	This read type uses the incremental parser available with JSON version	1253	This read type uses the incremental parser available with JSON version
…		…
1062	=cut	1262	=cut
1063		1263
1064	register_read_type json => sub {	1264	register_read_type json => sub {
1065	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
1066		1266
1067	require JSON;	1267	my $json = $self->{json} \|\|=
		1268	eval { require JSON::XS; JSON::XS->new->utf8 }
		1269	\|\| do { require JSON; JSON->new->utf8 };
1068		1270
1069	my $data;	1271	my $data;
1070	my $rbuf = \$self->{rbuf};	1272	my $rbuf = \$self->{rbuf};
1071		1273
1072	my $json = $self->{json} \|\|= JSON->new->utf8;
1073
1074	sub {	1274	sub {
1075	my $ref = $json->incr_parse ($self->{rbuf});	1275	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1076		1276
1077	if ($ref) {	1277	if ($ref) {
1078	$self->{rbuf} = $json->incr_text;	1278	$self->{rbuf} = $json->incr_text;
1079	$json->incr_text = "";	1279	$json->incr_text = "";
1080	$cb->($self, $ref);	1280	$cb->($self, $ref);
1081		1281
1082	1	1282	1
		1283	} elsif ($@) {
		1284	# error case
		1285	$json->incr_skip;
		1286
		1287	$self->{rbuf} = $json->incr_text;
		1288	$json->incr_text = "";
		1289
		1290	$self->_error (&Errno::EBADMSG);
		1291
		1292	()
1083	} else {	1293	} else {
1084	$self->{rbuf} = "";	1294	$self->{rbuf} = "";
		1295
1085	()	1296	()
1086	}	1297	}
1087	}	1298	}
1088	};	1299	};
1089		1300
…		…
1102		1313
1103	require Storable;	1314	require Storable;
1104		1315
1105	sub {	1316	sub {
1106	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1317	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1107	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1318	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1108	or return;	1319	or return;
1109		1320
		1321	my $format = length pack "w", $len;
		1322
		1323	# bypass unshift if we already have the remaining chunk
		1324	if ($format + $len <= length $_[0]{rbuf}) {
		1325	my $data = substr $_[0]{rbuf}, $format, $len;
		1326	substr $_[0]{rbuf}, 0, $format + $len, "";
		1327	$cb->($_[0], Storable::thaw ($data));
		1328	} else {
1110	# remove prefix	1329	# remove prefix
1111	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1330	substr $_[0]{rbuf}, 0, $format, "";
1112		1331
1113	# read rest	1332	# read remaining chunk
1114	$_[0]->unshift_read (chunk => $len, sub {	1333	$_[0]->unshift_read (chunk => $len, sub {
1115	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1334	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1116	$cb->($_[0], $ref);	1335	$cb->($_[0], $ref);
1117	} else {	1336	} else {
1118	$self->_error (&Errno::EBADMSG);	1337	$self->_error (&Errno::EBADMSG);
		1338	}
1119	}	1339	});
1120	});	1340	}
		1341
		1342	1
1121	}	1343	}
1122	};	1344	};
1123		1345
1124	=back	1346	=back
1125		1347
…		…
1155	Note that AnyEvent::Handle will automatically C<start_read> for you when	1377	Note that AnyEvent::Handle will automatically C<start_read> for you when
1156	you change the C<on_read> callback or push/unshift a read callback, and it	1378	you change the C<on_read> callback or push/unshift a read callback, and it
1157	will automatically C<stop_read> for you when neither C<on_read> is set nor	1379	will automatically C<stop_read> for you when neither C<on_read> is set nor
1158	there are any read requests in the queue.	1380	there are any read requests in the queue.
1159		1381
		1382	These methods will have no effect when in TLS mode (as TLS doesn't support
		1383	half-duplex connections).
		1384
1160	=cut	1385	=cut
1161		1386
1162	sub stop_read {	1387	sub stop_read {
1163	my ($self) = @_;	1388	my ($self) = @_;
1164		1389
1165	delete $self->{_rw};	1390	delete $self->{_rw} unless $self->{tls};
1166	}	1391	}
1167		1392
1168	sub start_read {	1393	sub start_read {
1169	my ($self) = @_;	1394	my ($self) = @_;
1170		1395
1171	unless ($self->{_rw} \|\| $self->{_eof}) {	1396	unless ($self->{_rw} \|\| $self->{_eof}) {
1172	Scalar::Util::weaken $self;	1397	Scalar::Util::weaken $self;
1173		1398
1174	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1399	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1175	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1400	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1176	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1401	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1177		1402
1178	if ($len > 0) {	1403	if ($len > 0) {
1179	$self->{_activity} = AnyEvent->now;	1404	$self->{_activity} = AnyEvent->now;
1180		1405
1181	$self->{filter_r}	1406	if ($self->{tls}) {
1182	? $self->{filter_r}($self, $rbuf)	1407	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1183	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1408
		1409	&_dotls ($self);
		1410	} else {
		1411	$self->_drain_rbuf unless $self->{_in_drain};
		1412	}
1184		1413
1185	} elsif (defined $len) {	1414	} elsif (defined $len) {
1186	delete $self->{_rw};	1415	delete $self->{_rw};
1187	$self->{_eof} = 1;	1416	$self->{_eof} = 1;
1188	$self->_drain_rbuf unless $self->{_in_drain};	1417	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1192	}	1421	}
1193	});	1422	});
1194	}	1423	}
1195	}	1424	}
1196		1425
		1426	our $ERROR_SYSCALL;
		1427	our $ERROR_WANT_READ;
		1428
		1429	sub _tls_error {
		1430	my ($self, $err) = @_;
		1431
		1432	return $self->_error ($!, 1)
		1433	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1434
		1435	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1436
		1437	# reduce error string to look less scary
		1438	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1439
		1440	$self->_error (&Errno::EPROTO, 1, $err);
		1441	}
		1442
		1443	# poll the write BIO and send the data if applicable
		1444	# also decode read data if possible
		1445	# this is basiclaly our TLS state machine
		1446	# more efficient implementations are possible with openssl,
		1447	# but not with the buggy and incomplete Net::SSLeay.
1197	sub _dotls {	1448	sub _dotls {
1198	my ($self) = @_;	1449	my ($self) = @_;
1199		1450
1200	my $buf;	1451	my $tmp;
1201		1452
1202	if (length $self->{_tls_wbuf}) {	1453	if (length $self->{_tls_wbuf}) {
1203	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1454	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1204	substr $self->{_tls_wbuf}, 0, $len, "";	1455	substr $self->{_tls_wbuf}, 0, $tmp, "";
1205	}	1456	}
1206	}
1207		1457
		1458	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1459	return $self->_tls_error ($tmp)
		1460	if $tmp != $ERROR_WANT_READ
		1461	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1462	}
		1463
		1464	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1465	unless (length $tmp) {
		1466	&_freetls;
		1467	if ($self->{on_stoptls}) {
		1468	$self->{on_stoptls}($self);
		1469	return;
		1470	} else {
		1471	# let's treat SSL-eof as we treat normal EOF
		1472	delete $self->{_rw};
		1473	$self->{_eof} = 1;
		1474	}
		1475	}
		1476
		1477	$self->{_tls_rbuf} .= $tmp;
		1478	$self->_drain_rbuf unless $self->{_in_drain};
		1479	$self->{tls} or return; # tls session might have gone away in callback
		1480	}
		1481
		1482	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1483	return $self->_tls_error ($tmp)
		1484	if $tmp != $ERROR_WANT_READ
		1485	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1486
1208	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1487	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1209	$self->{wbuf} .= $buf;	1488	$self->{wbuf} .= $tmp;
1210	$self->_drain_wbuf;	1489	$self->_drain_wbuf;
1211	}	1490	}
1212		1491
1213	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1492	$self->{_on_starttls}
1214	if (length $buf) {	1493	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1215	$self->{rbuf} .= $buf;	1494	and (delete $self->{_on_starttls})->($self, 1);
1216	$self->_drain_rbuf unless $self->{_in_drain};
1217	} else {
1218	# let's treat SSL-eof as we treat normal EOF
1219	$self->{_eof} = 1;
1220	$self->_shutdown;
1221	return;
1222	}
1223	}
1224
1225	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1226
1227	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1228	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1229	return $self->_error ($!, 1);
1230	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1231	return $self->_error (&Errno::EIO, 1);
1232	}
1233
1234	# all others are fine for our purposes
1235	}
1236	}	1495	}
1237		1496
1238	=item $handle->starttls ($tls[, $tls_ctx])	1497	=item $handle->starttls ($tls[, $tls_ctx])
1239		1498
1240	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1499	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1242	C<starttls>.	1501	C<starttls>.
1243		1502
1244	The first argument is the same as the C<tls> constructor argument (either	1503	The first argument is the same as the C<tls> constructor argument (either
1245	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1504	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1246		1505
1247	The second argument is the optional C<Net::SSLeay::CTX> object that is	1506	The second argument is the optional C<AnyEvent::TLS> object that is used
1248	used when AnyEvent::Handle has to create its own TLS connection object.	1507	when AnyEvent::Handle has to create its own TLS connection object, or
		1508	a hash reference with C<< key => value >> pairs that will be used to
		1509	construct a new context.
1249		1510
1250	The TLS connection object will end up in C<< $handle->{tls} >> after this	1511	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1251	call and can be used or changed to your liking. Note that the handshake	1512	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1252	might have already started when this function returns.	1513	changed to your liking. Note that the handshake might have already started
		1514	when this function returns.
1253		1515
		1516	If it an error to start a TLS handshake more than once per
		1517	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1518
1254	=cut	1519	=cut
		1520
		1521	our %TLS_CACHE; #TODO not yet documented, should we?
1255		1522
1256	sub starttls {	1523	sub starttls {
1257	my ($self, $ssl, $ctx) = @_;	1524	my ($self, $ssl, $ctx) = @_;
1258		1525
1259	$self->stoptls;	1526	require Net::SSLeay;
1260		1527
1261	if ($ssl eq "accept") {	1528	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1262	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1529	if $self->{tls};
1263	Net::SSLeay::set_accept_state ($ssl);	1530
1264	} elsif ($ssl eq "connect") {	1531	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1265	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1532	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1266	Net::SSLeay::set_connect_state ($ssl);	1533
		1534	$ctx \|\|= $self->{tls_ctx};
		1535
		1536	if ("HASH" eq ref $ctx) {
		1537	require AnyEvent::TLS;
		1538
		1539	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1540
		1541	if ($ctx->{cache}) {
		1542	my $key = $ctx+0;
		1543	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1544	} else {
		1545	$ctx = new AnyEvent::TLS %$ctx;
		1546	}
		1547	}
1267	}	1548
1268		1549	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1269	$self->{tls} = $ssl;	1550	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1270		1551
1271	# basically, this is deep magic (because SSL_read should have the same issues)	1552	# basically, this is deep magic (because SSL_read should have the same issues)
1272	# but the openssl maintainers basically said: "trust us, it just works".	1553	# but the openssl maintainers basically said: "trust us, it just works".
1273	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1554	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1274	# and mismaintained ssleay-module doesn't even offer them).	1555	# and mismaintained ssleay-module doesn't even offer them).
1275	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1556	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1557	#
		1558	# in short: this is a mess.
		1559	#
		1560	# note that we do not try to keep the length constant between writes as we are required to do.
		1561	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1562	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1563	# have identity issues in that area.
1276	Net::SSLeay::CTX_set_mode ($self->{tls},	1564	# Net::SSLeay::CTX_set_mode ($ssl,
1277	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1565	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1278	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1566	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1567	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1279		1568
1280	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1569	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1281	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1570	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1282		1571
1283	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1572	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1284		1573
1285	$self->{filter_w} = sub {	1574	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1286	$_[0]{_tls_wbuf} .= ${$_[1]};	1575	if exists $self->{on_starttls};
1287	&_dotls;	1576
1288	};	1577	&_dotls; # need to trigger the initial handshake
1289	$self->{filter_r} = sub {	1578	$self->start_read; # make sure we actually do read
1290	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1291	&_dotls;
1292	};
1293	}	1579	}
1294		1580
1295	=item $handle->stoptls	1581	=item $handle->stoptls
1296		1582
1297	Destroys the SSL connection, if any. Partial read or write data will be	1583	Shuts down the SSL connection - this makes a proper EOF handshake by
1298	lost.	1584	sending a close notify to the other side, but since OpenSSL doesn't
		1585	support non-blocking shut downs, it is not possible to re-use the stream
		1586	afterwards.
1299		1587
1300	=cut	1588	=cut
1301		1589
1302	sub stoptls {	1590	sub stoptls {
1303	my ($self) = @_;	1591	my ($self) = @_;
1304		1592
1305	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1593	if ($self->{tls}) {
		1594	Net::SSLeay::shutdown ($self->{tls});
1306		1595
1307	delete $self->{_rbio};	1596	&_dotls;
1308	delete $self->{_wbio};	1597
1309	delete $self->{_tls_wbuf};	1598	# # we don't give a shit. no, we do, but we can't. no...#d#
1310	delete $self->{filter_r};	1599	# # we, we... have to use openssl :/#d#
1311	delete $self->{filter_w};	1600	# &_freetls;#d#
		1601	}
		1602	}
		1603
		1604	sub _freetls {
		1605	my ($self) = @_;
		1606
		1607	return unless $self->{tls};
		1608
		1609	$self->{_on_starttls}
		1610	and (delete $self->{_on_starttls})->($self, undef);
		1611
		1612	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1613
		1614	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1312	}	1615	}
1313		1616
1314	sub DESTROY {	1617	sub DESTROY {
1315	my $self = shift;	1618	my ($self) = @_;
1316		1619
1317	$self->stoptls;	1620	&_freetls;
1318		1621
1319	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1622	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1320		1623
1321	if ($linger && length $self->{wbuf}) {	1624	if ($linger && length $self->{wbuf}) {
1322	my $fh = delete $self->{fh};	1625	my $fh = delete $self->{fh};
…		…
1337	@linger = ();	1640	@linger = ();
1338	});	1641	});
1339	}	1642	}
1340	}	1643	}
1341		1644
		1645	=item $handle->destroy
		1646
		1647	Shuts down the handle object as much as possible - this call ensures that
		1648	no further callbacks will be invoked and as many resources as possible
		1649	will be freed. You must not call any methods on the object afterwards.
		1650
		1651	Normally, you can just "forget" any references to an AnyEvent::Handle
		1652	object and it will simply shut down. This works in fatal error and EOF
		1653	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1654	callback, so when you want to destroy the AnyEvent::Handle object from
		1655	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1656	that case.
		1657
		1658	The handle might still linger in the background and write out remaining
		1659	data, as specified by the C<linger> option, however.
		1660
		1661	=cut
		1662
		1663	sub destroy {
		1664	my ($self) = @_;
		1665
		1666	$self->DESTROY;
		1667	%$self = ();
		1668	}
		1669
1342	=item AnyEvent::Handle::TLS_CTX	1670	=item AnyEvent::Handle::TLS_CTX
1343		1671
1344	This function creates and returns the Net::SSLeay::CTX object used by	1672	This function creates and returns the AnyEvent::TLS object used by default
1345	default for TLS mode.	1673	for TLS mode.
1346		1674
1347	The context is created like this:	1675	The context is created by calling L<AnyEvent::TLS> without any arguments.
1348
1349	Net::SSLeay::load_error_strings;
1350	Net::SSLeay::SSLeay_add_ssl_algorithms;
1351	Net::SSLeay::randomize;
1352
1353	my $CTX = Net::SSLeay::CTX_new;
1354
1355	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1356		1676
1357	=cut	1677	=cut
1358		1678
1359	our $TLS_CTX;	1679	our $TLS_CTX;
1360		1680
1361	sub TLS_CTX() {	1681	sub TLS_CTX() {
1362	$TLS_CTX \|\| do {	1682	$TLS_CTX \|\|= do {
1363	require Net::SSLeay;	1683	require AnyEvent::TLS;
1364		1684
1365	Net::SSLeay::load_error_strings ();	1685	new AnyEvent::TLS
1366	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1367	Net::SSLeay::randomize ();
1368
1369	$TLS_CTX = Net::SSLeay::CTX_new ();
1370
1371	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1372
1373	$TLS_CTX
1374	}	1686	}
1375	}	1687	}
1376		1688
1377	=back	1689	=back
		1690
		1691
		1692	=head1 NONFREQUENTLY ASKED QUESTIONS
		1693
		1694	=over 4
		1695
		1696	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1697	still get further invocations!
		1698
		1699	That's because AnyEvent::Handle keeps a reference to itself when handling
		1700	read or write callbacks.
		1701
		1702	It is only safe to "forget" the reference inside EOF or error callbacks,
		1703	from within all other callbacks, you need to explicitly call the C<<
		1704	->destroy >> method.
		1705
		1706	=item I get different callback invocations in TLS mode/Why can't I pause
		1707	reading?
		1708
		1709	Unlike, say, TCP, TLS connections do not consist of two independent
		1710	communication channels, one for each direction. Or put differently. The
		1711	read and write directions are not independent of each other: you cannot
		1712	write data unless you are also prepared to read, and vice versa.
		1713
		1714	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1715	callback invocations when you are not expecting any read data - the reason
		1716	is that AnyEvent::Handle always reads in TLS mode.
		1717
		1718	During the connection, you have to make sure that you always have a
		1719	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1720	connection (or when you no longer want to use it) you can call the
		1721	C<destroy> method.
		1722
		1723	=item How do I read data until the other side closes the connection?
		1724
		1725	If you just want to read your data into a perl scalar, the easiest way
		1726	to achieve this is by setting an C<on_read> callback that does nothing,
		1727	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1728	will be in C<$_[0]{rbuf}>:
		1729
		1730	$handle->on_read (sub { });
		1731	$handle->on_eof (undef);
		1732	$handle->on_error (sub {
		1733	my $data = delete $_[0]{rbuf};
		1734	undef $handle;
		1735	});
		1736
		1737	The reason to use C<on_error> is that TCP connections, due to latencies
		1738	and packets loss, might get closed quite violently with an error, when in
		1739	fact, all data has been received.
		1740
		1741	It is usually better to use acknowledgements when transferring data,
		1742	to make sure the other side hasn't just died and you got the data
		1743	intact. This is also one reason why so many internet protocols have an
		1744	explicit QUIT command.
		1745
		1746	=item I don't want to destroy the handle too early - how do I wait until
		1747	all data has been written?
		1748
		1749	After writing your last bits of data, set the C<on_drain> callback
		1750	and destroy the handle in there - with the default setting of
		1751	C<low_water_mark> this will be called precisely when all data has been
		1752	written to the socket:
		1753
		1754	$handle->push_write (...);
		1755	$handle->on_drain (sub {
		1756	warn "all data submitted to the kernel\n";
		1757	undef $handle;
		1758	});
		1759
		1760	=back
		1761
1378		1762
1379	=head1 SUBCLASSING AnyEvent::Handle	1763	=head1 SUBCLASSING AnyEvent::Handle
1380		1764
1381	In many cases, you might want to subclass AnyEvent::Handle.	1765	In many cases, you might want to subclass AnyEvent::Handle.
1382		1766
…		…
1386	=over 4	1770	=over 4
1387		1771
1388	=item * all constructor arguments become object members.	1772	=item * all constructor arguments become object members.
1389		1773
1390	At least initially, when you pass a C<tls>-argument to the constructor it	1774	At least initially, when you pass a C<tls>-argument to the constructor it
1391	will end up in C<< $handle->{tls} >>. Those members might be changes or	1775	will end up in C<< $handle->{tls} >>. Those members might be changed or
1392	mutated later on (for example C<tls> will hold the TLS connection object).	1776	mutated later on (for example C<tls> will hold the TLS connection object).
1393		1777
1394	=item * other object member names are prefixed with an C<_>.	1778	=item * other object member names are prefixed with an C<_>.
1395		1779
1396	All object members not explicitly documented (internal use) are prefixed	1780	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.63 by root, Fri Jun 6 11:00:32 2008 UTC vs. Revision 1.142 by root, Mon Jul 6 20:24:47 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.63 by root, Fri Jun 6 11:00:32 2008 UTC vs.
Revision 1.142 by root, Mon Jul 6 20:24:47 2009 UTC