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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
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.14;	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 detcted,	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
…		…
124	This sets the callback that is called when the write buffer becomes empty	141	This sets the callback that is called when the write buffer becomes empty
125	(or when the callback is set and the buffer is empty already).	142	(or when the callback is set and the buffer is empty already).
126		143
127	To append to the write buffer, use the C<< ->push_write >> method.	144	To append to the write buffer, use the C<< ->push_write >> method.
128		145
		146	This callback is useful when you don't want to put all of your write data
		147	into the queue at once, for example, when you want to write the contents
		148	of some file to the socket you might not want to read the whole file into
		149	memory and push it into the queue, but instead only read more data from
		150	the file when the write queue becomes empty.
		151
129	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
130		153
131	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
132	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
133	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
134	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		158
136	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
137	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
138	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
139	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
140		164
141	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
142		166
143	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
144		168
…		…
148		172
149	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
150		174
151	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>)
152	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
153	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
154		178
155	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
156	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
157	(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
158	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
159	isn't finished).	183	isn't finished).
160		184
		185	=item autocork => <boolean>
		186
		187	When disabled (the default), then C<push_write> will try to immediately
		188	write the data to the handle, if possible. This avoids having to register
		189	a write watcher and wait for the next event loop iteration, but can
		190	be inefficient if you write multiple small chunks (on the wire, this
		191	disadvantage is usually avoided by your kernel's nagle algorithm, see
		192	C<no_delay>, but this option can save costly syscalls).
		193
		194	When enabled, then writes will always be queued till the next event loop
		195	iteration. This is efficient when you do many small writes per iteration,
		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.
		198
		199	=item no_delay => <boolean>
		200
		201	When doing small writes on sockets, your operating system kernel might
		202	wait a bit for more data before actually sending it out. This is called
		203	the Nagle algorithm, and usually it is beneficial.
		204
		205	In some situations you want as low a delay as possible, which can be
		206	accomplishd by setting this option to a true value.
		207
		208	The default is your opertaing system's default behaviour (most likely
		209	enabled), this option explicitly enables or disables it, if possible.
		210
161	=item read_size => <bytes>	211	=item read_size => <bytes>
162		212
163	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
164	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
165		216
166	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
167		218
168	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
169	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
170	considered empty.	221	considered empty.
171		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
		228	=item linger => <seconds>
		229
		230	If non-zero (default: C<3600>), then the destructor of the
		231	AnyEvent::Handle object will check whether there is still outstanding
		232	write data and will install a watcher that will write this data to the
		233	socket. No errors will be reported (this mostly matches how the operating
		234	system treats outstanding data at socket close time).
		235
		236	This will not work for partial TLS data that could not be encoded
		237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
		239
172	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
173		241
174	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
175	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
176	data.	244	established and will transparently encrypt/decrypt data afterwards.
177		245
178	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
179	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.
180		250
181	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
182	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
183		254
184	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
185	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>
186	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
187	AnyEvent::Handle.	258	AnyEvent::Handle.
188		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
189	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.
190		266
191	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
192		268
193	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
194	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
195	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
196		272
197	=item json => JSON or JSON::XS object	273	=item json => JSON or JSON::XS object
198		274
199	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.
200		276
201	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
202	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.
203		280
204	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
205	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
206		283
207	=item filter_r => $cb
208
209	=item filter_w => $cb
210
211	These exist, but are undocumented at this time.
212
213	=back	284	=back
214		285
215	=cut	286	=cut
216		287
217	sub new {	288	sub new {
…		…
221		292
222	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
223		294
224	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
225		296
226	if ($self->{tls}) {
227	require Net::SSLeay;
228	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
229	}	298	if $self->{tls};
230		299
231	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
232	$self->_timeout;	301	$self->_timeout;
233		302
234	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		304	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		305
		306	$self->start_read
		307	if $self->{on_read};
235		308
236	$self	309	$self
237	}	310	}
238		311
239	sub _shutdown {	312	sub _shutdown {
…		…
242	delete $self->{_tw};	315	delete $self->{_tw};
243	delete $self->{_rw};	316	delete $self->{_rw};
244	delete $self->{_ww};	317	delete $self->{_ww};
245	delete $self->{fh};	318	delete $self->{fh};
246		319
247	$self->stoptls;	320	&_freetls;
		321
		322	delete $self->{on_read};
		323	delete $self->{_queue};
248	}	324	}
249		325
250	sub _error {	326	sub _error {
251	my ($self, $errno, $fatal) = @_;	327	my ($self, $errno, $fatal) = @_;
252		328
…		…
255		331
256	$! = $errno;	332	$! = $errno;
257		333
258	if ($self->{on_error}) {	334	if ($self->{on_error}) {
259	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
260	} else {	336	} elsif ($self->{fh}) {
261	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
262	}	338	}
263	}	339	}
264		340
265	=item $fh = $handle->fh	341	=item $fh = $handle->fh
266		342
267	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.
268		344
269	=cut	345	=cut
270		346
271	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
272		348
…		…
290	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
291	}	367	}
292		368
293	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
294		370
295	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
296	(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
297	argument.	373	argument and method.
298		374
299	=cut	375	=cut
300		376
301	sub on_timeout {	377	sub on_timeout {
302	$_[0]{on_timeout} = $_[1];	378	$_[0]{on_timeout} = $_[1];
		379	}
		380
		381	=item $handle->autocork ($boolean)
		382
		383	Enables or disables the current autocork behaviour (see C<autocork>
		384	constructor argument). Changes will only take effect on the next write.
		385
		386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
		391
		392	=item $handle->no_delay ($boolean)
		393
		394	Enables or disables the C<no_delay> setting (see constructor argument of
		395	the same name for details).
		396
		397	=cut
		398
		399	sub no_delay {
		400	$_[0]{no_delay} = $_[1];
		401
		402	eval {
		403	local $SIG{__DIE__};
		404	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		405	};
303	}	406	}
304		407
305	#############################################################################	408	#############################################################################
306		409
307	=item $handle->timeout ($seconds)	410	=item $handle->timeout ($seconds)
…		…
385	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
386		489
387	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
388		491
389	$cb->($self)	492	$cb->($self)
390	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
391	}	494	}
392		495
393	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
394		497
395	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
…		…
412	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
413		516
414	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
415		518
416	$self->{on_drain}($self)	519	$self->{on_drain}($self)
417	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
418	&& $self->{on_drain};	521	&& $self->{on_drain};
419		522
420	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
421	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
422	$self->_error ($!, 1);	525	$self->_error ($!, 1);
423	}	526	}
424	};	527	};
425		528
426	# try to write data immediately	529	# try to write data immediately
427	$cb->();	530	$cb->() unless $self->{autocork};
428		531
429	# if still data left in wbuf, we need to poll	532	# if still data left in wbuf, we need to poll
430	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	533	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
431	if length $self->{wbuf};	534	if length $self->{wbuf};
432	};	535	};
…		…
446		549
447	@_ = ($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")
448	->($self, @_);	551	->($self, @_);
449	}	552	}
450		553
451	if ($self->{filter_w}) {	554	if ($self->{tls}) {
452	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
453	} else {	558	} else {
454	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
455	$self->_drain_wbuf;	560	$self->_drain_wbuf;
456	}	561	}
457	}	562	}
…		…
474	=cut	579	=cut
475		580
476	register_write_type netstring => sub {	581	register_write_type netstring => sub {
477	my ($self, $string) = @_;	582	my ($self, $string) = @_;
478		583
479	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
480	};	585	};
481		586
482	=item packstring => $format, $data	587	=item packstring => $format, $data
483		588
484	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>
…		…
489	=cut	594	=cut
490		595
491	register_write_type packstring => sub {	596	register_write_type packstring => sub {
492	my ($self, $format, $string) = @_;	597	my ($self, $format, $string) = @_;
493		598
494	pack "$format/a", $string	599	pack "$format/a*", $string
495	};	600	};
496		601
497	=item json => $array_or_hashref	602	=item json => $array_or_hashref
498		603
499	Encodes the given hash or array reference into a JSON object. Unless you	604	Encodes the given hash or array reference into a JSON object. Unless you
…		…
533		638
534	$self->{json} ? $self->{json}->encode ($ref)	639	$self->{json} ? $self->{json}->encode ($ref)
535	: JSON::encode_json ($ref)	640	: JSON::encode_json ($ref)
536	};	641	};
537		642
		643	=item storable => $reference
		644
		645	Freezes the given reference using L<Storable> and writes it to the
		646	handle. Uses the C<nfreeze> format.
		647
		648	=cut
		649
		650	register_write_type storable => sub {
		651	my ($self, $ref) = @_;
		652
		653	require Storable;
		654
		655	pack "w/a*", Storable::nfreeze ($ref)
		656	};
		657
538	=back	658	=back
539		659
540	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
541		661
542	This function (not method) lets you add your own types to C<push_write>.	662	This function (not method) lets you add your own types to C<push_write>.
…		…
564	ways, the "simple" way, using only C<on_read> and the "complex" way, using	684	ways, the "simple" way, using only C<on_read> and the "complex" way, using
565	a queue.	685	a queue.
566		686
567	In the simple case, you just install an C<on_read> callback and whenever	687	In the simple case, you just install an C<on_read> callback and whenever
568	new data arrives, it will be called. You can then remove some data (if	688	new data arrives, it will be called. You can then remove some data (if
569	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	689	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
570	or not.	690	leave the data there if you want to accumulate more (e.g. when only a
		691	partial message has been received so far).
571		692
572	In the more complex case, you want to queue multiple callbacks. In this	693	In the more complex case, you want to queue multiple callbacks. In this
573	case, AnyEvent::Handle will call the first queued callback each time new	694	case, AnyEvent::Handle will call the first queued callback each time new
574	data arrives (also the first time it is queued) and removes it when it has	695	data arrives (also the first time it is queued) and removes it when it has
575	done its job (see C<push_read>, below).	696	done its job (see C<push_read>, below).
…		…
593	# handle xml	714	# handle xml
594	});	715	});
595	});	716	});
596	});	717	});
597		718
598	Example 2: Implement a client for a protocol that replies either with	719	Example 2: Implement a client for a protocol that replies either with "OK"
599	"OK" and another line or "ERROR" for one request, and 64 bytes for the	720	and another line or "ERROR" for the first request that is sent, and 64
600	second request. Due tot he availability of a full queue, we can just	721	bytes for the second request. Due to the availability of a queue, we can
601	pipeline sending both requests and manipulate the queue as necessary in	722	just pipeline sending both requests and manipulate the queue as necessary
602	the callbacks:	723	in the callbacks.
603		724
604	# request one	725	When the first callback is called and sees an "OK" response, it will
		726	C<unshift> another line-read. This line-read will be queued I<before> the
		727	64-byte chunk callback.
		728
		729	# request one, returns either "OK + extra line" or "ERROR"
605	$handle->push_write ("request 1\015\012");	730	$handle->push_write ("request 1\015\012");
606		731
607	# we expect "ERROR" or "OK" as response, so push a line read	732	# we expect "ERROR" or "OK" as response, so push a line read
608	$handle->push_read (line => sub {	733	$handle->push_read (line => sub {
609	# if we got an "OK", we have to _prepend_ another line,	734	# if we got an "OK", we have to _prepend_ another line,
…		…
616	...	741	...
617	});	742	});
618	}	743	}
619	});	744	});
620		745
621	# request two	746	# request two, simply returns 64 octets
622	$handle->push_write ("request 2\015\012");	747	$handle->push_write ("request 2\015\012");
623		748
624	# simply read 64 bytes, always	749	# simply read 64 bytes, always
625	$handle->push_read (chunk => 64, sub {	750	$handle->push_read (chunk => 64, sub {
626	my $response = $_[1];	751	my $response = $_[1];
…		…
638		763
639	if (	764	if (
640	defined $self->{rbuf_max}	765	defined $self->{rbuf_max}
641	&& $self->{rbuf_max} < length $self->{rbuf}	766	&& $self->{rbuf_max} < length $self->{rbuf}
642	) {	767	) {
643	return $self->_error (&Errno::ENOSPC, 1);	768	$self->_error (&Errno::ENOSPC, 1), return;
644	}	769	}
645		770
646	while () {	771	while () {
647	no strict 'refs';	772	$self->{rbuf} .= delete $self->{tls_rbuf} if exists $self->{tls_rbuf};#d#
648		773
649	my $len = length $self->{rbuf};	774	my $len = length $self->{rbuf};
650		775
651	if (my $cb = shift @{ $self->{_queue} }) {	776	if (my $cb = shift @{ $self->{_queue} }) {
652	unless ($cb->($self)) {	777	unless ($cb->($self)) {
653	if ($self->{_eof}) {	778	if ($self->{_eof}) {
654	# no progress can be made (not enough data and no data forthcoming)	779	# no progress can be made (not enough data and no data forthcoming)
655	$self->_error (&Errno::EPIPE, 1), last;	780	$self->_error (&Errno::EPIPE, 1), return;
656	}	781	}
657		782
658	unshift @{ $self->{_queue} }, $cb;	783	unshift @{ $self->{_queue} }, $cb;
659	last;	784	last;
660	}	785	}
…		…
668	&& !@{ $self->{_queue} } # and the queue is still empty	793	&& !@{ $self->{_queue} } # and the queue is still empty
669	&& $self->{on_read} # but we still have on_read	794	&& $self->{on_read} # but we still have on_read
670	) {	795	) {
671	# no further data will arrive	796	# no further data will arrive
672	# so no progress can be made	797	# so no progress can be made
673	$self->_error (&Errno::EPIPE, 1), last	798	$self->_error (&Errno::EPIPE, 1), return
674	if $self->{_eof};	799	if $self->{_eof};
675		800
676	last; # more data might arrive	801	last; # more data might arrive
677	}	802	}
678	} else {	803	} else {
679	# read side becomes idle	804	# read side becomes idle
680	delete $self->{_rw};	805	delete $self->{_rw} unless $self->{tls};
681	last;	806	last;
682	}	807	}
683	}	808	}
684		809
		810	if ($self->{_eof}) {
		811	if ($self->{on_eof}) {
685	$self->{on_eof}($self)	812	$self->{on_eof}($self)
686	if $self->{_eof} && $self->{on_eof};	813	} else {
		814	$self->_error (0, 1);
		815	}
		816	}
687		817
688	# may need to restart read watcher	818	# may need to restart read watcher
689	unless ($self->{_rw}) {	819	unless ($self->{_rw}) {
690	$self->start_read	820	$self->start_read
691	if $self->{on_read} \|\| @{ $self->{_queue} };	821	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
817	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	947	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
818	1	948	1
819	}	949	}
820	};	950	};
821		951
822	# compatibility with older API
823	sub push_read_chunk {
824	$_[0]->push_read (chunk => $_[1], $_[2]);
825	}
826
827	sub unshift_read_chunk {
828	$_[0]->unshift_read (chunk => $_[1], $_[2]);
829	}
830
831	=item line => [$eol, ]$cb->($handle, $line, $eol)	952	=item line => [$eol, ]$cb->($handle, $line, $eol)
832		953
833	The callback will be called only once a full line (including the end of	954	The callback will be called only once a full line (including the end of
834	line marker, C<$eol>) has been read. This line (excluding the end of line	955	line marker, C<$eol>) has been read. This line (excluding the end of line
835	marker) will be passed to the callback as second argument (C<$line>), and	956	marker) will be passed to the callback as second argument (C<$line>), and
…		…
850	=cut	971	=cut
851		972
852	register_read_type line => sub {	973	register_read_type line => sub {
853	my ($self, $cb, $eol) = @_;	974	my ($self, $cb, $eol) = @_;
854		975
855	$eol = qr\|(\015?\012)\| if @_ < 3;	976	if (@_ < 3) {
		977	# this is more than twice as fast as the generic code below
		978	sub {
		979	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		980
		981	$cb->($_[0], $1, $2);
		982	1
		983	}
		984	} else {
856	$eol = quotemeta $eol unless ref $eol;	985	$eol = quotemeta $eol unless ref $eol;
857	$eol = qr\|^(.*?)($eol)\|s;	986	$eol = qr\|^(.*?)($eol)\|s;
858		987
859	sub {	988	sub {
860	$_[0]{rbuf} =~ s/$eol// or return;	989	$_[0]{rbuf} =~ s/$eol// or return;
861		990
862	$cb->($_[0], $1, $2);	991	$cb->($_[0], $1, $2);
		992	1
863	1	993	}
864	}	994	}
865	};	995	};
866
867	# compatibility with older API
868	sub push_read_line {
869	my $self = shift;
870	$self->push_read (line => @_);
871	}
872
873	sub unshift_read_line {
874	my $self = shift;
875	$self->unshift_read (line => @_);
876	}
877		996
878	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	997	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
879		998
880	Makes a regex match against the regex object C<$accept> and returns	999	Makes a regex match against the regex object C<$accept> and returns
881	everything up to and including the match.	1000	everything up to and including the match.
…		…
986	An octet string prefixed with an encoded length. The encoding C<$format>	1105	An octet string prefixed with an encoded length. The encoding C<$format>
987	uses the same format as a Perl C<pack> format, but must specify a single	1106	uses the same format as a Perl C<pack> format, but must specify a single
988	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1107	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
989	optional C<!>, C<< < >> or C<< > >> modifier).	1108	optional C<!>, C<< < >> or C<< > >> modifier).
990		1109
991	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1110	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1111	EPP uses a prefix of C<N> (4 octtes).
992		1112
993	Example: read a block of data prefixed by its length in BER-encoded	1113	Example: read a block of data prefixed by its length in BER-encoded
994	format (very efficient).	1114	format (very efficient).
995		1115
996	$handle->push_read (packstring => "w", sub {	1116	$handle->push_read (packstring => "w", sub {
…		…
1002	register_read_type packstring => sub {	1122	register_read_type packstring => sub {
1003	my ($self, $cb, $format) = @_;	1123	my ($self, $cb, $format) = @_;
1004		1124
1005	sub {	1125	sub {
1006	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1126	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1007	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1127	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1008	or return;	1128	or return;
1009		1129
		1130	$format = length pack $format, $len;
		1131
		1132	# bypass unshift if we already have the remaining chunk
		1133	if ($format + $len <= length $_[0]{rbuf}) {
		1134	my $data = substr $_[0]{rbuf}, $format, $len;
		1135	substr $_[0]{rbuf}, 0, $format + $len, "";
		1136	$cb->($_[0], $data);
		1137	} else {
1010	# remove prefix	1138	# remove prefix
1011	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1139	substr $_[0]{rbuf}, 0, $format, "";
1012		1140
1013	# read rest	1141	# read remaining chunk
1014	$_[0]->unshift_read (chunk => $len, $cb);	1142	$_[0]->unshift_read (chunk => $len, $cb);
		1143	}
1015		1144
1016	1	1145	1
1017	}	1146	}
1018	};	1147	};
1019		1148
1020	=item json => $cb->($handle, $hash_or_arrayref)	1149	=item json => $cb->($handle, $hash_or_arrayref)
1021		1150
1022	Reads a JSON object or array, decodes it and passes it to the callback.	1151	Reads a JSON object or array, decodes it and passes it to the
		1152	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1023		1153
1024	If a C<json> object was passed to the constructor, then that will be used	1154	If a C<json> object was passed to the constructor, then that will be used
1025	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1155	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1026		1156
1027	This read type uses the incremental parser available with JSON version	1157	This read type uses the incremental parser available with JSON version
…		…
1034	the C<json> write type description, above, for an actual example.	1164	the C<json> write type description, above, for an actual example.
1035		1165
1036	=cut	1166	=cut
1037		1167
1038	register_read_type json => sub {	1168	register_read_type json => sub {
1039	my ($self, $cb, $accept, $reject, $skip) = @_;	1169	my ($self, $cb) = @_;
1040		1170
1041	require JSON;	1171	require JSON;
1042		1172
1043	my $data;	1173	my $data;
1044	my $rbuf = \$self->{rbuf};	1174	my $rbuf = \$self->{rbuf};
1045		1175
1046	my $json = $self->{json} \|\|= JSON->new->utf8;	1176	my $json = $self->{json} \|\|= JSON->new->utf8;
1047		1177
1048	sub {	1178	sub {
1049	my $ref = $json->incr_parse ($self->{rbuf});	1179	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1050		1180
1051	if ($ref) {	1181	if ($ref) {
1052	$self->{rbuf} = $json->incr_text;	1182	$self->{rbuf} = $json->incr_text;
1053	$json->incr_text = "";	1183	$json->incr_text = "";
1054	$cb->($self, $ref);	1184	$cb->($self, $ref);
1055		1185
1056	1	1186	1
		1187	} elsif ($@) {
		1188	# error case
		1189	$json->incr_skip;
		1190
		1191	$self->{rbuf} = $json->incr_text;
		1192	$json->incr_text = "";
		1193
		1194	$self->_error (&Errno::EBADMSG);
		1195
		1196	()
1057	} else {	1197	} else {
1058	$self->{rbuf} = "";	1198	$self->{rbuf} = "";
		1199
1059	()	1200	()
1060	}	1201	}
		1202	}
		1203	};
		1204
		1205	=item storable => $cb->($handle, $ref)
		1206
		1207	Deserialises a L<Storable> frozen representation as written by the
		1208	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1209	data).
		1210
		1211	Raises C<EBADMSG> error if the data could not be decoded.
		1212
		1213	=cut
		1214
		1215	register_read_type storable => sub {
		1216	my ($self, $cb) = @_;
		1217
		1218	require Storable;
		1219
		1220	sub {
		1221	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1222	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1223	or return;
		1224
		1225	my $format = length pack "w", $len;
		1226
		1227	# bypass unshift if we already have the remaining chunk
		1228	if ($format + $len <= length $_[0]{rbuf}) {
		1229	my $data = substr $_[0]{rbuf}, $format, $len;
		1230	substr $_[0]{rbuf}, 0, $format + $len, "";
		1231	$cb->($_[0], Storable::thaw ($data));
		1232	} else {
		1233	# remove prefix
		1234	substr $_[0]{rbuf}, 0, $format, "";
		1235
		1236	# read remaining chunk
		1237	$_[0]->unshift_read (chunk => $len, sub {
		1238	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1239	$cb->($_[0], $ref);
		1240	} else {
		1241	$self->_error (&Errno::EBADMSG);
		1242	}
		1243	});
		1244	}
		1245
		1246	1
1061	}	1247	}
1062	};	1248	};
1063		1249
1064	=back	1250	=back
1065		1251
…		…
1095	Note that AnyEvent::Handle will automatically C<start_read> for you when	1281	Note that AnyEvent::Handle will automatically C<start_read> for you when
1096	you change the C<on_read> callback or push/unshift a read callback, and it	1282	you change the C<on_read> callback or push/unshift a read callback, and it
1097	will automatically C<stop_read> for you when neither C<on_read> is set nor	1283	will automatically C<stop_read> for you when neither C<on_read> is set nor
1098	there are any read requests in the queue.	1284	there are any read requests in the queue.
1099		1285
		1286	These methods will have no effect when in TLS mode (as TLS doesn't support
		1287	half-duplex connections).
		1288
1100	=cut	1289	=cut
1101		1290
1102	sub stop_read {	1291	sub stop_read {
1103	my ($self) = @_;	1292	my ($self) = @_;
1104		1293
1105	delete $self->{_rw};	1294	delete $self->{_rw} unless $self->{tls};
1106	}	1295	}
1107		1296
1108	sub start_read {	1297	sub start_read {
1109	my ($self) = @_;	1298	my ($self) = @_;
1110		1299
1111	unless ($self->{_rw} \|\| $self->{_eof}) {	1300	unless ($self->{_rw} \|\| $self->{_eof}) {
1112	Scalar::Util::weaken $self;	1301	Scalar::Util::weaken $self;
1113		1302
1114	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1303	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1115	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1304	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1116	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1305	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1117		1306
1118	if ($len > 0) {	1307	if ($len > 0) {
1119	$self->{_activity} = AnyEvent->now;	1308	$self->{_activity} = AnyEvent->now;
1120		1309
1121	$self->{filter_r}	1310	if ($self->{tls}) {
1122	? $self->{filter_r}($self, $rbuf)	1311	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1123	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1312
		1313	&_dotls ($self);
		1314	} else {
		1315	$self->_drain_rbuf unless $self->{_in_drain};
		1316	}
1124		1317
1125	} elsif (defined $len) {	1318	} elsif (defined $len) {
1126	delete $self->{_rw};	1319	delete $self->{_rw};
1127	$self->{_eof} = 1;	1320	$self->{_eof} = 1;
1128	$self->_drain_rbuf unless $self->{_in_drain};	1321	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1132	}	1325	}
1133	});	1326	});
1134	}	1327	}
1135	}	1328	}
1136		1329
		1330	# poll the write BIO and send the data if applicable
1137	sub _dotls {	1331	sub _dotls {
1138	my ($self) = @_;	1332	my ($self) = @_;
1139		1333
1140	my $buf;	1334	my $tmp;
1141		1335
1142	if (length $self->{_tls_wbuf}) {	1336	if (length $self->{_tls_wbuf}) {
1143	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1337	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1144	substr $self->{_tls_wbuf}, 0, $len, "";	1338	substr $self->{_tls_wbuf}, 0, $tmp, "";
1145	}	1339	}
1146	}	1340	}
1147		1341
1148	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1149	$self->{wbuf} .= $buf;
1150	$self->_drain_wbuf;
1151	}
1152
1153	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1342	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1154	if (length $buf) {	1343	unless (length $tmp) {
1155	$self->{rbuf} .= $buf;
1156	$self->_drain_rbuf unless $self->{_in_drain};
1157	} else {
1158	# let's treat SSL-eof as we treat normal EOF	1344	# let's treat SSL-eof as we treat normal EOF
		1345	delete $self->{_rw};
1159	$self->{_eof} = 1;	1346	$self->{_eof} = 1;
1160	$self->_shutdown;	1347	&_freetls;
1161	return;
1162	}	1348	}
1163	}
1164		1349
		1350	$self->{tls_rbuf} .= $tmp;#d#
		1351	$self->_drain_rbuf unless $self->{_in_drain};
		1352	$self->{tls} or return; # tls session might have gone away in callback
		1353	}
		1354
1165	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1355	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1166		1356
1167	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1357	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1168	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1358	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1169	return $self->_error ($!, 1);	1359	return $self->_error ($!, 1);
1170	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1360	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1171	return $self->_error (&Errno::EIO, 1);	1361	return $self->_error (&Errno::EIO, 1);
1172	}	1362	}
1173		1363
1174	# all others are fine for our purposes	1364	# all other errors are fine for our purposes
		1365	}
		1366
		1367	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1368	$self->{wbuf} .= $tmp;
		1369	$self->_drain_wbuf;
1175	}	1370	}
1176	}	1371	}
1177		1372
1178	=item $handle->starttls ($tls[, $tls_ctx])	1373	=item $handle->starttls ($tls[, $tls_ctx])
1179		1374
…		…
1189		1384
1190	The TLS connection object will end up in C<< $handle->{tls} >> after this	1385	The TLS connection object will end up in C<< $handle->{tls} >> after this
1191	call and can be used or changed to your liking. Note that the handshake	1386	call and can be used or changed to your liking. Note that the handshake
1192	might have already started when this function returns.	1387	might have already started when this function returns.
1193		1388
		1389	If it an error to start a TLS handshake more than once per
		1390	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1391
1194	=cut	1392	=cut
1195		1393
1196	sub starttls {	1394	sub starttls {
1197	my ($self, $ssl, $ctx) = @_;	1395	my ($self, $ssl, $ctx) = @_;
1198		1396
1199	$self->stoptls;	1397	require Net::SSLeay;
1200		1398
		1399	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1400	if $self->{tls};
		1401
1201	if ($ssl eq "accept") {	1402	if ($ssl eq "accept") {
1202	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1403	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1203	Net::SSLeay::set_accept_state ($ssl);	1404	Net::SSLeay::set_accept_state ($ssl);
1204	} elsif ($ssl eq "connect") {	1405	} elsif ($ssl eq "connect") {
1205	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1406	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1211	# basically, this is deep magic (because SSL_read should have the same issues)	1412	# basically, this is deep magic (because SSL_read should have the same issues)
1212	# but the openssl maintainers basically said: "trust us, it just works".	1413	# but the openssl maintainers basically said: "trust us, it just works".
1213	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1414	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1214	# and mismaintained ssleay-module doesn't even offer them).	1415	# and mismaintained ssleay-module doesn't even offer them).
1215	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1416	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1417	#
		1418	# in short: this is a mess.
		1419	#
		1420	# note that we do not try to keep the length constant between writes as we are required to do.
		1421	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1422	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1423	# have identity issues in that area.
1216	Net::SSLeay::CTX_set_mode ($self->{tls},	1424	Net::SSLeay::CTX_set_mode ($self->{tls},
1217	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1425	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1218	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1426	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1219		1427
1220	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1221	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1222		1430
1223	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1431	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1224		1432
1225	$self->{filter_w} = sub {	1433	&_dotls; # need to trigger the initial handshake
1226	$_[0]{_tls_wbuf} .= ${$_[1]};	1434	$self->start_read; # make sure we actually do read
1227	&_dotls;
1228	};
1229	$self->{filter_r} = sub {
1230	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1231	&_dotls;
1232	};
1233	}	1435	}
1234		1436
1235	=item $handle->stoptls	1437	=item $handle->stoptls
1236		1438
1237	Destroys the SSL connection, if any. Partial read or write data will be	1439	Shuts down the SSL connection - this makes a proper EOF handshake by
1238	lost.	1440	sending a close notify to the other side, but since OpenSSL doesn't
		1441	support non-blocking shut downs, it is not possible to re-use the stream
		1442	afterwards.
1239		1443
1240	=cut	1444	=cut
1241		1445
1242	sub stoptls {	1446	sub stoptls {
1243	my ($self) = @_;	1447	my ($self) = @_;
1244		1448
		1449	if ($self->{tls}) {
		1450	Net::SSLeay::shutdown ($self->{tls});
		1451
		1452	&_dotls;
		1453
		1454	# we don't give a shit. no, we do, but we can't. no...
		1455	# we, we... have to use openssl :/
		1456	&_freetls;
		1457	}
		1458	}
		1459
		1460	sub _freetls {
		1461	my ($self) = @_;
		1462
		1463	return unless $self->{tls};
		1464
1245	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1465	Net::SSLeay::free (delete $self->{tls});
1246		1466
1247	delete $self->{_rbio};	1467	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1248	delete $self->{_wbio};
1249	delete $self->{_tls_wbuf};
1250	delete $self->{filter_r};
1251	delete $self->{filter_w};
1252	}	1468	}
1253		1469
1254	sub DESTROY {	1470	sub DESTROY {
1255	my $self = shift;	1471	my $self = shift;
1256		1472
1257	$self->stoptls;	1473	&_freetls;
		1474
		1475	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1476
		1477	if ($linger && length $self->{wbuf}) {
		1478	my $fh = delete $self->{fh};
		1479	my $wbuf = delete $self->{wbuf};
		1480
		1481	my @linger;
		1482
		1483	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1484	my $len = syswrite $fh, $wbuf, length $wbuf;
		1485
		1486	if ($len > 0) {
		1487	substr $wbuf, 0, $len, "";
		1488	} else {
		1489	@linger = (); # end
		1490	}
		1491	});
		1492	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1493	@linger = ();
		1494	});
		1495	}
		1496	}
		1497
		1498	=item $handle->destroy
		1499
		1500	Shuts down the handle object as much as possible - this call ensures that
		1501	no further callbacks will be invoked and resources will be freed as much
		1502	as possible. You must not call any methods on the object afterwards.
		1503
		1504	Normally, you can just "forget" any references to an AnyEvent::Handle
		1505	object and it will simply shut down. This works in fatal error and EOF
		1506	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1507	callback, so when you want to destroy the AnyEvent::Handle object from
		1508	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1509	that case.
		1510
		1511	The handle might still linger in the background and write out remaining
		1512	data, as specified by the C<linger> option, however.
		1513
		1514	=cut
		1515
		1516	sub destroy {
		1517	my ($self) = @_;
		1518
		1519	$self->DESTROY;
		1520	%$self = ();
1258	}	1521	}
1259		1522
1260	=item AnyEvent::Handle::TLS_CTX	1523	=item AnyEvent::Handle::TLS_CTX
1261		1524
1262	This function creates and returns the Net::SSLeay::CTX object used by	1525	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1292	}	1555	}
1293	}	1556	}
1294		1557
1295	=back	1558	=back
1296		1559
		1560
		1561	=head1 NONFREQUENTLY ASKED QUESTIONS
		1562
		1563	=over 4
		1564
		1565	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1566	still get further invocations!
		1567
		1568	That's because AnyEvent::Handle keeps a reference to itself when handling
		1569	read or write callbacks.
		1570
		1571	It is only safe to "forget" the reference inside EOF or error callbacks,
		1572	from within all other callbacks, you need to explicitly call the C<<
		1573	->destroy >> method.
		1574
		1575	=item I get different callback invocations in TLS mode/Why can't I pause
		1576	reading?
		1577
		1578	Unlike, say, TCP, TLS connections do not consist of two independent
		1579	communication channels, one for each direction. Or put differently. The
		1580	read and write directions are not independent of each other: you cannot
		1581	write data unless you are also prepared to read, and vice versa.
		1582
		1583	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1584	callback invocations when you are not expecting any read data - the reason
		1585	is that AnyEvent::Handle always reads in TLS mode.
		1586
		1587	During the connection, you have to make sure that you always have a
		1588	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1589	connection (or when you no longer want to use it) you can call the
		1590	C<destroy> method.
		1591
		1592	=item How do I read data until the other side closes the connection?
		1593
		1594	If you just want to read your data into a perl scalar, the easiest way
		1595	to achieve this is by setting an C<on_read> callback that does nothing,
		1596	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1597	will be in C<$_[0]{rbuf}>:
		1598
		1599	$handle->on_read (sub { });
		1600	$handle->on_eof (undef);
		1601	$handle->on_error (sub {
		1602	my $data = delete $_[0]{rbuf};
		1603	undef $handle;
		1604	});
		1605
		1606	The reason to use C<on_error> is that TCP connections, due to latencies
		1607	and packets loss, might get closed quite violently with an error, when in
		1608	fact, all data has been received.
		1609
		1610	It is usually better to use acknowledgements when transferring data,
		1611	to make sure the other side hasn't just died and you got the data
		1612	intact. This is also one reason why so many internet protocols have an
		1613	explicit QUIT command.
		1614
		1615	=item I don't want to destroy the handle too early - how do I wait until
		1616	all data has been written?
		1617
		1618	After writing your last bits of data, set the C<on_drain> callback
		1619	and destroy the handle in there - with the default setting of
		1620	C<low_water_mark> this will be called precisely when all data has been
		1621	written to the socket:
		1622
		1623	$handle->push_write (...);
		1624	$handle->on_drain (sub {
		1625	warn "all data submitted to the kernel\n";
		1626	undef $handle;
		1627	});
		1628
		1629	=back
		1630
		1631
1297	=head1 SUBCLASSING AnyEvent::Handle	1632	=head1 SUBCLASSING AnyEvent::Handle
1298		1633
1299	In many cases, you might want to subclass AnyEvent::Handle.	1634	In many cases, you might want to subclass AnyEvent::Handle.
1300		1635
1301	To make this easier, a given version of AnyEvent::Handle uses these	1636	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1304	=over 4	1639	=over 4
1305		1640
1306	=item * all constructor arguments become object members.	1641	=item * all constructor arguments become object members.
1307		1642
1308	At least initially, when you pass a C<tls>-argument to the constructor it	1643	At least initially, when you pass a C<tls>-argument to the constructor it
1309	will end up in C<< $handle->{tls} >>. Those members might be changes or	1644	will end up in C<< $handle->{tls} >>. Those members might be changed or
1310	mutated later on (for example C<tls> will hold the TLS connection object).	1645	mutated later on (for example C<tls> will hold the TLS connection object).
1311		1646
1312	=item * other object member names are prefixed with an C<_>.	1647	=item * other object member names are prefixed with an C<_>.
1313		1648
1314	All object members not explicitly documented (internal use) are prefixed	1649	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC vs. Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC