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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
		12	use Time::HiRes qw(time);
12		13
13	=head1 NAME	14	=head1 NAME
14		15
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	16	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		17
…		…
73	The filehandle this L<AnyEvent::Handle> object will operate on.	74	The filehandle this L<AnyEvent::Handle> object will operate on.
74		75
75	NOTE: The filehandle will be set to non-blocking (using	76	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	77	AnyEvent::Util::fh_nonblocking).
77		78
78	=item on_eof => $cb->($self)	79	=item on_eof => $cb->($handle)
79		80
80	Set the callback to be called on EOF.	81	Set the callback to be called on EOF.
81		82
82	While not mandatory, it is highly recommended to set an eof callback,	83	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	otherwise you might end up with a closed socket while you are still
84	waiting for data.	85	waiting for data.
85		86
86	=item on_error => $cb->($self)	87	=item on_error => $cb->($handle)
87		88
88	This is the fatal error callback, that is called when, well, a fatal error	89	This is the fatal error callback, that is called when, well, a fatal error
89	occurs, such as not being able to resolve the hostname, failure to connect	90	occurs, such as not being able to resolve the hostname, failure to connect
90	or a read error.	91	or a read error.
91		92
92	The object will not be in a usable state when this callback has been	93	The object will not be in a usable state when this callback has been
93	called.	94	called.
94		95
95	On callback entrance, the value of C<$!> contains the operating system	96	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	97	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		98
98	The callback should throw an exception. If it returns, then	99	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.	100	AnyEvent::Handle will C<croak> for you.
100		101
101	While not mandatory, it is I<highly> recommended to set this callback, as	102	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	103	you will not be notified of errors otherwise. The default simply calls
103	die.	104	die.
104		105
105	=item on_read => $cb->($self)	106	=item on_read => $cb->($handle)
106		107
107	This sets the default read callback, which is called when data arrives	108	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	109	and no read request is in the queue.
109		110
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	111	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$self->{rbuf}> member directly.	112	method or access the C<$handle->{rbuf}> member directly.
112		113
113	When an EOF condition is detected then AnyEvent::Handle will first try to	114	When an EOF condition is detected then AnyEvent::Handle will first try to
114	feed all the remaining data to the queued callbacks and C<on_read> before	115	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	116	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	117	error will be raised (with C<$!> set to C<EPIPE>).
117		118
118	=item on_drain => $cb->()	119	=item on_drain => $cb->($handle)
119		120
120	This sets the callback that is called when the write buffer becomes empty	121	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	122	(or when the callback is set and the buffer is empty already).
122		123
123	To append to the write buffer, use the C<< ->push_write >> method.	124	To append to the write buffer, use the C<< ->push_write >> method.
		125
		126	=item timeout => $fractional_seconds
		127
		128	If non-zero, then this enables an "inactivity" timeout: whenever this many
		129	seconds pass without a successful read or write on the underlying file
		130	handle, the C<on_timeout> callback will be invoked (and if that one is
		131	missing, an C<ETIMEDOUT> errror will be raised).
		132
		133	Note that timeout processing is also active when you currently do not have
		134	any outstanding read or write requests: If you plan to keep the connection
		135	idle then you should disable the timout temporarily or ignore the timeout
		136	in the C<on_timeout> callback.
		137
		138	Zero (the default) disables this timeout.
		139
		140	=item on_timeout => $cb->($handle)
		141
		142	Called whenever the inactivity timeout passes. If you return from this
		143	callback, then the timeout will be reset as if some activity had happened,
		144	so this condition is not fatal in any way.
124		145
125	=item rbuf_max => <bytes>	146	=item rbuf_max => <bytes>
126		147
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	148	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
128	when the read buffer ever (strictly) exceeds this size. This is useful to	149	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
168		189
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	190	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	191	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	192	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		193
		194	=item json => JSON or JSON::XS object
		195
		196	This is the json coder object used by the C<json> read and write types.
		197
		198	If you don't supply it, then AnyEvent::Handle will create and use a
		199	suitable one, which will write and expect UTF-8 encoded JSON texts.
		200
		201	Note that you are responsible to depend on the JSON module if you want to
		202	use this functionality, as AnyEvent does not have a dependency itself.
		203
173	=item filter_r => $cb	204	=item filter_r => $cb
174		205
175	=item filter_w => $cb	206	=item filter_w => $cb
176		207
177	These exist, but are undocumented at this time.	208	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	223	if ($self->{tls}) {
193	require Net::SSLeay;	224	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	225	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	226	}
196		227
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	228	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	229	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
		230	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	231	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	232
		233	$self->{_activity} = time;
		234	$self->_timeout;
201		235
202	$self->start_read;	236	$self->start_read;
203		237
204	$self	238	$self
205	}	239	}
…		…
252		286
253	sub on_eof {	287	sub on_eof {
254	$_[0]{on_eof} = $_[1];	288	$_[0]{on_eof} = $_[1];
255	}	289	}
256		290
		291	=item $handle->on_timeout ($cb)
		292
		293	Replace the current C<on_timeout> callback, or disables the callback
		294	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		295	argument.
		296
		297	=cut
		298
		299	sub on_timeout {
		300	$_[0]{on_timeout} = $_[1];
		301	}
		302
		303	#############################################################################
		304
		305	=item $handle->timeout ($seconds)
		306
		307	Configures (or disables) the inactivity timeout.
		308
		309	=cut
		310
		311	sub timeout {
		312	my ($self, $timeout) = @_;
		313
		314	$self->{timeout} = $timeout;
		315	$self->_timeout;
		316	}
		317
		318	# reset the timeout watcher, as neccessary
		319	# also check for time-outs
		320	sub _timeout {
		321	my ($self) = @_;
		322
		323	if ($self->{timeout}) {
		324	my $NOW = time;
		325
		326	# when would the timeout trigger?
		327	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		328
		329	warn "next to in $after\n";#d#
		330
		331	# now or in the past already?
		332	if ($after <= 0) {
		333	$self->{_activity} = $NOW;
		334
		335	if ($self->{on_timeout}) {
		336	$self->{on_timeout}->($self);
		337	} else {
		338	$! = Errno::ETIMEDOUT;
		339	$self->error;
		340	}
		341
		342	# callbakx could have changed timeout value, optimise
		343	return unless $self->{timeout};
		344
		345	# calculate new after
		346	$after = $self->{timeout};
		347	}
		348
		349	Scalar::Util::weaken $self;
		350
		351	warn "after $after\n";#d#
		352	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		353	delete $self->{_tw};
		354	$self->_timeout;
		355	});
		356	} else {
		357	delete $self->{_tw};
		358	}
		359	}
		360
257	#############################################################################	361	#############################################################################
258		362
259	=back	363	=back
260		364
261	=head2 WRITE QUEUE	365	=head2 WRITE QUEUE
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	410	my $len = syswrite $self->{fh}, $self->{wbuf};
307		411
308	if ($len >= 0) {	412	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	413	substr $self->{wbuf}, 0, $len, "";
310		414
		415	$self->{_activity} = time;
		416
311	$self->{on_drain}($self)	417	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	418	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	419	&& $self->{on_drain};
314		420
315	delete $self->{_ww} unless length $self->{wbuf};	421	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	422	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	423	$self->error;
318	}	424	}
319	};	425	};
320		426
321	# try to write data immediately	427	# try to write data immediately
…		…
376	my ($self, $string) = @_;	482	my ($self, $string) = @_;
377		483
378	sprintf "%d:%s,", (length $string), $string	484	sprintf "%d:%s,", (length $string), $string
379	};	485	};
380		486
		487	=item json => $array_or_hashref
		488
		489	Encodes the given hash or array reference into a JSON object. Unless you
		490	provide your own JSON object, this means it will be encoded to JSON text
		491	in UTF-8.
		492
		493	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		494	one end of a handle and read them at the other end without using any
		495	additional framing.
		496
		497	The generated JSON text is guaranteed not to contain any newlines: While
		498	this module doesn't need delimiters after or between JSON texts to be
		499	able to read them, many other languages depend on that.
		500
		501	A simple RPC protocol that interoperates easily with others is to send
		502	JSON arrays (or objects, although arrays are usually the better choice as
		503	they mimic how function argument passing works) and a newline after each
		504	JSON text:
		505
		506	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		507	$handle->push_write ("\012");
		508
		509	An AnyEvent::Handle receiver would simply use the C<json> read type and
		510	rely on the fact that the newline will be skipped as leading whitespace:
		511
		512	$handle->push_read (json => sub { my $array = $_[1]; ... });
		513
		514	Other languages could read single lines terminated by a newline and pass
		515	this line into their JSON decoder of choice.
		516
		517	=cut
		518
		519	register_write_type json => sub {
		520	my ($self, $ref) = @_;
		521
		522	require JSON;
		523
		524	$self->{json} ? $self->{json}->encode ($ref)
		525	: JSON::encode_json ($ref)
		526	};
		527
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		529
383	This function (not method) lets you add your own types to C<push_write>.	530	This function (not method) lets you add your own types to C<push_write>.
384	Whenever the given C<type> is used, C<push_write> will invoke the code	531	Whenever the given C<type> is used, C<push_write> will invoke the code
385	reference with the handle object and the remaining arguments.	532	reference with the handle object and the remaining arguments.
386		533
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	773	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	774	drop by and tell us):
628		775
629	=over 4	776	=over 4
630		777
631	=item chunk => $octets, $cb->($self, $data)	778	=item chunk => $octets, $cb->($handle, $data)
632		779
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	780	Invoke the callback only once C<$octets> bytes have been read. Pass the
634	data read to the callback. The callback will never be called with less	781	data read to the callback. The callback will never be called with less
635	data.	782	data.
636		783
…		…
659		806
660	sub unshift_read_chunk {	807	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);	808	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}	809	}
663		810
664	=item line => [$eol, ]$cb->($self, $line, $eol)	811	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		812
666	The callback will be called only once a full line (including the end of	813	The callback will be called only once a full line (including the end of
667	line marker, C<$eol>) has been read. This line (excluding the end of line	814	line marker, C<$eol>) has been read. This line (excluding the end of line
668	marker) will be passed to the callback as second argument (C<$line>), and	815	marker) will be passed to the callback as second argument (C<$line>), and
669	the end of line marker as the third argument (C<$eol>).	816	the end of line marker as the third argument (C<$eol>).
…		…
706	sub unshift_read_line {	853	sub unshift_read_line {
707	my $self = shift;	854	my $self = shift;
708	$self->unshift_read (line => @_);	855	$self->unshift_read (line => @_);
709	}	856	}
710		857
711	=item netstring => $cb->($string)	858	=item netstring => $cb->($handle, $string)
712		859
713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	860	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
714		861
715	Throws an error with C<$!> set to EBADMSG on format violations.	862	Throws an error with C<$!> set to EBADMSG on format violations.
716		863
…		…
744		891
745	1	892	1
746	}	893	}
747	};	894	};
748		895
749	=item regex => $accept[, $reject[, $skip], $cb->($data)	896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		897
751	Makes a regex match against the regex object C<$accept> and returns	898	Makes a regex match against the regex object C<$accept> and returns
752	everything up to and including the match.	899	everything up to and including the match.
753		900
754	Example: read a single line terminated by '\n'.	901	Example: read a single line terminated by '\n'.
…		…
815		962
816	()	963	()
817	}	964	}
818	};	965	};
819		966
		967	=item json => $cb->($handle, $hash_or_arrayref)
		968
		969	Reads a JSON object or array, decodes it and passes it to the callback.
		970
		971	If a C<json> object was passed to the constructor, then that will be used
		972	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		973
		974	This read type uses the incremental parser available with JSON version
		975	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		976	dependency on your own: this module will load the JSON module, but
		977	AnyEvent does not depend on it itself.
		978
		979	Since JSON texts are fully self-delimiting, the C<json> read and write
		980	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		981	the C<json> write type description, above, for an actual example.
		982
		983	=cut
		984
		985	register_read_type json => sub {
		986	my ($self, $cb, $accept, $reject, $skip) = @_;
		987
		988	require JSON;
		989
		990	my $data;
		991	my $rbuf = \$self->{rbuf};
		992
		993	my $json = $self->{json} \|\|= JSON->new->utf8;
		994
		995	sub {
		996	my $ref = $json->incr_parse ($self->{rbuf});
		997
		998	if ($ref) {
		999	$self->{rbuf} = $json->incr_text;
		1000	$json->incr_text = "";
		1001	$cb->($self, $ref);
		1002
		1003	1
		1004	} else {
		1005	$self->{rbuf} = "";
		1006	()
		1007	}
		1008	}
		1009	};
		1010
820	=back	1011	=back
821		1012
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1014
824	This function (not method) lets you add your own types to C<push_read>.	1015	This function (not method) lets you add your own types to C<push_read>.
825		1016
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1017	Whenever the given C<type> is used, C<push_read> will invoke the code
827	reference with the handle object, the callback and the remaining	1018	reference with the handle object, the callback and the remaining
…		…
829		1020
830	The code reference is supposed to return a callback (usually a closure)	1021	The code reference is supposed to return a callback (usually a closure)
831	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1022	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1023
833	It should invoke the passed callback when it is done reading (remember to	1024	It should invoke the passed callback when it is done reading (remember to
834	pass C<$self> as first argument as all other callbacks do that).	1025	pass C<$handle> as first argument as all other callbacks do that).
835		1026
836	Note that this is a function, and all types registered this way will be	1027	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1028	global, so try to use unique names.
838		1029
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1030	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1056	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1057	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1058	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
868		1059
869	if ($len > 0) {	1060	if ($len > 0) {
		1061	$self->{_activity} = time;
		1062
870	$self->{filter_r}	1063	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1064	? $self->{filter_r}->($self, $rbuf)
872	: $self->_drain_rbuf;	1065	: $self->_drain_rbuf;
873		1066
874	} elsif (defined $len) {	1067	} elsif (defined $len) {
875	delete $self->{_rw};	1068	delete $self->{_rw};
		1069	delete $self->{_ww};
		1070	delete $self->{_tw};
876	$self->{_eof} = 1;	1071	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1072	$self->_drain_rbuf;
878		1073
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1074	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1075	return $self->error;
881	}	1076	}
882	});	1077	});
883	}	1078	}
884	}	1079	}

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs. Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC