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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.27 by root, Sat May 24 15:26:04 2008 UTC vs. Revision 1.65 by root, Fri Jun 6 11:05:16 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.27 by root, Sat May 24 15:26:04 2008 UTC vs.
Revision 1.65 by root, Fri Jun 6 11:05:16 2008 UTC