[ViewVC] Diff of: 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.97 by root, Thu Oct 2 11:07:59 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
		556	&_dotls ($self);
451	} else {	557	} else {
452	$self->{wbuf} .= $_[0];	558	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	559	$self->_drain_wbuf;
454	}	560	}
455	}	561	}
456		562
457	=item $handle->push_write (type => @args)	563	=item $handle->push_write (type => @args)
458		564
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	565	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	566	the job by specifying a type and type-specific arguments.
463		567
464	Predefined types are (if you have ideas for additional types, feel free to	568	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	569	drop by and tell us):
…		…
469	=item netstring => $string	573	=item netstring => $string
470		574
471	Formats the given value as netstring	575	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	576	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		577
474	=back
475
476	=cut	578	=cut
477		579
478	register_write_type netstring => sub {	580	register_write_type netstring => sub {
479	my ($self, $string) = @_;	581	my ($self, $string) = @_;
480		582
481	sprintf "%d:%s,", (length $string), $string	583	(length $string) . ":$string,"
		584	};
		585
		586	=item packstring => $format, $data
		587
		588	An octet string prefixed with an encoded length. The encoding C<$format>
		589	uses the same format as a Perl C<pack> format, but must specify a single
		590	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		591	optional C<!>, C<< < >> or C<< > >> modifier).
		592
		593	=cut
		594
		595	register_write_type packstring => sub {
		596	my ($self, $format, $string) = @_;
		597
		598	pack "$format/a*", $string
482	};	599	};
483		600
484	=item json => $array_or_hashref	601	=item json => $array_or_hashref
485		602
486	Encodes the given hash or array reference into a JSON object. Unless you	603	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		637
521	$self->{json} ? $self->{json}->encode ($ref)	638	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	639	: JSON::encode_json ($ref)
523	};	640	};
524		641
		642	=item storable => $reference
		643
		644	Freezes the given reference using L<Storable> and writes it to the
		645	handle. Uses the C<nfreeze> format.
		646
		647	=cut
		648
		649	register_write_type storable => sub {
		650	my ($self, $ref) = @_;
		651
		652	require Storable;
		653
		654	pack "w/a*", Storable::nfreeze ($ref)
		655	};
		656
		657	=back
		658
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	659	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		660
527	This function (not method) lets you add your own types to C<push_write>.	661	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	662	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	663	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	683	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	684	a queue.
551		685
552	In the simple case, you just install an C<on_read> callback and whenever	686	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	687	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	688	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	689	leave the data there if you want to accumulate more (e.g. when only a
		690	partial message has been received so far).
556		691
557	In the more complex case, you want to queue multiple callbacks. In this	692	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	693	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>,	694	data arrives (also the first time it is queued) and removes it when it has
560	below).	695	done its job (see C<push_read>, below).
561		696
562	This way you can, for example, push three line-reads, followed by reading	697	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.	698	a chunk of data, and AnyEvent::Handle will execute them in order.
564		699
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	700	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	701	the specified number of bytes which give an XML datagram.
567		702
568	# in the default state, expect some header bytes	703	# in the default state, expect some header bytes
569	$handle->on_read (sub {	704	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	705	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	706	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	707	# header arrived, decode
573	my $len = unpack "N", $_[1];	708	my $len = unpack "N", $_[1];
574		709
575	# now read the payload	710	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	711	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	712	my $xml = $_[1];
578	# handle xml	713	# handle xml
579	});	714	});
580	});	715	});
581	});	716	});
582		717
583	Example 2: Implement a client for a protocol that replies either with	718	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	719	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	720	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	721	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	722	in the callbacks.
588		723
589	# request one	724	When the first callback is called and sees an "OK" response, it will
		725	C<unshift> another line-read. This line-read will be queued I<before> the
		726	64-byte chunk callback.
		727
		728	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	729	$handle->push_write ("request 1\015\012");
591		730
592	# we expect "ERROR" or "OK" as response, so push a line read	731	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	732	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	733	# 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	734	# 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	735	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	736	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	737	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	738	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	739	my $response = $_[1];
601	...	740	...
602	});	741	});
603	}	742	}
604	});	743	});
605		744
606	# request two	745	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	746	$handle->push_write ("request 2\015\012");
608		747
609	# simply read 64 bytes, always	748	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	749	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	750	my $response = $_[1];
612	...	751	...
613	});	752	});
614		753
615	=over 4	754	=over 4
616		755
617	=cut	756	=cut
618		757
619	sub _drain_rbuf {	758	sub _drain_rbuf {
620	my ($self) = @_;	759	my ($self) = @_;
		760
		761	local $self->{_in_drain} = 1;
621		762
622	if (	763	if (
623	defined $self->{rbuf_max}	764	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	765	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	766	) {
626	$! = &Errno::ENOSPC;	767	$self->_error (&Errno::ENOSPC, 1), return;
627	$self->error;
628	}	768	}
629		769
630	return if $self->{in_drain};	770	while () {
631	local $self->{in_drain} = 1;
632
633	while (my $len = length $self->{rbuf}) {	771	my $len = length $self->{rbuf};
634	no strict 'refs';	772
635	if (my $cb = shift @{ $self->{_queue} }) {	773	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	774	unless ($cb->($self)) {
637	if ($self->{_eof}) {	775	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	776	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	777	$self->_error (&Errno::EPIPE, 1), return;
640	$self->error;
641	}	778	}
642		779
643	unshift @{ $self->{_queue} }, $cb;	780	unshift @{ $self->{_queue} }, $cb;
644	return;	781	last;
645	}	782	}
646	} elsif ($self->{on_read}) {	783	} elsif ($self->{on_read}) {
		784	last unless $len;
		785
647	$self->{on_read}($self);	786	$self->{on_read}($self);
648		787
649	if (	788	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	789	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	790	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	791	&& $self->{on_read} # but we still have on_read
654	) {	792	) {
		793	# no further data will arrive
655	# then no progress can be made	794	# so no progress can be made
656	$! = &Errno::EPIPE;	795	$self->_error (&Errno::EPIPE, 1), return
657	$self->error;	796	if $self->{_eof};
		797
		798	last; # more data might arrive
658	}	799	}
659	} else {	800	} else {
660	# read side becomes idle	801	# read side becomes idle
661	delete $self->{_rw};	802	delete $self->{_rw} unless $self->{tls};
662	return;	803	last;
663	}	804	}
664	}	805	}
665		806
666	if ($self->{_eof}) {	807	if ($self->{_eof}) {
667	$self->_shutdown;	808	if ($self->{on_eof}) {
668	$self->{on_eof}($self)	809	$self->{on_eof}($self)
669	if $self->{on_eof};	810	} else {
		811	$self->_error (0, 1);
		812	}
		813	}
		814
		815	# may need to restart read watcher
		816	unless ($self->{_rw}) {
		817	$self->start_read
		818	if $self->{on_read} \|\| @{ $self->{_queue} };
670	}	819	}
671	}	820	}
672		821
673	=item $handle->on_read ($cb)	822	=item $handle->on_read ($cb)
674		823
…		…
680		829
681	sub on_read {	830	sub on_read {
682	my ($self, $cb) = @_;	831	my ($self, $cb) = @_;
683		832
684	$self->{on_read} = $cb;	833	$self->{on_read} = $cb;
		834	$self->_drain_rbuf if $cb && !$self->{_in_drain};
685	}	835	}
686		836
687	=item $handle->rbuf	837	=item $handle->rbuf
688		838
689	Returns the read buffer (as a modifiable lvalue).	839	Returns the read buffer (as a modifiable lvalue).
…		…
738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	888	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
739	->($self, $cb, @_);	889	->($self, $cb, @_);
740	}	890	}
741		891
742	push @{ $self->{_queue} }, $cb;	892	push @{ $self->{_queue} }, $cb;
743	$self->_drain_rbuf;	893	$self->_drain_rbuf unless $self->{_in_drain};
744	}	894	}
745		895
746	sub unshift_read {	896	sub unshift_read {
747	my $self = shift;	897	my $self = shift;
748	my $cb = pop;	898	my $cb = pop;
…		…
754	->($self, $cb, @_);	904	->($self, $cb, @_);
755	}	905	}
756		906
757		907
758	unshift @{ $self->{_queue} }, $cb;	908	unshift @{ $self->{_queue} }, $cb;
759	$self->_drain_rbuf;	909	$self->_drain_rbuf unless $self->{_in_drain};
760	}	910	}
761		911
762	=item $handle->push_read (type => @args, $cb)	912	=item $handle->push_read (type => @args, $cb)
763		913
764	=item $handle->unshift_read (type => @args, $cb)	914	=item $handle->unshift_read (type => @args, $cb)
…		…
794	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	944	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
795	1	945	1
796	}	946	}
797	};	947	};
798		948
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)	949	=item line => [$eol, ]$cb->($handle, $line, $eol)
809		950
810	The callback will be called only once a full line (including the end of	951	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	952	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	953	marker) will be passed to the callback as second argument (C<$line>), and
…		…
827	=cut	968	=cut
828		969
829	register_read_type line => sub {	970	register_read_type line => sub {
830	my ($self, $cb, $eol) = @_;	971	my ($self, $cb, $eol) = @_;
831		972
832	$eol = qr\|(\015?\012)\| if @_ < 3;	973	if (@_ < 3) {
833	$eol = quotemeta $eol unless ref $eol;	974	# this is more than twice as fast as the generic code below
834	$eol = qr\|^(.*?)($eol)\|s;
835
836	sub {	975	sub {
837	$_[0]{rbuf} =~ s/$eol// or return;	976	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
838		977
839	$cb->($_[0], $1, $2);	978	$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	}	979	1
872	return;
873	}	980	}
		981	} else {
		982	$eol = quotemeta $eol unless ref $eol;
		983	$eol = qr\|^(.*?)($eol)\|s;
874		984
875	my $len = $1;	985	sub {
		986	$_[0]{rbuf} =~ s/$eol// or return;
876		987
877	$self->unshift_read (chunk => $len, sub {	988	$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	});	989	1
887	});	990	}
888
889	1
890	}	991	}
891	};	992	};
892		993
893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	994	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
894		995
…		…
946	return 1;	1047	return 1;
947	}	1048	}
948		1049
949	# reject	1050	# reject
950	if ($reject && $$rbuf =~ $reject) {	1051	if ($reject && $$rbuf =~ $reject) {
951	$! = &Errno::EBADMSG;	1052	$self->_error (&Errno::EBADMSG);
952	$self->error;
953	}	1053	}
954		1054
955	# skip	1055	# skip
956	if ($skip && $$rbuf =~ $skip) {	1056	if ($skip && $$rbuf =~ $skip) {
957	$data .= substr $$rbuf, 0, $+[0], "";	1057	$data .= substr $$rbuf, 0, $+[0], "";
…		…
959		1059
960	()	1060	()
961	}	1061	}
962	};	1062	};
963		1063
		1064	=item netstring => $cb->($handle, $string)
		1065
		1066	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1067
		1068	Throws an error with C<$!> set to EBADMSG on format violations.
		1069
		1070	=cut
		1071
		1072	register_read_type netstring => sub {
		1073	my ($self, $cb) = @_;
		1074
		1075	sub {
		1076	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1077	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1078	$self->_error (&Errno::EBADMSG);
		1079	}
		1080	return;
		1081	}
		1082
		1083	my $len = $1;
		1084
		1085	$self->unshift_read (chunk => $len, sub {
		1086	my $string = $_[1];
		1087	$_[0]->unshift_read (chunk => 1, sub {
		1088	if ($_[1] eq ",") {
		1089	$cb->($_[0], $string);
		1090	} else {
		1091	$self->_error (&Errno::EBADMSG);
		1092	}
		1093	});
		1094	});
		1095
		1096	1
		1097	}
		1098	};
		1099
		1100	=item packstring => $format, $cb->($handle, $string)
		1101
		1102	An octet string prefixed with an encoded length. The encoding C<$format>
		1103	uses the same format as a Perl C<pack> format, but must specify a single
		1104	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1105	optional C<!>, C<< < >> or C<< > >> modifier).
		1106
		1107	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1108	EPP uses a prefix of C<N> (4 octtes).
		1109
		1110	Example: read a block of data prefixed by its length in BER-encoded
		1111	format (very efficient).
		1112
		1113	$handle->push_read (packstring => "w", sub {
		1114	my ($handle, $data) = @_;
		1115	});
		1116
		1117	=cut
		1118
		1119	register_read_type packstring => sub {
		1120	my ($self, $cb, $format) = @_;
		1121
		1122	sub {
		1123	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1124	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1125	or return;
		1126
		1127	$format = length pack $format, $len;
		1128
		1129	# bypass unshift if we already have the remaining chunk
		1130	if ($format + $len <= length $_[0]{rbuf}) {
		1131	my $data = substr $_[0]{rbuf}, $format, $len;
		1132	substr $_[0]{rbuf}, 0, $format + $len, "";
		1133	$cb->($_[0], $data);
		1134	} else {
		1135	# remove prefix
		1136	substr $_[0]{rbuf}, 0, $format, "";
		1137
		1138	# read remaining chunk
		1139	$_[0]->unshift_read (chunk => $len, $cb);
		1140	}
		1141
		1142	1
		1143	}
		1144	};
		1145
964	=item json => $cb->($handle, $hash_or_arrayref)	1146	=item json => $cb->($handle, $hash_or_arrayref)
965		1147
966	Reads a JSON object or array, decodes it and passes it to the callback.	1148	Reads a JSON object or array, decodes it and passes it to the callback.
967		1149
968	If a C<json> object was passed to the constructor, then that will be used	1150	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.	1160	the C<json> write type description, above, for an actual example.
979		1161
980	=cut	1162	=cut
981		1163
982	register_read_type json => sub {	1164	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1165	my ($self, $cb) = @_;
984		1166
985	require JSON;	1167	require JSON;
986		1168
987	my $data;	1169	my $data;
988	my $rbuf = \$self->{rbuf};	1170	my $rbuf = \$self->{rbuf};
…		…
1003	()	1185	()
1004	}	1186	}
1005	}	1187	}
1006	};	1188	};
1007		1189
		1190	=item storable => $cb->($handle, $ref)
		1191
		1192	Deserialises a L<Storable> frozen representation as written by the
		1193	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1194	data).
		1195
		1196	Raises C<EBADMSG> error if the data could not be decoded.
		1197
		1198	=cut
		1199
		1200	register_read_type storable => sub {
		1201	my ($self, $cb) = @_;
		1202
		1203	require Storable;
		1204
		1205	sub {
		1206	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1207	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1208	or return;
		1209
		1210	my $format = length pack "w", $len;
		1211
		1212	# bypass unshift if we already have the remaining chunk
		1213	if ($format + $len <= length $_[0]{rbuf}) {
		1214	my $data = substr $_[0]{rbuf}, $format, $len;
		1215	substr $_[0]{rbuf}, 0, $format + $len, "";
		1216	$cb->($_[0], Storable::thaw ($data));
		1217	} else {
		1218	# remove prefix
		1219	substr $_[0]{rbuf}, 0, $format, "";
		1220
		1221	# read remaining chunk
		1222	$_[0]->unshift_read (chunk => $len, sub {
		1223	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1224	$cb->($_[0], $ref);
		1225	} else {
		1226	$self->_error (&Errno::EBADMSG);
		1227	}
		1228	});
		1229	}
		1230
		1231	1
		1232	}
		1233	};
		1234
1008	=back	1235	=back
1009		1236
1010	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1237	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1011		1238
1012	This function (not method) lets you add your own types to C<push_read>.	1239	This function (not method) lets you add your own types to C<push_read>.
…		…
1030	=item $handle->stop_read	1257	=item $handle->stop_read
1031		1258
1032	=item $handle->start_read	1259	=item $handle->start_read
1033		1260
1034	In rare cases you actually do not want to read anything from the	1261	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	1262	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	1263	any queued callbacks will be executed then. To start reading again, call
1037	C<start_read>.	1264	C<start_read>.
1038		1265
		1266	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1267	you change the C<on_read> callback or push/unshift a read callback, and it
		1268	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1269	there are any read requests in the queue.
		1270
		1271	These methods will have no effect when in TLS mode (as TLS doesn't support
		1272	half-duplex connections).
		1273
1039	=cut	1274	=cut
1040		1275
1041	sub stop_read {	1276	sub stop_read {
1042	my ($self) = @_;	1277	my ($self) = @_;
1043		1278
1044	delete $self->{_rw};	1279	delete $self->{_rw} unless $self->{tls};
1045	}	1280	}
1046		1281
1047	sub start_read {	1282	sub start_read {
1048	my ($self) = @_;	1283	my ($self) = @_;
1049		1284
1050	unless ($self->{_rw} \|\| $self->{_eof}) {	1285	unless ($self->{_rw} \|\| $self->{_eof}) {
1051	Scalar::Util::weaken $self;	1286	Scalar::Util::weaken $self;
1052		1287
1053	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1288	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1054	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1289	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1055	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1290	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1056		1291
1057	if ($len > 0) {	1292	if ($len > 0) {
1058	$self->{_activity} = AnyEvent->now;	1293	$self->{_activity} = AnyEvent->now;
1059		1294
1060	$self->{filter_r}	1295	if ($self->{tls}) {
1061	? $self->{filter_r}->($self, $rbuf)	1296	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1062	: $self->_drain_rbuf;	1297
		1298	&_dotls ($self);
		1299	} else {
		1300	$self->_drain_rbuf unless $self->{_in_drain};
		1301	}
1063		1302
1064	} elsif (defined $len) {	1303	} elsif (defined $len) {
1065	delete $self->{_rw};	1304	delete $self->{_rw};
1066	$self->{_eof} = 1;	1305	$self->{_eof} = 1;
1067	$self->_drain_rbuf;	1306	$self->_drain_rbuf unless $self->{_in_drain};
1068		1307
1069	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1308	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1070	return $self->error;	1309	return $self->_error ($!, 1);
1071	}	1310	}
1072	});	1311	});
1073	}	1312	}
1074	}	1313	}
1075		1314
		1315	# poll the write BIO and send the data if applicable
1076	sub _dotls {	1316	sub _dotls {
1077	my ($self) = @_;	1317	my ($self) = @_;
1078		1318
		1319	my $tmp;
		1320
1079	if (length $self->{_tls_wbuf}) {	1321	if (length $self->{_tls_wbuf}) {
1080	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1322	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1081	substr $self->{_tls_wbuf}, 0, $len, "";	1323	substr $self->{_tls_wbuf}, 0, $tmp, "";
1082	}	1324	}
1083	}	1325	}
1084		1326
		1327	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1328	unless (length $tmp) {
		1329	# let's treat SSL-eof as we treat normal EOF
		1330	delete $self->{_rw};
		1331	$self->{_eof} = 1;
		1332	&_freetls;
		1333	}
		1334
		1335	$self->{rbuf} .= $tmp;
		1336	$self->_drain_rbuf unless $self->{_in_drain};
		1337	$self->{tls} or return; # tls session might have gone away in callback
		1338	}
		1339
		1340	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1341
		1342	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
		1343	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
		1344	return $self->_error ($!, 1);
		1345	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
		1346	return $self->_error (&Errno::EIO, 1);
		1347	}
		1348
		1349	# all other errors are fine for our purposes
		1350	}
		1351
1085	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1352	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1086	$self->{wbuf} .= $buf;	1353	$self->{wbuf} .= $tmp;
1087	$self->_drain_wbuf;	1354	$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	}	1355	}
1107	}	1356	}
1108		1357
1109	=item $handle->starttls ($tls[, $tls_ctx])	1358	=item $handle->starttls ($tls[, $tls_ctx])
1110		1359
…		…
1120		1369
1121	The TLS connection object will end up in C<< $handle->{tls} >> after this	1370	The TLS connection object will end up in C<< $handle->{tls} >> after this
1122	call and can be used or changed to your liking. Note that the handshake	1371	call and can be used or changed to your liking. Note that the handshake
1123	might have already started when this function returns.	1372	might have already started when this function returns.
1124		1373
1125	=cut	1374	If it an error to start a TLS handshake more than once per
		1375	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1126		1376
1127	# TODO: maybe document...	1377	=cut
		1378
1128	sub starttls {	1379	sub starttls {
1129	my ($self, $ssl, $ctx) = @_;	1380	my ($self, $ssl, $ctx) = @_;
1130		1381
1131	$self->stoptls;	1382	require Net::SSLeay;
1132		1383
		1384	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
		1385	if $self->{tls};
		1386
1133	if ($ssl eq "accept") {	1387	if ($ssl eq "accept") {
1134	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1388	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1135	Net::SSLeay::set_accept_state ($ssl);	1389	Net::SSLeay::set_accept_state ($ssl);
1136	} elsif ($ssl eq "connect") {	1390	} elsif ($ssl eq "connect") {
1137	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1391	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1143	# basically, this is deep magic (because SSL_read should have the same issues)	1397	# 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".	1398	# but the openssl maintainers basically said: "trust us, it just works".
1145	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1399	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1146	# and mismaintained ssleay-module doesn't even offer them).	1400	# and mismaintained ssleay-module doesn't even offer them).
1147	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1401	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1402	#
		1403	# in short: this is a mess.
		1404	#
		1405	# note that we do not try to keep the length constant between writes as we are required to do.
		1406	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1407	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1408	# have identity issues in that area.
1148	Net::SSLeay::CTX_set_mode ($self->{tls},	1409	Net::SSLeay::CTX_set_mode ($self->{tls},
1149	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1410	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1150	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1411	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1151		1412
1152	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1413	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1153	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1414	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1154		1415
1155	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1416	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1156		1417
1157	$self->{filter_w} = sub {	1418	&_dotls; # need to trigger the initial handshake
1158	$_[0]{_tls_wbuf} .= ${$_[1]};	1419	$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	}	1420	}
1166		1421
1167	=item $handle->stoptls	1422	=item $handle->stoptls
1168		1423
1169	Destroys the SSL connection, if any. Partial read or write data will be	1424	Shuts down the SSL connection - this makes a proper EOF handshake by
1170	lost.	1425	sending a close notify to the other side, but since OpenSSL doesn't
		1426	support non-blocking shut downs, it is not possible to re-use the stream
		1427	afterwards.
1171		1428
1172	=cut	1429	=cut
1173		1430
1174	sub stoptls {	1431	sub stoptls {
1175	my ($self) = @_;	1432	my ($self) = @_;
1176		1433
		1434	if ($self->{tls}) {
		1435	Net::SSLeay::shutdown ($self->{tls});
		1436
		1437	&_dotls;
		1438
		1439	# we don't give a shit. no, we do, but we can't. no...
		1440	# we, we... have to use openssl :/
		1441	&_freetls;
		1442	}
		1443	}
		1444
		1445	sub _freetls {
		1446	my ($self) = @_;
		1447
		1448	return unless $self->{tls};
		1449
1177	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1450	Net::SSLeay::free (delete $self->{tls});
1178		1451
1179	delete $self->{_rbio};	1452	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1180	delete $self->{_wbio};
1181	delete $self->{_tls_wbuf};
1182	delete $self->{filter_r};
1183	delete $self->{filter_w};
1184	}	1453	}
1185		1454
1186	sub DESTROY {	1455	sub DESTROY {
1187	my $self = shift;	1456	my $self = shift;
1188		1457
1189	$self->stoptls;	1458	&_freetls;
		1459
		1460	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1461
		1462	if ($linger && length $self->{wbuf}) {
		1463	my $fh = delete $self->{fh};
		1464	my $wbuf = delete $self->{wbuf};
		1465
		1466	my @linger;
		1467
		1468	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1469	my $len = syswrite $fh, $wbuf, length $wbuf;
		1470
		1471	if ($len > 0) {
		1472	substr $wbuf, 0, $len, "";
		1473	} else {
		1474	@linger = (); # end
		1475	}
		1476	});
		1477	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1478	@linger = ();
		1479	});
		1480	}
1190	}	1481	}
1191		1482
1192	=item AnyEvent::Handle::TLS_CTX	1483	=item AnyEvent::Handle::TLS_CTX
1193		1484
1194	This function creates and returns the Net::SSLeay::CTX object used by	1485	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1224	}	1515	}
1225	}	1516	}
1226		1517
1227	=back	1518	=back
1228		1519
		1520
		1521	=head1 NONFREQUENTLY ASKED QUESTIONS
		1522
		1523	=over 4
		1524
		1525	=item How do I read data until the other side closes the connection?
		1526
		1527	If you just want to read your data into a perl scalar, the easiest way
		1528	to achieve this is by setting an C<on_read> callback that does nothing,
		1529	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1530	will be in C<$_[0]{rbuf}>:
		1531
		1532	$handle->on_read (sub { });
		1533	$handle->on_eof (undef);
		1534	$handle->on_error (sub {
		1535	my $data = delete $_[0]{rbuf};
		1536	undef $handle;
		1537	});
		1538
		1539	The reason to use C<on_error> is that TCP connections, due to latencies
		1540	and packets loss, might get closed quite violently with an error, when in
		1541	fact, all data has been received.
		1542
		1543	It is usually better to use acknowledgements when transfering data,
		1544	to make sure the other side hasn't just died and you got the data
		1545	intact. This is also one reason why so many internet protocols have an
		1546	explicit QUIT command.
		1547
		1548
		1549	=item I don't want to destroy the handle too early - how do I wait until
		1550	all data has been written?
		1551
		1552	After writing your last bits of data, set the C<on_drain> callback
		1553	and destroy the handle in there - with the default setting of
		1554	C<low_water_mark> this will be called precisely when all data has been
		1555	written to the socket:
		1556
		1557	$handle->push_write (...);
		1558	$handle->on_drain (sub {
		1559	warn "all data submitted to the kernel\n";
		1560	undef $handle;
		1561	});
		1562
		1563	=back
		1564
		1565
1229	=head1 SUBCLASSING AnyEvent::Handle	1566	=head1 SUBCLASSING AnyEvent::Handle
1230		1567
1231	In many cases, you might want to subclass AnyEvent::Handle.	1568	In many cases, you might want to subclass AnyEvent::Handle.
1232		1569
1233	To make this easier, a given version of AnyEvent::Handle uses these	1570	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1236	=over 4	1573	=over 4
1237		1574
1238	=item * all constructor arguments become object members.	1575	=item * all constructor arguments become object members.
1239		1576
1240	At least initially, when you pass a C<tls>-argument to the constructor it	1577	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	1578	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).	1579	mutated later on (for example C<tls> will hold the TLS connection object).
1243		1580
1244	=item * other object member names are prefixed with an C<_>.	1581	=item * other object member names are prefixed with an C<_>.
1245		1582
1246	All object members not explicitly documented (internal use) are prefixed	1583	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.47 by root, Thu May 29 00:25:28 2008 UTC vs. Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs.
Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC