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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC vs.
Revision 1.109 by root, Wed Jan 14 02:03:43 2009 UTC

…		…
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.232;	19	our $VERSION = 4.331;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
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
…		…
81	Set the callback to be called when an end-of-file condition is detected,	84	Set the callback to be called when an end-of-file condition is detected,
82	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
83	connection cleanly.	86	connection cleanly.
84		87
85	For sockets, this just means that the other side has stopped sending data,	88	For sockets, this just means that the other side has stopped sending data,
86	you can still try to write data, and, in fact, one can return from the eof	89	you can still try to write data, and, in fact, one can return from the EOF
87	callback and continue writing data, as only the read part has been shut	90	callback and continue writing data, as only the read part has been shut
88	down.	91	down.
89		92
90	While not mandatory, it is I<highly> recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
91	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
92	waiting for data.	95	waiting for data.
93		96
94	If an EOF condition has been detected but no C<on_eof> callback has been	97	If an EOF condition has been detected but no C<on_eof> callback has been
95	set, then a fatal error will be raised with C<$!> set to <0>.	98	set, then a fatal error will be raised with C<$!> set to <0>.
…		…
100	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.	104	connect or a read error.
102		105
103	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be shut down and will not be usable	107	fatal errors the handle object will be shut down and will not be usable
105	(but you are free to look at the current C< ->rbuf >). Examples of fatal	108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
106	errors are an EOF condition with active (but unsatisifable) read watchers	109	errors are an EOF condition with active (but unsatisifable) read watchers
107	(C<EPIPE>) or I/O errors.	110	(C<EPIPE>) or I/O errors.
108		111
109	Non-fatal errors can be retried by simply returning, but it is recommended	112	Non-fatal errors can be retried by simply returning, but it is recommended
110	to simply ignore this parameter and instead abondon the handle object	113	to simply ignore this parameter and instead abondon the handle object
…		…
149	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
150		153
151	If non-zero, then this enables an "inactivity" timeout: whenever this many	154	If non-zero, then this enables an "inactivity" timeout: whenever this many
152	seconds pass without a successful read or write on the underlying file	155	seconds pass without a successful read or write on the underlying file
153	handle, the C<on_timeout> callback will be invoked (and if that one is	156	handle, the C<on_timeout> callback will be invoked (and if that one is
154	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
155		158
156	Note that timeout processing is also active when you currently do not have	159	Note that timeout processing is also active when you currently do not have
157	any outstanding read or write requests: If you plan to keep the connection	160	any outstanding read or write requests: If you plan to keep the connection
158	idle then you should disable the timout temporarily or ignore the timeout	161	idle then you should disable the timout temporarily or ignore the timeout
159	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
160		164
161	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
162		166
163	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
164		168
…		…
168		172
169	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
170		174
171	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	175	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
172	when the read buffer ever (strictly) exceeds this size. This is useful to	176	when the read buffer ever (strictly) exceeds this size. This is useful to
173	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
174		178
175	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
176	be configured to accept only so-and-so much data that it cannot act on	180	be configured to accept only so-and-so much data that it cannot act on
177	(for example, when expecting a line, an attacker could send an unlimited	181	(for example, when expecting a line, an attacker could send an unlimited
178	amount of data without a callback ever being called as long as the line	182	amount of data without a callback ever being called as long as the line
179	isn't finished).	183	isn't finished).
180		184
181	=item autocork => <boolean>	185	=item autocork => <boolean>
182		186
183	When disabled (the default), then C<push_write> will try to immediately	187	When disabled (the default), then C<push_write> will try to immediately
184	write the data to the handle if possible. This avoids having to register	188	write the data to the handle, if possible. This avoids having to register
185	a write watcher and wait for the next event loop iteration, but can be	189	a write watcher and wait for the next event loop iteration, but can
186	inefficient if you write multiple small chunks (this disadvantage is	190	be inefficient if you write multiple small chunks (on the wire, this
187	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	191	disadvantage is usually avoided by your kernel's nagle algorithm, see
		192	C<no_delay>, but this option can save costly syscalls).
188		193
189	When enabled, then writes will always be queued till the next event loop	194	When enabled, then writes will always be queued till the next event loop
190	iteration. This is efficient when you do many small writes per iteration,	195	iteration. This is efficient when you do many small writes per iteration,
191	but less efficient when you do a single write only.	196	but less efficient when you do a single write only per iteration (or when
		197	the write buffer often is full). It also increases write latency.
192		198
193	=item no_delay => <boolean>	199	=item no_delay => <boolean>
194		200
195	When doing small writes on sockets, your operating system kernel might	201	When doing small writes on sockets, your operating system kernel might
196	wait a bit for more data before actually sending it out. This is called	202	wait a bit for more data before actually sending it out. This is called
197	the Nagle algorithm, and usually it is beneficial.	203	the Nagle algorithm, and usually it is beneficial.
198		204
199	In some situations you want as low a delay as possible, which cna be	205	In some situations you want as low a delay as possible, which can be
200	accomplishd by setting this option to true.	206	accomplishd by setting this option to a true value.
201		207
202	The default is your opertaing system's default behaviour, this option	208	The default is your opertaing system's default behaviour (most likely
203	explicitly enables or disables it, if possible.	209	enabled), this option explicitly enables or disables it, if possible.
204		210
205	=item read_size => <bytes>	211	=item read_size => <bytes>
206		212
207	The default read block size (the amount of bytes this module will try to read	213	The default read block size (the amount of bytes this module will
208	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
209		216
210	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
211		218
212	Sets the amount of bytes (default: C<0>) that make up an "empty" write	219	Sets the amount of bytes (default: C<0>) that make up an "empty" write
213	buffer: If the write reaches this size or gets even samller it is	220	buffer: If the write reaches this size or gets even samller it is
214	considered empty.	221	considered empty.
215		222
		223	Sometimes it can be beneficial (for performance reasons) to add data to
		224	the write buffer before it is fully drained, but this is a rare case, as
		225	the operating system kernel usually buffers data as well, so the default
		226	is good in almost all cases.
		227
216	=item linger => <seconds>	228	=item linger => <seconds>
217		229
218	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
219	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
220	data and will install a watcher that will write out this data. No errors	232	write data and will install a watcher that will write this data to the
221	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
222	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
223		235
224	This will not work for partial TLS data that could not yet been	236	This will not work for partial TLS data that could not be encoded
225	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
226		239
227	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
228		241
229	When this parameter is given, it enables TLS (SSL) mode, that means it	242	When this parameter is given, it enables TLS (SSL) mode, that means
230	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
231	data.	244	established and will transparently encrypt/decrypt data afterwards.
232		245
233	TLS mode requires Net::SSLeay to be installed (it will be loaded	246	TLS mode requires Net::SSLeay to be installed (it will be loaded
234	automatically when you try to create a TLS handle).	247	automatically when you try to create a TLS handle): this module doesn't
		248	have a dependency on that module, so if your module requires it, you have
		249	to add the dependency yourself.
235		250
236	For the TLS server side, use C<accept>, and for the TLS client side of a	251	Unlike TCP, TLS has a server and client side: for the TLS server side, use
237	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
238		254
239	You can also provide your own TLS connection object, but you have	255	You can also provide your own TLS connection object, but you have
240	to make sure that you call either C<Net::SSLeay::set_connect_state>	256	to make sure that you call either C<Net::SSLeay::set_connect_state>
241	or C<Net::SSLeay::set_accept_state> on it before you pass it to	257	or C<Net::SSLeay::set_accept_state> on it before you pass it to
242	AnyEvent::Handle.	258	AnyEvent::Handle.
243		259
		260	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		261	passing in the wrong integer will lead to certain crash. This most often
		262	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		263	segmentation fault.
		264
244	See the C<starttls> method if you need to start TLS negotiation later.	265	See the C<< ->starttls >> method for when need to start TLS negotiation later.
245		266
246	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
247		268
248	Use the given Net::SSLeay::CTX object to create the new TLS connection	269	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
249	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
250	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
251		272
252	=item json => JSON or JSON::XS object	273	=item json => JSON or JSON::XS object
253		274
254	This is the json coder object used by the C<json> read and write types.	275	This is the json coder object used by the C<json> read and write types.
255		276
256	If you don't supply it, then AnyEvent::Handle will create and use a	277	If you don't supply it, then AnyEvent::Handle will create and use a
257	suitable one, which will write and expect UTF-8 encoded JSON texts.	278	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		279	texts.
258		280
259	Note that you are responsible to depend on the JSON module if you want to	281	Note that you are responsible to depend on the JSON module if you want to
260	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
261		283
262	=item filter_r => $cb
263
264	=item filter_w => $cb
265
266	These exist, but are undocumented at this time.
267
268	=back	284	=back
269		285
270	=cut	286	=cut
271		287
272	sub new {	288	sub new {
…		…
276		292
277	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
278		294
279	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
280		296
281	if ($self->{tls}) {
282	require Net::SSLeay;
283	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
284	}	298	if $self->{tls};
285		299
286	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
287	$self->_timeout;	301	$self->_timeout;
288		302
289	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
301	delete $self->{_tw};	315	delete $self->{_tw};
302	delete $self->{_rw};	316	delete $self->{_rw};
303	delete $self->{_ww};	317	delete $self->{_ww};
304	delete $self->{fh};	318	delete $self->{fh};
305		319
306	$self->stoptls;	320	&_freetls;
307		321
308	delete $self->{on_read};	322	delete $self->{on_read};
309	delete $self->{_queue};	323	delete $self->{_queue};
310	}	324	}
311		325
…		…
317		331
318	$! = $errno;	332	$! = $errno;
319		333
320	if ($self->{on_error}) {	334	if ($self->{on_error}) {
321	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
322	} else {	336	} elsif ($self->{fh}) {
323	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
324	}	338	}
325	}	339	}
326		340
327	=item $fh = $handle->fh	341	=item $fh = $handle->fh
328		342
329	This method returns the file handle of the L<AnyEvent::Handle> object.	343	This method returns the file handle used to create the L<AnyEvent::Handle> object.
330		344
331	=cut	345	=cut
332		346
333	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
334		348
…		…
352	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
353	}	367	}
354		368
355	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
356		370
357	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
358	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	372	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
359	argument.	373	argument and method.
360		374
361	=cut	375	=cut
362		376
363	sub on_timeout {	377	sub on_timeout {
364	$_[0]{on_timeout} = $_[1];	378	$_[0]{on_timeout} = $_[1];
365	}	379	}
366		380
367	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
368		382
369	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
370	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
371		385
372	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
373		391
374	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
375		393
376	Enables or disables the C<no_delay> setting (see constructor argument of	394	Enables or disables the C<no_delay> setting (see constructor argument of
377	the same name for details).	395	the same name for details).
…		…
470	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
471		489
472	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
473		491
474	$cb->($self)	492	$cb->($self)
475	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
476	}	494	}
477		495
478	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
479		497
480	Queues the given scalar to be written. You can push as much data as you	498	Queues the given scalar to be written. You can push as much data as you
…		…
497	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
498		516
499	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
500		518
501	$self->{on_drain}($self)	519	$self->{on_drain}($self)
502	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
503	&& $self->{on_drain};	521	&& $self->{on_drain};
504		522
505	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
506	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
507	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
531		549
532	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	550	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
533	->($self, @_);	551	->($self, @_);
534	}	552	}
535		553
536	if ($self->{filter_w}) {	554	if ($self->{tls}) {
537	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
538	} else {	558	} else {
539	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
540	$self->_drain_wbuf;	560	$self->_drain_wbuf;
541	}	561	}
542	}	562	}
…		…
559	=cut	579	=cut
560		580
561	register_write_type netstring => sub {	581	register_write_type netstring => sub {
562	my ($self, $string) = @_;	582	my ($self, $string) = @_;
563		583
564	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
565	};	585	};
566		586
567	=item packstring => $format, $data	587	=item packstring => $format, $data
568		588
569	An octet string prefixed with an encoded length. The encoding C<$format>	589	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
778		798
779	last; # more data might arrive	799	last; # more data might arrive
780	}	800	}
781	} else {	801	} else {
782	# read side becomes idle	802	# read side becomes idle
783	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
784	last;	804	last;
785	}	805	}
786	}	806	}
787		807
788	if ($self->{_eof}) {	808	if ($self->{_eof}) {
…		…
1083	An octet string prefixed with an encoded length. The encoding C<$format>	1103	An octet string prefixed with an encoded length. The encoding C<$format>
1084	uses the same format as a Perl C<pack> format, but must specify a single	1104	uses the same format as a Perl C<pack> format, but must specify a single
1085	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1086	optional C<!>, C<< < >> or C<< > >> modifier).	1106	optional C<!>, C<< < >> or C<< > >> modifier).
1087		1107
1088	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1108	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1109	EPP uses a prefix of C<N> (4 octtes).
1089		1110
1090	Example: read a block of data prefixed by its length in BER-encoded	1111	Example: read a block of data prefixed by its length in BER-encoded
1091	format (very efficient).	1112	format (very efficient).
1092		1113
1093	$handle->push_read (packstring => "w", sub {	1114	$handle->push_read (packstring => "w", sub {
…		…
1246	Note that AnyEvent::Handle will automatically C<start_read> for you when	1267	Note that AnyEvent::Handle will automatically C<start_read> for you when
1247	you change the C<on_read> callback or push/unshift a read callback, and it	1268	you change the C<on_read> callback or push/unshift a read callback, and it
1248	will automatically C<stop_read> for you when neither C<on_read> is set nor	1269	will automatically C<stop_read> for you when neither C<on_read> is set nor
1249	there are any read requests in the queue.	1270	there are any read requests in the queue.
1250		1271
		1272	These methods will have no effect when in TLS mode (as TLS doesn't support
		1273	half-duplex connections).
		1274
1251	=cut	1275	=cut
1252		1276
1253	sub stop_read {	1277	sub stop_read {
1254	my ($self) = @_;	1278	my ($self) = @_;
1255		1279
1256	delete $self->{_rw};	1280	delete $self->{_rw} unless $self->{tls};
1257	}	1281	}
1258		1282
1259	sub start_read {	1283	sub start_read {
1260	my ($self) = @_;	1284	my ($self) = @_;
1261		1285
1262	unless ($self->{_rw} \|\| $self->{_eof}) {	1286	unless ($self->{_rw} \|\| $self->{_eof}) {
1263	Scalar::Util::weaken $self;	1287	Scalar::Util::weaken $self;
1264		1288
1265	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1289	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1266	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1290	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1267	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1291	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1268		1292
1269	if ($len > 0) {	1293	if ($len > 0) {
1270	$self->{_activity} = AnyEvent->now;	1294	$self->{_activity} = AnyEvent->now;
1271		1295
1272	$self->{filter_r}	1296	if ($self->{tls}) {
1273	? $self->{filter_r}($self, $rbuf)	1297	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1274	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1298
		1299	&_dotls ($self);
		1300	} else {
		1301	$self->_drain_rbuf unless $self->{_in_drain};
		1302	}
1275		1303
1276	} elsif (defined $len) {	1304	} elsif (defined $len) {
1277	delete $self->{_rw};	1305	delete $self->{_rw};
1278	$self->{_eof} = 1;	1306	$self->{_eof} = 1;
1279	$self->_drain_rbuf unless $self->{_in_drain};	1307	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1283	}	1311	}
1284	});	1312	});
1285	}	1313	}
1286	}	1314	}
1287		1315
		1316	# poll the write BIO and send the data if applicable
1288	sub _dotls {	1317	sub _dotls {
1289	my ($self) = @_;	1318	my ($self) = @_;
1290		1319
1291	my $buf;	1320	my $tmp;
1292		1321
1293	if (length $self->{_tls_wbuf}) {	1322	if (length $self->{_tls_wbuf}) {
1294	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1323	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1295	substr $self->{_tls_wbuf}, 0, $len, "";	1324	substr $self->{_tls_wbuf}, 0, $tmp, "";
1296	}	1325	}
1297	}	1326	}
1298		1327
1299	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1300	$self->{wbuf} .= $buf;
1301	$self->_drain_wbuf;
1302	}
1303
1304	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1328	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1305	if (length $buf) {	1329	unless (length $tmp) {
1306	$self->{rbuf} .= $buf;
1307	$self->_drain_rbuf unless $self->{_in_drain};
1308	} else {
1309	# let's treat SSL-eof as we treat normal EOF	1330	# let's treat SSL-eof as we treat normal EOF
		1331	delete $self->{_rw};
1310	$self->{_eof} = 1;	1332	$self->{_eof} = 1;
1311	$self->_shutdown;	1333	&_freetls;
1312	return;
1313	}	1334	}
1314	}
1315		1335
		1336	$self->{rbuf} .= $tmp;
		1337	$self->_drain_rbuf unless $self->{_in_drain};
		1338	$self->{tls} or return; # tls session might have gone away in callback
		1339	}
		1340
1316	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1341	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1317		1342
1318	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1343	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1319	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1344	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1320	return $self->_error ($!, 1);	1345	return $self->_error ($!, 1);
1321	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1346	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1322	return $self->_error (&Errno::EIO, 1);	1347	return $self->_error (&Errno::EIO, 1);
1323	}	1348	}
1324		1349
1325	# all others are fine for our purposes	1350	# all other errors are fine for our purposes
		1351	}
		1352
		1353	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1354	$self->{wbuf} .= $tmp;
		1355	$self->_drain_wbuf;
1326	}	1356	}
1327	}	1357	}
1328		1358
1329	=item $handle->starttls ($tls[, $tls_ctx])	1359	=item $handle->starttls ($tls[, $tls_ctx])
1330		1360
…		…
1340		1370
1341	The TLS connection object will end up in C<< $handle->{tls} >> after this	1371	The TLS connection object will end up in C<< $handle->{tls} >> after this
1342	call and can be used or changed to your liking. Note that the handshake	1372	call and can be used or changed to your liking. Note that the handshake
1343	might have already started when this function returns.	1373	might have already started when this function returns.
1344		1374
		1375	If it an error to start a TLS handshake more than once per
		1376	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1377
1345	=cut	1378	=cut
1346		1379
1347	sub starttls {	1380	sub starttls {
1348	my ($self, $ssl, $ctx) = @_;	1381	my ($self, $ssl, $ctx) = @_;
1349		1382
1350	$self->stoptls;	1383	require Net::SSLeay;
1351		1384
		1385	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1386	if $self->{tls};
		1387
1352	if ($ssl eq "accept") {	1388	if ($ssl eq "accept") {
1353	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1389	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1354	Net::SSLeay::set_accept_state ($ssl);	1390	Net::SSLeay::set_accept_state ($ssl);
1355	} elsif ($ssl eq "connect") {	1391	} elsif ($ssl eq "connect") {
1356	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1392	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1362	# basically, this is deep magic (because SSL_read should have the same issues)	1398	# basically, this is deep magic (because SSL_read should have the same issues)
1363	# but the openssl maintainers basically said: "trust us, it just works".	1399	# but the openssl maintainers basically said: "trust us, it just works".
1364	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1400	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1365	# and mismaintained ssleay-module doesn't even offer them).	1401	# and mismaintained ssleay-module doesn't even offer them).
1366	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1402	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1403	#
		1404	# in short: this is a mess.
		1405	#
		1406	# note that we do not try to keep the length constant between writes as we are required to do.
		1407	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1408	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1409	# have identity issues in that area.
1367	Net::SSLeay::CTX_set_mode ($self->{tls},	1410	Net::SSLeay::CTX_set_mode ($self->{tls},
1368	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1411	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1369	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1412	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1370		1413
1371	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1414	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1372	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1415	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1373		1416
1374	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1417	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1375		1418
1376	$self->{filter_w} = sub {	1419	&_dotls; # need to trigger the initial handshake
1377	$_[0]{_tls_wbuf} .= ${$_[1]};	1420	$self->start_read; # make sure we actually do read
1378	&_dotls;
1379	};
1380	$self->{filter_r} = sub {
1381	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1382	&_dotls;
1383	};
1384	}	1421	}
1385		1422
1386	=item $handle->stoptls	1423	=item $handle->stoptls
1387		1424
1388	Destroys the SSL connection, if any. Partial read or write data will be	1425	Shuts down the SSL connection - this makes a proper EOF handshake by
1389	lost.	1426	sending a close notify to the other side, but since OpenSSL doesn't
		1427	support non-blocking shut downs, it is not possible to re-use the stream
		1428	afterwards.
1390		1429
1391	=cut	1430	=cut
1392		1431
1393	sub stoptls {	1432	sub stoptls {
1394	my ($self) = @_;	1433	my ($self) = @_;
1395		1434
		1435	if ($self->{tls}) {
		1436	Net::SSLeay::shutdown ($self->{tls});
		1437
		1438	&_dotls;
		1439
		1440	# we don't give a shit. no, we do, but we can't. no...
		1441	# we, we... have to use openssl :/
		1442	&_freetls;
		1443	}
		1444	}
		1445
		1446	sub _freetls {
		1447	my ($self) = @_;
		1448
		1449	return unless $self->{tls};
		1450
1396	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1451	Net::SSLeay::free (delete $self->{tls});
1397		1452
1398	delete $self->{_rbio};	1453	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1399	delete $self->{_wbio};
1400	delete $self->{_tls_wbuf};
1401	delete $self->{filter_r};
1402	delete $self->{filter_w};
1403	}	1454	}
1404		1455
1405	sub DESTROY {	1456	sub DESTROY {
1406	my $self = shift;	1457	my $self = shift;
1407		1458
1408	$self->stoptls;	1459	&_freetls;
1409		1460
1410	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1461	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1411		1462
1412	if ($linger && length $self->{wbuf}) {	1463	if ($linger && length $self->{wbuf}) {
1413	my $fh = delete $self->{fh};	1464	my $fh = delete $self->{fh};
…		…
1428	@linger = ();	1479	@linger = ();
1429	});	1480	});
1430	}	1481	}
1431	}	1482	}
1432		1483
		1484	=item $handle->destroy
		1485
		1486	Shuts down the handle object as much as possible - this call ensures that
		1487	no further callbacks will be invoked and resources will be freed as much
		1488	as possible. You must not call any methods on the object afterwards.
		1489
		1490	Normally, you can just "forget" any references to an AnyEvent::Handle
		1491	object and it will simply shut down. This works in fatal error and EOF
		1492	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1493	callback, so when you want to destroy the AnyEvent::Handle object from
		1494	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1495	that case.
		1496
		1497	The handle might still linger in the background and write out remaining
		1498	data, as specified by the C<linger> option, however.
		1499
		1500	=cut
		1501
		1502	sub destroy {
		1503	my ($self) = @_;
		1504
		1505	$self->DESTROY;
		1506	%$self = ();
		1507	}
		1508
1433	=item AnyEvent::Handle::TLS_CTX	1509	=item AnyEvent::Handle::TLS_CTX
1434		1510
1435	This function creates and returns the Net::SSLeay::CTX object used by	1511	This function creates and returns the Net::SSLeay::CTX object used by
1436	default for TLS mode.	1512	default for TLS mode.
1437		1513
…		…
1465	}	1541	}
1466	}	1542	}
1467		1543
1468	=back	1544	=back
1469		1545
		1546
		1547	=head1 NONFREQUENTLY ASKED QUESTIONS
		1548
		1549	=over 4
		1550
		1551	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1552	still get further invocations!
		1553
		1554	That's because AnyEvent::Handle keeps a reference to itself when handling
		1555	read or write callbacks.
		1556
		1557	It is only safe to "forget" the reference inside EOF or error callbacks,
		1558	from within all other callbacks, you need to explicitly call the C<<
		1559	->destroy >> method.
		1560
		1561	=item I get different callback invocations in TLS mode/Why can't I pause
		1562	reading?
		1563
		1564	Unlike, say, TCP, TLS connections do not consist of two independent
		1565	communication channels, one for each direction. Or put differently. The
		1566	read and write directions are not independent of each other: you cannot
		1567	write data unless you are also prepared to read, and vice versa.
		1568
		1569	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1570	callback invocations when you are not expecting any read data - the reason
		1571	is that AnyEvent::Handle always reads in TLS mode.
		1572
		1573	During the connection, you have to make sure that you always have a
		1574	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1575	connection (or when you no longer want to use it) you can call the
		1576	C<destroy> method.
		1577
		1578	=item How do I read data until the other side closes the connection?
		1579
		1580	If you just want to read your data into a perl scalar, the easiest way
		1581	to achieve this is by setting an C<on_read> callback that does nothing,
		1582	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1583	will be in C<$_[0]{rbuf}>:
		1584
		1585	$handle->on_read (sub { });
		1586	$handle->on_eof (undef);
		1587	$handle->on_error (sub {
		1588	my $data = delete $_[0]{rbuf};
		1589	undef $handle;
		1590	});
		1591
		1592	The reason to use C<on_error> is that TCP connections, due to latencies
		1593	and packets loss, might get closed quite violently with an error, when in
		1594	fact, all data has been received.
		1595
		1596	It is usually better to use acknowledgements when transferring data,
		1597	to make sure the other side hasn't just died and you got the data
		1598	intact. This is also one reason why so many internet protocols have an
		1599	explicit QUIT command.
		1600
		1601	=item I don't want to destroy the handle too early - how do I wait until
		1602	all data has been written?
		1603
		1604	After writing your last bits of data, set the C<on_drain> callback
		1605	and destroy the handle in there - with the default setting of
		1606	C<low_water_mark> this will be called precisely when all data has been
		1607	written to the socket:
		1608
		1609	$handle->push_write (...);
		1610	$handle->on_drain (sub {
		1611	warn "all data submitted to the kernel\n";
		1612	undef $handle;
		1613	});
		1614
		1615	=back
		1616
		1617
1470	=head1 SUBCLASSING AnyEvent::Handle	1618	=head1 SUBCLASSING AnyEvent::Handle
1471		1619
1472	In many cases, you might want to subclass AnyEvent::Handle.	1620	In many cases, you might want to subclass AnyEvent::Handle.
1473		1621
1474	To make this easier, a given version of AnyEvent::Handle uses these	1622	To make this easier, a given version of AnyEvent::Handle uses these

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC vs. Revision 1.109 by root, Wed Jan 14 02:03:43 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.83 by root, Thu Aug 21 19:11:37 2008 UTC vs.
Revision 1.109 by root, Wed Jan 14 02:03:43 2009 UTC