ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs.
Revision 1.132 by elmex, Thu Jul 2 22:25:13 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 = '0.04';	19	our $VERSION = 4.45;
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 on EOF.	84	Set the callback to be called when an end-of-file condition is detected,
		85	i.e. in the case of a socket, when the other side has closed the
		86	connection cleanly.
81		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
82	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,
83	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
84	waiting for data.	95	waiting for data.
85		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
86	=item on_error => $cb->($handle)	100	=item on_error => $cb->($handle, $fatal)
87		101
88	This is the fatal error callback, that is called when, well, a fatal error	102	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	103	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	104	connect or a read error.
91		105
92	The object will not be in a usable state when this callback has been	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	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	Non-fatal errors can be retried by simply returning, but it is recommended
		113	to simply ignore this parameter and instead abondon the handle object
		114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		116
95	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		119
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100
101	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	121	you will not be notified of errors otherwise. The default simply calls
103	die.	122	C<croak>.
104		123
105	=item on_read => $cb->($handle)	124	=item on_read => $cb->($handle)
106		125
107	This sets the default read callback, which is called when data arrives	126	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	127	and no read request is in the queue (unlike read queue callbacks, this
		128	callback will only be called when at least one octet of data is in the
		129	read buffer).
109		130
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly. Note that you
		133	must not enlarge or modify the read buffer, you can only remove data at
		134	the beginning from it.
112		135
113	When an EOF condition is detected then AnyEvent::Handle will first try to	136	When an EOF condition is detected then AnyEvent::Handle will first try to
114	feed all the remaining data to the queued callbacks and C<on_read> before	137	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	138	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	139	error will be raised (with C<$!> set to C<EPIPE>).
…		…
120	This sets the callback that is called when the write buffer becomes empty	143	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	144	(or when the callback is set and the buffer is empty already).
122		145
123	To append to the write buffer, use the C<< ->push_write >> method.	146	To append to the write buffer, use the C<< ->push_write >> method.
124		147
		148	This callback is useful when you don't want to put all of your write data
		149	into the queue at once, for example, when you want to write the contents
		150	of some file to the socket you might not want to read the whole file into
		151	memory and push it into the queue, but instead only read more data from
		152	the file when the write queue becomes empty.
		153
125	=item timeout => $fractional_seconds	154	=item timeout => $fractional_seconds
126		155
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	156	If non-zero, then this enables an "inactivity" timeout: whenever this many
128	seconds pass without a successful read or write on the underlying file	157	seconds pass without a successful read or write on the underlying file
129	handle, the C<on_timeout> callback will be invoked (and if that one is	158	handle, the C<on_timeout> callback will be invoked (and if that one is
130	missing, an C<ETIMEDOUT> error will be raised).	159	missing, a non-fatal C<ETIMEDOUT> error will be raised).
131		160
132	Note that timeout processing is also active when you currently do not have	161	Note that timeout processing is also active when you currently do not have
133	any outstanding read or write requests: If you plan to keep the connection	162	any outstanding read or write requests: If you plan to keep the connection
134	idle then you should disable the timout temporarily or ignore the timeout	163	idle then you should disable the timout temporarily or ignore the timeout
135	in the C<on_timeout> callback.	164	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		165	restart the timeout.
136		166
137	Zero (the default) disables this timeout.	167	Zero (the default) disables this timeout.
138		168
139	=item on_timeout => $cb->($handle)	169	=item on_timeout => $cb->($handle)
140		170
…		…
144		174
145	=item rbuf_max => <bytes>	175	=item rbuf_max => <bytes>
146		176
147	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	177	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
148	when the read buffer ever (strictly) exceeds this size. This is useful to	178	when the read buffer ever (strictly) exceeds this size. This is useful to
149	avoid denial-of-service attacks.	179	avoid some forms of denial-of-service attacks.
150		180
151	For example, a server accepting connections from untrusted sources should	181	For example, a server accepting connections from untrusted sources should
152	be configured to accept only so-and-so much data that it cannot act on	182	be configured to accept only so-and-so much data that it cannot act on
153	(for example, when expecting a line, an attacker could send an unlimited	183	(for example, when expecting a line, an attacker could send an unlimited
154	amount of data without a callback ever being called as long as the line	184	amount of data without a callback ever being called as long as the line
155	isn't finished).	185	isn't finished).
156		186
		187	=item autocork => <boolean>
		188
		189	When disabled (the default), then C<push_write> will try to immediately
		190	write the data to the handle, if possible. This avoids having to register
		191	a write watcher and wait for the next event loop iteration, but can
		192	be inefficient if you write multiple small chunks (on the wire, this
		193	disadvantage is usually avoided by your kernel's nagle algorithm, see
		194	C<no_delay>, but this option can save costly syscalls).
		195
		196	When enabled, then writes will always be queued till the next event loop
		197	iteration. This is efficient when you do many small writes per iteration,
		198	but less efficient when you do a single write only per iteration (or when
		199	the write buffer often is full). It also increases write latency.
		200
		201	=item no_delay => <boolean>
		202
		203	When doing small writes on sockets, your operating system kernel might
		204	wait a bit for more data before actually sending it out. This is called
		205	the Nagle algorithm, and usually it is beneficial.
		206
		207	In some situations you want as low a delay as possible, which can be
		208	accomplishd by setting this option to a true value.
		209
		210	The default is your opertaing system's default behaviour (most likely
		211	enabled), this option explicitly enables or disables it, if possible.
		212
157	=item read_size => <bytes>	213	=item read_size => <bytes>
158		214
159	The default read block size (the amount of bytes this module will try to read	215	The default read block size (the amount of bytes this module will
160	during each (loop iteration). Default: C<8192>.	216	try to read during each loop iteration, which affects memory
		217	requirements). Default: C<8192>.
161		218
162	=item low_water_mark => <bytes>	219	=item low_water_mark => <bytes>
163		220
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	221	Sets the amount of bytes (default: C<0>) that make up an "empty" write
165	buffer: If the write reaches this size or gets even samller it is	222	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	223	considered empty.
167		224
		225	Sometimes it can be beneficial (for performance reasons) to add data to
		226	the write buffer before it is fully drained, but this is a rare case, as
		227	the operating system kernel usually buffers data as well, so the default
		228	is good in almost all cases.
		229
		230	=item linger => <seconds>
		231
		232	If non-zero (default: C<3600>), then the destructor of the
		233	AnyEvent::Handle object will check whether there is still outstanding
		234	write data and will install a watcher that will write this data to the
		235	socket. No errors will be reported (this mostly matches how the operating
		236	system treats outstanding data at socket close time).
		237
		238	This will not work for partial TLS data that could not be encoded
		239	yet. This data will be lost. Calling the C<stoptls> method in time might
		240	help.
		241
		242	=item common_name => $string
		243
		244	The common name used by some verification methods (most notably SSL/TLS)
		245	associated with this connection. Usually this is the remote hostname used
		246	to connect, but can be almost anything.
		247
168	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	248	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
169		249
170	When this parameter is given, it enables TLS (SSL) mode, that means it	250	When this parameter is given, it enables TLS (SSL) mode, that means
171	will start making tls handshake and will transparently encrypt/decrypt	251	AnyEvent will start a TLS handshake as soon as the conenction has been
172	data.	252	established and will transparently encrypt/decrypt data afterwards.
173		253
174	TLS mode requires Net::SSLeay to be installed (it will be loaded	254	TLS mode requires Net::SSLeay to be installed (it will be loaded
175	automatically when you try to create a TLS handle).	255	automatically when you try to create a TLS handle): this module doesn't
		256	have a dependency on that module, so if your module requires it, you have
		257	to add the dependency yourself.
176		258
177	For the TLS server side, use C<accept>, and for the TLS client side of a	259	Unlike TCP, TLS has a server and client side: for the TLS server side, use
178	connection, use C<connect> mode.	260	C<accept>, and for the TLS client side of a connection, use C<connect>
		261	mode.
179		262
180	You can also provide your own TLS connection object, but you have	263	You can also provide your own TLS connection object, but you have
181	to make sure that you call either C<Net::SSLeay::set_connect_state>	264	to make sure that you call either C<Net::SSLeay::set_connect_state>
182	or C<Net::SSLeay::set_accept_state> on it before you pass it to	265	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	266	AnyEvent::Handle. Also, this module will take ownership of this connection
		267	object.
184		268
		269	At some future point, AnyEvent::Handle might switch to another TLS
		270	implementation, then the option to use your own session object will go
		271	away.
		272
		273	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		274	passing in the wrong integer will lead to certain crash. This most often
		275	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		276	segmentation fault.
		277
185	See the C<starttls> method if you need to start TLs negotiation later.	278	See the C<< ->starttls >> method for when need to start TLS negotiation later.
186		279
187	=item tls_ctx => $ssl_ctx	280	=item tls_ctx => $anyevent_tls
188		281
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	282	Use the given C<AnyEvent::TLS> object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	283	(unless a connection object was specified directly). If this parameter is
191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	284	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
192		285
		286	Instead of an object, you can also specify a hash reference with C<< key
		287	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		288	new TLS context object.
		289
193	=item json => JSON or JSON::XS object	290	=item json => JSON or JSON::XS object
194		291
195	This is the json coder object used by the C<json> read and write types.	292	This is the json coder object used by the C<json> read and write types.
196		293
197	If you don't supply it, then AnyEvent::Handle will create and use a	294	If you don't supply it, then AnyEvent::Handle will create and use a
198	suitable one, which will write and expect UTF-8 encoded JSON texts.	295	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		296	texts.
199		297
200	Note that you are responsible to depend on the JSON module if you want to	298	Note that you are responsible to depend on the JSON module if you want to
201	use this functionality, as AnyEvent does not have a dependency itself.	299	use this functionality, as AnyEvent does not have a dependency itself.
202		300
203	=item filter_r => $cb
204
205	=item filter_w => $cb
206
207	These exist, but are undocumented at this time.
208
209	=back	301	=back
210		302
211	=cut	303	=cut
212		304
213	sub new {	305	sub new {
214	my $class = shift;	306	my $class = shift;
215
216	my $self = bless { @_ }, $class;	307	my $self = bless { @_ }, $class;
217		308
218	$self->{fh} or Carp::croak "mandatory argument fh is missing";	309	$self->{fh} or Carp::croak "mandatory argument fh is missing";
219		310
220	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	311	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
221
222	if ($self->{tls}) {
223	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}
226
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231		312
232	$self->{_activity} = AnyEvent->now;	313	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	314	$self->_timeout;
234		315
		316	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		317
		318	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		319	if $self->{tls};
		320
		321	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		322
235	$self->start_read;	323	$self->start_read
		324	if $self->{on_read};
236		325
237	$self	326	$self->{fh} && $self
238	}	327	}
239		328
240	sub _shutdown {	329	sub _shutdown {
241	my ($self) = @_;	330	my ($self) = @_;
242		331
243	delete $self->{_tw};	332	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
244	delete $self->{_rw};	333	$self->{_eof} = 1; # tell starttls et. al to stop trying
245	delete $self->{_ww};
246	delete $self->{fh};
247	}
248		334
		335	&_freetls;
		336	}
		337
249	sub error {	338	sub _error {
250	my ($self) = @_;	339	my ($self, $errno, $fatal) = @_;
251		340
252	{
253	local $!;
254	$self->_shutdown;	341	$self->_shutdown
255	}	342	if $fatal;
256		343
257	$self->{on_error}($self)	344	$! = $errno;
		345
258	if $self->{on_error};	346	if ($self->{on_error}) {
259		347	$self->{on_error}($self, $fatal);
		348	} elsif ($self->{fh}) {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	349	Carp::croak "AnyEvent::Handle uncaught error: $!";
		350	}
261	}	351	}
262		352
263	=item $fh = $handle->fh	353	=item $fh = $handle->fh
264		354
265	This method returns the file handle of the L<AnyEvent::Handle> object.	355	This method returns the file handle used to create the L<AnyEvent::Handle> object.
266		356
267	=cut	357	=cut
268		358
269	sub fh { $_[0]{fh} }	359	sub fh { $_[0]{fh} }
270		360
…		…
288	$_[0]{on_eof} = $_[1];	378	$_[0]{on_eof} = $_[1];
289	}	379	}
290		380
291	=item $handle->on_timeout ($cb)	381	=item $handle->on_timeout ($cb)
292		382
293	Replace the current C<on_timeout> callback, or disables the callback	383	Replace the current C<on_timeout> callback, or disables the callback (but
294	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	384	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
295	argument.	385	argument and method.
296		386
297	=cut	387	=cut
298		388
299	sub on_timeout {	389	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	390	$_[0]{on_timeout} = $_[1];
		391	}
		392
		393	=item $handle->autocork ($boolean)
		394
		395	Enables or disables the current autocork behaviour (see C<autocork>
		396	constructor argument). Changes will only take effect on the next write.
		397
		398	=cut
		399
		400	sub autocork {
		401	$_[0]{autocork} = $_[1];
		402	}
		403
		404	=item $handle->no_delay ($boolean)
		405
		406	Enables or disables the C<no_delay> setting (see constructor argument of
		407	the same name for details).
		408
		409	=cut
		410
		411	sub no_delay {
		412	$_[0]{no_delay} = $_[1];
		413
		414	eval {
		415	local $SIG{__DIE__};
		416	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		417	};
301	}	418	}
302		419
303	#############################################################################	420	#############################################################################
304		421
305	=item $handle->timeout ($seconds)	422	=item $handle->timeout ($seconds)
…		…
329	# now or in the past already?	446	# now or in the past already?
330	if ($after <= 0) {	447	if ($after <= 0) {
331	$self->{_activity} = $NOW;	448	$self->{_activity} = $NOW;
332		449
333	if ($self->{on_timeout}) {	450	if ($self->{on_timeout}) {
334	$self->{on_timeout}->($self);	451	$self->{on_timeout}($self);
335	} else {	452	} else {
336	$! = Errno::ETIMEDOUT;	453	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	454	}
339		455
340	# callbakx could have changed timeout value, optimise	456	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	457	return unless $self->{timeout};
342		458
343	# calculate new after	459	# calculate new after
344	$after = $self->{timeout};	460	$after = $self->{timeout};
345	}	461	}
346		462
347	Scalar::Util::weaken $self;	463	Scalar::Util::weaken $self;
		464	return unless $self; # ->error could have destroyed $self
348		465
349	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {	466	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	467	delete $self->{_tw};
351	$self->_timeout;	468	$self->_timeout;
352	});	469	});
…		…
383	my ($self, $cb) = @_;	500	my ($self, $cb) = @_;
384		501
385	$self->{on_drain} = $cb;	502	$self->{on_drain} = $cb;
386		503
387	$cb->($self)	504	$cb->($self)
388	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	505	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
389	}	506	}
390		507
391	=item $handle->push_write ($data)	508	=item $handle->push_write ($data)
392		509
393	Queues the given scalar to be written. You can push as much data as you	510	Queues the given scalar to be written. You can push as much data as you
…		…
410	substr $self->{wbuf}, 0, $len, "";	527	substr $self->{wbuf}, 0, $len, "";
411		528
412	$self->{_activity} = AnyEvent->now;	529	$self->{_activity} = AnyEvent->now;
413		530
414	$self->{on_drain}($self)	531	$self->{on_drain}($self)
415	if $self->{low_water_mark} >= length $self->{wbuf}	532	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
416	&& $self->{on_drain};	533	&& $self->{on_drain};
417		534
418	delete $self->{_ww} unless length $self->{wbuf};	535	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	536	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	537	$self->_error ($!, 1);
421	}	538	}
422	};	539	};
423		540
424	# try to write data immediately	541	# try to write data immediately
425	$cb->();	542	$cb->() unless $self->{autocork};
426		543
427	# if still data left in wbuf, we need to poll	544	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	545	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	546	if length $self->{wbuf};
430	};	547	};
…		…
444		561
445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	562	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
446	->($self, @_);	563	->($self, @_);
447	}	564	}
448		565
449	if ($self->{filter_w}) {	566	if ($self->{tls}) {
450	$self->{filter_w}->($self, \$_[0]);	567	$self->{_tls_wbuf} .= $_[0];
		568
		569	&_dotls ($self);
451	} else {	570	} else {
452	$self->{wbuf} .= $_[0];	571	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	572	$self->_drain_wbuf;
454	}	573	}
455	}	574	}
456		575
457	=item $handle->push_write (type => @args)	576	=item $handle->push_write (type => @args)
458		577
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	578	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	579	the job by specifying a type and type-specific arguments.
463		580
464	Predefined types are (if you have ideas for additional types, feel free to	581	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	582	drop by and tell us):
…		…
469	=item netstring => $string	586	=item netstring => $string
470		587
471	Formats the given value as netstring	588	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	589	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		590
474	=back
475
476	=cut	591	=cut
477		592
478	register_write_type netstring => sub {	593	register_write_type netstring => sub {
479	my ($self, $string) = @_;	594	my ($self, $string) = @_;
480		595
481	sprintf "%d:%s,", (length $string), $string	596	(length $string) . ":$string,"
		597	};
		598
		599	=item packstring => $format, $data
		600
		601	An octet string prefixed with an encoded length. The encoding C<$format>
		602	uses the same format as a Perl C<pack> format, but must specify a single
		603	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		604	optional C<!>, C<< < >> or C<< > >> modifier).
		605
		606	=cut
		607
		608	register_write_type packstring => sub {
		609	my ($self, $format, $string) = @_;
		610
		611	pack "$format/a*", $string
482	};	612	};
483		613
484	=item json => $array_or_hashref	614	=item json => $array_or_hashref
485		615
486	Encodes the given hash or array reference into a JSON object. Unless you	616	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		650
521	$self->{json} ? $self->{json}->encode ($ref)	651	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	652	: JSON::encode_json ($ref)
523	};	653	};
524		654
		655	=item storable => $reference
		656
		657	Freezes the given reference using L<Storable> and writes it to the
		658	handle. Uses the C<nfreeze> format.
		659
		660	=cut
		661
		662	register_write_type storable => sub {
		663	my ($self, $ref) = @_;
		664
		665	require Storable;
		666
		667	pack "w/a*", Storable::nfreeze ($ref)
		668	};
		669
		670	=back
		671
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	672	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		673
527	This function (not method) lets you add your own types to C<push_write>.	674	This function (not method) lets you add your own types to C<push_write>.
528	Whenever the given C<type> is used, C<push_write> will invoke the code	675	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	676	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	696	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	697	a queue.
551		698
552	In the simple case, you just install an C<on_read> callback and whenever	699	In the simple case, you just install an C<on_read> callback and whenever
553	new data arrives, it will be called. You can then remove some data (if	700	new data arrives, it will be called. You can then remove some data (if
554	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	701	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	702	leave the data there if you want to accumulate more (e.g. when only a
		703	partial message has been received so far).
556		704
557	In the more complex case, you want to queue multiple callbacks. In this	705	In the more complex case, you want to queue multiple callbacks. In this
558	case, AnyEvent::Handle will call the first queued callback each time new	706	case, AnyEvent::Handle will call the first queued callback each time new
559	data arrives and removes it when it has done its job (see C<push_read>,	707	data arrives (also the first time it is queued) and removes it when it has
560	below).	708	done its job (see C<push_read>, below).
561		709
562	This way you can, for example, push three line-reads, followed by reading	710	This way you can, for example, push three line-reads, followed by reading
563	a chunk of data, and AnyEvent::Handle will execute them in order.	711	a chunk of data, and AnyEvent::Handle will execute them in order.
564		712
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	713	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	714	the specified number of bytes which give an XML datagram.
567		715
568	# in the default state, expect some header bytes	716	# in the default state, expect some header bytes
569	$handle->on_read (sub {	717	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	718	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	719	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	720	# header arrived, decode
573	my $len = unpack "N", $_[1];	721	my $len = unpack "N", $_[1];
574		722
575	# now read the payload	723	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	724	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	725	my $xml = $_[1];
578	# handle xml	726	# handle xml
579	});	727	});
580	});	728	});
581	});	729	});
582		730
583	Example 2: Implement a client for a protocol that replies either with	731	Example 2: Implement a client for a protocol that replies either with "OK"
584	"OK" and another line or "ERROR" for one request, and 64 bytes for the	732	and another line or "ERROR" for the first request that is sent, and 64
585	second request. Due tot he availability of a full queue, we can just	733	bytes for the second request. Due to the availability of a queue, we can
586	pipeline sending both requests and manipulate the queue as necessary in	734	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	735	in the callbacks.
588		736
589	# request one	737	When the first callback is called and sees an "OK" response, it will
		738	C<unshift> another line-read. This line-read will be queued I<before> the
		739	64-byte chunk callback.
		740
		741	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	742	$handle->push_write ("request 1\015\012");
591		743
592	# we expect "ERROR" or "OK" as response, so push a line read	744	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	745	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	746	# if we got an "OK", we have to _prepend_ another line,
595	# so it will be read before the second request reads its 64 bytes	747	# so it will be read before the second request reads its 64 bytes
596	# which are already in the queue when this callback is called	748	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	749	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	750	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	751	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	752	my $response = $_[1];
601	...	753	...
602	});	754	});
603	}	755	}
604	});	756	});
605		757
606	# request two	758	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	759	$handle->push_write ("request 2\015\012");
608		760
609	# simply read 64 bytes, always	761	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	762	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	763	my $response = $_[1];
612	...	764	...
613	});	765	});
614		766
615	=over 4	767	=over 4
616		768
617	=cut	769	=cut
618		770
619	sub _drain_rbuf {	771	sub _drain_rbuf {
620	my ($self) = @_;	772	my ($self) = @_;
		773
		774	local $self->{_in_drain} = 1;
621		775
622	if (	776	if (
623	defined $self->{rbuf_max}	777	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	778	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	779	) {
626	$! = &Errno::ENOSPC;	780	$self->_error (&Errno::ENOSPC, 1), return;
627	$self->error;
628	}	781	}
629		782
630	return if $self->{in_drain};	783	while () {
631	local $self->{in_drain} = 1;	784	# we need to use a separate tls read buffer, as we must not receive data while
		785	# we are draining the buffer, and this can only happen with TLS.
		786	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
632		787
633	while (my $len = length $self->{rbuf}) {	788	my $len = length $self->{rbuf};
634	no strict 'refs';	789
635	if (my $cb = shift @{ $self->{_queue} }) {	790	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	791	unless ($cb->($self)) {
637	if ($self->{_eof}) {	792	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	793	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	794	$self->_error (&Errno::EPIPE, 1), return;
640	$self->error;
641	}	795	}
642		796
643	unshift @{ $self->{_queue} }, $cb;	797	unshift @{ $self->{_queue} }, $cb;
644	return;	798	last;
645	}	799	}
646	} elsif ($self->{on_read}) {	800	} elsif ($self->{on_read}) {
		801	last unless $len;
		802
647	$self->{on_read}($self);	803	$self->{on_read}($self);
648		804
649	if (	805	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	806	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	807	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	808	&& $self->{on_read} # but we still have on_read
654	) {	809	) {
		810	# no further data will arrive
655	# then no progress can be made	811	# so no progress can be made
656	$! = &Errno::EPIPE;	812	$self->_error (&Errno::EPIPE, 1), return
657	$self->error;	813	if $self->{_eof};
		814
		815	last; # more data might arrive
658	}	816	}
659	} else {	817	} else {
660	# read side becomes idle	818	# read side becomes idle
661	delete $self->{_rw};	819	delete $self->{_rw} unless $self->{tls};
662	return;	820	last;
663	}	821	}
664	}	822	}
665		823
666	if ($self->{_eof}) {	824	if ($self->{_eof}) {
667	$self->_shutdown;	825	if ($self->{on_eof}) {
668	$self->{on_eof}($self)	826	$self->{on_eof}($self)
669	if $self->{on_eof};	827	} else {
		828	$self->_error (0, 1);
		829	}
		830	}
		831
		832	# may need to restart read watcher
		833	unless ($self->{_rw}) {
		834	$self->start_read
		835	if $self->{on_read} || @{ $self->{_queue} };
670	}	836	}
671	}	837	}
672		838
673	=item $handle->on_read ($cb)	839	=item $handle->on_read ($cb)
674		840
…		…
680		846
681	sub on_read {	847	sub on_read {
682	my ($self, $cb) = @_;	848	my ($self, $cb) = @_;
683		849
684	$self->{on_read} = $cb;	850	$self->{on_read} = $cb;
		851	$self->_drain_rbuf if $cb && !$self->{_in_drain};
685	}	852	}
686		853
687	=item $handle->rbuf	854	=item $handle->rbuf
688		855
689	Returns the read buffer (as a modifiable lvalue).	856	Returns the read buffer (as a modifiable lvalue).
690		857
691	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	858	You can access the read buffer directly as the C<< ->{rbuf} >>
692	you want.	859	member, if you want. However, the only operation allowed on the
		860	read buffer (apart from looking at it) is removing data from its
		861	beginning. Otherwise modifying or appending to it is not allowed and will
		862	lead to hard-to-track-down bugs.
693		863
694	NOTE: The read buffer should only be used or modified if the C<on_read>,	864	NOTE: The read buffer should only be used or modified if the C<on_read>,
695	C<push_read> or C<unshift_read> methods are used. The other read methods	865	C<push_read> or C<unshift_read> methods are used. The other read methods
696	automatically manage the read buffer.	866	automatically manage the read buffer.
697		867
…		…
738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	908	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
739	->($self, $cb, @_);	909	->($self, $cb, @_);
740	}	910	}
741		911
742	push @{ $self->{_queue} }, $cb;	912	push @{ $self->{_queue} }, $cb;
743	$self->_drain_rbuf;	913	$self->_drain_rbuf unless $self->{_in_drain};
744	}	914	}
745		915
746	sub unshift_read {	916	sub unshift_read {
747	my $self = shift;	917	my $self = shift;
748	my $cb = pop;	918	my $cb = pop;
…		…
754	->($self, $cb, @_);	924	->($self, $cb, @_);
755	}	925	}
756		926
757		927
758	unshift @{ $self->{_queue} }, $cb;	928	unshift @{ $self->{_queue} }, $cb;
759	$self->_drain_rbuf;	929	$self->_drain_rbuf unless $self->{_in_drain};
760	}	930	}
761		931
762	=item $handle->push_read (type => @args, $cb)	932	=item $handle->push_read (type => @args, $cb)
763		933
764	=item $handle->unshift_read (type => @args, $cb)	934	=item $handle->unshift_read (type => @args, $cb)
…		…
794	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	964	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
795	1	965	1
796	}	966	}
797	};	967	};
798		968
799	# compatibility with older API
800	sub push_read_chunk {
801	$_[0]->push_read (chunk => $_[1], $_[2]);
802	}
803
804	sub unshift_read_chunk {
805	$_[0]->unshift_read (chunk => $_[1], $_[2]);
806	}
807
808	=item line => [$eol, ]$cb->($handle, $line, $eol)	969	=item line => [$eol, ]$cb->($handle, $line, $eol)
809		970
810	The callback will be called only once a full line (including the end of	971	The callback will be called only once a full line (including the end of
811	line marker, C<$eol>) has been read. This line (excluding the end of line	972	line marker, C<$eol>) has been read. This line (excluding the end of line
812	marker) will be passed to the callback as second argument (C<$line>), and	973	marker) will be passed to the callback as second argument (C<$line>), and
…		…
827	=cut	988	=cut
828		989
829	register_read_type line => sub {	990	register_read_type line => sub {
830	my ($self, $cb, $eol) = @_;	991	my ($self, $cb, $eol) = @_;
831		992
832	$eol = qr|(\015?\012)| if @_ < 3;	993	if (@_ < 3) {
833	$eol = quotemeta $eol unless ref $eol;	994	# this is more than twice as fast as the generic code below
834	$eol = qr|^(.*?)($eol)|s;
835
836	sub {	995	sub {
837	$_[0]{rbuf} =~ s/$eol// or return;	996	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
838		997
839	$cb->($_[0], $1, $2);	998	$cb->($_[0], $1, $2);
840	1
841	}
842	};
843
844	# compatibility with older API
845	sub push_read_line {
846	my $self = shift;
847	$self->push_read (line => @_);
848	}
849
850	sub unshift_read_line {
851	my $self = shift;
852	$self->unshift_read (line => @_);
853	}
854
855	=item netstring => $cb->($handle, $string)
856
857	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
858
859	Throws an error with C<$!> set to EBADMSG on format violations.
860
861	=cut
862
863	register_read_type netstring => sub {
864	my ($self, $cb) = @_;
865
866	sub {
867	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
868	if ($_[0]{rbuf} =~ /[^0-9]/) {
869	$! = &Errno::EBADMSG;
870	$self->error;
871	}	999	1
872	return;
873	}	1000	}
		1001	} else {
		1002	$eol = quotemeta $eol unless ref $eol;
		1003	$eol = qr|^(.*?)($eol)|s;
874		1004
875	my $len = $1;	1005	sub {
		1006	$_[0]{rbuf} =~ s/$eol// or return;
876		1007
877	$self->unshift_read (chunk => $len, sub {	1008	$cb->($_[0], $1, $2);
878	my $string = $_[1];
879	$_[0]->unshift_read (chunk => 1, sub {
880	if ($_[1] eq ",") {
881	$cb->($_[0], $string);
882	} else {
883	$! = &Errno::EBADMSG;
884	$self->error;
885	}
886	});	1009	1
887	});	1010	}
888
889	1
890	}	1011	}
891	};	1012	};
892		1013
893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1014	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
894		1015
…		…
946	return 1;	1067	return 1;
947	}	1068	}
948		1069
949	# reject	1070	# reject
950	if ($reject && $$rbuf =~ $reject) {	1071	if ($reject && $$rbuf =~ $reject) {
951	$! = &Errno::EBADMSG;	1072	$self->_error (&Errno::EBADMSG);
952	$self->error;
953	}	1073	}
954		1074
955	# skip	1075	# skip
956	if ($skip && $$rbuf =~ $skip) {	1076	if ($skip && $$rbuf =~ $skip) {
957	$data .= substr $$rbuf, 0, $+[0], "";	1077	$data .= substr $$rbuf, 0, $+[0], "";
…		…
959		1079
960	()	1080	()
961	}	1081	}
962	};	1082	};
963		1083
		1084	=item netstring => $cb->($handle, $string)
		1085
		1086	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1087
		1088	Throws an error with C<$!> set to EBADMSG on format violations.
		1089
		1090	=cut
		1091
		1092	register_read_type netstring => sub {
		1093	my ($self, $cb) = @_;
		1094
		1095	sub {
		1096	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1097	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1098	$self->_error (&Errno::EBADMSG);
		1099	}
		1100	return;
		1101	}
		1102
		1103	my $len = $1;
		1104
		1105	$self->unshift_read (chunk => $len, sub {
		1106	my $string = $_[1];
		1107	$_[0]->unshift_read (chunk => 1, sub {
		1108	if ($_[1] eq ",") {
		1109	$cb->($_[0], $string);
		1110	} else {
		1111	$self->_error (&Errno::EBADMSG);
		1112	}
		1113	});
		1114	});
		1115
		1116	1
		1117	}
		1118	};
		1119
		1120	=item packstring => $format, $cb->($handle, $string)
		1121
		1122	An octet string prefixed with an encoded length. The encoding C<$format>
		1123	uses the same format as a Perl C<pack> format, but must specify a single
		1124	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1125	optional C<!>, C<< < >> or C<< > >> modifier).
		1126
		1127	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1128	EPP uses a prefix of C<N> (4 octtes).
		1129
		1130	Example: read a block of data prefixed by its length in BER-encoded
		1131	format (very efficient).
		1132
		1133	$handle->push_read (packstring => "w", sub {
		1134	my ($handle, $data) = @_;
		1135	});
		1136
		1137	=cut
		1138
		1139	register_read_type packstring => sub {
		1140	my ($self, $cb, $format) = @_;
		1141
		1142	sub {
		1143	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1144	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1145	or return;
		1146
		1147	$format = length pack $format, $len;
		1148
		1149	# bypass unshift if we already have the remaining chunk
		1150	if ($format + $len <= length $_[0]{rbuf}) {
		1151	my $data = substr $_[0]{rbuf}, $format, $len;
		1152	substr $_[0]{rbuf}, 0, $format + $len, "";
		1153	$cb->($_[0], $data);
		1154	} else {
		1155	# remove prefix
		1156	substr $_[0]{rbuf}, 0, $format, "";
		1157
		1158	# read remaining chunk
		1159	$_[0]->unshift_read (chunk => $len, $cb);
		1160	}
		1161
		1162	1
		1163	}
		1164	};
		1165
964	=item json => $cb->($handle, $hash_or_arrayref)	1166	=item json => $cb->($handle, $hash_or_arrayref)
965		1167
966	Reads a JSON object or array, decodes it and passes it to the callback.	1168	Reads a JSON object or array, decodes it and passes it to the
		1169	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
967		1170
968	If a C<json> object was passed to the constructor, then that will be used	1171	If a C<json> object was passed to the constructor, then that will be used
969	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1172	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
970		1173
971	This read type uses the incremental parser available with JSON version	1174	This read type uses the incremental parser available with JSON version
…		…
978	the C<json> write type description, above, for an actual example.	1181	the C<json> write type description, above, for an actual example.
979		1182
980	=cut	1183	=cut
981		1184
982	register_read_type json => sub {	1185	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1186	my ($self, $cb) = @_;
984		1187
985	require JSON;	1188	require JSON;
986		1189
987	my $data;	1190	my $data;
988	my $rbuf = \$self->{rbuf};	1191	my $rbuf = \$self->{rbuf};
989		1192
990	my $json = $self->{json} ||= JSON->new->utf8;	1193	my $json = $self->{json} ||= JSON->new->utf8;
991		1194
992	sub {	1195	sub {
993	my $ref = $json->incr_parse ($self->{rbuf});	1196	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
994		1197
995	if ($ref) {	1198	if ($ref) {
996	$self->{rbuf} = $json->incr_text;	1199	$self->{rbuf} = $json->incr_text;
997	$json->incr_text = "";	1200	$json->incr_text = "";
998	$cb->($self, $ref);	1201	$cb->($self, $ref);
999		1202
1000	1	1203	1
		1204	} elsif ($@) {
		1205	# error case
		1206	$json->incr_skip;
		1207
		1208	$self->{rbuf} = $json->incr_text;
		1209	$json->incr_text = "";
		1210
		1211	$self->_error (&Errno::EBADMSG);
		1212
		1213	()
1001	} else {	1214	} else {
1002	$self->{rbuf} = "";	1215	$self->{rbuf} = "";
		1216
1003	()	1217	()
1004	}	1218	}
		1219	}
		1220	};
		1221
		1222	=item storable => $cb->($handle, $ref)
		1223
		1224	Deserialises a L<Storable> frozen representation as written by the
		1225	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1226	data).
		1227
		1228	Raises C<EBADMSG> error if the data could not be decoded.
		1229
		1230	=cut
		1231
		1232	register_read_type storable => sub {
		1233	my ($self, $cb) = @_;
		1234
		1235	require Storable;
		1236
		1237	sub {
		1238	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1239	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1240	or return;
		1241
		1242	my $format = length pack "w", $len;
		1243
		1244	# bypass unshift if we already have the remaining chunk
		1245	if ($format + $len <= length $_[0]{rbuf}) {
		1246	my $data = substr $_[0]{rbuf}, $format, $len;
		1247	substr $_[0]{rbuf}, 0, $format + $len, "";
		1248	$cb->($_[0], Storable::thaw ($data));
		1249	} else {
		1250	# remove prefix
		1251	substr $_[0]{rbuf}, 0, $format, "";
		1252
		1253	# read remaining chunk
		1254	$_[0]->unshift_read (chunk => $len, sub {
		1255	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1256	$cb->($_[0], $ref);
		1257	} else {
		1258	$self->_error (&Errno::EBADMSG);
		1259	}
		1260	});
		1261	}
		1262
		1263	1
1005	}	1264	}
1006	};	1265	};
1007		1266
1008	=back	1267	=back
1009		1268
…		…
1030	=item $handle->stop_read	1289	=item $handle->stop_read
1031		1290
1032	=item $handle->start_read	1291	=item $handle->start_read
1033		1292
1034	In rare cases you actually do not want to read anything from the	1293	In rare cases you actually do not want to read anything from the
1035	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1294	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1036	any queued callbacks will be executed then. To start reading again, call	1295	any queued callbacks will be executed then. To start reading again, call
1037	C<start_read>.	1296	C<start_read>.
1038		1297
		1298	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1299	you change the C<on_read> callback or push/unshift a read callback, and it
		1300	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1301	there are any read requests in the queue.
		1302
		1303	These methods will have no effect when in TLS mode (as TLS doesn't support
		1304	half-duplex connections).
		1305
1039	=cut	1306	=cut
1040		1307
1041	sub stop_read {	1308	sub stop_read {
1042	my ($self) = @_;	1309	my ($self) = @_;
1043		1310
1044	delete $self->{_rw};	1311	delete $self->{_rw} unless $self->{tls};
1045	}	1312	}
1046		1313
1047	sub start_read {	1314	sub start_read {
1048	my ($self) = @_;	1315	my ($self) = @_;
1049		1316
1050	unless ($self->{_rw} || $self->{_eof}) {	1317	unless ($self->{_rw} || $self->{_eof}) {
1051	Scalar::Util::weaken $self;	1318	Scalar::Util::weaken $self;
1052		1319
1053	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1320	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1054	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1321	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1055	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1322	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1056		1323
1057	if ($len > 0) {	1324	if ($len > 0) {
1058	$self->{_activity} = AnyEvent->now;	1325	$self->{_activity} = AnyEvent->now;
1059		1326
1060	$self->{filter_r}	1327	if ($self->{tls}) {
1061	? $self->{filter_r}->($self, $rbuf)	1328	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1062	: $self->_drain_rbuf;	1329
		1330	&_dotls ($self);
		1331	} else {
		1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	}
1063		1334
1064	} elsif (defined $len) {	1335	} elsif (defined $len) {
1065	delete $self->{_rw};	1336	delete $self->{_rw};
1066	$self->{_eof} = 1;	1337	$self->{_eof} = 1;
1067	$self->_drain_rbuf;	1338	$self->_drain_rbuf unless $self->{_in_drain};
1068		1339
1069	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1340	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1070	return $self->error;	1341	return $self->_error ($!, 1);
1071	}	1342	}
1072	});	1343	});
1073	}	1344	}
1074	}	1345	}
1075		1346
		1347	# poll the write BIO and send the data if applicable
1076	sub _dotls {	1348	sub _dotls {
1077	my ($self) = @_;	1349	my ($self) = @_;
1078		1350
		1351	my $tmp;
		1352
1079	if (length $self->{_tls_wbuf}) {	1353	if (length $self->{_tls_wbuf}) {
1080	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1354	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1081	substr $self->{_tls_wbuf}, 0, $len, "";	1355	substr $self->{_tls_wbuf}, 0, $tmp, "";
1082	}	1356	}
1083	}	1357	}
1084		1358
		1359	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1360	unless (length $tmp) {
		1361	# let's treat SSL-eof as we treat normal EOF
		1362	delete $self->{_rw};
		1363	$self->{_eof} = 1;
		1364	&_freetls;
		1365	}
		1366
		1367	$self->{_tls_rbuf} .= $tmp;
		1368	$self->_drain_rbuf unless $self->{_in_drain};
		1369	$self->{tls} or return; # tls session might have gone away in callback
		1370	}
		1371
		1372	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1373
		1374	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
		1375	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
		1376	return $self->_error ($!, 1);
		1377	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
		1378	return $self->_error (&Errno::EIO, 1);
		1379	}
		1380
		1381	# all other errors are fine for our purposes
		1382	}
		1383
1085	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1384	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1086	$self->{wbuf} .= $buf;	1385	$self->{wbuf} .= $tmp;
1087	$self->_drain_wbuf;	1386	$self->_drain_wbuf;
1088	}
1089
1090	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
1091	$self->{rbuf} .= $buf;
1092	$self->_drain_rbuf;
1093	}
1094
1095	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1096
1097	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1098	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1099	$self->error;
1100	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1101	$! = &Errno::EIO;
1102	$self->error;
1103	}
1104
1105	# all others are fine for our purposes
1106	}	1387	}
1107	}	1388	}
1108		1389
1109	=item $handle->starttls ($tls[, $tls_ctx])	1390	=item $handle->starttls ($tls[, $tls_ctx])
1110		1391
…		…
1113	C<starttls>.	1394	C<starttls>.
1114		1395
1115	The first argument is the same as the C<tls> constructor argument (either	1396	The first argument is the same as the C<tls> constructor argument (either
1116	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1397	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1117		1398
1118	The second argument is the optional C<Net::SSLeay::CTX> object that is	1399	The second argument is the optional C<AnyEvent::TLS> object that is used
1119	used when AnyEvent::Handle has to create its own TLS connection object.	1400	when AnyEvent::Handle has to create its own TLS connection object, or
		1401	a hash reference with C<< key => value >> pairs that will be used to
		1402	construct a new context.
1120		1403
1121	The TLS connection object will end up in C<< $handle->{tls} >> after this	1404	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1122	call and can be used or changed to your liking. Note that the handshake	1405	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1123	might have already started when this function returns.	1406	changed to your liking. Note that the handshake might have already started
		1407	when this function returns.
1124		1408
1125	=cut	1409	If it an error to start a TLS handshake more than once per
		1410	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1126		1411
1127	# TODO: maybe document...	1412	=cut
		1413
1128	sub starttls {	1414	sub starttls {
1129	my ($self, $ssl, $ctx) = @_;	1415	my ($self, $ssl, $ctx) = @_;
1130		1416
1131	$self->stoptls;	1417	require Net::SSLeay;
1132		1418
1133	if ($ssl eq "accept") {	1419	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1134	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1420	if $self->{tls};
1135	Net::SSLeay::set_accept_state ($ssl);	1421
1136	} elsif ($ssl eq "connect") {	1422	$ctx ||= $self->{tls_ctx};
1137	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1423
1138	Net::SSLeay::set_connect_state ($ssl);	1424	if ("HASH" eq ref $ctx) {
		1425	require AnyEvent::TLS;
		1426
		1427	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1428	$ctx = new AnyEvent::TLS %$ctx;
		1429	}
1139	}	1430
1140		1431	$self->{tls_ctx} = $ctx || TLS_CTX ();
1141	$self->{tls} = $ssl;	1432	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self);
1142		1433
1143	# basically, this is deep magic (because SSL_read should have the same issues)	1434	# basically, this is deep magic (because SSL_read should have the same issues)
1144	# but the openssl maintainers basically said: "trust us, it just works".	1435	# but the openssl maintainers basically said: "trust us, it just works".
1145	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1436	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1146	# and mismaintained ssleay-module doesn't even offer them).	1437	# and mismaintained ssleay-module doesn't even offer them).
1147	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1438	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1439	#
		1440	# in short: this is a mess.
		1441	#
		1442	# note that we do not try to keep the length constant between writes as we are required to do.
		1443	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1444	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1445	# have identity issues in that area.
1148	Net::SSLeay::CTX_set_mode ($self->{tls},	1446	# Net::SSLeay::CTX_set_mode ($ssl,
1149	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1447	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1150	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1448	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1449	Net::SSLeay::CTX_set_mode ($ssl, 1|2);
1151		1450
1152	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1451	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1153	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1452	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1154		1453
1155	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1454	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1156		1455
1157	$self->{filter_w} = sub {	1456	&_dotls; # need to trigger the initial handshake
1158	$_[0]{_tls_wbuf} .= ${$_[1]};	1457	$self->start_read; # make sure we actually do read
1159	&_dotls;
1160	};
1161	$self->{filter_r} = sub {
1162	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1163	&_dotls;
1164	};
1165	}	1458	}
1166		1459
1167	=item $handle->stoptls	1460	=item $handle->stoptls
1168		1461
1169	Destroys the SSL connection, if any. Partial read or write data will be	1462	Shuts down the SSL connection - this makes a proper EOF handshake by
1170	lost.	1463	sending a close notify to the other side, but since OpenSSL doesn't
		1464	support non-blocking shut downs, it is not possible to re-use the stream
		1465	afterwards.
1171		1466
1172	=cut	1467	=cut
1173		1468
1174	sub stoptls {	1469	sub stoptls {
1175	my ($self) = @_;	1470	my ($self) = @_;
1176		1471
1177	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1472	if ($self->{tls}) {
		1473	Net::SSLeay::shutdown ($self->{tls});
1178		1474
1179	delete $self->{_rbio};	1475	&_dotls;
1180	delete $self->{_wbio};	1476
1181	delete $self->{_tls_wbuf};	1477	# we don't give a shit. no, we do, but we can't. no...
1182	delete $self->{filter_r};	1478	# we, we... have to use openssl :/
1183	delete $self->{filter_w};	1479	&_freetls;
		1480	}
		1481	}
		1482
		1483	sub _freetls {
		1484	my ($self) = @_;
		1485
		1486	return unless $self->{tls};
		1487
		1488	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1489
		1490	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1184	}	1491	}
1185		1492
1186	sub DESTROY {	1493	sub DESTROY {
1187	my $self = shift;	1494	my ($self) = @_;
1188		1495
1189	$self->stoptls;	1496	&_freetls;
		1497
		1498	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1499
		1500	if ($linger && length $self->{wbuf}) {
		1501	my $fh = delete $self->{fh};
		1502	my $wbuf = delete $self->{wbuf};
		1503
		1504	my @linger;
		1505
		1506	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1507	my $len = syswrite $fh, $wbuf, length $wbuf;
		1508
		1509	if ($len > 0) {
		1510	substr $wbuf, 0, $len, "";
		1511	} else {
		1512	@linger = (); # end
		1513	}
		1514	});
		1515	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1516	@linger = ();
		1517	});
		1518	}
		1519	}
		1520
		1521	=item $handle->destroy
		1522
		1523	Shuts down the handle object as much as possible - this call ensures that
		1524	no further callbacks will be invoked and resources will be freed as much
		1525	as possible. You must not call any methods on the object afterwards.
		1526
		1527	Normally, you can just "forget" any references to an AnyEvent::Handle
		1528	object and it will simply shut down. This works in fatal error and EOF
		1529	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1530	callback, so when you want to destroy the AnyEvent::Handle object from
		1531	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1532	that case.
		1533
		1534	The handle might still linger in the background and write out remaining
		1535	data, as specified by the C<linger> option, however.
		1536
		1537	=cut
		1538
		1539	sub destroy {
		1540	my ($self) = @_;
		1541
		1542	$self->DESTROY;
		1543	%$self = ();
1190	}	1544	}
1191		1545
1192	=item AnyEvent::Handle::TLS_CTX	1546	=item AnyEvent::Handle::TLS_CTX
1193		1547
1194	This function creates and returns the Net::SSLeay::CTX object used by	1548	This function creates and returns the AnyEvent::TLS object used by default
1195	default for TLS mode.	1549	for TLS mode.
1196		1550
1197	The context is created like this:	1551	The context is created by calling L<AnyEvent::TLS> without any arguments.
1198
1199	Net::SSLeay::load_error_strings;
1200	Net::SSLeay::SSLeay_add_ssl_algorithms;
1201	Net::SSLeay::randomize;
1202
1203	my $CTX = Net::SSLeay::CTX_new;
1204
1205	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1206		1552
1207	=cut	1553	=cut
1208		1554
1209	our $TLS_CTX;	1555	our $TLS_CTX;
1210		1556
1211	sub TLS_CTX() {	1557	sub TLS_CTX() {
1212	$TLS_CTX || do {	1558	$TLS_CTX ||= do {
1213	require Net::SSLeay;	1559	require AnyEvent::TLS;
1214		1560
1215	Net::SSLeay::load_error_strings ();	1561	new AnyEvent::TLS
1216	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1217	Net::SSLeay::randomize ();
1218
1219	$TLS_CTX = Net::SSLeay::CTX_new ();
1220
1221	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1222
1223	$TLS_CTX
1224	}	1562	}
1225	}	1563	}
1226		1564
1227	=back	1565	=back
		1566
		1567
		1568	=head1 NONFREQUENTLY ASKED QUESTIONS
		1569
		1570	=over 4
		1571
		1572	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1573	still get further invocations!
		1574
		1575	That's because AnyEvent::Handle keeps a reference to itself when handling
		1576	read or write callbacks.
		1577
		1578	It is only safe to "forget" the reference inside EOF or error callbacks,
		1579	from within all other callbacks, you need to explicitly call the C<<
		1580	->destroy >> method.
		1581
		1582	=item I get different callback invocations in TLS mode/Why can't I pause
		1583	reading?
		1584
		1585	Unlike, say, TCP, TLS connections do not consist of two independent
		1586	communication channels, one for each direction. Or put differently. The
		1587	read and write directions are not independent of each other: you cannot
		1588	write data unless you are also prepared to read, and vice versa.
		1589
		1590	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1591	callback invocations when you are not expecting any read data - the reason
		1592	is that AnyEvent::Handle always reads in TLS mode.
		1593
		1594	During the connection, you have to make sure that you always have a
		1595	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1596	connection (or when you no longer want to use it) you can call the
		1597	C<destroy> method.
		1598
		1599	=item How do I read data until the other side closes the connection?
		1600
		1601	If you just want to read your data into a perl scalar, the easiest way
		1602	to achieve this is by setting an C<on_read> callback that does nothing,
		1603	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1604	will be in C<$_[0]{rbuf}>:
		1605
		1606	$handle->on_read (sub { });
		1607	$handle->on_eof (undef);
		1608	$handle->on_error (sub {
		1609	my $data = delete $_[0]{rbuf};
		1610	undef $handle;
		1611	});
		1612
		1613	The reason to use C<on_error> is that TCP connections, due to latencies
		1614	and packets loss, might get closed quite violently with an error, when in
		1615	fact, all data has been received.
		1616
		1617	It is usually better to use acknowledgements when transferring data,
		1618	to make sure the other side hasn't just died and you got the data
		1619	intact. This is also one reason why so many internet protocols have an
		1620	explicit QUIT command.
		1621
		1622	=item I don't want to destroy the handle too early - how do I wait until
		1623	all data has been written?
		1624
		1625	After writing your last bits of data, set the C<on_drain> callback
		1626	and destroy the handle in there - with the default setting of
		1627	C<low_water_mark> this will be called precisely when all data has been
		1628	written to the socket:
		1629
		1630	$handle->push_write (...);
		1631	$handle->on_drain (sub {
		1632	warn "all data submitted to the kernel\n";
		1633	undef $handle;
		1634	});
		1635
		1636	=back
		1637
1228		1638
1229	=head1 SUBCLASSING AnyEvent::Handle	1639	=head1 SUBCLASSING AnyEvent::Handle
1230		1640
1231	In many cases, you might want to subclass AnyEvent::Handle.	1641	In many cases, you might want to subclass AnyEvent::Handle.
1232		1642
…		…
1236	=over 4	1646	=over 4
1237		1647
1238	=item * all constructor arguments become object members.	1648	=item * all constructor arguments become object members.
1239		1649
1240	At least initially, when you pass a C<tls>-argument to the constructor it	1650	At least initially, when you pass a C<tls>-argument to the constructor it
1241	will end up in C<< $handle->{tls} >>. Those members might be changes or	1651	will end up in C<< $handle->{tls} >>. Those members might be changed or
1242	mutated later on (for example C<tls> will hold the TLS connection object).	1652	mutated later on (for example C<tls> will hold the TLS connection object).
1243		1653
1244	=item * other object member names are prefixed with an C<_>.	1654	=item * other object member names are prefixed with an C<_>.
1245		1655
1246	All object members not explicitly documented (internal use) are prefixed	1656	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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