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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC vs.
Revision 1.55 by root, Tue Jun 3 16:15:30 2008 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC vs. Revision 1.55 by root, Tue Jun 3 16:15:30 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC vs.
Revision 1.55 by root, Tue Jun 3 16:15:30 2008 UTC