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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.86 by root, Thu Aug 21 20:41:16 2008 UTC vs.
Revision 1.97 by root, Thu Oct 2 11:07:59 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.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;
…		…
59	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
60		60
61	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
62	argument.	62	argument.
63		63
		64	=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
64	=head1 METHODS	72	=head1 METHODS
65		73
66	=over 4	74	=over 4
67		75
68	=item B<new (%args)>	76	=item B<new (%args)>
…		…
103	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
104	connect or a read error.	112	connect or a read error.
105		113
106	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
107	fatal errors the handle object will be shut down and will not be usable	115	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C< ->rbuf >). Examples of fatal	116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers	117	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.	118	(C<EPIPE>) or I/O errors.
111		119
112	Non-fatal errors can be retried by simply returning, but it is recommended	120	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	121	to simply ignore this parameter and instead abondon the handle object
…		…
152	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
153		161
154	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
155	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
156	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
157	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
158		166
159	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
160	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
161	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
162	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
163		172
164	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
165		174
166	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
167		176
…		…
171		180
172	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
173		182
174	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>)
175	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
176	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
177		186
178	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
179	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
180	(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
181	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
182	isn't finished).	191	isn't finished).
183		192
184	=item autocork => <boolean>	193	=item autocork => <boolean>
185		194
186	When disabled (the default), then C<push_write> will try to immediately	195	When disabled (the default), then C<push_write> will try to immediately
187	write the data to the handle if possible. This avoids having to register	196	write the data to the handle, if possible. This avoids having to register
188	a write watcher and wait for the next event loop iteration, but can be	197	a write watcher and wait for the next event loop iteration, but can
189	inefficient if you write multiple small chunks (this disadvantage is	198	be inefficient if you write multiple small chunks (on the wire, this
190	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
191		201
192	When enabled, then writes will always be queued till the next event loop	202	When enabled, then writes will always be queued till the next event loop
193	iteration. This is efficient when you do many small writes per iteration,	203	iteration. This is efficient when you do many small writes per iteration,
194	but less efficient when you do a single write only.	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.
195		206
196	=item no_delay => <boolean>	207	=item no_delay => <boolean>
197		208
198	When doing small writes on sockets, your operating system kernel might	209	When doing small writes on sockets, your operating system kernel might
199	wait a bit for more data before actually sending it out. This is called	210	wait a bit for more data before actually sending it out. This is called
200	the Nagle algorithm, and usually it is beneficial.	211	the Nagle algorithm, and usually it is beneficial.
201		212
202	In some situations you want as low a delay as possible, which cna be	213	In some situations you want as low a delay as possible, which can be
203	accomplishd by setting this option to true.	214	accomplishd by setting this option to a true value.
204		215
205	The default is your opertaing system's default behaviour, this option	216	The default is your opertaing system's default behaviour (most likely
206	explicitly enables or disables it, if possible.	217	enabled), this option explicitly enables or disables it, if possible.
207		218
208	=item read_size => <bytes>	219	=item read_size => <bytes>
209		220
210	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
211	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
212		224
213	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
214		226
215	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
216	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
217	considered empty.	229	considered empty.
218		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
219	=item linger => <seconds>	236	=item linger => <seconds>
220		237
221	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
222	AnyEvent::Handle object will check wether there is still outstanding write	239	AnyEvent::Handle object will check whether there is still outstanding
223	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
224	will be reported (this mostly matches how the operating system treats	241	socket. No errors will be reported (this mostly matches how the operating
225	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
226		243
227	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
228	encoded. This data will be lost.	245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
229		247
230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
231		249
232	When this parameter is given, it enables TLS (SSL) mode, that means	250	When this parameter is given, it enables TLS (SSL) mode, that means
233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt	251	AnyEvent will start a TLS handshake as soon as the conenction has been
234	data.	252	established and will transparently encrypt/decrypt data afterwards.
235		253
236	TLS mode requires Net::SSLeay to be installed (it will be loaded	254	TLS mode requires Net::SSLeay to be installed (it will be loaded
237	automatically when you try to create a TLS handle).	255	automatically when you try to create a TLS handle): this module doesn't
		256	have a dependency on that module, so if your module requires it, you have
		257	to add the dependency yourself.
238		258
239	Unlike TCP, TLS has a server and client side: for the TLS server side, use	259	Unlike TCP, TLS has a server and client side: for the TLS server side, use
240	C<accept>, and for the TLS client side of a connection, use C<connect>	260	C<accept>, and for the TLS client side of a connection, use C<connect>
241	mode.	261	mode.
242		262
243	You can also provide your own TLS connection object, but you have	263	You can also provide your own TLS connection object, but you have
244	to make sure that you call either C<Net::SSLeay::set_connect_state>	264	to make sure that you call either C<Net::SSLeay::set_connect_state>
245	or C<Net::SSLeay::set_accept_state> on it before you pass it to	265	or C<Net::SSLeay::set_accept_state> on it before you pass it to
246	AnyEvent::Handle.	266	AnyEvent::Handle.
247		267
248	See the C<starttls> method for when need to start TLS negotiation later.	268	See the C<< ->starttls >> method for when need to start TLS negotiation later.
249		269
250	=item tls_ctx => $ssl_ctx	270	=item tls_ctx => $ssl_ctx
251		271
252	Use the given Net::SSLeay::CTX object to create the new TLS connection	272	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
253	(unless a connection object was specified directly). If this parameter is	273	(unless a connection object was specified directly). If this parameter is
254	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	274	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
255		275
256	=item json => JSON or JSON::XS object	276	=item json => JSON or JSON::XS object
257		277
…		…
262	texts.	282	texts.
263		283
264	Note that you are responsible to depend on the JSON module if you want to	284	Note that you are responsible to depend on the JSON module if you want to
265	use this functionality, as AnyEvent does not have a dependency itself.	285	use this functionality, as AnyEvent does not have a dependency itself.
266		286
267	=item filter_r => $cb
268
269	=item filter_w => $cb
270
271	These exist, but are undocumented at this time.
272
273	=back	287	=back
274		288
275	=cut	289	=cut
276		290
277	sub new {	291	sub new {
…		…
281		295
282	$self->{fh} or Carp::croak "mandatory argument fh is missing";	296	$self->{fh} or Carp::croak "mandatory argument fh is missing";
283		297
284	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	298	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
285		299
286	if ($self->{tls}) {
287	require Net::SSLeay;
288	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
289	}	301	if $self->{tls};
290		302
291	$self->{_activity} = AnyEvent->now;	303	$self->{_activity} = AnyEvent->now;
292	$self->_timeout;	304	$self->_timeout;
293		305
294	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
306	delete $self->{_tw};	318	delete $self->{_tw};
307	delete $self->{_rw};	319	delete $self->{_rw};
308	delete $self->{_ww};	320	delete $self->{_ww};
309	delete $self->{fh};	321	delete $self->{fh};
310		322
311	$self->stoptls;	323	&_freetls;
312		324
313	delete $self->{on_read};	325	delete $self->{on_read};
314	delete $self->{_queue};	326	delete $self->{_queue};
315	}	327	}
316		328
…		…
329	}	341	}
330	}	342	}
331		343
332	=item $fh = $handle->fh	344	=item $fh = $handle->fh
333		345
334	This method returns the file handle of the L<AnyEvent::Handle> object.	346	This method returns the file handle used to create the L<AnyEvent::Handle> object.
335		347
336	=cut	348	=cut
337		349
338	sub fh { $_[0]{fh} }	350	sub fh { $_[0]{fh} }
339		351
…		…
357	$_[0]{on_eof} = $_[1];	369	$_[0]{on_eof} = $_[1];
358	}	370	}
359		371
360	=item $handle->on_timeout ($cb)	372	=item $handle->on_timeout ($cb)
361		373
362	Replace the current C<on_timeout> callback, or disables the callback	374	Replace the current C<on_timeout> callback, or disables the callback (but
363	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	375	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
364	argument.	376	argument and method.
365		377
366	=cut	378	=cut
367		379
368	sub on_timeout {	380	sub on_timeout {
369	$_[0]{on_timeout} = $_[1];	381	$_[0]{on_timeout} = $_[1];
…		…
475	my ($self, $cb) = @_;	487	my ($self, $cb) = @_;
476		488
477	$self->{on_drain} = $cb;	489	$self->{on_drain} = $cb;
478		490
479	$cb->($self)	491	$cb->($self)
480	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	492	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
481	}	493	}
482		494
483	=item $handle->push_write ($data)	495	=item $handle->push_write ($data)
484		496
485	Queues the given scalar to be written. You can push as much data as you	497	Queues the given scalar to be written. You can push as much data as you
…		…
502	substr $self->{wbuf}, 0, $len, "";	514	substr $self->{wbuf}, 0, $len, "";
503		515
504	$self->{_activity} = AnyEvent->now;	516	$self->{_activity} = AnyEvent->now;
505		517
506	$self->{on_drain}($self)	518	$self->{on_drain}($self)
507	if $self->{low_water_mark} >= length $self->{wbuf}	519	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
508	&& $self->{on_drain};	520	&& $self->{on_drain};
509		521
510	delete $self->{_ww} unless length $self->{wbuf};	522	delete $self->{_ww} unless length $self->{wbuf};
511	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
512	$self->_error ($!, 1);	524	$self->_error ($!, 1);
…		…
536		548
537	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	549	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
538	->($self, @_);	550	->($self, @_);
539	}	551	}
540		552
541	if ($self->{filter_w}) {	553	if ($self->{tls}) {
542	$self->{filter_w}($self, \$_[0]);	554	$self->{_tls_wbuf} .= $_[0];
		555
		556	&_dotls ($self);
543	} else {	557	} else {
544	$self->{wbuf} .= $_[0];	558	$self->{wbuf} .= $_[0];
545	$self->_drain_wbuf;	559	$self->_drain_wbuf;
546	}	560	}
547	}	561	}
…		…
564	=cut	578	=cut
565		579
566	register_write_type netstring => sub {	580	register_write_type netstring => sub {
567	my ($self, $string) = @_;	581	my ($self, $string) = @_;
568		582
569	sprintf "%d:%s,", (length $string), $string	583	(length $string) . ":$string,"
570	};	584	};
571		585
572	=item packstring => $format, $data	586	=item packstring => $format, $data
573		587
574	An octet string prefixed with an encoded length. The encoding C<$format>	588	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
783		797
784	last; # more data might arrive	798	last; # more data might arrive
785	}	799	}
786	} else {	800	} else {
787	# read side becomes idle	801	# read side becomes idle
788	delete $self->{_rw};	802	delete $self->{_rw} unless $self->{tls};
789	last;	803	last;
790	}	804	}
791	}	805	}
792		806
793	if ($self->{_eof}) {	807	if ($self->{_eof}) {
…		…
1088	An octet string prefixed with an encoded length. The encoding C<$format>	1102	An octet string prefixed with an encoded length. The encoding C<$format>
1089	uses the same format as a Perl C<pack> format, but must specify a single	1103	uses the same format as a Perl C<pack> format, but must specify a single
1090	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1104	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1091	optional C<!>, C<< < >> or C<< > >> modifier).	1105	optional C<!>, C<< < >> or C<< > >> modifier).
1092		1106
1093	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1107	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1108	EPP uses a prefix of C<N> (4 octtes).
1094		1109
1095	Example: read a block of data prefixed by its length in BER-encoded	1110	Example: read a block of data prefixed by its length in BER-encoded
1096	format (very efficient).	1111	format (very efficient).
1097		1112
1098	$handle->push_read (packstring => "w", sub {	1113	$handle->push_read (packstring => "w", sub {
…		…
1251	Note that AnyEvent::Handle will automatically C<start_read> for you when	1266	Note that AnyEvent::Handle will automatically C<start_read> for you when
1252	you change the C<on_read> callback or push/unshift a read callback, and it	1267	you change the C<on_read> callback or push/unshift a read callback, and it
1253	will automatically C<stop_read> for you when neither C<on_read> is set nor	1268	will automatically C<stop_read> for you when neither C<on_read> is set nor
1254	there are any read requests in the queue.	1269	there are any read requests in the queue.
1255		1270
		1271	These methods will have no effect when in TLS mode (as TLS doesn't support
		1272	half-duplex connections).
		1273
1256	=cut	1274	=cut
1257		1275
1258	sub stop_read {	1276	sub stop_read {
1259	my ($self) = @_;	1277	my ($self) = @_;
1260		1278
1261	delete $self->{_rw};	1279	delete $self->{_rw} unless $self->{tls};
1262	}	1280	}
1263		1281
1264	sub start_read {	1282	sub start_read {
1265	my ($self) = @_;	1283	my ($self) = @_;
1266		1284
1267	unless ($self->{_rw} \|\| $self->{_eof}) {	1285	unless ($self->{_rw} \|\| $self->{_eof}) {
1268	Scalar::Util::weaken $self;	1286	Scalar::Util::weaken $self;
1269		1287
1270	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1288	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1271	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1289	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1272	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1290	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1273		1291
1274	if ($len > 0) {	1292	if ($len > 0) {
1275	$self->{_activity} = AnyEvent->now;	1293	$self->{_activity} = AnyEvent->now;
1276		1294
1277	$self->{filter_r}	1295	if ($self->{tls}) {
1278	? $self->{filter_r}($self, $rbuf)	1296	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1279	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1297
		1298	&_dotls ($self);
		1299	} else {
		1300	$self->_drain_rbuf unless $self->{_in_drain};
		1301	}
1280		1302
1281	} elsif (defined $len) {	1303	} elsif (defined $len) {
1282	delete $self->{_rw};	1304	delete $self->{_rw};
1283	$self->{_eof} = 1;	1305	$self->{_eof} = 1;
1284	$self->_drain_rbuf unless $self->{_in_drain};	1306	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1288	}	1310	}
1289	});	1311	});
1290	}	1312	}
1291	}	1313	}
1292		1314
		1315	# poll the write BIO and send the data if applicable
1293	sub _dotls {	1316	sub _dotls {
1294	my ($self) = @_;	1317	my ($self) = @_;
1295		1318
1296	my $buf;	1319	my $tmp;
1297		1320
1298	if (length $self->{_tls_wbuf}) {	1321	if (length $self->{_tls_wbuf}) {
1299	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1322	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1300	substr $self->{_tls_wbuf}, 0, $len, "";	1323	substr $self->{_tls_wbuf}, 0, $tmp, "";
1301	}	1324	}
1302	}	1325	}
1303		1326
1304	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1305	$self->{wbuf} .= $buf;
1306	$self->_drain_wbuf;
1307	}
1308
1309	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1327	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1310	if (length $buf) {	1328	unless (length $tmp) {
1311	$self->{rbuf} .= $buf;
1312	$self->_drain_rbuf unless $self->{_in_drain};
1313	} else {
1314	# let's treat SSL-eof as we treat normal EOF	1329	# let's treat SSL-eof as we treat normal EOF
		1330	delete $self->{_rw};
1315	$self->{_eof} = 1;	1331	$self->{_eof} = 1;
1316	$self->_shutdown;	1332	&_freetls;
1317	return;
1318	}	1333	}
1319	}
1320		1334
		1335	$self->{rbuf} .= $tmp;
		1336	$self->_drain_rbuf unless $self->{_in_drain};
		1337	$self->{tls} or return; # tls session might have gone away in callback
		1338	}
		1339
1321	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1340	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1322		1341
1323	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1342	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1324	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1343	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1325	return $self->_error ($!, 1);	1344	return $self->_error ($!, 1);
1326	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1345	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1327	return $self->_error (&Errno::EIO, 1);	1346	return $self->_error (&Errno::EIO, 1);
1328	}	1347	}
1329		1348
1330	# all others are fine for our purposes	1349	# all other errors are fine for our purposes
		1350	}
		1351
		1352	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1353	$self->{wbuf} .= $tmp;
		1354	$self->_drain_wbuf;
1331	}	1355	}
1332	}	1356	}
1333		1357
1334	=item $handle->starttls ($tls[, $tls_ctx])	1358	=item $handle->starttls ($tls[, $tls_ctx])
1335		1359
…		…
1345		1369
1346	The TLS connection object will end up in C<< $handle->{tls} >> after this	1370	The TLS connection object will end up in C<< $handle->{tls} >> after this
1347	call and can be used or changed to your liking. Note that the handshake	1371	call and can be used or changed to your liking. Note that the handshake
1348	might have already started when this function returns.	1372	might have already started when this function returns.
1349		1373
		1374	If it an error to start a TLS handshake more than once per
		1375	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1376
1350	=cut	1377	=cut
1351		1378
1352	sub starttls {	1379	sub starttls {
1353	my ($self, $ssl, $ctx) = @_;	1380	my ($self, $ssl, $ctx) = @_;
1354		1381
1355	$self->stoptls;	1382	require Net::SSLeay;
1356		1383
		1384	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
		1385	if $self->{tls};
		1386
1357	if ($ssl eq "accept") {	1387	if ($ssl eq "accept") {
1358	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1388	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1359	Net::SSLeay::set_accept_state ($ssl);	1389	Net::SSLeay::set_accept_state ($ssl);
1360	} elsif ($ssl eq "connect") {	1390	} elsif ($ssl eq "connect") {
1361	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1391	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1367	# basically, this is deep magic (because SSL_read should have the same issues)	1397	# basically, this is deep magic (because SSL_read should have the same issues)
1368	# but the openssl maintainers basically said: "trust us, it just works".	1398	# but the openssl maintainers basically said: "trust us, it just works".
1369	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1399	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1370	# and mismaintained ssleay-module doesn't even offer them).	1400	# and mismaintained ssleay-module doesn't even offer them).
1371	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1401	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1402	#
		1403	# in short: this is a mess.
		1404	#
		1405	# note that we do not try to keep the length constant between writes as we are required to do.
		1406	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1407	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1408	# have identity issues in that area.
1372	Net::SSLeay::CTX_set_mode ($self->{tls},	1409	Net::SSLeay::CTX_set_mode ($self->{tls},
1373	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1410	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1374	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1411	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1375		1412
1376	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1413	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1377	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1414	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1378		1415
1379	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1416	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1380		1417
1381	$self->{filter_w} = sub {	1418	&_dotls; # need to trigger the initial handshake
1382	$_[0]{_tls_wbuf} .= ${$_[1]};	1419	$self->start_read; # make sure we actually do read
1383	&_dotls;
1384	};
1385	$self->{filter_r} = sub {
1386	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1387	&_dotls;
1388	};
1389	}	1420	}
1390		1421
1391	=item $handle->stoptls	1422	=item $handle->stoptls
1392		1423
1393	Destroys the SSL connection, if any. Partial read or write data will be	1424	Shuts down the SSL connection - this makes a proper EOF handshake by
1394	lost.	1425	sending a close notify to the other side, but since OpenSSL doesn't
		1426	support non-blocking shut downs, it is not possible to re-use the stream
		1427	afterwards.
1395		1428
1396	=cut	1429	=cut
1397		1430
1398	sub stoptls {	1431	sub stoptls {
1399	my ($self) = @_;	1432	my ($self) = @_;
1400		1433
		1434	if ($self->{tls}) {
		1435	Net::SSLeay::shutdown ($self->{tls});
		1436
		1437	&_dotls;
		1438
		1439	# we don't give a shit. no, we do, but we can't. no...
		1440	# we, we... have to use openssl :/
		1441	&_freetls;
		1442	}
		1443	}
		1444
		1445	sub _freetls {
		1446	my ($self) = @_;
		1447
		1448	return unless $self->{tls};
		1449
1401	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1450	Net::SSLeay::free (delete $self->{tls});
1402		1451
1403	delete $self->{_rbio};	1452	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1404	delete $self->{_wbio};
1405	delete $self->{_tls_wbuf};
1406	delete $self->{filter_r};
1407	delete $self->{filter_w};
1408	}	1453	}
1409		1454
1410	sub DESTROY {	1455	sub DESTROY {
1411	my $self = shift;	1456	my $self = shift;
1412		1457
1413	$self->stoptls;	1458	&_freetls;
1414		1459
1415	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1460	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1416		1461
1417	if ($linger && length $self->{wbuf}) {	1462	if ($linger && length $self->{wbuf}) {
1418	my $fh = delete $self->{fh};	1463	my $fh = delete $self->{fh};
…		…
1470	}	1515	}
1471	}	1516	}
1472		1517
1473	=back	1518	=back
1474		1519
		1520
		1521	=head1 NONFREQUENTLY ASKED QUESTIONS
		1522
		1523	=over 4
		1524
		1525	=item How do I read data until the other side closes the connection?
		1526
		1527	If you just want to read your data into a perl scalar, the easiest way
		1528	to achieve this is by setting an C<on_read> callback that does nothing,
		1529	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1530	will be in C<$_[0]{rbuf}>:
		1531
		1532	$handle->on_read (sub { });
		1533	$handle->on_eof (undef);
		1534	$handle->on_error (sub {
		1535	my $data = delete $_[0]{rbuf};
		1536	undef $handle;
		1537	});
		1538
		1539	The reason to use C<on_error> is that TCP connections, due to latencies
		1540	and packets loss, might get closed quite violently with an error, when in
		1541	fact, all data has been received.
		1542
		1543	It is usually better to use acknowledgements when transfering data,
		1544	to make sure the other side hasn't just died and you got the data
		1545	intact. This is also one reason why so many internet protocols have an
		1546	explicit QUIT command.
		1547
		1548
		1549	=item I don't want to destroy the handle too early - how do I wait until
		1550	all data has been written?
		1551
		1552	After writing your last bits of data, set the C<on_drain> callback
		1553	and destroy the handle in there - with the default setting of
		1554	C<low_water_mark> this will be called precisely when all data has been
		1555	written to the socket:
		1556
		1557	$handle->push_write (...);
		1558	$handle->on_drain (sub {
		1559	warn "all data submitted to the kernel\n";
		1560	undef $handle;
		1561	});
		1562
		1563	=back
		1564
		1565
1475	=head1 SUBCLASSING AnyEvent::Handle	1566	=head1 SUBCLASSING AnyEvent::Handle
1476		1567
1477	In many cases, you might want to subclass AnyEvent::Handle.	1568	In many cases, you might want to subclass AnyEvent::Handle.
1478		1569
1479	To make this easier, a given version of AnyEvent::Handle uses these	1570	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.86 by root, Thu Aug 21 20:41:16 2008 UTC vs. Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.86 by root, Thu Aug 21 20:41:16 2008 UTC vs.
Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC