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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC

…		…
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.232;	19	our $VERSION = 4.331;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
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 it	242	When this parameter is given, it enables TLS (SSL) mode, that means
233	will start making 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	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
240	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
241		254
242	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
243	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>
244	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
245	AnyEvent::Handle.	258	AnyEvent::Handle.
246		259
		260	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		261	passing in the wrong integer will lead to certain crash. This most often
		262	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		263	segmentation fault.
		264
247	See the C<starttls> method if you need to start TLS negotiation later.	265	See the C<< ->starttls >> method for when need to start TLS negotiation later.
248		266
249	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
250		268
251	Use the given Net::SSLeay::CTX object to create the new TLS connection	269	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
252	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
253	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
254		272
255	=item json => JSON or JSON::XS object	273	=item json => JSON or JSON::XS object
256		274
257	This is the json coder object used by the C<json> read and write types.	275	This is the json coder object used by the C<json> read and write types.
258		276
259	If you don't supply it, then AnyEvent::Handle will create and use a	277	If you don't supply it, then AnyEvent::Handle will create and use a
260	suitable one, which will write and expect UTF-8 encoded JSON texts.	278	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		279	texts.
261		280
262	Note that you are responsible to depend on the JSON module if you want to	281	Note that you are responsible to depend on the JSON module if you want to
263	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
264		283
265	=item filter_r => $cb
266
267	=item filter_w => $cb
268
269	These exist, but are undocumented at this time.
270
271	=back	284	=back
272		285
273	=cut	286	=cut
274		287
275	sub new {	288	sub new {
…		…
279		292
280	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
281		294
282	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
283		296
284	if ($self->{tls}) {
285	require Net::SSLeay;
286	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
287	}	298	if $self->{tls};
288		299
289	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
290	$self->_timeout;	301	$self->_timeout;
291		302
292	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
304	delete $self->{_tw};	315	delete $self->{_tw};
305	delete $self->{_rw};	316	delete $self->{_rw};
306	delete $self->{_ww};	317	delete $self->{_ww};
307	delete $self->{fh};	318	delete $self->{fh};
308		319
309	$self->stoptls;	320	&_freetls;
310		321
311	delete $self->{on_read};	322	delete $self->{on_read};
312	delete $self->{_queue};	323	delete $self->{_queue};
313	}	324	}
314		325
…		…
320		331
321	$! = $errno;	332	$! = $errno;
322		333
323	if ($self->{on_error}) {	334	if ($self->{on_error}) {
324	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
325	} else {	336	} elsif ($self->{fh}) {
326	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
327	}	338	}
328	}	339	}
329		340
330	=item $fh = $handle->fh	341	=item $fh = $handle->fh
331		342
332	This method returns the file handle of the L<AnyEvent::Handle> object.	343	This method returns the file handle used to create the L<AnyEvent::Handle> object.
333		344
334	=cut	345	=cut
335		346
336	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
337		348
…		…
355	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
356	}	367	}
357		368
358	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
359		370
360	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
361	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	372	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
362	argument.	373	argument and method.
363		374
364	=cut	375	=cut
365		376
366	sub on_timeout {	377	sub on_timeout {
367	$_[0]{on_timeout} = $_[1];	378	$_[0]{on_timeout} = $_[1];
368	}	379	}
369		380
370	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
371		382
372	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
373	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
374		385
375	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
376		391
377	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
378		393
379	Enables or disables the C<no_delay> setting (see constructor argument of	394	Enables or disables the C<no_delay> setting (see constructor argument of
380	the same name for details).	395	the same name for details).
…		…
473	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
474		489
475	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
476		491
477	$cb->($self)	492	$cb->($self)
478	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
479	}	494	}
480		495
481	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
482		497
483	Queues the given scalar to be written. You can push as much data as you	498	Queues the given scalar to be written. You can push as much data as you
…		…
500	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
501		516
502	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
503		518
504	$self->{on_drain}($self)	519	$self->{on_drain}($self)
505	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
506	&& $self->{on_drain};	521	&& $self->{on_drain};
507		522
508	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
509	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
510	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
534		549
535	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	550	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
536	->($self, @_);	551	->($self, @_);
537	}	552	}
538		553
539	if ($self->{filter_w}) {	554	if ($self->{tls}) {
540	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
541	} else {	558	} else {
542	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
543	$self->_drain_wbuf;	560	$self->_drain_wbuf;
544	}	561	}
545	}	562	}
…		…
562	=cut	579	=cut
563		580
564	register_write_type netstring => sub {	581	register_write_type netstring => sub {
565	my ($self, $string) = @_;	582	my ($self, $string) = @_;
566		583
567	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
568	};	585	};
569		586
570	=item packstring => $format, $data	587	=item packstring => $format, $data
571		588
572	An octet string prefixed with an encoded length. The encoding C<$format>	589	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
750	) {	767	) {
751	$self->_error (&Errno::ENOSPC, 1), return;	768	$self->_error (&Errno::ENOSPC, 1), return;
752	}	769	}
753		770
754	while () {	771	while () {
		772	$self->{rbuf} .= delete $self->{tls_rbuf} if exists $self->{tls_rbuf};#d#
		773
755	my $len = length $self->{rbuf};	774	my $len = length $self->{rbuf};
756		775
757	if (my $cb = shift @{ $self->{_queue} }) {	776	if (my $cb = shift @{ $self->{_queue} }) {
758	unless ($cb->($self)) {	777	unless ($cb->($self)) {
759	if ($self->{_eof}) {	778	if ($self->{_eof}) {
…		…
781		800
782	last; # more data might arrive	801	last; # more data might arrive
783	}	802	}
784	} else {	803	} else {
785	# read side becomes idle	804	# read side becomes idle
786	delete $self->{_rw};	805	delete $self->{_rw} unless $self->{tls};
787	last;	806	last;
788	}	807	}
789	}	808	}
790		809
791	if ($self->{_eof}) {	810	if ($self->{_eof}) {
…		…
1086	An octet string prefixed with an encoded length. The encoding C<$format>	1105	An octet string prefixed with an encoded length. The encoding C<$format>
1087	uses the same format as a Perl C<pack> format, but must specify a single	1106	uses the same format as a Perl C<pack> format, but must specify a single
1088	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1107	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1089	optional C<!>, C<< < >> or C<< > >> modifier).	1108	optional C<!>, C<< < >> or C<< > >> modifier).
1090		1109
1091	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1110	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1111	EPP uses a prefix of C<N> (4 octtes).
1092		1112
1093	Example: read a block of data prefixed by its length in BER-encoded	1113	Example: read a block of data prefixed by its length in BER-encoded
1094	format (very efficient).	1114	format (very efficient).
1095		1115
1096	$handle->push_read (packstring => "w", sub {	1116	$handle->push_read (packstring => "w", sub {
…		…
1126	}	1146	}
1127	};	1147	};
1128		1148
1129	=item json => $cb->($handle, $hash_or_arrayref)	1149	=item json => $cb->($handle, $hash_or_arrayref)
1130		1150
1131	Reads a JSON object or array, decodes it and passes it to the callback.	1151	Reads a JSON object or array, decodes it and passes it to the
		1152	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1132		1153
1133	If a C<json> object was passed to the constructor, then that will be used	1154	If a C<json> object was passed to the constructor, then that will be used
1134	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1155	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1135		1156
1136	This read type uses the incremental parser available with JSON version	1157	This read type uses the incremental parser available with JSON version
…		…
1153	my $rbuf = \$self->{rbuf};	1174	my $rbuf = \$self->{rbuf};
1154		1175
1155	my $json = $self->{json} \|\|= JSON->new->utf8;	1176	my $json = $self->{json} \|\|= JSON->new->utf8;
1156		1177
1157	sub {	1178	sub {
1158	my $ref = $json->incr_parse ($self->{rbuf});	1179	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1159		1180
1160	if ($ref) {	1181	if ($ref) {
1161	$self->{rbuf} = $json->incr_text;	1182	$self->{rbuf} = $json->incr_text;
1162	$json->incr_text = "";	1183	$json->incr_text = "";
1163	$cb->($self, $ref);	1184	$cb->($self, $ref);
1164		1185
1165	1	1186	1
		1187	} elsif ($@) {
		1188	# error case
		1189	$json->incr_skip;
		1190
		1191	$self->{rbuf} = $json->incr_text;
		1192	$json->incr_text = "";
		1193
		1194	$self->_error (&Errno::EBADMSG);
		1195
		1196	()
1166	} else {	1197	} else {
1167	$self->{rbuf} = "";	1198	$self->{rbuf} = "";
		1199
1168	()	1200	()
1169	}	1201	}
1170	}	1202	}
1171	};	1203	};
1172		1204
…		…
1249	Note that AnyEvent::Handle will automatically C<start_read> for you when	1281	Note that AnyEvent::Handle will automatically C<start_read> for you when
1250	you change the C<on_read> callback or push/unshift a read callback, and it	1282	you change the C<on_read> callback or push/unshift a read callback, and it
1251	will automatically C<stop_read> for you when neither C<on_read> is set nor	1283	will automatically C<stop_read> for you when neither C<on_read> is set nor
1252	there are any read requests in the queue.	1284	there are any read requests in the queue.
1253		1285
		1286	These methods will have no effect when in TLS mode (as TLS doesn't support
		1287	half-duplex connections).
		1288
1254	=cut	1289	=cut
1255		1290
1256	sub stop_read {	1291	sub stop_read {
1257	my ($self) = @_;	1292	my ($self) = @_;
1258		1293
1259	delete $self->{_rw};	1294	delete $self->{_rw} unless $self->{tls};
1260	}	1295	}
1261		1296
1262	sub start_read {	1297	sub start_read {
1263	my ($self) = @_;	1298	my ($self) = @_;
1264		1299
1265	unless ($self->{_rw} \|\| $self->{_eof}) {	1300	unless ($self->{_rw} \|\| $self->{_eof}) {
1266	Scalar::Util::weaken $self;	1301	Scalar::Util::weaken $self;
1267		1302
1268	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1303	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1269	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1304	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1270	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1305	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1271		1306
1272	if ($len > 0) {	1307	if ($len > 0) {
1273	$self->{_activity} = AnyEvent->now;	1308	$self->{_activity} = AnyEvent->now;
1274		1309
1275	$self->{filter_r}	1310	if ($self->{tls}) {
1276	? $self->{filter_r}($self, $rbuf)	1311	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1277	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1312
		1313	&_dotls ($self);
		1314	} else {
		1315	$self->_drain_rbuf unless $self->{_in_drain};
		1316	}
1278		1317
1279	} elsif (defined $len) {	1318	} elsif (defined $len) {
1280	delete $self->{_rw};	1319	delete $self->{_rw};
1281	$self->{_eof} = 1;	1320	$self->{_eof} = 1;
1282	$self->_drain_rbuf unless $self->{_in_drain};	1321	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1286	}	1325	}
1287	});	1326	});
1288	}	1327	}
1289	}	1328	}
1290		1329
		1330	# poll the write BIO and send the data if applicable
1291	sub _dotls {	1331	sub _dotls {
1292	my ($self) = @_;	1332	my ($self) = @_;
1293		1333
1294	my $buf;	1334	my $tmp;
1295		1335
1296	if (length $self->{_tls_wbuf}) {	1336	if (length $self->{_tls_wbuf}) {
1297	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1337	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1298	substr $self->{_tls_wbuf}, 0, $len, "";	1338	substr $self->{_tls_wbuf}, 0, $tmp, "";
1299	}	1339	}
1300	}	1340	}
1301		1341
1302	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1303	$self->{wbuf} .= $buf;
1304	$self->_drain_wbuf;
1305	}
1306
1307	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1342	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1308	if (length $buf) {	1343	unless (length $tmp) {
1309	$self->{rbuf} .= $buf;
1310	$self->_drain_rbuf unless $self->{_in_drain};
1311	} else {
1312	# let's treat SSL-eof as we treat normal EOF	1344	# let's treat SSL-eof as we treat normal EOF
		1345	delete $self->{_rw};
1313	$self->{_eof} = 1;	1346	$self->{_eof} = 1;
1314	$self->_shutdown;	1347	&_freetls;
1315	return;
1316	}	1348	}
1317	}
1318		1349
		1350	$self->{tls_rbuf} .= $tmp;#d#
		1351	$self->_drain_rbuf unless $self->{_in_drain};
		1352	$self->{tls} or return; # tls session might have gone away in callback
		1353	}
		1354
1319	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1355	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1320		1356
1321	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1357	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1322	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1358	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1323	return $self->_error ($!, 1);	1359	return $self->_error ($!, 1);
1324	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1360	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1325	return $self->_error (&Errno::EIO, 1);	1361	return $self->_error (&Errno::EIO, 1);
1326	}	1362	}
1327		1363
1328	# all others are fine for our purposes	1364	# all other errors are fine for our purposes
		1365	}
		1366
		1367	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1368	$self->{wbuf} .= $tmp;
		1369	$self->_drain_wbuf;
1329	}	1370	}
1330	}	1371	}
1331		1372
1332	=item $handle->starttls ($tls[, $tls_ctx])	1373	=item $handle->starttls ($tls[, $tls_ctx])
1333		1374
…		…
1343		1384
1344	The TLS connection object will end up in C<< $handle->{tls} >> after this	1385	The TLS connection object will end up in C<< $handle->{tls} >> after this
1345	call and can be used or changed to your liking. Note that the handshake	1386	call and can be used or changed to your liking. Note that the handshake
1346	might have already started when this function returns.	1387	might have already started when this function returns.
1347		1388
		1389	If it an error to start a TLS handshake more than once per
		1390	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1391
1348	=cut	1392	=cut
1349		1393
1350	sub starttls {	1394	sub starttls {
1351	my ($self, $ssl, $ctx) = @_;	1395	my ($self, $ssl, $ctx) = @_;
1352		1396
1353	$self->stoptls;	1397	require Net::SSLeay;
1354		1398
		1399	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1400	if $self->{tls};
		1401
1355	if ($ssl eq "accept") {	1402	if ($ssl eq "accept") {
1356	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1403	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1357	Net::SSLeay::set_accept_state ($ssl);	1404	Net::SSLeay::set_accept_state ($ssl);
1358	} elsif ($ssl eq "connect") {	1405	} elsif ($ssl eq "connect") {
1359	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1406	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1365	# basically, this is deep magic (because SSL_read should have the same issues)	1412	# basically, this is deep magic (because SSL_read should have the same issues)
1366	# but the openssl maintainers basically said: "trust us, it just works".	1413	# but the openssl maintainers basically said: "trust us, it just works".
1367	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1414	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1368	# and mismaintained ssleay-module doesn't even offer them).	1415	# and mismaintained ssleay-module doesn't even offer them).
1369	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1416	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1417	#
		1418	# in short: this is a mess.
		1419	#
		1420	# note that we do not try to keep the length constant between writes as we are required to do.
		1421	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1422	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1423	# have identity issues in that area.
1370	Net::SSLeay::CTX_set_mode ($self->{tls},	1424	Net::SSLeay::CTX_set_mode ($self->{tls},
1371	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1425	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1372	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1426	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1373		1427
1374	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1375	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1376		1430
1377	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1431	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1378		1432
1379	$self->{filter_w} = sub {	1433	&_dotls; # need to trigger the initial handshake
1380	$_[0]{_tls_wbuf} .= ${$_[1]};	1434	$self->start_read; # make sure we actually do read
1381	&_dotls;
1382	};
1383	$self->{filter_r} = sub {
1384	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1385	&_dotls;
1386	};
1387	}	1435	}
1388		1436
1389	=item $handle->stoptls	1437	=item $handle->stoptls
1390		1438
1391	Destroys the SSL connection, if any. Partial read or write data will be	1439	Shuts down the SSL connection - this makes a proper EOF handshake by
1392	lost.	1440	sending a close notify to the other side, but since OpenSSL doesn't
		1441	support non-blocking shut downs, it is not possible to re-use the stream
		1442	afterwards.
1393		1443
1394	=cut	1444	=cut
1395		1445
1396	sub stoptls {	1446	sub stoptls {
1397	my ($self) = @_;	1447	my ($self) = @_;
1398		1448
		1449	if ($self->{tls}) {
		1450	Net::SSLeay::shutdown ($self->{tls});
		1451
		1452	&_dotls;
		1453
		1454	# we don't give a shit. no, we do, but we can't. no...
		1455	# we, we... have to use openssl :/
		1456	&_freetls;
		1457	}
		1458	}
		1459
		1460	sub _freetls {
		1461	my ($self) = @_;
		1462
		1463	return unless $self->{tls};
		1464
1399	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1465	Net::SSLeay::free (delete $self->{tls});
1400		1466
1401	delete $self->{_rbio};	1467	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1402	delete $self->{_wbio};
1403	delete $self->{_tls_wbuf};
1404	delete $self->{filter_r};
1405	delete $self->{filter_w};
1406	}	1468	}
1407		1469
1408	sub DESTROY {	1470	sub DESTROY {
1409	my $self = shift;	1471	my $self = shift;
1410		1472
1411	$self->stoptls;	1473	&_freetls;
1412		1474
1413	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1475	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1414		1476
1415	if ($linger && length $self->{wbuf}) {	1477	if ($linger && length $self->{wbuf}) {
1416	my $fh = delete $self->{fh};	1478	my $fh = delete $self->{fh};
…		…
1431	@linger = ();	1493	@linger = ();
1432	});	1494	});
1433	}	1495	}
1434	}	1496	}
1435		1497
		1498	=item $handle->destroy
		1499
		1500	Shuts down the handle object as much as possible - this call ensures that
		1501	no further callbacks will be invoked and resources will be freed as much
		1502	as possible. You must not call any methods on the object afterwards.
		1503
		1504	Normally, you can just "forget" any references to an AnyEvent::Handle
		1505	object and it will simply shut down. This works in fatal error and EOF
		1506	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1507	callback, so when you want to destroy the AnyEvent::Handle object from
		1508	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1509	that case.
		1510
		1511	The handle might still linger in the background and write out remaining
		1512	data, as specified by the C<linger> option, however.
		1513
		1514	=cut
		1515
		1516	sub destroy {
		1517	my ($self) = @_;
		1518
		1519	$self->DESTROY;
		1520	%$self = ();
		1521	}
		1522
1436	=item AnyEvent::Handle::TLS_CTX	1523	=item AnyEvent::Handle::TLS_CTX
1437		1524
1438	This function creates and returns the Net::SSLeay::CTX object used by	1525	This function creates and returns the Net::SSLeay::CTX object used by
1439	default for TLS mode.	1526	default for TLS mode.
1440		1527
…		…
1468	}	1555	}
1469	}	1556	}
1470		1557
1471	=back	1558	=back
1472		1559
		1560
		1561	=head1 NONFREQUENTLY ASKED QUESTIONS
		1562
		1563	=over 4
		1564
		1565	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1566	still get further invocations!
		1567
		1568	That's because AnyEvent::Handle keeps a reference to itself when handling
		1569	read or write callbacks.
		1570
		1571	It is only safe to "forget" the reference inside EOF or error callbacks,
		1572	from within all other callbacks, you need to explicitly call the C<<
		1573	->destroy >> method.
		1574
		1575	=item I get different callback invocations in TLS mode/Why can't I pause
		1576	reading?
		1577
		1578	Unlike, say, TCP, TLS connections do not consist of two independent
		1579	communication channels, one for each direction. Or put differently. The
		1580	read and write directions are not independent of each other: you cannot
		1581	write data unless you are also prepared to read, and vice versa.
		1582
		1583	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1584	callback invocations when you are not expecting any read data - the reason
		1585	is that AnyEvent::Handle always reads in TLS mode.
		1586
		1587	During the connection, you have to make sure that you always have a
		1588	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1589	connection (or when you no longer want to use it) you can call the
		1590	C<destroy> method.
		1591
		1592	=item How do I read data until the other side closes the connection?
		1593
		1594	If you just want to read your data into a perl scalar, the easiest way
		1595	to achieve this is by setting an C<on_read> callback that does nothing,
		1596	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1597	will be in C<$_[0]{rbuf}>:
		1598
		1599	$handle->on_read (sub { });
		1600	$handle->on_eof (undef);
		1601	$handle->on_error (sub {
		1602	my $data = delete $_[0]{rbuf};
		1603	undef $handle;
		1604	});
		1605
		1606	The reason to use C<on_error> is that TCP connections, due to latencies
		1607	and packets loss, might get closed quite violently with an error, when in
		1608	fact, all data has been received.
		1609
		1610	It is usually better to use acknowledgements when transferring data,
		1611	to make sure the other side hasn't just died and you got the data
		1612	intact. This is also one reason why so many internet protocols have an
		1613	explicit QUIT command.
		1614
		1615	=item I don't want to destroy the handle too early - how do I wait until
		1616	all data has been written?
		1617
		1618	After writing your last bits of data, set the C<on_drain> callback
		1619	and destroy the handle in there - with the default setting of
		1620	C<low_water_mark> this will be called precisely when all data has been
		1621	written to the socket:
		1622
		1623	$handle->push_write (...);
		1624	$handle->on_drain (sub {
		1625	warn "all data submitted to the kernel\n";
		1626	undef $handle;
		1627	});
		1628
		1629	=back
		1630
		1631
1473	=head1 SUBCLASSING AnyEvent::Handle	1632	=head1 SUBCLASSING AnyEvent::Handle
1474		1633
1475	In many cases, you might want to subclass AnyEvent::Handle.	1634	In many cases, you might want to subclass AnyEvent::Handle.
1476		1635
1477	To make this easier, a given version of AnyEvent::Handle uses these	1636	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.84 by root, Thu Aug 21 19:13:05 2008 UTC vs. Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC