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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.51 by root, Sat May 31 13:38:01 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.51 by root, Sat May 31 13:38:01 2008 UTC vs. Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.51 by root, Sat May 31 13:38:01 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC