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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.8 by root, Fri May 2 15:36:10 2008 UTC vs. Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.8 by root, Fri May 2 15:36:10 2008 UTC vs.
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC