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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.139 by root, Sun Jul 5 23:39:48 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.3;	19	our $VERSION = 4.452;
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");
…		…
59	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
60		60
61	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
62	argument.	62	argument.
63		63
64	=head2 SIGPIPE is not handled by this module
65
66	SIGPIPE is not handled by this module, so one of the practical
67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
68	'IGNORE'>). At least, this is highly recommend in a networked program: If
69	you use AnyEvent::Handle in a filter program (like sort), exiting on
70	SIGPIPE is probably the right thing to do.
71
72	=head1 METHODS	64	=head1 METHODS
73		65
74	=over 4	66	=over 4
75		67
76	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
77		69
78	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
79		71
80	=over 4	72	=over 4
81		73
82	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
83		75
…		…
92	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,
93	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
94	connection cleanly.	86	connection cleanly.
95		87
96	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,
97	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
98	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
99	down.	91	down.
100		92
101	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,
102	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
103	waiting for data.	95	waiting for data.
104		96
105	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
106	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>.
107		99
108	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal, $message)
109		101
110	This is the error callback, which is called when, well, some error	102	This is the error callback, which is called when, well, some error
111	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
112	connect or a read error.	104	connect or a read error.
113		105
…		…
115	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
116	(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
117	errors are an EOF condition with active (but unsatisifable) read watchers	109	errors are an EOF condition with active (but unsatisifable) read watchers
118	(C<EPIPE>) or I/O errors.	110	(C<EPIPE>) or I/O errors.
119		111
		112	AnyEvent::Handle tries to find an appropriate error code for you to check
		113	against, but in some cases (TLS errors), this does not work well. It is
		114	recommended to always output the C<$message> argument in human-readable
		115	error messages (it's usually the same as C<"$!">).
		116
120	Non-fatal errors can be retried by simply returning, but it is recommended	117	Non-fatal errors can be retried by simply returning, but it is recommended
121	to simply ignore this parameter and instead abondon the handle object	118	to simply ignore this parameter and instead abondon the handle object
122	when this callback is invoked. Examples of non-fatal errors are timeouts	119	when this callback is invoked. Examples of non-fatal errors are timeouts
123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
124		121
125	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		124	C<EPROTO>).
127		125
128	While not mandatory, it is I<highly> recommended to set this callback, as	126	While not mandatory, it is I<highly> recommended to set this callback, as
129	you will not be notified of errors otherwise. The default simply calls	127	you will not be notified of errors otherwise. The default simply calls
130	C<croak>.	128	C<croak>.
131		129
…		…
135	and no read request is in the queue (unlike read queue callbacks, this	133	and no read request is in the queue (unlike read queue callbacks, this
136	callback will only be called when at least one octet of data is in the	134	callback will only be called when at least one octet of data is in the
137	read buffer).	135	read buffer).
138		136
139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
140	method or access the C<$handle->{rbuf}> member directly.	138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		139	must not enlarge or modify the read buffer, you can only remove data at
		140	the beginning from it.
141		141
142	When an EOF condition is detected then AnyEvent::Handle will first try to	142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before	143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal	144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
240	write data and will install a watcher that will write this data to the	240	write data and will install a watcher that will write this data to the
241	socket. No errors will be reported (this mostly matches how the operating	241	socket. No errors will be reported (this mostly matches how the operating
242	system treats outstanding data at socket close time).	242	system treats outstanding data at socket close time).
243		243
244	This will not work for partial TLS data that could not be encoded	244	This will not work for partial TLS data that could not be encoded
245	yet. This data will be lost.	245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
		247
		248	=item peername => $string
		249
		250	A string used to identify the remote site - usually the DNS hostname
		251	(I<not> IDN!) used to create the connection, rarely the IP address.
		252
		253	Apart from being useful in error messages, this string is also used in TLS
		254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).
246		255
247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
248		257
249	When this parameter is given, it enables TLS (SSL) mode, that means	258	When this parameter is given, it enables TLS (SSL) mode, that means
250	AnyEvent will start a TLS handshake as soon as the conenction has been	259	AnyEvent will start a TLS handshake as soon as the conenction has been
251	established and will transparently encrypt/decrypt data afterwards.	260	established and will transparently encrypt/decrypt data afterwards.
		261
		262	All TLS protocol errors will be signalled as C<EPROTO>, with an
		263	appropriate error message.
252		264
253	TLS mode requires Net::SSLeay to be installed (it will be loaded	265	TLS mode requires Net::SSLeay to be installed (it will be loaded
254	automatically when you try to create a TLS handle): this module doesn't	266	automatically when you try to create a TLS handle): this module doesn't
255	have a dependency on that module, so if your module requires it, you have	267	have a dependency on that module, so if your module requires it, you have
256	to add the dependency yourself.	268	to add the dependency yourself.
…		…
260	mode.	272	mode.
261		273
262	You can also provide your own TLS connection object, but you have	274	You can also provide your own TLS connection object, but you have
263	to make sure that you call either C<Net::SSLeay::set_connect_state>	275	to make sure that you call either C<Net::SSLeay::set_connect_state>
264	or C<Net::SSLeay::set_accept_state> on it before you pass it to	276	or C<Net::SSLeay::set_accept_state> on it before you pass it to
265	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
		279
		280	At some future point, AnyEvent::Handle might switch to another TLS
		281	implementation, then the option to use your own session object will go
		282	away.
		283
		284	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		285	passing in the wrong integer will lead to certain crash. This most often
		286	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		287	segmentation fault.
266		288
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	289	See the C<< ->starttls >> method for when need to start TLS negotiation later.
268		290
269	=item tls_ctx => $ssl_ctx	291	=item tls_ctx => $anyevent_tls
270		292
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	293	Use the given C<AnyEvent::TLS> object to create the new TLS connection
272	(unless a connection object was specified directly). If this parameter is	294	(unless a connection object was specified directly). If this parameter is
273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		296
		297	Instead of an object, you can also specify a hash reference with C<< key
		298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		299	new TLS context object.
274		300
275	=item json => JSON or JSON::XS object	301	=item json => JSON or JSON::XS object
276		302
277	This is the json coder object used by the C<json> read and write types.	303	This is the json coder object used by the C<json> read and write types.
278		304
…		…
281	texts.	307	texts.
282		308
283	Note that you are responsible to depend on the JSON module if you want to	309	Note that you are responsible to depend on the JSON module if you want to
284	use this functionality, as AnyEvent does not have a dependency itself.	310	use this functionality, as AnyEvent does not have a dependency itself.
285		311
286	=item filter_r => $cb
287
288	=item filter_w => $cb
289
290	These exist, but are undocumented at this time. (They are used internally
291	by the TLS code).
292
293	=back	312	=back
294		313
295	=cut	314	=cut
296		315
297	sub new {	316	sub new {
298	my $class = shift;	317	my $class = shift;
299
300	my $self = bless { @_ }, $class;	318	my $self = bless { @_ }, $class;
301		319
302	$self->{fh} or Carp::croak "mandatory argument fh is missing";	320	$self->{fh} or Carp::croak "mandatory argument fh is missing";
303		321
304	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
305
306	if ($self->{tls}) {
307	require Net::SSLeay;
308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
309	}
310		323
311	$self->{_activity} = AnyEvent->now;	324	$self->{_activity} = AnyEvent->now;
312	$self->_timeout;	325	$self->_timeout;
313		326
		327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		328
		329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		330	if $self->{tls};
		331
314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
316		333
317	$self->start_read	334	$self->start_read
318	if $self->{on_read};	335	if $self->{on_read};
319		336
320	$self	337	$self->{fh} && $self
321	}	338	}
322		339
323	sub _shutdown {	340	sub _shutdown {
324	my ($self) = @_;	341	my ($self) = @_;
325		342
326	delete $self->{_tw};	343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
327	delete $self->{_rw};	344	$self->{_eof} = 1; # tell starttls et. al to stop trying
328	delete $self->{_ww};
329	delete $self->{fh};
330		345
331	&_freetls;	346	&_freetls;
332
333	delete $self->{on_read};
334	delete $self->{_queue};
335	}	347	}
336		348
337	sub _error {	349	sub _error {
338	my ($self, $errno, $fatal) = @_;	350	my ($self, $errno, $fatal, $message) = @_;
339		351
340	$self->_shutdown	352	$self->_shutdown
341	if $fatal;	353	if $fatal;
342		354
343	$! = $errno;	355	$! = $errno;
		356	$message \|\|= "$!";
344		357
345	if ($self->{on_error}) {	358	if ($self->{on_error}) {
346	$self->{on_error}($self, $fatal);	359	$self->{on_error}($self, $fatal, $message);
347	} else {	360	} elsif ($self->{fh}) {
348	Carp::croak "AnyEvent::Handle uncaught error: $!";	361	Carp::croak "AnyEvent::Handle uncaught error: $message";
349	}	362	}
350	}	363	}
351		364
352	=item $fh = $handle->fh	365	=item $fh = $handle->fh
353		366
…		…
390	}	403	}
391		404
392	=item $handle->autocork ($boolean)	405	=item $handle->autocork ($boolean)
393		406
394	Enables or disables the current autocork behaviour (see C<autocork>	407	Enables or disables the current autocork behaviour (see C<autocork>
395	constructor argument).	408	constructor argument). Changes will only take effect on the next write.
396		409
397	=cut	410	=cut
		411
		412	sub autocork {
		413	$_[0]{autocork} = $_[1];
		414	}
398		415
399	=item $handle->no_delay ($boolean)	416	=item $handle->no_delay ($boolean)
400		417
401	Enables or disables the C<no_delay> setting (see constructor argument of	418	Enables or disables the C<no_delay> setting (see constructor argument of
402	the same name for details).	419	the same name for details).
…		…
495	my ($self, $cb) = @_;	512	my ($self, $cb) = @_;
496		513
497	$self->{on_drain} = $cb;	514	$self->{on_drain} = $cb;
498		515
499	$cb->($self)	516	$cb->($self)
500	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	517	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
501	}	518	}
502		519
503	=item $handle->push_write ($data)	520	=item $handle->push_write ($data)
504		521
505	Queues the given scalar to be written. You can push as much data as you	522	Queues the given scalar to be written. You can push as much data as you
…		…
522	substr $self->{wbuf}, 0, $len, "";	539	substr $self->{wbuf}, 0, $len, "";
523		540
524	$self->{_activity} = AnyEvent->now;	541	$self->{_activity} = AnyEvent->now;
525		542
526	$self->{on_drain}($self)	543	$self->{on_drain}($self)
527	if $self->{low_water_mark} >= length $self->{wbuf}	544	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
528	&& $self->{on_drain};	545	&& $self->{on_drain};
529		546
530	delete $self->{_ww} unless length $self->{wbuf};	547	delete $self->{_ww} unless length $self->{wbuf};
531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
532	$self->_error ($!, 1);	549	$self->_error ($!, 1);
…		…
556		573
557	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	574	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
558	->($self, @_);	575	->($self, @_);
559	}	576	}
560		577
561	if ($self->{filter_w}) {	578	if ($self->{tls}) {
562	$self->{filter_w}($self, \$_[0]);	579	$self->{_tls_wbuf} .= $_[0];
		580
		581	&_dotls ($self);
563	} else {	582	} else {
564	$self->{wbuf} .= $_[0];	583	$self->{wbuf} .= $_[0];
565	$self->_drain_wbuf;	584	$self->_drain_wbuf;
566	}	585	}
567	}	586	}
…		…
584	=cut	603	=cut
585		604
586	register_write_type netstring => sub {	605	register_write_type netstring => sub {
587	my ($self, $string) = @_;	606	my ($self, $string) = @_;
588		607
589	sprintf "%d:%s,", (length $string), $string	608	(length $string) . ":$string,"
590	};	609	};
591		610
592	=item packstring => $format, $data	611	=item packstring => $format, $data
593		612
594	An octet string prefixed with an encoded length. The encoding C<$format>	613	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
659		678
660	pack "w/a*", Storable::nfreeze ($ref)	679	pack "w/a*", Storable::nfreeze ($ref)
661	};	680	};
662		681
663	=back	682	=back
		683
		684	=item $handle->push_shutdown
		685
		686	Sometimes you know you want to close the socket after writing your data
		687	before it was actually written. One way to do that is to replace your
		688	C<on_drain> handler by a callback that shuts down the socket. This method
		689	is a shorthand for just that, and replaces the C<on_drain> callback with:
		690
		691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		692
		693	This simply shuts down the write side and signals an EOF condition to the
		694	the peer.
		695
		696	You can rely on the normal read queue and C<on_eof> handling
		697	afterwards. This is the cleanest way to close a connection.
		698
		699	=cut
		700
		701	sub push_shutdown {
		702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };
		703	}
664		704
665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
666		706
667	This function (not method) lets you add your own types to C<push_write>.	707	This function (not method) lets you add your own types to C<push_write>.
668	Whenever the given C<type> is used, C<push_write> will invoke the code	708	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
772	) {	812	) {
773	$self->_error (&Errno::ENOSPC, 1), return;	813	$self->_error (&Errno::ENOSPC, 1), return;
774	}	814	}
775		815
776	while () {	816	while () {
		817	# we need to use a separate tls read buffer, as we must not receive data while
		818	# we are draining the buffer, and this can only happen with TLS.
		819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		820
777	my $len = length $self->{rbuf};	821	my $len = length $self->{rbuf};
778		822
779	if (my $cb = shift @{ $self->{_queue} }) {	823	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	824	unless ($cb->($self)) {
781	if ($self->{_eof}) {	825	if ($self->{_eof}) {
…		…
803		847
804	last; # more data might arrive	848	last; # more data might arrive
805	}	849	}
806	} else {	850	} else {
807	# read side becomes idle	851	# read side becomes idle
808	delete $self->{_rw};	852	delete $self->{_rw} unless $self->{tls};
809	last;	853	last;
810	}	854	}
811	}	855	}
812		856
813	if ($self->{_eof}) {	857	if ($self->{_eof}) {
…		…
842		886
843	=item $handle->rbuf	887	=item $handle->rbuf
844		888
845	Returns the read buffer (as a modifiable lvalue).	889	Returns the read buffer (as a modifiable lvalue).
846		890
847	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	891	You can access the read buffer directly as the C<< ->{rbuf} >>
848	you want.	892	member, if you want. However, the only operation allowed on the
		893	read buffer (apart from looking at it) is removing data from its
		894	beginning. Otherwise modifying or appending to it is not allowed and will
		895	lead to hard-to-track-down bugs.
849		896
850	NOTE: The read buffer should only be used or modified if the C<on_read>,	897	NOTE: The read buffer should only be used or modified if the C<on_read>,
851	C<push_read> or C<unshift_read> methods are used. The other read methods	898	C<push_read> or C<unshift_read> methods are used. The other read methods
852	automatically manage the read buffer.	899	automatically manage the read buffer.
853		900
…		…
1108	An octet string prefixed with an encoded length. The encoding C<$format>	1155	An octet string prefixed with an encoded length. The encoding C<$format>
1109	uses the same format as a Perl C<pack> format, but must specify a single	1156	uses the same format as a Perl C<pack> format, but must specify a single
1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1157	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1158	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1159
1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1160	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1161	EPP uses a prefix of C<N> (4 octtes).
1114		1162
1115	Example: read a block of data prefixed by its length in BER-encoded	1163	Example: read a block of data prefixed by its length in BER-encoded
1116	format (very efficient).	1164	format (very efficient).
1117		1165
1118	$handle->push_read (packstring => "w", sub {	1166	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1196	}
1149	};	1197	};
1150		1198
1151	=item json => $cb->($handle, $hash_or_arrayref)	1199	=item json => $cb->($handle, $hash_or_arrayref)
1152		1200
1153	Reads a JSON object or array, decodes it and passes it to the callback.	1201	Reads a JSON object or array, decodes it and passes it to the
		1202	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1154		1203
1155	If a C<json> object was passed to the constructor, then that will be used	1204	If a C<json> object was passed to the constructor, then that will be used
1156	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1205	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1157		1206
1158	This read type uses the incremental parser available with JSON version	1207	This read type uses the incremental parser available with JSON version
…		…
1167	=cut	1216	=cut
1168		1217
1169	register_read_type json => sub {	1218	register_read_type json => sub {
1170	my ($self, $cb) = @_;	1219	my ($self, $cb) = @_;
1171		1220
1172	require JSON;	1221	my $json = $self->{json} \|\|=
		1222	eval { require JSON::XS; JSON::XS->new->utf8 }
		1223	\|\| do { require JSON; JSON->new->utf8 };
1173		1224
1174	my $data;	1225	my $data;
1175	my $rbuf = \$self->{rbuf};	1226	my $rbuf = \$self->{rbuf};
1176		1227
1177	my $json = $self->{json} \|\|= JSON->new->utf8;
1178
1179	sub {	1228	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1230
1182	if ($ref) {	1231	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1232	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1233	$json->incr_text = "";
1185	$cb->($self, $ref);	1234	$cb->($self, $ref);
1186		1235
1187	1	1236	1
		1237	} elsif ($@) {
		1238	# error case
		1239	$json->incr_skip;
		1240
		1241	$self->{rbuf} = $json->incr_text;
		1242	$json->incr_text = "";
		1243
		1244	$self->_error (&Errno::EBADMSG);
		1245
		1246	()
1188	} else {	1247	} else {
1189	$self->{rbuf} = "";	1248	$self->{rbuf} = "";
		1249
1190	()	1250	()
1191	}	1251	}
1192	}	1252	}
1193	};	1253	};
1194		1254
…		…
1271	Note that AnyEvent::Handle will automatically C<start_read> for you when	1331	Note that AnyEvent::Handle will automatically C<start_read> for you when
1272	you change the C<on_read> callback or push/unshift a read callback, and it	1332	you change the C<on_read> callback or push/unshift a read callback, and it
1273	will automatically C<stop_read> for you when neither C<on_read> is set nor	1333	will automatically C<stop_read> for you when neither C<on_read> is set nor
1274	there are any read requests in the queue.	1334	there are any read requests in the queue.
1275		1335
		1336	These methods will have no effect when in TLS mode (as TLS doesn't support
		1337	half-duplex connections).
		1338
1276	=cut	1339	=cut
1277		1340
1278	sub stop_read {	1341	sub stop_read {
1279	my ($self) = @_;	1342	my ($self) = @_;
1280		1343
1281	delete $self->{_rw};	1344	delete $self->{_rw} unless $self->{tls};
1282	}	1345	}
1283		1346
1284	sub start_read {	1347	sub start_read {
1285	my ($self) = @_;	1348	my ($self) = @_;
1286		1349
1287	unless ($self->{_rw} \|\| $self->{_eof}) {	1350	unless ($self->{_rw} \|\| $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1351	Scalar::Util::weaken $self;
1289		1352
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1355	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1293		1356
1294	if ($len > 0) {	1357	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1358	$self->{_activity} = AnyEvent->now;
1296		1359
1297	$self->{filter_r}	1360	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1362
		1363	&_dotls ($self);
		1364	} else {
		1365	$self->_drain_rbuf unless $self->{_in_drain};
		1366	}
1300		1367
1301	} elsif (defined $len) {	1368	} elsif (defined $len) {
1302	delete $self->{_rw};	1369	delete $self->{_rw};
1303	$self->{_eof} = 1;	1370	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1371	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1308	}	1375	}
1309	});	1376	});
1310	}	1377	}
1311	}	1378	}
1312		1379
		1380	our $ERROR_SYSCALL;
		1381	our $ERROR_WANT_READ;
		1382	our $ERROR_ZERO_RETURN;
		1383
		1384	sub _tls_error {
		1385	my ($self, $err) = @_;
		1386
		1387	return $self->_error ($!, 1)
		1388	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1389
		1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1391
		1392	# reduce error string to look less scary
		1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1394
		1395	$self->_error (&Errno::EPROTO, 1, $err);
		1396	}
		1397
		1398	# poll the write BIO and send the data if applicable
		1399	# also decode read data if possible
		1400	# this is basiclaly our TLS state machine
		1401	# more efficient implementations are possible with openssl,
		1402	# but not with the buggy and incomplete Net::SSLeay.
1313	sub _dotls {	1403	sub _dotls {
1314	my ($self) = @_;	1404	my ($self) = @_;
1315		1405
1316	my $buf;	1406	my $tmp;
1317		1407
1318	if (length $self->{_tls_wbuf}) {	1408	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1409	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1410	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1411	}
1322	}
1323		1412
		1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1414	return $self->_tls_error ($tmp)
		1415	if $tmp != $ERROR_WANT_READ
		1416	&& ($tmp != $ERROR_SYSCALL \|\| $!)
		1417	&& $tmp != $ERROR_ZERO_RETURN;
		1418	}
		1419
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1421	unless (length $tmp) {
1326	# let's treat SSL-eof as we treat normal EOF	1422	# let's treat SSL-eof as we treat normal EOF
1327	delete $self->{_rw};	1423	delete $self->{_rw};
1328	$self->{_eof} = 1;	1424	$self->{_eof} = 1;
1329	&_freetls;	1425	&_freetls;
1330	}	1426	}
1331		1427
1332	$self->{rbuf} .= $buf;	1428	$self->{_tls_rbuf} .= $tmp;
1333	$self->_drain_rbuf unless $self->{_in_drain};	1429	$self->_drain_rbuf unless $self->{_in_drain};
1334	$self->{tls} or return; # tls session might have gone away in callback	1430	$self->{tls} or return; # tls session might have gone away in callback
1335	}	1431	}
1336		1432
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1434	return $self->_tls_error ($tmp)
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1435	if $tmp != $ERROR_WANT_READ
1343	return $self->_error (&Errno::EIO, 1);	1436	&& ($tmp != $ERROR_SYSCALL \|\| $!)
1344	}	1437	&& $tmp != $ERROR_ZERO_RETURN;
1345		1438
1346	# all others are fine for our purposes
1347	}
1348
1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1440	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1441	$self->_drain_wbuf;
1352	}	1442	}
1353	}	1443	}
1354		1444
1355	=item $handle->starttls ($tls[, $tls_ctx])	1445	=item $handle->starttls ($tls[, $tls_ctx])
…		…
1359	C<starttls>.	1449	C<starttls>.
1360		1450
1361	The first argument is the same as the C<tls> constructor argument (either	1451	The first argument is the same as the C<tls> constructor argument (either
1362	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1363		1453
1364	The second argument is the optional C<Net::SSLeay::CTX> object that is	1454	The second argument is the optional C<AnyEvent::TLS> object that is used
1365	used when AnyEvent::Handle has to create its own TLS connection object.	1455	when AnyEvent::Handle has to create its own TLS connection object, or
		1456	a hash reference with C<< key => value >> pairs that will be used to
		1457	construct a new context.
1366		1458
1367	The TLS connection object will end up in C<< $handle->{tls} >> after this	1459	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1368	call and can be used or changed to your liking. Note that the handshake	1460	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1369	might have already started when this function returns.	1461	changed to your liking. Note that the handshake might have already started
		1462	when this function returns.
1370		1463
1371	If it an error to start a TLS handshake more than once per	1464	If it an error to start a TLS handshake more than once per
1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1465	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1373		1466
1374	=cut	1467	=cut
1375		1468
		1469	our %TLS_CACHE; #TODO not yet documented, should we?
		1470
1376	sub starttls {	1471	sub starttls {
1377	my ($self, $ssl, $ctx) = @_;	1472	my ($self, $ssl, $ctx) = @_;
1378		1473
		1474	require Net::SSLeay;
		1475
1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1476	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1380	if $self->{tls};	1477	if $self->{tls};
		1478
		1479	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
		1482
		1483	$ctx \|\|= $self->{tls_ctx};
		1484
		1485	if ("HASH" eq ref $ctx) {
		1486	require AnyEvent::TLS;
		1487
		1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1489
		1490	if ($ctx->{cache}) {
		1491	my $key = $ctx+0;
		1492	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1493	} else {
		1494	$ctx = new AnyEvent::TLS %$ctx;
		1495	}
		1496	}
1381		1497
1382	if ($ssl eq "accept") {	1498	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1499	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1384	Net::SSLeay::set_accept_state ($ssl);
1385	} elsif ($ssl eq "connect") {
1386	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1387	Net::SSLeay::set_connect_state ($ssl);
1388	}
1389
1390	$self->{tls} = $ssl;
1391		1500
1392	# basically, this is deep magic (because SSL_read should have the same issues)	1501	# basically, this is deep magic (because SSL_read should have the same issues)
1393	# but the openssl maintainers basically said: "trust us, it just works".	1502	# but the openssl maintainers basically said: "trust us, it just works".
1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1503	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1395	# and mismaintained ssleay-module doesn't even offer them).	1504	# and mismaintained ssleay-module doesn't even offer them).
1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1505	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1397	#	1506	#
1398	# in short: this is a mess.	1507	# in short: this is a mess.
1399	#	1508	#
1400	# note that we do not try to kepe the length constant between writes as we are required to do.	1509	# note that we do not try to keep the length constant between writes as we are required to do.
1401	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1510	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1402	# and we drive openssl fully in blocking mode here.	1511	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1512	# have identity issues in that area.
1403	Net::SSLeay::CTX_set_mode ($self->{tls},	1513	# Net::SSLeay::CTX_set_mode ($ssl,
1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1514	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1405	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1515	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1516	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1406		1517
1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1408	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1409		1520
1410	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1411		1522
1412	$self->{filter_w} = sub {
1413	$_[0]{_tls_wbuf} .= ${$_[1]};
1414	&_dotls;
1415	};
1416	$self->{filter_r} = sub {
1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1418	&_dotls;
1419	};
1420
1421	&_dotls; # need to trigger the initial negotiation exchange	1523	&_dotls; # need to trigger the initial handshake
		1524	$self->start_read; # make sure we actually do read
1422	}	1525	}
1423		1526
1424	=item $handle->stoptls	1527	=item $handle->stoptls
1425		1528
1426	Shuts down the SSL connection - this makes a proper EOF handshake by	1529	Shuts down the SSL connection - this makes a proper EOF handshake by
…		…
1432		1535
1433	sub stoptls {	1536	sub stoptls {
1434	my ($self) = @_;	1537	my ($self) = @_;
1435		1538
1436	if ($self->{tls}) {	1539	if ($self->{tls}) {
1437	Net::SSLeay::shutdown $self->{tls};	1540	Net::SSLeay::shutdown ($self->{tls});
1438		1541
1439	&_dotls;	1542	&_dotls;
1440		1543
1441	# we don't give a shit. no, we do, but we can't. no...	1544	# we don't give a shit. no, we do, but we can't. no...
1442	# we, we... have to use openssl :/	1545	# we, we... have to use openssl :/
…		…
1447	sub _freetls {	1550	sub _freetls {
1448	my ($self) = @_;	1551	my ($self) = @_;
1449		1552
1450	return unless $self->{tls};	1553	return unless $self->{tls};
1451		1554
1452	Net::SSLeay::free (delete $self->{tls});	1555	$self->{tls_ctx}->_put_session (delete $self->{tls});
1453		1556
1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};	1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1455	}	1558	}
1456		1559
1457	sub DESTROY {	1560	sub DESTROY {
1458	my $self = shift;	1561	my ($self) = @_;
1459		1562
1460	&_freetls;	1563	&_freetls;
1461		1564
1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1463		1566
…		…
1480	@linger = ();	1583	@linger = ();
1481	});	1584	});
1482	}	1585	}
1483	}	1586	}
1484		1587
		1588	=item $handle->destroy
		1589
		1590	Shuts down the handle object as much as possible - this call ensures that
		1591	no further callbacks will be invoked and resources will be freed as much
		1592	as possible. You must not call any methods on the object afterwards.
		1593
		1594	Normally, you can just "forget" any references to an AnyEvent::Handle
		1595	object and it will simply shut down. This works in fatal error and EOF
		1596	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1597	callback, so when you want to destroy the AnyEvent::Handle object from
		1598	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1599	that case.
		1600
		1601	The handle might still linger in the background and write out remaining
		1602	data, as specified by the C<linger> option, however.
		1603
		1604	=cut
		1605
		1606	sub destroy {
		1607	my ($self) = @_;
		1608
		1609	$self->DESTROY;
		1610	%$self = ();
		1611	}
		1612
1485	=item AnyEvent::Handle::TLS_CTX	1613	=item AnyEvent::Handle::TLS_CTX
1486		1614
1487	This function creates and returns the Net::SSLeay::CTX object used by	1615	This function creates and returns the AnyEvent::TLS object used by default
1488	default for TLS mode.	1616	for TLS mode.
1489		1617
1490	The context is created like this:	1618	The context is created by calling L<AnyEvent::TLS> without any arguments.
1491
1492	Net::SSLeay::load_error_strings;
1493	Net::SSLeay::SSLeay_add_ssl_algorithms;
1494	Net::SSLeay::randomize;
1495
1496	my $CTX = Net::SSLeay::CTX_new;
1497
1498	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1499		1619
1500	=cut	1620	=cut
1501		1621
1502	our $TLS_CTX;	1622	our $TLS_CTX;
1503		1623
1504	sub TLS_CTX() {	1624	sub TLS_CTX() {
1505	$TLS_CTX \|\| do {	1625	$TLS_CTX \|\|= do {
1506	require Net::SSLeay;	1626	require AnyEvent::TLS;
1507		1627
1508	Net::SSLeay::load_error_strings ();	1628	new AnyEvent::TLS
1509	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1510	Net::SSLeay::randomize ();
1511
1512	$TLS_CTX = Net::SSLeay::CTX_new ();
1513
1514	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1515
1516	$TLS_CTX
1517	}	1629	}
1518	}	1630	}
1519		1631
1520	=back	1632	=back
		1633
		1634
		1635	=head1 NONFREQUENTLY ASKED QUESTIONS
		1636
		1637	=over 4
		1638
		1639	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1640	still get further invocations!
		1641
		1642	That's because AnyEvent::Handle keeps a reference to itself when handling
		1643	read or write callbacks.
		1644
		1645	It is only safe to "forget" the reference inside EOF or error callbacks,
		1646	from within all other callbacks, you need to explicitly call the C<<
		1647	->destroy >> method.
		1648
		1649	=item I get different callback invocations in TLS mode/Why can't I pause
		1650	reading?
		1651
		1652	Unlike, say, TCP, TLS connections do not consist of two independent
		1653	communication channels, one for each direction. Or put differently. The
		1654	read and write directions are not independent of each other: you cannot
		1655	write data unless you are also prepared to read, and vice versa.
		1656
		1657	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1658	callback invocations when you are not expecting any read data - the reason
		1659	is that AnyEvent::Handle always reads in TLS mode.
		1660
		1661	During the connection, you have to make sure that you always have a
		1662	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1663	connection (or when you no longer want to use it) you can call the
		1664	C<destroy> method.
		1665
		1666	=item How do I read data until the other side closes the connection?
		1667
		1668	If you just want to read your data into a perl scalar, the easiest way
		1669	to achieve this is by setting an C<on_read> callback that does nothing,
		1670	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1671	will be in C<$_[0]{rbuf}>:
		1672
		1673	$handle->on_read (sub { });
		1674	$handle->on_eof (undef);
		1675	$handle->on_error (sub {
		1676	my $data = delete $_[0]{rbuf};
		1677	undef $handle;
		1678	});
		1679
		1680	The reason to use C<on_error> is that TCP connections, due to latencies
		1681	and packets loss, might get closed quite violently with an error, when in
		1682	fact, all data has been received.
		1683
		1684	It is usually better to use acknowledgements when transferring data,
		1685	to make sure the other side hasn't just died and you got the data
		1686	intact. This is also one reason why so many internet protocols have an
		1687	explicit QUIT command.
		1688
		1689	=item I don't want to destroy the handle too early - how do I wait until
		1690	all data has been written?
		1691
		1692	After writing your last bits of data, set the C<on_drain> callback
		1693	and destroy the handle in there - with the default setting of
		1694	C<low_water_mark> this will be called precisely when all data has been
		1695	written to the socket:
		1696
		1697	$handle->push_write (...);
		1698	$handle->on_drain (sub {
		1699	warn "all data submitted to the kernel\n";
		1700	undef $handle;
		1701	});
		1702
		1703	=back
		1704
1521		1705
1522	=head1 SUBCLASSING AnyEvent::Handle	1706	=head1 SUBCLASSING AnyEvent::Handle
1523		1707
1524	In many cases, you might want to subclass AnyEvent::Handle.	1708	In many cases, you might want to subclass AnyEvent::Handle.
1525		1709

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC vs. Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC