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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.21 by root, Sat May 24 15:03:42 2008 UTC vs. Revision 1.62 by root, Fri Jun 6 10:49:20 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.21 by root, Sat May 24 15:03:42 2008 UTC vs.
Revision 1.62 by root, Fri Jun 6 10:49:20 2008 UTC