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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC vs.
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles 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 = 4.151;	19	our $VERSION = 4.3;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
49		49
50	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
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	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
59	argument.	62	argument.
60		63
		64	=head2 SIGPIPE is not handled by this module
		65
		66	SIGPIPE is not handled by this module, so one of the practical
		67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
		68	'IGNORE'>). At least, this is highly recommend in a networked program: If
		69	you use AnyEvent::Handle in a filter program (like sort), exiting on
		70	SIGPIPE is probably the right thing to do.
		71
61	=head1 METHODS	72	=head1 METHODS
62		73
63	=over 4	74	=over 4
64		75
65	=item B<new (%args)>	76	=item B<new (%args)>
…		…
70		81
71	=item fh => $filehandle [MANDATORY]	82	=item fh => $filehandle [MANDATORY]
72		83
73	The filehandle this L<AnyEvent::Handle> object will operate on.	84	The filehandle this L<AnyEvent::Handle> object will operate on.
74		85
75	NOTE: The filehandle will be set to non-blocking (using	86	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		88	that mode.
77		89
78	=item on_eof => $cb->($handle)	90	=item on_eof => $cb->($handle)
79		91
80	Set the callback to be called when an end-of-file condition is detcted,	92	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	93	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	94	connection cleanly.
83		95
		96	For sockets, this just means that the other side has stopped sending data,
		97	you can still try to write data, and, in fact, one can return from the eof
		98	callback and continue writing data, as only the read part has been shut
		99	down.
		100
84	While not mandatory, it is highly recommended to set an eof callback,	101	While not mandatory, it is I<highly> recommended to set an eof callback,
85	otherwise you might end up with a closed socket while you are still	102	otherwise you might end up with a closed socket while you are still
86	waiting for data.	103	waiting for data.
		104
		105	If an EOF condition has been detected but no C<on_eof> callback has been
		106	set, then a fatal error will be raised with C<$!> set to <0>.
87		107
88	=item on_error => $cb->($handle, $fatal)	108	=item on_error => $cb->($handle, $fatal)
89		109
90	This is the error callback, which is called when, well, some error	110	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	111	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	112	connect or a read error.
93		113
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	114	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	115	fatal errors the handle object will be shut down and will not be usable
		116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		117	errors are an EOF condition with active (but unsatisifable) read watchers
		118	(C<EPIPE>) or I/O errors.
		119
96	usable. Non-fatal errors can be retried by simply returning, but it is	120	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	121	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	122	when this callback is invoked. Examples of non-fatal errors are timeouts
		123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		124
100	On callback entrance, the value of C<$!> contains the operating system	125	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		127
103	While not mandatory, it is I<highly> recommended to set this callback, as	128	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
135	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
136		161
137	If non-zero, then this enables an "inactivity" timeout: whenever this many	162	If non-zero, then this enables an "inactivity" timeout: whenever this many
138	seconds pass without a successful read or write on the underlying file	163	seconds pass without a successful read or write on the underlying file
139	handle, the C<on_timeout> callback will be invoked (and if that one is	164	handle, the C<on_timeout> callback will be invoked (and if that one is
140	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
141		166
142	Note that timeout processing is also active when you currently do not have	167	Note that timeout processing is also active when you currently do not have
143	any outstanding read or write requests: If you plan to keep the connection	168	any outstanding read or write requests: If you plan to keep the connection
144	idle then you should disable the timout temporarily or ignore the timeout	169	idle then you should disable the timout temporarily or ignore the timeout
145	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
146		172
147	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
148		174
149	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
150		176
…		…
154		180
155	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
156		182
157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	183	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158	when the read buffer ever (strictly) exceeds this size. This is useful to	184	when the read buffer ever (strictly) exceeds this size. This is useful to
159	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
160		186
161	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
162	be configured to accept only so-and-so much data that it cannot act on	188	be configured to accept only so-and-so much data that it cannot act on
163	(for example, when expecting a line, an attacker could send an unlimited	189	(for example, when expecting a line, an attacker could send an unlimited
164	amount of data without a callback ever being called as long as the line	190	amount of data without a callback ever being called as long as the line
165	isn't finished).	191	isn't finished).
166		192
		193	=item autocork => <boolean>
		194
		195	When disabled (the default), then C<push_write> will try to immediately
		196	write the data to the handle, if possible. This avoids having to register
		197	a write watcher and wait for the next event loop iteration, but can
		198	be inefficient if you write multiple small chunks (on the wire, this
		199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
		201
		202	When enabled, then writes will always be queued till the next event loop
		203	iteration. This is efficient when you do many small writes per iteration,
		204	but less efficient when you do a single write only per iteration (or when
		205	the write buffer often is full). It also increases write latency.
		206
		207	=item no_delay => <boolean>
		208
		209	When doing small writes on sockets, your operating system kernel might
		210	wait a bit for more data before actually sending it out. This is called
		211	the Nagle algorithm, and usually it is beneficial.
		212
		213	In some situations you want as low a delay as possible, which can be
		214	accomplishd by setting this option to a true value.
		215
		216	The default is your opertaing system's default behaviour (most likely
		217	enabled), this option explicitly enables or disables it, if possible.
		218
167	=item read_size => <bytes>	219	=item read_size => <bytes>
168		220
169	The default read block size (the amount of bytes this module will try to read	221	The default read block size (the amount of bytes this module will
170	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
171		224
172	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
173		226
174	Sets the amount of bytes (default: C<0>) that make up an "empty" write	227	Sets the amount of bytes (default: C<0>) that make up an "empty" write
175	buffer: If the write reaches this size or gets even samller it is	228	buffer: If the write reaches this size or gets even samller it is
176	considered empty.	229	considered empty.
177		230
		231	Sometimes it can be beneficial (for performance reasons) to add data to
		232	the write buffer before it is fully drained, but this is a rare case, as
		233	the operating system kernel usually buffers data as well, so the default
		234	is good in almost all cases.
		235
178	=item linger => <seconds>	236	=item linger => <seconds>
179		237
180	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
181	AnyEvent::Handle object will check wether there is still outstanding write	239	AnyEvent::Handle object will check whether there is still outstanding
182	data and will install a watcher that will write out this data. No errors	240	write data and will install a watcher that will write this data to the
183	will be reported (this mostly matches how the operating system treats	241	socket. No errors will be reported (this mostly matches how the operating
184	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
185		243
186	This will not work for partial TLS data that could not yet been	244	This will not work for partial TLS data that could not be encoded
187	encoded. This data will be lost.	245	yet. This data will be lost.
188		246
189	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
190		248
191	When this parameter is given, it enables TLS (SSL) mode, that means it	249	When this parameter is given, it enables TLS (SSL) mode, that means
192	will start making tls handshake and will transparently encrypt/decrypt	250	AnyEvent will start a TLS handshake as soon as the conenction has been
193	data.	251	established and will transparently encrypt/decrypt data afterwards.
194		252
195	TLS mode requires Net::SSLeay to be installed (it will be loaded	253	TLS mode requires Net::SSLeay to be installed (it will be loaded
196	automatically when you try to create a TLS handle).	254	automatically when you try to create a TLS handle): this module doesn't
		255	have a dependency on that module, so if your module requires it, you have
		256	to add the dependency yourself.
197		257
198	For the TLS server side, use C<accept>, and for the TLS client side of a	258	Unlike TCP, TLS has a server and client side: for the TLS server side, use
199	connection, use C<connect> mode.	259	C<accept>, and for the TLS client side of a connection, use C<connect>
		260	mode.
200		261
201	You can also provide your own TLS connection object, but you have	262	You can also provide your own TLS connection object, but you have
202	to make sure that you call either C<Net::SSLeay::set_connect_state>	263	to make sure that you call either C<Net::SSLeay::set_connect_state>
203	or C<Net::SSLeay::set_accept_state> on it before you pass it to	264	or C<Net::SSLeay::set_accept_state> on it before you pass it to
204	AnyEvent::Handle.	265	AnyEvent::Handle.
205		266
206	See the C<starttls> method if you need to start TLs negotiation later.	267	See the C<< ->starttls >> method for when need to start TLS negotiation later.
207		268
208	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
209		270
210	Use the given Net::SSLeay::CTX object to create the new TLS connection	271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
211	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
212	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
213		274
214	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
215		276
216	This is the json coder object used by the C<json> read and write types.	277	This is the json coder object used by the C<json> read and write types.
217		278
218	If you don't supply it, then AnyEvent::Handle will create and use a	279	If you don't supply it, then AnyEvent::Handle will create and use a
219	suitable one, which will write and expect UTF-8 encoded JSON texts.	280	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		281	texts.
220		282
221	Note that you are responsible to depend on the JSON module if you want to	283	Note that you are responsible to depend on the JSON module if you want to
222	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
223		285
224	=item filter_r => $cb	286	=item filter_r => $cb
225		287
226	=item filter_w => $cb	288	=item filter_w => $cb
227		289
228	These exist, but are undocumented at this time.	290	These exist, but are undocumented at this time. (They are used internally
		291	by the TLS code).
229		292
230	=back	293	=back
231		294
232	=cut	295	=cut
233		296
…		…
246	}	309	}
247		310
248	$self->{_activity} = AnyEvent->now;	311	$self->{_activity} = AnyEvent->now;
249	$self->_timeout;	312	$self->_timeout;
250		313
251	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
252		316
253	$self->start_read	317	$self->start_read
254	if $self->{on_read};	318	if $self->{on_read};
255		319
256	$self	320	$self
…		…
262	delete $self->{_tw};	326	delete $self->{_tw};
263	delete $self->{_rw};	327	delete $self->{_rw};
264	delete $self->{_ww};	328	delete $self->{_ww};
265	delete $self->{fh};	329	delete $self->{fh};
266		330
267	$self->stoptls;	331	&_freetls;
		332
		333	delete $self->{on_read};
		334	delete $self->{_queue};
268	}	335	}
269		336
270	sub _error {	337	sub _error {
271	my ($self, $errno, $fatal) = @_;	338	my ($self, $errno, $fatal) = @_;
272		339
…		…
282	}	349	}
283	}	350	}
284		351
285	=item $fh = $handle->fh	352	=item $fh = $handle->fh
286		353
287	This method returns the file handle of the L<AnyEvent::Handle> object.	354	This method returns the file handle used to create the L<AnyEvent::Handle> object.
288		355
289	=cut	356	=cut
290		357
291	sub fh { $_[0]{fh} }	358	sub fh { $_[0]{fh} }
292		359
…		…
310	$_[0]{on_eof} = $_[1];	377	$_[0]{on_eof} = $_[1];
311	}	378	}
312		379
313	=item $handle->on_timeout ($cb)	380	=item $handle->on_timeout ($cb)
314		381
315	Replace the current C<on_timeout> callback, or disables the callback	382	Replace the current C<on_timeout> callback, or disables the callback (but
316	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	383	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
317	argument.	384	argument and method.
318		385
319	=cut	386	=cut
320		387
321	sub on_timeout {	388	sub on_timeout {
322	$_[0]{on_timeout} = $_[1];	389	$_[0]{on_timeout} = $_[1];
		390	}
		391
		392	=item $handle->autocork ($boolean)
		393
		394	Enables or disables the current autocork behaviour (see C<autocork>
		395	constructor argument).
		396
		397	=cut
		398
		399	=item $handle->no_delay ($boolean)
		400
		401	Enables or disables the C<no_delay> setting (see constructor argument of
		402	the same name for details).
		403
		404	=cut
		405
		406	sub no_delay {
		407	$_[0]{no_delay} = $_[1];
		408
		409	eval {
		410	local $SIG{__DIE__};
		411	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		412	};
323	}	413	}
324		414
325	#############################################################################	415	#############################################################################
326		416
327	=item $handle->timeout ($seconds)	417	=item $handle->timeout ($seconds)
…		…
442	$self->_error ($!, 1);	532	$self->_error ($!, 1);
443	}	533	}
444	};	534	};
445		535
446	# try to write data immediately	536	# try to write data immediately
447	$cb->();	537	$cb->() unless $self->{autocork};
448		538
449	# if still data left in wbuf, we need to poll	539	# if still data left in wbuf, we need to poll
450	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	540	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
451	if length $self->{wbuf};	541	if length $self->{wbuf};
452	};	542	};
…		…
678		768
679	if (	769	if (
680	defined $self->{rbuf_max}	770	defined $self->{rbuf_max}
681	&& $self->{rbuf_max} < length $self->{rbuf}	771	&& $self->{rbuf_max} < length $self->{rbuf}
682	) {	772	) {
683	return $self->_error (&Errno::ENOSPC, 1);	773	$self->_error (&Errno::ENOSPC, 1), return;
684	}	774	}
685		775
686	while () {	776	while () {
687	no strict 'refs';
688
689	my $len = length $self->{rbuf};	777	my $len = length $self->{rbuf};
690		778
691	if (my $cb = shift @{ $self->{_queue} }) {	779	if (my $cb = shift @{ $self->{_queue} }) {
692	unless ($cb->($self)) {	780	unless ($cb->($self)) {
693	if ($self->{_eof}) {	781	if ($self->{_eof}) {
694	# no progress can be made (not enough data and no data forthcoming)	782	# no progress can be made (not enough data and no data forthcoming)
695	$self->_error (&Errno::EPIPE, 1), last;	783	$self->_error (&Errno::EPIPE, 1), return;
696	}	784	}
697		785
698	unshift @{ $self->{_queue} }, $cb;	786	unshift @{ $self->{_queue} }, $cb;
699	last;	787	last;
700	}	788	}
…		…
708	&& !@{ $self->{_queue} } # and the queue is still empty	796	&& !@{ $self->{_queue} } # and the queue is still empty
709	&& $self->{on_read} # but we still have on_read	797	&& $self->{on_read} # but we still have on_read
710	) {	798	) {
711	# no further data will arrive	799	# no further data will arrive
712	# so no progress can be made	800	# so no progress can be made
713	$self->_error (&Errno::EPIPE, 1), last	801	$self->_error (&Errno::EPIPE, 1), return
714	if $self->{_eof};	802	if $self->{_eof};
715		803
716	last; # more data might arrive	804	last; # more data might arrive
717	}	805	}
718	} else {	806	} else {
…		…
720	delete $self->{_rw};	808	delete $self->{_rw};
721	last;	809	last;
722	}	810	}
723	}	811	}
724		812
		813	if ($self->{_eof}) {
		814	if ($self->{on_eof}) {
725	$self->{on_eof}($self)	815	$self->{on_eof}($self)
726	if $self->{_eof} && $self->{on_eof};	816	} else {
		817	$self->_error (0, 1);
		818	}
		819	}
727		820
728	# may need to restart read watcher	821	# may need to restart read watcher
729	unless ($self->{_rw}) {	822	unless ($self->{_rw}) {
730	$self->start_read	823	$self->start_read
731	if $self->{on_read} \|\| @{ $self->{_queue} };	824	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
857	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	950	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
858	1	951	1
859	}	952	}
860	};	953	};
861		954
862	# compatibility with older API
863	sub push_read_chunk {
864	$_[0]->push_read (chunk => $_[1], $_[2]);
865	}
866
867	sub unshift_read_chunk {
868	$_[0]->unshift_read (chunk => $_[1], $_[2]);
869	}
870
871	=item line => [$eol, ]$cb->($handle, $line, $eol)	955	=item line => [$eol, ]$cb->($handle, $line, $eol)
872		956
873	The callback will be called only once a full line (including the end of	957	The callback will be called only once a full line (including the end of
874	line marker, C<$eol>) has been read. This line (excluding the end of line	958	line marker, C<$eol>) has been read. This line (excluding the end of line
875	marker) will be passed to the callback as second argument (C<$line>), and	959	marker) will be passed to the callback as second argument (C<$line>), and
…		…
890	=cut	974	=cut
891		975
892	register_read_type line => sub {	976	register_read_type line => sub {
893	my ($self, $cb, $eol) = @_;	977	my ($self, $cb, $eol) = @_;
894		978
895	$eol = qr\|(\015?\012)\| if @_ < 3;	979	if (@_ < 3) {
		980	# this is more than twice as fast as the generic code below
		981	sub {
		982	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		983
		984	$cb->($_[0], $1, $2);
		985	1
		986	}
		987	} else {
896	$eol = quotemeta $eol unless ref $eol;	988	$eol = quotemeta $eol unless ref $eol;
897	$eol = qr\|^(.*?)($eol)\|s;	989	$eol = qr\|^(.*?)($eol)\|s;
898		990
899	sub {	991	sub {
900	$_[0]{rbuf} =~ s/$eol// or return;	992	$_[0]{rbuf} =~ s/$eol// or return;
901		993
902	$cb->($_[0], $1, $2);	994	$cb->($_[0], $1, $2);
		995	1
903	1	996	}
904	}	997	}
905	};	998	};
906
907	# compatibility with older API
908	sub push_read_line {
909	my $self = shift;
910	$self->push_read (line => @_);
911	}
912
913	sub unshift_read_line {
914	my $self = shift;
915	$self->unshift_read (line => @_);
916	}
917		999
918	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1000	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
919		1001
920	Makes a regex match against the regex object C<$accept> and returns	1002	Makes a regex match against the regex object C<$accept> and returns
921	everything up to and including the match.	1003	everything up to and including the match.
…		…
1042	register_read_type packstring => sub {	1124	register_read_type packstring => sub {
1043	my ($self, $cb, $format) = @_;	1125	my ($self, $cb, $format) = @_;
1044		1126
1045	sub {	1127	sub {
1046	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1128	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1047	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1129	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1048	or return;	1130	or return;
1049		1131
		1132	$format = length pack $format, $len;
		1133
		1134	# bypass unshift if we already have the remaining chunk
		1135	if ($format + $len <= length $_[0]{rbuf}) {
		1136	my $data = substr $_[0]{rbuf}, $format, $len;
		1137	substr $_[0]{rbuf}, 0, $format + $len, "";
		1138	$cb->($_[0], $data);
		1139	} else {
1050	# remove prefix	1140	# remove prefix
1051	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1141	substr $_[0]{rbuf}, 0, $format, "";
1052		1142
1053	# read rest	1143	# read remaining chunk
1054	$_[0]->unshift_read (chunk => $len, $cb);	1144	$_[0]->unshift_read (chunk => $len, $cb);
		1145	}
1055		1146
1056	1	1147	1
1057	}	1148	}
1058	};	1149	};
1059		1150
…		…
1116		1207
1117	require Storable;	1208	require Storable;
1118		1209
1119	sub {	1210	sub {
1120	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1211	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1121	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1212	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1122	or return;	1213	or return;
1123		1214
		1215	my $format = length pack "w", $len;
		1216
		1217	# bypass unshift if we already have the remaining chunk
		1218	if ($format + $len <= length $_[0]{rbuf}) {
		1219	my $data = substr $_[0]{rbuf}, $format, $len;
		1220	substr $_[0]{rbuf}, 0, $format + $len, "";
		1221	$cb->($_[0], Storable::thaw ($data));
		1222	} else {
1124	# remove prefix	1223	# remove prefix
1125	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1224	substr $_[0]{rbuf}, 0, $format, "";
1126		1225
1127	# read rest	1226	# read remaining chunk
1128	$_[0]->unshift_read (chunk => $len, sub {	1227	$_[0]->unshift_read (chunk => $len, sub {
1129	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1130	$cb->($_[0], $ref);	1229	$cb->($_[0], $ref);
1131	} else {	1230	} else {
1132	$self->_error (&Errno::EBADMSG);	1231	$self->_error (&Errno::EBADMSG);
		1232	}
1133	}	1233	});
1134	});	1234	}
		1235
		1236	1
1135	}	1237	}
1136	};	1238	};
1137		1239
1138	=back	1240	=back
1139		1241
…		…
1217	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1218	substr $self->{_tls_wbuf}, 0, $len, "";	1320	substr $self->{_tls_wbuf}, 0, $len, "";
1219	}	1321	}
1220	}	1322	}
1221		1323
1222	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1223	$self->{wbuf} .= $buf;
1224	$self->_drain_wbuf;
1225	}
1226
1227	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1228	if (length $buf) {	1325	unless (length $buf) {
1229	$self->{rbuf} .= $buf;
1230	$self->_drain_rbuf unless $self->{_in_drain};
1231	} else {
1232	# let's treat SSL-eof as we treat normal EOF	1326	# let's treat SSL-eof as we treat normal EOF
		1327	delete $self->{_rw};
1233	$self->{_eof} = 1;	1328	$self->{_eof} = 1;
1234	$self->_shutdown;	1329	&_freetls;
1235	return;
1236	}	1330	}
		1331
		1332	$self->{rbuf} .= $buf;
		1333	$self->_drain_rbuf unless $self->{_in_drain};
		1334	$self->{tls} or return; # tls session might have gone away in callback
1237	}	1335	}
1238		1336
1239	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1240		1338
1241	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
…		…
1245	return $self->_error (&Errno::EIO, 1);	1343	return $self->_error (&Errno::EIO, 1);
1246	}	1344	}
1247		1345
1248	# all others are fine for our purposes	1346	# all others are fine for our purposes
1249	}	1347	}
		1348
		1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1350	$self->{wbuf} .= $buf;
		1351	$self->_drain_wbuf;
		1352	}
1250	}	1353	}
1251		1354
1252	=item $handle->starttls ($tls[, $tls_ctx])	1355	=item $handle->starttls ($tls[, $tls_ctx])
1253		1356
1254	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1263		1366
1264	The TLS connection object will end up in C<< $handle->{tls} >> after this	1367	The TLS connection object will end up in C<< $handle->{tls} >> after this
1265	call and can be used or changed to your liking. Note that the handshake	1368	call and can be used or changed to your liking. Note that the handshake
1266	might have already started when this function returns.	1369	might have already started when this function returns.
1267		1370
		1371	If it an error to start a TLS handshake more than once per
		1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1373
1268	=cut	1374	=cut
1269		1375
1270	sub starttls {	1376	sub starttls {
1271	my ($self, $ssl, $ctx) = @_;	1377	my ($self, $ssl, $ctx) = @_;
1272		1378
1273	$self->stoptls;	1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
1274		1380	if $self->{tls};
		1381
1275	if ($ssl eq "accept") {	1382	if ($ssl eq "accept") {
1276	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1277	Net::SSLeay::set_accept_state ($ssl);	1384	Net::SSLeay::set_accept_state ($ssl);
1278	} elsif ($ssl eq "connect") {	1385	} elsif ($ssl eq "connect") {
1279	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1386	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1285	# basically, this is deep magic (because SSL_read should have the same issues)	1392	# basically, this is deep magic (because SSL_read should have the same issues)
1286	# but the openssl maintainers basically said: "trust us, it just works".	1393	# but the openssl maintainers basically said: "trust us, it just works".
1287	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1288	# and mismaintained ssleay-module doesn't even offer them).	1395	# and mismaintained ssleay-module doesn't even offer them).
1289	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1397	#
		1398	# in short: this is a mess.
		1399	#
		1400	# note that we do not try to kepe the length constant between writes as we are required to do.
		1401	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1402	# and we drive openssl fully in blocking mode here.
1290	Net::SSLeay::CTX_set_mode ($self->{tls},	1403	Net::SSLeay::CTX_set_mode ($self->{tls},
1291	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1292	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1405	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1293		1406
1294	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
…		…
1302	};	1415	};
1303	$self->{filter_r} = sub {	1416	$self->{filter_r} = sub {
1304	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});	1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1305	&_dotls;	1418	&_dotls;
1306	};	1419	};
		1420
		1421	&_dotls; # need to trigger the initial negotiation exchange
1307	}	1422	}
1308		1423
1309	=item $handle->stoptls	1424	=item $handle->stoptls
1310		1425
1311	Destroys the SSL connection, if any. Partial read or write data will be	1426	Shuts down the SSL connection - this makes a proper EOF handshake by
1312	lost.	1427	sending a close notify to the other side, but since OpenSSL doesn't
		1428	support non-blocking shut downs, it is not possible to re-use the stream
		1429	afterwards.
1313		1430
1314	=cut	1431	=cut
1315		1432
1316	sub stoptls {	1433	sub stoptls {
1317	my ($self) = @_;	1434	my ($self) = @_;
1318		1435
		1436	if ($self->{tls}) {
		1437	Net::SSLeay::shutdown $self->{tls};
		1438
		1439	&_dotls;
		1440
		1441	# we don't give a shit. no, we do, but we can't. no...
		1442	# we, we... have to use openssl :/
		1443	&_freetls;
		1444	}
		1445	}
		1446
		1447	sub _freetls {
		1448	my ($self) = @_;
		1449
		1450	return unless $self->{tls};
		1451
1319	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1452	Net::SSLeay::free (delete $self->{tls});
1320		1453
1321	delete $self->{_rbio};	1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};
1322	delete $self->{_wbio};
1323	delete $self->{_tls_wbuf};
1324	delete $self->{filter_r};
1325	delete $self->{filter_w};
1326	}	1455	}
1327		1456
1328	sub DESTROY {	1457	sub DESTROY {
1329	my $self = shift;	1458	my $self = shift;
1330		1459
1331	$self->stoptls;	1460	&_freetls;
1332		1461
1333	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1334		1463
1335	if ($linger && length $self->{wbuf}) {	1464	if ($linger && length $self->{wbuf}) {
1336	my $fh = delete $self->{fh};	1465	my $fh = delete $self->{fh};
…		…
1400	=over 4	1529	=over 4
1401		1530
1402	=item * all constructor arguments become object members.	1531	=item * all constructor arguments become object members.
1403		1532
1404	At least initially, when you pass a C<tls>-argument to the constructor it	1533	At least initially, when you pass a C<tls>-argument to the constructor it
1405	will end up in C<< $handle->{tls} >>. Those members might be changes or	1534	will end up in C<< $handle->{tls} >>. Those members might be changed or
1406	mutated later on (for example C<tls> will hold the TLS connection object).	1535	mutated later on (for example C<tls> will hold the TLS connection object).
1407		1536
1408	=item * other object member names are prefixed with an C<_>.	1537	=item * other object member names are prefixed with an C<_>.
1409		1538
1410	All object members not explicitly documented (internal use) are prefixed	1539	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC vs. Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC vs.
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC