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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util ();	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		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.15;
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
24		22
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->broadcast;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
72	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
73		74
74	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
75	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
76		77
77	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
78		79
79	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
80		83
81	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
82	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
83	waiting for data.	86	waiting for data.
84		87
85	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
86		89
87	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
88	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
89	or a read error.	92	connect or a read error.
90		93
91	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
92	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
93		99
94	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
96		102
97	While not mandatory, it is I<highly> recommended to set this callback, as	103	While not mandatory, it is I<highly> recommended to set this callback, as
98	you will not be notified of errors otherwise. The default simply calls	104	you will not be notified of errors otherwise. The default simply calls
99	die.	105	C<croak>.
100		106
101	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
102		108
103	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
104	and no read request is in the queue.	110	and no read request is in the queue (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
105		113
106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107	method or access the C<$self->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
108		116
109	When an EOF condition is detected then AnyEvent::Handle will first try to	117	When an EOF condition is detected then AnyEvent::Handle will first try to
110	feed all the remaining data to the queued callbacks and C<on_read> before	118	feed all the remaining data to the queued callbacks and C<on_read> before
111	calling the C<on_eof> callback. If no progress can be made, then a fatal	119	calling the C<on_eof> callback. If no progress can be made, then a fatal
112	error will be raised (with C<$!> set to C<EPIPE>).	120	error will be raised (with C<$!> set to C<EPIPE>).
113		121
114	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
115		123
116	This sets the callback that is called when the write buffer becomes empty	124	This sets the callback that is called when the write buffer becomes empty
117	(or when the callback is set and the buffer is empty already).	125	(or when the callback is set and the buffer is empty already).
118		126
119	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
		128
		129	=item timeout => $fractional_seconds
		130
		131	If non-zero, then this enables an "inactivity" timeout: whenever this many
		132	seconds pass without a successful read or write on the underlying file
		133	handle, the C<on_timeout> callback will be invoked (and if that one is
		134	missing, an C<ETIMEDOUT> error will be raised).
		135
		136	Note that timeout processing is also active when you currently do not have
		137	any outstanding read or write requests: If you plan to keep the connection
		138	idle then you should disable the timout temporarily or ignore the timeout
		139	in the C<on_timeout> callback.
		140
		141	Zero (the default) disables this timeout.
		142
		143	=item on_timeout => $cb->($handle)
		144
		145	Called whenever the inactivity timeout passes. If you return from this
		146	callback, then the timeout will be reset as if some activity had happened,
		147	so this condition is not fatal in any way.
120		148
121	=item rbuf_max => <bytes>	149	=item rbuf_max => <bytes>
122		150
123	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	151	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
124	when the read buffer ever (strictly) exceeds this size. This is useful to	152	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
131	isn't finished).	159	isn't finished).
132		160
133	=item read_size => <bytes>	161	=item read_size => <bytes>
134		162
135	The default read block size (the amount of bytes this module will try to read	163	The default read block size (the amount of bytes this module will try to read
136	on each [loop iteration). Default: C<4096>.	164	during each (loop iteration). Default: C<8192>.
137		165
138	=item low_water_mark => <bytes>	166	=item low_water_mark => <bytes>
139		167
140	Sets the amount of bytes (default: C<0>) that make up an "empty" write	168	Sets the amount of bytes (default: C<0>) that make up an "empty" write
141	buffer: If the write reaches this size or gets even samller it is	169	buffer: If the write reaches this size or gets even samller it is
142	considered empty.	170	considered empty.
		171
		172	=item linger => <seconds>
		173
		174	If non-zero (default: C<3600>), then the destructor of the
		175	AnyEvent::Handle object will check wether there is still outstanding write
		176	data and will install a watcher that will write out this data. No errors
		177	will be reported (this mostly matches how the operating system treats
		178	outstanding data at socket close time).
		179
		180	This will not work for partial TLS data that could not yet been
		181	encoded. This data will be lost.
143		182
144	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
145		184
146	When this parameter is given, it enables TLS (SSL) mode, that means it	185	When this parameter is given, it enables TLS (SSL) mode, that means it
147	will start making tls handshake and will transparently encrypt/decrypt	186	will start making tls handshake and will transparently encrypt/decrypt
…		…
164		203
165	Use the given Net::SSLeay::CTX object to create the new TLS connection	204	Use the given Net::SSLeay::CTX object to create the new TLS connection
166	(unless a connection object was specified directly). If this parameter is	205	(unless a connection object was specified directly). If this parameter is
167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168		207
		208	=item json => JSON or JSON::XS object
		209
		210	This is the json coder object used by the C<json> read and write types.
		211
		212	If you don't supply it, then AnyEvent::Handle will create and use a
		213	suitable one, which will write and expect UTF-8 encoded JSON texts.
		214
		215	Note that you are responsible to depend on the JSON module if you want to
		216	use this functionality, as AnyEvent does not have a dependency itself.
		217
		218	=item filter_r => $cb
		219
		220	=item filter_w => $cb
		221
		222	These exist, but are undocumented at this time.
		223
169	=back	224	=back
170		225
171	=cut	226	=cut
172
173	our (%RH, %WH);
174
175	sub register_read_type($$) {
176	$RH{$_[0]} = $_[1];
177	}
178
179	sub register_write_type($$) {
180	$WH{$_[0]} = $_[1];
181	}
182		227
183	sub new {	228	sub new {
184	my $class = shift;	229	my $class = shift;
185		230
186	my $self = bless { @_ }, $class;	231	my $self = bless { @_ }, $class;
…		…
192	if ($self->{tls}) {	237	if ($self->{tls}) {
193	require Net::SSLeay;	238	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	240	}
196		241
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	242	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	243	$self->_timeout;
		244
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
201		246
202	$self->start_read;	247	$self->start_read
		248	if $self->{on_read} \|\| @{ $self->{_queue} };
203		249
204	$self	250	$self
205	}	251	}
206		252
207	sub _shutdown {	253	sub _shutdown {
208	my ($self) = @_;	254	my ($self) = @_;
209		255
		256	delete $self->{_tw};
210	delete $self->{rw};	257	delete $self->{_rw};
211	delete $self->{ww};	258	delete $self->{_ww};
212	delete $self->{fh};	259	delete $self->{fh};
213	}
214		260
		261	$self->stoptls;
		262	}
		263
215	sub error {	264	sub _error {
216	my ($self) = @_;	265	my ($self, $errno, $fatal) = @_;
217		266
218	{
219	local $!;
220	$self->_shutdown;	267	$self->_shutdown
221	}	268	if $fatal;
		269
		270	$! = $errno;
222		271
223	if ($self->{on_error}) {	272	if ($self->{on_error}) {
224	$self->{on_error}($self);	273	$self->{on_error}($self, $fatal);
225	} else {	274	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	275	Carp::croak "AnyEvent::Handle uncaught error: $!";
227	}	276	}
228	}	277	}
229		278
230	=item $fh = $handle->fh	279	=item $fh = $handle->fh
231		280
232	This method returns the file handle of the L<AnyEvent::Handle> object.	281	This method returns the file handle of the L<AnyEvent::Handle> object.
233		282
234	=cut	283	=cut
235		284
236	sub fh { $_[0]->{fh} }	285	sub fh { $_[0]{fh} }
237		286
238	=item $handle->on_error ($cb)	287	=item $handle->on_error ($cb)
239		288
240	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	289	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
241		290
…		…
251		300
252	=cut	301	=cut
253		302
254	sub on_eof {	303	sub on_eof {
255	$_[0]{on_eof} = $_[1];	304	$_[0]{on_eof} = $_[1];
		305	}
		306
		307	=item $handle->on_timeout ($cb)
		308
		309	Replace the current C<on_timeout> callback, or disables the callback
		310	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		311	argument.
		312
		313	=cut
		314
		315	sub on_timeout {
		316	$_[0]{on_timeout} = $_[1];
		317	}
		318
		319	#############################################################################
		320
		321	=item $handle->timeout ($seconds)
		322
		323	Configures (or disables) the inactivity timeout.
		324
		325	=cut
		326
		327	sub timeout {
		328	my ($self, $timeout) = @_;
		329
		330	$self->{timeout} = $timeout;
		331	$self->_timeout;
		332	}
		333
		334	# reset the timeout watcher, as neccessary
		335	# also check for time-outs
		336	sub _timeout {
		337	my ($self) = @_;
		338
		339	if ($self->{timeout}) {
		340	my $NOW = AnyEvent->now;
		341
		342	# when would the timeout trigger?
		343	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		344
		345	# now or in the past already?
		346	if ($after <= 0) {
		347	$self->{_activity} = $NOW;
		348
		349	if ($self->{on_timeout}) {
		350	$self->{on_timeout}($self);
		351	} else {
		352	$self->_error (&Errno::ETIMEDOUT);
		353	}
		354
		355	# callback could have changed timeout value, optimise
		356	return unless $self->{timeout};
		357
		358	# calculate new after
		359	$after = $self->{timeout};
		360	}
		361
		362	Scalar::Util::weaken $self;
		363	return unless $self; # ->error could have destroyed $self
		364
		365	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		366	delete $self->{_tw};
		367	$self->_timeout;
		368	});
		369	} else {
		370	delete $self->{_tw};
		371	}
256	}	372	}
257		373
258	#############################################################################	374	#############################################################################
259		375
260	=back	376	=back
…		…
297	=cut	413	=cut
298		414
299	sub _drain_wbuf {	415	sub _drain_wbuf {
300	my ($self) = @_;	416	my ($self) = @_;
301		417
302	if (!$self->{ww} && length $self->{wbuf}) {	418	if (!$self->{_ww} && length $self->{wbuf}) {
		419
303	Scalar::Util::weaken $self;	420	Scalar::Util::weaken $self;
		421
304	my $cb = sub {	422	my $cb = sub {
305	my $len = syswrite $self->{fh}, $self->{wbuf};	423	my $len = syswrite $self->{fh}, $self->{wbuf};
306		424
307	if ($len >= 0) {	425	if ($len >= 0) {
308	substr $self->{wbuf}, 0, $len, "";	426	substr $self->{wbuf}, 0, $len, "";
		427
		428	$self->{_activity} = AnyEvent->now;
309		429
310	$self->{on_drain}($self)	430	$self->{on_drain}($self)
311	if $self->{low_water_mark} >= length $self->{wbuf}	431	if $self->{low_water_mark} >= length $self->{wbuf}
312	&& $self->{on_drain};	432	&& $self->{on_drain};
313		433
314	delete $self->{ww} unless length $self->{wbuf};	434	delete $self->{_ww} unless length $self->{wbuf};
315	} elsif ($! != EAGAIN && $! != EINTR) {	435	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
316	$self->error;	436	$self->_error ($!, 1);
317	}	437	}
318	};	438	};
319		439
		440	# try to write data immediately
		441	$cb->();
		442
		443	# if still data left in wbuf, we need to poll
320	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	444	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
321		445	if length $self->{wbuf};
322	$cb->($self);
323	};	446	};
		447	}
		448
		449	our %WH;
		450
		451	sub register_write_type($$) {
		452	$WH{$_[0]} = $_[1];
324	}	453	}
325		454
326	sub push_write {	455	sub push_write {
327	my $self = shift;	456	my $self = shift;
328		457
…		…
332	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	461	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
333	->($self, @_);	462	->($self, @_);
334	}	463	}
335		464
336	if ($self->{filter_w}) {	465	if ($self->{filter_w}) {
337	$self->{filter_w}->($self, \$_[0]);	466	$self->{filter_w}($self, \$_[0]);
338	} else {	467	} else {
339	$self->{wbuf} .= $_[0];	468	$self->{wbuf} .= $_[0];
340	$self->_drain_wbuf;	469	$self->_drain_wbuf;
341	}	470	}
342	}	471	}
343		472
344	=item $handle->push_write (type => @args)	473	=item $handle->push_write (type => @args)
345		474
346	=item $handle->unshift_write (type => @args)
347
348	Instead of formatting your data yourself, you can also let this module do	475	Instead of formatting your data yourself, you can also let this module do
349	the job by specifying a type and type-specific arguments.	476	the job by specifying a type and type-specific arguments.
350		477
351	Predefined types are:	478	Predefined types are (if you have ideas for additional types, feel free to
		479	drop by and tell us):
352		480
353	=over 4	481	=over 4
354		482
355	=item netstring => $string	483	=item netstring => $string
356		484
…		…
363	my ($self, $string) = @_;	491	my ($self, $string) = @_;
364		492
365	sprintf "%d:%s,", (length $string), $string	493	sprintf "%d:%s,", (length $string), $string
366	};	494	};
367		495
		496	=item packstring => $format, $data
		497
		498	An octet string prefixed with an encoded length. The encoding C<$format>
		499	uses the same format as a Perl C<pack> format, but must specify a single
		500	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		501	optional C<!>, C<< < >> or C<< > >> modifier).
		502
		503	=cut
		504
		505	register_write_type packstring => sub {
		506	my ($self, $format, $string) = @_;
		507
		508	pack "$format/a*", $string
		509	};
		510
		511	=item json => $array_or_hashref
		512
		513	Encodes the given hash or array reference into a JSON object. Unless you
		514	provide your own JSON object, this means it will be encoded to JSON text
		515	in UTF-8.
		516
		517	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		518	one end of a handle and read them at the other end without using any
		519	additional framing.
		520
		521	The generated JSON text is guaranteed not to contain any newlines: While
		522	this module doesn't need delimiters after or between JSON texts to be
		523	able to read them, many other languages depend on that.
		524
		525	A simple RPC protocol that interoperates easily with others is to send
		526	JSON arrays (or objects, although arrays are usually the better choice as
		527	they mimic how function argument passing works) and a newline after each
		528	JSON text:
		529
		530	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		531	$handle->push_write ("\012");
		532
		533	An AnyEvent::Handle receiver would simply use the C<json> read type and
		534	rely on the fact that the newline will be skipped as leading whitespace:
		535
		536	$handle->push_read (json => sub { my $array = $_[1]; ... });
		537
		538	Other languages could read single lines terminated by a newline and pass
		539	this line into their JSON decoder of choice.
		540
		541	=cut
		542
		543	register_write_type json => sub {
		544	my ($self, $ref) = @_;
		545
		546	require JSON;
		547
		548	$self->{json} ? $self->{json}->encode ($ref)
		549	: JSON::encode_json ($ref)
		550	};
		551
		552	=item storable => $reference
		553
		554	Freezes the given reference using L<Storable> and writes it to the
		555	handle. Uses the C<nfreeze> format.
		556
		557	=cut
		558
		559	register_write_type storable => sub {
		560	my ($self, $ref) = @_;
		561
		562	require Storable;
		563
		564	pack "w/a*", Storable::nfreeze ($ref)
		565	};
		566
368	=back	567	=back
369		568
370	=cut	569	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
371		570
		571	This function (not method) lets you add your own types to C<push_write>.
		572	Whenever the given C<type> is used, C<push_write> will invoke the code
		573	reference with the handle object and the remaining arguments.
372		574
		575	The code reference is supposed to return a single octet string that will
		576	be appended to the write buffer.
		577
		578	Note that this is a function, and all types registered this way will be
		579	global, so try to use unique names.
		580
		581	=cut
373		582
374	#############################################################################	583	#############################################################################
375		584
376	=back	585	=back
377		586
…		…
389	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	598	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
390	or not.	599	or not.
391		600
392	In the more complex case, you want to queue multiple callbacks. In this	601	In the more complex case, you want to queue multiple callbacks. In this
393	case, AnyEvent::Handle will call the first queued callback each time new	602	case, AnyEvent::Handle will call the first queued callback each time new
394	data arrives and removes it when it has done its job (see C<push_read>,	603	data arrives (also the first time it is queued) and removes it when it has
395	below).	604	done its job (see C<push_read>, below).
396		605
397	This way you can, for example, push three line-reads, followed by reading	606	This way you can, for example, push three line-reads, followed by reading
398	a chunk of data, and AnyEvent::Handle will execute them in order.	607	a chunk of data, and AnyEvent::Handle will execute them in order.
399		608
400	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	609	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
401	the specified number of bytes which give an XML datagram.	610	the specified number of bytes which give an XML datagram.
402		611
403	# in the default state, expect some header bytes	612	# in the default state, expect some header bytes
404	$handle->on_read (sub {	613	$handle->on_read (sub {
405	# some data is here, now queue the length-header-read (4 octets)	614	# some data is here, now queue the length-header-read (4 octets)
406	shift->unshift_read_chunk (4, sub {	615	shift->unshift_read (chunk => 4, sub {
407	# header arrived, decode	616	# header arrived, decode
408	my $len = unpack "N", $_[1];	617	my $len = unpack "N", $_[1];
409		618
410	# now read the payload	619	# now read the payload
411	shift->unshift_read_chunk ($len, sub {	620	shift->unshift_read (chunk => $len, sub {
412	my $xml = $_[1];	621	my $xml = $_[1];
413	# handle xml	622	# handle xml
414	});	623	});
415	});	624	});
416	});	625	});
…		…
423		632
424	# request one	633	# request one
425	$handle->push_write ("request 1\015\012");	634	$handle->push_write ("request 1\015\012");
426		635
427	# we expect "ERROR" or "OK" as response, so push a line read	636	# we expect "ERROR" or "OK" as response, so push a line read
428	$handle->push_read_line (sub {	637	$handle->push_read (line => sub {
429	# if we got an "OK", we have to _prepend_ another line,	638	# if we got an "OK", we have to _prepend_ another line,
430	# so it will be read before the second request reads its 64 bytes	639	# so it will be read before the second request reads its 64 bytes
431	# which are already in the queue when this callback is called	640	# which are already in the queue when this callback is called
432	# we don't do this in case we got an error	641	# we don't do this in case we got an error
433	if ($_[1] eq "OK") {	642	if ($_[1] eq "OK") {
434	$_[0]->unshift_read_line (sub {	643	$_[0]->unshift_read (line => sub {
435	my $response = $_[1];	644	my $response = $_[1];
436	...	645	...
437	});	646	});
438	}	647	}
439	});	648	});
440		649
441	# request two	650	# request two
442	$handle->push_write ("request 2\015\012");	651	$handle->push_write ("request 2\015\012");
443		652
444	# simply read 64 bytes, always	653	# simply read 64 bytes, always
445	$handle->push_read_chunk (64, sub {	654	$handle->push_read (chunk => 64, sub {
446	my $response = $_[1];	655	my $response = $_[1];
447	...	656	...
448	});	657	});
449		658
450	=over 4	659	=over 4
451		660
452	=cut	661	=cut
453		662
454	sub _drain_rbuf {	663	sub _drain_rbuf {
455	my ($self) = @_;	664	my ($self) = @_;
		665
		666	local $self->{_in_drain} = 1;
456		667
457	if (	668	if (
458	defined $self->{rbuf_max}	669	defined $self->{rbuf_max}
459	&& $self->{rbuf_max} < length $self->{rbuf}	670	&& $self->{rbuf_max} < length $self->{rbuf}
460	) {	671	) {
461	$! = &Errno::ENOSPC; return $self->error;	672	return $self->_error (&Errno::ENOSPC, 1);
462	}	673	}
463		674
464	return if $self->{in_drain};	675	while () {
465	local $self->{in_drain} = 1;
466
467	while (my $len = length $self->{rbuf}) {
468	no strict 'refs';	676	no strict 'refs';
		677
		678	my $len = length $self->{rbuf};
		679
469	if (my $cb = shift @{ $self->{queue} }) {	680	if (my $cb = shift @{ $self->{_queue} }) {
470	unless ($cb->($self)) {	681	unless ($cb->($self)) {
471	if ($self->{eof}) {	682	if ($self->{_eof}) {
472	# no progress can be made (not enough data and no data forthcoming)	683	# no progress can be made (not enough data and no data forthcoming)
473	$! = &Errno::EPIPE; return $self->error;	684	$self->_error (&Errno::EPIPE, 1), last;
474	}	685	}
475		686
476	unshift @{ $self->{queue} }, $cb;	687	unshift @{ $self->{_queue} }, $cb;
477	return;	688	last;
478	}	689	}
479	} elsif ($self->{on_read}) {	690	} elsif ($self->{on_read}) {
		691	last unless $len;
		692
480	$self->{on_read}($self);	693	$self->{on_read}($self);
481		694
482	if (	695	if (
483	$self->{eof} # if no further data will arrive
484	&& $len == length $self->{rbuf} # and no data has been consumed	696	$len == length $self->{rbuf} # if no data has been consumed
485	&& !@{ $self->{queue} } # and the queue is still empty	697	&& !@{ $self->{_queue} } # and the queue is still empty
486	&& $self->{on_read} # and we still want to read data	698	&& $self->{on_read} # but we still have on_read
487	) {	699	) {
		700	# no further data will arrive
488	# then no progress can be made	701	# so no progress can be made
489	$! = &Errno::EPIPE; return $self->error;	702	$self->_error (&Errno::EPIPE, 1), last
		703	if $self->{_eof};
		704
		705	last; # more data might arrive
490	}	706	}
491	} else {	707	} else {
492	# read side becomes idle	708	# read side becomes idle
493	delete $self->{rw};	709	delete $self->{_rw};
494	return;	710	last;
495	}	711	}
496	}	712	}
497		713
498	if ($self->{eof}) {
499	$self->_shutdown;
500	$self->{on_eof}($self)	714	$self->{on_eof}($self)
501	if $self->{on_eof};	715	if $self->{_eof} && $self->{on_eof};
		716
		717	# may need to restart read watcher
		718	unless ($self->{_rw}) {
		719	$self->start_read
		720	if $self->{on_read} \|\| @{ $self->{_queue} };
502	}	721	}
503	}	722	}
504		723
505	=item $handle->on_read ($cb)	724	=item $handle->on_read ($cb)
506		725
…		…
512		731
513	sub on_read {	732	sub on_read {
514	my ($self, $cb) = @_;	733	my ($self, $cb) = @_;
515		734
516	$self->{on_read} = $cb;	735	$self->{on_read} = $cb;
		736	$self->_drain_rbuf if $cb && !$self->{_in_drain};
517	}	737	}
518		738
519	=item $handle->rbuf	739	=item $handle->rbuf
520		740
521	Returns the read buffer (as a modifiable lvalue).	741	Returns the read buffer (as a modifiable lvalue).
…		…
552	interested in (which can be none at all) and return a true value. After returning	772	interested in (which can be none at all) and return a true value. After returning
553	true, it will be removed from the queue.	773	true, it will be removed from the queue.
554		774
555	=cut	775	=cut
556		776
		777	our %RH;
		778
		779	sub register_read_type($$) {
		780	$RH{$_[0]} = $_[1];
		781	}
		782
557	sub push_read {	783	sub push_read {
558	my $self = shift;	784	my $self = shift;
559	my $cb = pop;	785	my $cb = pop;
560		786
561	if (@_) {	787	if (@_) {
…		…
563		789
564	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	790	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
565	->($self, $cb, @_);	791	->($self, $cb, @_);
566	}	792	}
567		793
568	push @{ $self->{queue} }, $cb;	794	push @{ $self->{_queue} }, $cb;
569	$self->_drain_rbuf;	795	$self->_drain_rbuf unless $self->{_in_drain};
570	}	796	}
571		797
572	sub unshift_read {	798	sub unshift_read {
573	my $self = shift;	799	my $self = shift;
574	my $cb = pop;	800	my $cb = pop;
…		…
579	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	805	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
580	->($self, $cb, @_);	806	->($self, $cb, @_);
581	}	807	}
582		808
583		809
584	unshift @{ $self->{queue} }, $cb;	810	unshift @{ $self->{_queue} }, $cb;
585	$self->_drain_rbuf;	811	$self->_drain_rbuf unless $self->{_in_drain};
586	}	812	}
587		813
588	=item $handle->push_read (type => @args, $cb)	814	=item $handle->push_read (type => @args, $cb)
589		815
590	=item $handle->unshift_read (type => @args, $cb)	816	=item $handle->unshift_read (type => @args, $cb)
591		817
592	Instead of providing a callback that parses the data itself you can chose	818	Instead of providing a callback that parses the data itself you can chose
593	between a number of predefined parsing formats, for chunks of data, lines	819	between a number of predefined parsing formats, for chunks of data, lines
594	etc.	820	etc.
595		821
596	The types currently supported are:	822	Predefined types are (if you have ideas for additional types, feel free to
		823	drop by and tell us):
597		824
598	=over 4	825	=over 4
599		826
600	=item chunk => $octets, $cb->($self, $data)	827	=item chunk => $octets, $cb->($handle, $data)
601		828
602	Invoke the callback only once C<$octets> bytes have been read. Pass the	829	Invoke the callback only once C<$octets> bytes have been read. Pass the
603	data read to the callback. The callback will never be called with less	830	data read to the callback. The callback will never be called with less
604	data.	831	data.
605		832
…		…
628		855
629	sub unshift_read_chunk {	856	sub unshift_read_chunk {
630	$_[0]->unshift_read (chunk => $_[1], $_[2]);	857	$_[0]->unshift_read (chunk => $_[1], $_[2]);
631	}	858	}
632		859
633	=item line => [$eol, ]$cb->($self, $line, $eol)	860	=item line => [$eol, ]$cb->($handle, $line, $eol)
634		861
635	The callback will be called only once a full line (including the end of	862	The callback will be called only once a full line (including the end of
636	line marker, C<$eol>) has been read. This line (excluding the end of line	863	line marker, C<$eol>) has been read. This line (excluding the end of line
637	marker) will be passed to the callback as second argument (C<$line>), and	864	marker) will be passed to the callback as second argument (C<$line>), and
638	the end of line marker as the third argument (C<$eol>).	865	the end of line marker as the third argument (C<$eol>).
…		…
675	sub unshift_read_line {	902	sub unshift_read_line {
676	my $self = shift;	903	my $self = shift;
677	$self->unshift_read (line => @_);	904	$self->unshift_read (line => @_);
678	}	905	}
679		906
		907	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		908
		909	Makes a regex match against the regex object C<$accept> and returns
		910	everything up to and including the match.
		911
		912	Example: read a single line terminated by '\n'.
		913
		914	$handle->push_read (regex => qr<\n>, sub { ... });
		915
		916	If C<$reject> is given and not undef, then it determines when the data is
		917	to be rejected: it is matched against the data when the C<$accept> regex
		918	does not match and generates an C<EBADMSG> error when it matches. This is
		919	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		920	receive buffer overflow).
		921
		922	Example: expect a single decimal number followed by whitespace, reject
		923	anything else (not the use of an anchor).
		924
		925	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		926
		927	If C<$skip> is given and not C<undef>, then it will be matched against
		928	the receive buffer when neither C<$accept> nor C<$reject> match,
		929	and everything preceding and including the match will be accepted
		930	unconditionally. This is useful to skip large amounts of data that you
		931	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		932	have to start matching from the beginning. This is purely an optimisation
		933	and is usually worth only when you expect more than a few kilobytes.
		934
		935	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		936	expect the header to be very large (it isn't in practise, but...), we use
		937	a skip regex to skip initial portions. The skip regex is tricky in that
		938	it only accepts something not ending in either \015 or \012, as these are
		939	required for the accept regex.
		940
		941	$handle->push_read (regex =>
		942	qr<\015\012\015\012>,
		943	undef, # no reject
		944	qr<^.*[^\015\012]>,
		945	sub { ... });
		946
		947	=cut
		948
		949	register_read_type regex => sub {
		950	my ($self, $cb, $accept, $reject, $skip) = @_;
		951
		952	my $data;
		953	my $rbuf = \$self->{rbuf};
		954
		955	sub {
		956	# accept
		957	if ($$rbuf =~ $accept) {
		958	$data .= substr $$rbuf, 0, $+[0], "";
		959	$cb->($self, $data);
		960	return 1;
		961	}
		962
		963	# reject
		964	if ($reject && $$rbuf =~ $reject) {
		965	$self->_error (&Errno::EBADMSG);
		966	}
		967
		968	# skip
		969	if ($skip && $$rbuf =~ $skip) {
		970	$data .= substr $$rbuf, 0, $+[0], "";
		971	}
		972
		973	()
		974	}
		975	};
		976
680	=item netstring => $cb->($string)	977	=item netstring => $cb->($handle, $string)
681		978
682	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	979	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
683		980
684	Throws an error with C<$!> set to EBADMSG on format violations.	981	Throws an error with C<$!> set to EBADMSG on format violations.
685		982
…		…
689	my ($self, $cb) = @_;	986	my ($self, $cb) = @_;
690		987
691	sub {	988	sub {
692	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	989	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
693	if ($_[0]{rbuf} =~ /[^0-9]/) {	990	if ($_[0]{rbuf} =~ /[^0-9]/) {
694	$! = &Errno::EBADMSG;	991	$self->_error (&Errno::EBADMSG);
695	$self->error;
696	}	992	}
697	return;	993	return;
698	}	994	}
699		995
700	my $len = $1;	996	my $len = $1;
…		…
703	my $string = $_[1];	999	my $string = $_[1];
704	$_[0]->unshift_read (chunk => 1, sub {	1000	$_[0]->unshift_read (chunk => 1, sub {
705	if ($_[1] eq ",") {	1001	if ($_[1] eq ",") {
706	$cb->($_[0], $string);	1002	$cb->($_[0], $string);
707	} else {	1003	} else {
708	$! = &Errno::EBADMSG;	1004	$self->_error (&Errno::EBADMSG);
709	$self->error;
710	}	1005	}
711	});	1006	});
712	});	1007	});
713		1008
714	1	1009	1
715	}	1010	}
716	};	1011	};
717		1012
		1013	=item packstring => $format, $cb->($handle, $string)
		1014
		1015	An octet string prefixed with an encoded length. The encoding C<$format>
		1016	uses the same format as a Perl C<pack> format, but must specify a single
		1017	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1018	optional C<!>, C<< < >> or C<< > >> modifier).
		1019
		1020	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1021
		1022	Example: read a block of data prefixed by its length in BER-encoded
		1023	format (very efficient).
		1024
		1025	$handle->push_read (packstring => "w", sub {
		1026	my ($handle, $data) = @_;
		1027	});
		1028
		1029	=cut
		1030
		1031	register_read_type packstring => sub {
		1032	my ($self, $cb, $format) = @_;
		1033
		1034	sub {
		1035	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1036	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1037	or return;
		1038
		1039	# remove prefix
		1040	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1041
		1042	# read rest
		1043	$_[0]->unshift_read (chunk => $len, $cb);
		1044
		1045	1
		1046	}
		1047	};
		1048
		1049	=item json => $cb->($handle, $hash_or_arrayref)
		1050
		1051	Reads a JSON object or array, decodes it and passes it to the callback.
		1052
		1053	If a C<json> object was passed to the constructor, then that will be used
		1054	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1055
		1056	This read type uses the incremental parser available with JSON version
		1057	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1058	dependency on your own: this module will load the JSON module, but
		1059	AnyEvent does not depend on it itself.
		1060
		1061	Since JSON texts are fully self-delimiting, the C<json> read and write
		1062	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1063	the C<json> write type description, above, for an actual example.
		1064
		1065	=cut
		1066
		1067	register_read_type json => sub {
		1068	my ($self, $cb) = @_;
		1069
		1070	require JSON;
		1071
		1072	my $data;
		1073	my $rbuf = \$self->{rbuf};
		1074
		1075	my $json = $self->{json} \|\|= JSON->new->utf8;
		1076
		1077	sub {
		1078	my $ref = $json->incr_parse ($self->{rbuf});
		1079
		1080	if ($ref) {
		1081	$self->{rbuf} = $json->incr_text;
		1082	$json->incr_text = "";
		1083	$cb->($self, $ref);
		1084
		1085	1
		1086	} else {
		1087	$self->{rbuf} = "";
		1088	()
		1089	}
		1090	}
		1091	};
		1092
		1093	=item storable => $cb->($handle, $ref)
		1094
		1095	Deserialises a L<Storable> frozen representation as written by the
		1096	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1097	data).
		1098
		1099	Raises C<EBADMSG> error if the data could not be decoded.
		1100
		1101	=cut
		1102
		1103	register_read_type storable => sub {
		1104	my ($self, $cb) = @_;
		1105
		1106	require Storable;
		1107
		1108	sub {
		1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1110	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1111	or return;
		1112
		1113	# remove prefix
		1114	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1115
		1116	# read rest
		1117	$_[0]->unshift_read (chunk => $len, sub {
		1118	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1119	$cb->($_[0], $ref);
		1120	} else {
		1121	$self->_error (&Errno::EBADMSG);
		1122	}
		1123	});
		1124	}
		1125	};
		1126
718	=back	1127	=back
719		1128
		1129	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1130
		1131	This function (not method) lets you add your own types to C<push_read>.
		1132
		1133	Whenever the given C<type> is used, C<push_read> will invoke the code
		1134	reference with the handle object, the callback and the remaining
		1135	arguments.
		1136
		1137	The code reference is supposed to return a callback (usually a closure)
		1138	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1139
		1140	It should invoke the passed callback when it is done reading (remember to
		1141	pass C<$handle> as first argument as all other callbacks do that).
		1142
		1143	Note that this is a function, and all types registered this way will be
		1144	global, so try to use unique names.
		1145
		1146	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1147	search for C<register_read_type>)).
		1148
720	=item $handle->stop_read	1149	=item $handle->stop_read
721		1150
722	=item $handle->start_read	1151	=item $handle->start_read
723		1152
724	In rare cases you actually do not want to read anything from the	1153	In rare cases you actually do not want to read anything from the
725	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1154	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
726	any queued callbacks will be executed then. To start reading again, call	1155	any queued callbacks will be executed then. To start reading again, call
727	C<start_read>.	1156	C<start_read>.
728		1157
		1158	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1159	you change the C<on_read> callback or push/unshift a read callback, and it
		1160	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1161	there are any read requests in the queue.
		1162
729	=cut	1163	=cut
730		1164
731	sub stop_read {	1165	sub stop_read {
732	my ($self) = @_;	1166	my ($self) = @_;
733		1167
734	delete $self->{rw};	1168	delete $self->{_rw};
735	}	1169	}
736		1170
737	sub start_read {	1171	sub start_read {
738	my ($self) = @_;	1172	my ($self) = @_;
739		1173
740	unless ($self->{rw} \|\| $self->{eof}) {	1174	unless ($self->{_rw} \|\| $self->{_eof}) {
741	Scalar::Util::weaken $self;	1175	Scalar::Util::weaken $self;
742		1176
743	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1177	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
744	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1178	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1179	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
746		1180
747	if ($len > 0) {	1181	if ($len > 0) {
		1182	$self->{_activity} = AnyEvent->now;
		1183
748	$self->{filter_r}	1184	$self->{filter_r}
749	? $self->{filter_r}->($self, $rbuf)	1185	? $self->{filter_r}($self, $rbuf)
750	: $self->_drain_rbuf;	1186	: $self->{_in_drain} \|\| $self->_drain_rbuf;
751		1187
752	} elsif (defined $len) {	1188	} elsif (defined $len) {
753	delete $self->{rw};	1189	delete $self->{_rw};
754	$self->{eof} = 1;	1190	$self->{_eof} = 1;
755	$self->_drain_rbuf;	1191	$self->_drain_rbuf unless $self->{_in_drain};
756		1192
757	} elsif ($! != EAGAIN && $! != EINTR) {	1193	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
758	return $self->error;	1194	return $self->_error ($!, 1);
759	}	1195	}
760	});	1196	});
761	}	1197	}
762	}	1198	}
763		1199
764	sub _dotls {	1200	sub _dotls {
765	my ($self) = @_;	1201	my ($self) = @_;
766		1202
		1203	my $buf;
		1204
767	if (length $self->{tls_wbuf}) {	1205	if (length $self->{_tls_wbuf}) {
768	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1206	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
769	substr $self->{tls_wbuf}, 0, $len, "";	1207	substr $self->{_tls_wbuf}, 0, $len, "";
770	}	1208	}
771	}	1209	}
772		1210
773	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1211	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
774	$self->{wbuf} .= $buf;	1212	$self->{wbuf} .= $buf;
775	$self->_drain_wbuf;	1213	$self->_drain_wbuf;
776	}	1214	}
777		1215
778	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1216	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1217	if (length $buf) {
779	$self->{rbuf} .= $buf;	1218	$self->{rbuf} .= $buf;
780	$self->_drain_rbuf;	1219	$self->_drain_rbuf unless $self->{_in_drain};
		1220	} else {
		1221	# let's treat SSL-eof as we treat normal EOF
		1222	$self->{_eof} = 1;
		1223	$self->_shutdown;
		1224	return;
		1225	}
781	}	1226	}
782		1227
783	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1228	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
784		1229
785	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1230	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
786	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1231	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
787	$self->error;	1232	return $self->_error ($!, 1);
788	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1233	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
789	$! = &Errno::EIO;	1234	return $self->_error (&Errno::EIO, 1);
790	$self->error;
791	}	1235	}
792		1236
793	# all others are fine for our purposes	1237	# all others are fine for our purposes
794	}	1238	}
795	}	1239	}
…		…
804	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1248	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
805		1249
806	The second argument is the optional C<Net::SSLeay::CTX> object that is	1250	The second argument is the optional C<Net::SSLeay::CTX> object that is
807	used when AnyEvent::Handle has to create its own TLS connection object.	1251	used when AnyEvent::Handle has to create its own TLS connection object.
808		1252
809	=cut	1253	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1254	call and can be used or changed to your liking. Note that the handshake
		1255	might have already started when this function returns.
810		1256
811	# TODO: maybe document...	1257	=cut
		1258
812	sub starttls {	1259	sub starttls {
813	my ($self, $ssl, $ctx) = @_;	1260	my ($self, $ssl, $ctx) = @_;
814		1261
815	$self->stoptls;	1262	$self->stoptls;
816		1263
…		…
828	# but the openssl maintainers basically said: "trust us, it just works".	1275	# but the openssl maintainers basically said: "trust us, it just works".
829	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1276	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
830	# and mismaintained ssleay-module doesn't even offer them).	1277	# and mismaintained ssleay-module doesn't even offer them).
831	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1278	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
832	Net::SSLeay::CTX_set_mode ($self->{tls},	1279	Net::SSLeay::CTX_set_mode ($self->{tls},
833	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1280	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
834	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1281	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
835		1282
836	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1283	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
837	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1284	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
838		1285
839	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1286	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
840		1287
841	$self->{filter_w} = sub {	1288	$self->{filter_w} = sub {
842	$_[0]{tls_wbuf} .= ${$_[1]};	1289	$_[0]{_tls_wbuf} .= ${$_[1]};
843	&_dotls;	1290	&_dotls;
844	};	1291	};
845	$self->{filter_r} = sub {	1292	$self->{filter_r} = sub {
846	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1293	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
847	&_dotls;	1294	&_dotls;
848	};	1295	};
849	}	1296	}
850		1297
851	=item $handle->stoptls	1298	=item $handle->stoptls
…		…
857		1304
858	sub stoptls {	1305	sub stoptls {
859	my ($self) = @_;	1306	my ($self) = @_;
860		1307
861	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1308	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1309
862	delete $self->{tls_rbio};	1310	delete $self->{_rbio};
863	delete $self->{tls_wbio};	1311	delete $self->{_wbio};
864	delete $self->{tls_wbuf};	1312	delete $self->{_tls_wbuf};
865	delete $self->{filter_r};	1313	delete $self->{filter_r};
866	delete $self->{filter_w};	1314	delete $self->{filter_w};
867	}	1315	}
868		1316
869	sub DESTROY {	1317	sub DESTROY {
870	my $self = shift;	1318	my $self = shift;
871		1319
872	$self->stoptls;	1320	$self->stoptls;
		1321
		1322	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1323
		1324	if ($linger && length $self->{wbuf}) {
		1325	my $fh = delete $self->{fh};
		1326	my $wbuf = delete $self->{wbuf};
		1327
		1328	my @linger;
		1329
		1330	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1331	my $len = syswrite $fh, $wbuf, length $wbuf;
		1332
		1333	if ($len > 0) {
		1334	substr $wbuf, 0, $len, "";
		1335	} else {
		1336	@linger = (); # end
		1337	}
		1338	});
		1339	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1340	@linger = ();
		1341	});
		1342	}
873	}	1343	}
874		1344
875	=item AnyEvent::Handle::TLS_CTX	1345	=item AnyEvent::Handle::TLS_CTX
876		1346
877	This function creates and returns the Net::SSLeay::CTX object used by	1347	This function creates and returns the Net::SSLeay::CTX object used by
…		…
907	}	1377	}
908	}	1378	}
909		1379
910	=back	1380	=back
911		1381
		1382	=head1 SUBCLASSING AnyEvent::Handle
		1383
		1384	In many cases, you might want to subclass AnyEvent::Handle.
		1385
		1386	To make this easier, a given version of AnyEvent::Handle uses these
		1387	conventions:
		1388
		1389	=over 4
		1390
		1391	=item * all constructor arguments become object members.
		1392
		1393	At least initially, when you pass a C<tls>-argument to the constructor it
		1394	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1395	mutated later on (for example C<tls> will hold the TLS connection object).
		1396
		1397	=item * other object member names are prefixed with an C<_>.
		1398
		1399	All object members not explicitly documented (internal use) are prefixed
		1400	with an underscore character, so the remaining non-C<_>-namespace is free
		1401	for use for subclasses.
		1402
		1403	=item * all members not documented here and not prefixed with an underscore
		1404	are free to use in subclasses.
		1405
		1406	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1407	member variables, but thats just life, at least it is documented.
		1408
		1409	=back
		1410
912	=head1 AUTHOR	1411	=head1 AUTHOR
913		1412
914	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1413	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
915		1414
916	=cut	1415	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs. Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC