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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.26 by root, Sat May 24 15:20:46 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 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.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.
		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	=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
326		564
327	#############################################################################	565	#############################################################################
328		566
329	=back	567	=back
330		568
…		…
342	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
343	or not.	581	or not.
344		582
345	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
346	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
347	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
348	below).	586	done its job (see C<push_read>, below).
349		587
350	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
351	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.
352		590
353	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
354	the specified number of bytes which give an XML datagram.	592	the specified number of bytes which give an XML datagram.
355		593
356	# in the default state, expect some header bytes	594	# in the default state, expect some header bytes
357	$handle->on_read (sub {	595	$handle->on_read (sub {
358	# 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)
359	shift->unshift_read_chunk (4, sub {	597	shift->unshift_read (chunk => 4, sub {
360	# header arrived, decode	598	# header arrived, decode
361	my $len = unpack "N", $_[1];	599	my $len = unpack "N", $_[1];
362		600
363	# now read the payload	601	# now read the payload
364	shift->unshift_read_chunk ($len, sub {	602	shift->unshift_read (chunk => $len, sub {
365	my $xml = $_[1];	603	my $xml = $_[1];
366	# handle xml	604	# handle xml
367	});	605	});
368	});	606	});
369	});	607	});
…		…
376		614
377	# request one	615	# request one
378	$handle->push_write ("request 1\015\012");	616	$handle->push_write ("request 1\015\012");
379		617
380	# 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
381	$handle->push_read_line (sub {	619	$handle->push_read (line => sub {
382	# if we got an "OK", we have to _prepend_ another line,	620	# 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	621	# 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	622	# which are already in the queue when this callback is called
385	# we don't do this in case we got an error	623	# we don't do this in case we got an error
386	if ($_[1] eq "OK") {	624	if ($_[1] eq "OK") {
387	$_[0]->unshift_read_line (sub {	625	$_[0]->unshift_read (line => sub {
388	my $response = $_[1];	626	my $response = $_[1];
389	...	627	...
390	});	628	});
391	}	629	}
392	});	630	});
393		631
394	# request two	632	# request two
395	$handle->push_write ("request 2\015\012");	633	$handle->push_write ("request 2\015\012");
396		634
397	# simply read 64 bytes, always	635	# simply read 64 bytes, always
398	$handle->push_read_chunk (64, sub {	636	$handle->push_read (chunk => 64, sub {
399	my $response = $_[1];	637	my $response = $_[1];
400	...	638	...
401	});	639	});
402		640
403	=over 4	641	=over 4
404		642
405	=cut	643	=cut
406		644
407	sub _drain_rbuf {	645	sub _drain_rbuf {
408	my ($self) = @_;	646	my ($self) = @_;
		647
		648	local $self->{_in_drain} = 1;
409		649
410	if (	650	if (
411	defined $self->{rbuf_max}	651	defined $self->{rbuf_max}
412	&& $self->{rbuf_max} < length $self->{rbuf}	652	&& $self->{rbuf_max} < length $self->{rbuf}
413	) {	653	) {
414	$! = &Errno::ENOSPC; return $self->error;	654	return $self->_error (&Errno::ENOSPC, 1);
415	}	655	}
416		656
417	return if $self->{in_drain};	657	while () {
418	local $self->{in_drain} = 1;
419
420	while (my $len = length $self->{rbuf}) {
421	no strict 'refs';	658	no strict 'refs';
		659
		660	my $len = length $self->{rbuf};
		661
422	if (my $cb = shift @{ $self->{queue} }) {	662	if (my $cb = shift @{ $self->{_queue} }) {
423	if (!$cb->($self)) {	663	unless ($cb->($self)) {
424	if ($self->{eof}) {	664	if ($self->{_eof}) {
425	# 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)
426	$! = &Errno::EPIPE; return $self->error;	666	$self->_error (&Errno::EPIPE, 1), last;
427	}	667	}
428		668
429	unshift @{ $self->{queue} }, $cb;	669	unshift @{ $self->{_queue} }, $cb;
430	return;	670	last;
431	}	671	}
432	} elsif ($self->{on_read}) {	672	} elsif ($self->{on_read}) {
		673	last unless $len;
		674
433	$self->{on_read}($self);	675	$self->{on_read}($self);
434		676
435	if (	677	if (
436	$self->{eof} # if no further data will arrive
437	&& $len == length $self->{rbuf} # and no data has been consumed	678	$len == length $self->{rbuf} # if no data has been consumed
438	&& !@{ $self->{queue} } # and the queue is still empty	679	&& !@{ $self->{_queue} } # and the queue is still empty
439	&& $self->{on_read} # and we still want to read data	680	&& $self->{on_read} # but we still have on_read
440	) {	681	) {
		682	# no further data will arrive
441	# then no progress can be made	683	# so no progress can be made
442	$! = &Errno::EPIPE; return $self->error;	684	$self->_error (&Errno::EPIPE, 1), last
		685	if $self->{_eof};
		686
		687	last; # more data might arrive
443	}	688	}
444	} else {	689	} else {
445	# read side becomes idle	690	# read side becomes idle
446	delete $self->{rw};	691	delete $self->{_rw};
447	return;	692	last;
448	}	693	}
449	}	694	}
450		695
451	if ($self->{eof}) {
452	$self->_shutdown;
453	$self->{on_eof}($self)	696	$self->{on_eof}($self)
454	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} };
455	}	703	}
456	}	704	}
457		705
458	=item $handle->on_read ($cb)	706	=item $handle->on_read ($cb)
459		707
…		…
465		713
466	sub on_read {	714	sub on_read {
467	my ($self, $cb) = @_;	715	my ($self, $cb) = @_;
468		716
469	$self->{on_read} = $cb;	717	$self->{on_read} = $cb;
		718	$self->_drain_rbuf if $cb && !$self->{_in_drain};
470	}	719	}
471		720
472	=item $handle->rbuf	721	=item $handle->rbuf
473		722
474	Returns the read buffer (as a modifiable lvalue).	723	Returns the read buffer (as a modifiable lvalue).
…		…
505	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
506	true, it will be removed from the queue.	755	true, it will be removed from the queue.
507		756
508	=cut	757	=cut
509		758
		759	our %RH;
		760
		761	sub register_read_type($$) {
		762	$RH{$_[0]} = $_[1];
		763	}
		764
510	sub push_read {	765	sub push_read {
511	my ($self, $cb) = @_;	766	my $self = shift;
		767	my $cb = pop;
512		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
513	push @{ $self->{queue} }, $cb;	776	push @{ $self->{_queue} }, $cb;
514	$self->_drain_rbuf;	777	$self->_drain_rbuf unless $self->{_in_drain};
515	}	778	}
516		779
517	sub unshift_read {	780	sub unshift_read {
518	my ($self, $cb) = @_;	781	my $self = shift;
		782	my $cb = pop;
519		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
520	push @{ $self->{queue} }, $cb;	792	unshift @{ $self->{_queue} }, $cb;
521	$self->_drain_rbuf;	793	$self->_drain_rbuf unless $self->{_in_drain};
522	}	794	}
523		795
524	=item $handle->push_read_chunk ($len, $cb->($self, $data))	796	=item $handle->push_read (type => @args, $cb)
525		797
526	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	798	=item $handle->unshift_read (type => @args, $cb)
527		799
528	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
529	prepend it (C<unshift_read_chunk>).	801	between a number of predefined parsing formats, for chunks of data, lines
		802	etc.
530		803
531	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
532	these C<$len> bytes will be passed to the callback.	805	drop by and tell us):
533		806
534	=cut	807	=over 4
535		808
536	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 {
537	my ($self, $len, $cb) = @_;	824	my ($self, $cb, $len) = @_;
538		825
539	sub {	826	sub {
540	$len <= length $_[0]{rbuf} or return;	827	$len <= length $_[0]{rbuf} or return;
541	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	828	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
542	1	829	1
543	}	830	}
544	}	831	};
545		832
		833	# compatibility with older API
546	sub push_read_chunk {	834	sub push_read_chunk {
547	$_[0]->push_read (&_read_chunk);	835	$_[0]->push_read (chunk => $_[1], $_[2]);
548	}	836	}
549
550		837
551	sub unshift_read_chunk {	838	sub unshift_read_chunk {
552	$_[0]->unshift_read (&_read_chunk);	839	$_[0]->unshift_read (chunk => $_[1], $_[2]);
553	}	840	}
554		841
555	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	842	=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		843
562	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
563	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
564	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
565	the end of line marker as the third argument (C<$eol>).	847	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	858	Partial lines at the end of the stream will never be returned, as they are
577	not marked by the end of line marker.	859	not marked by the end of line marker.
578		860
579	=cut	861	=cut
580		862
581	sub _read_line($$) {	863	register_read_type line => sub {
582	my $self = shift;	864	my ($self, $cb, $eol) = @_;
583	my $cb = pop;
584	my $eol = @_ ? shift : qr\|(\015?\012)\|;
585	my $pos;
586		865
		866	$eol = qr\|(\015?\012)\| if @_ < 3;
587	$eol = quotemeta $eol unless ref $eol;	867	$eol = quotemeta $eol unless ref $eol;
588	$eol = qr\|^(.*?)($eol)\|s;	868	$eol = qr\|^(.*?)($eol)\|s;
589		869
590	sub {	870	sub {
591	$_[0]{rbuf} =~ s/$eol// or return;	871	$_[0]{rbuf} =~ s/$eol// or return;
592		872
593	$cb->($_[0], $1, $2);	873	$cb->($_[0], $1, $2);
594	1	874	1
595	}	875	}
596	}	876	};
597		877
		878	# compatibility with older API
598	sub push_read_line {	879	sub push_read_line {
599	$_[0]->push_read (&_read_line);	880	my $self = shift;
		881	$self->push_read (line => @_);
600	}	882	}
601		883
602	sub unshift_read_line {	884	sub unshift_read_line {
603	$_[0]->unshift_read (&_read_line);	885	my $self = shift;
		886	$self->unshift_read (line => @_);
604	}	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>)).
605		1096
606	=item $handle->stop_read	1097	=item $handle->stop_read
607		1098
608	=item $handle->start_read	1099	=item $handle->start_read
609		1100
610	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
611	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
612	any queued callbacks will be executed then. To start reading again, call	1103	any queued callbacks will be executed then. To start reading again, call
613	C<start_read>.	1104	C<start_read>.
614		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.
		1110
615	=cut	1111	=cut
616		1112
617	sub stop_read {	1113	sub stop_read {
618	my ($self) = @_;	1114	my ($self) = @_;
619		1115
620	delete $self->{rw};	1116	delete $self->{_rw};
621	}	1117	}
622		1118
623	sub start_read {	1119	sub start_read {
624	my ($self) = @_;	1120	my ($self) = @_;
625		1121
626	unless ($self->{rw} \|\| $self->{eof}) {	1122	unless ($self->{_rw} \|\| $self->{_eof}) {
627	Scalar::Util::weaken $self;	1123	Scalar::Util::weaken $self;
628		1124
629	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1125	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
630	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1126	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
631	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;
632		1128
633	if ($len > 0) {	1129	if ($len > 0) {
		1130	$self->{_activity} = AnyEvent->now;
		1131
634	$self->{filter_r}	1132	$self->{filter_r}
635	? $self->{filter_r}->($self, $rbuf)	1133	? $self->{filter_r}($self, $rbuf)
636	: $self->_drain_rbuf;	1134	: $self->{_in_drain} \|\| $self->_drain_rbuf;
637		1135
638	} elsif (defined $len) {	1136	} elsif (defined $len) {
639	delete $self->{rw};	1137	delete $self->{_rw};
640	$self->{eof} = 1;	1138	$self->{_eof} = 1;
641	$self->_drain_rbuf;	1139	$self->_drain_rbuf unless $self->{_in_drain};
642		1140
643	} elsif ($! != EAGAIN && $! != EINTR) {	1141	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
644	return $self->error;	1142	return $self->_error ($!, 1);
645	}	1143	}
646	});	1144	});
647	}	1145	}
648	}	1146	}
649		1147
650	sub _dotls {	1148	sub _dotls {
651	my ($self) = @_;	1149	my ($self) = @_;
652		1150
		1151	my $buf;
		1152
653	if (length $self->{tls_wbuf}) {	1153	if (length $self->{_tls_wbuf}) {
654	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1154	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
655	substr $self->{tls_wbuf}, 0, $len, "";	1155	substr $self->{_tls_wbuf}, 0, $len, "";
656	}	1156	}
657	}	1157	}
658		1158
659	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1159	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
660	$self->{wbuf} .= $buf;	1160	$self->{wbuf} .= $buf;
661	$self->_drain_wbuf;	1161	$self->_drain_wbuf;
662	}	1162	}
663		1163
664	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1164	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1165	if (length $buf) {
665	$self->{rbuf} .= $buf;	1166	$self->{rbuf} .= $buf;
666	$self->_drain_rbuf;	1167	$self->_drain_rbuf unless $self->{_in_drain};
		1168	} else {
		1169	# let's treat SSL-eof as we treat normal EOF
		1170	$self->{_eof} = 1;
		1171	$self->_shutdown;
		1172	return;
		1173	}
667	}	1174	}
668		1175
669	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1176	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
670		1177
671	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1178	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
672	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1179	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
673	$self->error;	1180	return $self->_error ($!, 1);
674	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1181	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
675	$! = &Errno::EIO;	1182	return $self->_error (&Errno::EIO, 1);
676	$self->error;
677	}	1183	}
678		1184
679	# all others are fine for our purposes	1185	# all others are fine for our purposes
680	}	1186	}
681	}	1187	}
…		…
690	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1196	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
691		1197
692	The second argument is the optional C<Net::SSLeay::CTX> object that is	1198	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.	1199	used when AnyEvent::Handle has to create its own TLS connection object.
694		1200
695	=cut	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.
696		1204
697	# TODO: maybe document...	1205	=cut
		1206
698	sub starttls {	1207	sub starttls {
699	my ($self, $ssl, $ctx) = @_;	1208	my ($self, $ssl, $ctx) = @_;
700		1209
701	$self->stoptls;	1210	$self->stoptls;
702		1211
…		…
712		1221
713	# 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)
714	# but the openssl maintainers basically said: "trust us, it just works".	1223	# but the openssl maintainers basically said: "trust us, it just works".
715	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1224	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
716	# 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
717	Net::SSLeay::CTX_set_mode ($self->{tls},	1227	Net::SSLeay::CTX_set_mode ($self->{tls},
718	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1228	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
719	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1229	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
720		1230
721	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1231	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
722	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1232	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
723		1233
724	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1234	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
725		1235
726	$self->{filter_w} = sub {	1236	$self->{filter_w} = sub {
727	$_[0]{tls_wbuf} .= ${$_[1]};	1237	$_[0]{_tls_wbuf} .= ${$_[1]};
728	&_dotls;	1238	&_dotls;
729	};	1239	};
730	$self->{filter_r} = sub {	1240	$self->{filter_r} = sub {
731	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1241	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
732	&_dotls;	1242	&_dotls;
733	};	1243	};
734	}	1244	}
735		1245
736	=item $handle->stoptls	1246	=item $handle->stoptls
…		…
742		1252
743	sub stoptls {	1253	sub stoptls {
744	my ($self) = @_;	1254	my ($self) = @_;
745		1255
746	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1256	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1257
747	delete $self->{tls_rbio};	1258	delete $self->{_rbio};
748	delete $self->{tls_wbio};	1259	delete $self->{_wbio};
749	delete $self->{tls_wbuf};	1260	delete $self->{_tls_wbuf};
750	delete $self->{filter_r};	1261	delete $self->{filter_r};
751	delete $self->{filter_w};	1262	delete $self->{filter_w};
752	}	1263	}
753		1264
754	sub DESTROY {	1265	sub DESTROY {
755	my $self = shift;	1266	my $self = shift;
756		1267
757	$self->stoptls;	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	}
758	}	1291	}
759		1292
760	=item AnyEvent::Handle::TLS_CTX	1293	=item AnyEvent::Handle::TLS_CTX
761		1294
762	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
…		…
792	}	1325	}
793	}	1326	}
794		1327
795	=back	1328	=back
796		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
797	=head1 AUTHOR	1359	=head1 AUTHOR
798		1360
799	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>.
800		1362
801	=cut	1363	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.26 by root, Sat May 24 15:20:46 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.26 by root, Sat May 24 15:20:46 2008 UTC vs.
Revision 1.62 by root, Fri Jun 6 10:49:20 2008 UTC