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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC vs.
Revision 1.111 by root, Wed Jan 21 06:01:29 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. (They are used internally
272	by the TLS code).
273
274	=back	284	=back
275		285
276	=cut	286	=cut
277		287
278	sub new {	288	sub new {
…		…
282		292
283	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
284		294
285	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
286		296
287	if ($self->{tls}) {
288	require Net::SSLeay;
289	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
290	}	298	if $self->{tls};
291		299
292	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
293	$self->_timeout;	301	$self->_timeout;
294		302
295	$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};
…		…
307	delete $self->{_tw};	315	delete $self->{_tw};
308	delete $self->{_rw};	316	delete $self->{_rw};
309	delete $self->{_ww};	317	delete $self->{_ww};
310	delete $self->{fh};	318	delete $self->{fh};
311		319
312	$self->stoptls;	320	&_freetls;
313		321
314	delete $self->{on_read};	322	delete $self->{on_read};
315	delete $self->{_queue};	323	delete $self->{_queue};
316	}	324	}
317		325
…		…
323		331
324	$! = $errno;	332	$! = $errno;
325		333
326	if ($self->{on_error}) {	334	if ($self->{on_error}) {
327	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
328	} else {	336	} elsif ($self->{fh}) {
329	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
330	}	338	}
331	}	339	}
332		340
333	=item $fh = $handle->fh	341	=item $fh = $handle->fh
334		342
335	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.
336		344
337	=cut	345	=cut
338		346
339	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
340		348
…		…
358	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
359	}	367	}
360		368
361	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
362		370
363	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
364	(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
365	argument.	373	argument and method.
366		374
367	=cut	375	=cut
368		376
369	sub on_timeout {	377	sub on_timeout {
370	$_[0]{on_timeout} = $_[1];	378	$_[0]{on_timeout} = $_[1];
371	}	379	}
372		380
373	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
374		382
375	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
376	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
377		385
378	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
379		391
380	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
381		393
382	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
383	the same name for details).	395	the same name for details).
…		…
476	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
477		489
478	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
479		491
480	$cb->($self)	492	$cb->($self)
481	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
482	}	494	}
483		495
484	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
485		497
486	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
…		…
503	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
504		516
505	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
506		518
507	$self->{on_drain}($self)	519	$self->{on_drain}($self)
508	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
509	&& $self->{on_drain};	521	&& $self->{on_drain};
510		522
511	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
512	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
513	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
537		549
538	@_ = ($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")
539	->($self, @_);	551	->($self, @_);
540	}	552	}
541		553
542	if ($self->{filter_w}) {	554	if ($self->{tls}) {
543	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
544	} else {	558	} else {
545	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
546	$self->_drain_wbuf;	560	$self->_drain_wbuf;
547	}	561	}
548	}	562	}
…		…
565	=cut	579	=cut
566		580
567	register_write_type netstring => sub {	581	register_write_type netstring => sub {
568	my ($self, $string) = @_;	582	my ($self, $string) = @_;
569		583
570	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
571	};	585	};
572		586
573	=item packstring => $format, $data	587	=item packstring => $format, $data
574		588
575	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>
…		…
784		798
785	last; # more data might arrive	799	last; # more data might arrive
786	}	800	}
787	} else {	801	} else {
788	# read side becomes idle	802	# read side becomes idle
789	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
790	last;	804	last;
791	}	805	}
792	}	806	}
793		807
794	if ($self->{_eof}) {	808	if ($self->{_eof}) {
…		…
1089	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>
1090	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
1091	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1092	optional C<!>, C<< < >> or C<< > >> modifier).	1106	optional C<!>, C<< < >> or C<< > >> modifier).
1093		1107
1094	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).
1095		1110
1096	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
1097	format (very efficient).	1112	format (very efficient).
1098		1113
1099	$handle->push_read (packstring => "w", sub {	1114	$handle->push_read (packstring => "w", sub {
…		…
1129	}	1144	}
1130	};	1145	};
1131		1146
1132	=item json => $cb->($handle, $hash_or_arrayref)	1147	=item json => $cb->($handle, $hash_or_arrayref)
1133		1148
1134	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.
1135		1151
1136	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
1137	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.
1138		1154
1139	This read type uses the incremental parser available with JSON version	1155	This read type uses the incremental parser available with JSON version
…		…
1156	my $rbuf = \$self->{rbuf};	1172	my $rbuf = \$self->{rbuf};
1157		1173
1158	my $json = $self->{json} \|\|= JSON->new->utf8;	1174	my $json = $self->{json} \|\|= JSON->new->utf8;
1159		1175
1160	sub {	1176	sub {
		1177	eval {
1161	my $ref = $json->incr_parse ($self->{rbuf});	1178	my $ref = $json->incr_parse ($self->{rbuf});
1162		1179
1163	if ($ref) {	1180	if ($ref) {
		1181	$self->{rbuf} = $json->incr_text;
		1182	$json->incr_text = "";
		1183	$cb->($self, $ref);
		1184
		1185	1
		1186	} else {
		1187	$self->{rbuf} = "";
		1188	()
		1189	}
		1190
		1191	1
		1192	} or do {
		1193	# error case
		1194	$json->incr_skip;
		1195
1164	$self->{rbuf} = $json->incr_text;	1196	$self->{rbuf} = $json->incr_text;
1165	$json->incr_text = "";	1197	$json->incr_text = "";
1166	$cb->($self, $ref);
1167		1198
1168	1	1199	$self->_error (&Errno::EBADMSG);
1169	} else {
1170	$self->{rbuf} = "";
1171	()
1172	}	1200	};
		1201
1173	}	1202	}
1174	};	1203	};
1175		1204
1176	=item storable => $cb->($handle, $ref)	1205	=item storable => $cb->($handle, $ref)
1177		1206
…		…
1252	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
1253	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
1254	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
1255	there are any read requests in the queue.	1284	there are any read requests in the queue.
1256		1285
		1286	These methods will have no effect when in TLS mode (as TLS doesn't support
		1287	half-duplex connections).
		1288
1257	=cut	1289	=cut
1258		1290
1259	sub stop_read {	1291	sub stop_read {
1260	my ($self) = @_;	1292	my ($self) = @_;
1261		1293
1262	delete $self->{_rw};	1294	delete $self->{_rw} unless $self->{tls};
1263	}	1295	}
1264		1296
1265	sub start_read {	1297	sub start_read {
1266	my ($self) = @_;	1298	my ($self) = @_;
1267		1299
1268	unless ($self->{_rw} \|\| $self->{_eof}) {	1300	unless ($self->{_rw} \|\| $self->{_eof}) {
1269	Scalar::Util::weaken $self;	1301	Scalar::Util::weaken $self;
1270		1302
1271	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1303	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1272	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1304	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1273	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;
1274		1306
1275	if ($len > 0) {	1307	if ($len > 0) {
1276	$self->{_activity} = AnyEvent->now;	1308	$self->{_activity} = AnyEvent->now;
1277		1309
1278	$self->{filter_r}	1310	if ($self->{tls}) {
1279	? $self->{filter_r}($self, $rbuf)	1311	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1280	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1312
		1313	&_dotls ($self);
		1314	} else {
		1315	$self->_drain_rbuf unless $self->{_in_drain};
		1316	}
1281		1317
1282	} elsif (defined $len) {	1318	} elsif (defined $len) {
1283	delete $self->{_rw};	1319	delete $self->{_rw};
1284	$self->{_eof} = 1;	1320	$self->{_eof} = 1;
1285	$self->_drain_rbuf unless $self->{_in_drain};	1321	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1289	}	1325	}
1290	});	1326	});
1291	}	1327	}
1292	}	1328	}
1293		1329
		1330	# poll the write BIO and send the data if applicable
1294	sub _dotls {	1331	sub _dotls {
1295	my ($self) = @_;	1332	my ($self) = @_;
1296		1333
1297	my $buf;	1334	my $tmp;
1298		1335
1299	if (length $self->{_tls_wbuf}) {	1336	if (length $self->{_tls_wbuf}) {
1300	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1337	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1301	substr $self->{_tls_wbuf}, 0, $len, "";	1338	substr $self->{_tls_wbuf}, 0, $tmp, "";
1302	}	1339	}
1303	}	1340	}
1304		1341
1305	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1306	$self->{wbuf} .= $buf;
1307	$self->_drain_wbuf;
1308	}
1309
1310	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1342	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1311	if (length $buf) {	1343	unless (length $tmp) {
1312	$self->{rbuf} .= $buf;
1313	$self->_drain_rbuf unless $self->{_in_drain};
1314	} else {
1315	# 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};
1316	$self->{_eof} = 1;	1346	$self->{_eof} = 1;
1317	$self->_shutdown;	1347	&_freetls;
1318	return;
1319	}	1348	}
1320	}
1321		1349
		1350	$self->{rbuf} .= $tmp;
		1351	$self->_drain_rbuf unless $self->{_in_drain};
		1352	$self->{tls} or return; # tls session might have gone away in callback
		1353	}
		1354
1322	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1355	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1323		1356
1324	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1357	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1325	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1358	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1326	return $self->_error ($!, 1);	1359	return $self->_error ($!, 1);
1327	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1360	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1328	return $self->_error (&Errno::EIO, 1);	1361	return $self->_error (&Errno::EIO, 1);
1329	}	1362	}
1330		1363
1331	# 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;
1332	}	1370	}
1333	}	1371	}
1334		1372
1335	=item $handle->starttls ($tls[, $tls_ctx])	1373	=item $handle->starttls ($tls[, $tls_ctx])
1336		1374
…		…
1346		1384
1347	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
1348	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
1349	might have already started when this function returns.	1387	might have already started when this function returns.
1350		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
1351	=cut	1392	=cut
1352		1393
1353	sub starttls {	1394	sub starttls {
1354	my ($self, $ssl, $ctx) = @_;	1395	my ($self, $ssl, $ctx) = @_;
1355		1396
1356	$self->stoptls;	1397	require Net::SSLeay;
1357		1398
		1399	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1400	if $self->{tls};
		1401
1358	if ($ssl eq "accept") {	1402	if ($ssl eq "accept") {
1359	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1403	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1360	Net::SSLeay::set_accept_state ($ssl);	1404	Net::SSLeay::set_accept_state ($ssl);
1361	} elsif ($ssl eq "connect") {	1405	} elsif ($ssl eq "connect") {
1362	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1406	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1371	# and mismaintained ssleay-module doesn't even offer them).	1415	# and mismaintained ssleay-module doesn't even offer them).
1372	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1416	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1373	#	1417	#
1374	# in short: this is a mess.	1418	# in short: this is a mess.
1375	#	1419	#
1376	# note that we do not try to kepe the length constant between writes as we are required to do.	1420	# note that we do not try to keep the length constant between writes as we are required to do.
1377	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1421	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1378	# and we drive openssl fully in blocking mode here.	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.
1379	Net::SSLeay::CTX_set_mode ($self->{tls},	1424	Net::SSLeay::CTX_set_mode ($self->{tls},
1380	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1425	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1381	\| (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));
1382		1427
1383	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1384	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1385		1430
1386	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1431	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1387		1432
1388	$self->{filter_w} = sub {	1433	&_dotls; # need to trigger the initial handshake
1389	$_[0]{_tls_wbuf} .= ${$_[1]};	1434	$self->start_read; # make sure we actually do read
1390	&_dotls;
1391	};
1392	$self->{filter_r} = sub {
1393	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1394	&_dotls;
1395	};
1396	}	1435	}
1397		1436
1398	=item $handle->stoptls	1437	=item $handle->stoptls
1399		1438
1400	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
1401	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.
1402		1443
1403	=cut	1444	=cut
1404		1445
1405	sub stoptls {	1446	sub stoptls {
1406	my ($self) = @_;	1447	my ($self) = @_;
1407		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
1408	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1465	Net::SSLeay::free (delete $self->{tls});
1409		1466
1410	delete $self->{_rbio};	1467	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1411	delete $self->{_wbio};
1412	delete $self->{_tls_wbuf};
1413	delete $self->{filter_r};
1414	delete $self->{filter_w};
1415	}	1468	}
1416		1469
1417	sub DESTROY {	1470	sub DESTROY {
1418	my $self = shift;	1471	my $self = shift;
1419		1472
1420	$self->stoptls;	1473	&_freetls;
1421		1474
1422	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1475	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1423		1476
1424	if ($linger && length $self->{wbuf}) {	1477	if ($linger && length $self->{wbuf}) {
1425	my $fh = delete $self->{fh};	1478	my $fh = delete $self->{fh};
…		…
1440	@linger = ();	1493	@linger = ();
1441	});	1494	});
1442	}	1495	}
1443	}	1496	}
1444		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
1445	=item AnyEvent::Handle::TLS_CTX	1523	=item AnyEvent::Handle::TLS_CTX
1446		1524
1447	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
1448	default for TLS mode.	1526	default for TLS mode.
1449		1527
…		…
1477	}	1555	}
1478	}	1556	}
1479		1557
1480	=back	1558	=back
1481		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
1482	=head1 SUBCLASSING AnyEvent::Handle	1632	=head1 SUBCLASSING AnyEvent::Handle
1483		1633
1484	In many cases, you might want to subclass AnyEvent::Handle.	1634	In many cases, you might want to subclass AnyEvent::Handle.
1485		1635
1486	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.87 by root, Thu Aug 21 20:52:39 2008 UTC vs. Revision 1.111 by root, Wed Jan 21 06:01:29 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC vs.
Revision 1.111 by root, Wed Jan 21 06:01:29 2009 UTC