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