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

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

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.85 by root, Thu Aug 21 19:53:19 2008 UTC vs.
Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC