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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.79 by root, Sun Jul 27 08:37:56 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.22;	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
		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
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
85	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
86	waiting for data.	95	waiting for data.
		96
		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>.
87		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal)
89		101
90	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
91	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
92	connect or a read error.	104	connect or a read error.
93		105
94	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
95	fatal errors the handle object will be shut down and will not be	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
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
96	usable. Non-fatal errors can be retried by simply returning, but it is	112	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	113	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		116
100	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		119
103	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
135	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
136		153
137	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
138	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
139	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
140	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
141		158
142	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
143	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
144	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
145	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
146		164
147	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
148		166
149	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
150		168
…		…
154		172
155	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
156		174
157	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>)
158	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
159	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
160		178
161	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
162	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
163	(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
164	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
165	isn't finished).	183	isn't finished).
166		184
167	=item autocork => <boolean>	185	=item autocork => <boolean>
168		186
169	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
170	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
171	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
172	inefficient if you write multiple small chunks (this disadvantage is	190	be inefficient if you write multiple small chunks (on the wire, this
173	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).
174		193
175	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
176	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,
177	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.
178		198
179	=item no_delay => <boolean>	199	=item no_delay => <boolean>
180		200
181	When doing small writes on sockets, your operating system kernel might	201	When doing small writes on sockets, your operating system kernel might
182	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
183	the Nagle algorithm, and usually it is beneficial.	203	the Nagle algorithm, and usually it is beneficial.
184		204
185	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
186	accomplishd by setting this option to true.	206	accomplishd by setting this option to a true value.
187		207
188	The default is your opertaing system's default behaviour, this option	208	The default is your opertaing system's default behaviour (most likely
189	explicitly enables or disables it, if possible.	209	enabled), this option explicitly enables or disables it, if possible.
190		210
191	=item read_size => <bytes>	211	=item read_size => <bytes>
192		212
193	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
194	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
195		216
196	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
197		218
198	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
199	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
200	considered empty.	221	considered empty.
201		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
202	=item linger => <seconds>	228	=item linger => <seconds>
203		229
204	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
205	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
206	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
207	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
208	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
209		235
210	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
211	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
212		239
213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
214		241
215	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
216	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
217	data.	244	established and will transparently encrypt/decrypt data afterwards.
218		245
219	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
220	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.
221		250
222	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
223	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
224		254
225	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
226	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>
227	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
228	AnyEvent::Handle.	258	AnyEvent::Handle.
229		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
230	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.
231		266
232	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
233		268
234	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
235	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
237		272
238	=item json => JSON or JSON::XS object	273	=item json => JSON or JSON::XS object
239		274
240	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.
241		276
242	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
243	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.
244		280
245	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
246	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
247		283
248	=item filter_r => $cb
249
250	=item filter_w => $cb
251
252	These exist, but are undocumented at this time.
253
254	=back	284	=back
255		285
256	=cut	286	=cut
257		287
258	sub new {	288	sub new {
…		…
262		292
263	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
264		294
265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
266		296
267	if ($self->{tls}) {
268	require Net::SSLeay;
269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
270	}	298	if $self->{tls};
271		299
272	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
273	$self->_timeout;	301	$self->_timeout;
274		302
275	$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};
…		…
287	delete $self->{_tw};	315	delete $self->{_tw};
288	delete $self->{_rw};	316	delete $self->{_rw};
289	delete $self->{_ww};	317	delete $self->{_ww};
290	delete $self->{fh};	318	delete $self->{fh};
291		319
292	$self->stoptls;	320	&_freetls;
		321
		322	delete $self->{on_read};
		323	delete $self->{_queue};
293	}	324	}
294		325
295	sub _error {	326	sub _error {
296	my ($self, $errno, $fatal) = @_;	327	my ($self, $errno, $fatal) = @_;
297		328
…		…
300		331
301	$! = $errno;	332	$! = $errno;
302		333
303	if ($self->{on_error}) {	334	if ($self->{on_error}) {
304	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
305	} else {	336	} elsif ($self->{fh}) {
306	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
307	}	338	}
308	}	339	}
309		340
310	=item $fh = $handle->fh	341	=item $fh = $handle->fh
311		342
312	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.
313		344
314	=cut	345	=cut
315		346
316	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
317		348
…		…
335	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
336	}	367	}
337		368
338	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
339		370
340	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
341	(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
342	argument.	373	argument and method.
343		374
344	=cut	375	=cut
345		376
346	sub on_timeout {	377	sub on_timeout {
347	$_[0]{on_timeout} = $_[1];	378	$_[0]{on_timeout} = $_[1];
348	}	379	}
349		380
350	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
351		382
352	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
353	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
354		385
355	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
356		391
357	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
358		393
359	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
360	the same name for details).	395	the same name for details).
…		…
453	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
454		489
455	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
456		491
457	$cb->($self)	492	$cb->($self)
458	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
459	}	494	}
460		495
461	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
462		497
463	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
…		…
480	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
481		516
482	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
483		518
484	$self->{on_drain}($self)	519	$self->{on_drain}($self)
485	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
486	&& $self->{on_drain};	521	&& $self->{on_drain};
487		522
488	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
490	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
514		549
515	@_ = ($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")
516	->($self, @_);	551	->($self, @_);
517	}	552	}
518		553
519	if ($self->{filter_w}) {	554	if ($self->{tls}) {
520	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
521	} else {	558	} else {
522	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
523	$self->_drain_wbuf;	560	$self->_drain_wbuf;
524	}	561	}
525	}	562	}
…		…
542	=cut	579	=cut
543		580
544	register_write_type netstring => sub {	581	register_write_type netstring => sub {
545	my ($self, $string) = @_;	582	my ($self, $string) = @_;
546		583
547	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
548	};	585	};
549		586
550	=item packstring => $format, $data	587	=item packstring => $format, $data
551		588
552	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>
…		…
726		763
727	if (	764	if (
728	defined $self->{rbuf_max}	765	defined $self->{rbuf_max}
729	&& $self->{rbuf_max} < length $self->{rbuf}	766	&& $self->{rbuf_max} < length $self->{rbuf}
730	) {	767	) {
731	return $self->_error (&Errno::ENOSPC, 1);	768	$self->_error (&Errno::ENOSPC, 1), return;
732	}	769	}
733		770
734	while () {	771	while () {
735	my $len = length $self->{rbuf};	772	my $len = length $self->{rbuf};
736		773
737	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
738	unless ($cb->($self)) {	775	unless ($cb->($self)) {
739	if ($self->{_eof}) {	776	if ($self->{_eof}) {
740	# no progress can be made (not enough data and no data forthcoming)	777	# no progress can be made (not enough data and no data forthcoming)
741	$self->_error (&Errno::EPIPE, 1), last;	778	$self->_error (&Errno::EPIPE, 1), return;
742	}	779	}
743		780
744	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
745	last;	782	last;
746	}	783	}
…		…
754	&& !@{ $self->{_queue} } # and the queue is still empty	791	&& !@{ $self->{_queue} } # and the queue is still empty
755	&& $self->{on_read} # but we still have on_read	792	&& $self->{on_read} # but we still have on_read
756	) {	793	) {
757	# no further data will arrive	794	# no further data will arrive
758	# so no progress can be made	795	# so no progress can be made
759	$self->_error (&Errno::EPIPE, 1), last	796	$self->_error (&Errno::EPIPE, 1), return
760	if $self->{_eof};	797	if $self->{_eof};
761		798
762	last; # more data might arrive	799	last; # more data might arrive
763	}	800	}
764	} else {	801	} else {
765	# read side becomes idle	802	# read side becomes idle
766	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
767	last;	804	last;
768	}	805	}
769	}	806	}
770		807
		808	if ($self->{_eof}) {
		809	if ($self->{on_eof}) {
771	$self->{on_eof}($self)	810	$self->{on_eof}($self)
772	if $self->{_eof} && $self->{on_eof};	811	} else {
		812	$self->_error (0, 1);
		813	}
		814	}
773		815
774	# may need to restart read watcher	816	# may need to restart read watcher
775	unless ($self->{_rw}) {	817	unless ($self->{_rw}) {
776	$self->start_read	818	$self->start_read
777	if $self->{on_read} \|\| @{ $self->{_queue} };	819	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
1061	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>
1062	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
1063	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1064	optional C<!>, C<< < >> or C<< > >> modifier).	1106	optional C<!>, C<< < >> or C<< > >> modifier).
1065		1107
1066	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).
1067		1110
1068	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
1069	format (very efficient).	1112	format (very efficient).
1070		1113
1071	$handle->push_read (packstring => "w", sub {	1114	$handle->push_read (packstring => "w", sub {
…		…
1101	}	1144	}
1102	};	1145	};
1103		1146
1104	=item json => $cb->($handle, $hash_or_arrayref)	1147	=item json => $cb->($handle, $hash_or_arrayref)
1105		1148
1106	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.
1107		1151
1108	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
1109	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.
1110		1154
1111	This read type uses the incremental parser available with JSON version	1155	This read type uses the incremental parser available with JSON version
…		…
1128	my $rbuf = \$self->{rbuf};	1172	my $rbuf = \$self->{rbuf};
1129		1173
1130	my $json = $self->{json} \|\|= JSON->new->utf8;	1174	my $json = $self->{json} \|\|= JSON->new->utf8;
1131		1175
1132	sub {	1176	sub {
1133	my $ref = $json->incr_parse ($self->{rbuf});	1177	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1134		1178
1135	if ($ref) {	1179	if ($ref) {
1136	$self->{rbuf} = $json->incr_text;	1180	$self->{rbuf} = $json->incr_text;
1137	$json->incr_text = "";	1181	$json->incr_text = "";
1138	$cb->($self, $ref);	1182	$cb->($self, $ref);
1139		1183
1140	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
1141	} else {	1195	} else {
1142	$self->{rbuf} = "";	1196	$self->{rbuf} = "";
1143	()	1197	()
1144	}	1198	}
1145	}	1199	}
…		…
1224	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
1225	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
1226	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
1227	there are any read requests in the queue.	1281	there are any read requests in the queue.
1228		1282
		1283	These methods will have no effect when in TLS mode (as TLS doesn't support
		1284	half-duplex connections).
		1285
1229	=cut	1286	=cut
1230		1287
1231	sub stop_read {	1288	sub stop_read {
1232	my ($self) = @_;	1289	my ($self) = @_;
1233		1290
1234	delete $self->{_rw};	1291	delete $self->{_rw} unless $self->{tls};
1235	}	1292	}
1236		1293
1237	sub start_read {	1294	sub start_read {
1238	my ($self) = @_;	1295	my ($self) = @_;
1239		1296
1240	unless ($self->{_rw} \|\| $self->{_eof}) {	1297	unless ($self->{_rw} \|\| $self->{_eof}) {
1241	Scalar::Util::weaken $self;	1298	Scalar::Util::weaken $self;
1242		1299
1243	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1300	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1244	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1301	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1245	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;
1246		1303
1247	if ($len > 0) {	1304	if ($len > 0) {
1248	$self->{_activity} = AnyEvent->now;	1305	$self->{_activity} = AnyEvent->now;
1249		1306
1250	$self->{filter_r}	1307	if ($self->{tls}) {
1251	? $self->{filter_r}($self, $rbuf)	1308	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1252	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1309
		1310	&_dotls ($self);
		1311	} else {
		1312	$self->_drain_rbuf unless $self->{_in_drain};
		1313	}
1253		1314
1254	} elsif (defined $len) {	1315	} elsif (defined $len) {
1255	delete $self->{_rw};	1316	delete $self->{_rw};
1256	$self->{_eof} = 1;	1317	$self->{_eof} = 1;
1257	$self->_drain_rbuf unless $self->{_in_drain};	1318	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1261	}	1322	}
1262	});	1323	});
1263	}	1324	}
1264	}	1325	}
1265		1326
		1327	# poll the write BIO and send the data if applicable
1266	sub _dotls {	1328	sub _dotls {
1267	my ($self) = @_;	1329	my ($self) = @_;
1268		1330
1269	my $buf;	1331	my $tmp;
1270		1332
1271	if (length $self->{_tls_wbuf}) {	1333	if (length $self->{_tls_wbuf}) {
1272	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1334	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1273	substr $self->{_tls_wbuf}, 0, $len, "";	1335	substr $self->{_tls_wbuf}, 0, $tmp, "";
1274	}	1336	}
1275	}	1337	}
1276		1338
1277	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1278	$self->{wbuf} .= $buf;
1279	$self->_drain_wbuf;
1280	}
1281
1282	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1339	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1283	if (length $buf) {	1340	unless (length $tmp) {
1284	$self->{rbuf} .= $buf;
1285	$self->_drain_rbuf unless $self->{_in_drain};
1286	} else {
1287	# 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};
1288	$self->{_eof} = 1;	1343	$self->{_eof} = 1;
1289	$self->_shutdown;	1344	&_freetls;
1290	return;
1291	}	1345	}
1292	}
1293		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
1294	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1352	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1295		1353
1296	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1354	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1297	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1355	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1298	return $self->_error ($!, 1);	1356	return $self->_error ($!, 1);
1299	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1357	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1300	return $self->_error (&Errno::EIO, 1);	1358	return $self->_error (&Errno::EIO, 1);
1301	}	1359	}
1302		1360
1303	# 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;
1304	}	1367	}
1305	}	1368	}
1306		1369
1307	=item $handle->starttls ($tls[, $tls_ctx])	1370	=item $handle->starttls ($tls[, $tls_ctx])
1308		1371
…		…
1318		1381
1319	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
1320	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
1321	might have already started when this function returns.	1384	might have already started when this function returns.
1322		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
1323	=cut	1389	=cut
1324		1390
1325	sub starttls {	1391	sub starttls {
1326	my ($self, $ssl, $ctx) = @_;	1392	my ($self, $ssl, $ctx) = @_;
1327		1393
1328	$self->stoptls;	1394	require Net::SSLeay;
1329		1395
		1396	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1397	if $self->{tls};
		1398
1330	if ($ssl eq "accept") {	1399	if ($ssl eq "accept") {
1331	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1400	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1332	Net::SSLeay::set_accept_state ($ssl);	1401	Net::SSLeay::set_accept_state ($ssl);
1333	} elsif ($ssl eq "connect") {	1402	} elsif ($ssl eq "connect") {
1334	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1403	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1340	# 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)
1341	# but the openssl maintainers basically said: "trust us, it just works".	1410	# but the openssl maintainers basically said: "trust us, it just works".
1342	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1411	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1343	# and mismaintained ssleay-module doesn't even offer them).	1412	# and mismaintained ssleay-module doesn't even offer them).
1344	# 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.
1345	Net::SSLeay::CTX_set_mode ($self->{tls},	1421	Net::SSLeay::CTX_set_mode ($self->{tls},
1346	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1422	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1347	\| (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));
1348		1424
1349	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1425	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1350	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1426	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1351		1427
1352	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1428	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1353		1429
1354	$self->{filter_w} = sub {	1430	&_dotls; # need to trigger the initial handshake
1355	$_[0]{_tls_wbuf} .= ${$_[1]};	1431	$self->start_read; # make sure we actually do read
1356	&_dotls;
1357	};
1358	$self->{filter_r} = sub {
1359	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1360	&_dotls;
1361	};
1362	}	1432	}
1363		1433
1364	=item $handle->stoptls	1434	=item $handle->stoptls
1365		1435
1366	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
1367	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.
1368		1440
1369	=cut	1441	=cut
1370		1442
1371	sub stoptls {	1443	sub stoptls {
1372	my ($self) = @_;	1444	my ($self) = @_;
1373		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
1374	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1462	Net::SSLeay::free (delete $self->{tls});
1375		1463
1376	delete $self->{_rbio};	1464	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1377	delete $self->{_wbio};
1378	delete $self->{_tls_wbuf};
1379	delete $self->{filter_r};
1380	delete $self->{filter_w};
1381	}	1465	}
1382		1466
1383	sub DESTROY {	1467	sub DESTROY {
1384	my $self = shift;	1468	my $self = shift;
1385		1469
1386	$self->stoptls;	1470	&_freetls;
1387		1471
1388	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1472	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1389		1473
1390	if ($linger && length $self->{wbuf}) {	1474	if ($linger && length $self->{wbuf}) {
1391	my $fh = delete $self->{fh};	1475	my $fh = delete $self->{fh};
…		…
1406	@linger = ();	1490	@linger = ();
1407	});	1491	});
1408	}	1492	}
1409	}	1493	}
1410		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
1411	=item AnyEvent::Handle::TLS_CTX	1520	=item AnyEvent::Handle::TLS_CTX
1412		1521
1413	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
1414	default for TLS mode.	1523	default for TLS mode.
1415		1524
…		…
1443	}	1552	}
1444	}	1553	}
1445		1554
1446	=back	1555	=back
1447		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
1448	=head1 SUBCLASSING AnyEvent::Handle	1629	=head1 SUBCLASSING AnyEvent::Handle
1449		1630
1450	In many cases, you might want to subclass AnyEvent::Handle.	1631	In many cases, you might want to subclass AnyEvent::Handle.
1451		1632
1452	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.79 by root, Sun Jul 27 08:37:56 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.79 by root, Sun Jul 27 08:37:56 2008 UTC vs.
Revision 1.113 by root, Wed Jan 21 06:02:21 2009 UTC