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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.11 by root, Sun May 11 17:54:13 2008 UTC vs.
Revision 1.51 by root, Sat May 31 13:38:01 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util ();	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on filehandles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.02';	19	our $VERSION = 4.1;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
29
30	#TODO
31
32	# or use the constructor to pass the callback:
33
34	my $ae_fh2 =
35	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
36	fh => \*STDIN,	30	fh => \*STDIN,
37	on_eof => sub {	31	on_eof => sub {
38	$cv->broadcast;	32	$cv->broadcast;
39	},	33	},
40	#TODO
41	);	34	);
42		35
43	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
44		47
45	=head1 DESCRIPTION	48	=head1 DESCRIPTION
46		49
47	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
48	filehandles (and sockets, see L<AnyEvent::Socket> for an easy way to make	51	filehandles. For utility functions for doing non-blocking connects and accepts
49	non-blocking resolves and connects).	52	on sockets see L<AnyEvent::Util>.
50		53
51	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
52	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
53	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
54		57
…		…
70	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
71		74
72	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
73	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
74		77
75	=item on_eof => $cb->($self) [MANDATORY]	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> error 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
…		…
125	isn't finished).	155	isn't finished).
126		156
127	=item read_size => <bytes>	157	=item read_size => <bytes>
128		158
129	The default read block size (the amount of bytes this module will try to read	159	The default read block size (the amount of bytes this module will try to read
130	on each [loop iteration). Default: C<4096>.	160	during each (loop iteration). Default: C<8192>.
131		161
132	=item low_water_mark => <bytes>	162	=item low_water_mark => <bytes>
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
		243	delete $self->{_tw};
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 = AnyEvent->now;
		325
		326	# when would the timeout trigger?
		327	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		328
		329	# now or in the past already?
		330	if ($after <= 0) {
		331	$self->{_activity} = $NOW;
		332
		333	if ($self->{on_timeout}) {
		334	$self->{on_timeout}($self);
		335	} else {
		336	$! = Errno::ETIMEDOUT;
		337	$self->error;
		338	}
		339
		340	# callbakx could have changed timeout value, optimise
		341	return unless $self->{timeout};
		342
		343	# calculate new after
		344	$after = $self->{timeout};
		345	}
		346
		347	Scalar::Util::weaken $self;
		348
		349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		350	delete $self->{_tw};
		351	$self->_timeout;
		352	});
		353	} else {
		354	delete $self->{_tw};
		355	}
		356	}
		357
213	#############################################################################	358	#############################################################################
214		359
215	=back	360	=back
216		361
217	=head2 WRITE QUEUE	362	=head2 WRITE QUEUE
…		…
220	for reading.	365	for reading.
221		366
222	The write queue is very simple: you can add data to its end, and	367	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.	368	AnyEvent::Handle will automatically try to get rid of it for you.
224		369
225	When data could be writtena nd the write buffer is shorter then the low	370	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.	371	water mark, the C<on_drain> callback will be invoked.
227		372
228	=over 4	373	=over 4
229		374
230	=item $handle->on_drain ($cb)	375	=item $handle->on_drain ($cb)
…		…
249	want (only limited by the available memory), as C<AnyEvent::Handle>	394	want (only limited by the available memory), as C<AnyEvent::Handle>
250	buffers it independently of the kernel.	395	buffers it independently of the kernel.
251		396
252	=cut	397	=cut
253		398
254	sub push_write {	399	sub _drain_wbuf {
255	my ($self, $data) = @_;	400	my ($self) = @_;
256		401
257	$self->{wbuf} .= $data;	402	if (!$self->{_ww} && length $self->{wbuf}) {
258		403
259	unless ($self->{ww}) {
260	Scalar::Util::weaken $self;	404	Scalar::Util::weaken $self;
		405
261	my $cb = sub {	406	my $cb = sub {
262	my $len = syswrite $self->{fh}, $self->{wbuf};	407	my $len = syswrite $self->{fh}, $self->{wbuf};
263		408
264	if ($len > 0) {	409	if ($len >= 0) {
265	substr $self->{wbuf}, 0, $len, "";	410	substr $self->{wbuf}, 0, $len, "";
266		411
		412	$self->{_activity} = AnyEvent->now;
267		413
268	$self->{on_drain}($self)	414	$self->{on_drain}($self)
269	if $self->{low_water_mark} >= length $self->{wbuf}	415	if $self->{low_water_mark} >= length $self->{wbuf}
270	&& $self->{on_drain};	416	&& $self->{on_drain};
271		417
272	delete $self->{ww} unless length $self->{wbuf};	418	delete $self->{_ww} unless length $self->{wbuf};
273	} elsif ($! != EAGAIN && $! != EINTR) {	419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
274	$self->error;	420	$self->error;
275	}	421	}
276	};	422	};
277		423
		424	# try to write data immediately
		425	$cb->();
		426
		427	# if still data left in wbuf, we need to poll
278	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
279		429	if length $self->{wbuf};
280	$cb->($self);
281	};	430	};
282	}	431	}
		432
		433	our %WH;
		434
		435	sub register_write_type($$) {
		436	$WH{$_[0]} = $_[1];
		437	}
		438
		439	sub push_write {
		440	my $self = shift;
		441
		442	if (@_ > 1) {
		443	my $type = shift;
		444
		445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		446	->($self, @_);
		447	}
		448
		449	if ($self->{filter_w}) {
		450	$self->{filter_w}($self, \$_[0]);
		451	} else {
		452	$self->{wbuf} .= $_[0];
		453	$self->_drain_wbuf;
		454	}
		455	}
		456
		457	=item $handle->push_write (type => @args)
		458
		459	=item $handle->unshift_write (type => @args)
		460
		461	Instead of formatting your data yourself, you can also let this module do
		462	the job by specifying a type and type-specific arguments.
		463
		464	Predefined types are (if you have ideas for additional types, feel free to
		465	drop by and tell us):
		466
		467	=over 4
		468
		469	=item netstring => $string
		470
		471	Formats the given value as netstring
		472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		473
		474	=back
		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	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		526
		527	This function (not method) lets you add your own types to C<push_write>.
		528	Whenever the given C<type> is used, C<push_write> will invoke the code
		529	reference with the handle object and the remaining arguments.
		530
		531	The code reference is supposed to return a single octet string that will
		532	be appended to the write buffer.
		533
		534	Note that this is a function, and all types registered this way will be
		535	global, so try to use unique names.
		536
		537	=cut
283		538
284	#############################################################################	539	#############################################################################
285		540
286	=back	541	=back
287		542
…		…
362	=cut	617	=cut
363		618
364	sub _drain_rbuf {	619	sub _drain_rbuf {
365	my ($self) = @_;	620	my ($self) = @_;
366		621
		622	if (
		623	defined $self->{rbuf_max}
		624	&& $self->{rbuf_max} < length $self->{rbuf}
		625	) {
		626	$! = &Errno::ENOSPC;
		627	$self->error;
		628	}
		629
367	return if $self->{in_drain};	630	return if $self->{in_drain};
368	local $self->{in_drain} = 1;	631	local $self->{in_drain} = 1;
369		632
370	while (my $len = length $self->{rbuf}) {	633	while (my $len = length $self->{rbuf}) {
371	no strict 'refs';	634	no strict 'refs';
372	if (my $cb = shift @{ $self->{queue} }) {	635	if (my $cb = shift @{ $self->{_queue} }) {
373	if (!$cb->($self)) {	636	unless ($cb->($self)) {
374	if ($self->{eof}) {	637	if ($self->{_eof}) {
375	# no progress can be made (not enough data and no data forthcoming)	638	# no progress can be made (not enough data and no data forthcoming)
376	$! = &Errno::EPIPE; return $self->error;	639	$! = &Errno::EPIPE;
		640	$self->error;
377	}	641	}
378		642
379	unshift @{ $self->{queue} }, $cb;	643	unshift @{ $self->{_queue} }, $cb;
380	return;	644	return;
381	}	645	}
382	} elsif ($self->{on_read}) {	646	} elsif ($self->{on_read}) {
383	$self->{on_read}($self);	647	$self->{on_read}($self);
384		648
385	if (	649	if (
386	$self->{eof} # if no further data will arrive	650	$self->{_eof} # if no further data will arrive
387	&& $len == length $self->{rbuf} # and no data has been consumed	651	&& $len == length $self->{rbuf} # and no data has been consumed
388	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
389	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # and we still want to read data
390	) {	654	) {
391	# then no progress can be made	655	# then no progress can be made
392	$! = &Errno::EPIPE; return $self->error;	656	$! = &Errno::EPIPE;
		657	$self->error;
393	}	658	}
394	} else {	659	} else {
395	# read side becomes idle	660	# read side becomes idle
396	delete $self->{rw};	661	delete $self->{_rw};
397	return;	662	return;
398	}	663	}
399	}	664	}
400		665
401	if ($self->{eof}) {
402	$self->_shutdown;
403	$self->{on_eof}($self);	666	$self->{on_eof}($self)
404	}	667	if $self->{_eof} && $self->{on_eof};
405	}	668	}
406		669
407	=item $handle->on_read ($cb)	670	=item $handle->on_read ($cb)
408		671
409	This replaces the currently set C<on_read> callback, or clears it (when	672	This replaces the currently set C<on_read> callback, or clears it (when
…		…
442	Append the given callback to the end of the queue (C<push_read>) or	705	Append the given callback to the end of the queue (C<push_read>) or
443	prepend it (C<unshift_read>).	706	prepend it (C<unshift_read>).
444		707
445	The callback is called each time some additional read data arrives.	708	The callback is called each time some additional read data arrives.
446		709
447	It must check wether enough data is in the read buffer already.	710	It must check whether enough data is in the read buffer already.
448		711
449	If not enough data is available, it must return the empty list or a false	712	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	713	value, in which case it will be called repeatedly until enough data is
451	available (or an error condition is detected).	714	available (or an error condition is detected).
452		715
…		…
454	interested in (which can be none at all) and return a true value. After returning	717	interested in (which can be none at all) and return a true value. After returning
455	true, it will be removed from the queue.	718	true, it will be removed from the queue.
456		719
457	=cut	720	=cut
458		721
		722	our %RH;
		723
		724	sub register_read_type($$) {
		725	$RH{$_[0]} = $_[1];
		726	}
		727
459	sub push_read {	728	sub push_read {
460	my ($self, $cb) = @_;	729	my $self = shift;
		730	my $cb = pop;
461		731
		732	if (@_) {
		733	my $type = shift;
		734
		735	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		736	->($self, $cb, @_);
		737	}
		738
462	push @{ $self->{queue} }, $cb;	739	push @{ $self->{_queue} }, $cb;
463	$self->_drain_rbuf;	740	$self->_drain_rbuf;
464	}	741	}
465		742
466	sub unshift_read {	743	sub unshift_read {
467	my ($self, $cb) = @_;	744	my $self = shift;
		745	my $cb = pop;
468		746
		747	if (@_) {
		748	my $type = shift;
		749
		750	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		751	->($self, $cb, @_);
		752	}
		753
		754
469	push @{ $self->{queue} }, $cb;	755	unshift @{ $self->{_queue} }, $cb;
470	$self->_drain_rbuf;	756	$self->_drain_rbuf;
471	}	757	}
472		758
473	=item $handle->push_read_chunk ($len, $cb->($self, $data))	759	=item $handle->push_read (type => @args, $cb)
474		760
475	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	761	=item $handle->unshift_read (type => @args, $cb)
476		762
477	Append the given callback to the end of the queue (C<push_read_chunk>) or	763	Instead of providing a callback that parses the data itself you can chose
478	prepend it (C<unshift_read_chunk>).	764	between a number of predefined parsing formats, for chunks of data, lines
		765	etc.
479		766
480	The callback will be called only once C<$len> bytes have been read, and	767	Predefined types are (if you have ideas for additional types, feel free to
481	these C<$len> bytes will be passed to the callback.	768	drop by and tell us):
482		769
483	=cut	770	=over 4
484		771
485	sub _read_chunk($$) {	772	=item chunk => $octets, $cb->($handle, $data)
		773
		774	Invoke the callback only once C<$octets> bytes have been read. Pass the
		775	data read to the callback. The callback will never be called with less
		776	data.
		777
		778	Example: read 2 bytes.
		779
		780	$handle->push_read (chunk => 2, sub {
		781	warn "yay ", unpack "H*", $_[1];
		782	});
		783
		784	=cut
		785
		786	register_read_type chunk => sub {
486	my ($self, $len, $cb) = @_;	787	my ($self, $cb, $len) = @_;
487		788
488	sub {	789	sub {
489	$len <= length $_[0]{rbuf} or return;	790	$len <= length $_[0]{rbuf} or return;
490	$cb->($self, $_[0], substr $_[0]{rbuf}, 0, $len, "");	791	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
491	1	792	1
492	}	793	}
493	}	794	};
494		795
		796	# compatibility with older API
495	sub push_read_chunk {	797	sub push_read_chunk {
496	$_[0]->push_read (&_read_chunk);	798	$_[0]->push_read (chunk => $_[1], $_[2]);
497	}	799	}
498
499		800
500	sub unshift_read_chunk {	801	sub unshift_read_chunk {
501	$_[0]->unshift_read (&_read_chunk);	802	$_[0]->unshift_read (chunk => $_[1], $_[2]);
502	}	803	}
503		804
504	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	805	=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		806
511	The callback will be called only once a full line (including the end of	807	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	808	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	809	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>).	810	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	821	Partial lines at the end of the stream will never be returned, as they are
526	not marked by the end of line marker.	822	not marked by the end of line marker.
527		823
528	=cut	824	=cut
529		825
530	sub _read_line($$) {	826	register_read_type line => sub {
531	my $self = shift;	827	my ($self, $cb, $eol) = @_;
532	my $cb = pop;
533	my $eol = @_ ? shift : qr\|(\015?\012)\|;
534	my $pos;
535		828
		829	$eol = qr\|(\015?\012)\| if @_ < 3;
536	$eol = qr\|(\Q$eol\E)\| unless ref $eol;	830	$eol = quotemeta $eol unless ref $eol;
537	$eol = qr\|^(.*?)($eol)\|;	831	$eol = qr\|^(.*?)($eol)\|s;
538		832
539	sub {	833	sub {
540	$_[0]{rbuf} =~ s/$eol// or return;	834	$_[0]{rbuf} =~ s/$eol// or return;
541		835
542	$cb->($self, $1, $2);	836	$cb->($_[0], $1, $2);
543	1	837	1
544	}	838	}
545	}	839	};
546		840
		841	# compatibility with older API
547	sub push_read_line {	842	sub push_read_line {
548	$_[0]->push_read (&_read_line);	843	my $self = shift;
		844	$self->push_read (line => @_);
549	}	845	}
550		846
551	sub unshift_read_line {	847	sub unshift_read_line {
552	$_[0]->unshift_read (&_read_line);	848	my $self = shift;
		849	$self->unshift_read (line => @_);
553	}	850	}
		851
		852	=item netstring => $cb->($handle, $string)
		853
		854	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		855
		856	Throws an error with C<$!> set to EBADMSG on format violations.
		857
		858	=cut
		859
		860	register_read_type netstring => sub {
		861	my ($self, $cb) = @_;
		862
		863	sub {
		864	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		865	if ($_[0]{rbuf} =~ /[^0-9]/) {
		866	$! = &Errno::EBADMSG;
		867	$self->error;
		868	}
		869	return;
		870	}
		871
		872	my $len = $1;
		873
		874	$self->unshift_read (chunk => $len, sub {
		875	my $string = $_[1];
		876	$_[0]->unshift_read (chunk => 1, sub {
		877	if ($_[1] eq ",") {
		878	$cb->($_[0], $string);
		879	} else {
		880	$! = &Errno::EBADMSG;
		881	$self->error;
		882	}
		883	});
		884	});
		885
		886	1
		887	}
		888	};
		889
		890	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		891
		892	Makes a regex match against the regex object C<$accept> and returns
		893	everything up to and including the match.
		894
		895	Example: read a single line terminated by '\n'.
		896
		897	$handle->push_read (regex => qr<\n>, sub { ... });
		898
		899	If C<$reject> is given and not undef, then it determines when the data is
		900	to be rejected: it is matched against the data when the C<$accept> regex
		901	does not match and generates an C<EBADMSG> error when it matches. This is
		902	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		903	receive buffer overflow).
		904
		905	Example: expect a single decimal number followed by whitespace, reject
		906	anything else (not the use of an anchor).
		907
		908	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		909
		910	If C<$skip> is given and not C<undef>, then it will be matched against
		911	the receive buffer when neither C<$accept> nor C<$reject> match,
		912	and everything preceding and including the match will be accepted
		913	unconditionally. This is useful to skip large amounts of data that you
		914	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		915	have to start matching from the beginning. This is purely an optimisation
		916	and is usually worth only when you expect more than a few kilobytes.
		917
		918	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		919	expect the header to be very large (it isn't in practise, but...), we use
		920	a skip regex to skip initial portions. The skip regex is tricky in that
		921	it only accepts something not ending in either \015 or \012, as these are
		922	required for the accept regex.
		923
		924	$handle->push_read (regex =>
		925	qr<\015\012\015\012>,
		926	undef, # no reject
		927	qr<^.*[^\015\012]>,
		928	sub { ... });
		929
		930	=cut
		931
		932	register_read_type regex => sub {
		933	my ($self, $cb, $accept, $reject, $skip) = @_;
		934
		935	my $data;
		936	my $rbuf = \$self->{rbuf};
		937
		938	sub {
		939	# accept
		940	if ($$rbuf =~ $accept) {
		941	$data .= substr $$rbuf, 0, $+[0], "";
		942	$cb->($self, $data);
		943	return 1;
		944	}
		945
		946	# reject
		947	if ($reject && $$rbuf =~ $reject) {
		948	$! = &Errno::EBADMSG;
		949	$self->error;
		950	}
		951
		952	# skip
		953	if ($skip && $$rbuf =~ $skip) {
		954	$data .= substr $$rbuf, 0, $+[0], "";
		955	}
		956
		957	()
		958	}
		959	};
		960
		961	=item json => $cb->($handle, $hash_or_arrayref)
		962
		963	Reads a JSON object or array, decodes it and passes it to the callback.
		964
		965	If a C<json> object was passed to the constructor, then that will be used
		966	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		967
		968	This read type uses the incremental parser available with JSON version
		969	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		970	dependency on your own: this module will load the JSON module, but
		971	AnyEvent does not depend on it itself.
		972
		973	Since JSON texts are fully self-delimiting, the C<json> read and write
		974	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		975	the C<json> write type description, above, for an actual example.
		976
		977	=cut
		978
		979	register_read_type json => sub {
		980	my ($self, $cb, $accept, $reject, $skip) = @_;
		981
		982	require JSON;
		983
		984	my $data;
		985	my $rbuf = \$self->{rbuf};
		986
		987	my $json = $self->{json} \|\|= JSON->new->utf8;
		988
		989	sub {
		990	my $ref = $json->incr_parse ($self->{rbuf});
		991
		992	if ($ref) {
		993	$self->{rbuf} = $json->incr_text;
		994	$json->incr_text = "";
		995	$cb->($self, $ref);
		996
		997	1
		998	} else {
		999	$self->{rbuf} = "";
		1000	()
		1001	}
		1002	}
		1003	};
		1004
		1005	=back
		1006
		1007	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1008
		1009	This function (not method) lets you add your own types to C<push_read>.
		1010
		1011	Whenever the given C<type> is used, C<push_read> will invoke the code
		1012	reference with the handle object, the callback and the remaining
		1013	arguments.
		1014
		1015	The code reference is supposed to return a callback (usually a closure)
		1016	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1017
		1018	It should invoke the passed callback when it is done reading (remember to
		1019	pass C<$handle> as first argument as all other callbacks do that).
		1020
		1021	Note that this is a function, and all types registered this way will be
		1022	global, so try to use unique names.
		1023
		1024	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1025	search for C<register_read_type>)).
554		1026
555	=item $handle->stop_read	1027	=item $handle->stop_read
556		1028
557	=item $handle->start_read	1029	=item $handle->start_read
558		1030
559	In rare cases you actually do not want to read anything form the	1031	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	1032	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	1033	any queued callbacks will be executed then. To start reading again, call
562	C<start_read>.	1034	C<start_read>.
563		1035
564	=cut	1036	=cut
565		1037
566	sub stop_read {	1038	sub stop_read {
567	my ($self) = @_;	1039	my ($self) = @_;
568		1040
569	delete $self->{rw};	1041	delete $self->{_rw};
570	}	1042	}
571		1043
572	sub start_read {	1044	sub start_read {
573	my ($self) = @_;	1045	my ($self) = @_;
574		1046
575	unless ($self->{rw} \|\| $self->{eof}) {	1047	unless ($self->{_rw} \|\| $self->{_eof}) {
576	Scalar::Util::weaken $self;	1048	Scalar::Util::weaken $self;
577		1049
578	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1050	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
		1051	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
579	my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} \|\| 8192, length $self->{rbuf};	1052	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
580		1053
581	if ($len > 0) {	1054	if ($len > 0) {
582	if (defined $self->{rbuf_max}) {	1055	$self->{_activity} = AnyEvent->now;
583	if ($self->{rbuf_max} < length $self->{rbuf}) {	1056
584	$! = &Errno::ENOSPC; return $self->error;	1057	$self->{filter_r}
585	}	1058	? $self->{filter_r}($self, $rbuf)
586	}	1059	: $self->_drain_rbuf;
587		1060
588	} elsif (defined $len) {	1061	} elsif (defined $len) {
589	$self->{eof} = 1;
590	delete $self->{rw};	1062	delete $self->{_rw};
		1063	$self->{_eof} = 1;
		1064	$self->_drain_rbuf;
591		1065
592	} elsif ($! != EAGAIN && $! != EINTR) {	1066	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
593	return $self->error;	1067	return $self->error;
594	}	1068	}
595
596	$self->_drain_rbuf;
597	});	1069	});
598	}	1070	}
599	}	1071	}
600		1072
		1073	sub _dotls {
		1074	my ($self) = @_;
		1075
		1076	if (length $self->{_tls_wbuf}) {
		1077	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
		1078	substr $self->{_tls_wbuf}, 0, $len, "";
		1079	}
		1080	}
		1081
		1082	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1083	$self->{wbuf} .= $buf;
		1084	$self->_drain_wbuf;
		1085	}
		1086
		1087	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
		1088	$self->{rbuf} .= $buf;
		1089	$self->_drain_rbuf;
		1090	}
		1091
		1092	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		1093
		1094	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
		1095	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
		1096	$self->error;
		1097	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
		1098	$! = &Errno::EIO;
		1099	$self->error;
		1100	}
		1101
		1102	# all others are fine for our purposes
		1103	}
		1104	}
		1105
		1106	=item $handle->starttls ($tls[, $tls_ctx])
		1107
		1108	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		1109	object is created, you can also do that at a later time by calling
		1110	C<starttls>.
		1111
		1112	The first argument is the same as the C<tls> constructor argument (either
		1113	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1114
		1115	The second argument is the optional C<Net::SSLeay::CTX> object that is
		1116	used when AnyEvent::Handle has to create its own TLS connection object.
		1117
		1118	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1119	call and can be used or changed to your liking. Note that the handshake
		1120	might have already started when this function returns.
		1121
		1122	=cut
		1123
		1124	sub starttls {
		1125	my ($self, $ssl, $ctx) = @_;
		1126
		1127	$self->stoptls;
		1128
		1129	if ($ssl eq "accept") {
		1130	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		1131	Net::SSLeay::set_accept_state ($ssl);
		1132	} elsif ($ssl eq "connect") {
		1133	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		1134	Net::SSLeay::set_connect_state ($ssl);
		1135	}
		1136
		1137	$self->{tls} = $ssl;
		1138
		1139	# basically, this is deep magic (because SSL_read should have the same issues)
		1140	# but the openssl maintainers basically said: "trust us, it just works".
		1141	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		1142	# and mismaintained ssleay-module doesn't even offer them).
		1143	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1144	Net::SSLeay::CTX_set_mode ($self->{tls},
		1145	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
		1146	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1147
		1148	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1149	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1150
		1151	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
		1152
		1153	$self->{filter_w} = sub {
		1154	$_[0]{_tls_wbuf} .= ${$_[1]};
		1155	&_dotls;
		1156	};
		1157	$self->{filter_r} = sub {
		1158	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
		1159	&_dotls;
		1160	};
		1161	}
		1162
		1163	=item $handle->stoptls
		1164
		1165	Destroys the SSL connection, if any. Partial read or write data will be
		1166	lost.
		1167
		1168	=cut
		1169
		1170	sub stoptls {
		1171	my ($self) = @_;
		1172
		1173	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1174
		1175	delete $self->{_rbio};
		1176	delete $self->{_wbio};
		1177	delete $self->{_tls_wbuf};
		1178	delete $self->{filter_r};
		1179	delete $self->{filter_w};
		1180	}
		1181
		1182	sub DESTROY {
		1183	my $self = shift;
		1184
		1185	$self->stoptls;
		1186	}
		1187
		1188	=item AnyEvent::Handle::TLS_CTX
		1189
		1190	This function creates and returns the Net::SSLeay::CTX object used by
		1191	default for TLS mode.
		1192
		1193	The context is created like this:
		1194
		1195	Net::SSLeay::load_error_strings;
		1196	Net::SSLeay::SSLeay_add_ssl_algorithms;
		1197	Net::SSLeay::randomize;
		1198
		1199	my $CTX = Net::SSLeay::CTX_new;
		1200
		1201	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
		1202
		1203	=cut
		1204
		1205	our $TLS_CTX;
		1206
		1207	sub TLS_CTX() {
		1208	$TLS_CTX \|\| do {
		1209	require Net::SSLeay;
		1210
		1211	Net::SSLeay::load_error_strings ();
		1212	Net::SSLeay::SSLeay_add_ssl_algorithms ();
		1213	Net::SSLeay::randomize ();
		1214
		1215	$TLS_CTX = Net::SSLeay::CTX_new ();
		1216
		1217	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
		1218
		1219	$TLS_CTX
		1220	}
		1221	}
		1222
601	=back	1223	=back
602		1224
		1225	=head1 SUBCLASSING AnyEvent::Handle
		1226
		1227	In many cases, you might want to subclass AnyEvent::Handle.
		1228
		1229	To make this easier, a given version of AnyEvent::Handle uses these
		1230	conventions:
		1231
		1232	=over 4
		1233
		1234	=item * all constructor arguments become object members.
		1235
		1236	At least initially, when you pass a C<tls>-argument to the constructor it
		1237	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1238	mutated later on (for example C<tls> will hold the TLS connection object).
		1239
		1240	=item * other object member names are prefixed with an C<_>.
		1241
		1242	All object members not explicitly documented (internal use) are prefixed
		1243	with an underscore character, so the remaining non-C<_>-namespace is free
		1244	for use for subclasses.
		1245
		1246	=item * all members not documented here and not prefixed with an underscore
		1247	are free to use in subclasses.
		1248
		1249	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1250	member variables, but thats just life, at least it is documented.
		1251
		1252	=back
		1253
603	=head1 AUTHOR	1254	=head1 AUTHOR
604		1255
605	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1256	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
606		1257
607	=cut	1258	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.11 by root, Sun May 11 17:54:13 2008 UTC vs. Revision 1.51 by root, Sat May 31 13:38:01 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.11 by root, Sun May 11 17:54:13 2008 UTC vs.
Revision 1.51 by root, Sat May 31 13:38:01 2008 UTC