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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.143 by root, Mon Jul 6 21:02:34 2009 UTC vs.
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.452;	16	our $VERSION = 4.86;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
		29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	},
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		50
54	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
56		53
57	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
58	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
59	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
60		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
61	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
62	argument.	62	argument.
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
69		69
70	The constructor supports these arguments (all as C<< key => value >> pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	When this parameter is specified, then the C<on_prepare>,
		90	C<on_connect_error> and C<on_connect> callbacks will be called under the
		91	appropriate circumstances:
		92
		93	=over 4
		94
		95	=item on_prepare => $cb->($handle)
		96
		97	This (rarely used) callback is called before a new connection is
		98	attempted, but after the file handle has been created. It could be used to
		99	prepare the file handle with parameters required for the actual connect
		100	(as opposed to settings that can be changed when the connection is already
		101	established).
		102
		103	=item on_connect => $cb->($handle, $host, $port, $retry->())
		104
		105	This callback is called when a connection has been successfully established.
		106
		107	The actual numeric host and port (the socket peername) are passed as
		108	parameters, together with a retry callback.
		109
		110	When, for some reason, the handle is not acceptable, then calling
		111	C<$retry> will continue with the next conenction target (in case of
		112	multi-homed hosts or SRV records there can be multiple connection
		113	endpoints). When it is called then the read and write queues, eof status,
		114	tls status and similar properties of the handle are being reset.
		115
		116	In most cases, ignoring the C<$retry> parameter is the way to go.
		117
		118	=item on_connect_error => $cb->($handle, $message)
		119
		120	This callback is called when the conenction could not be
		121	established. C<$!> will contain the relevant error code, and C<$message> a
		122	message describing it (usually the same as C<"$!">).
		123
		124	If this callback isn't specified, then C<on_error> will be called with a
		125	fatal error instead.
		126
		127	=back
		128
		129	=item on_error => $cb->($handle, $fatal, $message)
		130
		131	This is the error callback, which is called when, well, some error
		132	occured, such as not being able to resolve the hostname, failure to
		133	connect or a read error.
		134
		135	Some errors are fatal (which is indicated by C<$fatal> being true). On
		136	fatal errors the handle object will be destroyed (by a call to C<< ->
		137	destroy >>) after invoking the error callback (which means you are free to
		138	examine the handle object). Examples of fatal errors are an EOF condition
		139	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		140	cases where the other side can close the connection at their will it is
		141	often easiest to not report C<EPIPE> errors in this callback.
		142
		143	AnyEvent::Handle tries to find an appropriate error code for you to check
		144	against, but in some cases (TLS errors), this does not work well. It is
		145	recommended to always output the C<$message> argument in human-readable
		146	error messages (it's usually the same as C<"$!">).
		147
		148	Non-fatal errors can be retried by simply returning, but it is recommended
		149	to simply ignore this parameter and instead abondon the handle object
		150	when this callback is invoked. Examples of non-fatal errors are timeouts
		151	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		152
		153	On callback entrance, the value of C<$!> contains the operating system
		154	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		155	C<EPROTO>).
		156
		157	While not mandatory, it is I<highly> recommended to set this callback, as
		158	you will not be notified of errors otherwise. The default simply calls
		159	C<croak>.
		160
		161	=item on_read => $cb->($handle)
		162
		163	This sets the default read callback, which is called when data arrives
		164	and no read request is in the queue (unlike read queue callbacks, this
		165	callback will only be called when at least one octet of data is in the
		166	read buffer).
		167
		168	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		169	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		170	must not enlarge or modify the read buffer, you can only remove data at
		171	the beginning from it.
		172
		173	When an EOF condition is detected then AnyEvent::Handle will first try to
		174	feed all the remaining data to the queued callbacks and C<on_read> before
		175	calling the C<on_eof> callback. If no progress can be made, then a fatal
		176	error will be raised (with C<$!> set to C<EPIPE>).
		177
		178	Note that, unlike requests in the read queue, an C<on_read> callback
		179	doesn't mean you I<require> some data: if there is an EOF and there
		180	are outstanding read requests then an error will be flagged. With an
		181	C<on_read> callback, the C<on_eof> callback will be invoked.
		182
82	=item on_eof => $cb->($handle)	183	=item on_eof => $cb->($handle)
83		184
84	Set the callback to be called when an end-of-file condition is detected,	185	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	186	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	187	connection cleanly, and there are no outstanding read requests in the
		188	queue (if there are read requests, then an EOF counts as an unexpected
		189	connection close and will be flagged as an error).
87		190
88	For sockets, this just means that the other side has stopped sending data,	191	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	192	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	193	callback and continue writing data, as only the read part has been shut
91	down.	194	down.
92		195
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	196	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	197	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		198
147	=item on_drain => $cb->($handle)	199	=item on_drain => $cb->($handle)
148		200
149	This sets the callback that is called when the write buffer becomes empty	201	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	202	(or when the callback is set and the buffer is empty already).
…		…
249		301
250	A string used to identify the remote site - usually the DNS hostname	302	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	303	(I<not> IDN!) used to create the connection, rarely the IP address.
252		304
253	Apart from being useful in error messages, this string is also used in TLS	305	Apart from being useful in error messages, this string is also used in TLS
254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).	306	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		307	verification will be skipped when C<peername> is not specified or
		308	C<undef>.
255		309
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	310	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		311
258	When this parameter is given, it enables TLS (SSL) mode, that means	312	When this parameter is given, it enables TLS (SSL) mode, that means
259	AnyEvent will start a TLS handshake as soon as the conenction has been	313	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
347		401
348	sub new {	402	sub new {
349	my $class = shift;	403	my $class = shift;
350	my $self = bless { @_ }, $class;	404	my $self = bless { @_ }, $class;
351		405
352	$self->{fh} or Carp::croak "mandatory argument fh is missing";	406	if ($self->{fh}) {
		407	$self->_start;
		408	return unless $self->{fh}; # could be gone by now
		409
		410	} elsif ($self->{connect}) {
		411	require AnyEvent::Socket;
		412
		413	$self->{peername} = $self->{connect}[0]
		414	unless exists $self->{peername};
		415
		416	$self->{_skip_drain_rbuf} = 1;
		417
		418	{
		419	Scalar::Util::weaken (my $self = $self);
		420
		421	$self->{_connect} =
		422	AnyEvent::Socket::tcp_connect (
		423	$self->{connect}[0],
		424	$self->{connect}[1],
		425	sub {
		426	my ($fh, $host, $port, $retry) = @_;
		427
		428	if ($fh) {
		429	$self->{fh} = $fh;
		430
		431	delete $self->{_skip_drain_rbuf};
		432	$self->_start;
		433
		434	$self->{on_connect}
		435	and $self->{on_connect}($self, $host, $port, sub {
		436	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		437	$self->{_skip_drain_rbuf} = 1;
		438	&$retry;
		439	});
		440
		441	} else {
		442	if ($self->{on_connect_error}) {
		443	$self->{on_connect_error}($self, "$!");
		444	$self->destroy;
		445	} else {
		446	$self->fatal ($!, 1);
		447	}
		448	}
		449	},
		450	sub {
		451	local $self->{fh} = $_[0];
		452
		453	$self->{on_prepare}->($self)
		454	if $self->{on_prepare};
		455	}
		456	);
		457	}
		458
		459	} else {
		460	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		461	}
		462
		463	$self
		464	}
		465
		466	sub _start {
		467	my ($self) = @_;
353		468
354	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
355		470
356	$self->{_activity} = AnyEvent->now;	471	$self->{_activity} = AnyEvent->now;
357	$self->_timeout;	472	$self->_timeout;
…		…
362	if $self->{tls};	477	if $self->{tls};
363		478
364	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
365		480
366	$self->start_read	481	$self->start_read
367	if $self->{on_read};	482	if $self->{on_read} \|\| @{ $self->{_queue} };
368
369	$self->{fh} && $self
370	}	483	}
371		484
372	sub _shutdown {	485	#sub _shutdown {
373	my ($self) = @_;	486	# my ($self) = @_;
374		487	#
375	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	488	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
376	$self->{_eof} = 1; # tell starttls et. al to stop trying	489	# $self->{_eof} = 1; # tell starttls et. al to stop trying
377		490	#
378	&_freetls;	491	# &_freetls;
379	}	492	#}
380		493
381	sub _error {	494	sub _error {
382	my ($self, $errno, $fatal, $message) = @_;	495	my ($self, $errno, $fatal, $message) = @_;
383		496
384	$self->_shutdown
385	if $fatal;
386
387	$! = $errno;	497	$! = $errno;
388	$message \|\|= "$!";	498	$message \|\|= "$!";
389		499
390	if ($self->{on_error}) {	500	if ($self->{on_error}) {
391	$self->{on_error}($self, $fatal, $message);	501	$self->{on_error}($self, $fatal, $message);
		502	$self->destroy if $fatal;
392	} elsif ($self->{fh}) {	503	} elsif ($self->{fh}) {
		504	$self->destroy;
393	Carp::croak "AnyEvent::Handle uncaught error: $message";	505	Carp::croak "AnyEvent::Handle uncaught error: $message";
394	}	506	}
395	}	507	}
396		508
397	=item $fh = $handle->fh	509	=item $fh = $handle->fh
…		…
455	sub no_delay {	567	sub no_delay {
456	$_[0]{no_delay} = $_[1];	568	$_[0]{no_delay} = $_[1];
457		569
458	eval {	570	eval {
459	local $SIG{__DIE__};	571	local $SIG{__DIE__};
460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		573	if $_[0]{fh};
461	};	574	};
462	}	575	}
463		576
464	=item $handle->on_starttls ($cb)	577	=item $handle->on_starttls ($cb)
465		578
…		…
499	# reset the timeout watcher, as neccessary	612	# reset the timeout watcher, as neccessary
500	# also check for time-outs	613	# also check for time-outs
501	sub _timeout {	614	sub _timeout {
502	my ($self) = @_;	615	my ($self) = @_;
503		616
504	if ($self->{timeout}) {	617	if ($self->{timeout} && $self->{fh}) {
505	my $NOW = AnyEvent->now;	618	my $NOW = AnyEvent->now;
506		619
507	# when would the timeout trigger?	620	# when would the timeout trigger?
508	my $after = $self->{_activity} + $self->{timeout} - $NOW;	621	my $after = $self->{_activity} + $self->{timeout} - $NOW;
509		622
…		…
512	$self->{_activity} = $NOW;	625	$self->{_activity} = $NOW;
513		626
514	if ($self->{on_timeout}) {	627	if ($self->{on_timeout}) {
515	$self->{on_timeout}($self);	628	$self->{on_timeout}($self);
516	} else {	629	} else {
517	$self->_error (&Errno::ETIMEDOUT);	630	$self->_error (Errno::ETIMEDOUT);
518	}	631	}
519		632
520	# callback could have changed timeout value, optimise	633	# callback could have changed timeout value, optimise
521	return unless $self->{timeout};	634	return unless $self->{timeout};
522		635
…		…
585	Scalar::Util::weaken $self;	698	Scalar::Util::weaken $self;
586		699
587	my $cb = sub {	700	my $cb = sub {
588	my $len = syswrite $self->{fh}, $self->{wbuf};	701	my $len = syswrite $self->{fh}, $self->{wbuf};
589		702
590	if ($len >= 0) {	703	if (defined $len) {
591	substr $self->{wbuf}, 0, $len, "";	704	substr $self->{wbuf}, 0, $len, "";
592		705
593	$self->{_activity} = AnyEvent->now;	706	$self->{_activity} = AnyEvent->now;
594		707
595	$self->{on_drain}($self)	708	$self->{on_drain}($self)
…		…
631	$self->{_tls_wbuf} .= $_[0];	744	$self->{_tls_wbuf} .= $_[0];
632		745
633	&_dotls ($self);	746	&_dotls ($self);
634	} else {	747	} else {
635	$self->{wbuf} .= $_[0];	748	$self->{wbuf} .= $_[0];
636	$self->_drain_wbuf;	749	$self->_drain_wbuf if $self->{fh};
637	}	750	}
638	}	751	}
639		752
640	=item $handle->push_write (type => @args)	753	=item $handle->push_write (type => @args)
641		754
…		…
858	=cut	971	=cut
859		972
860	sub _drain_rbuf {	973	sub _drain_rbuf {
861	my ($self) = @_;	974	my ($self) = @_;
862		975
		976	# avoid recursion
		977	return if exists $self->{_skip_drain_rbuf};
863	local $self->{_in_drain} = 1;	978	local $self->{_skip_drain_rbuf} = 1;
864		979
865	if (	980	if (
866	defined $self->{rbuf_max}	981	defined $self->{rbuf_max}
867	&& $self->{rbuf_max} < length $self->{rbuf}	982	&& $self->{rbuf_max} < length $self->{rbuf}
868	) {	983	) {
869	$self->_error (&Errno::ENOSPC, 1), return;	984	$self->_error (Errno::ENOSPC, 1), return;
870	}	985	}
871		986
872	while () {	987	while () {
873	# we need to use a separate tls read buffer, as we must not receive data while	988	# we need to use a separate tls read buffer, as we must not receive data while
874	# we are draining the buffer, and this can only happen with TLS.	989	# we are draining the buffer, and this can only happen with TLS.
…		…
878		993
879	if (my $cb = shift @{ $self->{_queue} }) {	994	if (my $cb = shift @{ $self->{_queue} }) {
880	unless ($cb->($self)) {	995	unless ($cb->($self)) {
881	if ($self->{_eof}) {	996	if ($self->{_eof}) {
882	# no progress can be made (not enough data and no data forthcoming)	997	# no progress can be made (not enough data and no data forthcoming)
883	$self->_error (&Errno::EPIPE, 1), return;	998	$self->_error (Errno::EPIPE, 1), return;
884	}	999	}
885		1000
886	unshift @{ $self->{_queue} }, $cb;	1001	unshift @{ $self->{_queue} }, $cb;
887	last;	1002	last;
888	}	1003	}
…		…
896	&& !@{ $self->{_queue} } # and the queue is still empty	1011	&& !@{ $self->{_queue} } # and the queue is still empty
897	&& $self->{on_read} # but we still have on_read	1012	&& $self->{on_read} # but we still have on_read
898	) {	1013	) {
899	# no further data will arrive	1014	# no further data will arrive
900	# so no progress can be made	1015	# so no progress can be made
901	$self->_error (&Errno::EPIPE, 1), return	1016	$self->_error (Errno::EPIPE, 1), return
902	if $self->{_eof};	1017	if $self->{_eof};
903		1018
904	last; # more data might arrive	1019	last; # more data might arrive
905	}	1020	}
906	} else {	1021	} else {
…		…
935		1050
936	sub on_read {	1051	sub on_read {
937	my ($self, $cb) = @_;	1052	my ($self, $cb) = @_;
938		1053
939	$self->{on_read} = $cb;	1054	$self->{on_read} = $cb;
940	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1055	$self->_drain_rbuf if $cb;
941	}	1056	}
942		1057
943	=item $handle->rbuf	1058	=item $handle->rbuf
944		1059
945	Returns the read buffer (as a modifiable lvalue).	1060	Returns the read buffer (as a modifiable lvalue).
…		…
997	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1112	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
998	->($self, $cb, @_);	1113	->($self, $cb, @_);
999	}	1114	}
1000		1115
1001	push @{ $self->{_queue} }, $cb;	1116	push @{ $self->{_queue} }, $cb;
1002	$self->_drain_rbuf unless $self->{_in_drain};	1117	$self->_drain_rbuf;
1003	}	1118	}
1004		1119
1005	sub unshift_read {	1120	sub unshift_read {
1006	my $self = shift;	1121	my $self = shift;
1007	my $cb = pop;	1122	my $cb = pop;
…		…
1013	->($self, $cb, @_);	1128	->($self, $cb, @_);
1014	}	1129	}
1015		1130
1016		1131
1017	unshift @{ $self->{_queue} }, $cb;	1132	unshift @{ $self->{_queue} }, $cb;
1018	$self->_drain_rbuf unless $self->{_in_drain};	1133	$self->_drain_rbuf;
1019	}	1134	}
1020		1135
1021	=item $handle->push_read (type => @args, $cb)	1136	=item $handle->push_read (type => @args, $cb)
1022		1137
1023	=item $handle->unshift_read (type => @args, $cb)	1138	=item $handle->unshift_read (type => @args, $cb)
…		…
1156	return 1;	1271	return 1;
1157	}	1272	}
1158		1273
1159	# reject	1274	# reject
1160	if ($reject && $$rbuf =~ $reject) {	1275	if ($reject && $$rbuf =~ $reject) {
1161	$self->_error (&Errno::EBADMSG);	1276	$self->_error (Errno::EBADMSG);
1162	}	1277	}
1163		1278
1164	# skip	1279	# skip
1165	if ($skip && $$rbuf =~ $skip) {	1280	if ($skip && $$rbuf =~ $skip) {
1166	$data .= substr $$rbuf, 0, $+[0], "";	1281	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1182	my ($self, $cb) = @_;	1297	my ($self, $cb) = @_;
1183		1298
1184	sub {	1299	sub {
1185	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1300	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1186	if ($_[0]{rbuf} =~ /[^0-9]/) {	1301	if ($_[0]{rbuf} =~ /[^0-9]/) {
1187	$self->_error (&Errno::EBADMSG);	1302	$self->_error (Errno::EBADMSG);
1188	}	1303	}
1189	return;	1304	return;
1190	}	1305	}
1191		1306
1192	my $len = $1;	1307	my $len = $1;
…		…
1195	my $string = $_[1];	1310	my $string = $_[1];
1196	$_[0]->unshift_read (chunk => 1, sub {	1311	$_[0]->unshift_read (chunk => 1, sub {
1197	if ($_[1] eq ",") {	1312	if ($_[1] eq ",") {
1198	$cb->($_[0], $string);	1313	$cb->($_[0], $string);
1199	} else {	1314	} else {
1200	$self->_error (&Errno::EBADMSG);	1315	$self->_error (Errno::EBADMSG);
1201	}	1316	}
1202	});	1317	});
1203	});	1318	});
1204		1319
1205	1	1320	1
…		…
1295	$json->incr_skip;	1410	$json->incr_skip;
1296		1411
1297	$self->{rbuf} = $json->incr_text;	1412	$self->{rbuf} = $json->incr_text;
1298	$json->incr_text = "";	1413	$json->incr_text = "";
1299		1414
1300	$self->_error (&Errno::EBADMSG);	1415	$self->_error (Errno::EBADMSG);
1301		1416
1302	()	1417	()
1303	} else {	1418	} else {
1304	$self->{rbuf} = "";	1419	$self->{rbuf} = "";
1305		1420
…		…
1342	# read remaining chunk	1457	# read remaining chunk
1343	$_[0]->unshift_read (chunk => $len, sub {	1458	$_[0]->unshift_read (chunk => $len, sub {
1344	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1459	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1345	$cb->($_[0], $ref);	1460	$cb->($_[0], $ref);
1346	} else {	1461	} else {
1347	$self->_error (&Errno::EBADMSG);	1462	$self->_error (Errno::EBADMSG);
1348	}	1463	}
1349	});	1464	});
1350	}	1465	}
1351		1466
1352	1	1467	1
…		…
1416	if ($self->{tls}) {	1531	if ($self->{tls}) {
1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1418		1533
1419	&_dotls ($self);	1534	&_dotls ($self);
1420	} else {	1535	} else {
1421	$self->_drain_rbuf unless $self->{_in_drain};	1536	$self->_drain_rbuf;
1422	}	1537	}
1423		1538
1424	} elsif (defined $len) {	1539	} elsif (defined $len) {
1425	delete $self->{_rw};	1540	delete $self->{_rw};
1426	$self->{_eof} = 1;	1541	$self->{_eof} = 1;
1427	$self->_drain_rbuf unless $self->{_in_drain};	1542	$self->_drain_rbuf;
1428		1543
1429	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1430	return $self->_error ($!, 1);	1545	return $self->_error ($!, 1);
1431	}	1546	}
1432	});	1547	});
…		…
1450	if ($self->{_on_starttls}) {	1565	if ($self->{_on_starttls}) {
1451	(delete $self->{_on_starttls})->($self, undef, $err);	1566	(delete $self->{_on_starttls})->($self, undef, $err);
1452	&_freetls;	1567	&_freetls;
1453	} else {	1568	} else {
1454	&_freetls;	1569	&_freetls;
1455	$self->_error (&Errno::EPROTO, 1, $err);	1570	$self->_error (Errno::EPROTO, 1, $err);
1456	}	1571	}
1457	}	1572	}
1458		1573
1459	# poll the write BIO and send the data if applicable	1574	# poll the write BIO and send the data if applicable
1460	# also decode read data if possible	1575	# also decode read data if possible
…		…
1492	$self->{_eof} = 1;	1607	$self->{_eof} = 1;
1493	}	1608	}
1494	}	1609	}
1495		1610
1496	$self->{_tls_rbuf} .= $tmp;	1611	$self->{_tls_rbuf} .= $tmp;
1497	$self->_drain_rbuf unless $self->{_in_drain};	1612	$self->_drain_rbuf;
1498	$self->{tls} or return; # tls session might have gone away in callback	1613	$self->{tls} or return; # tls session might have gone away in callback
1499	}	1614	}
1500		1615
1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1616	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1502	return $self->_tls_error ($tmp)	1617	return $self->_tls_error ($tmp)
…		…
1517		1632
1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1633	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1519	object is created, you can also do that at a later time by calling	1634	object is created, you can also do that at a later time by calling
1520	C<starttls>.	1635	C<starttls>.
1521		1636
		1637	Starting TLS is currently an asynchronous operation - when you push some
		1638	write data and then call C<< ->starttls >> then TLS negotiation will start
		1639	immediately, after which the queued write data is then sent.
		1640
1522	The first argument is the same as the C<tls> constructor argument (either	1641	The first argument is the same as the C<tls> constructor argument (either
1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1642	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1524		1643
1525	The second argument is the optional C<AnyEvent::TLS> object that is used	1644	The second argument is the optional C<AnyEvent::TLS> object that is used
1526	when AnyEvent::Handle has to create its own TLS connection object, or	1645	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1552		1671
1553	$ctx \|\|= $self->{tls_ctx};	1672	$ctx \|\|= $self->{tls_ctx};
1554		1673
		1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1675
1555	if ("HASH" eq ref $ctx) {	1676	if ("HASH" eq ref $ctx) {
1556	require AnyEvent::TLS;	1677	require AnyEvent::TLS;
1557
1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1559		1678
1560	if ($ctx->{cache}) {	1679	if ($ctx->{cache}) {
1561	my $key = $ctx+0;	1680	my $key = $ctx+0;
1562	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1681	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1563	} else {	1682	} else {
…		…
1635		1754
1636	&_freetls;	1755	&_freetls;
1637		1756
1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1757	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1639		1758
1640	if ($linger && length $self->{wbuf}) {	1759	if ($linger && length $self->{wbuf} && $self->{fh}) {
1641	my $fh = delete $self->{fh};	1760	my $fh = delete $self->{fh};
1642	my $wbuf = delete $self->{wbuf};	1761	my $wbuf = delete $self->{wbuf};
1643		1762
1644	my @linger;	1763	my @linger;
1645		1764
…		…
1669	callbacks, as well as code outside. It does I<NOT> work in a read or write	1788	callbacks, as well as code outside. It does I<NOT> work in a read or write
1670	callback, so when you want to destroy the AnyEvent::Handle object from	1789	callback, so when you want to destroy the AnyEvent::Handle object from
1671	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1790	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1672	that case.	1791	that case.
1673		1792
		1793	Destroying the handle object in this way has the advantage that callbacks
		1794	will be removed as well, so if those are the only reference holders (as
		1795	is common), then one doesn't need to do anything special to break any
		1796	reference cycles.
		1797
1674	The handle might still linger in the background and write out remaining	1798	The handle might still linger in the background and write out remaining
1675	data, as specified by the C<linger> option, however.	1799	data, as specified by the C<linger> option, however.
1676		1800
1677	=cut	1801	=cut
1678		1802
…		…
1745		1869
1746	$handle->on_read (sub { });	1870	$handle->on_read (sub { });
1747	$handle->on_eof (undef);	1871	$handle->on_eof (undef);
1748	$handle->on_error (sub {	1872	$handle->on_error (sub {
1749	my $data = delete $_[0]{rbuf};	1873	my $data = delete $_[0]{rbuf};
1750	undef $handle;
1751	});	1874	});
1752		1875
1753	The reason to use C<on_error> is that TCP connections, due to latencies	1876	The reason to use C<on_error> is that TCP connections, due to latencies
1754	and packets loss, might get closed quite violently with an error, when in	1877	and packets loss, might get closed quite violently with an error, when in
1755	fact, all data has been received.	1878	fact, all data has been received.
…		…
1780		1903
1781	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	1904	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1782	simply connect to it and then create the AnyEvent::Handle with the C<tls>	1905	simply connect to it and then create the AnyEvent::Handle with the C<tls>
1783	parameter:	1906	parameter:
1784		1907
		1908	tcp_connect $host, $port, sub {
		1909	my ($fh) = @_;
		1910
1785	my $handle = new AnyEvent::Handle	1911	my $handle = new AnyEvent::Handle
1786	fh => $fh,	1912	fh => $fh,
1787	tls => "connect",	1913	tls => "connect",
1788	on_error => sub { ... };	1914	on_error => sub { ... };
1789		1915
1790	$handle->push_write (...);	1916	$handle->push_write (...);
		1917	};
1791		1918
1792	=item I want to contact a TLS/SSL server, I do care about security.	1919	=item I want to contact a TLS/SSL server, I do care about security.
1793		1920
1794	Then you #x##TODO#	1921	Then you should additionally enable certificate verification, including
		1922	peername verification, if the protocol you use supports it (see
		1923	L<AnyEvent::TLS>, C<verify_peername>).
1795		1924
1796		1925	E.g. for HTTPS:
		1926
		1927	tcp_connect $host, $port, sub {
		1928	my ($fh) = @_;
		1929
		1930	my $handle = new AnyEvent::Handle
		1931	fh => $fh,
		1932	peername => $host,
		1933	tls => "connect",
		1934	tls_ctx => { verify => 1, verify_peername => "https" },
		1935	...
		1936
		1937	Note that you must specify the hostname you connected to (or whatever
		1938	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1939	peername verification will be done.
		1940
		1941	The above will use the system-dependent default set of trusted CA
		1942	certificates. If you want to check against a specific CA, add the
		1943	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1944
		1945	tls_ctx => {
		1946	verify => 1,
		1947	verify_peername => "https",
		1948	ca_file => "my-ca-cert.pem",
		1949	},
		1950
		1951	=item I want to create a TLS/SSL server, how do I do that?
		1952
		1953	Well, you first need to get a server certificate and key. You have
		1954	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1955	self-signed certificate (cheap. check the search engine of your choice,
		1956	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1957	nice program for that purpose).
		1958
		1959	Then create a file with your private key (in PEM format, see
		1960	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1961	file should then look like this:
		1962
		1963	-----BEGIN RSA PRIVATE KEY-----
		1964	...header data
		1965	... lots of base64'y-stuff
		1966	-----END RSA PRIVATE KEY-----
		1967
		1968	-----BEGIN CERTIFICATE-----
		1969	... lots of base64'y-stuff
		1970	-----END CERTIFICATE-----
		1971
		1972	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1973	specify this file as C<cert_file>:
		1974
		1975	tcp_server undef, $port, sub {
		1976	my ($fh) = @_;
		1977
		1978	my $handle = new AnyEvent::Handle
		1979	fh => $fh,
		1980	tls => "accept",
		1981	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1982	...
		1983
		1984	When you have intermediate CA certificates that your clients might not
		1985	know about, just append them to the C<cert_file>.
1797		1986
1798	=back	1987	=back
1799		1988
1800		1989
1801	=head1 SUBCLASSING AnyEvent::Handle	1990	=head1 SUBCLASSING AnyEvent::Handle

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.143 by root, Mon Jul 6 21:02:34 2009 UTC vs. Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.143 by root, Mon Jul 6 21:02:34 2009 UTC vs.
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC