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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC vs.
Revision 1.113 by root, Wed Jan 21 06:02:21 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");
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	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,
81	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
82	connection cleanly.	86	connection cleanly.
83		87
84	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,
85	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
86	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
87	down.	91	down.
88		92
89	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,
90	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
91	waiting for data.	95	waiting for data.
92		96
93	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
94	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>.
…		…
99	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
100	connect or a read error.	104	connect or a read error.
101		105
102	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
103	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
104	(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
105	errors are an EOF condition with active (but unsatisifable) read watchers	109	errors are an EOF condition with active (but unsatisifable) read watchers
106	(C<EPIPE>) or I/O errors.	110	(C<EPIPE>) or I/O errors.
107		111
108	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
109	to simply ignore this parameter and instead abondon the handle object	113	to simply ignore this parameter and instead abondon the handle object
…		…
148	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
149		153
150	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
151	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
152	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
153	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
154		158
155	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
156	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
157	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
158	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
159		164
160	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
161		166
162	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
163		168
…		…
167		172
168	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
169		174
170	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>)
171	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
172	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
173		178
174	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
175	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
176	(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
177	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
178	isn't finished).	183	isn't finished).
179		184
180	=item autocork => <boolean>	185	=item autocork => <boolean>
181		186
182	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
183	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
184	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
185	inefficient if you write multiple small chunks (this disadvantage is	190	be inefficient if you write multiple small chunks (on the wire, this
186	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).
187		193
188	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
189	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,
190	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.
191		198
192	=item no_delay => <boolean>	199	=item no_delay => <boolean>
193		200
194	When doing small writes on sockets, your operating system kernel might	201	When doing small writes on sockets, your operating system kernel might
195	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
196	the Nagle algorithm, and usually it is beneficial.	203	the Nagle algorithm, and usually it is beneficial.
197		204
198	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
199	accomplishd by setting this option to true.	206	accomplishd by setting this option to a true value.
200		207
201	The default is your opertaing system's default behaviour, this option	208	The default is your opertaing system's default behaviour (most likely
202	explicitly enables or disables it, if possible.	209	enabled), this option explicitly enables or disables it, if possible.
203		210
204	=item read_size => <bytes>	211	=item read_size => <bytes>
205		212
206	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
207	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
208		216
209	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
210		218
211	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
212	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
213	considered empty.	221	considered empty.
214		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
215	=item linger => <seconds>	228	=item linger => <seconds>
216		229
217	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
218	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
219	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
220	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
221	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
222		235
223	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
224	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
225		239
226	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
227		241
228	When this parameter is given, it enables TLS (SSL) mode, that means it	242	When this parameter is given, it enables TLS (SSL) mode, that means
229	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
230	data.	244	established and will transparently encrypt/decrypt data afterwards.
231		245
232	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
233	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.
234		250
235	For the TLS server side, use C<accept>, and for the TLS client side of a	251	Unlike TCP, TLS has a server and client side: for the TLS server side, use
236	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
237		254
238	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
239	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>
240	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
241	AnyEvent::Handle.	258	AnyEvent::Handle.
242		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
243	See the C<starttls> method if you need to start TLS negotiation later.	265	See the C<< ->starttls >> method for when need to start TLS negotiation later.
244		266
245	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
246		268
247	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
248	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
249	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
250		272
251	=item json => JSON or JSON::XS object	273	=item json => JSON or JSON::XS object
252		274
253	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.
254		276
255	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
256	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.
257		280
258	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
259	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
260		283
261	=item filter_r => $cb
262
263	=item filter_w => $cb
264
265	These exist, but are undocumented at this time.
266
267	=back	284	=back
268		285
269	=cut	286	=cut
270		287
271	sub new {	288	sub new {
…		…
275		292
276	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
277		294
278	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
279		296
280	if ($self->{tls}) {
281	require Net::SSLeay;
282	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
283	}	298	if $self->{tls};
284		299
285	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
286	$self->_timeout;	301	$self->_timeout;
287		302
288	$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};
…		…
300	delete $self->{_tw};	315	delete $self->{_tw};
301	delete $self->{_rw};	316	delete $self->{_rw};
302	delete $self->{_ww};	317	delete $self->{_ww};
303	delete $self->{fh};	318	delete $self->{fh};
304		319
305	$self->stoptls;	320	&_freetls;
306		321
307	delete $self->{on_read};	322	delete $self->{on_read};
308	delete $self->{_queue};	323	delete $self->{_queue};
309	}	324	}
310		325
…		…
316		331
317	$! = $errno;	332	$! = $errno;
318		333
319	if ($self->{on_error}) {	334	if ($self->{on_error}) {
320	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
321	} else {	336	} elsif ($self->{fh}) {
322	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
323	}	338	}
324	}	339	}
325		340
326	=item $fh = $handle->fh	341	=item $fh = $handle->fh
327		342
328	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.
329		344
330	=cut	345	=cut
331		346
332	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
333		348
…		…
351	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
352	}	367	}
353		368
354	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
355		370
356	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
357	(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
358	argument.	373	argument and method.
359		374
360	=cut	375	=cut
361		376
362	sub on_timeout {	377	sub on_timeout {
363	$_[0]{on_timeout} = $_[1];	378	$_[0]{on_timeout} = $_[1];
364	}	379	}
365		380
366	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
367		382
368	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
369	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
370		385
371	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
372		391
373	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
374		393
375	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
376	the same name for details).	395	the same name for details).
…		…
469	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
470		489
471	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
472		491
473	$cb->($self)	492	$cb->($self)
474	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
475	}	494	}
476		495
477	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
478		497
479	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
…		…
496	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
497		516
498	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
499		518
500	$self->{on_drain}($self)	519	$self->{on_drain}($self)
501	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
502	&& $self->{on_drain};	521	&& $self->{on_drain};
503		522
504	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
505	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
506	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
530		549
531	@_ = ($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")
532	->($self, @_);	551	->($self, @_);
533	}	552	}
534		553
535	if ($self->{filter_w}) {	554	if ($self->{tls}) {
536	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
537	} else {	558	} else {
538	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
539	$self->_drain_wbuf;	560	$self->_drain_wbuf;
540	}	561	}
541	}	562	}
…		…
558	=cut	579	=cut
559		580
560	register_write_type netstring => sub {	581	register_write_type netstring => sub {
561	my ($self, $string) = @_;	582	my ($self, $string) = @_;
562		583
563	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
564	};	585	};
565		586
566	=item packstring => $format, $data	587	=item packstring => $format, $data
567		588
568	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>
…		…
777		798
778	last; # more data might arrive	799	last; # more data might arrive
779	}	800	}
780	} else {	801	} else {
781	# read side becomes idle	802	# read side becomes idle
782	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
783	last;	804	last;
784	}	805	}
785	}	806	}
786		807
787	if ($self->{_eof}) {	808	if ($self->{_eof}) {
…		…
1082	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>
1083	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
1084	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1085	optional C<!>, C<< < >> or C<< > >> modifier).	1106	optional C<!>, C<< < >> or C<< > >> modifier).
1086		1107
1087	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).
1088		1110
1089	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
1090	format (very efficient).	1112	format (very efficient).
1091		1113
1092	$handle->push_read (packstring => "w", sub {	1114	$handle->push_read (packstring => "w", sub {
…		…
1122	}	1144	}
1123	};	1145	};
1124		1146
1125	=item json => $cb->($handle, $hash_or_arrayref)	1147	=item json => $cb->($handle, $hash_or_arrayref)
1126		1148
1127	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.
1128		1151
1129	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
1130	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.
1131		1154
1132	This read type uses the incremental parser available with JSON version	1155	This read type uses the incremental parser available with JSON version
…		…
1149	my $rbuf = \$self->{rbuf};	1172	my $rbuf = \$self->{rbuf};
1150		1173
1151	my $json = $self->{json} \|\|= JSON->new->utf8;	1174	my $json = $self->{json} \|\|= JSON->new->utf8;
1152		1175
1153	sub {	1176	sub {
1154	my $ref = $json->incr_parse ($self->{rbuf});	1177	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1155		1178
1156	if ($ref) {	1179	if ($ref) {
1157	$self->{rbuf} = $json->incr_text;	1180	$self->{rbuf} = $json->incr_text;
1158	$json->incr_text = "";	1181	$json->incr_text = "";
1159	$cb->($self, $ref);	1182	$cb->($self, $ref);
1160		1183
1161	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
1162	} else {	1195	} else {
1163	$self->{rbuf} = "";	1196	$self->{rbuf} = "";
1164	()	1197	()
1165	}	1198	}
1166	}	1199	}
…		…
1245	Note that AnyEvent::Handle will automatically C<start_read> for you when	1278	Note that AnyEvent::Handle will automatically C<start_read> for you when
1246	you change the C<on_read> callback or push/unshift a read callback, and it	1279	you change the C<on_read> callback or push/unshift a read callback, and it
1247	will automatically C<stop_read> for you when neither C<on_read> is set nor	1280	will automatically C<stop_read> for you when neither C<on_read> is set nor
1248	there are any read requests in the queue.	1281	there are any read requests in the queue.
1249		1282
		1283	These methods will have no effect when in TLS mode (as TLS doesn't support
		1284	half-duplex connections).
		1285
1250	=cut	1286	=cut
1251		1287
1252	sub stop_read {	1288	sub stop_read {
1253	my ($self) = @_;	1289	my ($self) = @_;
1254		1290
1255	delete $self->{_rw};	1291	delete $self->{_rw} unless $self->{tls};
1256	}	1292	}
1257		1293
1258	sub start_read {	1294	sub start_read {
1259	my ($self) = @_;	1295	my ($self) = @_;
1260		1296
1261	unless ($self->{_rw} \|\| $self->{_eof}) {	1297	unless ($self->{_rw} \|\| $self->{_eof}) {
1262	Scalar::Util::weaken $self;	1298	Scalar::Util::weaken $self;
1263		1299
1264	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1300	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1265	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1301	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1266	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1302	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1267		1303
1268	if ($len > 0) {	1304	if ($len > 0) {
1269	$self->{_activity} = AnyEvent->now;	1305	$self->{_activity} = AnyEvent->now;
1270		1306
1271	$self->{filter_r}	1307	if ($self->{tls}) {
1272	? $self->{filter_r}($self, $rbuf)	1308	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1273	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1309
		1310	&_dotls ($self);
		1311	} else {
		1312	$self->_drain_rbuf unless $self->{_in_drain};
		1313	}
1274		1314
1275	} elsif (defined $len) {	1315	} elsif (defined $len) {
1276	delete $self->{_rw};	1316	delete $self->{_rw};
1277	$self->{_eof} = 1;	1317	$self->{_eof} = 1;
1278	$self->_drain_rbuf unless $self->{_in_drain};	1318	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1282	}	1322	}
1283	});	1323	});
1284	}	1324	}
1285	}	1325	}
1286		1326
		1327	# poll the write BIO and send the data if applicable
1287	sub _dotls {	1328	sub _dotls {
1288	my ($self) = @_;	1329	my ($self) = @_;
1289		1330
1290	my $buf;	1331	my $tmp;
1291		1332
1292	if (length $self->{_tls_wbuf}) {	1333	if (length $self->{_tls_wbuf}) {
1293	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1334	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1294	substr $self->{_tls_wbuf}, 0, $len, "";	1335	substr $self->{_tls_wbuf}, 0, $tmp, "";
1295	}	1336	}
1296	}	1337	}
1297		1338
1298	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1299	$self->{wbuf} .= $buf;
1300	$self->_drain_wbuf;
1301	}
1302
1303	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1339	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1304	if (length $buf) {	1340	unless (length $tmp) {
1305	$self->{rbuf} .= $buf;
1306	$self->_drain_rbuf unless $self->{_in_drain};
1307	} else {
1308	# let's treat SSL-eof as we treat normal EOF	1341	# let's treat SSL-eof as we treat normal EOF
		1342	delete $self->{_rw};
1309	$self->{_eof} = 1;	1343	$self->{_eof} = 1;
1310	$self->_shutdown;	1344	&_freetls;
1311	return;
1312	}	1345	}
1313	}
1314		1346
		1347	$self->{rbuf} .= $tmp;
		1348	$self->_drain_rbuf unless $self->{_in_drain};
		1349	$self->{tls} or return; # tls session might have gone away in callback
		1350	}
		1351
1315	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1352	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1316		1353
1317	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1354	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1318	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1355	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1319	return $self->_error ($!, 1);	1356	return $self->_error ($!, 1);
1320	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1357	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1321	return $self->_error (&Errno::EIO, 1);	1358	return $self->_error (&Errno::EIO, 1);
1322	}	1359	}
1323		1360
1324	# all others are fine for our purposes	1361	# all other errors are fine for our purposes
		1362	}
		1363
		1364	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1365	$self->{wbuf} .= $tmp;
		1366	$self->_drain_wbuf;
1325	}	1367	}
1326	}	1368	}
1327		1369
1328	=item $handle->starttls ($tls[, $tls_ctx])	1370	=item $handle->starttls ($tls[, $tls_ctx])
1329		1371
…		…
1339		1381
1340	The TLS connection object will end up in C<< $handle->{tls} >> after this	1382	The TLS connection object will end up in C<< $handle->{tls} >> after this
1341	call and can be used or changed to your liking. Note that the handshake	1383	call and can be used or changed to your liking. Note that the handshake
1342	might have already started when this function returns.	1384	might have already started when this function returns.
1343		1385
		1386	If it an error to start a TLS handshake more than once per
		1387	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1388
1344	=cut	1389	=cut
1345		1390
1346	sub starttls {	1391	sub starttls {
1347	my ($self, $ssl, $ctx) = @_;	1392	my ($self, $ssl, $ctx) = @_;
1348		1393
1349	$self->stoptls;	1394	require Net::SSLeay;
1350		1395
		1396	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1397	if $self->{tls};
		1398
1351	if ($ssl eq "accept") {	1399	if ($ssl eq "accept") {
1352	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1400	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1353	Net::SSLeay::set_accept_state ($ssl);	1401	Net::SSLeay::set_accept_state ($ssl);
1354	} elsif ($ssl eq "connect") {	1402	} elsif ($ssl eq "connect") {
1355	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1403	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1361	# basically, this is deep magic (because SSL_read should have the same issues)	1409	# basically, this is deep magic (because SSL_read should have the same issues)
1362	# but the openssl maintainers basically said: "trust us, it just works".	1410	# but the openssl maintainers basically said: "trust us, it just works".
1363	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1411	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1364	# and mismaintained ssleay-module doesn't even offer them).	1412	# and mismaintained ssleay-module doesn't even offer them).
1365	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1413	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1414	#
		1415	# in short: this is a mess.
		1416	#
		1417	# note that we do not try to keep the length constant between writes as we are required to do.
		1418	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1419	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1420	# have identity issues in that area.
1366	Net::SSLeay::CTX_set_mode ($self->{tls},	1421	Net::SSLeay::CTX_set_mode ($self->{tls},
1367	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1422	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1368	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1423	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1369		1424
1370	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1425	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1371	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1426	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1372		1427
1373	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1428	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1374		1429
1375	$self->{filter_w} = sub {	1430	&_dotls; # need to trigger the initial handshake
1376	$_[0]{_tls_wbuf} .= ${$_[1]};	1431	$self->start_read; # make sure we actually do read
1377	&_dotls;
1378	};
1379	$self->{filter_r} = sub {
1380	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1381	&_dotls;
1382	};
1383	}	1432	}
1384		1433
1385	=item $handle->stoptls	1434	=item $handle->stoptls
1386		1435
1387	Destroys the SSL connection, if any. Partial read or write data will be	1436	Shuts down the SSL connection - this makes a proper EOF handshake by
1388	lost.	1437	sending a close notify to the other side, but since OpenSSL doesn't
		1438	support non-blocking shut downs, it is not possible to re-use the stream
		1439	afterwards.
1389		1440
1390	=cut	1441	=cut
1391		1442
1392	sub stoptls {	1443	sub stoptls {
1393	my ($self) = @_;	1444	my ($self) = @_;
1394		1445
		1446	if ($self->{tls}) {
		1447	Net::SSLeay::shutdown ($self->{tls});
		1448
		1449	&_dotls;
		1450
		1451	# we don't give a shit. no, we do, but we can't. no...
		1452	# we, we... have to use openssl :/
		1453	&_freetls;
		1454	}
		1455	}
		1456
		1457	sub _freetls {
		1458	my ($self) = @_;
		1459
		1460	return unless $self->{tls};
		1461
1395	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1462	Net::SSLeay::free (delete $self->{tls});
1396		1463
1397	delete $self->{_rbio};	1464	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1398	delete $self->{_wbio};
1399	delete $self->{_tls_wbuf};
1400	delete $self->{filter_r};
1401	delete $self->{filter_w};
1402	}	1465	}
1403		1466
1404	sub DESTROY {	1467	sub DESTROY {
1405	my $self = shift;	1468	my $self = shift;
1406		1469
1407	$self->stoptls;	1470	&_freetls;
1408		1471
1409	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1472	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1410		1473
1411	if ($linger && length $self->{wbuf}) {	1474	if ($linger && length $self->{wbuf}) {
1412	my $fh = delete $self->{fh};	1475	my $fh = delete $self->{fh};
…		…
1427	@linger = ();	1490	@linger = ();
1428	});	1491	});
1429	}	1492	}
1430	}	1493	}
1431		1494
		1495	=item $handle->destroy
		1496
		1497	Shuts down the handle object as much as possible - this call ensures that
		1498	no further callbacks will be invoked and resources will be freed as much
		1499	as possible. You must not call any methods on the object afterwards.
		1500
		1501	Normally, you can just "forget" any references to an AnyEvent::Handle
		1502	object and it will simply shut down. This works in fatal error and EOF
		1503	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1504	callback, so when you want to destroy the AnyEvent::Handle object from
		1505	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1506	that case.
		1507
		1508	The handle might still linger in the background and write out remaining
		1509	data, as specified by the C<linger> option, however.
		1510
		1511	=cut
		1512
		1513	sub destroy {
		1514	my ($self) = @_;
		1515
		1516	$self->DESTROY;
		1517	%$self = ();
		1518	}
		1519
1432	=item AnyEvent::Handle::TLS_CTX	1520	=item AnyEvent::Handle::TLS_CTX
1433		1521
1434	This function creates and returns the Net::SSLeay::CTX object used by	1522	This function creates and returns the Net::SSLeay::CTX object used by
1435	default for TLS mode.	1523	default for TLS mode.
1436		1524
…		…
1464	}	1552	}
1465	}	1553	}
1466		1554
1467	=back	1555	=back
1468		1556
		1557
		1558	=head1 NONFREQUENTLY ASKED QUESTIONS
		1559
		1560	=over 4
		1561
		1562	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1563	still get further invocations!
		1564
		1565	That's because AnyEvent::Handle keeps a reference to itself when handling
		1566	read or write callbacks.
		1567
		1568	It is only safe to "forget" the reference inside EOF or error callbacks,
		1569	from within all other callbacks, you need to explicitly call the C<<
		1570	->destroy >> method.
		1571
		1572	=item I get different callback invocations in TLS mode/Why can't I pause
		1573	reading?
		1574
		1575	Unlike, say, TCP, TLS connections do not consist of two independent
		1576	communication channels, one for each direction. Or put differently. The
		1577	read and write directions are not independent of each other: you cannot
		1578	write data unless you are also prepared to read, and vice versa.
		1579
		1580	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1581	callback invocations when you are not expecting any read data - the reason
		1582	is that AnyEvent::Handle always reads in TLS mode.
		1583
		1584	During the connection, you have to make sure that you always have a
		1585	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1586	connection (or when you no longer want to use it) you can call the
		1587	C<destroy> method.
		1588
		1589	=item How do I read data until the other side closes the connection?
		1590
		1591	If you just want to read your data into a perl scalar, the easiest way
		1592	to achieve this is by setting an C<on_read> callback that does nothing,
		1593	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1594	will be in C<$_[0]{rbuf}>:
		1595
		1596	$handle->on_read (sub { });
		1597	$handle->on_eof (undef);
		1598	$handle->on_error (sub {
		1599	my $data = delete $_[0]{rbuf};
		1600	undef $handle;
		1601	});
		1602
		1603	The reason to use C<on_error> is that TCP connections, due to latencies
		1604	and packets loss, might get closed quite violently with an error, when in
		1605	fact, all data has been received.
		1606
		1607	It is usually better to use acknowledgements when transferring data,
		1608	to make sure the other side hasn't just died and you got the data
		1609	intact. This is also one reason why so many internet protocols have an
		1610	explicit QUIT command.
		1611
		1612	=item I don't want to destroy the handle too early - how do I wait until
		1613	all data has been written?
		1614
		1615	After writing your last bits of data, set the C<on_drain> callback
		1616	and destroy the handle in there - with the default setting of
		1617	C<low_water_mark> this will be called precisely when all data has been
		1618	written to the socket:
		1619
		1620	$handle->push_write (...);
		1621	$handle->on_drain (sub {
		1622	warn "all data submitted to the kernel\n";
		1623	undef $handle;
		1624	});
		1625
		1626	=back
		1627
		1628
1469	=head1 SUBCLASSING AnyEvent::Handle	1629	=head1 SUBCLASSING AnyEvent::Handle
1470		1630
1471	In many cases, you might want to subclass AnyEvent::Handle.	1631	In many cases, you might want to subclass AnyEvent::Handle.
1472		1632
1473	To make this easier, a given version of AnyEvent::Handle uses these	1633	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.82 by root, Thu Aug 21 18:45:16 2008 UTC vs. Revision 1.113 by root, Wed Jan 21 06:02:21 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC vs.
Revision 1.113 by root, Wed Jan 21 06:02:21 2009 UTC