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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.10 by root, Sat May 3 12:17:35 2008 UTC vs. Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.10 by root, Sat May 3 12:17:35 2008 UTC vs.
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC