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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.13 by elmex, Thu May 15 13:32:19 2008 UTC vs. Revision 1.44 by root, Thu May 29 00:00:07 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.13 by elmex, Thu May 15 13:32:19 2008 UTC vs.
Revision 1.44 by root, Thu May 29 00:00:07 2008 UTC