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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.63 by root, Fri Jun 6 11:00:32 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.14;	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
…		…
124	This sets the callback that is called when the write buffer becomes empty	149	This sets the callback that is called when the write buffer becomes empty
125	(or when the callback is set and the buffer is empty already).	150	(or when the callback is set and the buffer is empty already).
126		151
127	To append to the write buffer, use the C<< ->push_write >> method.	152	To append to the write buffer, use the C<< ->push_write >> method.
128		153
		154	This callback is useful when you don't want to put all of your write data
		155	into the queue at once, for example, when you want to write the contents
		156	of some file to the socket you might not want to read the whole file into
		157	memory and push it into the queue, but instead only read more data from
		158	the file when the write queue becomes empty.
		159
129	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
130		161
131	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
132	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
133	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
134	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		166
136	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
137	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
138	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
139	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
140		172
141	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
142		174
143	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
144		176
…		…
148		180
149	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
150		182
151	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>)
152	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
153	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
154		186
155	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
156	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
157	(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
158	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
159	isn't finished).	191	isn't finished).
160		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
161	=item read_size => <bytes>	219	=item read_size => <bytes>
162		220
163	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
164	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
165		224
166	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
167		226
168	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
169	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
170	considered empty.	229	considered empty.
171		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
172	=item linger => <seconds>	236	=item linger => <seconds>
173		237
174	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	239	AnyEvent::Handle object will check whether there is still outstanding
176	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
177	will be reported (this mostly matches how the operating system treats	241	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
179		243
180	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
181	encoded. This data will be lost.	245	yet. This data will be lost.
182		246
183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
184		248
185	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
186	will start making tls handshake and will transparently encrypt/decrypt	250	AnyEvent will start a TLS handshake as soon as the conenction has been
187	data.	251	established and will transparently encrypt/decrypt data afterwards.
188		252
189	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
190	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.
191		257
192	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
193	connection, use C<connect> mode.	259	C<accept>, and for the TLS client side of a connection, use C<connect>
		260	mode.
194		261
195	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
196	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>
197	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
198	AnyEvent::Handle.	265	AnyEvent::Handle.
199		266
200	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.
201		268
202	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
203		270
204	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
205	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		274
208	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
209		276
210	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.
211		278
212	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
213	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.
214		282
215	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
216	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
217		285
218	=item filter_r => $cb	286	=item filter_r => $cb
219		287
220	=item filter_w => $cb	288	=item filter_w => $cb
221		289
222	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).
223		292
224	=back	293	=back
225		294
226	=cut	295	=cut
227		296
…		…
240	}	309	}
241		310
242	$self->{_activity} = AnyEvent->now;	311	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;	312	$self->_timeout;
244		313
245	$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};
		316
		317	$self->start_read
		318	if $self->{on_read};
246		319
247	$self	320	$self
248	}	321	}
249		322
250	sub _shutdown {	323	sub _shutdown {
…		…
253	delete $self->{_tw};	326	delete $self->{_tw};
254	delete $self->{_rw};	327	delete $self->{_rw};
255	delete $self->{_ww};	328	delete $self->{_ww};
256	delete $self->{fh};	329	delete $self->{fh};
257		330
258	$self->stoptls;	331	&_freetls;
		332
		333	delete $self->{on_read};
		334	delete $self->{_queue};
259	}	335	}
260		336
261	sub _error {	337	sub _error {
262	my ($self, $errno, $fatal) = @_;	338	my ($self, $errno, $fatal) = @_;
263		339
…		…
273	}	349	}
274	}	350	}
275		351
276	=item $fh = $handle->fh	352	=item $fh = $handle->fh
277		353
278	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.
279		355
280	=cut	356	=cut
281		357
282	sub fh { $_[0]{fh} }	358	sub fh { $_[0]{fh} }
283		359
…		…
301	$_[0]{on_eof} = $_[1];	377	$_[0]{on_eof} = $_[1];
302	}	378	}
303		379
304	=item $handle->on_timeout ($cb)	380	=item $handle->on_timeout ($cb)
305		381
306	Replace the current C<on_timeout> callback, or disables the callback	382	Replace the current C<on_timeout> callback, or disables the callback (but
307	(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
308	argument.	384	argument and method.
309		385
310	=cut	386	=cut
311		387
312	sub on_timeout {	388	sub on_timeout {
313	$_[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	};
314	}	413	}
315		414
316	#############################################################################	415	#############################################################################
317		416
318	=item $handle->timeout ($seconds)	417	=item $handle->timeout ($seconds)
…		…
433	$self->_error ($!, 1);	532	$self->_error ($!, 1);
434	}	533	}
435	};	534	};
436		535
437	# try to write data immediately	536	# try to write data immediately
438	$cb->();	537	$cb->() unless $self->{autocork};
439		538
440	# if still data left in wbuf, we need to poll	539	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	540	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
442	if length $self->{wbuf};	541	if length $self->{wbuf};
443	};	542	};
…		…
500	=cut	599	=cut
501		600
502	register_write_type packstring => sub {	601	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	602	my ($self, $format, $string) = @_;
504		603
505	pack "$format/a", $string	604	pack "$format/a*", $string
506	};	605	};
507		606
508	=item json => $array_or_hashref	607	=item json => $array_or_hashref
509		608
510	Encodes the given hash or array reference into a JSON object. Unless you	609	Encodes the given hash or array reference into a JSON object. Unless you
…		…
556	register_write_type storable => sub {	655	register_write_type storable => sub {
557	my ($self, $ref) = @_;	656	my ($self, $ref) = @_;
558		657
559	require Storable;	658	require Storable;
560		659
561	pack "w/a", Storable::nfreeze ($ref)	660	pack "w/a*", Storable::nfreeze ($ref)
562	};	661	};
563		662
564	=back	663	=back
565		664
566	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
…		…
590	ways, the "simple" way, using only C<on_read> and the "complex" way, using	689	ways, the "simple" way, using only C<on_read> and the "complex" way, using
591	a queue.	690	a queue.
592		691
593	In the simple case, you just install an C<on_read> callback and whenever	692	In the simple case, you just install an C<on_read> callback and whenever
594	new data arrives, it will be called. You can then remove some data (if	693	new data arrives, it will be called. You can then remove some data (if
595	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	694	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
596	or not.	695	leave the data there if you want to accumulate more (e.g. when only a
		696	partial message has been received so far).
597		697
598	In the more complex case, you want to queue multiple callbacks. In this	698	In the more complex case, you want to queue multiple callbacks. In this
599	case, AnyEvent::Handle will call the first queued callback each time new	699	case, AnyEvent::Handle will call the first queued callback each time new
600	data arrives (also the first time it is queued) and removes it when it has	700	data arrives (also the first time it is queued) and removes it when it has
601	done its job (see C<push_read>, below).	701	done its job (see C<push_read>, below).
…		…
619	# handle xml	719	# handle xml
620	});	720	});
621	});	721	});
622	});	722	});
623		723
624	Example 2: Implement a client for a protocol that replies either with	724	Example 2: Implement a client for a protocol that replies either with "OK"
625	"OK" and another line or "ERROR" for one request, and 64 bytes for the	725	and another line or "ERROR" for the first request that is sent, and 64
626	second request. Due tot he availability of a full queue, we can just	726	bytes for the second request. Due to the availability of a queue, we can
627	pipeline sending both requests and manipulate the queue as necessary in	727	just pipeline sending both requests and manipulate the queue as necessary
628	the callbacks:	728	in the callbacks.
629		729
630	# request one	730	When the first callback is called and sees an "OK" response, it will
		731	C<unshift> another line-read. This line-read will be queued I<before> the
		732	64-byte chunk callback.
		733
		734	# request one, returns either "OK + extra line" or "ERROR"
631	$handle->push_write ("request 1\015\012");	735	$handle->push_write ("request 1\015\012");
632		736
633	# we expect "ERROR" or "OK" as response, so push a line read	737	# we expect "ERROR" or "OK" as response, so push a line read
634	$handle->push_read (line => sub {	738	$handle->push_read (line => sub {
635	# if we got an "OK", we have to _prepend_ another line,	739	# if we got an "OK", we have to _prepend_ another line,
…		…
642	...	746	...
643	});	747	});
644	}	748	}
645	});	749	});
646		750
647	# request two	751	# request two, simply returns 64 octets
648	$handle->push_write ("request 2\015\012");	752	$handle->push_write ("request 2\015\012");
649		753
650	# simply read 64 bytes, always	754	# simply read 64 bytes, always
651	$handle->push_read (chunk => 64, sub {	755	$handle->push_read (chunk => 64, sub {
652	my $response = $_[1];	756	my $response = $_[1];
…		…
664		768
665	if (	769	if (
666	defined $self->{rbuf_max}	770	defined $self->{rbuf_max}
667	&& $self->{rbuf_max} < length $self->{rbuf}	771	&& $self->{rbuf_max} < length $self->{rbuf}
668	) {	772	) {
669	return $self->_error (&Errno::ENOSPC, 1);	773	$self->_error (&Errno::ENOSPC, 1), return;
670	}	774	}
671		775
672	while () {	776	while () {
673	no strict 'refs';
674
675	my $len = length $self->{rbuf};	777	my $len = length $self->{rbuf};
676		778
677	if (my $cb = shift @{ $self->{_queue} }) {	779	if (my $cb = shift @{ $self->{_queue} }) {
678	unless ($cb->($self)) {	780	unless ($cb->($self)) {
679	if ($self->{_eof}) {	781	if ($self->{_eof}) {
680	# 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)
681	$self->_error (&Errno::EPIPE, 1), last;	783	$self->_error (&Errno::EPIPE, 1), return;
682	}	784	}
683		785
684	unshift @{ $self->{_queue} }, $cb;	786	unshift @{ $self->{_queue} }, $cb;
685	last;	787	last;
686	}	788	}
…		…
694	&& !@{ $self->{_queue} } # and the queue is still empty	796	&& !@{ $self->{_queue} } # and the queue is still empty
695	&& $self->{on_read} # but we still have on_read	797	&& $self->{on_read} # but we still have on_read
696	) {	798	) {
697	# no further data will arrive	799	# no further data will arrive
698	# so no progress can be made	800	# so no progress can be made
699	$self->_error (&Errno::EPIPE, 1), last	801	$self->_error (&Errno::EPIPE, 1), return
700	if $self->{_eof};	802	if $self->{_eof};
701		803
702	last; # more data might arrive	804	last; # more data might arrive
703	}	805	}
704	} else {	806	} else {
…		…
706	delete $self->{_rw};	808	delete $self->{_rw};
707	last;	809	last;
708	}	810	}
709	}	811	}
710		812
		813	if ($self->{_eof}) {
		814	if ($self->{on_eof}) {
711	$self->{on_eof}($self)	815	$self->{on_eof}($self)
712	if $self->{_eof} && $self->{on_eof};	816	} else {
		817	$self->_error (0, 1);
		818	}
		819	}
713		820
714	# may need to restart read watcher	821	# may need to restart read watcher
715	unless ($self->{_rw}) {	822	unless ($self->{_rw}) {
716	$self->start_read	823	$self->start_read
717	if $self->{on_read} \|\| @{ $self->{_queue} };	824	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
843	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	950	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
844	1	951	1
845	}	952	}
846	};	953	};
847		954
848	# compatibility with older API
849	sub push_read_chunk {
850	$_[0]->push_read (chunk => $_[1], $_[2]);
851	}
852
853	sub unshift_read_chunk {
854	$_[0]->unshift_read (chunk => $_[1], $_[2]);
855	}
856
857	=item line => [$eol, ]$cb->($handle, $line, $eol)	955	=item line => [$eol, ]$cb->($handle, $line, $eol)
858		956
859	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
860	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
861	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
…		…
876	=cut	974	=cut
877		975
878	register_read_type line => sub {	976	register_read_type line => sub {
879	my ($self, $cb, $eol) = @_;	977	my ($self, $cb, $eol) = @_;
880		978
881	$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 {
882	$eol = quotemeta $eol unless ref $eol;	988	$eol = quotemeta $eol unless ref $eol;
883	$eol = qr\|^(.*?)($eol)\|s;	989	$eol = qr\|^(.*?)($eol)\|s;
884		990
885	sub {	991	sub {
886	$_[0]{rbuf} =~ s/$eol// or return;	992	$_[0]{rbuf} =~ s/$eol// or return;
887		993
888	$cb->($_[0], $1, $2);	994	$cb->($_[0], $1, $2);
		995	1
889	1	996	}
890	}	997	}
891	};	998	};
892
893	# compatibility with older API
894	sub push_read_line {
895	my $self = shift;
896	$self->push_read (line => @_);
897	}
898
899	sub unshift_read_line {
900	my $self = shift;
901	$self->unshift_read (line => @_);
902	}
903		999
904	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1000	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
905		1001
906	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
907	everything up to and including the match.	1003	everything up to and including the match.
…		…
1028	register_read_type packstring => sub {	1124	register_read_type packstring => sub {
1029	my ($self, $cb, $format) = @_;	1125	my ($self, $cb, $format) = @_;
1030		1126
1031	sub {	1127	sub {
1032	# 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
1033	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1129	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1034	or return;	1130	or return;
1035		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 {
1036	# remove prefix	1140	# remove prefix
1037	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1141	substr $_[0]{rbuf}, 0, $format, "";
1038		1142
1039	# read rest	1143	# read remaining chunk
1040	$_[0]->unshift_read (chunk => $len, $cb);	1144	$_[0]->unshift_read (chunk => $len, $cb);
		1145	}
1041		1146
1042	1	1147	1
1043	}	1148	}
1044	};	1149	};
1045		1150
…		…
1102		1207
1103	require Storable;	1208	require Storable;
1104		1209
1105	sub {	1210	sub {
1106	# 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
1107	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1212	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1108	or return;	1213	or return;
1109		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 {
1110	# remove prefix	1223	# remove prefix
1111	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1224	substr $_[0]{rbuf}, 0, $format, "";
1112		1225
1113	# read rest	1226	# read remaining chunk
1114	$_[0]->unshift_read (chunk => $len, sub {	1227	$_[0]->unshift_read (chunk => $len, sub {
1115	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1116	$cb->($_[0], $ref);	1229	$cb->($_[0], $ref);
1117	} else {	1230	} else {
1118	$self->_error (&Errno::EBADMSG);	1231	$self->_error (&Errno::EBADMSG);
		1232	}
1119	}	1233	});
1120	});	1234	}
		1235
		1236	1
1121	}	1237	}
1122	};	1238	};
1123		1239
1124	=back	1240	=back
1125		1241
…		…
1203	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) {
1204	substr $self->{_tls_wbuf}, 0, $len, "";	1320	substr $self->{_tls_wbuf}, 0, $len, "";
1205	}	1321	}
1206	}	1322	}
1207		1323
1208	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1209	$self->{wbuf} .= $buf;
1210	$self->_drain_wbuf;
1211	}
1212
1213	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1214	if (length $buf) {	1325	unless (length $buf) {
1215	$self->{rbuf} .= $buf;
1216	$self->_drain_rbuf unless $self->{_in_drain};
1217	} else {
1218	# 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};
1219	$self->{_eof} = 1;	1328	$self->{_eof} = 1;
1220	$self->_shutdown;	1329	&_freetls;
1221	return;
1222	}	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
1223	}	1335	}
1224		1336
1225	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1226		1338
1227	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
…		…
1231	return $self->_error (&Errno::EIO, 1);	1343	return $self->_error (&Errno::EIO, 1);
1232	}	1344	}
1233		1345
1234	# all others are fine for our purposes	1346	# all others are fine for our purposes
1235	}	1347	}
		1348
		1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1350	$self->{wbuf} .= $buf;
		1351	$self->_drain_wbuf;
		1352	}
1236	}	1353	}
1237		1354
1238	=item $handle->starttls ($tls[, $tls_ctx])	1355	=item $handle->starttls ($tls[, $tls_ctx])
1239		1356
1240	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1249		1366
1250	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
1251	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
1252	might have already started when this function returns.	1369	might have already started when this function returns.
1253		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
1254	=cut	1374	=cut
1255		1375
1256	sub starttls {	1376	sub starttls {
1257	my ($self, $ssl, $ctx) = @_;	1377	my ($self, $ssl, $ctx) = @_;
1258		1378
1259	$self->stoptls;	1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
1260		1380	if $self->{tls};
		1381
1261	if ($ssl eq "accept") {	1382	if ($ssl eq "accept") {
1262	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1263	Net::SSLeay::set_accept_state ($ssl);	1384	Net::SSLeay::set_accept_state ($ssl);
1264	} elsif ($ssl eq "connect") {	1385	} elsif ($ssl eq "connect") {
1265	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1386	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1271	# 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)
1272	# but the openssl maintainers basically said: "trust us, it just works".	1393	# but the openssl maintainers basically said: "trust us, it just works".
1273	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1274	# and mismaintained ssleay-module doesn't even offer them).	1395	# and mismaintained ssleay-module doesn't even offer them).
1275	# 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.
1276	Net::SSLeay::CTX_set_mode ($self->{tls},	1403	Net::SSLeay::CTX_set_mode ($self->{tls},
1277	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1278	\| (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));
1279		1406
1280	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
…		…
1288	};	1415	};
1289	$self->{filter_r} = sub {	1416	$self->{filter_r} = sub {
1290	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});	1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1291	&_dotls;	1418	&_dotls;
1292	};	1419	};
		1420
		1421	&_dotls; # need to trigger the initial negotiation exchange
1293	}	1422	}
1294		1423
1295	=item $handle->stoptls	1424	=item $handle->stoptls
1296		1425
1297	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
1298	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.
1299		1430
1300	=cut	1431	=cut
1301		1432
1302	sub stoptls {	1433	sub stoptls {
1303	my ($self) = @_;	1434	my ($self) = @_;
1304		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
1305	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1452	Net::SSLeay::free (delete $self->{tls});
1306		1453
1307	delete $self->{_rbio};	1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};
1308	delete $self->{_wbio};
1309	delete $self->{_tls_wbuf};
1310	delete $self->{filter_r};
1311	delete $self->{filter_w};
1312	}	1455	}
1313		1456
1314	sub DESTROY {	1457	sub DESTROY {
1315	my $self = shift;	1458	my $self = shift;
1316		1459
1317	$self->stoptls;	1460	&_freetls;
1318		1461
1319	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1320		1463
1321	if ($linger && length $self->{wbuf}) {	1464	if ($linger && length $self->{wbuf}) {
1322	my $fh = delete $self->{fh};	1465	my $fh = delete $self->{fh};
…		…
1386	=over 4	1529	=over 4
1387		1530
1388	=item * all constructor arguments become object members.	1531	=item * all constructor arguments become object members.
1389		1532
1390	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
1391	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
1392	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).
1393		1536
1394	=item * other object member names are prefixed with an C<_>.	1537	=item * other object member names are prefixed with an C<_>.
1395		1538
1396	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.63 by root, Fri Jun 6 11:00:32 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.63 by root, Fri Jun 6 11:00:32 2008 UTC vs.
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC