ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.5 by elmex, Mon Apr 28 08:01:05 2008 UTC vs.
Revision 1.60 by root, Thu Jun 5 18:30:08 2008 UTC

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

Diff Legend

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