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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.46 by root, Thu May 29 00:22:36 2008 UTC vs.
Revision 1.96 by root, Thu Oct 2 08:10:27 2008 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.3;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
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
59	argument.	62	argument.
60		63
		64	=head2 SIGPIPE is not handled by this module
		65
		66	SIGPIPE is not handled by this module, so one of the practical
		67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
		68	'IGNORE'>). At least, this is highly recommend in a networked program: If
		69	you use AnyEvent::Handle in a filter program (like sort), exiting on
		70	SIGPIPE is probably the right thing to do.
		71
61	=head1 METHODS	72	=head1 METHODS
62		73
63	=over 4	74	=over 4
64		75
65	=item B<new (%args)>	76	=item B<new (%args)>
…		…
70		81
71	=item fh => $filehandle [MANDATORY]	82	=item fh => $filehandle [MANDATORY]
72		83
73	The filehandle this L<AnyEvent::Handle> object will operate on.	84	The filehandle this L<AnyEvent::Handle> object will operate on.
74		85
75	NOTE: The filehandle will be set to non-blocking (using	86	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		88	that mode.
77		89
78	=item on_eof => $cb->($handle)	90	=item on_eof => $cb->($handle)
79		91
80	Set the callback to be called on EOF.	92	Set the callback to be called when an end-of-file condition is detected,
		93	i.e. in the case of a socket, when the other side has closed the
		94	connection cleanly.
81		95
		96	For sockets, this just means that the other side has stopped sending data,
		97	you can still try to write data, and, in fact, one can return from the eof
		98	callback and continue writing data, as only the read part has been shut
		99	down.
		100
82	While not mandatory, it is highly recommended to set an eof callback,	101	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	102	otherwise you might end up with a closed socket while you are still
84	waiting for data.	103	waiting for data.
85		104
		105	If an EOF condition has been detected but no C<on_eof> callback has been
		106	set, then a fatal error will be raised with C<$!> set to <0>.
		107
86	=item on_error => $cb->($handle)	108	=item on_error => $cb->($handle, $fatal)
87		109
88	This is the fatal error callback, that is called when, well, a fatal error	110	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	111	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	112	connect or a read error.
91		113
92	The object will not be in a usable state when this callback has been	114	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	115	fatal errors the handle object will be shut down and will not be usable
		116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		117	errors are an EOF condition with active (but unsatisifable) read watchers
		118	(C<EPIPE>) or I/O errors.
		119
		120	Non-fatal errors can be retried by simply returning, but it is recommended
		121	to simply ignore this parameter and instead abondon the handle object
		122	when this callback is invoked. Examples of non-fatal errors are timeouts
		123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		124
95	On callback entrance, the value of C<$!> contains the operating system	125	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		127
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	128	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	129	you will not be notified of errors otherwise. The default simply calls
103	die.	130	C<croak>.
104		131
105	=item on_read => $cb->($handle)	132	=item on_read => $cb->($handle)
106		133
107	This sets the default read callback, which is called when data arrives	134	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	135	and no read request is in the queue (unlike read queue callbacks, this
		136	callback will only be called when at least one octet of data is in the
		137	read buffer).
109		138
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	140	method or access the C<$handle->{rbuf}> member directly.
112		141
113	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
…		…
120	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
121	(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).
122		151
123	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.
124		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
125	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
126		161
127	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
128	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
129	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
130	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
131		166
132	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
133	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
134	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
135	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
136		172
137	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
138		174
139	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
140		176
…		…
144		180
145	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
146		182
147	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>)
148	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
149	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
150		186
151	For example, a server accepting connections from untrusted sources should	187	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	188	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	189	(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	190	amount of data without a callback ever being called as long as the line
155	isn't finished).	191	isn't finished).
156		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
157	=item read_size => <bytes>	219	=item read_size => <bytes>
158		220
159	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
160	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
161		224
162	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
163		226
164	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
165	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
166	considered empty.	229	considered empty.
167		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
		236	=item linger => <seconds>
		237
		238	If non-zero (default: C<3600>), then the destructor of the
		239	AnyEvent::Handle object will check whether there is still outstanding
		240	write data and will install a watcher that will write this data to the
		241	socket. No errors will be reported (this mostly matches how the operating
		242	system treats outstanding data at socket close time).
		243
		244	This will not work for partial TLS data that could not be encoded
		245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
		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.
184		267
185	See the C<starttls> method if you need to start TLs negotiation later.	268	See the C<< ->starttls >> method for when need to start TLS negotiation later.
186		269
187	=item tls_ctx => $ssl_ctx	270	=item tls_ctx => $ssl_ctx
188		271
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	272	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	273	(unless a connection object was specified directly). If this parameter is
191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	274	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
192		275
193	=item json => JSON or JSON::XS object	276	=item json => JSON or JSON::XS object
194		277
195	This is the json coder object used by the C<json> read and write types.	278	This is the json coder object used by the C<json> read and write types.
196		279
197	If you don't supply it, then AnyEvent::Handle will create and use a	280	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.	281	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		282	texts.
199		283
200	Note that you are responsible to depend on the JSON module if you want to	284	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.	285	use this functionality, as AnyEvent does not have a dependency itself.
202		286
203	=item filter_r => $cb
204
205	=item filter_w => $cb
206
207	These exist, but are undocumented at this time.
208
209	=back	287	=back
210		288
211	=cut	289	=cut
212		290
213	sub new {	291	sub new {
…		…
217		295
218	$self->{fh} or Carp::croak "mandatory argument fh is missing";	296	$self->{fh} or Carp::croak "mandatory argument fh is missing";
219		297
220	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	298	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
221		299
222	if ($self->{tls}) {
223	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
225	}	301	if $self->{tls};
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		302
232	$self->{_activity} = AnyEvent->now;	303	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	304	$self->_timeout;
234		305
		306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		308
235	$self->start_read;	309	$self->start_read
		310	if $self->{on_read};
236		311
237	$self	312	$self
238	}	313	}
239		314
240	sub _shutdown {	315	sub _shutdown {
…		…
242		317
243	delete $self->{_tw};	318	delete $self->{_tw};
244	delete $self->{_rw};	319	delete $self->{_rw};
245	delete $self->{_ww};	320	delete $self->{_ww};
246	delete $self->{fh};	321	delete $self->{fh};
247	}
248		322
		323	&_freetls;
		324
		325	delete $self->{on_read};
		326	delete $self->{_queue};
		327	}
		328
249	sub error {	329	sub _error {
250	my ($self) = @_;	330	my ($self, $errno, $fatal) = @_;
251		331
252	{
253	local $!;
254	$self->_shutdown;	332	$self->_shutdown
255	}	333	if $fatal;
256		334
257	$self->{on_error}($self)	335	$! = $errno;
		336
258	if $self->{on_error};	337	if ($self->{on_error}) {
259		338	$self->{on_error}($self, $fatal);
		339	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	340	Carp::croak "AnyEvent::Handle uncaught error: $!";
		341	}
261	}	342	}
262		343
263	=item $fh = $handle->fh	344	=item $fh = $handle->fh
264		345
265	This method returns the file handle of the L<AnyEvent::Handle> object.	346	This method returns the file handle used to create the L<AnyEvent::Handle> object.
266		347
267	=cut	348	=cut
268		349
269	sub fh { $_[0]{fh} }	350	sub fh { $_[0]{fh} }
270		351
…		…
288	$_[0]{on_eof} = $_[1];	369	$_[0]{on_eof} = $_[1];
289	}	370	}
290		371
291	=item $handle->on_timeout ($cb)	372	=item $handle->on_timeout ($cb)
292		373
293	Replace the current C<on_timeout> callback, or disables the callback	374	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	375	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
295	argument.	376	argument and method.
296		377
297	=cut	378	=cut
298		379
299	sub on_timeout {	380	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	381	$_[0]{on_timeout} = $_[1];
		382	}
		383
		384	=item $handle->autocork ($boolean)
		385
		386	Enables or disables the current autocork behaviour (see C<autocork>
		387	constructor argument).
		388
		389	=cut
		390
		391	=item $handle->no_delay ($boolean)
		392
		393	Enables or disables the C<no_delay> setting (see constructor argument of
		394	the same name for details).
		395
		396	=cut
		397
		398	sub no_delay {
		399	$_[0]{no_delay} = $_[1];
		400
		401	eval {
		402	local $SIG{__DIE__};
		403	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		404	};
301	}	405	}
302		406
303	#############################################################################	407	#############################################################################
304		408
305	=item $handle->timeout ($seconds)	409	=item $handle->timeout ($seconds)
…		…
329	# now or in the past already?	433	# now or in the past already?
330	if ($after <= 0) {	434	if ($after <= 0) {
331	$self->{_activity} = $NOW;	435	$self->{_activity} = $NOW;
332		436
333	if ($self->{on_timeout}) {	437	if ($self->{on_timeout}) {
334	$self->{on_timeout}->($self);	438	$self->{on_timeout}($self);
335	} else {	439	} else {
336	$! = Errno::ETIMEDOUT;	440	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	441	}
339		442
340	# callbakx could have changed timeout value, optimise	443	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	444	return unless $self->{timeout};
342		445
343	# calculate new after	446	# calculate new after
344	$after = $self->{timeout};	447	$after = $self->{timeout};
345	}	448	}
346		449
347	Scalar::Util::weaken $self;	450	Scalar::Util::weaken $self;
		451	return unless $self; # ->error could have destroyed $self
348		452
349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	453	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	454	delete $self->{_tw};
351	$self->_timeout;	455	$self->_timeout;
352	});	456	});
…		…
383	my ($self, $cb) = @_;	487	my ($self, $cb) = @_;
384		488
385	$self->{on_drain} = $cb;	489	$self->{on_drain} = $cb;
386		490
387	$cb->($self)	491	$cb->($self)
388	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	492	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
389	}	493	}
390		494
391	=item $handle->push_write ($data)	495	=item $handle->push_write ($data)
392		496
393	Queues the given scalar to be written. You can push as much data as you	497	Queues the given scalar to be written. You can push as much data as you
…		…
410	substr $self->{wbuf}, 0, $len, "";	514	substr $self->{wbuf}, 0, $len, "";
411		515
412	$self->{_activity} = AnyEvent->now;	516	$self->{_activity} = AnyEvent->now;
413		517
414	$self->{on_drain}($self)	518	$self->{on_drain}($self)
415	if $self->{low_water_mark} >= length $self->{wbuf}	519	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
416	&& $self->{on_drain};	520	&& $self->{on_drain};
417		521
418	delete $self->{_ww} unless length $self->{wbuf};	522	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	524	$self->_error ($!, 1);
421	}	525	}
422	};	526	};
423		527
424	# try to write data immediately	528	# try to write data immediately
425	$cb->();	529	$cb->() unless $self->{autocork};
426		530
427	# if still data left in wbuf, we need to poll	531	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	532	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	533	if length $self->{wbuf};
430	};	534	};
…		…
444		548
445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	549	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
446	->($self, @_);	550	->($self, @_);
447	}	551	}
448		552
449	if ($self->{filter_w}) {	553	if ($self->{tls}) {
450	$self->{filter_w}->($self, \$_[0]);	554	$self->{_tls_wbuf} .= $_[0];
		555	&_dotls ($self);
451	} else {	556	} else {
452	$self->{wbuf} .= $_[0];	557	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	558	$self->_drain_wbuf;
454	}	559	}
455	}	560	}
456		561
457	=item $handle->push_write (type => @args)	562	=item $handle->push_write (type => @args)
458		563
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	564	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	565	the job by specifying a type and type-specific arguments.
463		566
464	Predefined types are (if you have ideas for additional types, feel free to	567	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	568	drop by and tell us):
…		…
469	=item netstring => $string	572	=item netstring => $string
470		573
471	Formats the given value as netstring	574	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	575	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		576
474	=back
475
476	=cut	577	=cut
477		578
478	register_write_type netstring => sub {	579	register_write_type netstring => sub {
479	my ($self, $string) = @_;	580	my ($self, $string) = @_;
480		581
481	sprintf "%d:%s,", (length $string), $string	582	(length $string) . ":$string,"
		583	};
		584
		585	=item packstring => $format, $data
		586
		587	An octet string prefixed with an encoded length. The encoding C<$format>
		588	uses the same format as a Perl C<pack> format, but must specify a single
		589	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		590	optional C<!>, C<< < >> or C<< > >> modifier).
		591
		592	=cut
		593
		594	register_write_type packstring => sub {
		595	my ($self, $format, $string) = @_;
		596
		597	pack "$format/a*", $string
482	};	598	};
483		599
484	=item json => $array_or_hashref	600	=item json => $array_or_hashref
485		601
486	Encodes the given hash or array reference into a JSON object. Unless you	602	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		636
521	$self->{json} ? $self->{json}->encode ($ref)	637	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	638	: JSON::encode_json ($ref)
523	};	639	};
524		640
		641	=item storable => $reference
		642
		643	Freezes the given reference using L<Storable> and writes it to the
		644	handle. Uses the C<nfreeze> format.
		645
		646	=cut
		647
		648	register_write_type storable => sub {
		649	my ($self, $ref) = @_;
		650
		651	require Storable;
		652
		653	pack "w/a*", Storable::nfreeze ($ref)
		654	};
		655
		656	=back
		657
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	658	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		659
527	This function (not method) lets you add your own types to C<push_write>.	660	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	661	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	662	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	682	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	683	a queue.
551		684
552	In the simple case, you just install an C<on_read> callback and whenever	685	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	686	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	687	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	688	leave the data there if you want to accumulate more (e.g. when only a
		689	partial message has been received so far).
556		690
557	In the more complex case, you want to queue multiple callbacks. In this	691	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	692	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>,	693	data arrives (also the first time it is queued) and removes it when it has
560	below).	694	done its job (see C<push_read>, below).
561		695
562	This way you can, for example, push three line-reads, followed by reading	696	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.	697	a chunk of data, and AnyEvent::Handle will execute them in order.
564		698
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	699	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	700	the specified number of bytes which give an XML datagram.
567		701
568	# in the default state, expect some header bytes	702	# in the default state, expect some header bytes
569	$handle->on_read (sub {	703	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	704	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	705	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	706	# header arrived, decode
573	my $len = unpack "N", $_[1];	707	my $len = unpack "N", $_[1];
574		708
575	# now read the payload	709	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	710	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	711	my $xml = $_[1];
578	# handle xml	712	# handle xml
579	});	713	});
580	});	714	});
581	});	715	});
582		716
583	Example 2: Implement a client for a protocol that replies either with	717	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	718	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	719	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	720	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	721	in the callbacks.
588		722
589	# request one	723	When the first callback is called and sees an "OK" response, it will
		724	C<unshift> another line-read. This line-read will be queued I<before> the
		725	64-byte chunk callback.
		726
		727	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	728	$handle->push_write ("request 1\015\012");
591		729
592	# we expect "ERROR" or "OK" as response, so push a line read	730	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	731	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	732	# 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	733	# 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	734	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	735	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	736	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	737	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	738	my $response = $_[1];
601	...	739	...
602	});	740	});
603	}	741	}
604	});	742	});
605		743
606	# request two	744	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	745	$handle->push_write ("request 2\015\012");
608		746
609	# simply read 64 bytes, always	747	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	748	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	749	my $response = $_[1];
612	...	750	...
613	});	751	});
614		752
615	=over 4	753	=over 4
616		754
617	=cut	755	=cut
618		756
619	sub _drain_rbuf {	757	sub _drain_rbuf {
620	my ($self) = @_;	758	my ($self) = @_;
		759
		760	local $self->{_in_drain} = 1;
621		761
622	if (	762	if (
623	defined $self->{rbuf_max}	763	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	764	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	765	) {
626	$! = &Errno::ENOSPC;	766	$self->_error (&Errno::ENOSPC, 1), return;
627	$self->error;
628	}	767	}
629		768
630	return if $self->{in_drain};	769	while () {
631	local $self->{in_drain} = 1;
632
633	while (my $len = length $self->{rbuf}) {	770	my $len = length $self->{rbuf};
634	no strict 'refs';	771
635	if (my $cb = shift @{ $self->{_queue} }) {	772	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	773	unless ($cb->($self)) {
637	if ($self->{_eof}) {	774	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	775	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	776	$self->_error (&Errno::EPIPE, 1), return;
640	$self->error;
641	}	777	}
642		778
643	unshift @{ $self->{_queue} }, $cb;	779	unshift @{ $self->{_queue} }, $cb;
644	return;	780	last;
645	}	781	}
646	} elsif ($self->{on_read}) {	782	} elsif ($self->{on_read}) {
		783	last unless $len;
		784
647	$self->{on_read}($self);	785	$self->{on_read}($self);
648		786
649	if (	787	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	788	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	789	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	790	&& $self->{on_read} # but we still have on_read
654	) {	791	) {
		792	# no further data will arrive
655	# then no progress can be made	793	# so no progress can be made
656	$! = &Errno::EPIPE;	794	$self->_error (&Errno::EPIPE, 1), return
657	$self->error;	795	if $self->{_eof};
		796
		797	last; # more data might arrive
658	}	798	}
659	} else {	799	} else {
660	# read side becomes idle	800	# read side becomes idle
661	delete $self->{_rw};	801	delete $self->{_rw} unless $self->{tls};
662	return;	802	last;
663	}	803	}
664	}	804	}
665		805
666	if ($self->{_eof}) {	806	if ($self->{_eof}) {
667	$self->_shutdown;	807	if ($self->{on_eof}) {
668	$self->{on_eof}($self)	808	$self->{on_eof}($self)
669	if $self->{on_eof};	809	} else {
		810	$self->_error (0, 1);
		811	}
		812	}
		813
		814	# may need to restart read watcher
		815	unless ($self->{_rw}) {
		816	$self->start_read
		817	if $self->{on_read} \|\| @{ $self->{_queue} };
670	}	818	}
671	}	819	}
672		820
673	=item $handle->on_read ($cb)	821	=item $handle->on_read ($cb)
674		822
…		…
680		828
681	sub on_read {	829	sub on_read {
682	my ($self, $cb) = @_;	830	my ($self, $cb) = @_;
683		831
684	$self->{on_read} = $cb;	832	$self->{on_read} = $cb;
		833	$self->_drain_rbuf if $cb && !$self->{_in_drain};
685	}	834	}
686		835
687	=item $handle->rbuf	836	=item $handle->rbuf
688		837
689	Returns the read buffer (as a modifiable lvalue).	838	Returns the read buffer (as a modifiable lvalue).
…		…
738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	887	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
739	->($self, $cb, @_);	888	->($self, $cb, @_);
740	}	889	}
741		890
742	push @{ $self->{_queue} }, $cb;	891	push @{ $self->{_queue} }, $cb;
743	$self->_drain_rbuf;	892	$self->_drain_rbuf unless $self->{_in_drain};
744	}	893	}
745		894
746	sub unshift_read {	895	sub unshift_read {
747	my $self = shift;	896	my $self = shift;
748	my $cb = pop;	897	my $cb = pop;
…		…
754	->($self, $cb, @_);	903	->($self, $cb, @_);
755	}	904	}
756		905
757		906
758	unshift @{ $self->{_queue} }, $cb;	907	unshift @{ $self->{_queue} }, $cb;
759	$self->_drain_rbuf;	908	$self->_drain_rbuf unless $self->{_in_drain};
760	}	909	}
761		910
762	=item $handle->push_read (type => @args, $cb)	911	=item $handle->push_read (type => @args, $cb)
763		912
764	=item $handle->unshift_read (type => @args, $cb)	913	=item $handle->unshift_read (type => @args, $cb)
…		…
794	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	943	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
795	1	944	1
796	}	945	}
797	};	946	};
798		947
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)	948	=item line => [$eol, ]$cb->($handle, $line, $eol)
809		949
810	The callback will be called only once a full line (including the end of	950	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	951	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	952	marker) will be passed to the callback as second argument (C<$line>), and
…		…
827	=cut	967	=cut
828		968
829	register_read_type line => sub {	969	register_read_type line => sub {
830	my ($self, $cb, $eol) = @_;	970	my ($self, $cb, $eol) = @_;
831		971
832	$eol = qr\|(\015?\012)\| if @_ < 3;	972	if (@_ < 3) {
833	$eol = quotemeta $eol unless ref $eol;	973	# this is more than twice as fast as the generic code below
834	$eol = qr\|^(.*?)($eol)\|s;
835
836	sub {	974	sub {
837	$_[0]{rbuf} =~ s/$eol// or return;	975	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
838		976
839	$cb->($_[0], $1, $2);	977	$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	}	978	1
872	return;
873	}	979	}
		980	} else {
		981	$eol = quotemeta $eol unless ref $eol;
		982	$eol = qr\|^(.*?)($eol)\|s;
874		983
875	my $len = $1;	984	sub {
		985	$_[0]{rbuf} =~ s/$eol// or return;
876		986
877	$self->unshift_read (chunk => $len, sub {	987	$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	});	988	1
887	});	989	}
888
889	1
890	}	990	}
891	};	991	};
892		992
893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	993	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
894		994
…		…
946	return 1;	1046	return 1;
947	}	1047	}
948		1048
949	# reject	1049	# reject
950	if ($reject && $$rbuf =~ $reject) {	1050	if ($reject && $$rbuf =~ $reject) {
951	$! = &Errno::EBADMSG;	1051	$self->_error (&Errno::EBADMSG);
952	$self->error;
953	}	1052	}
954		1053
955	# skip	1054	# skip
956	if ($skip && $$rbuf =~ $skip) {	1055	if ($skip && $$rbuf =~ $skip) {
957	$data .= substr $$rbuf, 0, $+[0], "";	1056	$data .= substr $$rbuf, 0, $+[0], "";
…		…
959		1058
960	()	1059	()
961	}	1060	}
962	};	1061	};
963		1062
		1063	=item netstring => $cb->($handle, $string)
		1064
		1065	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1066
		1067	Throws an error with C<$!> set to EBADMSG on format violations.
		1068
		1069	=cut
		1070
		1071	register_read_type netstring => sub {
		1072	my ($self, $cb) = @_;
		1073
		1074	sub {
		1075	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1076	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1077	$self->_error (&Errno::EBADMSG);
		1078	}
		1079	return;
		1080	}
		1081
		1082	my $len = $1;
		1083
		1084	$self->unshift_read (chunk => $len, sub {
		1085	my $string = $_[1];
		1086	$_[0]->unshift_read (chunk => 1, sub {
		1087	if ($_[1] eq ",") {
		1088	$cb->($_[0], $string);
		1089	} else {
		1090	$self->_error (&Errno::EBADMSG);
		1091	}
		1092	});
		1093	});
		1094
		1095	1
		1096	}
		1097	};
		1098
		1099	=item packstring => $format, $cb->($handle, $string)
		1100
		1101	An octet string prefixed with an encoded length. The encoding C<$format>
		1102	uses the same format as a Perl C<pack> format, but must specify a single
		1103	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1104	optional C<!>, C<< < >> or C<< > >> modifier).
		1105
		1106	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1107	EPP uses a prefix of C<N> (4 octtes).
		1108
		1109	Example: read a block of data prefixed by its length in BER-encoded
		1110	format (very efficient).
		1111
		1112	$handle->push_read (packstring => "w", sub {
		1113	my ($handle, $data) = @_;
		1114	});
		1115
		1116	=cut
		1117
		1118	register_read_type packstring => sub {
		1119	my ($self, $cb, $format) = @_;
		1120
		1121	sub {
		1122	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1123	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1124	or return;
		1125
		1126	$format = length pack $format, $len;
		1127
		1128	# bypass unshift if we already have the remaining chunk
		1129	if ($format + $len <= length $_[0]{rbuf}) {
		1130	my $data = substr $_[0]{rbuf}, $format, $len;
		1131	substr $_[0]{rbuf}, 0, $format + $len, "";
		1132	$cb->($_[0], $data);
		1133	} else {
		1134	# remove prefix
		1135	substr $_[0]{rbuf}, 0, $format, "";
		1136
		1137	# read remaining chunk
		1138	$_[0]->unshift_read (chunk => $len, $cb);
		1139	}
		1140
		1141	1
		1142	}
		1143	};
		1144
964	=item json => $cb->($handle, $hash_or_arrayref)	1145	=item json => $cb->($handle, $hash_or_arrayref)
965		1146
966	Reads a JSON object or array, decodes it and passes it to the callback.	1147	Reads a JSON object or array, decodes it and passes it to the callback.
967		1148
968	If a C<json> object was passed to the constructor, then that will be used	1149	If a C<json> object was passed to the constructor, then that will be used
…		…
978	the C<json> write type description, above, for an actual example.	1159	the C<json> write type description, above, for an actual example.
979		1160
980	=cut	1161	=cut
981		1162
982	register_read_type json => sub {	1163	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1164	my ($self, $cb) = @_;
984		1165
985	require JSON;	1166	require JSON;
986		1167
987	my $data;	1168	my $data;
988	my $rbuf = \$self->{rbuf};	1169	my $rbuf = \$self->{rbuf};
…		…
1003	()	1184	()
1004	}	1185	}
1005	}	1186	}
1006	};	1187	};
1007		1188
		1189	=item storable => $cb->($handle, $ref)
		1190
		1191	Deserialises a L<Storable> frozen representation as written by the
		1192	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1193	data).
		1194
		1195	Raises C<EBADMSG> error if the data could not be decoded.
		1196
		1197	=cut
		1198
		1199	register_read_type storable => sub {
		1200	my ($self, $cb) = @_;
		1201
		1202	require Storable;
		1203
		1204	sub {
		1205	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1206	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1207	or return;
		1208
		1209	my $format = length pack "w", $len;
		1210
		1211	# bypass unshift if we already have the remaining chunk
		1212	if ($format + $len <= length $_[0]{rbuf}) {
		1213	my $data = substr $_[0]{rbuf}, $format, $len;
		1214	substr $_[0]{rbuf}, 0, $format + $len, "";
		1215	$cb->($_[0], Storable::thaw ($data));
		1216	} else {
		1217	# remove prefix
		1218	substr $_[0]{rbuf}, 0, $format, "";
		1219
		1220	# read remaining chunk
		1221	$_[0]->unshift_read (chunk => $len, sub {
		1222	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1223	$cb->($_[0], $ref);
		1224	} else {
		1225	$self->_error (&Errno::EBADMSG);
		1226	}
		1227	});
		1228	}
		1229
		1230	1
		1231	}
		1232	};
		1233
1008	=back	1234	=back
1009		1235
1010	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1236	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1011		1237
1012	This function (not method) lets you add your own types to C<push_read>.	1238	This function (not method) lets you add your own types to C<push_read>.
…		…
1030	=item $handle->stop_read	1256	=item $handle->stop_read
1031		1257
1032	=item $handle->start_read	1258	=item $handle->start_read
1033		1259
1034	In rare cases you actually do not want to read anything from the	1260	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	1261	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	1262	any queued callbacks will be executed then. To start reading again, call
1037	C<start_read>.	1263	C<start_read>.
1038		1264
		1265	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1266	you change the C<on_read> callback or push/unshift a read callback, and it
		1267	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1268	there are any read requests in the queue.
		1269
		1270	These methods will have no effect when in TLS mode (as TLS doesn't support
		1271	half-duplex connections).
		1272
1039	=cut	1273	=cut
1040		1274
1041	sub stop_read {	1275	sub stop_read {
1042	my ($self) = @_;	1276	my ($self) = @_;
1043		1277
1044	delete $self->{_rw};	1278	delete $self->{_rw} unless $self->{tls};
1045	}	1279	}
1046		1280
1047	sub start_read {	1281	sub start_read {
1048	my ($self) = @_;	1282	my ($self) = @_;
1049		1283
1050	unless ($self->{_rw} \|\| $self->{_eof}) {	1284	unless ($self->{_rw} \|\| $self->{_eof}) {
1051	Scalar::Util::weaken $self;	1285	Scalar::Util::weaken $self;
1052		1286
1053	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1287	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1054	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1288	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1055	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1289	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1056		1290
1057	if ($len > 0) {	1291	if ($len > 0) {
1058	$self->{_activity} = AnyEvent->now;	1292	$self->{_activity} = AnyEvent->now;
1059		1293
1060	$self->{filter_r}	1294	if ($self->{tls}) {
1061	? $self->{filter_r}->($self, $rbuf)	1295	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1062	: $self->_drain_rbuf;	1296	&_dotls ($self);
		1297	} else {
		1298	$self->_drain_rbuf unless $self->{_in_drain};
		1299	}
1063		1300
1064	} elsif (defined $len) {	1301	} elsif (defined $len) {
1065	delete $self->{_rw};	1302	delete $self->{_rw};
1066	delete $self->{_ww};
1067	delete $self->{_tw};
1068	$self->{_eof} = 1;	1303	$self->{_eof} = 1;
1069	$self->_drain_rbuf;	1304	$self->_drain_rbuf unless $self->{_in_drain};
1070		1305
1071	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1072	return $self->error;	1307	return $self->_error ($!, 1);
1073	}	1308	}
1074	});	1309	});
1075	}	1310	}
1076	}	1311	}
1077		1312
1078	sub _dotls {	1313	sub _dotls {
1079	my ($self) = @_;	1314	my ($self) = @_;
		1315
		1316	my $buf;
1080		1317
1081	if (length $self->{_tls_wbuf}) {	1318	if (length $self->{_tls_wbuf}) {
1082	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1083	substr $self->{_tls_wbuf}, 0, $len, "";	1320	substr $self->{_tls_wbuf}, 0, $len, "";
1084	}	1321	}
1085	}	1322	}
1086		1323
		1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1325	unless (length $buf) {
		1326	# let's treat SSL-eof as we treat normal EOF
		1327	delete $self->{_rw};
		1328	$self->{_eof} = 1;
		1329	&_freetls;
		1330	}
		1331
		1332	$self->{rbuf} .= $buf;
		1333	$self->_drain_rbuf unless $self->{_in_drain};
		1334	$self->{tls} or return; # tls session might have gone away in callback
		1335	}
		1336
		1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		1338
		1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
		1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
		1341	return $self->_error ($!, 1);
		1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
		1343	return $self->_error (&Errno::EIO, 1);
		1344	}
		1345
		1346	# all others are fine for our purposes
		1347	}
		1348
1087	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1349	while (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1088	$self->{wbuf} .= $buf;	1350	$self->{wbuf} .= $buf;
1089	$self->_drain_wbuf;	1351	$self->_drain_wbuf;
1090	}
1091
1092	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
1093	$self->{rbuf} .= $buf;
1094	$self->_drain_rbuf;
1095	}
1096
1097	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1098
1099	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1100	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1101	$self->error;
1102	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1103	$! = &Errno::EIO;
1104	$self->error;
1105	}
1106
1107	# all others are fine for our purposes
1108	}	1352	}
1109	}	1353	}
1110		1354
1111	=item $handle->starttls ($tls[, $tls_ctx])	1355	=item $handle->starttls ($tls[, $tls_ctx])
1112		1356
…		…
1122		1366
1123	The TLS connection object will end up in C<< $handle->{tls} >> after this	1367	The TLS connection object will end up in C<< $handle->{tls} >> after this
1124	call and can be used or changed to your liking. Note that the handshake	1368	call and can be used or changed to your liking. Note that the handshake
1125	might have already started when this function returns.	1369	might have already started when this function returns.
1126		1370
1127	=cut	1371	If it an error to start a TLS handshake more than once per
		1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1128		1373
1129	# TODO: maybe document...	1374	=cut
		1375
1130	sub starttls {	1376	sub starttls {
1131	my ($self, $ssl, $ctx) = @_;	1377	my ($self, $ssl, $ctx) = @_;
1132		1378
1133	$self->stoptls;	1379	require Net::SSLeay;
1134		1380
		1381	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
		1382	if $self->{tls};
		1383
1135	if ($ssl eq "accept") {	1384	if ($ssl eq "accept") {
1136	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1385	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1137	Net::SSLeay::set_accept_state ($ssl);	1386	Net::SSLeay::set_accept_state ($ssl);
1138	} elsif ($ssl eq "connect") {	1387	} elsif ($ssl eq "connect") {
1139	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1388	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1145	# basically, this is deep magic (because SSL_read should have the same issues)	1394	# basically, this is deep magic (because SSL_read should have the same issues)
1146	# but the openssl maintainers basically said: "trust us, it just works".	1395	# but the openssl maintainers basically said: "trust us, it just works".
1147	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1396	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1148	# and mismaintained ssleay-module doesn't even offer them).	1397	# and mismaintained ssleay-module doesn't even offer them).
1149	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1398	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1399	#
		1400	# in short: this is a mess.
		1401	#
		1402	# note that we do not try to keep the length constant between writes as we are required to do.
		1403	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1404	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1405	# have identity issues in that area.
1150	Net::SSLeay::CTX_set_mode ($self->{tls},	1406	Net::SSLeay::CTX_set_mode ($self->{tls},
1151	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1407	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1152	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1408	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1153		1409
1154	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1410	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1155	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1411	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1156		1412
1157	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1413	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1158		1414
1159	$self->{filter_w} = sub {	1415	&_dotls; # need to trigger the initial handshake
1160	$_[0]{_tls_wbuf} .= ${$_[1]};	1416	$self->start_read; # make sure we actually do read
1161	&_dotls;
1162	};
1163	$self->{filter_r} = sub {
1164	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1165	&_dotls;
1166	};
1167	}	1417	}
1168		1418
1169	=item $handle->stoptls	1419	=item $handle->stoptls
1170		1420
1171	Destroys the SSL connection, if any. Partial read or write data will be	1421	Shuts down the SSL connection - this makes a proper EOF handshake by
1172	lost.	1422	sending a close notify to the other side, but since OpenSSL doesn't
		1423	support non-blocking shut downs, it is not possible to re-use the stream
		1424	afterwards.
1173		1425
1174	=cut	1426	=cut
1175		1427
1176	sub stoptls {	1428	sub stoptls {
1177	my ($self) = @_;	1429	my ($self) = @_;
1178		1430
		1431	if ($self->{tls}) {
		1432	Net::SSLeay::shutdown ($self->{tls});
		1433
		1434	&_dotls;
		1435
		1436	# we don't give a shit. no, we do, but we can't. no...
		1437	# we, we... have to use openssl :/
		1438	&_freetls;
		1439	}
		1440	}
		1441
		1442	sub _freetls {
		1443	my ($self) = @_;
		1444
		1445	return unless $self->{tls};
		1446
1179	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1447	Net::SSLeay::free (delete $self->{tls});
1180		1448
1181	delete $self->{_rbio};	1449	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1182	delete $self->{_wbio};
1183	delete $self->{_tls_wbuf};
1184	delete $self->{filter_r};
1185	delete $self->{filter_w};
1186	}	1450	}
1187		1451
1188	sub DESTROY {	1452	sub DESTROY {
1189	my $self = shift;	1453	my $self = shift;
1190		1454
1191	$self->stoptls;	1455	&_freetls;
		1456
		1457	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1458
		1459	if ($linger && length $self->{wbuf}) {
		1460	my $fh = delete $self->{fh};
		1461	my $wbuf = delete $self->{wbuf};
		1462
		1463	my @linger;
		1464
		1465	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1466	my $len = syswrite $fh, $wbuf, length $wbuf;
		1467
		1468	if ($len > 0) {
		1469	substr $wbuf, 0, $len, "";
		1470	} else {
		1471	@linger = (); # end
		1472	}
		1473	});
		1474	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1475	@linger = ();
		1476	});
		1477	}
1192	}	1478	}
1193		1479
1194	=item AnyEvent::Handle::TLS_CTX	1480	=item AnyEvent::Handle::TLS_CTX
1195		1481
1196	This function creates and returns the Net::SSLeay::CTX object used by	1482	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1226	}	1512	}
1227	}	1513	}
1228		1514
1229	=back	1515	=back
1230		1516
		1517
		1518	=head1 NONFREQUENTLY ASKED QUESTIONS
		1519
		1520	=over 4
		1521
		1522	=item How do I read data until the other side closes the connection?
		1523
		1524	If you just want to read your data into a perl scalar, the easiest way
		1525	to achieve this is by setting an C<on_read> callback that does nothing,
		1526	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1527	will be in C<$_[0]{rbuf}>:
		1528
		1529	$handle->on_read (sub { });
		1530	$handle->on_eof (undef);
		1531	$handle->on_error (sub {
		1532	my $data = delete $_[0]{rbuf};
		1533	undef $handle;
		1534	});
		1535
		1536	The reason to use C<on_error> is that TCP connections, due to latencies
		1537	and packets loss, might get closed quite violently with an error, when in
		1538	fact, all data has been received.
		1539
		1540	It is usually better to use acknowledgements when transfering data,
		1541	to make sure the other side hasn't just died and you got the data
		1542	intact. This is also one reason why so many internet protocols have an
		1543	explicit QUIT command.
		1544
		1545
		1546	=item I don't want to destroy the handle too early - how do I wait until
		1547	all data has been written?
		1548
		1549	After writing your last bits of data, set the C<on_drain> callback
		1550	and destroy the handle in there - with the default setting of
		1551	C<low_water_mark> this will be called precisely when all data has been
		1552	written to the socket:
		1553
		1554	$handle->push_write (...);
		1555	$handle->on_drain (sub {
		1556	warn "all data submitted to the kernel\n";
		1557	undef $handle;
		1558	});
		1559
		1560	=back
		1561
		1562
1231	=head1 SUBCLASSING AnyEvent::Handle	1563	=head1 SUBCLASSING AnyEvent::Handle
1232		1564
1233	In many cases, you might want to subclass AnyEvent::Handle.	1565	In many cases, you might want to subclass AnyEvent::Handle.
1234		1566
1235	To make this easier, a given version of AnyEvent::Handle uses these	1567	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1238	=over 4	1570	=over 4
1239		1571
1240	=item * all constructor arguments become object members.	1572	=item * all constructor arguments become object members.
1241		1573
1242	At least initially, when you pass a C<tls>-argument to the constructor it	1574	At least initially, when you pass a C<tls>-argument to the constructor it
1243	will end up in C<< $handle->{tls} >>. Those members might be changes or	1575	will end up in C<< $handle->{tls} >>. Those members might be changed or
1244	mutated later on (for example C<tls> will hold the TLS connection object).	1576	mutated later on (for example C<tls> will hold the TLS connection object).
1245		1577
1246	=item * other object member names are prefixed with an C<_>.	1578	=item * other object member names are prefixed with an C<_>.
1247		1579
1248	All object members not explicitly documented (internal use) are prefixed	1580	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.46 by root, Thu May 29 00:22:36 2008 UTC vs. Revision 1.96 by root, Thu Oct 2 08:10:27 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.46 by root, Thu May 29 00:22:36 2008 UTC vs.
Revision 1.96 by root, Thu Oct 2 08:10:27 2008 UTC