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.7 by root, Thu May 1 16:35:40 2008 UTC vs.
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC

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

Diff Legend

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