[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.85 by root, Thu Aug 21 19:53:19 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.232;
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
…		…
71		73
72	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
73		75
74	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
75		77
76	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
77	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
78		81
79	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
80		83
81	Set the callback to be called on EOF.	84	Set the callback to be called when an end-of-file condition is detected,
		85	i.e. in the case of a socket, when the other side has closed the
		86	connection cleanly.
82		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the eof
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
83	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an eof callback,
84	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
85	waiting for data.	95	waiting for data.
86		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
		99
87	=item on_error => $cb->($handle)	100	=item on_error => $cb->($handle, $fatal)
88		101
89	This is the fatal error callback, that is called when, well, a fatal error	102	This is the error callback, which is called when, well, some error
90	occurs, such as not being able to resolve the hostname, failure to connect	103	occured, such as not being able to resolve the hostname, failure to
91	or a read error.	104	connect or a read error.
92		105
93	The object will not be in a usable state when this callback has been	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
94	called.	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C< ->rbuf >). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
		112	Non-fatal errors can be retried by simply returning, but it is recommended
		113	to simply ignore this parameter and instead abondon the handle object
		114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
95		116
96	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
97	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
98		119
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	120	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	121	you will not be notified of errors otherwise. The default simply calls
104	die.	122	C<croak>.
105		123
106	=item on_read => $cb->($handle)	124	=item on_read => $cb->($handle)
107		125
108	This sets the default read callback, which is called when data arrives	126	This sets the default read callback, which is called when data arrives
109	and no read request is in the queue.	127	and no read request is in the queue (unlike read queue callbacks, this
		128	callback will only be called when at least one octet of data is in the
		129	read buffer).
110		130
111	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
112	method or access the C<$handle->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
113		133
114	When an EOF condition is detected then AnyEvent::Handle will first try to	134	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	141	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).	142	(or when the callback is set and the buffer is empty already).
123		143
124	To append to the write buffer, use the C<< ->push_write >> method.	144	To append to the write buffer, use the C<< ->push_write >> method.
125		145
		146	This callback is useful when you don't want to put all of your write data
		147	into the queue at once, for example, when you want to write the contents
		148	of some file to the socket you might not want to read the whole file into
		149	memory and push it into the queue, but instead only read more data from
		150	the file when the write queue becomes empty.
		151
126	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
127		153
128	If non-zero, then this enables an "inactivity" timeout: whenever this many	154	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	155	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	156	handle, the C<on_timeout> callback will be invoked (and if that one is
131	missing, an C<ETIMEDOUT> errror will be raised).	157	missing, an C<ETIMEDOUT> error will be raised).
132		158
133	Note that timeout processing is also active when you currently do not have	159	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	160	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	161	idle then you should disable the timout temporarily or ignore the timeout
136	in the C<on_timeout> callback.	162	in the C<on_timeout> callback.
…		…
153	be configured to accept only so-and-so much data that it cannot act on	179	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	180	(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	181	amount of data without a callback ever being called as long as the line
156	isn't finished).	182	isn't finished).
157		183
		184	=item autocork => <boolean>
		185
		186	When disabled (the default), then C<push_write> will try to immediately
		187	write the data to the handle if possible. This avoids having to register
		188	a write watcher and wait for the next event loop iteration, but can be
		189	inefficient if you write multiple small chunks (this disadvantage is
		190	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		191
		192	When enabled, then writes will always be queued till the next event loop
		193	iteration. This is efficient when you do many small writes per iteration,
		194	but less efficient when you do a single write only.
		195
		196	=item no_delay => <boolean>
		197
		198	When doing small writes on sockets, your operating system kernel might
		199	wait a bit for more data before actually sending it out. This is called
		200	the Nagle algorithm, and usually it is beneficial.
		201
		202	In some situations you want as low a delay as possible, which cna be
		203	accomplishd by setting this option to true.
		204
		205	The default is your opertaing system's default behaviour, this option
		206	explicitly enables or disables it, if possible.
		207
158	=item read_size => <bytes>	208	=item read_size => <bytes>
159		209
160	The default read block size (the amount of bytes this module will try to read	210	The default read block size (the amount of bytes this module will try to read
161	on each [loop iteration). Default: C<4096>.	211	during each (loop iteration). Default: C<8192>.
162		212
163	=item low_water_mark => <bytes>	213	=item low_water_mark => <bytes>
164		214
165	Sets the amount of bytes (default: C<0>) that make up an "empty" write	215	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	216	buffer: If the write reaches this size or gets even samller it is
167	considered empty.	217	considered empty.
168		218
		219	=item linger => <seconds>
		220
		221	If non-zero (default: C<3600>), then the destructor of the
		222	AnyEvent::Handle object will check wether there is still outstanding write
		223	data and will install a watcher that will write out this data. No errors
		224	will be reported (this mostly matches how the operating system treats
		225	outstanding data at socket close time).
		226
		227	This will not work for partial TLS data that could not yet been
		228	encoded. This data will be lost.
		229
169	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
170		231
171	When this parameter is given, it enables TLS (SSL) mode, that means it	232	When this parameter is given, it enables TLS (SSL) mode, that means
172	will start making tls handshake and will transparently encrypt/decrypt	233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt
173	data.	234	data.
174		235
175	TLS mode requires Net::SSLeay to be installed (it will be loaded	236	TLS mode requires Net::SSLeay to be installed (it will be loaded
176	automatically when you try to create a TLS handle).	237	automatically when you try to create a TLS handle).
177		238
178	For the TLS server side, use C<accept>, and for the TLS client side of a	239	Unlike TCP, TLS has a server and client side: for the TLS server side, use
179	connection, use C<connect> mode.	240	C<accept>, and for the TLS client side of a connection, use C<connect>
		241	mode.
180		242
181	You can also provide your own TLS connection object, but you have	243	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>	244	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	245	or C<Net::SSLeay::set_accept_state> on it before you pass it to
184	AnyEvent::Handle.	246	AnyEvent::Handle.
185		247
186	See the C<starttls> method if you need to start TLs negotiation later.	248	See the C<starttls> method for when need to start TLS negotiation later.
187		249
188	=item tls_ctx => $ssl_ctx	250	=item tls_ctx => $ssl_ctx
189		251
190	Use the given Net::SSLeay::CTX object to create the new TLS connection	252	Use the given Net::SSLeay::CTX object to create the new TLS connection
191	(unless a connection object was specified directly). If this parameter is	253	(unless a connection object was specified directly). If this parameter is
…		…
223	if ($self->{tls}) {	285	if ($self->{tls}) {
224	require Net::SSLeay;	286	require Net::SSLeay;
225	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	287	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
226	}	288	}
227		289
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;	290	$self->{_activity} = AnyEvent->now;
234	$self->_timeout;	291	$self->_timeout;
235		292
		293	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		294	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		295
236	$self->start_read;	296	$self->start_read
		297	if $self->{on_read};
237		298
238	$self	299	$self
239	}	300	}
240		301
241	sub _shutdown {	302	sub _shutdown {
242	my ($self) = @_;	303	my ($self) = @_;
243		304
		305	delete $self->{_tw};
244	delete $self->{_rw};	306	delete $self->{_rw};
245	delete $self->{_ww};	307	delete $self->{_ww};
246	delete $self->{fh};	308	delete $self->{fh};
247	}
248		309
		310	$self->stoptls;
		311
		312	delete $self->{on_read};
		313	delete $self->{_queue};
		314	}
		315
249	sub error {	316	sub _error {
250	my ($self) = @_;	317	my ($self, $errno, $fatal) = @_;
251		318
252	{
253	local $!;
254	$self->_shutdown;	319	$self->_shutdown
255	}	320	if $fatal;
256		321
257	$self->{on_error}($self)	322	$! = $errno;
		323
258	if $self->{on_error};	324	if ($self->{on_error}) {
259		325	$self->{on_error}($self, $fatal);
		326	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	327	Carp::croak "AnyEvent::Handle uncaught error: $!";
		328	}
261	}	329	}
262		330
263	=item $fh = $handle->fh	331	=item $fh = $handle->fh
264		332
265	This method returns the file handle of the L<AnyEvent::Handle> object.	333	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
296		364
297	=cut	365	=cut
298		366
299	sub on_timeout {	367	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	368	$_[0]{on_timeout} = $_[1];
		369	}
		370
		371	=item $handle->autocork ($boolean)
		372
		373	Enables or disables the current autocork behaviour (see C<autocork>
		374	constructor argument).
		375
		376	=cut
		377
		378	=item $handle->no_delay ($boolean)
		379
		380	Enables or disables the C<no_delay> setting (see constructor argument of
		381	the same name for details).
		382
		383	=cut
		384
		385	sub no_delay {
		386	$_[0]{no_delay} = $_[1];
		387
		388	eval {
		389	local $SIG{__DIE__};
		390	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		391	};
301	}	392	}
302		393
303	#############################################################################	394	#############################################################################
304		395
305	=item $handle->timeout ($seconds)	396	=item $handle->timeout ($seconds)
…		…
319	# also check for time-outs	410	# also check for time-outs
320	sub _timeout {	411	sub _timeout {
321	my ($self) = @_;	412	my ($self) = @_;
322		413
323	if ($self->{timeout}) {	414	if ($self->{timeout}) {
324	my $NOW = time;	415	my $NOW = AnyEvent->now;
325		416
326	# when would the timeout trigger?	417	# when would the timeout trigger?
327	my $after = $self->{_activity} + $self->{timeout} - $NOW;	418	my $after = $self->{_activity} + $self->{timeout} - $NOW;
328
329	warn "next to in $after\n";#d#
330		419
331	# now or in the past already?	420	# now or in the past already?
332	if ($after <= 0) {	421	if ($after <= 0) {
333	$self->{_activity} = $NOW;	422	$self->{_activity} = $NOW;
334		423
335	if ($self->{on_timeout}) {	424	if ($self->{on_timeout}) {
336	$self->{on_timeout}->($self);	425	$self->{on_timeout}($self);
337	} else {	426	} else {
338	$! = Errno::ETIMEDOUT;	427	$self->_error (&Errno::ETIMEDOUT);
339	$self->error;
340	}	428	}
341		429
342	# callbakx could have changed timeout value, optimise	430	# callback could have changed timeout value, optimise
343	return unless $self->{timeout};	431	return unless $self->{timeout};
344		432
345	# calculate new after	433	# calculate new after
346	$after = $self->{timeout};	434	$after = $self->{timeout};
347	}	435	}
348		436
349	Scalar::Util::weaken $self;	437	Scalar::Util::weaken $self;
		438	return unless $self; # ->error could have destroyed $self
350		439
351	warn "after $after\n";#d#
352	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	440	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
353	delete $self->{_tw};	441	delete $self->{_tw};
354	$self->_timeout;	442	$self->_timeout;
355	});	443	});
356	} else {	444	} else {
…		…
410	my $len = syswrite $self->{fh}, $self->{wbuf};	498	my $len = syswrite $self->{fh}, $self->{wbuf};
411		499
412	if ($len >= 0) {	500	if ($len >= 0) {
413	substr $self->{wbuf}, 0, $len, "";	501	substr $self->{wbuf}, 0, $len, "";
414		502
415	$self->{_activity} = time;	503	$self->{_activity} = AnyEvent->now;
416		504
417	$self->{on_drain}($self)	505	$self->{on_drain}($self)
418	if $self->{low_water_mark} >= length $self->{wbuf}	506	if $self->{low_water_mark} >= length $self->{wbuf}
419	&& $self->{on_drain};	507	&& $self->{on_drain};
420		508
421	delete $self->{_ww} unless length $self->{wbuf};	509	delete $self->{_ww} unless length $self->{wbuf};
422	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	510	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
423	$self->error;	511	$self->_error ($!, 1);
424	}	512	}
425	};	513	};
426		514
427	# try to write data immediately	515	# try to write data immediately
428	$cb->();	516	$cb->() unless $self->{autocork};
429		517
430	# if still data left in wbuf, we need to poll	518	# if still data left in wbuf, we need to poll
431	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	519	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
432	if length $self->{wbuf};	520	if length $self->{wbuf};
433	};	521	};
…		…
448	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	536	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
449	->($self, @_);	537	->($self, @_);
450	}	538	}
451		539
452	if ($self->{filter_w}) {	540	if ($self->{filter_w}) {
453	$self->{filter_w}->($self, \$_[0]);	541	$self->{filter_w}($self, \$_[0]);
454	} else {	542	} else {
455	$self->{wbuf} .= $_[0];	543	$self->{wbuf} .= $_[0];
456	$self->_drain_wbuf;	544	$self->_drain_wbuf;
457	}	545	}
458	}	546	}
459		547
460	=item $handle->push_write (type => @args)	548	=item $handle->push_write (type => @args)
461		549
462	=item $handle->unshift_write (type => @args)
463
464	Instead of formatting your data yourself, you can also let this module do	550	Instead of formatting your data yourself, you can also let this module do
465	the job by specifying a type and type-specific arguments.	551	the job by specifying a type and type-specific arguments.
466		552
467	Predefined types are (if you have ideas for additional types, feel free to	553	Predefined types are (if you have ideas for additional types, feel free to
468	drop by and tell us):	554	drop by and tell us):
…		…
472	=item netstring => $string	558	=item netstring => $string
473		559
474	Formats the given value as netstring	560	Formats the given value as netstring
475	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	561	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
476		562
477	=back
478
479	=cut	563	=cut
480		564
481	register_write_type netstring => sub {	565	register_write_type netstring => sub {
482	my ($self, $string) = @_;	566	my ($self, $string) = @_;
483		567
484	sprintf "%d:%s,", (length $string), $string	568	sprintf "%d:%s,", (length $string), $string
		569	};
		570
		571	=item packstring => $format, $data
		572
		573	An octet string prefixed with an encoded length. The encoding C<$format>
		574	uses the same format as a Perl C<pack> format, but must specify a single
		575	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		576	optional C<!>, C<< < >> or C<< > >> modifier).
		577
		578	=cut
		579
		580	register_write_type packstring => sub {
		581	my ($self, $format, $string) = @_;
		582
		583	pack "$format/a*", $string
485	};	584	};
486		585
487	=item json => $array_or_hashref	586	=item json => $array_or_hashref
488		587
489	Encodes the given hash or array reference into a JSON object. Unless you	588	Encodes the given hash or array reference into a JSON object. Unless you
…		…
523		622
524	$self->{json} ? $self->{json}->encode ($ref)	623	$self->{json} ? $self->{json}->encode ($ref)
525	: JSON::encode_json ($ref)	624	: JSON::encode_json ($ref)
526	};	625	};
527		626
		627	=item storable => $reference
		628
		629	Freezes the given reference using L<Storable> and writes it to the
		630	handle. Uses the C<nfreeze> format.
		631
		632	=cut
		633
		634	register_write_type storable => sub {
		635	my ($self, $ref) = @_;
		636
		637	require Storable;
		638
		639	pack "w/a*", Storable::nfreeze ($ref)
		640	};
		641
		642	=back
		643
528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	644	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
529		645
530	This function (not method) lets you add your own types to C<push_write>.	646	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	647	Whenever the given C<type> is used, C<push_write> will invoke the code
532	reference with the handle object and the remaining arguments.	648	reference with the handle object and the remaining arguments.
…		…
552	ways, the "simple" way, using only C<on_read> and the "complex" way, using	668	ways, the "simple" way, using only C<on_read> and the "complex" way, using
553	a queue.	669	a queue.
554		670
555	In the simple case, you just install an C<on_read> callback and whenever	671	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	672	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	673	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
558	or not.	674	leave the data there if you want to accumulate more (e.g. when only a
		675	partial message has been received so far).
559		676
560	In the more complex case, you want to queue multiple callbacks. In this	677	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	678	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>,	679	data arrives (also the first time it is queued) and removes it when it has
563	below).	680	done its job (see C<push_read>, below).
564		681
565	This way you can, for example, push three line-reads, followed by reading	682	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.	683	a chunk of data, and AnyEvent::Handle will execute them in order.
567		684
568	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	685	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
569	the specified number of bytes which give an XML datagram.	686	the specified number of bytes which give an XML datagram.
570		687
571	# in the default state, expect some header bytes	688	# in the default state, expect some header bytes
572	$handle->on_read (sub {	689	$handle->on_read (sub {
573	# some data is here, now queue the length-header-read (4 octets)	690	# some data is here, now queue the length-header-read (4 octets)
574	shift->unshift_read_chunk (4, sub {	691	shift->unshift_read (chunk => 4, sub {
575	# header arrived, decode	692	# header arrived, decode
576	my $len = unpack "N", $_[1];	693	my $len = unpack "N", $_[1];
577		694
578	# now read the payload	695	# now read the payload
579	shift->unshift_read_chunk ($len, sub {	696	shift->unshift_read (chunk => $len, sub {
580	my $xml = $_[1];	697	my $xml = $_[1];
581	# handle xml	698	# handle xml
582	});	699	});
583	});	700	});
584	});	701	});
585		702
586	Example 2: Implement a client for a protocol that replies either with	703	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	704	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	705	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	706	just pipeline sending both requests and manipulate the queue as necessary
590	the callbacks:	707	in the callbacks.
591		708
592	# request one	709	When the first callback is called and sees an "OK" response, it will
		710	C<unshift> another line-read. This line-read will be queued I<before> the
		711	64-byte chunk callback.
		712
		713	# request one, returns either "OK + extra line" or "ERROR"
593	$handle->push_write ("request 1\015\012");	714	$handle->push_write ("request 1\015\012");
594		715
595	# we expect "ERROR" or "OK" as response, so push a line read	716	# we expect "ERROR" or "OK" as response, so push a line read
596	$handle->push_read_line (sub {	717	$handle->push_read (line => sub {
597	# if we got an "OK", we have to _prepend_ another line,	718	# 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	719	# 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	720	# which are already in the queue when this callback is called
600	# we don't do this in case we got an error	721	# we don't do this in case we got an error
601	if ($_[1] eq "OK") {	722	if ($_[1] eq "OK") {
602	$_[0]->unshift_read_line (sub {	723	$_[0]->unshift_read (line => sub {
603	my $response = $_[1];	724	my $response = $_[1];
604	...	725	...
605	});	726	});
606	}	727	}
607	});	728	});
608		729
609	# request two	730	# request two, simply returns 64 octets
610	$handle->push_write ("request 2\015\012");	731	$handle->push_write ("request 2\015\012");
611		732
612	# simply read 64 bytes, always	733	# simply read 64 bytes, always
613	$handle->push_read_chunk (64, sub {	734	$handle->push_read (chunk => 64, sub {
614	my $response = $_[1];	735	my $response = $_[1];
615	...	736	...
616	});	737	});
617		738
618	=over 4	739	=over 4
619		740
620	=cut	741	=cut
621		742
622	sub _drain_rbuf {	743	sub _drain_rbuf {
623	my ($self) = @_;	744	my ($self) = @_;
		745
		746	local $self->{_in_drain} = 1;
624		747
625	if (	748	if (
626	defined $self->{rbuf_max}	749	defined $self->{rbuf_max}
627	&& $self->{rbuf_max} < length $self->{rbuf}	750	&& $self->{rbuf_max} < length $self->{rbuf}
628	) {	751	) {
629	$! = &Errno::ENOSPC;	752	$self->_error (&Errno::ENOSPC, 1), return;
630	$self->error;
631	}	753	}
632		754
633	return if $self->{in_drain};	755	while () {
634	local $self->{in_drain} = 1;
635
636	while (my $len = length $self->{rbuf}) {	756	my $len = length $self->{rbuf};
637	no strict 'refs';	757
638	if (my $cb = shift @{ $self->{_queue} }) {	758	if (my $cb = shift @{ $self->{_queue} }) {
639	unless ($cb->($self)) {	759	unless ($cb->($self)) {
640	if ($self->{_eof}) {	760	if ($self->{_eof}) {
641	# no progress can be made (not enough data and no data forthcoming)	761	# no progress can be made (not enough data and no data forthcoming)
642	$! = &Errno::EPIPE;	762	$self->_error (&Errno::EPIPE, 1), return;
643	$self->error;
644	}	763	}
645		764
646	unshift @{ $self->{_queue} }, $cb;	765	unshift @{ $self->{_queue} }, $cb;
647	return;	766	last;
648	}	767	}
649	} elsif ($self->{on_read}) {	768	} elsif ($self->{on_read}) {
		769	last unless $len;
		770
650	$self->{on_read}($self);	771	$self->{on_read}($self);
651		772
652	if (	773	if (
653	$self->{_eof} # if no further data will arrive
654	&& $len == length $self->{rbuf} # and no data has been consumed	774	$len == length $self->{rbuf} # if no data has been consumed
655	&& !@{ $self->{_queue} } # and the queue is still empty	775	&& !@{ $self->{_queue} } # and the queue is still empty
656	&& $self->{on_read} # and we still want to read data	776	&& $self->{on_read} # but we still have on_read
657	) {	777	) {
		778	# no further data will arrive
658	# then no progress can be made	779	# so no progress can be made
659	$! = &Errno::EPIPE;	780	$self->_error (&Errno::EPIPE, 1), return
660	$self->error;	781	if $self->{_eof};
		782
		783	last; # more data might arrive
661	}	784	}
662	} else {	785	} else {
663	# read side becomes idle	786	# read side becomes idle
664	delete $self->{_rw};	787	delete $self->{_rw};
665	return;	788	last;
666	}	789	}
667	}	790	}
668		791
669	if ($self->{_eof}) {	792	if ($self->{_eof}) {
670	$self->_shutdown;	793	if ($self->{on_eof}) {
671	$self->{on_eof}($self)	794	$self->{on_eof}($self)
672	if $self->{on_eof};	795	} else {
		796	$self->_error (0, 1);
		797	}
		798	}
		799
		800	# may need to restart read watcher
		801	unless ($self->{_rw}) {
		802	$self->start_read
		803	if $self->{on_read} \|\| @{ $self->{_queue} };
673	}	804	}
674	}	805	}
675		806
676	=item $handle->on_read ($cb)	807	=item $handle->on_read ($cb)
677		808
…		…
683		814
684	sub on_read {	815	sub on_read {
685	my ($self, $cb) = @_;	816	my ($self, $cb) = @_;
686		817
687	$self->{on_read} = $cb;	818	$self->{on_read} = $cb;
		819	$self->_drain_rbuf if $cb && !$self->{_in_drain};
688	}	820	}
689		821
690	=item $handle->rbuf	822	=item $handle->rbuf
691		823
692	Returns the read buffer (as a modifiable lvalue).	824	Returns the read buffer (as a modifiable lvalue).
…		…
741	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	873	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
742	->($self, $cb, @_);	874	->($self, $cb, @_);
743	}	875	}
744		876
745	push @{ $self->{_queue} }, $cb;	877	push @{ $self->{_queue} }, $cb;
746	$self->_drain_rbuf;	878	$self->_drain_rbuf unless $self->{_in_drain};
747	}	879	}
748		880
749	sub unshift_read {	881	sub unshift_read {
750	my $self = shift;	882	my $self = shift;
751	my $cb = pop;	883	my $cb = pop;
…		…
757	->($self, $cb, @_);	889	->($self, $cb, @_);
758	}	890	}
759		891
760		892
761	unshift @{ $self->{_queue} }, $cb;	893	unshift @{ $self->{_queue} }, $cb;
762	$self->_drain_rbuf;	894	$self->_drain_rbuf unless $self->{_in_drain};
763	}	895	}
764		896
765	=item $handle->push_read (type => @args, $cb)	897	=item $handle->push_read (type => @args, $cb)
766		898
767	=item $handle->unshift_read (type => @args, $cb)	899	=item $handle->unshift_read (type => @args, $cb)
…		…
797	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	929	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
798	1	930	1
799	}	931	}
800	};	932	};
801		933
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)	934	=item line => [$eol, ]$cb->($handle, $line, $eol)
812		935
813	The callback will be called only once a full line (including the end of	936	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	937	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	938	marker) will be passed to the callback as second argument (C<$line>), and
…		…
830	=cut	953	=cut
831		954
832	register_read_type line => sub {	955	register_read_type line => sub {
833	my ($self, $cb, $eol) = @_;	956	my ($self, $cb, $eol) = @_;
834		957
835	$eol = qr\|(\015?\012)\| if @_ < 3;	958	if (@_ < 3) {
836	$eol = quotemeta $eol unless ref $eol;	959	# this is more than twice as fast as the generic code below
837	$eol = qr\|^(.*?)($eol)\|s;
838
839	sub {	960	sub {
840	$_[0]{rbuf} =~ s/$eol// or return;	961	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
841		962
842	$cb->($_[0], $1, $2);	963	$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	}	964	1
875	return;
876	}	965	}
		966	} else {
		967	$eol = quotemeta $eol unless ref $eol;
		968	$eol = qr\|^(.*?)($eol)\|s;
877		969
878	my $len = $1;	970	sub {
		971	$_[0]{rbuf} =~ s/$eol// or return;
879		972
880	$self->unshift_read (chunk => $len, sub {	973	$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	});	974	1
890	});	975	}
891
892	1
893	}	976	}
894	};	977	};
895		978
896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	979	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
897		980
…		…
949	return 1;	1032	return 1;
950	}	1033	}
951		1034
952	# reject	1035	# reject
953	if ($reject && $$rbuf =~ $reject) {	1036	if ($reject && $$rbuf =~ $reject) {
954	$! = &Errno::EBADMSG;	1037	$self->_error (&Errno::EBADMSG);
955	$self->error;
956	}	1038	}
957		1039
958	# skip	1040	# skip
959	if ($skip && $$rbuf =~ $skip) {	1041	if ($skip && $$rbuf =~ $skip) {
960	$data .= substr $$rbuf, 0, $+[0], "";	1042	$data .= substr $$rbuf, 0, $+[0], "";
…		…
962		1044
963	()	1045	()
964	}	1046	}
965	};	1047	};
966		1048
		1049	=item netstring => $cb->($handle, $string)
		1050
		1051	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1052
		1053	Throws an error with C<$!> set to EBADMSG on format violations.
		1054
		1055	=cut
		1056
		1057	register_read_type netstring => sub {
		1058	my ($self, $cb) = @_;
		1059
		1060	sub {
		1061	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1062	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1063	$self->_error (&Errno::EBADMSG);
		1064	}
		1065	return;
		1066	}
		1067
		1068	my $len = $1;
		1069
		1070	$self->unshift_read (chunk => $len, sub {
		1071	my $string = $_[1];
		1072	$_[0]->unshift_read (chunk => 1, sub {
		1073	if ($_[1] eq ",") {
		1074	$cb->($_[0], $string);
		1075	} else {
		1076	$self->_error (&Errno::EBADMSG);
		1077	}
		1078	});
		1079	});
		1080
		1081	1
		1082	}
		1083	};
		1084
		1085	=item packstring => $format, $cb->($handle, $string)
		1086
		1087	An octet string prefixed with an encoded length. The encoding C<$format>
		1088	uses the same format as a Perl C<pack> format, but must specify a single
		1089	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1090	optional C<!>, C<< < >> or C<< > >> modifier).
		1091
		1092	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1093
		1094	Example: read a block of data prefixed by its length in BER-encoded
		1095	format (very efficient).
		1096
		1097	$handle->push_read (packstring => "w", sub {
		1098	my ($handle, $data) = @_;
		1099	});
		1100
		1101	=cut
		1102
		1103	register_read_type packstring => sub {
		1104	my ($self, $cb, $format) = @_;
		1105
		1106	sub {
		1107	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1108	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1109	or return;
		1110
		1111	$format = length pack $format, $len;
		1112
		1113	# bypass unshift if we already have the remaining chunk
		1114	if ($format + $len <= length $_[0]{rbuf}) {
		1115	my $data = substr $_[0]{rbuf}, $format, $len;
		1116	substr $_[0]{rbuf}, 0, $format + $len, "";
		1117	$cb->($_[0], $data);
		1118	} else {
		1119	# remove prefix
		1120	substr $_[0]{rbuf}, 0, $format, "";
		1121
		1122	# read remaining chunk
		1123	$_[0]->unshift_read (chunk => $len, $cb);
		1124	}
		1125
		1126	1
		1127	}
		1128	};
		1129
967	=item json => $cb->($handle, $hash_or_arrayref)	1130	=item json => $cb->($handle, $hash_or_arrayref)
968		1131
969	Reads a JSON object or array, decodes it and passes it to the callback.	1132	Reads a JSON object or array, decodes it and passes it to the callback.
970		1133
971	If a C<json> object was passed to the constructor, then that will be used	1134	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.	1144	the C<json> write type description, above, for an actual example.
982		1145
983	=cut	1146	=cut
984		1147
985	register_read_type json => sub {	1148	register_read_type json => sub {
986	my ($self, $cb, $accept, $reject, $skip) = @_;	1149	my ($self, $cb) = @_;
987		1150
988	require JSON;	1151	require JSON;
989		1152
990	my $data;	1153	my $data;
991	my $rbuf = \$self->{rbuf};	1154	my $rbuf = \$self->{rbuf};
…		…
1006	()	1169	()
1007	}	1170	}
1008	}	1171	}
1009	};	1172	};
1010		1173
		1174	=item storable => $cb->($handle, $ref)
		1175
		1176	Deserialises a L<Storable> frozen representation as written by the
		1177	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1178	data).
		1179
		1180	Raises C<EBADMSG> error if the data could not be decoded.
		1181
		1182	=cut
		1183
		1184	register_read_type storable => sub {
		1185	my ($self, $cb) = @_;
		1186
		1187	require Storable;
		1188
		1189	sub {
		1190	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1191	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1192	or return;
		1193
		1194	my $format = length pack "w", $len;
		1195
		1196	# bypass unshift if we already have the remaining chunk
		1197	if ($format + $len <= length $_[0]{rbuf}) {
		1198	my $data = substr $_[0]{rbuf}, $format, $len;
		1199	substr $_[0]{rbuf}, 0, $format + $len, "";
		1200	$cb->($_[0], Storable::thaw ($data));
		1201	} else {
		1202	# remove prefix
		1203	substr $_[0]{rbuf}, 0, $format, "";
		1204
		1205	# read remaining chunk
		1206	$_[0]->unshift_read (chunk => $len, sub {
		1207	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1208	$cb->($_[0], $ref);
		1209	} else {
		1210	$self->_error (&Errno::EBADMSG);
		1211	}
		1212	});
		1213	}
		1214
		1215	1
		1216	}
		1217	};
		1218
1011	=back	1219	=back
1012		1220
1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1221	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1014		1222
1015	This function (not method) lets you add your own types to C<push_read>.	1223	This function (not method) lets you add your own types to C<push_read>.
…		…
1033	=item $handle->stop_read	1241	=item $handle->stop_read
1034		1242
1035	=item $handle->start_read	1243	=item $handle->start_read
1036		1244
1037	In rare cases you actually do not want to read anything from the	1245	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	1246	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	1247	any queued callbacks will be executed then. To start reading again, call
1040	C<start_read>.	1248	C<start_read>.
		1249
		1250	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1251	you change the C<on_read> callback or push/unshift a read callback, and it
		1252	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1253	there are any read requests in the queue.
1041		1254
1042	=cut	1255	=cut
1043		1256
1044	sub stop_read {	1257	sub stop_read {
1045	my ($self) = @_;	1258	my ($self) = @_;
…		…
1056	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1269	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1057	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1270	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
1058	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1271	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1059		1272
1060	if ($len > 0) {	1273	if ($len > 0) {
1061	$self->{_activity} = time;	1274	$self->{_activity} = AnyEvent->now;
1062		1275
1063	$self->{filter_r}	1276	$self->{filter_r}
1064	? $self->{filter_r}->($self, $rbuf)	1277	? $self->{filter_r}($self, $rbuf)
1065	: $self->_drain_rbuf;	1278	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1066		1279
1067	} elsif (defined $len) {	1280	} elsif (defined $len) {
1068	delete $self->{_rw};	1281	delete $self->{_rw};
1069	delete $self->{_ww};
1070	delete $self->{_tw};
1071	$self->{_eof} = 1;	1282	$self->{_eof} = 1;
1072	$self->_drain_rbuf;	1283	$self->_drain_rbuf unless $self->{_in_drain};
1073		1284
1074	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1285	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1075	return $self->error;	1286	return $self->_error ($!, 1);
1076	}	1287	}
1077	});	1288	});
1078	}	1289	}
1079	}	1290	}
1080		1291
1081	sub _dotls {	1292	sub _dotls {
1082	my ($self) = @_;	1293	my ($self) = @_;
		1294
		1295	my $buf;
1083		1296
1084	if (length $self->{_tls_wbuf}) {	1297	if (length $self->{_tls_wbuf}) {
1085	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1298	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1086	substr $self->{_tls_wbuf}, 0, $len, "";	1299	substr $self->{_tls_wbuf}, 0, $len, "";
1087	}	1300	}
1088	}	1301	}
1089		1302
1090	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1303	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1091	$self->{wbuf} .= $buf;	1304	$self->{wbuf} .= $buf;
1092	$self->_drain_wbuf;	1305	$self->_drain_wbuf;
1093	}	1306	}
1094		1307
1095	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1308	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1309	if (length $buf) {
1096	$self->{rbuf} .= $buf;	1310	$self->{rbuf} .= $buf;
1097	$self->_drain_rbuf;	1311	$self->_drain_rbuf unless $self->{_in_drain};
		1312	} else {
		1313	# let's treat SSL-eof as we treat normal EOF
		1314	$self->{_eof} = 1;
		1315	$self->_shutdown;
		1316	return;
		1317	}
1098	}	1318	}
1099		1319
1100	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1320	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1101		1321
1102	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1322	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1103	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1323	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1104	$self->error;	1324	return $self->_error ($!, 1);
1105	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1325	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1106	$! = &Errno::EIO;	1326	return $self->_error (&Errno::EIO, 1);
1107	$self->error;
1108	}	1327	}
1109		1328
1110	# all others are fine for our purposes	1329	# all others are fine for our purposes
1111	}	1330	}
1112	}	1331	}
…		…
1127	call and can be used or changed to your liking. Note that the handshake	1346	call and can be used or changed to your liking. Note that the handshake
1128	might have already started when this function returns.	1347	might have already started when this function returns.
1129		1348
1130	=cut	1349	=cut
1131		1350
1132	# TODO: maybe document...
1133	sub starttls {	1351	sub starttls {
1134	my ($self, $ssl, $ctx) = @_;	1352	my ($self, $ssl, $ctx) = @_;
1135		1353
1136	$self->stoptls;	1354	$self->stoptls;
1137		1355
…		…
1190		1408
1191	sub DESTROY {	1409	sub DESTROY {
1192	my $self = shift;	1410	my $self = shift;
1193		1411
1194	$self->stoptls;	1412	$self->stoptls;
		1413
		1414	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1415
		1416	if ($linger && length $self->{wbuf}) {
		1417	my $fh = delete $self->{fh};
		1418	my $wbuf = delete $self->{wbuf};
		1419
		1420	my @linger;
		1421
		1422	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1423	my $len = syswrite $fh, $wbuf, length $wbuf;
		1424
		1425	if ($len > 0) {
		1426	substr $wbuf, 0, $len, "";
		1427	} else {
		1428	@linger = (); # end
		1429	}
		1430	});
		1431	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1432	@linger = ();
		1433	});
		1434	}
1195	}	1435	}
1196		1436
1197	=item AnyEvent::Handle::TLS_CTX	1437	=item AnyEvent::Handle::TLS_CTX
1198		1438
1199	This function creates and returns the Net::SSLeay::CTX object used by	1439	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1241	=over 4	1481	=over 4
1242		1482
1243	=item * all constructor arguments become object members.	1483	=item * all constructor arguments become object members.
1244		1484
1245	At least initially, when you pass a C<tls>-argument to the constructor it	1485	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	1486	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).	1487	mutated later on (for example C<tls> will hold the TLS connection object).
1248		1488
1249	=item * other object member names are prefixed with an C<_>.	1489	=item * other object member names are prefixed with an C<_>.
1250		1490
1251	All object members not explicitly documented (internal use) are prefixed	1491	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.85 by root, Thu Aug 21 19:53:19 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.85 by root, Thu Aug 21 19:53:19 2008 UTC