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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.58 by root, Wed Jun 4 22:51:15 2008 UTC vs.
Revision 1.108 by root, Tue Jan 6 20:08:05 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.13;	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
…		…
105	C<croak>.	122	C<croak>.
106		123
107	=item on_read => $cb->($handle)	124	=item on_read => $cb->($handle)
108		125
109	This sets the default read callback, which is called when data arrives	126	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue.	127	and no read request is in the queue (unlike read queue callbacks, this
		128	callback will only be called when at least one octet of data is in the
		129	read buffer).
111		130
112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113	method or access the C<$handle->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
114		133
115	When an EOF condition is detected then AnyEvent::Handle will first try to	134	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
122	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
123	(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).
124		143
125	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.
126		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
127	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
128		153
129	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
130	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
131	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
132	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
133		158
134	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
135	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
136	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
137	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
138		164
139	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
140		166
141	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
142		168
…		…
146		172
147	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
148		174
149	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>)
150	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
151	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
152		178
153	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
154	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
155	(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
156	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
157	isn't finished).	183	isn't finished).
158		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
159	=item read_size => <bytes>	211	=item read_size => <bytes>
160		212
161	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
162	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
163		216
164	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
165		218
166	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
167	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
168	considered empty.	221	considered empty.
169		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
170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
171		241
172	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
173	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
174	data.	244	established and will transparently encrypt/decrypt data afterwards.
175		245
176	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
177	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.
178		250
179	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
180	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
181		254
182	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
183	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>
184	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
185	AnyEvent::Handle.	258	AnyEvent::Handle.
186		259
187	See the C<starttls> method if you need to start TLs negotiation later.	260	See the C<< ->starttls >> method for when need to start TLS negotiation later.
188		261
189	=item tls_ctx => $ssl_ctx	262	=item tls_ctx => $ssl_ctx
190		263
191	Use the given Net::SSLeay::CTX object to create the new TLS connection	264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
192	(unless a connection object was specified directly). If this parameter is	265	(unless a connection object was specified directly). If this parameter is
193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
194		267
195	=item json => JSON or JSON::XS object	268	=item json => JSON or JSON::XS object
196		269
197	This is the json coder object used by the C<json> read and write types.	270	This is the json coder object used by the C<json> read and write types.
198		271
199	If you don't supply it, then AnyEvent::Handle will create and use a	272	If you don't supply it, then AnyEvent::Handle will create and use a
200	suitable one, which will write and expect UTF-8 encoded JSON texts.	273	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		274	texts.
201		275
202	Note that you are responsible to depend on the JSON module if you want to	276	Note that you are responsible to depend on the JSON module if you want to
203	use this functionality, as AnyEvent does not have a dependency itself.	277	use this functionality, as AnyEvent does not have a dependency itself.
204		278
205	=item filter_r => $cb
206
207	=item filter_w => $cb
208
209	These exist, but are undocumented at this time.
210
211	=back	279	=back
212		280
213	=cut	281	=cut
214		282
215	sub new {	283	sub new {
…		…
219		287
220	$self->{fh} or Carp::croak "mandatory argument fh is missing";	288	$self->{fh} or Carp::croak "mandatory argument fh is missing";
221		289
222	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
223		291
224	if ($self->{tls}) {
225	require Net::SSLeay;
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
227	}	293	if $self->{tls};
228		294
229	$self->{_activity} = AnyEvent->now;	295	$self->{_activity} = AnyEvent->now;
230	$self->_timeout;	296	$self->_timeout;
231		297
232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
233	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		300
		301	$self->start_read
		302	if $self->{on_read};
234		303
235	$self	304	$self
236	}	305	}
237		306
238	sub _shutdown {	307	sub _shutdown {
…		…
241	delete $self->{_tw};	310	delete $self->{_tw};
242	delete $self->{_rw};	311	delete $self->{_rw};
243	delete $self->{_ww};	312	delete $self->{_ww};
244	delete $self->{fh};	313	delete $self->{fh};
245		314
246	$self->stoptls;	315	&_freetls;
		316
		317	delete $self->{on_read};
		318	delete $self->{_queue};
247	}	319	}
248		320
249	sub _error {	321	sub _error {
250	my ($self, $errno, $fatal) = @_;	322	my ($self, $errno, $fatal) = @_;
251		323
…		…
254		326
255	$! = $errno;	327	$! = $errno;
256		328
257	if ($self->{on_error}) {	329	if ($self->{on_error}) {
258	$self->{on_error}($self, $fatal);	330	$self->{on_error}($self, $fatal);
259	} else {	331	} elsif ($self->{fh}) {
260	Carp::croak "AnyEvent::Handle uncaught error: $!";	332	Carp::croak "AnyEvent::Handle uncaught error: $!";
261	}	333	}
262	}	334	}
263		335
264	=item $fh = $handle->fh	336	=item $fh = $handle->fh
265		337
266	This method returns the file handle of the L<AnyEvent::Handle> object.	338	This method returns the file handle used to create the L<AnyEvent::Handle> object.
267		339
268	=cut	340	=cut
269		341
270	sub fh { $_[0]{fh} }	342	sub fh { $_[0]{fh} }
271		343
…		…
289	$_[0]{on_eof} = $_[1];	361	$_[0]{on_eof} = $_[1];
290	}	362	}
291		363
292	=item $handle->on_timeout ($cb)	364	=item $handle->on_timeout ($cb)
293		365
294	Replace the current C<on_timeout> callback, or disables the callback	366	Replace the current C<on_timeout> callback, or disables the callback (but
295	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	367	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
296	argument.	368	argument and method.
297		369
298	=cut	370	=cut
299		371
300	sub on_timeout {	372	sub on_timeout {
301	$_[0]{on_timeout} = $_[1];	373	$_[0]{on_timeout} = $_[1];
		374	}
		375
		376	=item $handle->autocork ($boolean)
		377
		378	Enables or disables the current autocork behaviour (see C<autocork>
		379	constructor argument). Changes will only take effect on the next write.
		380
		381	=cut
		382
		383	sub autocork {
		384	$_[0]{autocork} = $_[1];
		385	}
		386
		387	=item $handle->no_delay ($boolean)
		388
		389	Enables or disables the C<no_delay> setting (see constructor argument of
		390	the same name for details).
		391
		392	=cut
		393
		394	sub no_delay {
		395	$_[0]{no_delay} = $_[1];
		396
		397	eval {
		398	local $SIG{__DIE__};
		399	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		400	};
302	}	401	}
303		402
304	#############################################################################	403	#############################################################################
305		404
306	=item $handle->timeout ($seconds)	405	=item $handle->timeout ($seconds)
…		…
384	my ($self, $cb) = @_;	483	my ($self, $cb) = @_;
385		484
386	$self->{on_drain} = $cb;	485	$self->{on_drain} = $cb;
387		486
388	$cb->($self)	487	$cb->($self)
389	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	488	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
390	}	489	}
391		490
392	=item $handle->push_write ($data)	491	=item $handle->push_write ($data)
393		492
394	Queues the given scalar to be written. You can push as much data as you	493	Queues the given scalar to be written. You can push as much data as you
…		…
411	substr $self->{wbuf}, 0, $len, "";	510	substr $self->{wbuf}, 0, $len, "";
412		511
413	$self->{_activity} = AnyEvent->now;	512	$self->{_activity} = AnyEvent->now;
414		513
415	$self->{on_drain}($self)	514	$self->{on_drain}($self)
416	if $self->{low_water_mark} >= length $self->{wbuf}	515	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
417	&& $self->{on_drain};	516	&& $self->{on_drain};
418		517
419	delete $self->{_ww} unless length $self->{wbuf};	518	delete $self->{_ww} unless length $self->{wbuf};
420	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	519	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
421	$self->_error ($!, 1);	520	$self->_error ($!, 1);
422	}	521	}
423	};	522	};
424		523
425	# try to write data immediately	524	# try to write data immediately
426	$cb->();	525	$cb->() unless $self->{autocork};
427		526
428	# if still data left in wbuf, we need to poll	527	# if still data left in wbuf, we need to poll
429	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	528	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
430	if length $self->{wbuf};	529	if length $self->{wbuf};
431	};	530	};
…		…
445		544
446	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	545	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
447	->($self, @_);	546	->($self, @_);
448	}	547	}
449		548
450	if ($self->{filter_w}) {	549	if ($self->{tls}) {
451	$self->{filter_w}($self, \$_[0]);	550	$self->{_tls_wbuf} .= $_[0];
		551
		552	&_dotls ($self);
452	} else {	553	} else {
453	$self->{wbuf} .= $_[0];	554	$self->{wbuf} .= $_[0];
454	$self->_drain_wbuf;	555	$self->_drain_wbuf;
455	}	556	}
456	}	557	}
…		…
473	=cut	574	=cut
474		575
475	register_write_type netstring => sub {	576	register_write_type netstring => sub {
476	my ($self, $string) = @_;	577	my ($self, $string) = @_;
477		578
478	sprintf "%d:%s,", (length $string), $string	579	(length $string) . ":$string,"
		580	};
		581
		582	=item packstring => $format, $data
		583
		584	An octet string prefixed with an encoded length. The encoding C<$format>
		585	uses the same format as a Perl C<pack> format, but must specify a single
		586	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		587	optional C<!>, C<< < >> or C<< > >> modifier).
		588
		589	=cut
		590
		591	register_write_type packstring => sub {
		592	my ($self, $format, $string) = @_;
		593
		594	pack "$format/a*", $string
479	};	595	};
480		596
481	=item json => $array_or_hashref	597	=item json => $array_or_hashref
482		598
483	Encodes the given hash or array reference into a JSON object. Unless you	599	Encodes the given hash or array reference into a JSON object. Unless you
…		…
517		633
518	$self->{json} ? $self->{json}->encode ($ref)	634	$self->{json} ? $self->{json}->encode ($ref)
519	: JSON::encode_json ($ref)	635	: JSON::encode_json ($ref)
520	};	636	};
521		637
		638	=item storable => $reference
		639
		640	Freezes the given reference using L<Storable> and writes it to the
		641	handle. Uses the C<nfreeze> format.
		642
		643	=cut
		644
		645	register_write_type storable => sub {
		646	my ($self, $ref) = @_;
		647
		648	require Storable;
		649
		650	pack "w/a*", Storable::nfreeze ($ref)
		651	};
		652
522	=back	653	=back
523		654
524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	655	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525		656
526	This function (not method) lets you add your own types to C<push_write>.	657	This function (not method) lets you add your own types to C<push_write>.
…		…
548	ways, the "simple" way, using only C<on_read> and the "complex" way, using	679	ways, the "simple" way, using only C<on_read> and the "complex" way, using
549	a queue.	680	a queue.
550		681
551	In the simple case, you just install an C<on_read> callback and whenever	682	In the simple case, you just install an C<on_read> callback and whenever
552	new data arrives, it will be called. You can then remove some data (if	683	new data arrives, it will be called. You can then remove some data (if
553	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	684	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
554	or not.	685	leave the data there if you want to accumulate more (e.g. when only a
		686	partial message has been received so far).
555		687
556	In the more complex case, you want to queue multiple callbacks. In this	688	In the more complex case, you want to queue multiple callbacks. In this
557	case, AnyEvent::Handle will call the first queued callback each time new	689	case, AnyEvent::Handle will call the first queued callback each time new
558	data arrives and removes it when it has done its job (see C<push_read>,	690	data arrives (also the first time it is queued) and removes it when it has
559	below).	691	done its job (see C<push_read>, below).
560		692
561	This way you can, for example, push three line-reads, followed by reading	693	This way you can, for example, push three line-reads, followed by reading
562	a chunk of data, and AnyEvent::Handle will execute them in order.	694	a chunk of data, and AnyEvent::Handle will execute them in order.
563		695
564	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	696	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
…		…
577	# handle xml	709	# handle xml
578	});	710	});
579	});	711	});
580	});	712	});
581		713
582	Example 2: Implement a client for a protocol that replies either with	714	Example 2: Implement a client for a protocol that replies either with "OK"
583	"OK" and another line or "ERROR" for one request, and 64 bytes for the	715	and another line or "ERROR" for the first request that is sent, and 64
584	second request. Due tot he availability of a full queue, we can just	716	bytes for the second request. Due to the availability of a queue, we can
585	pipeline sending both requests and manipulate the queue as necessary in	717	just pipeline sending both requests and manipulate the queue as necessary
586	the callbacks:	718	in the callbacks.
587		719
588	# request one	720	When the first callback is called and sees an "OK" response, it will
		721	C<unshift> another line-read. This line-read will be queued I<before> the
		722	64-byte chunk callback.
		723
		724	# request one, returns either "OK + extra line" or "ERROR"
589	$handle->push_write ("request 1\015\012");	725	$handle->push_write ("request 1\015\012");
590		726
591	# we expect "ERROR" or "OK" as response, so push a line read	727	# we expect "ERROR" or "OK" as response, so push a line read
592	$handle->push_read (line => sub {	728	$handle->push_read (line => sub {
593	# if we got an "OK", we have to _prepend_ another line,	729	# if we got an "OK", we have to _prepend_ another line,
…		…
600	...	736	...
601	});	737	});
602	}	738	}
603	});	739	});
604		740
605	# request two	741	# request two, simply returns 64 octets
606	$handle->push_write ("request 2\015\012");	742	$handle->push_write ("request 2\015\012");
607		743
608	# simply read 64 bytes, always	744	# simply read 64 bytes, always
609	$handle->push_read (chunk => 64, sub {	745	$handle->push_read (chunk => 64, sub {
610	my $response = $_[1];	746	my $response = $_[1];
…		…
616	=cut	752	=cut
617		753
618	sub _drain_rbuf {	754	sub _drain_rbuf {
619	my ($self) = @_;	755	my ($self) = @_;
620		756
		757	local $self->{_in_drain} = 1;
		758
621	if (	759	if (
622	defined $self->{rbuf_max}	760	defined $self->{rbuf_max}
623	&& $self->{rbuf_max} < length $self->{rbuf}	761	&& $self->{rbuf_max} < length $self->{rbuf}
624	) {	762	) {
625	return $self->_error (&Errno::ENOSPC, 1);	763	$self->_error (&Errno::ENOSPC, 1), return;
626	}	764	}
627		765
628	return if $self->{in_drain};	766	while () {
629	local $self->{in_drain} = 1;
630
631	while (my $len = length $self->{rbuf}) {	767	my $len = length $self->{rbuf};
632	no strict 'refs';	768
633	if (my $cb = shift @{ $self->{_queue} }) {	769	if (my $cb = shift @{ $self->{_queue} }) {
634	unless ($cb->($self)) {	770	unless ($cb->($self)) {
635	if ($self->{_eof}) {	771	if ($self->{_eof}) {
636	# no progress can be made (not enough data and no data forthcoming)	772	# no progress can be made (not enough data and no data forthcoming)
637	return $self->_error (&Errno::EPIPE, 1);	773	$self->_error (&Errno::EPIPE, 1), return;
638	}	774	}
639		775
640	unshift @{ $self->{_queue} }, $cb;	776	unshift @{ $self->{_queue} }, $cb;
641	last;	777	last;
642	}	778	}
643	} elsif ($self->{on_read}) {	779	} elsif ($self->{on_read}) {
		780	last unless $len;
		781
644	$self->{on_read}($self);	782	$self->{on_read}($self);
645		783
646	if (	784	if (
647	$len == length $self->{rbuf} # if no data has been consumed	785	$len == length $self->{rbuf} # if no data has been consumed
648	&& !@{ $self->{_queue} } # and the queue is still empty	786	&& !@{ $self->{_queue} } # and the queue is still empty
649	&& $self->{on_read} # but we still have on_read	787	&& $self->{on_read} # but we still have on_read
650	) {	788	) {
651	# no further data will arrive	789	# no further data will arrive
652	# so no progress can be made	790	# so no progress can be made
653	return $self->_error (&Errno::EPIPE, 1)	791	$self->_error (&Errno::EPIPE, 1), return
654	if $self->{_eof};	792	if $self->{_eof};
655		793
656	last; # more data might arrive	794	last; # more data might arrive
657	}	795	}
658	} else {	796	} else {
659	# read side becomes idle	797	# read side becomes idle
660	delete $self->{_rw};	798	delete $self->{_rw} unless $self->{tls};
661	last;	799	last;
662	}	800	}
663	}	801	}
664		802
		803	if ($self->{_eof}) {
		804	if ($self->{on_eof}) {
665	$self->{on_eof}($self)	805	$self->{on_eof}($self)
666	if $self->{_eof} && $self->{on_eof};	806	} else {
		807	$self->_error (0, 1);
		808	}
		809	}
667		810
668	# may need to restart read watcher	811	# may need to restart read watcher
669	unless ($self->{_rw}) {	812	unless ($self->{_rw}) {
670	$self->start_read	813	$self->start_read
671	if $self->{on_read} \|\| @{ $self->{_queue} };	814	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
682		825
683	sub on_read {	826	sub on_read {
684	my ($self, $cb) = @_;	827	my ($self, $cb) = @_;
685		828
686	$self->{on_read} = $cb;	829	$self->{on_read} = $cb;
687	$self->_drain_rbuf if $cb;	830	$self->_drain_rbuf if $cb && !$self->{_in_drain};
688	}	831	}
689		832
690	=item $handle->rbuf	833	=item $handle->rbuf
691		834
692	Returns the read buffer (as a modifiable lvalue).	835	Returns the read buffer (as a modifiable lvalue).
…		…
741	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	884	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
742	->($self, $cb, @_);	885	->($self, $cb, @_);
743	}	886	}
744		887
745	push @{ $self->{_queue} }, $cb;	888	push @{ $self->{_queue} }, $cb;
746	$self->_drain_rbuf;	889	$self->_drain_rbuf unless $self->{_in_drain};
747	}	890	}
748		891
749	sub unshift_read {	892	sub unshift_read {
750	my $self = shift;	893	my $self = shift;
751	my $cb = pop;	894	my $cb = pop;
…		…
757	->($self, $cb, @_);	900	->($self, $cb, @_);
758	}	901	}
759		902
760		903
761	unshift @{ $self->{_queue} }, $cb;	904	unshift @{ $self->{_queue} }, $cb;
762	$self->_drain_rbuf;	905	$self->_drain_rbuf unless $self->{_in_drain};
763	}	906	}
764		907
765	=item $handle->push_read (type => @args, $cb)	908	=item $handle->push_read (type => @args, $cb)
766		909
767	=item $handle->unshift_read (type => @args, $cb)	910	=item $handle->unshift_read (type => @args, $cb)
…		…
797	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	940	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
798	1	941	1
799	}	942	}
800	};	943	};
801		944
802	# compatibility with older API
803	sub push_read_chunk {
804	$_[0]->push_read (chunk => $_[1], $_[2]);
805	}
806
807	sub unshift_read_chunk {
808	$_[0]->unshift_read (chunk => $_[1], $_[2]);
809	}
810
811	=item line => [$eol, ]$cb->($handle, $line, $eol)	945	=item line => [$eol, ]$cb->($handle, $line, $eol)
812		946
813	The callback will be called only once a full line (including the end of	947	The callback will be called only once a full line (including the end of
814	line marker, C<$eol>) has been read. This line (excluding the end of line	948	line marker, C<$eol>) has been read. This line (excluding the end of line
815	marker) will be passed to the callback as second argument (C<$line>), and	949	marker) will be passed to the callback as second argument (C<$line>), and
…		…
830	=cut	964	=cut
831		965
832	register_read_type line => sub {	966	register_read_type line => sub {
833	my ($self, $cb, $eol) = @_;	967	my ($self, $cb, $eol) = @_;
834		968
835	$eol = qr\|(\015?\012)\| if @_ < 3;	969	if (@_ < 3) {
836	$eol = quotemeta $eol unless ref $eol;	970	# this is more than twice as fast as the generic code below
837	$eol = qr\|^(.*?)($eol)\|s;
838
839	sub {	971	sub {
840	$_[0]{rbuf} =~ s/$eol// or return;	972	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
841		973
842	$cb->($_[0], $1, $2);	974	$cb->($_[0], $1, $2);
843	1
844	}
845	};
846
847	# compatibility with older API
848	sub push_read_line {
849	my $self = shift;
850	$self->push_read (line => @_);
851	}
852
853	sub unshift_read_line {
854	my $self = shift;
855	$self->unshift_read (line => @_);
856	}
857
858	=item netstring => $cb->($handle, $string)
859
860	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
861
862	Throws an error with C<$!> set to EBADMSG on format violations.
863
864	=cut
865
866	register_read_type netstring => sub {
867	my ($self, $cb) = @_;
868
869	sub {
870	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
871	if ($_[0]{rbuf} =~ /[^0-9]/) {
872	$self->_error (&Errno::EBADMSG);
873	}	975	1
874	return;
875	}	976	}
		977	} else {
		978	$eol = quotemeta $eol unless ref $eol;
		979	$eol = qr\|^(.*?)($eol)\|s;
876		980
877	my $len = $1;	981	sub {
		982	$_[0]{rbuf} =~ s/$eol// or return;
878		983
879	$self->unshift_read (chunk => $len, sub {	984	$cb->($_[0], $1, $2);
880	my $string = $_[1];
881	$_[0]->unshift_read (chunk => 1, sub {
882	if ($_[1] eq ",") {
883	$cb->($_[0], $string);
884	} else {
885	$self->_error (&Errno::EBADMSG);
886	}
887	});	985	1
888	});	986	}
889
890	1
891	}	987	}
892	};	988	};
893		989
894	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	990	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
895		991
…		…
959		1055
960	()	1056	()
961	}	1057	}
962	};	1058	};
963		1059
		1060	=item netstring => $cb->($handle, $string)
		1061
		1062	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1063
		1064	Throws an error with C<$!> set to EBADMSG on format violations.
		1065
		1066	=cut
		1067
		1068	register_read_type netstring => sub {
		1069	my ($self, $cb) = @_;
		1070
		1071	sub {
		1072	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1073	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1074	$self->_error (&Errno::EBADMSG);
		1075	}
		1076	return;
		1077	}
		1078
		1079	my $len = $1;
		1080
		1081	$self->unshift_read (chunk => $len, sub {
		1082	my $string = $_[1];
		1083	$_[0]->unshift_read (chunk => 1, sub {
		1084	if ($_[1] eq ",") {
		1085	$cb->($_[0], $string);
		1086	} else {
		1087	$self->_error (&Errno::EBADMSG);
		1088	}
		1089	});
		1090	});
		1091
		1092	1
		1093	}
		1094	};
		1095
		1096	=item packstring => $format, $cb->($handle, $string)
		1097
		1098	An octet string prefixed with an encoded length. The encoding C<$format>
		1099	uses the same format as a Perl C<pack> format, but must specify a single
		1100	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1101	optional C<!>, C<< < >> or C<< > >> modifier).
		1102
		1103	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1104	EPP uses a prefix of C<N> (4 octtes).
		1105
		1106	Example: read a block of data prefixed by its length in BER-encoded
		1107	format (very efficient).
		1108
		1109	$handle->push_read (packstring => "w", sub {
		1110	my ($handle, $data) = @_;
		1111	});
		1112
		1113	=cut
		1114
		1115	register_read_type packstring => sub {
		1116	my ($self, $cb, $format) = @_;
		1117
		1118	sub {
		1119	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1120	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1121	or return;
		1122
		1123	$format = length pack $format, $len;
		1124
		1125	# bypass unshift if we already have the remaining chunk
		1126	if ($format + $len <= length $_[0]{rbuf}) {
		1127	my $data = substr $_[0]{rbuf}, $format, $len;
		1128	substr $_[0]{rbuf}, 0, $format + $len, "";
		1129	$cb->($_[0], $data);
		1130	} else {
		1131	# remove prefix
		1132	substr $_[0]{rbuf}, 0, $format, "";
		1133
		1134	# read remaining chunk
		1135	$_[0]->unshift_read (chunk => $len, $cb);
		1136	}
		1137
		1138	1
		1139	}
		1140	};
		1141
964	=item json => $cb->($handle, $hash_or_arrayref)	1142	=item json => $cb->($handle, $hash_or_arrayref)
965		1143
966	Reads a JSON object or array, decodes it and passes it to the callback.	1144	Reads a JSON object or array, decodes it and passes it to the callback.
967		1145
968	If a C<json> object was passed to the constructor, then that will be used	1146	If a C<json> object was passed to the constructor, then that will be used
…		…
978	the C<json> write type description, above, for an actual example.	1156	the C<json> write type description, above, for an actual example.
979		1157
980	=cut	1158	=cut
981		1159
982	register_read_type json => sub {	1160	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1161	my ($self, $cb) = @_;
984		1162
985	require JSON;	1163	require JSON;
986		1164
987	my $data;	1165	my $data;
988	my $rbuf = \$self->{rbuf};	1166	my $rbuf = \$self->{rbuf};
…		…
1003	()	1181	()
1004	}	1182	}
1005	}	1183	}
1006	};	1184	};
1007		1185
		1186	=item storable => $cb->($handle, $ref)
		1187
		1188	Deserialises a L<Storable> frozen representation as written by the
		1189	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1190	data).
		1191
		1192	Raises C<EBADMSG> error if the data could not be decoded.
		1193
		1194	=cut
		1195
		1196	register_read_type storable => sub {
		1197	my ($self, $cb) = @_;
		1198
		1199	require Storable;
		1200
		1201	sub {
		1202	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1203	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1204	or return;
		1205
		1206	my $format = length pack "w", $len;
		1207
		1208	# bypass unshift if we already have the remaining chunk
		1209	if ($format + $len <= length $_[0]{rbuf}) {
		1210	my $data = substr $_[0]{rbuf}, $format, $len;
		1211	substr $_[0]{rbuf}, 0, $format + $len, "";
		1212	$cb->($_[0], Storable::thaw ($data));
		1213	} else {
		1214	# remove prefix
		1215	substr $_[0]{rbuf}, 0, $format, "";
		1216
		1217	# read remaining chunk
		1218	$_[0]->unshift_read (chunk => $len, sub {
		1219	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1220	$cb->($_[0], $ref);
		1221	} else {
		1222	$self->_error (&Errno::EBADMSG);
		1223	}
		1224	});
		1225	}
		1226
		1227	1
		1228	}
		1229	};
		1230
1008	=back	1231	=back
1009		1232
1010	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1233	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1011		1234
1012	This function (not method) lets you add your own types to C<push_read>.	1235	This function (not method) lets you add your own types to C<push_read>.
…		…
1039	Note that AnyEvent::Handle will automatically C<start_read> for you when	1262	Note that AnyEvent::Handle will automatically C<start_read> for you when
1040	you change the C<on_read> callback or push/unshift a read callback, and it	1263	you change the C<on_read> callback or push/unshift a read callback, and it
1041	will automatically C<stop_read> for you when neither C<on_read> is set nor	1264	will automatically C<stop_read> for you when neither C<on_read> is set nor
1042	there are any read requests in the queue.	1265	there are any read requests in the queue.
1043		1266
		1267	These methods will have no effect when in TLS mode (as TLS doesn't support
		1268	half-duplex connections).
		1269
1044	=cut	1270	=cut
1045		1271
1046	sub stop_read {	1272	sub stop_read {
1047	my ($self) = @_;	1273	my ($self) = @_;
1048		1274
1049	delete $self->{_rw};	1275	delete $self->{_rw} unless $self->{tls};
1050	}	1276	}
1051		1277
1052	sub start_read {	1278	sub start_read {
1053	my ($self) = @_;	1279	my ($self) = @_;
1054		1280
1055	unless ($self->{_rw} \|\| $self->{_eof}) {	1281	unless ($self->{_rw} \|\| $self->{_eof}) {
1056	Scalar::Util::weaken $self;	1282	Scalar::Util::weaken $self;
1057		1283
1058	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1284	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1059	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1285	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1060	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1286	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1061		1287
1062	if ($len > 0) {	1288	if ($len > 0) {
1063	$self->{_activity} = AnyEvent->now;	1289	$self->{_activity} = AnyEvent->now;
1064		1290
1065	$self->{filter_r}	1291	if ($self->{tls}) {
1066	? $self->{filter_r}($self, $rbuf)	1292	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1067	: $self->_drain_rbuf;	1293
		1294	&_dotls ($self);
		1295	} else {
		1296	$self->_drain_rbuf unless $self->{_in_drain};
		1297	}
1068		1298
1069	} elsif (defined $len) {	1299	} elsif (defined $len) {
1070	delete $self->{_rw};	1300	delete $self->{_rw};
1071	$self->{_eof} = 1;	1301	$self->{_eof} = 1;
1072	$self->_drain_rbuf;	1302	$self->_drain_rbuf unless $self->{_in_drain};
1073		1303
1074	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1304	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1075	return $self->_error ($!, 1);	1305	return $self->_error ($!, 1);
1076	}	1306	}
1077	});	1307	});
1078	}	1308	}
1079	}	1309	}
1080		1310
		1311	# poll the write BIO and send the data if applicable
1081	sub _dotls {	1312	sub _dotls {
1082	my ($self) = @_;	1313	my ($self) = @_;
1083		1314
1084	my $buf;	1315	my $tmp;
1085		1316
1086	if (length $self->{_tls_wbuf}) {	1317	if (length $self->{_tls_wbuf}) {
1087	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1318	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1088	substr $self->{_tls_wbuf}, 0, $len, "";	1319	substr $self->{_tls_wbuf}, 0, $tmp, "";
1089	}	1320	}
1090	}	1321	}
1091		1322
1092	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1093	$self->{wbuf} .= $buf;
1094	$self->_drain_wbuf;
1095	}
1096
1097	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1323	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1098	if (length $buf) {	1324	unless (length $tmp) {
1099	$self->{rbuf} .= $buf;
1100	$self->_drain_rbuf;
1101	} else {
1102	# let's treat SSL-eof as we treat normal EOF	1325	# let's treat SSL-eof as we treat normal EOF
		1326	delete $self->{_rw};
1103	$self->{_eof} = 1;	1327	$self->{_eof} = 1;
1104	$self->_shutdown;	1328	&_freetls;
1105	return;
1106	}	1329	}
1107	}
1108		1330
		1331	$self->{rbuf} .= $tmp;
		1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	$self->{tls} or return; # tls session might have gone away in callback
		1334	}
		1335
1109	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1336	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1110		1337
1111	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1338	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1112	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1339	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1113	return $self->_error ($!, 1);	1340	return $self->_error ($!, 1);
1114	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1341	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1115	return $self->_error (&Errno::EIO, 1);	1342	return $self->_error (&Errno::EIO, 1);
1116	}	1343	}
1117		1344
1118	# all others are fine for our purposes	1345	# all other errors are fine for our purposes
		1346	}
		1347
		1348	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1349	$self->{wbuf} .= $tmp;
		1350	$self->_drain_wbuf;
1119	}	1351	}
1120	}	1352	}
1121		1353
1122	=item $handle->starttls ($tls[, $tls_ctx])	1354	=item $handle->starttls ($tls[, $tls_ctx])
1123		1355
…		…
1133		1365
1134	The TLS connection object will end up in C<< $handle->{tls} >> after this	1366	The TLS connection object will end up in C<< $handle->{tls} >> after this
1135	call and can be used or changed to your liking. Note that the handshake	1367	call and can be used or changed to your liking. Note that the handshake
1136	might have already started when this function returns.	1368	might have already started when this function returns.
1137		1369
		1370	If it an error to start a TLS handshake more than once per
		1371	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1372
1138	=cut	1373	=cut
1139		1374
1140	sub starttls {	1375	sub starttls {
1141	my ($self, $ssl, $ctx) = @_;	1376	my ($self, $ssl, $ctx) = @_;
1142		1377
1143	$self->stoptls;	1378	require Net::SSLeay;
1144		1379
		1380	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1381	if $self->{tls};
		1382
1145	if ($ssl eq "accept") {	1383	if ($ssl eq "accept") {
1146	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1384	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1147	Net::SSLeay::set_accept_state ($ssl);	1385	Net::SSLeay::set_accept_state ($ssl);
1148	} elsif ($ssl eq "connect") {	1386	} elsif ($ssl eq "connect") {
1149	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1387	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1155	# basically, this is deep magic (because SSL_read should have the same issues)	1393	# basically, this is deep magic (because SSL_read should have the same issues)
1156	# but the openssl maintainers basically said: "trust us, it just works".	1394	# but the openssl maintainers basically said: "trust us, it just works".
1157	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1395	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1158	# and mismaintained ssleay-module doesn't even offer them).	1396	# and mismaintained ssleay-module doesn't even offer them).
1159	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1397	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1398	#
		1399	# in short: this is a mess.
		1400	#
		1401	# note that we do not try to keep the length constant between writes as we are required to do.
		1402	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1403	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1404	# have identity issues in that area.
1160	Net::SSLeay::CTX_set_mode ($self->{tls},	1405	Net::SSLeay::CTX_set_mode ($self->{tls},
1161	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1406	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1162	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1407	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1163		1408
1164	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1409	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1165	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1410	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1166		1411
1167	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1412	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1168		1413
1169	$self->{filter_w} = sub {	1414	&_dotls; # need to trigger the initial handshake
1170	$_[0]{_tls_wbuf} .= ${$_[1]};	1415	$self->start_read; # make sure we actually do read
1171	&_dotls;
1172	};
1173	$self->{filter_r} = sub {
1174	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1175	&_dotls;
1176	};
1177	}	1416	}
1178		1417
1179	=item $handle->stoptls	1418	=item $handle->stoptls
1180		1419
1181	Destroys the SSL connection, if any. Partial read or write data will be	1420	Shuts down the SSL connection - this makes a proper EOF handshake by
1182	lost.	1421	sending a close notify to the other side, but since OpenSSL doesn't
		1422	support non-blocking shut downs, it is not possible to re-use the stream
		1423	afterwards.
1183		1424
1184	=cut	1425	=cut
1185		1426
1186	sub stoptls {	1427	sub stoptls {
1187	my ($self) = @_;	1428	my ($self) = @_;
1188		1429
		1430	if ($self->{tls}) {
		1431	Net::SSLeay::shutdown ($self->{tls});
		1432
		1433	&_dotls;
		1434
		1435	# we don't give a shit. no, we do, but we can't. no...
		1436	# we, we... have to use openssl :/
		1437	&_freetls;
		1438	}
		1439	}
		1440
		1441	sub _freetls {
		1442	my ($self) = @_;
		1443
		1444	return unless $self->{tls};
		1445
1189	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1446	Net::SSLeay::free (delete $self->{tls});
1190		1447
1191	delete $self->{_rbio};	1448	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1192	delete $self->{_wbio};
1193	delete $self->{_tls_wbuf};
1194	delete $self->{filter_r};
1195	delete $self->{filter_w};
1196	}	1449	}
1197		1450
1198	sub DESTROY {	1451	sub DESTROY {
1199	my $self = shift;	1452	my $self = shift;
1200		1453
1201	$self->stoptls;	1454	&_freetls;
		1455
		1456	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1457
		1458	if ($linger && length $self->{wbuf}) {
		1459	my $fh = delete $self->{fh};
		1460	my $wbuf = delete $self->{wbuf};
		1461
		1462	my @linger;
		1463
		1464	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1465	my $len = syswrite $fh, $wbuf, length $wbuf;
		1466
		1467	if ($len > 0) {
		1468	substr $wbuf, 0, $len, "";
		1469	} else {
		1470	@linger = (); # end
		1471	}
		1472	});
		1473	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1474	@linger = ();
		1475	});
		1476	}
		1477	}
		1478
		1479	=item $handle->destroy
		1480
		1481	Shuts down the handle object as much as possible - this call ensures that
		1482	no further callbacks will be invoked and resources will be freed as much
		1483	as possible. You must not call any methods on the object afterwards.
		1484
		1485	Normally, you can just "forget" any references to an AnyEvent::Handle
		1486	object and it will simply shut down. This works in fatal error and EOF
		1487	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1488	callback, so when you want to destroy the AnyEvent::Handle object from
		1489	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1490	that case.
		1491
		1492	The handle might still linger in the background and write out remaining
		1493	data, as specified by the C<linger> option, however.
		1494
		1495	=cut
		1496
		1497	sub destroy {
		1498	my ($self) = @_;
		1499
		1500	$self->DESTROY;
		1501	%$self = ();
1202	}	1502	}
1203		1503
1204	=item AnyEvent::Handle::TLS_CTX	1504	=item AnyEvent::Handle::TLS_CTX
1205		1505
1206	This function creates and returns the Net::SSLeay::CTX object used by	1506	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1236	}	1536	}
1237	}	1537	}
1238		1538
1239	=back	1539	=back
1240		1540
		1541
		1542	=head1 NONFREQUENTLY ASKED QUESTIONS
		1543
		1544	=over 4
		1545
		1546	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1547	still get further invocations!
		1548
		1549	That's because AnyEvent::Handle keeps a reference to itself when handling
		1550	read or write callbacks.
		1551
		1552	It is only safe to "forget" the reference inside EOF or error callbacks,
		1553	from within all other callbacks, you need to explicitly call the C<<
		1554	->destroy >> method.
		1555
		1556	=item I get different callback invocations in TLS mode/Why can't I pause
		1557	reading?
		1558
		1559	Unlike, say, TCP, TLS connections do not consist of two independent
		1560	communication channels, one for each direction. Or put differently. The
		1561	read and write directions are not independent of each other: you cannot
		1562	write data unless you are also prepared to read, and vice versa.
		1563
		1564	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1565	callback invocations when you are not expecting any read data - the reason
		1566	is that AnyEvent::Handle always reads in TLS mode.
		1567
		1568	During the connection, you have to make sure that you always have a
		1569	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1570	connection (or when you no longer want to use it) you can call the
		1571	C<destroy> method.
		1572
		1573	=item How do I read data until the other side closes the connection?
		1574
		1575	If you just want to read your data into a perl scalar, the easiest way
		1576	to achieve this is by setting an C<on_read> callback that does nothing,
		1577	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1578	will be in C<$_[0]{rbuf}>:
		1579
		1580	$handle->on_read (sub { });
		1581	$handle->on_eof (undef);
		1582	$handle->on_error (sub {
		1583	my $data = delete $_[0]{rbuf};
		1584	undef $handle;
		1585	});
		1586
		1587	The reason to use C<on_error> is that TCP connections, due to latencies
		1588	and packets loss, might get closed quite violently with an error, when in
		1589	fact, all data has been received.
		1590
		1591	It is usually better to use acknowledgements when transferring data,
		1592	to make sure the other side hasn't just died and you got the data
		1593	intact. This is also one reason why so many internet protocols have an
		1594	explicit QUIT command.
		1595
		1596	=item I don't want to destroy the handle too early - how do I wait until
		1597	all data has been written?
		1598
		1599	After writing your last bits of data, set the C<on_drain> callback
		1600	and destroy the handle in there - with the default setting of
		1601	C<low_water_mark> this will be called precisely when all data has been
		1602	written to the socket:
		1603
		1604	$handle->push_write (...);
		1605	$handle->on_drain (sub {
		1606	warn "all data submitted to the kernel\n";
		1607	undef $handle;
		1608	});
		1609
		1610	=back
		1611
		1612
1241	=head1 SUBCLASSING AnyEvent::Handle	1613	=head1 SUBCLASSING AnyEvent::Handle
1242		1614
1243	In many cases, you might want to subclass AnyEvent::Handle.	1615	In many cases, you might want to subclass AnyEvent::Handle.
1244		1616
1245	To make this easier, a given version of AnyEvent::Handle uses these	1617	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1248	=over 4	1620	=over 4
1249		1621
1250	=item * all constructor arguments become object members.	1622	=item * all constructor arguments become object members.
1251		1623
1252	At least initially, when you pass a C<tls>-argument to the constructor it	1624	At least initially, when you pass a C<tls>-argument to the constructor it
1253	will end up in C<< $handle->{tls} >>. Those members might be changes or	1625	will end up in C<< $handle->{tls} >>. Those members might be changed or
1254	mutated later on (for example C<tls> will hold the TLS connection object).	1626	mutated later on (for example C<tls> will hold the TLS connection object).
1255		1627
1256	=item * other object member names are prefixed with an C<_>.	1628	=item * other object member names are prefixed with an C<_>.
1257		1629
1258	All object members not explicitly documented (internal use) are prefixed	1630	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.58 by root, Wed Jun 4 22:51:15 2008 UTC vs. Revision 1.108 by root, Tue Jan 6 20:08:05 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.58 by root, Wed Jun 4 22:51:15 2008 UTC vs.
Revision 1.108 by root, Tue Jan 6 20:08:05 2009 UTC