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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.20 by elmex, Sat May 24 08:16:50 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	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.12;
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
24		22
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->broadcast;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
72	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
73		74
74	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
75	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
76		77
77	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
78		79
79	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
80		83
81	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
82	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
83	waiting for data.	86	waiting for data.
84		87
85	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
86		89
87	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
88	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
89	or a read error.	92	connect or a read error.
90		93
91	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
92	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
93		99
94	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
96		102
97	While not mandatory, it is I<highly> recommended to set this callback, as	103	While not mandatory, it is I<highly> recommended to set this callback, as
98	you will not be notified of errors otherwise. The default simply calls	104	you will not be notified of errors otherwise. The default simply calls
99	die.	105	C<croak>.
100		106
101	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
102		108
103	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
104	and no read request is in the queue.	110	and no read request is in the queue.
105		111
106	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 >>
107	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
108		114
109	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
110	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
111	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
112	error will be raised (with C<$!> set to C<EPIPE>).	118	error will be raised (with C<$!> set to C<EPIPE>).
113		119
114	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
115		121
116	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
117	(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).
118		124
119	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.
120		146
121	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
122		148
123	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>)
124	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
…		…
131	isn't finished).	157	isn't finished).
132		158
133	=item read_size => <bytes>	159	=item read_size => <bytes>
134		160
135	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
136	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
137		163
138	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
139		165
140	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
141	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
…		…
144	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
145		171
146	When this parameter is given, it enables TLS (SSL) mode, that means it	172	When this parameter is given, it enables TLS (SSL) mode, that means it
147	will start making tls handshake and will transparently encrypt/decrypt	173	will start making tls handshake and will transparently encrypt/decrypt
148	data.	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).
149		178
150	For the TLS server side, use C<accept>, and for the TLS client side of a	179	For the TLS server side, use C<accept>, and for the TLS client side of a
151	connection, use C<connect> mode.	180	connection, use C<connect> mode.
152		181
153	You can also provide your own TLS connection object, but you have	182	You can also provide your own TLS connection object, but you have
154	to make sure that you call either C<Net::SSLeay::set_connect_state>	183	to make sure that you call either C<Net::SSLeay::set_connect_state>
155	or C<Net::SSLeay::set_accept_state> on it before you pass it to	184	or C<Net::SSLeay::set_accept_state> on it before you pass it to
156	AnyEvent::Handle.	185	AnyEvent::Handle.
157		186
		187	See the C<starttls> method if you need to start TLs negotiation later.
		188
158	=item tls_ctx => $ssl_ctx	189	=item tls_ctx => $ssl_ctx
159		190
160	Use the given Net::SSLeay::CTX object to create the new TLS connection	191	Use the given Net::SSLeay::CTX object to create the new TLS connection
161	(unless a connection object was specified directly). If this parameter is	192	(unless a connection object was specified directly). If this parameter is
162	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
163		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
164	=back	211	=back
165		212
166	=cut	213	=cut
167		214
168	sub new {	215	sub new {
…		…
177	if ($self->{tls}) {	224	if ($self->{tls}) {
178	require Net::SSLeay;	225	require Net::SSLeay;
179	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
180	}	227	}
181		228
182	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
183	$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
184	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
185	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
186		236
187	$self->start_read;	237	$self->start_read;
188		238
189	$self	239	$self
190	}	240	}
191		241
192	sub _shutdown {	242	sub _shutdown {
193	my ($self) = @_;	243	my ($self) = @_;
194		244
		245	delete $self->{_tw};
195	delete $self->{rw};	246	delete $self->{_rw};
196	delete $self->{ww};	247	delete $self->{_ww};
197	delete $self->{fh};	248	delete $self->{fh};
198	}
199		249
		250	$self->stoptls;
		251	}
		252
200	sub error {	253	sub _error {
201	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
202		255
203	{
204	local $!;
205	$self->_shutdown;	256	$self->_shutdown
206	}	257	if $fatal;
		258
		259	$! = $errno;
207		260
208	if ($self->{on_error}) {	261	if ($self->{on_error}) {
209	$self->{on_error}($self);	262	$self->{on_error}($self, $fatal);
210	} else {	263	} else {
211	die "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
212	}	265	}
213	}	266	}
214		267
215	=item $fh = $handle->fh	268	=item $fh = $handle->fh
216		269
217	This method returns the filehandle of the L<AnyEvent::Handle> object.	270	This method returns the file handle of the L<AnyEvent::Handle> object.
218		271
219	=cut	272	=cut
220		273
221	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
222		275
223	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
224		277
225	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).
226		279
…		…
236		289
237	=cut	290	=cut
238		291
239	sub on_eof {	292	sub on_eof {
240	$_[0]{on_eof} = $_[1];	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	# 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	}
241	}	360	}
242		361
243	#############################################################################	362	#############################################################################
244		363
245	=back	364	=back
…		…
282	=cut	401	=cut
283		402
284	sub _drain_wbuf {	403	sub _drain_wbuf {
285	my ($self) = @_;	404	my ($self) = @_;
286		405
287	unless ($self->{ww}) {	406	if (!$self->{_ww} && length $self->{wbuf}) {
		407
288	Scalar::Util::weaken $self;	408	Scalar::Util::weaken $self;
		409
289	my $cb = sub {	410	my $cb = sub {
290	my $len = syswrite $self->{fh}, $self->{wbuf};	411	my $len = syswrite $self->{fh}, $self->{wbuf};
291		412
292	if ($len > 0) {	413	if ($len >= 0) {
293	substr $self->{wbuf}, 0, $len, "";	414	substr $self->{wbuf}, 0, $len, "";
		415
		416	$self->{_activity} = AnyEvent->now;
294		417
295	$self->{on_drain}($self)	418	$self->{on_drain}($self)
296	if $self->{low_water_mark} >= length $self->{wbuf}	419	if $self->{low_water_mark} >= length $self->{wbuf}
297	&& $self->{on_drain};	420	&& $self->{on_drain};
298		421
299	delete $self->{ww} unless length $self->{wbuf};	422	delete $self->{_ww} unless length $self->{wbuf};
300	} elsif ($! != EAGAIN && $! != EINTR) {	423	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
301	$self->error;	424	$self->_error ($!, 1);
302	}	425	}
303	};	426	};
304		427
		428	# try to write data immediately
		429	$cb->();
		430
		431	# if still data left in wbuf, we need to poll
305	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
306		433	if length $self->{wbuf};
307	$cb->($self);
308	};	434	};
		435	}
		436
		437	our %WH;
		438
		439	sub register_write_type($$) {
		440	$WH{$_[0]} = $_[1];
309	}	441	}
310		442
311	sub push_write {	443	sub push_write {
312	my $self = shift;	444	my $self = shift;
313		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
314	if ($self->{filter_w}) {	453	if ($self->{filter_w}) {
315	$self->{filter_w}->($self, \$_[0]);	454	$self->{filter_w}($self, \$_[0]);
316	} else {	455	} else {
317	$self->{wbuf} .= $_[0];	456	$self->{wbuf} .= $_[0];
318	$self->_drain_wbuf;	457	$self->_drain_wbuf;
319	}	458	}
320	}	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
321		540
322	#############################################################################	541	#############################################################################
323		542
324	=back	543	=back
325		544
…		…
349	the specified number of bytes which give an XML datagram.	568	the specified number of bytes which give an XML datagram.
350		569
351	# in the default state, expect some header bytes	570	# in the default state, expect some header bytes
352	$handle->on_read (sub {	571	$handle->on_read (sub {
353	# 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)
354	shift->unshift_read_chunk (4, sub {	573	shift->unshift_read (chunk => 4, sub {
355	# header arrived, decode	574	# header arrived, decode
356	my $len = unpack "N", $_[1];	575	my $len = unpack "N", $_[1];
357		576
358	# now read the payload	577	# now read the payload
359	shift->unshift_read_chunk ($len, sub {	578	shift->unshift_read (chunk => $len, sub {
360	my $xml = $_[1];	579	my $xml = $_[1];
361	# handle xml	580	# handle xml
362	});	581	});
363	});	582	});
364	});	583	});
…		…
371		590
372	# request one	591	# request one
373	$handle->push_write ("request 1\015\012");	592	$handle->push_write ("request 1\015\012");
374		593
375	# 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
376	$handle->push_read_line (sub {	595	$handle->push_read (line => sub {
377	# if we got an "OK", we have to _prepend_ another line,	596	# if we got an "OK", we have to _prepend_ another line,
378	# 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
379	# which are already in the queue when this callback is called	598	# which are already in the queue when this callback is called
380	# we don't do this in case we got an error	599	# we don't do this in case we got an error
381	if ($_[1] eq "OK") {	600	if ($_[1] eq "OK") {
382	$_[0]->unshift_read_line (sub {	601	$_[0]->unshift_read (line => sub {
383	my $response = $_[1];	602	my $response = $_[1];
384	...	603	...
385	});	604	});
386	}	605	}
387	});	606	});
388		607
389	# request two	608	# request two
390	$handle->push_write ("request 2\015\012");	609	$handle->push_write ("request 2\015\012");
391		610
392	# simply read 64 bytes, always	611	# simply read 64 bytes, always
393	$handle->push_read_chunk (64, sub {	612	$handle->push_read (chunk => 64, sub {
394	my $response = $_[1];	613	my $response = $_[1];
395	...	614	...
396	});	615	});
397		616
398	=over 4	617	=over 4
…		…
404		623
405	if (	624	if (
406	defined $self->{rbuf_max}	625	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	626	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	627	) {
409	$! = &Errno::ENOSPC; return $self->error;	628	return $self->_error (&Errno::ENOSPC, 1);
410	}	629	}
411		630
412	return if $self->{in_drain};	631	return if $self->{in_drain};
413	local $self->{in_drain} = 1;	632	local $self->{in_drain} = 1;
414		633
415	while (my $len = length $self->{rbuf}) {	634	while (my $len = length $self->{rbuf}) {
416	no strict 'refs';	635	no strict 'refs';
417	if (my $cb = shift @{ $self->{queue} }) {	636	if (my $cb = shift @{ $self->{_queue} }) {
418	if (!$cb->($self)) {	637	unless ($cb->($self)) {
419	if ($self->{eof}) {	638	if ($self->{_eof}) {
420	# 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)
421	$! = &Errno::EPIPE; return $self->error;	640	return $self->_error (&Errno::EPIPE, 1);
422	}	641	}
423		642
424	unshift @{ $self->{queue} }, $cb;	643	unshift @{ $self->{_queue} }, $cb;
425	return;	644	last;
426	}	645	}
427	} elsif ($self->{on_read}) {	646	} elsif ($self->{on_read}) {
428	$self->{on_read}($self);	647	$self->{on_read}($self);
429		648
430	if (	649	if (
431	$self->{eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed	650	$len == length $self->{rbuf} # if no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty	651	&& !@{ $self->{_queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data	652	&& $self->{on_read} # but we still have on_read
435	) {	653	) {
		654	# no further data will arrive
436	# then no progress can be made	655	# so no progress can be made
437	$! = &Errno::EPIPE; return $self->error;	656	return $self->_error (&Errno::EPIPE, 1)
		657	if $self->{_eof};
		658
		659	last; # more data might arrive
438	}	660	}
439	} else {	661	} else {
440	# read side becomes idle	662	# read side becomes idle
441	delete $self->{rw};	663	delete $self->{_rw};
442	return;	664	last;
443	}	665	}
444	}	666	}
445		667
446	if ($self->{eof}) {
447	$self->_shutdown;
448	$self->{on_eof}($self)	668	$self->{on_eof}($self)
449	if $self->{on_eof};	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} };
450	}	675	}
451	}	676	}
452		677
453	=item $handle->on_read ($cb)	678	=item $handle->on_read ($cb)
454		679
…		…
500	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
501	true, it will be removed from the queue.	726	true, it will be removed from the queue.
502		727
503	=cut	728	=cut
504		729
		730	our %RH;
		731
		732	sub register_read_type($$) {
		733	$RH{$_[0]} = $_[1];
		734	}
		735
505	sub push_read {	736	sub push_read {
506	my ($self, $cb) = @_;	737	my $self = shift;
		738	my $cb = pop;
507		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
508	push @{ $self->{queue} }, $cb;	747	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	748	$self->_drain_rbuf;
510	}	749	}
511		750
512	sub unshift_read {	751	sub unshift_read {
513	my ($self, $cb) = @_;	752	my $self = shift;
		753	my $cb = pop;
514		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
515	push @{ $self->{queue} }, $cb;	763	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	764	$self->_drain_rbuf;
517	}	765	}
518		766
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	767	=item $handle->push_read (type => @args, $cb)
520		768
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	769	=item $handle->unshift_read (type => @args, $cb)
522		770
523	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
524	prepend it (C<unshift_read_chunk>).	772	between a number of predefined parsing formats, for chunks of data, lines
		773	etc.
525		774
526	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
527	these C<$len> bytes will be passed to the callback.	776	drop by and tell us):
528		777
529	=cut	778	=over 4
530		779
531	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 {
532	my ($self, $len, $cb) = @_;	795	my ($self, $cb, $len) = @_;
533		796
534	sub {	797	sub {
535	$len <= length $_[0]{rbuf} or return;	798	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	799	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	800	1
538	}	801	}
539	}	802	};
540		803
		804	# compatibility with older API
541	sub push_read_chunk {	805	sub push_read_chunk {
542	$_[0]->push_read (&_read_chunk);	806	$_[0]->push_read (chunk => $_[1], $_[2]);
543	}	807	}
544
545		808
546	sub unshift_read_chunk {	809	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);	810	$_[0]->unshift_read (chunk => $_[1], $_[2]);
548	}	811	}
549		812
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	813	=item line => [$eol, ]$cb->($handle, $line, $eol)
551
552	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
553
554	Append the given callback to the end of the queue (C<push_read_line>) or
555	prepend it (C<unshift_read_line>).
556		814
557	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
558	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
559	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
560	the end of line marker as the third argument (C<$eol>).	818	the end of line marker as the third argument (C<$eol>).
…		…
571	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
572	not marked by the end of line marker.	830	not marked by the end of line marker.
573		831
574	=cut	832	=cut
575		833
576	sub _read_line($$) {	834	register_read_type line => sub {
577	my $self = shift;	835	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr\|(\015?\012)\|;
580	my $pos;
581		836
		837	$eol = qr\|(\015?\012)\| if @_ < 3;
582	$eol = quotemeta $eol unless ref $eol;	838	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr\|^(.*?)($eol)\|s;	839	$eol = qr\|^(.*?)($eol)\|s;
584		840
585	sub {	841	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	842	$_[0]{rbuf} =~ s/$eol// or return;
587		843
588	$cb->($_[0], $1, $2);	844	$cb->($_[0], $1, $2);
589	1	845	1
590	}	846	}
591	}	847	};
592		848
		849	# compatibility with older API
593	sub push_read_line {	850	sub push_read_line {
594	$_[0]->push_read (&_read_line);	851	my $self = shift;
		852	$self->push_read (line => @_);
595	}	853	}
596		854
597	sub unshift_read_line {	855	sub unshift_read_line {
598	$_[0]->unshift_read (&_read_line);	856	my $self = shift;
		857	$self->unshift_read (line => @_);
599	}	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>)).
600		1031
601	=item $handle->stop_read	1032	=item $handle->stop_read
602		1033
603	=item $handle->start_read	1034	=item $handle->start_read
604		1035
605	In rare cases you actually do not want to read anything from the	1036	In rare cases you actually do not want to read anything from the
606	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
607	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
608	C<start_read>.	1039	C<start_read>.
609		1040
610	=cut	1041	=cut
611		1042
612	sub stop_read {	1043	sub stop_read {
613	my ($self) = @_;	1044	my ($self) = @_;
614		1045
615	delete $self->{rw};	1046	delete $self->{_rw};
616	}	1047	}
617		1048
618	sub start_read {	1049	sub start_read {
619	my ($self) = @_;	1050	my ($self) = @_;
620		1051
621	unless ($self->{rw} \|\| $self->{eof}) {	1052	unless ($self->{_rw} \|\| $self->{_eof}) {
622	Scalar::Util::weaken $self;	1053	Scalar::Util::weaken $self;
623		1054
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1055	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1056	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
626	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1057	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
627		1058
628	if ($len > 0) {	1059	if ($len > 0) {
		1060	$self->{_activity} = AnyEvent->now;
		1061
629	$self->{filter_r}	1062	$self->{filter_r}
630	? $self->{filter_r}->($self, $rbuf)	1063	? $self->{filter_r}($self, $rbuf)
631	: $self->_drain_rbuf;	1064	: $self->_drain_rbuf;
632		1065
633	} elsif (defined $len) {	1066	} elsif (defined $len) {
634	delete $self->{rw};	1067	delete $self->{_rw};
635	$self->{eof} = 1;	1068	$self->{_eof} = 1;
636	$self->_drain_rbuf;	1069	$self->_drain_rbuf;
637		1070
638	} elsif ($! != EAGAIN && $! != EINTR) {	1071	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
639	return $self->error;	1072	return $self->_error ($!, 1);
640	}	1073	}
641	});	1074	});
642	}	1075	}
643	}	1076	}
644		1077
645	sub _dotls {	1078	sub _dotls {
646	my ($self) = @_;	1079	my ($self) = @_;
647		1080
648	if (length $self->{tls_wbuf}) {	1081	if (length $self->{_tls_wbuf}) {
649	my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf});	1082	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "" if $len > 0;	1083	substr $self->{_tls_wbuf}, 0, $len, "";
		1084	}
651	}	1085	}
652		1086
653	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1087	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
654	$self->{wbuf} .= $buf;	1088	$self->{wbuf} .= $buf;
655	$self->_drain_wbuf;	1089	$self->_drain_wbuf;
656	}	1090	}
657		1091
658	if (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1092	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
659	$self->{rbuf} .= $buf;	1093	$self->{rbuf} .= $buf;
660	$self->_drain_rbuf;	1094	$self->_drain_rbuf;
661	} elsif (	1095	}
		1096
662	(my $err = Net::SSLeay::get_error ($self->{tls}, -1))	1097	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		1098
663	!= Net::SSLeay::ERROR_WANT_READ ()	1099	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
664	) {
665	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1100	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
666	$self->error;	1101	return $self->_error ($!, 1);
667	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1102	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
668	$! = &Errno::EIO;	1103	return $self->_error (&Errno::EIO, 1);
669	$self->error;
670	}	1104	}
671		1105
672	# all others are fine for our purposes	1106	# all others are fine for our purposes
673	}	1107	}
674	}	1108	}
675		1109
676	# TODO: maybe document...	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
677	sub starttls {	1128	sub starttls {
678	my ($self, $ssl, $ctx) = @_;	1129	my ($self, $ssl, $ctx) = @_;
		1130
		1131	$self->stoptls;
679		1132
680	if ($ssl eq "accept") {	1133	if ($ssl eq "accept") {
681	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1134	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
682	Net::SSLeay::set_accept_state ($ssl);	1135	Net::SSLeay::set_accept_state ($ssl);
683	} elsif ($ssl eq "connect") {	1136	} elsif ($ssl eq "connect") {
…		…
685	Net::SSLeay::set_connect_state ($ssl);	1138	Net::SSLeay::set_connect_state ($ssl);
686	}	1139	}
687		1140
688	$self->{tls} = $ssl;	1141	$self->{tls} = $ssl;
689		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
690	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1152	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
691	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1153	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
692		1154
693	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1155	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
694		1156
695	$self->{filter_w} = sub {	1157	$self->{filter_w} = sub {
696	$_[0]{tls_wbuf} .= ${$_[1]};	1158	$_[0]{_tls_wbuf} .= ${$_[1]};
697	&_dotls;	1159	&_dotls;
698	};	1160	};
699	$self->{filter_r} = sub {	1161	$self->{filter_r} = sub {
700	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1162	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
701	&_dotls;	1163	&_dotls;
702	};	1164	};
703	}	1165	}
704		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
705	sub DESTROY {	1186	sub DESTROY {
706	my $self = shift;	1187	my $self = shift;
707		1188
708	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1189	$self->stoptls;
709	}	1190	}
710		1191
711	=item AnyEvent::Handle::TLS_CTX	1192	=item AnyEvent::Handle::TLS_CTX
712		1193
713	This function creates and returns the Net::SSLeay::CTX object used by	1194	This function creates and returns the Net::SSLeay::CTX object used by
…		…
743	}	1224	}
744	}	1225	}
745		1226
746	=back	1227	=back
747		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
748	=head1 AUTHOR	1258	=head1 AUTHOR
749		1259
750	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>.
751		1261
752	=cut	1262	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.20 by elmex, Sat May 24 08:16:50 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.20 by elmex, Sat May 24 08:16:50 2008 UTC vs.
Revision 1.55 by root, Tue Jun 3 16:15:30 2008 UTC