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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.52 by root, Mon Jun 2 09:10:38 2008 UTC vs.
Revision 1.110 by root, Wed Jan 21 05:36:45 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.1;	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
		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
187	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.
188		266
189	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
190		268
191	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
192	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
194		272
195	=item json => JSON or JSON::XS object	273	=item json => JSON or JSON::XS object
196		274
197	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.
198		276
199	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
200	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.
201		280
202	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
203	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
204		283
205	=item filter_r => $cb
206
207	=item filter_w => $cb
208
209	These exist, but are undocumented at this time.
210
211	=back	284	=back
212		285
213	=cut	286	=cut
214		287
215	sub new {	288	sub new {
…		…
219		292
220	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
221		294
222	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
223		296
224	if ($self->{tls}) {
225	require Net::SSLeay;
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
227	}	298	if $self->{tls};
228
229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
230	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
231	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
233		299
234	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
235	$self->_timeout;	301	$self->_timeout;
236		302
		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
237	$self->start_read;	306	$self->start_read
		307	if $self->{on_read};
238		308
239	$self	309	$self
240	}	310	}
241		311
242	sub _shutdown {	312	sub _shutdown {
…		…
245	delete $self->{_tw};	315	delete $self->{_tw};
246	delete $self->{_rw};	316	delete $self->{_rw};
247	delete $self->{_ww};	317	delete $self->{_ww};
248	delete $self->{fh};	318	delete $self->{fh};
249		319
250	$self->stoptls;	320	&_freetls;
		321
		322	delete $self->{on_read};
		323	delete $self->{_queue};
251	}	324	}
252		325
253	sub _error {	326	sub _error {
254	my ($self, $errno, $fatal) = @_;	327	my ($self, $errno, $fatal) = @_;
255		328
…		…
258		331
259	$! = $errno;	332	$! = $errno;
260		333
261	if ($self->{on_error}) {	334	if ($self->{on_error}) {
262	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
263	} else {	336	} elsif ($self->{fh}) {
264	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
265	}	338	}
266	}	339	}
267		340
268	=item $fh = $handle->fh	341	=item $fh = $handle->fh
269		342
270	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.
271		344
272	=cut	345	=cut
273		346
274	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
275		348
…		…
293	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
294	}	367	}
295		368
296	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
297		370
298	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
299	(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
300	argument.	373	argument and method.
301		374
302	=cut	375	=cut
303		376
304	sub on_timeout {	377	sub on_timeout {
305	$_[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	};
306	}	406	}
307		407
308	#############################################################################	408	#############################################################################
309		409
310	=item $handle->timeout ($seconds)	410	=item $handle->timeout ($seconds)
…		…
339	$self->{on_timeout}($self);	439	$self->{on_timeout}($self);
340	} else {	440	} else {
341	$self->_error (&Errno::ETIMEDOUT);	441	$self->_error (&Errno::ETIMEDOUT);
342	}	442	}
343		443
344	# callbakx could have changed timeout value, optimise	444	# callback could have changed timeout value, optimise
345	return unless $self->{timeout};	445	return unless $self->{timeout};
346		446
347	# calculate new after	447	# calculate new after
348	$after = $self->{timeout};	448	$after = $self->{timeout};
349	}	449	}
350		450
351	Scalar::Util::weaken $self;	451	Scalar::Util::weaken $self;
		452	return unless $self; # ->error could have destroyed $self
352		453
353	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	454	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
354	delete $self->{_tw};	455	delete $self->{_tw};
355	$self->_timeout;	456	$self->_timeout;
356	});	457	});
…		…
387	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
388		489
389	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
390		491
391	$cb->($self)	492	$cb->($self)
392	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
393	}	494	}
394		495
395	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
396		497
397	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
…		…
414	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
415		516
416	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
417		518
418	$self->{on_drain}($self)	519	$self->{on_drain}($self)
419	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
420	&& $self->{on_drain};	521	&& $self->{on_drain};
421		522
422	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
423	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
424	$self->_error ($!, 1);	525	$self->_error ($!, 1);
425	}	526	}
426	};	527	};
427		528
428	# try to write data immediately	529	# try to write data immediately
429	$cb->();	530	$cb->() unless $self->{autocork};
430		531
431	# if still data left in wbuf, we need to poll	532	# if still data left in wbuf, we need to poll
432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	533	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
433	if length $self->{wbuf};	534	if length $self->{wbuf};
434	};	535	};
…		…
448		549
449	@_ = ($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")
450	->($self, @_);	551	->($self, @_);
451	}	552	}
452		553
453	if ($self->{filter_w}) {	554	if ($self->{tls}) {
454	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
455	} else {	558	} else {
456	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
457	$self->_drain_wbuf;	560	$self->_drain_wbuf;
458	}	561	}
459	}	562	}
…		…
476	=cut	579	=cut
477		580
478	register_write_type netstring => sub {	581	register_write_type netstring => sub {
479	my ($self, $string) = @_;	582	my ($self, $string) = @_;
480		583
481	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
		585	};
		586
		587	=item packstring => $format, $data
		588
		589	An octet string prefixed with an encoded length. The encoding C<$format>
		590	uses the same format as a Perl C<pack> format, but must specify a single
		591	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		592	optional C<!>, C<< < >> or C<< > >> modifier).
		593
		594	=cut
		595
		596	register_write_type packstring => sub {
		597	my ($self, $format, $string) = @_;
		598
		599	pack "$format/a*", $string
482	};	600	};
483		601
484	=item json => $array_or_hashref	602	=item json => $array_or_hashref
485		603
486	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
…		…
520		638
521	$self->{json} ? $self->{json}->encode ($ref)	639	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	640	: JSON::encode_json ($ref)
523	};	641	};
524		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
		658	=back
		659
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		661
527	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>.
528	Whenever the given C<type> is used, C<push_write> will invoke the code	663	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	664	reference with the handle object and the remaining arguments.
…		…
532	be appended to the write buffer.	667	be appended to the write buffer.
533		668
534	Note that this is a function, and all types registered this way will be	669	Note that this is a function, and all types registered this way will be
535	global, so try to use unique names.	670	global, so try to use unique names.
536		671
537	=back
538
539	=cut	672	=cut
540		673
541	#############################################################################	674	#############################################################################
542		675
543	=back	676	=back
…		…
551	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
552	a queue.	685	a queue.
553		686
554	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
555	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
556	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
557	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).
558		692
559	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
560	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
561	data arrives and removes it when it has done its job (see C<push_read>,	695	data arrives (also the first time it is queued) and removes it when it has
562	below).	696	done its job (see C<push_read>, below).
563		697
564	This way you can, for example, push three line-reads, followed by reading	698	This way you can, for example, push three line-reads, followed by reading
565	a chunk of data, and AnyEvent::Handle will execute them in order.	699	a chunk of data, and AnyEvent::Handle will execute them in order.
566		700
567	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	701	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
…		…
580	# handle xml	714	# handle xml
581	});	715	});
582	});	716	});
583	});	717	});
584		718
585	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"
586	"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
587	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
588	pipeline sending both requests and manipulate the queue as necessary in	722	just pipeline sending both requests and manipulate the queue as necessary
589	the callbacks:	723	in the callbacks.
590		724
591	# 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"
592	$handle->push_write ("request 1\015\012");	730	$handle->push_write ("request 1\015\012");
593		731
594	# 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
595	$handle->push_read (line => sub {	733	$handle->push_read (line => sub {
596	# if we got an "OK", we have to _prepend_ another line,	734	# if we got an "OK", we have to _prepend_ another line,
…		…
603	...	741	...
604	});	742	});
605	}	743	}
606	});	744	});
607		745
608	# request two	746	# request two, simply returns 64 octets
609	$handle->push_write ("request 2\015\012");	747	$handle->push_write ("request 2\015\012");
610		748
611	# simply read 64 bytes, always	749	# simply read 64 bytes, always
612	$handle->push_read (chunk => 64, sub {	750	$handle->push_read (chunk => 64, sub {
613	my $response = $_[1];	751	my $response = $_[1];
…		…
619	=cut	757	=cut
620		758
621	sub _drain_rbuf {	759	sub _drain_rbuf {
622	my ($self) = @_;	760	my ($self) = @_;
623		761
		762	local $self->{_in_drain} = 1;
		763
624	if (	764	if (
625	defined $self->{rbuf_max}	765	defined $self->{rbuf_max}
626	&& $self->{rbuf_max} < length $self->{rbuf}	766	&& $self->{rbuf_max} < length $self->{rbuf}
627	) {	767	) {
628	return $self->_error (&Errno::ENOSPC, 1);	768	$self->_error (&Errno::ENOSPC, 1), return;
629	}	769	}
630		770
631	return if $self->{in_drain};	771	while () {
632	local $self->{in_drain} = 1;
633
634	while (my $len = length $self->{rbuf}) {	772	my $len = length $self->{rbuf};
635	no strict 'refs';	773
636	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
637	unless ($cb->($self)) {	775	unless ($cb->($self)) {
638	if ($self->{_eof}) {	776	if ($self->{_eof}) {
639	# no progress can be made (not enough data and no data forthcoming)	777	# no progress can be made (not enough data and no data forthcoming)
640	return $self->_error (&Errno::EPIPE, 1);	778	$self->_error (&Errno::EPIPE, 1), return;
641	}	779	}
642		780
643	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
644	return;	782	last;
645	}	783	}
646	} elsif ($self->{on_read}) {	784	} elsif ($self->{on_read}) {
		785	last unless $len;
		786
647	$self->{on_read}($self);	787	$self->{on_read}($self);
648		788
649	if (	789	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	790	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	791	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	792	&& $self->{on_read} # but we still have on_read
654	) {	793	) {
		794	# no further data will arrive
655	# then no progress can be made	795	# so no progress can be made
656	return $self->_error (&Errno::EPIPE, 1);	796	$self->_error (&Errno::EPIPE, 1), return
		797	if $self->{_eof};
		798
		799	last; # more data might arrive
657	}	800	}
658	} else {	801	} else {
659	# read side becomes idle	802	# read side becomes idle
660	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
661	return;	804	last;
662	}	805	}
663	}	806	}
664		807
		808	if ($self->{_eof}) {
		809	if ($self->{on_eof}) {
665	$self->{on_eof}($self)	810	$self->{on_eof}($self)
666	if $self->{_eof} && $self->{on_eof};	811	} else {
		812	$self->_error (0, 1);
		813	}
		814	}
		815
		816	# may need to restart read watcher
		817	unless ($self->{_rw}) {
		818	$self->start_read
		819	if $self->{on_read} \|\| @{ $self->{_queue} };
		820	}
667	}	821	}
668		822
669	=item $handle->on_read ($cb)	823	=item $handle->on_read ($cb)
670		824
671	This replaces the currently set C<on_read> callback, or clears it (when	825	This replaces the currently set C<on_read> callback, or clears it (when
…		…
676		830
677	sub on_read {	831	sub on_read {
678	my ($self, $cb) = @_;	832	my ($self, $cb) = @_;
679		833
680	$self->{on_read} = $cb;	834	$self->{on_read} = $cb;
		835	$self->_drain_rbuf if $cb && !$self->{_in_drain};
681	}	836	}
682		837
683	=item $handle->rbuf	838	=item $handle->rbuf
684		839
685	Returns the read buffer (as a modifiable lvalue).	840	Returns the read buffer (as a modifiable lvalue).
…		…
734	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	889	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
735	->($self, $cb, @_);	890	->($self, $cb, @_);
736	}	891	}
737		892
738	push @{ $self->{_queue} }, $cb;	893	push @{ $self->{_queue} }, $cb;
739	$self->_drain_rbuf;	894	$self->_drain_rbuf unless $self->{_in_drain};
740	}	895	}
741		896
742	sub unshift_read {	897	sub unshift_read {
743	my $self = shift;	898	my $self = shift;
744	my $cb = pop;	899	my $cb = pop;
…		…
750	->($self, $cb, @_);	905	->($self, $cb, @_);
751	}	906	}
752		907
753		908
754	unshift @{ $self->{_queue} }, $cb;	909	unshift @{ $self->{_queue} }, $cb;
755	$self->_drain_rbuf;	910	$self->_drain_rbuf unless $self->{_in_drain};
756	}	911	}
757		912
758	=item $handle->push_read (type => @args, $cb)	913	=item $handle->push_read (type => @args, $cb)
759		914
760	=item $handle->unshift_read (type => @args, $cb)	915	=item $handle->unshift_read (type => @args, $cb)
…		…
790	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	945	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
791	1	946	1
792	}	947	}
793	};	948	};
794		949
795	# compatibility with older API
796	sub push_read_chunk {
797	$_[0]->push_read (chunk => $_[1], $_[2]);
798	}
799
800	sub unshift_read_chunk {
801	$_[0]->unshift_read (chunk => $_[1], $_[2]);
802	}
803
804	=item line => [$eol, ]$cb->($handle, $line, $eol)	950	=item line => [$eol, ]$cb->($handle, $line, $eol)
805		951
806	The callback will be called only once a full line (including the end of	952	The callback will be called only once a full line (including the end of
807	line marker, C<$eol>) has been read. This line (excluding the end of line	953	line marker, C<$eol>) has been read. This line (excluding the end of line
808	marker) will be passed to the callback as second argument (C<$line>), and	954	marker) will be passed to the callback as second argument (C<$line>), and
…		…
823	=cut	969	=cut
824		970
825	register_read_type line => sub {	971	register_read_type line => sub {
826	my ($self, $cb, $eol) = @_;	972	my ($self, $cb, $eol) = @_;
827		973
828	$eol = qr\|(\015?\012)\| if @_ < 3;	974	if (@_ < 3) {
829	$eol = quotemeta $eol unless ref $eol;	975	# this is more than twice as fast as the generic code below
830	$eol = qr\|^(.*?)($eol)\|s;
831
832	sub {	976	sub {
833	$_[0]{rbuf} =~ s/$eol// or return;	977	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
834		978
835	$cb->($_[0], $1, $2);	979	$cb->($_[0], $1, $2);
836	1
837	}
838	};
839
840	# compatibility with older API
841	sub push_read_line {
842	my $self = shift;
843	$self->push_read (line => @_);
844	}
845
846	sub unshift_read_line {
847	my $self = shift;
848	$self->unshift_read (line => @_);
849	}
850
851	=item netstring => $cb->($handle, $string)
852
853	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
854
855	Throws an error with C<$!> set to EBADMSG on format violations.
856
857	=cut
858
859	register_read_type netstring => sub {
860	my ($self, $cb) = @_;
861
862	sub {
863	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
864	if ($_[0]{rbuf} =~ /[^0-9]/) {
865	$self->_error (&Errno::EBADMSG);
866	}	980	1
867	return;
868	}	981	}
		982	} else {
		983	$eol = quotemeta $eol unless ref $eol;
		984	$eol = qr\|^(.*?)($eol)\|s;
869		985
870	my $len = $1;	986	sub {
		987	$_[0]{rbuf} =~ s/$eol// or return;
871		988
872	$self->unshift_read (chunk => $len, sub {	989	$cb->($_[0], $1, $2);
873	my $string = $_[1];
874	$_[0]->unshift_read (chunk => 1, sub {
875	if ($_[1] eq ",") {
876	$cb->($_[0], $string);
877	} else {
878	$self->_error (&Errno::EBADMSG);
879	}
880	});	990	1
881	});	991	}
882
883	1
884	}	992	}
885	};	993	};
886		994
887	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	995	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
888		996
…		…
952		1060
953	()	1061	()
954	}	1062	}
955	};	1063	};
956		1064
		1065	=item netstring => $cb->($handle, $string)
		1066
		1067	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1068
		1069	Throws an error with C<$!> set to EBADMSG on format violations.
		1070
		1071	=cut
		1072
		1073	register_read_type netstring => sub {
		1074	my ($self, $cb) = @_;
		1075
		1076	sub {
		1077	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1078	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1079	$self->_error (&Errno::EBADMSG);
		1080	}
		1081	return;
		1082	}
		1083
		1084	my $len = $1;
		1085
		1086	$self->unshift_read (chunk => $len, sub {
		1087	my $string = $_[1];
		1088	$_[0]->unshift_read (chunk => 1, sub {
		1089	if ($_[1] eq ",") {
		1090	$cb->($_[0], $string);
		1091	} else {
		1092	$self->_error (&Errno::EBADMSG);
		1093	}
		1094	});
		1095	});
		1096
		1097	1
		1098	}
		1099	};
		1100
		1101	=item packstring => $format, $cb->($handle, $string)
		1102
		1103	An octet string prefixed with an encoded length. The encoding C<$format>
		1104	uses the same format as a Perl C<pack> format, but must specify a single
		1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1106	optional C<!>, C<< < >> or C<< > >> modifier).
		1107
		1108	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1109	EPP uses a prefix of C<N> (4 octtes).
		1110
		1111	Example: read a block of data prefixed by its length in BER-encoded
		1112	format (very efficient).
		1113
		1114	$handle->push_read (packstring => "w", sub {
		1115	my ($handle, $data) = @_;
		1116	});
		1117
		1118	=cut
		1119
		1120	register_read_type packstring => sub {
		1121	my ($self, $cb, $format) = @_;
		1122
		1123	sub {
		1124	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1125	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1126	or return;
		1127
		1128	$format = length pack $format, $len;
		1129
		1130	# bypass unshift if we already have the remaining chunk
		1131	if ($format + $len <= length $_[0]{rbuf}) {
		1132	my $data = substr $_[0]{rbuf}, $format, $len;
		1133	substr $_[0]{rbuf}, 0, $format + $len, "";
		1134	$cb->($_[0], $data);
		1135	} else {
		1136	# remove prefix
		1137	substr $_[0]{rbuf}, 0, $format, "";
		1138
		1139	# read remaining chunk
		1140	$_[0]->unshift_read (chunk => $len, $cb);
		1141	}
		1142
		1143	1
		1144	}
		1145	};
		1146
957	=item json => $cb->($handle, $hash_or_arrayref)	1147	=item json => $cb->($handle, $hash_or_arrayref)
958		1148
959	Reads a JSON object or array, decodes it and passes it to the callback.	1149	Reads a JSON object or array, decodes it and passes it to the
		1150	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
960		1151
961	If a C<json> object was passed to the constructor, then that will be used	1152	If a C<json> object was passed to the constructor, then that will be used
962	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1153	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
963		1154
964	This read type uses the incremental parser available with JSON version	1155	This read type uses the incremental parser available with JSON version
…		…
971	the C<json> write type description, above, for an actual example.	1162	the C<json> write type description, above, for an actual example.
972		1163
973	=cut	1164	=cut
974		1165
975	register_read_type json => sub {	1166	register_read_type json => sub {
976	my ($self, $cb, $accept, $reject, $skip) = @_;	1167	my ($self, $cb) = @_;
977		1168
978	require JSON;	1169	require JSON;
979		1170
980	my $data;	1171	my $data;
981	my $rbuf = \$self->{rbuf};	1172	my $rbuf = \$self->{rbuf};
982		1173
983	my $json = $self->{json} \|\|= JSON->new->utf8;	1174	my $json = $self->{json} \|\|= JSON->new->utf8;
984		1175
985	sub {	1176	sub {
		1177	eval {
986	my $ref = $json->incr_parse ($self->{rbuf});	1178	my $ref = $json->incr_parse ($self->{rbuf});
987		1179
988	if ($ref) {	1180	if ($ref) {
		1181	$self->{rbuf} = $json->incr_text;
		1182	$json->incr_text = "";
		1183	$cb->($self, $ref);
		1184
		1185	1
		1186	} else {
		1187	$self->{rbuf} = "";
		1188	()
		1189	}
		1190
		1191	1
		1192	} or do {
		1193	$json->incr_skip;
		1194
989	$self->{rbuf} = $json->incr_text;	1195	$self->{rbuf} = $json->incr_text;
990	$json->incr_text = "";	1196	$json->incr_text = "";
991	$cb->($self, $ref);
992		1197
993	1	1198	$self->_error (&Errno::EBADMSG);
		1199	};
		1200
		1201	}
		1202	};
		1203
		1204	=item storable => $cb->($handle, $ref)
		1205
		1206	Deserialises a L<Storable> frozen representation as written by the
		1207	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1208	data).
		1209
		1210	Raises C<EBADMSG> error if the data could not be decoded.
		1211
		1212	=cut
		1213
		1214	register_read_type storable => sub {
		1215	my ($self, $cb) = @_;
		1216
		1217	require Storable;
		1218
		1219	sub {
		1220	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1221	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1222	or return;
		1223
		1224	my $format = length pack "w", $len;
		1225
		1226	# bypass unshift if we already have the remaining chunk
		1227	if ($format + $len <= length $_[0]{rbuf}) {
		1228	my $data = substr $_[0]{rbuf}, $format, $len;
		1229	substr $_[0]{rbuf}, 0, $format + $len, "";
		1230	$cb->($_[0], Storable::thaw ($data));
994	} else {	1231	} else {
995	$self->{rbuf} = "";	1232	# remove prefix
		1233	substr $_[0]{rbuf}, 0, $format, "";
		1234
		1235	# read remaining chunk
		1236	$_[0]->unshift_read (chunk => $len, sub {
		1237	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1238	$cb->($_[0], $ref);
		1239	} else {
		1240	$self->_error (&Errno::EBADMSG);
		1241	}
996	()	1242	});
997	}	1243	}
		1244
		1245	1
998	}	1246	}
999	};	1247	};
1000		1248
1001	=back	1249	=back
1002		1250
…		…
1023	=item $handle->stop_read	1271	=item $handle->stop_read
1024		1272
1025	=item $handle->start_read	1273	=item $handle->start_read
1026		1274
1027	In rare cases you actually do not want to read anything from the	1275	In rare cases you actually do not want to read anything from the
1028	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1276	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1029	any queued callbacks will be executed then. To start reading again, call	1277	any queued callbacks will be executed then. To start reading again, call
1030	C<start_read>.	1278	C<start_read>.
1031		1279
		1280	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1281	you change the C<on_read> callback or push/unshift a read callback, and it
		1282	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1283	there are any read requests in the queue.
		1284
		1285	These methods will have no effect when in TLS mode (as TLS doesn't support
		1286	half-duplex connections).
		1287
1032	=cut	1288	=cut
1033		1289
1034	sub stop_read {	1290	sub stop_read {
1035	my ($self) = @_;	1291	my ($self) = @_;
1036		1292
1037	delete $self->{_rw};	1293	delete $self->{_rw} unless $self->{tls};
1038	}	1294	}
1039		1295
1040	sub start_read {	1296	sub start_read {
1041	my ($self) = @_;	1297	my ($self) = @_;
1042		1298
1043	unless ($self->{_rw} \|\| $self->{_eof}) {	1299	unless ($self->{_rw} \|\| $self->{_eof}) {
1044	Scalar::Util::weaken $self;	1300	Scalar::Util::weaken $self;
1045		1301
1046	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1302	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1047	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1303	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1048	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1304	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1049		1305
1050	if ($len > 0) {	1306	if ($len > 0) {
1051	$self->{_activity} = AnyEvent->now;	1307	$self->{_activity} = AnyEvent->now;
1052		1308
1053	$self->{filter_r}	1309	if ($self->{tls}) {
1054	? $self->{filter_r}($self, $rbuf)	1310	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1055	: $self->_drain_rbuf;	1311
		1312	&_dotls ($self);
		1313	} else {
		1314	$self->_drain_rbuf unless $self->{_in_drain};
		1315	}
1056		1316
1057	} elsif (defined $len) {	1317	} elsif (defined $len) {
1058	delete $self->{_rw};	1318	delete $self->{_rw};
1059	$self->{_eof} = 1;	1319	$self->{_eof} = 1;
1060	$self->_drain_rbuf;	1320	$self->_drain_rbuf unless $self->{_in_drain};
1061		1321
1062	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1322	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1063	return $self->_error ($!, 1);	1323	return $self->_error ($!, 1);
1064	}	1324	}
1065	});	1325	});
1066	}	1326	}
1067	}	1327	}
1068		1328
		1329	# poll the write BIO and send the data if applicable
1069	sub _dotls {	1330	sub _dotls {
1070	my ($self) = @_;	1331	my ($self) = @_;
1071		1332
		1333	my $tmp;
		1334
1072	if (length $self->{_tls_wbuf}) {	1335	if (length $self->{_tls_wbuf}) {
1073	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1336	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1074	substr $self->{_tls_wbuf}, 0, $len, "";	1337	substr $self->{_tls_wbuf}, 0, $tmp, "";
1075	}	1338	}
1076	}	1339	}
1077		1340
1078	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1079	$self->{wbuf} .= $buf;
1080	$self->_drain_wbuf;
1081	}
1082
1083	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1341	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1342	unless (length $tmp) {
		1343	# let's treat SSL-eof as we treat normal EOF
		1344	delete $self->{_rw};
		1345	$self->{_eof} = 1;
		1346	&_freetls;
		1347	}
		1348
1084	$self->{rbuf} .= $buf;	1349	$self->{rbuf} .= $tmp;
1085	$self->_drain_rbuf;	1350	$self->_drain_rbuf unless $self->{_in_drain};
		1351	$self->{tls} or return; # tls session might have gone away in callback
1086	}	1352	}
1087		1353
1088	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1354	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1089		1355
1090	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1356	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1091	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1357	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1092	return $self->_error ($!, 1);	1358	return $self->_error ($!, 1);
1093	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1359	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1094	return $self->_error (&Errno::EIO, 1);	1360	return $self->_error (&Errno::EIO, 1);
1095	}	1361	}
1096		1362
1097	# all others are fine for our purposes	1363	# all other errors are fine for our purposes
		1364	}
		1365
		1366	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1367	$self->{wbuf} .= $tmp;
		1368	$self->_drain_wbuf;
1098	}	1369	}
1099	}	1370	}
1100		1371
1101	=item $handle->starttls ($tls[, $tls_ctx])	1372	=item $handle->starttls ($tls[, $tls_ctx])
1102		1373
…		…
1112		1383
1113	The TLS connection object will end up in C<< $handle->{tls} >> after this	1384	The TLS connection object will end up in C<< $handle->{tls} >> after this
1114	call and can be used or changed to your liking. Note that the handshake	1385	call and can be used or changed to your liking. Note that the handshake
1115	might have already started when this function returns.	1386	might have already started when this function returns.
1116		1387
		1388	If it an error to start a TLS handshake more than once per
		1389	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1390
1117	=cut	1391	=cut
1118		1392
1119	sub starttls {	1393	sub starttls {
1120	my ($self, $ssl, $ctx) = @_;	1394	my ($self, $ssl, $ctx) = @_;
1121		1395
1122	$self->stoptls;	1396	require Net::SSLeay;
1123		1397
		1398	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1399	if $self->{tls};
		1400
1124	if ($ssl eq "accept") {	1401	if ($ssl eq "accept") {
1125	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1402	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1126	Net::SSLeay::set_accept_state ($ssl);	1403	Net::SSLeay::set_accept_state ($ssl);
1127	} elsif ($ssl eq "connect") {	1404	} elsif ($ssl eq "connect") {
1128	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1405	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1134	# basically, this is deep magic (because SSL_read should have the same issues)	1411	# basically, this is deep magic (because SSL_read should have the same issues)
1135	# but the openssl maintainers basically said: "trust us, it just works".	1412	# but the openssl maintainers basically said: "trust us, it just works".
1136	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1413	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1137	# and mismaintained ssleay-module doesn't even offer them).	1414	# and mismaintained ssleay-module doesn't even offer them).
1138	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1415	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1416	#
		1417	# in short: this is a mess.
		1418	#
		1419	# note that we do not try to keep the length constant between writes as we are required to do.
		1420	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1421	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1422	# have identity issues in that area.
1139	Net::SSLeay::CTX_set_mode ($self->{tls},	1423	Net::SSLeay::CTX_set_mode ($self->{tls},
1140	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1424	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1141	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1425	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1142		1426
1143	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1427	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1144	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1145		1429
1146	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1430	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1147		1431
1148	$self->{filter_w} = sub {	1432	&_dotls; # need to trigger the initial handshake
1149	$_[0]{_tls_wbuf} .= ${$_[1]};	1433	$self->start_read; # make sure we actually do read
1150	&_dotls;
1151	};
1152	$self->{filter_r} = sub {
1153	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1154	&_dotls;
1155	};
1156	}	1434	}
1157		1435
1158	=item $handle->stoptls	1436	=item $handle->stoptls
1159		1437
1160	Destroys the SSL connection, if any. Partial read or write data will be	1438	Shuts down the SSL connection - this makes a proper EOF handshake by
1161	lost.	1439	sending a close notify to the other side, but since OpenSSL doesn't
		1440	support non-blocking shut downs, it is not possible to re-use the stream
		1441	afterwards.
1162		1442
1163	=cut	1443	=cut
1164		1444
1165	sub stoptls {	1445	sub stoptls {
1166	my ($self) = @_;	1446	my ($self) = @_;
1167		1447
		1448	if ($self->{tls}) {
		1449	Net::SSLeay::shutdown ($self->{tls});
		1450
		1451	&_dotls;
		1452
		1453	# we don't give a shit. no, we do, but we can't. no...
		1454	# we, we... have to use openssl :/
		1455	&_freetls;
		1456	}
		1457	}
		1458
		1459	sub _freetls {
		1460	my ($self) = @_;
		1461
		1462	return unless $self->{tls};
		1463
1168	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1464	Net::SSLeay::free (delete $self->{tls});
1169		1465
1170	delete $self->{_rbio};	1466	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1171	delete $self->{_wbio};
1172	delete $self->{_tls_wbuf};
1173	delete $self->{filter_r};
1174	delete $self->{filter_w};
1175	}	1467	}
1176		1468
1177	sub DESTROY {	1469	sub DESTROY {
1178	my $self = shift;	1470	my $self = shift;
1179		1471
1180	$self->stoptls;	1472	&_freetls;
		1473
		1474	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1475
		1476	if ($linger && length $self->{wbuf}) {
		1477	my $fh = delete $self->{fh};
		1478	my $wbuf = delete $self->{wbuf};
		1479
		1480	my @linger;
		1481
		1482	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1483	my $len = syswrite $fh, $wbuf, length $wbuf;
		1484
		1485	if ($len > 0) {
		1486	substr $wbuf, 0, $len, "";
		1487	} else {
		1488	@linger = (); # end
		1489	}
		1490	});
		1491	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1492	@linger = ();
		1493	});
		1494	}
		1495	}
		1496
		1497	=item $handle->destroy
		1498
		1499	Shuts down the handle object as much as possible - this call ensures that
		1500	no further callbacks will be invoked and resources will be freed as much
		1501	as possible. You must not call any methods on the object afterwards.
		1502
		1503	Normally, you can just "forget" any references to an AnyEvent::Handle
		1504	object and it will simply shut down. This works in fatal error and EOF
		1505	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1506	callback, so when you want to destroy the AnyEvent::Handle object from
		1507	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1508	that case.
		1509
		1510	The handle might still linger in the background and write out remaining
		1511	data, as specified by the C<linger> option, however.
		1512
		1513	=cut
		1514
		1515	sub destroy {
		1516	my ($self) = @_;
		1517
		1518	$self->DESTROY;
		1519	%$self = ();
1181	}	1520	}
1182		1521
1183	=item AnyEvent::Handle::TLS_CTX	1522	=item AnyEvent::Handle::TLS_CTX
1184		1523
1185	This function creates and returns the Net::SSLeay::CTX object used by	1524	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1215	}	1554	}
1216	}	1555	}
1217		1556
1218	=back	1557	=back
1219		1558
		1559
		1560	=head1 NONFREQUENTLY ASKED QUESTIONS
		1561
		1562	=over 4
		1563
		1564	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1565	still get further invocations!
		1566
		1567	That's because AnyEvent::Handle keeps a reference to itself when handling
		1568	read or write callbacks.
		1569
		1570	It is only safe to "forget" the reference inside EOF or error callbacks,
		1571	from within all other callbacks, you need to explicitly call the C<<
		1572	->destroy >> method.
		1573
		1574	=item I get different callback invocations in TLS mode/Why can't I pause
		1575	reading?
		1576
		1577	Unlike, say, TCP, TLS connections do not consist of two independent
		1578	communication channels, one for each direction. Or put differently. The
		1579	read and write directions are not independent of each other: you cannot
		1580	write data unless you are also prepared to read, and vice versa.
		1581
		1582	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1583	callback invocations when you are not expecting any read data - the reason
		1584	is that AnyEvent::Handle always reads in TLS mode.
		1585
		1586	During the connection, you have to make sure that you always have a
		1587	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1588	connection (or when you no longer want to use it) you can call the
		1589	C<destroy> method.
		1590
		1591	=item How do I read data until the other side closes the connection?
		1592
		1593	If you just want to read your data into a perl scalar, the easiest way
		1594	to achieve this is by setting an C<on_read> callback that does nothing,
		1595	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1596	will be in C<$_[0]{rbuf}>:
		1597
		1598	$handle->on_read (sub { });
		1599	$handle->on_eof (undef);
		1600	$handle->on_error (sub {
		1601	my $data = delete $_[0]{rbuf};
		1602	undef $handle;
		1603	});
		1604
		1605	The reason to use C<on_error> is that TCP connections, due to latencies
		1606	and packets loss, might get closed quite violently with an error, when in
		1607	fact, all data has been received.
		1608
		1609	It is usually better to use acknowledgements when transferring data,
		1610	to make sure the other side hasn't just died and you got the data
		1611	intact. This is also one reason why so many internet protocols have an
		1612	explicit QUIT command.
		1613
		1614	=item I don't want to destroy the handle too early - how do I wait until
		1615	all data has been written?
		1616
		1617	After writing your last bits of data, set the C<on_drain> callback
		1618	and destroy the handle in there - with the default setting of
		1619	C<low_water_mark> this will be called precisely when all data has been
		1620	written to the socket:
		1621
		1622	$handle->push_write (...);
		1623	$handle->on_drain (sub {
		1624	warn "all data submitted to the kernel\n";
		1625	undef $handle;
		1626	});
		1627
		1628	=back
		1629
		1630
1220	=head1 SUBCLASSING AnyEvent::Handle	1631	=head1 SUBCLASSING AnyEvent::Handle
1221		1632
1222	In many cases, you might want to subclass AnyEvent::Handle.	1633	In many cases, you might want to subclass AnyEvent::Handle.
1223		1634
1224	To make this easier, a given version of AnyEvent::Handle uses these	1635	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1227	=over 4	1638	=over 4
1228		1639
1229	=item * all constructor arguments become object members.	1640	=item * all constructor arguments become object members.
1230		1641
1231	At least initially, when you pass a C<tls>-argument to the constructor it	1642	At least initially, when you pass a C<tls>-argument to the constructor it
1232	will end up in C<< $handle->{tls} >>. Those members might be changes or	1643	will end up in C<< $handle->{tls} >>. Those members might be changed or
1233	mutated later on (for example C<tls> will hold the TLS connection object).	1644	mutated later on (for example C<tls> will hold the TLS connection object).
1234		1645
1235	=item * other object member names are prefixed with an C<_>.	1646	=item * other object member names are prefixed with an C<_>.
1236		1647
1237	All object members not explicitly documented (internal use) are prefixed	1648	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.52 by root, Mon Jun 2 09:10:38 2008 UTC vs. Revision 1.110 by root, Wed Jan 21 05:36:45 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.52 by root, Mon Jun 2 09:10:38 2008 UTC vs.
Revision 1.110 by root, Wed Jan 21 05:36:45 2009 UTC