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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.14 by root, Sat May 17 19:05:51 2008 UTC vs. Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.14 by root, Sat May 17 19:05:51 2008 UTC vs.
Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC