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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.92 by root, Wed Oct 1 08:52:06 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 ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	11	use Errno qw(EAGAIN EINTR);
12	use Time::HiRes qw(time);
13		12
14	=head1 NAME	13	=head1 NAME
15		14
16	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
17		16
18	=cut	17	=cut
19		18
20	our $VERSION = '0.04';	19	our $VERSION = 4.3;
21		20
22	=head1 SYNOPSIS	21	=head1 SYNOPSIS
23		22
24	use AnyEvent;	23	use AnyEvent;
25	use AnyEvent::Handle;	24	use AnyEvent::Handle;
50		49
51	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
52	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
53	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
54		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
55	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
56	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
57	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
58		60
59	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
60	argument.	62	argument.
61		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
62	=head1 METHODS	72	=head1 METHODS
63		73
64	=over 4	74	=over 4
65		75
66	=item B<new (%args)>	76	=item B<new (%args)>
…		…
71		81
72	=item fh => $filehandle [MANDATORY]	82	=item fh => $filehandle [MANDATORY]
73		83
74	The filehandle this L<AnyEvent::Handle> object will operate on.	84	The filehandle this L<AnyEvent::Handle> object will operate on.
75		85
76	NOTE: The filehandle will be set to non-blocking (using	86	NOTE: The filehandle will be set to non-blocking mode (using
77	AnyEvent::Util::fh_nonblocking).	87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		88	that mode.
78		89
79	=item on_eof => $cb->($handle)	90	=item on_eof => $cb->($handle)
80		91
81	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.
82		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
83	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,
84	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
85	waiting for data.	103	waiting for data.
86		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
87	=item on_error => $cb->($handle)	108	=item on_error => $cb->($handle, $fatal)
88		109
89	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
90	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
91	or a read error.	112	connect or a read error.
92		113
93	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
94	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>).
95		124
96	On callback entrance, the value of C<$!> contains the operating system	125	On callback entrance, the value of C<$!> contains the operating system
97	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
98		127
99	The callback should throw an exception. If it returns, then
100	AnyEvent::Handle will C<croak> for you.
101
102	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
103	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
104	die.	130	C<croak>.
105		131
106	=item on_read => $cb->($handle)	132	=item on_read => $cb->($handle)
107		133
108	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
109	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).
110		138
111	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 >>
112	method or access the C<$handle->{rbuf}> member directly.	140	method or access the C<$handle->{rbuf}> member directly.
113		141
114	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
…		…
121	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
122	(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).
123		151
124	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.
125		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
126	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
127		161
128	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
129	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
130	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
131	missing, an C<ETIMEDOUT> errror will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
132		166
133	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
134	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
135	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
136	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
137		172
138	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
139		174
140	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
141		176
…		…
145		180
146	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
147		182
148	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>)
149	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
150	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
151		186
152	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
153	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
154	(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
155	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
156	isn't finished).	191	isn't finished).
157		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
158	=item read_size => <bytes>	219	=item read_size => <bytes>
159		220
160	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
161	on each [loop iteration). Default: C<4096>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
162		224
163	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
164		226
165	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
166	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
167	considered empty.	229	considered empty.
168		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.
		246
169	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
170		248
171	When this parameter is given, it enables TLS (SSL) mode, that means it	249	When this parameter is given, it enables TLS (SSL) mode, that means
172	will start making tls handshake and will transparently encrypt/decrypt	250	AnyEvent will start a TLS handshake as soon as the conenction has been
173	data.	251	established and will transparently encrypt/decrypt data afterwards.
174		252
175	TLS mode requires Net::SSLeay to be installed (it will be loaded	253	TLS mode requires Net::SSLeay to be installed (it will be loaded
176	automatically when you try to create a TLS handle).	254	automatically when you try to create a TLS handle): this module doesn't
		255	have a dependency on that module, so if your module requires it, you have
		256	to add the dependency yourself.
177		257
178	For the TLS server side, use C<accept>, and for the TLS client side of a	258	Unlike TCP, TLS has a server and client side: for the TLS server side, use
179	connection, use C<connect> mode.	259	C<accept>, and for the TLS client side of a connection, use C<connect>
		260	mode.
180		261
181	You can also provide your own TLS connection object, but you have	262	You can also provide your own TLS connection object, but you have
182	to make sure that you call either C<Net::SSLeay::set_connect_state>	263	to make sure that you call either C<Net::SSLeay::set_connect_state>
183	or C<Net::SSLeay::set_accept_state> on it before you pass it to	264	or C<Net::SSLeay::set_accept_state> on it before you pass it to
184	AnyEvent::Handle.	265	AnyEvent::Handle.
185		266
186	See the C<starttls> method if you need to start TLs negotiation later.	267	See the C<< ->starttls >> method for when need to start TLS negotiation later.
187		268
188	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
189		270
190	Use the given Net::SSLeay::CTX object to create the new TLS connection	271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
191	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
192	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
193		274
194	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
195		276
196	This is the json coder object used by the C<json> read and write types.	277	This is the json coder object used by the C<json> read and write types.
197		278
198	If you don't supply it, then AnyEvent::Handle will create and use a	279	If you don't supply it, then AnyEvent::Handle will create and use a
199	suitable one, which will write and expect UTF-8 encoded JSON texts.	280	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		281	texts.
200		282
201	Note that you are responsible to depend on the JSON module if you want to	283	Note that you are responsible to depend on the JSON module if you want to
202	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
203		285
204	=item filter_r => $cb	286	=item filter_r => $cb
205		287
206	=item filter_w => $cb	288	=item filter_w => $cb
207		289
208	These exist, but are undocumented at this time.	290	These exist, but are undocumented at this time. (They are used internally
		291	by the TLS code).
209		292
210	=back	293	=back
211		294
212	=cut	295	=cut
213		296
…		…
223	if ($self->{tls}) {	306	if ($self->{tls}) {
224	require Net::SSLeay;	307	require Net::SSLeay;
225	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
226	}	309	}
227		310
228	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
229	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
230	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
231	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
232
233	$self->{_activity} = time;	311	$self->{_activity} = AnyEvent->now;
234	$self->_timeout;	312	$self->_timeout;
235		313
		314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		316
236	$self->start_read;	317	$self->start_read
		318	if $self->{on_read};
237		319
238	$self	320	$self
239	}	321	}
240		322
241	sub _shutdown {	323	sub _shutdown {
242	my ($self) = @_;	324	my ($self) = @_;
243		325
		326	delete $self->{_tw};
244	delete $self->{_rw};	327	delete $self->{_rw};
245	delete $self->{_ww};	328	delete $self->{_ww};
246	delete $self->{fh};	329	delete $self->{fh};
247	}
248		330
		331	&_freetls;
		332
		333	delete $self->{on_read};
		334	delete $self->{_queue};
		335	}
		336
249	sub error {	337	sub _error {
250	my ($self) = @_;	338	my ($self, $errno, $fatal) = @_;
251		339
252	{
253	local $!;
254	$self->_shutdown;	340	$self->_shutdown
255	}	341	if $fatal;
256		342
257	$self->{on_error}($self)	343	$! = $errno;
		344
258	if $self->{on_error};	345	if ($self->{on_error}) {
259		346	$self->{on_error}($self, $fatal);
		347	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	348	Carp::croak "AnyEvent::Handle uncaught error: $!";
		349	}
261	}	350	}
262		351
263	=item $fh = $handle->fh	352	=item $fh = $handle->fh
264		353
265	This method returns the file handle of the L<AnyEvent::Handle> object.	354	This method returns the file handle used to create the L<AnyEvent::Handle> object.
266		355
267	=cut	356	=cut
268		357
269	sub fh { $_[0]{fh} }	358	sub fh { $_[0]{fh} }
270		359
…		…
288	$_[0]{on_eof} = $_[1];	377	$_[0]{on_eof} = $_[1];
289	}	378	}
290		379
291	=item $handle->on_timeout ($cb)	380	=item $handle->on_timeout ($cb)
292		381
293	Replace the current C<on_timeout> callback, or disables the callback	382	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	383	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
295	argument.	384	argument and method.
296		385
297	=cut	386	=cut
298		387
299	sub on_timeout {	388	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	389	$_[0]{on_timeout} = $_[1];
		390	}
		391
		392	=item $handle->autocork ($boolean)
		393
		394	Enables or disables the current autocork behaviour (see C<autocork>
		395	constructor argument).
		396
		397	=cut
		398
		399	=item $handle->no_delay ($boolean)
		400
		401	Enables or disables the C<no_delay> setting (see constructor argument of
		402	the same name for details).
		403
		404	=cut
		405
		406	sub no_delay {
		407	$_[0]{no_delay} = $_[1];
		408
		409	eval {
		410	local $SIG{__DIE__};
		411	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		412	};
301	}	413	}
302		414
303	#############################################################################	415	#############################################################################
304		416
305	=item $handle->timeout ($seconds)	417	=item $handle->timeout ($seconds)
…		…
319	# also check for time-outs	431	# also check for time-outs
320	sub _timeout {	432	sub _timeout {
321	my ($self) = @_;	433	my ($self) = @_;
322		434
323	if ($self->{timeout}) {	435	if ($self->{timeout}) {
324	my $NOW = time;	436	my $NOW = AnyEvent->now;
325		437
326	# when would the timeout trigger?	438	# when would the timeout trigger?
327	my $after = $self->{_activity} + $self->{timeout} - $NOW;	439	my $after = $self->{_activity} + $self->{timeout} - $NOW;
328
329	warn "next to in $after\n";#d#
330		440
331	# now or in the past already?	441	# now or in the past already?
332	if ($after <= 0) {	442	if ($after <= 0) {
333	$self->{_activity} = $NOW;	443	$self->{_activity} = $NOW;
334		444
335	if ($self->{on_timeout}) {	445	if ($self->{on_timeout}) {
336	$self->{on_timeout}->($self);	446	$self->{on_timeout}($self);
337	} else {	447	} else {
338	$! = Errno::ETIMEDOUT;	448	$self->_error (&Errno::ETIMEDOUT);
339	$self->error;
340	}	449	}
341		450
342	# callbakx could have changed timeout value, optimise	451	# callback could have changed timeout value, optimise
343	return unless $self->{timeout};	452	return unless $self->{timeout};
344		453
345	# calculate new after	454	# calculate new after
346	$after = $self->{timeout};	455	$after = $self->{timeout};
347	}	456	}
348		457
349	Scalar::Util::weaken $self;	458	Scalar::Util::weaken $self;
		459	return unless $self; # ->error could have destroyed $self
350		460
351	warn "after $after\n";#d#
352	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	461	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
353	delete $self->{_tw};	462	delete $self->{_tw};
354	$self->_timeout;	463	$self->_timeout;
355	});	464	});
356	} else {	465	} else {
…		…
410	my $len = syswrite $self->{fh}, $self->{wbuf};	519	my $len = syswrite $self->{fh}, $self->{wbuf};
411		520
412	if ($len >= 0) {	521	if ($len >= 0) {
413	substr $self->{wbuf}, 0, $len, "";	522	substr $self->{wbuf}, 0, $len, "";
414		523
415	$self->{_activity} = time;	524	$self->{_activity} = AnyEvent->now;
416		525
417	$self->{on_drain}($self)	526	$self->{on_drain}($self)
418	if $self->{low_water_mark} >= length $self->{wbuf}	527	if $self->{low_water_mark} >= length $self->{wbuf}
419	&& $self->{on_drain};	528	&& $self->{on_drain};
420		529
421	delete $self->{_ww} unless length $self->{wbuf};	530	delete $self->{_ww} unless length $self->{wbuf};
422	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
423	$self->error;	532	$self->_error ($!, 1);
424	}	533	}
425	};	534	};
426		535
427	# try to write data immediately	536	# try to write data immediately
428	$cb->();	537	$cb->() unless $self->{autocork};
429		538
430	# if still data left in wbuf, we need to poll	539	# if still data left in wbuf, we need to poll
431	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	540	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
432	if length $self->{wbuf};	541	if length $self->{wbuf};
433	};	542	};
…		…
448	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	557	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
449	->($self, @_);	558	->($self, @_);
450	}	559	}
451		560
452	if ($self->{filter_w}) {	561	if ($self->{filter_w}) {
453	$self->{filter_w}->($self, \$_[0]);	562	$self->{filter_w}($self, \$_[0]);
454	} else {	563	} else {
455	$self->{wbuf} .= $_[0];	564	$self->{wbuf} .= $_[0];
456	$self->_drain_wbuf;	565	$self->_drain_wbuf;
457	}	566	}
458	}	567	}
459		568
460	=item $handle->push_write (type => @args)	569	=item $handle->push_write (type => @args)
461		570
462	=item $handle->unshift_write (type => @args)
463
464	Instead of formatting your data yourself, you can also let this module do	571	Instead of formatting your data yourself, you can also let this module do
465	the job by specifying a type and type-specific arguments.	572	the job by specifying a type and type-specific arguments.
466		573
467	Predefined types are (if you have ideas for additional types, feel free to	574	Predefined types are (if you have ideas for additional types, feel free to
468	drop by and tell us):	575	drop by and tell us):
…		…
472	=item netstring => $string	579	=item netstring => $string
473		580
474	Formats the given value as netstring	581	Formats the given value as netstring
475	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	582	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
476		583
477	=back
478
479	=cut	584	=cut
480		585
481	register_write_type netstring => sub {	586	register_write_type netstring => sub {
482	my ($self, $string) = @_;	587	my ($self, $string) = @_;
483		588
484	sprintf "%d:%s,", (length $string), $string	589	sprintf "%d:%s,", (length $string), $string
		590	};
		591
		592	=item packstring => $format, $data
		593
		594	An octet string prefixed with an encoded length. The encoding C<$format>
		595	uses the same format as a Perl C<pack> format, but must specify a single
		596	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		597	optional C<!>, C<< < >> or C<< > >> modifier).
		598
		599	=cut
		600
		601	register_write_type packstring => sub {
		602	my ($self, $format, $string) = @_;
		603
		604	pack "$format/a*", $string
485	};	605	};
486		606
487	=item json => $array_or_hashref	607	=item json => $array_or_hashref
488		608
489	Encodes the given hash or array reference into a JSON object. Unless you	609	Encodes the given hash or array reference into a JSON object. Unless you
…		…
523		643
524	$self->{json} ? $self->{json}->encode ($ref)	644	$self->{json} ? $self->{json}->encode ($ref)
525	: JSON::encode_json ($ref)	645	: JSON::encode_json ($ref)
526	};	646	};
527		647
		648	=item storable => $reference
		649
		650	Freezes the given reference using L<Storable> and writes it to the
		651	handle. Uses the C<nfreeze> format.
		652
		653	=cut
		654
		655	register_write_type storable => sub {
		656	my ($self, $ref) = @_;
		657
		658	require Storable;
		659
		660	pack "w/a*", Storable::nfreeze ($ref)
		661	};
		662
		663	=back
		664
528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
529		666
530	This function (not method) lets you add your own types to C<push_write>.	667	This function (not method) lets you add your own types to C<push_write>.
531	Whenever the given C<type> is used, C<push_write> will invoke the code	668	Whenever the given C<type> is used, C<push_write> will invoke the code
532	reference with the handle object and the remaining arguments.	669	reference with the handle object and the remaining arguments.
…		…
552	ways, the "simple" way, using only C<on_read> and the "complex" way, using	689	ways, the "simple" way, using only C<on_read> and the "complex" way, using
553	a queue.	690	a queue.
554		691
555	In the simple case, you just install an C<on_read> callback and whenever	692	In the simple case, you just install an C<on_read> callback and whenever
556	new data arrives, it will be called. You can then remove some data (if	693	new data arrives, it will be called. You can then remove some data (if
557	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	694	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
558	or not.	695	leave the data there if you want to accumulate more (e.g. when only a
		696	partial message has been received so far).
559		697
560	In the more complex case, you want to queue multiple callbacks. In this	698	In the more complex case, you want to queue multiple callbacks. In this
561	case, AnyEvent::Handle will call the first queued callback each time new	699	case, AnyEvent::Handle will call the first queued callback each time new
562	data arrives and removes it when it has done its job (see C<push_read>,	700	data arrives (also the first time it is queued) and removes it when it has
563	below).	701	done its job (see C<push_read>, below).
564		702
565	This way you can, for example, push three line-reads, followed by reading	703	This way you can, for example, push three line-reads, followed by reading
566	a chunk of data, and AnyEvent::Handle will execute them in order.	704	a chunk of data, and AnyEvent::Handle will execute them in order.
567		705
568	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	706	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
569	the specified number of bytes which give an XML datagram.	707	the specified number of bytes which give an XML datagram.
570		708
571	# in the default state, expect some header bytes	709	# in the default state, expect some header bytes
572	$handle->on_read (sub {	710	$handle->on_read (sub {
573	# some data is here, now queue the length-header-read (4 octets)	711	# some data is here, now queue the length-header-read (4 octets)
574	shift->unshift_read_chunk (4, sub {	712	shift->unshift_read (chunk => 4, sub {
575	# header arrived, decode	713	# header arrived, decode
576	my $len = unpack "N", $_[1];	714	my $len = unpack "N", $_[1];
577		715
578	# now read the payload	716	# now read the payload
579	shift->unshift_read_chunk ($len, sub {	717	shift->unshift_read (chunk => $len, sub {
580	my $xml = $_[1];	718	my $xml = $_[1];
581	# handle xml	719	# handle xml
582	});	720	});
583	});	721	});
584	});	722	});
585		723
586	Example 2: Implement a client for a protocol that replies either with	724	Example 2: Implement a client for a protocol that replies either with "OK"
587	"OK" and another line or "ERROR" for one request, and 64 bytes for the	725	and another line or "ERROR" for the first request that is sent, and 64
588	second request. Due tot he availability of a full queue, we can just	726	bytes for the second request. Due to the availability of a queue, we can
589	pipeline sending both requests and manipulate the queue as necessary in	727	just pipeline sending both requests and manipulate the queue as necessary
590	the callbacks:	728	in the callbacks.
591		729
592	# request one	730	When the first callback is called and sees an "OK" response, it will
		731	C<unshift> another line-read. This line-read will be queued I<before> the
		732	64-byte chunk callback.
		733
		734	# request one, returns either "OK + extra line" or "ERROR"
593	$handle->push_write ("request 1\015\012");	735	$handle->push_write ("request 1\015\012");
594		736
595	# we expect "ERROR" or "OK" as response, so push a line read	737	# we expect "ERROR" or "OK" as response, so push a line read
596	$handle->push_read_line (sub {	738	$handle->push_read (line => sub {
597	# if we got an "OK", we have to _prepend_ another line,	739	# if we got an "OK", we have to _prepend_ another line,
598	# so it will be read before the second request reads its 64 bytes	740	# so it will be read before the second request reads its 64 bytes
599	# which are already in the queue when this callback is called	741	# which are already in the queue when this callback is called
600	# we don't do this in case we got an error	742	# we don't do this in case we got an error
601	if ($_[1] eq "OK") {	743	if ($_[1] eq "OK") {
602	$_[0]->unshift_read_line (sub {	744	$_[0]->unshift_read (line => sub {
603	my $response = $_[1];	745	my $response = $_[1];
604	...	746	...
605	});	747	});
606	}	748	}
607	});	749	});
608		750
609	# request two	751	# request two, simply returns 64 octets
610	$handle->push_write ("request 2\015\012");	752	$handle->push_write ("request 2\015\012");
611		753
612	# simply read 64 bytes, always	754	# simply read 64 bytes, always
613	$handle->push_read_chunk (64, sub {	755	$handle->push_read (chunk => 64, sub {
614	my $response = $_[1];	756	my $response = $_[1];
615	...	757	...
616	});	758	});
617		759
618	=over 4	760	=over 4
619		761
620	=cut	762	=cut
621		763
622	sub _drain_rbuf {	764	sub _drain_rbuf {
623	my ($self) = @_;	765	my ($self) = @_;
		766
		767	local $self->{_in_drain} = 1;
624		768
625	if (	769	if (
626	defined $self->{rbuf_max}	770	defined $self->{rbuf_max}
627	&& $self->{rbuf_max} < length $self->{rbuf}	771	&& $self->{rbuf_max} < length $self->{rbuf}
628	) {	772	) {
629	$! = &Errno::ENOSPC;	773	$self->_error (&Errno::ENOSPC, 1), return;
630	$self->error;
631	}	774	}
632		775
633	return if $self->{in_drain};	776	while () {
634	local $self->{in_drain} = 1;
635
636	while (my $len = length $self->{rbuf}) {	777	my $len = length $self->{rbuf};
637	no strict 'refs';	778
638	if (my $cb = shift @{ $self->{_queue} }) {	779	if (my $cb = shift @{ $self->{_queue} }) {
639	unless ($cb->($self)) {	780	unless ($cb->($self)) {
640	if ($self->{_eof}) {	781	if ($self->{_eof}) {
641	# no progress can be made (not enough data and no data forthcoming)	782	# no progress can be made (not enough data and no data forthcoming)
642	$! = &Errno::EPIPE;	783	$self->_error (&Errno::EPIPE, 1), return;
643	$self->error;
644	}	784	}
645		785
646	unshift @{ $self->{_queue} }, $cb;	786	unshift @{ $self->{_queue} }, $cb;
647	return;	787	last;
648	}	788	}
649	} elsif ($self->{on_read}) {	789	} elsif ($self->{on_read}) {
		790	last unless $len;
		791
650	$self->{on_read}($self);	792	$self->{on_read}($self);
651		793
652	if (	794	if (
653	$self->{_eof} # if no further data will arrive
654	&& $len == length $self->{rbuf} # and no data has been consumed	795	$len == length $self->{rbuf} # if no data has been consumed
655	&& !@{ $self->{_queue} } # and the queue is still empty	796	&& !@{ $self->{_queue} } # and the queue is still empty
656	&& $self->{on_read} # and we still want to read data	797	&& $self->{on_read} # but we still have on_read
657	) {	798	) {
		799	# no further data will arrive
658	# then no progress can be made	800	# so no progress can be made
659	$! = &Errno::EPIPE;	801	$self->_error (&Errno::EPIPE, 1), return
660	$self->error;	802	if $self->{_eof};
		803
		804	last; # more data might arrive
661	}	805	}
662	} else {	806	} else {
663	# read side becomes idle	807	# read side becomes idle
664	delete $self->{_rw};	808	delete $self->{_rw};
665	return;	809	last;
666	}	810	}
667	}	811	}
668		812
669	if ($self->{_eof}) {	813	if ($self->{_eof}) {
670	$self->_shutdown;	814	if ($self->{on_eof}) {
671	$self->{on_eof}($self)	815	$self->{on_eof}($self)
672	if $self->{on_eof};	816	} else {
		817	$self->_error (0, 1);
		818	}
		819	}
		820
		821	# may need to restart read watcher
		822	unless ($self->{_rw}) {
		823	$self->start_read
		824	if $self->{on_read} \|\| @{ $self->{_queue} };
673	}	825	}
674	}	826	}
675		827
676	=item $handle->on_read ($cb)	828	=item $handle->on_read ($cb)
677		829
…		…
683		835
684	sub on_read {	836	sub on_read {
685	my ($self, $cb) = @_;	837	my ($self, $cb) = @_;
686		838
687	$self->{on_read} = $cb;	839	$self->{on_read} = $cb;
		840	$self->_drain_rbuf if $cb && !$self->{_in_drain};
688	}	841	}
689		842
690	=item $handle->rbuf	843	=item $handle->rbuf
691		844
692	Returns the read buffer (as a modifiable lvalue).	845	Returns the read buffer (as a modifiable lvalue).
…		…
741	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	894	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
742	->($self, $cb, @_);	895	->($self, $cb, @_);
743	}	896	}
744		897
745	push @{ $self->{_queue} }, $cb;	898	push @{ $self->{_queue} }, $cb;
746	$self->_drain_rbuf;	899	$self->_drain_rbuf unless $self->{_in_drain};
747	}	900	}
748		901
749	sub unshift_read {	902	sub unshift_read {
750	my $self = shift;	903	my $self = shift;
751	my $cb = pop;	904	my $cb = pop;
…		…
757	->($self, $cb, @_);	910	->($self, $cb, @_);
758	}	911	}
759		912
760		913
761	unshift @{ $self->{_queue} }, $cb;	914	unshift @{ $self->{_queue} }, $cb;
762	$self->_drain_rbuf;	915	$self->_drain_rbuf unless $self->{_in_drain};
763	}	916	}
764		917
765	=item $handle->push_read (type => @args, $cb)	918	=item $handle->push_read (type => @args, $cb)
766		919
767	=item $handle->unshift_read (type => @args, $cb)	920	=item $handle->unshift_read (type => @args, $cb)
…		…
797	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	950	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
798	1	951	1
799	}	952	}
800	};	953	};
801		954
802	# compatibility with older API
803	sub push_read_chunk {
804	$_[0]->push_read (chunk => $_[1], $_[2]);
805	}
806
807	sub unshift_read_chunk {
808	$_[0]->unshift_read (chunk => $_[1], $_[2]);
809	}
810
811	=item line => [$eol, ]$cb->($handle, $line, $eol)	955	=item line => [$eol, ]$cb->($handle, $line, $eol)
812		956
813	The callback will be called only once a full line (including the end of	957	The callback will be called only once a full line (including the end of
814	line marker, C<$eol>) has been read. This line (excluding the end of line	958	line marker, C<$eol>) has been read. This line (excluding the end of line
815	marker) will be passed to the callback as second argument (C<$line>), and	959	marker) will be passed to the callback as second argument (C<$line>), and
…		…
830	=cut	974	=cut
831		975
832	register_read_type line => sub {	976	register_read_type line => sub {
833	my ($self, $cb, $eol) = @_;	977	my ($self, $cb, $eol) = @_;
834		978
835	$eol = qr\|(\015?\012)\| if @_ < 3;	979	if (@_ < 3) {
836	$eol = quotemeta $eol unless ref $eol;	980	# this is more than twice as fast as the generic code below
837	$eol = qr\|^(.*?)($eol)\|s;
838
839	sub {	981	sub {
840	$_[0]{rbuf} =~ s/$eol// or return;	982	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
841		983
842	$cb->($_[0], $1, $2);	984	$cb->($_[0], $1, $2);
843	1
844	}
845	};
846
847	# compatibility with older API
848	sub push_read_line {
849	my $self = shift;
850	$self->push_read (line => @_);
851	}
852
853	sub unshift_read_line {
854	my $self = shift;
855	$self->unshift_read (line => @_);
856	}
857
858	=item netstring => $cb->($handle, $string)
859
860	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
861
862	Throws an error with C<$!> set to EBADMSG on format violations.
863
864	=cut
865
866	register_read_type netstring => sub {
867	my ($self, $cb) = @_;
868
869	sub {
870	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
871	if ($_[0]{rbuf} =~ /[^0-9]/) {
872	$! = &Errno::EBADMSG;
873	$self->error;
874	}	985	1
875	return;
876	}	986	}
		987	} else {
		988	$eol = quotemeta $eol unless ref $eol;
		989	$eol = qr\|^(.*?)($eol)\|s;
877		990
878	my $len = $1;	991	sub {
		992	$_[0]{rbuf} =~ s/$eol// or return;
879		993
880	$self->unshift_read (chunk => $len, sub {	994	$cb->($_[0], $1, $2);
881	my $string = $_[1];
882	$_[0]->unshift_read (chunk => 1, sub {
883	if ($_[1] eq ",") {
884	$cb->($_[0], $string);
885	} else {
886	$! = &Errno::EBADMSG;
887	$self->error;
888	}
889	});	995	1
890	});	996	}
891
892	1
893	}	997	}
894	};	998	};
895		999
896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1000	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
897		1001
…		…
949	return 1;	1053	return 1;
950	}	1054	}
951		1055
952	# reject	1056	# reject
953	if ($reject && $$rbuf =~ $reject) {	1057	if ($reject && $$rbuf =~ $reject) {
954	$! = &Errno::EBADMSG;	1058	$self->_error (&Errno::EBADMSG);
955	$self->error;
956	}	1059	}
957		1060
958	# skip	1061	# skip
959	if ($skip && $$rbuf =~ $skip) {	1062	if ($skip && $$rbuf =~ $skip) {
960	$data .= substr $$rbuf, 0, $+[0], "";	1063	$data .= substr $$rbuf, 0, $+[0], "";
…		…
962		1065
963	()	1066	()
964	}	1067	}
965	};	1068	};
966		1069
		1070	=item netstring => $cb->($handle, $string)
		1071
		1072	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1073
		1074	Throws an error with C<$!> set to EBADMSG on format violations.
		1075
		1076	=cut
		1077
		1078	register_read_type netstring => sub {
		1079	my ($self, $cb) = @_;
		1080
		1081	sub {
		1082	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1083	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1084	$self->_error (&Errno::EBADMSG);
		1085	}
		1086	return;
		1087	}
		1088
		1089	my $len = $1;
		1090
		1091	$self->unshift_read (chunk => $len, sub {
		1092	my $string = $_[1];
		1093	$_[0]->unshift_read (chunk => 1, sub {
		1094	if ($_[1] eq ",") {
		1095	$cb->($_[0], $string);
		1096	} else {
		1097	$self->_error (&Errno::EBADMSG);
		1098	}
		1099	});
		1100	});
		1101
		1102	1
		1103	}
		1104	};
		1105
		1106	=item packstring => $format, $cb->($handle, $string)
		1107
		1108	An octet string prefixed with an encoded length. The encoding C<$format>
		1109	uses the same format as a Perl C<pack> format, but must specify a single
		1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1111	optional C<!>, C<< < >> or C<< > >> modifier).
		1112
		1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1114
		1115	Example: read a block of data prefixed by its length in BER-encoded
		1116	format (very efficient).
		1117
		1118	$handle->push_read (packstring => "w", sub {
		1119	my ($handle, $data) = @_;
		1120	});
		1121
		1122	=cut
		1123
		1124	register_read_type packstring => sub {
		1125	my ($self, $cb, $format) = @_;
		1126
		1127	sub {
		1128	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1129	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1130	or return;
		1131
		1132	$format = length pack $format, $len;
		1133
		1134	# bypass unshift if we already have the remaining chunk
		1135	if ($format + $len <= length $_[0]{rbuf}) {
		1136	my $data = substr $_[0]{rbuf}, $format, $len;
		1137	substr $_[0]{rbuf}, 0, $format + $len, "";
		1138	$cb->($_[0], $data);
		1139	} else {
		1140	# remove prefix
		1141	substr $_[0]{rbuf}, 0, $format, "";
		1142
		1143	# read remaining chunk
		1144	$_[0]->unshift_read (chunk => $len, $cb);
		1145	}
		1146
		1147	1
		1148	}
		1149	};
		1150
967	=item json => $cb->($handle, $hash_or_arrayref)	1151	=item json => $cb->($handle, $hash_or_arrayref)
968		1152
969	Reads a JSON object or array, decodes it and passes it to the callback.	1153	Reads a JSON object or array, decodes it and passes it to the callback.
970		1154
971	If a C<json> object was passed to the constructor, then that will be used	1155	If a C<json> object was passed to the constructor, then that will be used
…		…
981	the C<json> write type description, above, for an actual example.	1165	the C<json> write type description, above, for an actual example.
982		1166
983	=cut	1167	=cut
984		1168
985	register_read_type json => sub {	1169	register_read_type json => sub {
986	my ($self, $cb, $accept, $reject, $skip) = @_;	1170	my ($self, $cb) = @_;
987		1171
988	require JSON;	1172	require JSON;
989		1173
990	my $data;	1174	my $data;
991	my $rbuf = \$self->{rbuf};	1175	my $rbuf = \$self->{rbuf};
…		…
1006	()	1190	()
1007	}	1191	}
1008	}	1192	}
1009	};	1193	};
1010		1194
		1195	=item storable => $cb->($handle, $ref)
		1196
		1197	Deserialises a L<Storable> frozen representation as written by the
		1198	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1199	data).
		1200
		1201	Raises C<EBADMSG> error if the data could not be decoded.
		1202
		1203	=cut
		1204
		1205	register_read_type storable => sub {
		1206	my ($self, $cb) = @_;
		1207
		1208	require Storable;
		1209
		1210	sub {
		1211	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1212	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1213	or return;
		1214
		1215	my $format = length pack "w", $len;
		1216
		1217	# bypass unshift if we already have the remaining chunk
		1218	if ($format + $len <= length $_[0]{rbuf}) {
		1219	my $data = substr $_[0]{rbuf}, $format, $len;
		1220	substr $_[0]{rbuf}, 0, $format + $len, "";
		1221	$cb->($_[0], Storable::thaw ($data));
		1222	} else {
		1223	# remove prefix
		1224	substr $_[0]{rbuf}, 0, $format, "";
		1225
		1226	# read remaining chunk
		1227	$_[0]->unshift_read (chunk => $len, sub {
		1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1229	$cb->($_[0], $ref);
		1230	} else {
		1231	$self->_error (&Errno::EBADMSG);
		1232	}
		1233	});
		1234	}
		1235
		1236	1
		1237	}
		1238	};
		1239
1011	=back	1240	=back
1012		1241
1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1242	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1014		1243
1015	This function (not method) lets you add your own types to C<push_read>.	1244	This function (not method) lets you add your own types to C<push_read>.
…		…
1033	=item $handle->stop_read	1262	=item $handle->stop_read
1034		1263
1035	=item $handle->start_read	1264	=item $handle->start_read
1036		1265
1037	In rare cases you actually do not want to read anything from the	1266	In rare cases you actually do not want to read anything from the
1038	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1267	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1039	any queued callbacks will be executed then. To start reading again, call	1268	any queued callbacks will be executed then. To start reading again, call
1040	C<start_read>.	1269	C<start_read>.
		1270
		1271	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1272	you change the C<on_read> callback or push/unshift a read callback, and it
		1273	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1274	there are any read requests in the queue.
1041		1275
1042	=cut	1276	=cut
1043		1277
1044	sub stop_read {	1278	sub stop_read {
1045	my ($self) = @_;	1279	my ($self) = @_;
…		…
1056	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1057	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
1058	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1059		1293
1060	if ($len > 0) {	1294	if ($len > 0) {
1061	$self->{_activity} = time;	1295	$self->{_activity} = AnyEvent->now;
1062		1296
1063	$self->{filter_r}	1297	$self->{filter_r}
1064	? $self->{filter_r}->($self, $rbuf)	1298	? $self->{filter_r}($self, $rbuf)
1065	: $self->_drain_rbuf;	1299	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1066		1300
1067	} elsif (defined $len) {	1301	} elsif (defined $len) {
1068	delete $self->{_rw};	1302	delete $self->{_rw};
1069	delete $self->{_ww};
1070	delete $self->{_tw};
1071	$self->{_eof} = 1;	1303	$self->{_eof} = 1;
1072	$self->_drain_rbuf;	1304	$self->_drain_rbuf unless $self->{_in_drain};
1073		1305
1074	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1075	return $self->error;	1307	return $self->_error ($!, 1);
1076	}	1308	}
1077	});	1309	});
1078	}	1310	}
1079	}	1311	}
1080		1312
1081	sub _dotls {	1313	sub _dotls {
1082	my ($self) = @_;	1314	my ($self) = @_;
		1315
		1316	my $buf;
1083		1317
1084	if (length $self->{_tls_wbuf}) {	1318	if (length $self->{_tls_wbuf}) {
1085	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) {
1086	substr $self->{_tls_wbuf}, 0, $len, "";	1320	substr $self->{_tls_wbuf}, 0, $len, "";
1087	}	1321	}
1088	}	1322	}
1089		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
1090	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1091	$self->{wbuf} .= $buf;	1350	$self->{wbuf} .= $buf;
1092	$self->_drain_wbuf;	1351	$self->_drain_wbuf;
1093	}
1094
1095	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
1096	$self->{rbuf} .= $buf;
1097	$self->_drain_rbuf;
1098	}
1099
1100	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1101
1102	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1103	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1104	$self->error;
1105	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1106	$! = &Errno::EIO;
1107	$self->error;
1108	}
1109
1110	# all others are fine for our purposes
1111	}	1352	}
1112	}	1353	}
1113		1354
1114	=item $handle->starttls ($tls[, $tls_ctx])	1355	=item $handle->starttls ($tls[, $tls_ctx])
1115		1356
…		…
1125		1366
1126	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
1127	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
1128	might have already started when this function returns.	1369	might have already started when this function returns.
1129		1370
1130	=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).
1131		1373
1132	# TODO: maybe document...	1374	=cut
		1375
1133	sub starttls {	1376	sub starttls {
1134	my ($self, $ssl, $ctx) = @_;	1377	my ($self, $ssl, $ctx) = @_;
1135		1378
1136	$self->stoptls;	1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
1137		1380	if $self->{tls};
		1381
1138	if ($ssl eq "accept") {	1382	if ($ssl eq "accept") {
1139	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1140	Net::SSLeay::set_accept_state ($ssl);	1384	Net::SSLeay::set_accept_state ($ssl);
1141	} elsif ($ssl eq "connect") {	1385	} elsif ($ssl eq "connect") {
1142	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1386	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1148	# basically, this is deep magic (because SSL_read should have the same issues)	1392	# basically, this is deep magic (because SSL_read should have the same issues)
1149	# but the openssl maintainers basically said: "trust us, it just works".	1393	# but the openssl maintainers basically said: "trust us, it just works".
1150	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1151	# and mismaintained ssleay-module doesn't even offer them).	1395	# and mismaintained ssleay-module doesn't even offer them).
1152	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1397	#
		1398	# in short: this is a mess.
		1399	#
		1400	# note that we do not try to kepe the length constant between writes as we are required to do.
		1401	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1402	# and we drive openssl fully in blocking mode here.
1153	Net::SSLeay::CTX_set_mode ($self->{tls},	1403	Net::SSLeay::CTX_set_mode ($self->{tls},
1154	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1155	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1405	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1156		1406
1157	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
…		…
1165	};	1415	};
1166	$self->{filter_r} = sub {	1416	$self->{filter_r} = sub {
1167	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});	1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1168	&_dotls;	1418	&_dotls;
1169	};	1419	};
		1420
		1421	&_dotls; # need to trigger the initial negotiation exchange
1170	}	1422	}
1171		1423
1172	=item $handle->stoptls	1424	=item $handle->stoptls
1173		1425
1174	Destroys the SSL connection, if any. Partial read or write data will be	1426	Shuts down the SSL connection - this makes a proper EOF handshake by
1175	lost.	1427	sending a close notify to the other side, but since OpenSSL doesn't
		1428	support non-blocking shut downs, it is not possible to re-use the stream
		1429	afterwards.
1176		1430
1177	=cut	1431	=cut
1178		1432
1179	sub stoptls {	1433	sub stoptls {
1180	my ($self) = @_;	1434	my ($self) = @_;
1181		1435
		1436	if ($self->{tls}) {
		1437	Net::SSLeay::shutdown $self->{tls};
		1438
		1439	&_dotls;
		1440
		1441	# we don't give a shit. no, we do, but we can't. no...
		1442	# we, we... have to use openssl :/
		1443	&_freetls;
		1444	}
		1445	}
		1446
		1447	sub _freetls {
		1448	my ($self) = @_;
		1449
		1450	return unless $self->{tls};
		1451
1182	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1452	Net::SSLeay::free (delete $self->{tls});
1183		1453
1184	delete $self->{_rbio};	1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};
1185	delete $self->{_wbio};
1186	delete $self->{_tls_wbuf};
1187	delete $self->{filter_r};
1188	delete $self->{filter_w};
1189	}	1455	}
1190		1456
1191	sub DESTROY {	1457	sub DESTROY {
1192	my $self = shift;	1458	my $self = shift;
1193		1459
1194	$self->stoptls;	1460	&_freetls;
		1461
		1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1463
		1464	if ($linger && length $self->{wbuf}) {
		1465	my $fh = delete $self->{fh};
		1466	my $wbuf = delete $self->{wbuf};
		1467
		1468	my @linger;
		1469
		1470	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1471	my $len = syswrite $fh, $wbuf, length $wbuf;
		1472
		1473	if ($len > 0) {
		1474	substr $wbuf, 0, $len, "";
		1475	} else {
		1476	@linger = (); # end
		1477	}
		1478	});
		1479	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1480	@linger = ();
		1481	});
		1482	}
1195	}	1483	}
1196		1484
1197	=item AnyEvent::Handle::TLS_CTX	1485	=item AnyEvent::Handle::TLS_CTX
1198		1486
1199	This function creates and returns the Net::SSLeay::CTX object used by	1487	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1241	=over 4	1529	=over 4
1242		1530
1243	=item * all constructor arguments become object members.	1531	=item * all constructor arguments become object members.
1244		1532
1245	At least initially, when you pass a C<tls>-argument to the constructor it	1533	At least initially, when you pass a C<tls>-argument to the constructor it
1246	will end up in C<< $handle->{tls} >>. Those members might be changes or	1534	will end up in C<< $handle->{tls} >>. Those members might be changed or
1247	mutated later on (for example C<tls> will hold the TLS connection object).	1535	mutated later on (for example C<tls> will hold the TLS connection object).
1248		1536
1249	=item * other object member names are prefixed with an C<_>.	1537	=item * other object member names are prefixed with an C<_>.
1250		1538
1251	All object members not explicitly documented (internal use) are prefixed	1539	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.43 by root, Wed May 28 23:57:38 2008 UTC vs. Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC