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