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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC vs.
Revision 1.104 by root, Mon Nov 3 21:49:25 2008 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.32;
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
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	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,
81	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
82	connection cleanly.	86	connection cleanly.
83		87
84	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,
85	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
86	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
87	down.	91	down.
88		92
89	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,
90	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
91	waiting for data.	95	waiting for data.
92		96
93	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
94	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>.
…		…
99	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
100	connect or a read error.	104	connect or a read error.
101		105
102	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
103	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
104	(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
105	errors are an EOF condition with active (but unsatisifable) read watchers	109	errors are an EOF condition with active (but unsatisifable) read watchers
106	(C<EPIPE>) or I/O errors.	110	(C<EPIPE>) or I/O errors.
107		111
108	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
109	to simply ignore this parameter and instead abondon the handle object	113	to simply ignore this parameter and instead abondon the handle object
…		…
148	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
149		153
150	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
151	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
152	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
153	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
154		158
155	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
156	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
157	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
158	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
159		164
160	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
161		166
162	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
163		168
…		…
167		172
168	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
169		174
170	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>)
171	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
172	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
173		178
174	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
175	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
176	(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
177	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
178	isn't finished).	183	isn't finished).
179		184
180	=item autocork => <boolean>	185	=item autocork => <boolean>
181		186
182	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
183	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
184	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
185	inefficient if you write multiple small chunks (this disadvantage is	190	be inefficient if you write multiple small chunks (on the wire, this
186	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).
187		193
188	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
189	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,
190	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.
191		198
192	=item no_delay => <boolean>	199	=item no_delay => <boolean>
193		200
194	When doing small writes on sockets, your operating system kernel might	201	When doing small writes on sockets, your operating system kernel might
195	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
196	the Nagle algorithm, and usually it is beneficial.	203	the Nagle algorithm, and usually it is beneficial.
197		204
198	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
199	accomplishd by setting this option to true.	206	accomplishd by setting this option to a true value.
200		207
201	The default is your opertaing system's default behaviour, this option	208	The default is your opertaing system's default behaviour (most likely
202	explicitly enables or disables it, if possible.	209	enabled), this option explicitly enables or disables it, if possible.
203		210
204	=item read_size => <bytes>	211	=item read_size => <bytes>
205		212
206	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
207	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
208		216
209	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
210		218
211	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
212	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
213	considered empty.	221	considered empty.
214		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
215	=item linger => <seconds>	228	=item linger => <seconds>
216		229
217	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
218	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
219	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
220	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
221	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
222		235
223	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
224	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
225		239
226	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
227		241
228	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
229	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
230	data.	244	established and will transparently encrypt/decrypt data afterwards.
231		245
232	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
233	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.
234		250
235	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
236	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
237		254
238	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
239	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>
240	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
241	AnyEvent::Handle.	258	AnyEvent::Handle.
242		259
243	See the C<starttls> method if you need to start TLS negotiation later.	260	See the C<< ->starttls >> method for when need to start TLS negotiation later.
244		261
245	=item tls_ctx => $ssl_ctx	262	=item tls_ctx => $ssl_ctx
246		263
247	Use the given Net::SSLeay::CTX object to create the new TLS connection	264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
248	(unless a connection object was specified directly). If this parameter is	265	(unless a connection object was specified directly). If this parameter is
249	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
250		267
251	=item json => JSON or JSON::XS object	268	=item json => JSON or JSON::XS object
252		269
253	This is the json coder object used by the C<json> read and write types.	270	This is the json coder object used by the C<json> read and write types.
254		271
255	If you don't supply it, then AnyEvent::Handle will create and use a	272	If you don't supply it, then AnyEvent::Handle will create and use a
256	suitable one, which will write and expect UTF-8 encoded JSON texts.	273	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		274	texts.
257		275
258	Note that you are responsible to depend on the JSON module if you want to	276	Note that you are responsible to depend on the JSON module if you want to
259	use this functionality, as AnyEvent does not have a dependency itself.	277	use this functionality, as AnyEvent does not have a dependency itself.
260		278
261	=item filter_r => $cb
262
263	=item filter_w => $cb
264
265	These exist, but are undocumented at this time.
266
267	=back	279	=back
268		280
269	=cut	281	=cut
270		282
271	sub new {	283	sub new {
…		…
275		287
276	$self->{fh} or Carp::croak "mandatory argument fh is missing";	288	$self->{fh} or Carp::croak "mandatory argument fh is missing";
277		289
278	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
279		291
280	if ($self->{tls}) {
281	require Net::SSLeay;
282	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
283	}	293	if $self->{tls};
284		294
285	$self->{_activity} = AnyEvent->now;	295	$self->{_activity} = AnyEvent->now;
286	$self->_timeout;	296	$self->_timeout;
287		297
288	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
300	delete $self->{_tw};	310	delete $self->{_tw};
301	delete $self->{_rw};	311	delete $self->{_rw};
302	delete $self->{_ww};	312	delete $self->{_ww};
303	delete $self->{fh};	313	delete $self->{fh};
304		314
305	$self->stoptls;	315	&_freetls;
306		316
307	delete $self->{on_read};	317	delete $self->{on_read};
308	delete $self->{_queue};	318	delete $self->{_queue};
309	}	319	}
310		320
…		…
316		326
317	$! = $errno;	327	$! = $errno;
318		328
319	if ($self->{on_error}) {	329	if ($self->{on_error}) {
320	$self->{on_error}($self, $fatal);	330	$self->{on_error}($self, $fatal);
321	} else {	331	} elsif ($self->{fh}) {
322	Carp::croak "AnyEvent::Handle uncaught error: $!";	332	Carp::croak "AnyEvent::Handle uncaught error: $!";
323	}	333	}
324	}	334	}
325		335
326	=item $fh = $handle->fh	336	=item $fh = $handle->fh
327		337
328	This method returns the file handle of the L<AnyEvent::Handle> object.	338	This method returns the file handle used to create the L<AnyEvent::Handle> object.
329		339
330	=cut	340	=cut
331		341
332	sub fh { $_[0]{fh} }	342	sub fh { $_[0]{fh} }
333		343
…		…
351	$_[0]{on_eof} = $_[1];	361	$_[0]{on_eof} = $_[1];
352	}	362	}
353		363
354	=item $handle->on_timeout ($cb)	364	=item $handle->on_timeout ($cb)
355		365
356	Replace the current C<on_timeout> callback, or disables the callback	366	Replace the current C<on_timeout> callback, or disables the callback (but
357	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	367	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
358	argument.	368	argument and method.
359		369
360	=cut	370	=cut
361		371
362	sub on_timeout {	372	sub on_timeout {
363	$_[0]{on_timeout} = $_[1];	373	$_[0]{on_timeout} = $_[1];
…		…
469	my ($self, $cb) = @_;	479	my ($self, $cb) = @_;
470		480
471	$self->{on_drain} = $cb;	481	$self->{on_drain} = $cb;
472		482
473	$cb->($self)	483	$cb->($self)
474	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	484	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
475	}	485	}
476		486
477	=item $handle->push_write ($data)	487	=item $handle->push_write ($data)
478		488
479	Queues the given scalar to be written. You can push as much data as you	489	Queues the given scalar to be written. You can push as much data as you
…		…
496	substr $self->{wbuf}, 0, $len, "";	506	substr $self->{wbuf}, 0, $len, "";
497		507
498	$self->{_activity} = AnyEvent->now;	508	$self->{_activity} = AnyEvent->now;
499		509
500	$self->{on_drain}($self)	510	$self->{on_drain}($self)
501	if $self->{low_water_mark} >= length $self->{wbuf}	511	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
502	&& $self->{on_drain};	512	&& $self->{on_drain};
503		513
504	delete $self->{_ww} unless length $self->{wbuf};	514	delete $self->{_ww} unless length $self->{wbuf};
505	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	515	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
506	$self->_error ($!, 1);	516	$self->_error ($!, 1);
…		…
530		540
531	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	541	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
532	->($self, @_);	542	->($self, @_);
533	}	543	}
534		544
535	if ($self->{filter_w}) {	545	if ($self->{tls}) {
536	$self->{filter_w}($self, \$_[0]);	546	$self->{_tls_wbuf} .= $_[0];
		547
		548	&_dotls ($self);
537	} else {	549	} else {
538	$self->{wbuf} .= $_[0];	550	$self->{wbuf} .= $_[0];
539	$self->_drain_wbuf;	551	$self->_drain_wbuf;
540	}	552	}
541	}	553	}
…		…
558	=cut	570	=cut
559		571
560	register_write_type netstring => sub {	572	register_write_type netstring => sub {
561	my ($self, $string) = @_;	573	my ($self, $string) = @_;
562		574
563	sprintf "%d:%s,", (length $string), $string	575	(length $string) . ":$string,"
564	};	576	};
565		577
566	=item packstring => $format, $data	578	=item packstring => $format, $data
567		579
568	An octet string prefixed with an encoded length. The encoding C<$format>	580	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
777		789
778	last; # more data might arrive	790	last; # more data might arrive
779	}	791	}
780	} else {	792	} else {
781	# read side becomes idle	793	# read side becomes idle
782	delete $self->{_rw};	794	delete $self->{_rw} unless $self->{tls};
783	last;	795	last;
784	}	796	}
785	}	797	}
786		798
787	if ($self->{_eof}) {	799	if ($self->{_eof}) {
…		…
1082	An octet string prefixed with an encoded length. The encoding C<$format>	1094	An octet string prefixed with an encoded length. The encoding C<$format>
1083	uses the same format as a Perl C<pack> format, but must specify a single	1095	uses the same format as a Perl C<pack> format, but must specify a single
1084	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1096	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1085	optional C<!>, C<< < >> or C<< > >> modifier).	1097	optional C<!>, C<< < >> or C<< > >> modifier).
1086		1098
1087	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1099	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1100	EPP uses a prefix of C<N> (4 octtes).
1088		1101
1089	Example: read a block of data prefixed by its length in BER-encoded	1102	Example: read a block of data prefixed by its length in BER-encoded
1090	format (very efficient).	1103	format (very efficient).
1091		1104
1092	$handle->push_read (packstring => "w", sub {	1105	$handle->push_read (packstring => "w", sub {
…		…
1245	Note that AnyEvent::Handle will automatically C<start_read> for you when	1258	Note that AnyEvent::Handle will automatically C<start_read> for you when
1246	you change the C<on_read> callback or push/unshift a read callback, and it	1259	you change the C<on_read> callback or push/unshift a read callback, and it
1247	will automatically C<stop_read> for you when neither C<on_read> is set nor	1260	will automatically C<stop_read> for you when neither C<on_read> is set nor
1248	there are any read requests in the queue.	1261	there are any read requests in the queue.
1249		1262
		1263	These methods will have no effect when in TLS mode (as TLS doesn't support
		1264	half-duplex connections).
		1265
1250	=cut	1266	=cut
1251		1267
1252	sub stop_read {	1268	sub stop_read {
1253	my ($self) = @_;	1269	my ($self) = @_;
1254		1270
1255	delete $self->{_rw};	1271	delete $self->{_rw} unless $self->{tls};
1256	}	1272	}
1257		1273
1258	sub start_read {	1274	sub start_read {
1259	my ($self) = @_;	1275	my ($self) = @_;
1260		1276
1261	unless ($self->{_rw} \|\| $self->{_eof}) {	1277	unless ($self->{_rw} \|\| $self->{_eof}) {
1262	Scalar::Util::weaken $self;	1278	Scalar::Util::weaken $self;
1263		1279
1264	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1280	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1265	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1281	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1266	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1282	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1267		1283
1268	if ($len > 0) {	1284	if ($len > 0) {
1269	$self->{_activity} = AnyEvent->now;	1285	$self->{_activity} = AnyEvent->now;
1270		1286
1271	$self->{filter_r}	1287	if ($self->{tls}) {
1272	? $self->{filter_r}($self, $rbuf)	1288	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1273	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1289
		1290	&_dotls ($self);
		1291	} else {
		1292	$self->_drain_rbuf unless $self->{_in_drain};
		1293	}
1274		1294
1275	} elsif (defined $len) {	1295	} elsif (defined $len) {
1276	delete $self->{_rw};	1296	delete $self->{_rw};
1277	$self->{_eof} = 1;	1297	$self->{_eof} = 1;
1278	$self->_drain_rbuf unless $self->{_in_drain};	1298	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1282	}	1302	}
1283	});	1303	});
1284	}	1304	}
1285	}	1305	}
1286		1306
		1307	# poll the write BIO and send the data if applicable
1287	sub _dotls {	1308	sub _dotls {
1288	my ($self) = @_;	1309	my ($self) = @_;
1289		1310
1290	my $buf;	1311	my $tmp;
1291		1312
1292	if (length $self->{_tls_wbuf}) {	1313	if (length $self->{_tls_wbuf}) {
1293	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1294	substr $self->{_tls_wbuf}, 0, $len, "";	1315	substr $self->{_tls_wbuf}, 0, $tmp, "";
1295	}	1316	}
1296	}	1317	}
1297		1318
1298	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1299	$self->{wbuf} .= $buf;
1300	$self->_drain_wbuf;
1301	}
1302
1303	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1304	if (length $buf) {	1320	unless (length $tmp) {
1305	$self->{rbuf} .= $buf;
1306	$self->_drain_rbuf unless $self->{_in_drain};
1307	} else {
1308	# let's treat SSL-eof as we treat normal EOF	1321	# let's treat SSL-eof as we treat normal EOF
		1322	delete $self->{_rw};
1309	$self->{_eof} = 1;	1323	$self->{_eof} = 1;
1310	$self->_shutdown;	1324	&_freetls;
1311	return;
1312	}	1325	}
1313	}
1314		1326
		1327	$self->{rbuf} .= $tmp;
		1328	$self->_drain_rbuf unless $self->{_in_drain};
		1329	$self->{tls} or return; # tls session might have gone away in callback
		1330	}
		1331
1315	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1316		1333
1317	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1318	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1319	return $self->_error ($!, 1);	1336	return $self->_error ($!, 1);
1320	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1321	return $self->_error (&Errno::EIO, 1);	1338	return $self->_error (&Errno::EIO, 1);
1322	}	1339	}
1323		1340
1324	# all others are fine for our purposes	1341	# all other errors are fine for our purposes
		1342	}
		1343
		1344	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1345	$self->{wbuf} .= $tmp;
		1346	$self->_drain_wbuf;
1325	}	1347	}
1326	}	1348	}
1327		1349
1328	=item $handle->starttls ($tls[, $tls_ctx])	1350	=item $handle->starttls ($tls[, $tls_ctx])
1329		1351
…		…
1339		1361
1340	The TLS connection object will end up in C<< $handle->{tls} >> after this	1362	The TLS connection object will end up in C<< $handle->{tls} >> after this
1341	call and can be used or changed to your liking. Note that the handshake	1363	call and can be used or changed to your liking. Note that the handshake
1342	might have already started when this function returns.	1364	might have already started when this function returns.
1343		1365
		1366	If it an error to start a TLS handshake more than once per
		1367	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1368
1344	=cut	1369	=cut
1345		1370
1346	sub starttls {	1371	sub starttls {
1347	my ($self, $ssl, $ctx) = @_;	1372	my ($self, $ssl, $ctx) = @_;
1348		1373
1349	$self->stoptls;	1374	require Net::SSLeay;
1350		1375
		1376	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1377	if $self->{tls};
		1378
1351	if ($ssl eq "accept") {	1379	if ($ssl eq "accept") {
1352	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1380	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1353	Net::SSLeay::set_accept_state ($ssl);	1381	Net::SSLeay::set_accept_state ($ssl);
1354	} elsif ($ssl eq "connect") {	1382	} elsif ($ssl eq "connect") {
1355	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1361	# basically, this is deep magic (because SSL_read should have the same issues)	1389	# basically, this is deep magic (because SSL_read should have the same issues)
1362	# but the openssl maintainers basically said: "trust us, it just works".	1390	# but the openssl maintainers basically said: "trust us, it just works".
1363	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1364	# and mismaintained ssleay-module doesn't even offer them).	1392	# and mismaintained ssleay-module doesn't even offer them).
1365	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1393	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1394	#
		1395	# in short: this is a mess.
		1396	#
		1397	# note that we do not try to keep the length constant between writes as we are required to do.
		1398	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1399	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1400	# have identity issues in that area.
1366	Net::SSLeay::CTX_set_mode ($self->{tls},	1401	Net::SSLeay::CTX_set_mode ($self->{tls},
1367	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1368	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1403	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1369		1404
1370	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1371	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1372		1407
1373	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1408	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1374		1409
1375	$self->{filter_w} = sub {	1410	&_dotls; # need to trigger the initial handshake
1376	$_[0]{_tls_wbuf} .= ${$_[1]};	1411	$self->start_read; # make sure we actually do read
1377	&_dotls;
1378	};
1379	$self->{filter_r} = sub {
1380	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1381	&_dotls;
1382	};
1383	}	1412	}
1384		1413
1385	=item $handle->stoptls	1414	=item $handle->stoptls
1386		1415
1387	Destroys the SSL connection, if any. Partial read or write data will be	1416	Shuts down the SSL connection - this makes a proper EOF handshake by
1388	lost.	1417	sending a close notify to the other side, but since OpenSSL doesn't
		1418	support non-blocking shut downs, it is not possible to re-use the stream
		1419	afterwards.
1389		1420
1390	=cut	1421	=cut
1391		1422
1392	sub stoptls {	1423	sub stoptls {
1393	my ($self) = @_;	1424	my ($self) = @_;
1394		1425
		1426	if ($self->{tls}) {
		1427	Net::SSLeay::shutdown ($self->{tls});
		1428
		1429	&_dotls;
		1430
		1431	# we don't give a shit. no, we do, but we can't. no...
		1432	# we, we... have to use openssl :/
		1433	&_freetls;
		1434	}
		1435	}
		1436
		1437	sub _freetls {
		1438	my ($self) = @_;
		1439
		1440	return unless $self->{tls};
		1441
1395	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1442	Net::SSLeay::free (delete $self->{tls});
1396		1443
1397	delete $self->{_rbio};	1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1398	delete $self->{_wbio};
1399	delete $self->{_tls_wbuf};
1400	delete $self->{filter_r};
1401	delete $self->{filter_w};
1402	}	1445	}
1403		1446
1404	sub DESTROY {	1447	sub DESTROY {
1405	my $self = shift;	1448	my $self = shift;
1406		1449
1407	$self->stoptls;	1450	&_freetls;
1408		1451
1409	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1410		1453
1411	if ($linger && length $self->{wbuf}) {	1454	if ($linger && length $self->{wbuf}) {
1412	my $fh = delete $self->{fh};	1455	my $fh = delete $self->{fh};
…		…
1427	@linger = ();	1470	@linger = ();
1428	});	1471	});
1429	}	1472	}
1430	}	1473	}
1431		1474
		1475	=item $handle->destroy
		1476
		1477	Shuts down the handle object as much as possible - this call ensures that
		1478	no further callbacks will be invoked and resources will be freed as much
		1479	as possible. You must not call any methods on the object afterwards.
		1480
		1481	Normally, you can just "forget" any references to an AnyEvent::Handle
		1482	object and it will simply shut down. This works in fatal error and EOF
		1483	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1484	callback, so when you want to destroy the AnyEvent::Handle object from
		1485	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1486	that case.
		1487
		1488	The handle might still linger in the background and write out remaining
		1489	data, as specified by the C<linger> option, however.
		1490
		1491	=cut
		1492
		1493	sub destroy {
		1494	my ($self) = @_;
		1495
		1496	$self->DESTROY;
		1497	%$self = ();
		1498	}
		1499
1432	=item AnyEvent::Handle::TLS_CTX	1500	=item AnyEvent::Handle::TLS_CTX
1433		1501
1434	This function creates and returns the Net::SSLeay::CTX object used by	1502	This function creates and returns the Net::SSLeay::CTX object used by
1435	default for TLS mode.	1503	default for TLS mode.
1436		1504
…		…
1464	}	1532	}
1465	}	1533	}
1466		1534
1467	=back	1535	=back
1468		1536
		1537
		1538	=head1 NONFREQUENTLY ASKED QUESTIONS
		1539
		1540	=over 4
		1541
		1542	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1543	still get further invocations!
		1544
		1545	That's because AnyEvent::Handle keeps a reference to itself when handling
		1546	read or write callbacks.
		1547
		1548	It is only safe to "forget" the reference inside EOF or error callbacks,
		1549	from within all other callbacks, you need to explicitly call the C<<
		1550	->destroy >> method.
		1551
		1552	=item I get different callback invocations in TLS mode/Why can't I pause
		1553	reading?
		1554
		1555	Unlike, say, TCP, TLS connections do not consist of two independent
		1556	communication channels, one for each direction. Or put differently. The
		1557	read and write directions are not independent of each other: you cannot
		1558	write data unless you are also prepared to read, and vice versa.
		1559
		1560	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1561	callback invocations when you are not expecting any read data - the reason
		1562	is that AnyEvent::Handle always reads in TLS mode.
		1563
		1564	During the connection, you have to make sure that you always have a
		1565	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1566	connection (or when you no longer want to use it) you can call the
		1567	C<destroy> method.
		1568
		1569	=item How do I read data until the other side closes the connection?
		1570
		1571	If you just want to read your data into a perl scalar, the easiest way
		1572	to achieve this is by setting an C<on_read> callback that does nothing,
		1573	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1574	will be in C<$_[0]{rbuf}>:
		1575
		1576	$handle->on_read (sub { });
		1577	$handle->on_eof (undef);
		1578	$handle->on_error (sub {
		1579	my $data = delete $_[0]{rbuf};
		1580	undef $handle;
		1581	});
		1582
		1583	The reason to use C<on_error> is that TCP connections, due to latencies
		1584	and packets loss, might get closed quite violently with an error, when in
		1585	fact, all data has been received.
		1586
		1587	It is usually better to use acknowledgements when transferring data,
		1588	to make sure the other side hasn't just died and you got the data
		1589	intact. This is also one reason why so many internet protocols have an
		1590	explicit QUIT command.
		1591
		1592	=item I don't want to destroy the handle too early - how do I wait until
		1593	all data has been written?
		1594
		1595	After writing your last bits of data, set the C<on_drain> callback
		1596	and destroy the handle in there - with the default setting of
		1597	C<low_water_mark> this will be called precisely when all data has been
		1598	written to the socket:
		1599
		1600	$handle->push_write (...);
		1601	$handle->on_drain (sub {
		1602	warn "all data submitted to the kernel\n";
		1603	undef $handle;
		1604	});
		1605
		1606	=back
		1607
		1608
1469	=head1 SUBCLASSING AnyEvent::Handle	1609	=head1 SUBCLASSING AnyEvent::Handle
1470		1610
1471	In many cases, you might want to subclass AnyEvent::Handle.	1611	In many cases, you might want to subclass AnyEvent::Handle.
1472		1612
1473	To make this easier, a given version of AnyEvent::Handle uses these	1613	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.82 by root, Thu Aug 21 18:45:16 2008 UTC vs. Revision 1.104 by root, Mon Nov 3 21:49:25 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC vs.
Revision 1.104 by root, Mon Nov 3 21:49:25 2008 UTC