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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC vs. Revision 1.58 by root, Wed Jun 4 22:51:15 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC vs.
Revision 1.58 by root, Wed Jun 4 22:51:15 2008 UTC