ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.25 by root, Sat May 24 15:19:43 2008 UTC vs.
Revision 1.112 by root, Wed Jan 21 06:01:35 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 ();	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
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	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.331;
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
24		22
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->send;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
51	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
52		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
53	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
54	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
55	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
56		60
57	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
…		…
69		73
70	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
71		75
72	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
73		77
74	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
75	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
76		81
77	=item on_eof => $cb->($self)	82	=item on_eof => $cb->($handle)
78		83
79	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.
80		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
81	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,
82	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
83	waiting for data.	95	waiting for data.
84		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
85	=item on_error => $cb->($self)	100	=item on_error => $cb->($handle, $fatal)
86		101
87	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
88	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
89	or a read error.	104	connect or a read error.
90		105
91	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
92	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>).
93		116
94	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
96		119
97	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
98	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
99	die.	122	C<croak>.
100		123
101	=item on_read => $cb->($self)	124	=item on_read => $cb->($handle)
102		125
103	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
104	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).
105		130
106	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 >>
107	method or access the C<$self->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
108		133
109	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
110	feed all the remaining data to the queued callbacks and C<on_read> before	135	feed all the remaining data to the queued callbacks and C<on_read> before
111	calling the C<on_eof> callback. If no progress can be made, then a fatal	136	calling the C<on_eof> callback. If no progress can be made, then a fatal
112	error will be raised (with C<$!> set to C<EPIPE>).	137	error will be raised (with C<$!> set to C<EPIPE>).
113		138
114	=item on_drain => $cb->()	139	=item on_drain => $cb->($handle)
115		140
116	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
117	(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).
118		143
119	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.
120		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
		152	=item timeout => $fractional_seconds
		153
		154	If non-zero, then this enables an "inactivity" timeout: whenever this many
		155	seconds pass without a successful read or write on the underlying file
		156	handle, the C<on_timeout> callback will be invoked (and if that one is
		157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
		158
		159	Note that timeout processing is also active when you currently do not have
		160	any outstanding read or write requests: If you plan to keep the connection
		161	idle then you should disable the timout temporarily or ignore the timeout
		162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
		164
		165	Zero (the default) disables this timeout.
		166
		167	=item on_timeout => $cb->($handle)
		168
		169	Called whenever the inactivity timeout passes. If you return from this
		170	callback, then the timeout will be reset as if some activity had happened,
		171	so this condition is not fatal in any way.
		172
121	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
122		174
123	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>)
124	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
125	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
126		178
127	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
128	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
129	(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
130	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
131	isn't finished).	183	isn't finished).
132		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
133	=item read_size => <bytes>	211	=item read_size => <bytes>
134		212
135	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
136	on each [loop iteration). Default: C<4096>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
137		216
138	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
139		218
140	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
141	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
142	considered empty.	221	considered empty.
143		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
144	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	240	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
145		241
146	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
147	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
148	data.	244	established and will transparently encrypt/decrypt data afterwards.
149		245
150	For the TLS server side, use C<accept>, and for the TLS client side of a	246	TLS mode requires Net::SSLeay to be installed (it will be loaded
151	connection, use C<connect> mode.	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.
		250
		251	Unlike TCP, TLS has a server and client side: for the TLS server side, use
		252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
152		254
153	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
154	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>
155	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
156	AnyEvent::Handle.	258	AnyEvent::Handle.
157		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
		265	See the C<< ->starttls >> method for when need to start TLS negotiation later.
		266
158	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
159		268
160	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
161	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
162	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
163		272
		273	=item json => JSON or JSON::XS object
		274
		275	This is the json coder object used by the C<json> read and write types.
		276
		277	If you don't supply it, then AnyEvent::Handle will create and use a
		278	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		279	texts.
		280
		281	Note that you are responsible to depend on the JSON module if you want to
		282	use this functionality, as AnyEvent does not have a dependency itself.
		283
164	=back	284	=back
165		285
166	=cut	286	=cut
167		287
168	sub new {	288	sub new {
…		…
172		292
173	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
174		294
175	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
176		296
177	if ($self->{tls}) {
178	require Net::SSLeay;
179	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
180	}	298	if $self->{tls};
181		299
182	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	300	$self->{_activity} = AnyEvent->now;
183	$self->on_error (delete $self->{on_error}) if $self->{on_error};	301	$self->_timeout;
		302
184	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
185	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	304	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
186		305
187	$self->start_read;	306	$self->start_read
		307	if $self->{on_read};
188		308
189	$self	309	$self
190	}	310	}
191		311
192	sub _shutdown {	312	sub _shutdown {
193	my ($self) = @_;	313	my ($self) = @_;
194		314
		315	delete $self->{_tw};
195	delete $self->{rw};	316	delete $self->{_rw};
196	delete $self->{ww};	317	delete $self->{_ww};
197	delete $self->{fh};	318	delete $self->{fh};
198	}
199		319
		320	&_freetls;
		321
		322	delete $self->{on_read};
		323	delete $self->{_queue};
		324	}
		325
200	sub error {	326	sub _error {
201	my ($self) = @_;	327	my ($self, $errno, $fatal) = @_;
202		328
203	{
204	local $!;
205	$self->_shutdown;	329	$self->_shutdown
206	}	330	if $fatal;
		331
		332	$! = $errno;
207		333
208	if ($self->{on_error}) {	334	if ($self->{on_error}) {
209	$self->{on_error}($self);	335	$self->{on_error}($self, $fatal);
210	} else {	336	} elsif ($self->{fh}) {
211	die "AnyEvent::Handle uncaught fatal error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
212	}	338	}
213	}	339	}
214		340
215	=item $fh = $handle->fh	341	=item $fh = $handle->fh
216		342
217	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.
218		344
219	=cut	345	=cut
220		346
221	sub fh { $_[0]->{fh} }	347	sub fh { $_[0]{fh} }
222		348
223	=item $handle->on_error ($cb)	349	=item $handle->on_error ($cb)
224		350
225	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	351	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
226		352
…		…
238		364
239	sub on_eof {	365	sub on_eof {
240	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
241	}	367	}
242		368
		369	=item $handle->on_timeout ($cb)
		370
		371	Replace the current C<on_timeout> callback, or disables the callback (but
		372	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
		373	argument and method.
		374
		375	=cut
		376
		377	sub on_timeout {
		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	};
		406	}
		407
		408	#############################################################################
		409
		410	=item $handle->timeout ($seconds)
		411
		412	Configures (or disables) the inactivity timeout.
		413
		414	=cut
		415
		416	sub timeout {
		417	my ($self, $timeout) = @_;
		418
		419	$self->{timeout} = $timeout;
		420	$self->_timeout;
		421	}
		422
		423	# reset the timeout watcher, as neccessary
		424	# also check for time-outs
		425	sub _timeout {
		426	my ($self) = @_;
		427
		428	if ($self->{timeout}) {
		429	my $NOW = AnyEvent->now;
		430
		431	# when would the timeout trigger?
		432	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		433
		434	# now or in the past already?
		435	if ($after <= 0) {
		436	$self->{_activity} = $NOW;
		437
		438	if ($self->{on_timeout}) {
		439	$self->{on_timeout}($self);
		440	} else {
		441	$self->_error (&Errno::ETIMEDOUT);
		442	}
		443
		444	# callback could have changed timeout value, optimise
		445	return unless $self->{timeout};
		446
		447	# calculate new after
		448	$after = $self->{timeout};
		449	}
		450
		451	Scalar::Util::weaken $self;
		452	return unless $self; # ->error could have destroyed $self
		453
		454	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		455	delete $self->{_tw};
		456	$self->_timeout;
		457	});
		458	} else {
		459	delete $self->{_tw};
		460	}
		461	}
		462
243	#############################################################################	463	#############################################################################
244		464
245	=back	465	=back
246		466
247	=head2 WRITE QUEUE	467	=head2 WRITE QUEUE
…		…
268	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
269		489
270	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
271		491
272	$cb->($self)	492	$cb->($self)
273	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
274	}	494	}
275		495
276	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
277		497
278	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
…		…
282	=cut	502	=cut
283		503
284	sub _drain_wbuf {	504	sub _drain_wbuf {
285	my ($self) = @_;	505	my ($self) = @_;
286		506
287	unless ($self->{ww}) {	507	if (!$self->{_ww} && length $self->{wbuf}) {
		508
288	Scalar::Util::weaken $self;	509	Scalar::Util::weaken $self;
		510
289	my $cb = sub {	511	my $cb = sub {
290	my $len = syswrite $self->{fh}, $self->{wbuf};	512	my $len = syswrite $self->{fh}, $self->{wbuf};
291		513
292	if ($len > 0) {	514	if ($len >= 0) {
293	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
294		516
		517	$self->{_activity} = AnyEvent->now;
		518
295	$self->{on_drain}($self)	519	$self->{on_drain}($self)
296	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
297	&& $self->{on_drain};	521	&& $self->{on_drain};
298		522
299	delete $self->{ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
300	} elsif ($! != EAGAIN && $! != EINTR) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
301	$self->error;	525	$self->_error ($!, 1);
302	}	526	}
303	};	527	};
304		528
		529	# try to write data immediately
		530	$cb->() unless $self->{autocork};
		531
		532	# if still data left in wbuf, we need to poll
305	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	533	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
306		534	if length $self->{wbuf};
307	$cb->($self);
308	};	535	};
		536	}
		537
		538	our %WH;
		539
		540	sub register_write_type($$) {
		541	$WH{$_[0]} = $_[1];
309	}	542	}
310		543
311	sub push_write {	544	sub push_write {
312	my $self = shift;	545	my $self = shift;
313		546
		547	if (@_ > 1) {
		548	my $type = shift;
		549
		550	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		551	->($self, @_);
		552	}
		553
314	if ($self->{filter_w}) {	554	if ($self->{tls}) {
315	$self->{filter_w}->($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
316	} else {	558	} else {
317	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
318	$self->_drain_wbuf;	560	$self->_drain_wbuf;
319	}	561	}
320	}	562	}
321		563
		564	=item $handle->push_write (type => @args)
		565
		566	Instead of formatting your data yourself, you can also let this module do
		567	the job by specifying a type and type-specific arguments.
		568
		569	Predefined types are (if you have ideas for additional types, feel free to
		570	drop by and tell us):
		571
		572	=over 4
		573
		574	=item netstring => $string
		575
		576	Formats the given value as netstring
		577	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		578
		579	=cut
		580
		581	register_write_type netstring => sub {
		582	my ($self, $string) = @_;
		583
		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
		600	};
		601
		602	=item json => $array_or_hashref
		603
		604	Encodes the given hash or array reference into a JSON object. Unless you
		605	provide your own JSON object, this means it will be encoded to JSON text
		606	in UTF-8.
		607
		608	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		609	one end of a handle and read them at the other end without using any
		610	additional framing.
		611
		612	The generated JSON text is guaranteed not to contain any newlines: While
		613	this module doesn't need delimiters after or between JSON texts to be
		614	able to read them, many other languages depend on that.
		615
		616	A simple RPC protocol that interoperates easily with others is to send
		617	JSON arrays (or objects, although arrays are usually the better choice as
		618	they mimic how function argument passing works) and a newline after each
		619	JSON text:
		620
		621	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		622	$handle->push_write ("\012");
		623
		624	An AnyEvent::Handle receiver would simply use the C<json> read type and
		625	rely on the fact that the newline will be skipped as leading whitespace:
		626
		627	$handle->push_read (json => sub { my $array = $_[1]; ... });
		628
		629	Other languages could read single lines terminated by a newline and pass
		630	this line into their JSON decoder of choice.
		631
		632	=cut
		633
		634	register_write_type json => sub {
		635	my ($self, $ref) = @_;
		636
		637	require JSON;
		638
		639	$self->{json} ? $self->{json}->encode ($ref)
		640	: JSON::encode_json ($ref)
		641	};
		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
		660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		661
		662	This function (not method) lets you add your own types to C<push_write>.
		663	Whenever the given C<type> is used, C<push_write> will invoke the code
		664	reference with the handle object and the remaining arguments.
		665
		666	The code reference is supposed to return a single octet string that will
		667	be appended to the write buffer.
		668
		669	Note that this is a function, and all types registered this way will be
		670	global, so try to use unique names.
		671
		672	=cut
		673
322	#############################################################################	674	#############################################################################
323		675
324	=back	676	=back
325		677
326	=head2 READ QUEUE	678	=head2 READ QUEUE
…		…
332	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
333	a queue.	685	a queue.
334		686
335	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
336	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
337	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
338	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).
339		692
340	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
341	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
342	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
343	below).	696	done its job (see C<push_read>, below).
344		697
345	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
346	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.
347		700
348	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
349	the specified number of bytes which give an XML datagram.	702	the specified number of bytes which give an XML datagram.
350		703
351	# in the default state, expect some header bytes	704	# in the default state, expect some header bytes
352	$handle->on_read (sub {	705	$handle->on_read (sub {
353	# 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)
354	shift->unshift_read_chunk (4, sub {	707	shift->unshift_read (chunk => 4, sub {
355	# header arrived, decode	708	# header arrived, decode
356	my $len = unpack "N", $_[1];	709	my $len = unpack "N", $_[1];
357		710
358	# now read the payload	711	# now read the payload
359	shift->unshift_read_chunk ($len, sub {	712	shift->unshift_read (chunk => $len, sub {
360	my $xml = $_[1];	713	my $xml = $_[1];
361	# handle xml	714	# handle xml
362	});	715	});
363	});	716	});
364	});	717	});
365		718
366	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"
367	"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
368	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
369	pipeline sending both requests and manipulate the queue as necessary in	722	just pipeline sending both requests and manipulate the queue as necessary
370	the callbacks:	723	in the callbacks.
371		724
372	# 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"
373	$handle->push_write ("request 1\015\012");	730	$handle->push_write ("request 1\015\012");
374		731
375	# 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
376	$handle->push_read_line (sub {	733	$handle->push_read (line => sub {
377	# if we got an "OK", we have to _prepend_ another line,	734	# if we got an "OK", we have to _prepend_ another line,
378	# 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
379	# which are already in the queue when this callback is called	736	# which are already in the queue when this callback is called
380	# we don't do this in case we got an error	737	# we don't do this in case we got an error
381	if ($_[1] eq "OK") {	738	if ($_[1] eq "OK") {
382	$_[0]->unshift_read_line (sub {	739	$_[0]->unshift_read (line => sub {
383	my $response = $_[1];	740	my $response = $_[1];
384	...	741	...
385	});	742	});
386	}	743	}
387	});	744	});
388		745
389	# request two	746	# request two, simply returns 64 octets
390	$handle->push_write ("request 2\015\012");	747	$handle->push_write ("request 2\015\012");
391		748
392	# simply read 64 bytes, always	749	# simply read 64 bytes, always
393	$handle->push_read_chunk (64, sub {	750	$handle->push_read (chunk => 64, sub {
394	my $response = $_[1];	751	my $response = $_[1];
395	...	752	...
396	});	753	});
397		754
398	=over 4	755	=over 4
399		756
400	=cut	757	=cut
401		758
402	sub _drain_rbuf {	759	sub _drain_rbuf {
403	my ($self) = @_;	760	my ($self) = @_;
		761
		762	local $self->{_in_drain} = 1;
404		763
405	if (	764	if (
406	defined $self->{rbuf_max}	765	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	766	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	767	) {
409	$! = &Errno::ENOSPC; return $self->error;	768	$self->_error (&Errno::ENOSPC, 1), return;
410	}	769	}
411		770
412	return if $self->{in_drain};	771	while () {
413	local $self->{in_drain} = 1;
414
415	while (my $len = length $self->{rbuf}) {	772	my $len = length $self->{rbuf};
416	no strict 'refs';	773
417	if (my $cb = shift @{ $self->{queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
418	if (!$cb->($self)) {	775	unless ($cb->($self)) {
419	if ($self->{eof}) {	776	if ($self->{_eof}) {
420	# 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)
421	$! = &Errno::EPIPE; return $self->error;	778	$self->_error (&Errno::EPIPE, 1), return;
422	}	779	}
423		780
424	unshift @{ $self->{queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
425	return;	782	last;
426	}	783	}
427	} elsif ($self->{on_read}) {	784	} elsif ($self->{on_read}) {
		785	last unless $len;
		786
428	$self->{on_read}($self);	787	$self->{on_read}($self);
429		788
430	if (	789	if (
431	$self->{eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed	790	$len == length $self->{rbuf} # if no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty	791	&& !@{ $self->{_queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data	792	&& $self->{on_read} # but we still have on_read
435	) {	793	) {
		794	# no further data will arrive
436	# then no progress can be made	795	# so no progress can be made
437	$! = &Errno::EPIPE; return $self->error;	796	$self->_error (&Errno::EPIPE, 1), return
		797	if $self->{_eof};
		798
		799	last; # more data might arrive
438	}	800	}
439	} else {	801	} else {
440	# read side becomes idle	802	# read side becomes idle
441	delete $self->{rw};	803	delete $self->{_rw} unless $self->{tls};
442	return;	804	last;
443	}	805	}
444	}	806	}
445		807
446	if ($self->{eof}) {	808	if ($self->{_eof}) {
447	$self->_shutdown;	809	if ($self->{on_eof}) {
448	$self->{on_eof}($self)	810	$self->{on_eof}($self)
449	if $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} };
450	}	820	}
451	}	821	}
452		822
453	=item $handle->on_read ($cb)	823	=item $handle->on_read ($cb)
454		824
…		…
460		830
461	sub on_read {	831	sub on_read {
462	my ($self, $cb) = @_;	832	my ($self, $cb) = @_;
463		833
464	$self->{on_read} = $cb;	834	$self->{on_read} = $cb;
		835	$self->_drain_rbuf if $cb && !$self->{_in_drain};
465	}	836	}
466		837
467	=item $handle->rbuf	838	=item $handle->rbuf
468		839
469	Returns the read buffer (as a modifiable lvalue).	840	Returns the read buffer (as a modifiable lvalue).
…		…
500	interested in (which can be none at all) and return a true value. After returning	871	interested in (which can be none at all) and return a true value. After returning
501	true, it will be removed from the queue.	872	true, it will be removed from the queue.
502		873
503	=cut	874	=cut
504		875
		876	our %RH;
		877
		878	sub register_read_type($$) {
		879	$RH{$_[0]} = $_[1];
		880	}
		881
505	sub push_read {	882	sub push_read {
506	my ($self, $cb) = @_;	883	my $self = shift;
		884	my $cb = pop;
507		885
		886	if (@_) {
		887	my $type = shift;
		888
		889	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		890	->($self, $cb, @_);
		891	}
		892
508	push @{ $self->{queue} }, $cb;	893	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	894	$self->_drain_rbuf unless $self->{_in_drain};
510	}	895	}
511		896
512	sub unshift_read {	897	sub unshift_read {
513	my ($self, $cb) = @_;	898	my $self = shift;
		899	my $cb = pop;
514		900
		901	if (@_) {
		902	my $type = shift;
		903
		904	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		905	->($self, $cb, @_);
		906	}
		907
		908
515	push @{ $self->{queue} }, $cb;	909	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	910	$self->_drain_rbuf unless $self->{_in_drain};
517	}	911	}
518		912
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	913	=item $handle->push_read (type => @args, $cb)
520		914
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	915	=item $handle->unshift_read (type => @args, $cb)
522		916
523	Append the given callback to the end of the queue (C<push_read_chunk>) or	917	Instead of providing a callback that parses the data itself you can chose
524	prepend it (C<unshift_read_chunk>).	918	between a number of predefined parsing formats, for chunks of data, lines
		919	etc.
525		920
526	The callback will be called only once C<$len> bytes have been read, and	921	Predefined types are (if you have ideas for additional types, feel free to
527	these C<$len> bytes will be passed to the callback.	922	drop by and tell us):
528		923
529	=cut	924	=over 4
530		925
531	sub _read_chunk($$) {	926	=item chunk => $octets, $cb->($handle, $data)
		927
		928	Invoke the callback only once C<$octets> bytes have been read. Pass the
		929	data read to the callback. The callback will never be called with less
		930	data.
		931
		932	Example: read 2 bytes.
		933
		934	$handle->push_read (chunk => 2, sub {
		935	warn "yay ", unpack "H*", $_[1];
		936	});
		937
		938	=cut
		939
		940	register_read_type chunk => sub {
532	my ($self, $len, $cb) = @_;	941	my ($self, $cb, $len) = @_;
533		942
534	sub {	943	sub {
535	$len <= length $_[0]{rbuf} or return;	944	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	945	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	946	1
538	}	947	}
539	}	948	};
540		949
541	sub push_read_chunk {	950	=item line => [$eol, ]$cb->($handle, $line, $eol)
542	$_[0]->push_read (&_read_chunk);
543	}
544
545
546	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);
548	}
549
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))
551
552	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
553
554	Append the given callback to the end of the queue (C<push_read_line>) or
555	prepend it (C<unshift_read_line>).
556		951
557	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
558	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
559	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
560	the end of line marker as the third argument (C<$eol>).	955	the end of line marker as the third argument (C<$eol>).
…		…
571	Partial lines at the end of the stream will never be returned, as they are	966	Partial lines at the end of the stream will never be returned, as they are
572	not marked by the end of line marker.	967	not marked by the end of line marker.
573		968
574	=cut	969	=cut
575		970
576	sub _read_line($$) {	971	register_read_type line => sub {
577	my $self = shift;	972	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr|(\015?\012)|;
580	my $pos;
581		973
		974	if (@_ < 3) {
		975	# this is more than twice as fast as the generic code below
		976	sub {
		977	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		978
		979	$cb->($_[0], $1, $2);
		980	1
		981	}
		982	} else {
582	$eol = quotemeta $eol unless ref $eol;	983	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr|^(.*?)($eol)|s;	984	$eol = qr|^(.*?)($eol)|s;
		985
		986	sub {
		987	$_[0]{rbuf} =~ s/$eol// or return;
		988
		989	$cb->($_[0], $1, $2);
		990	1
		991	}
		992	}
		993	};
		994
		995	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		996
		997	Makes a regex match against the regex object C<$accept> and returns
		998	everything up to and including the match.
		999
		1000	Example: read a single line terminated by '\n'.
		1001
		1002	$handle->push_read (regex => qr<\n>, sub { ... });
		1003
		1004	If C<$reject> is given and not undef, then it determines when the data is
		1005	to be rejected: it is matched against the data when the C<$accept> regex
		1006	does not match and generates an C<EBADMSG> error when it matches. This is
		1007	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		1008	receive buffer overflow).
		1009
		1010	Example: expect a single decimal number followed by whitespace, reject
		1011	anything else (not the use of an anchor).
		1012
		1013	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		1014
		1015	If C<$skip> is given and not C<undef>, then it will be matched against
		1016	the receive buffer when neither C<$accept> nor C<$reject> match,
		1017	and everything preceding and including the match will be accepted
		1018	unconditionally. This is useful to skip large amounts of data that you
		1019	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		1020	have to start matching from the beginning. This is purely an optimisation
		1021	and is usually worth only when you expect more than a few kilobytes.
		1022
		1023	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		1024	expect the header to be very large (it isn't in practise, but...), we use
		1025	a skip regex to skip initial portions. The skip regex is tricky in that
		1026	it only accepts something not ending in either \015 or \012, as these are
		1027	required for the accept regex.
		1028
		1029	$handle->push_read (regex =>
		1030	qr<\015\012\015\012>,
		1031	undef, # no reject
		1032	qr<^.*[^\015\012]>,
		1033	sub { ... });
		1034
		1035	=cut
		1036
		1037	register_read_type regex => sub {
		1038	my ($self, $cb, $accept, $reject, $skip) = @_;
		1039
		1040	my $data;
		1041	my $rbuf = \$self->{rbuf};
584		1042
585	sub {	1043	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	1044	# accept
		1045	if ($$rbuf =~ $accept) {
		1046	$data .= substr $$rbuf, 0, $+[0], "";
		1047	$cb->($self, $data);
		1048	return 1;
		1049	}
		1050
		1051	# reject
		1052	if ($reject && $$rbuf =~ $reject) {
		1053	$self->_error (&Errno::EBADMSG);
		1054	}
587		1055
588	$cb->($_[0], $1, $2);	1056	# skip
		1057	if ($skip && $$rbuf =~ $skip) {
		1058	$data .= substr $$rbuf, 0, $+[0], "";
		1059	}
		1060
		1061	()
		1062	}
		1063	};
		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
589	1	1097	1
590	}	1098	}
591	}	1099	};
592		1100
593	sub push_read_line {	1101	=item packstring => $format, $cb->($handle, $string)
594	$_[0]->push_read (&_read_line);
595	}
596		1102
597	sub unshift_read_line {	1103	An octet string prefixed with an encoded length. The encoding C<$format>
598	$_[0]->unshift_read (&_read_line);	1104	uses the same format as a Perl C<pack> format, but must specify a single
599	}	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
		1147	=item json => $cb->($handle, $hash_or_arrayref)
		1148
		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.
		1151
		1152	If a C<json> object was passed to the constructor, then that will be used
		1153	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1154
		1155	This read type uses the incremental parser available with JSON version
		1156	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1157	dependency on your own: this module will load the JSON module, but
		1158	AnyEvent does not depend on it itself.
		1159
		1160	Since JSON texts are fully self-delimiting, the C<json> read and write
		1161	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1162	the C<json> write type description, above, for an actual example.
		1163
		1164	=cut
		1165
		1166	register_read_type json => sub {
		1167	my ($self, $cb) = @_;
		1168
		1169	require JSON;
		1170
		1171	my $data;
		1172	my $rbuf = \$self->{rbuf};
		1173
		1174	my $json = $self->{json} ||= JSON->new->utf8;
		1175
		1176	sub {
		1177	eval {
		1178	my $ref = $json->incr_parse ($self->{rbuf});
		1179
		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	# error case
		1194	$json->incr_skip;
		1195
		1196	$self->{rbuf} = $json->incr_text;
		1197	$json->incr_text = "";
		1198
		1199	$self->_error (&Errno::EBADMSG);
		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));
		1231	} else {
		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	}
		1242	});
		1243	}
		1244
		1245	1
		1246	}
		1247	};
		1248
		1249	=back
		1250
		1251	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1252
		1253	This function (not method) lets you add your own types to C<push_read>.
		1254
		1255	Whenever the given C<type> is used, C<push_read> will invoke the code
		1256	reference with the handle object, the callback and the remaining
		1257	arguments.
		1258
		1259	The code reference is supposed to return a callback (usually a closure)
		1260	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1261
		1262	It should invoke the passed callback when it is done reading (remember to
		1263	pass C<$handle> as first argument as all other callbacks do that).
		1264
		1265	Note that this is a function, and all types registered this way will be
		1266	global, so try to use unique names.
		1267
		1268	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1269	search for C<register_read_type>)).
600		1270
601	=item $handle->stop_read	1271	=item $handle->stop_read
602		1272
603	=item $handle->start_read	1273	=item $handle->start_read
604		1274
605	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
606	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
607	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
608	C<start_read>.	1278	C<start_read>.
609		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
610	=cut	1288	=cut
611		1289
612	sub stop_read {	1290	sub stop_read {
613	my ($self) = @_;	1291	my ($self) = @_;
614		1292
615	delete $self->{rw};	1293	delete $self->{_rw} unless $self->{tls};
616	}	1294	}
617		1295
618	sub start_read {	1296	sub start_read {
619	my ($self) = @_;	1297	my ($self) = @_;
620		1298
621	unless ($self->{rw} || $self->{eof}) {	1299	unless ($self->{_rw} || $self->{_eof}) {
622	Scalar::Util::weaken $self;	1300	Scalar::Util::weaken $self;
623		1301
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1302	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1303	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
626	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;
627		1305
628	if ($len > 0) {	1306	if ($len > 0) {
629	$self->{filter_r}	1307	$self->{_activity} = AnyEvent->now;
630	? $self->{filter_r}->($self, $rbuf)	1308
631	: $self->_drain_rbuf;	1309	if ($self->{tls}) {
		1310	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1311
		1312	&_dotls ($self);
		1313	} else {
		1314	$self->_drain_rbuf unless $self->{_in_drain};
		1315	}
632		1316
633	} elsif (defined $len) {	1317	} elsif (defined $len) {
634	delete $self->{rw};	1318	delete $self->{_rw};
635	$self->{eof} = 1;	1319	$self->{_eof} = 1;
636	$self->_drain_rbuf;	1320	$self->_drain_rbuf unless $self->{_in_drain};
637		1321
638	} elsif ($! != EAGAIN && $! != EINTR) {	1322	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
639	return $self->error;	1323	return $self->_error ($!, 1);
640	}	1324	}
641	});	1325	});
642	}	1326	}
643	}	1327	}
644		1328
		1329	# poll the write BIO and send the data if applicable
645	sub _dotls {	1330	sub _dotls {
646	my ($self) = @_;	1331	my ($self) = @_;
647		1332
		1333	my $tmp;
		1334
648	if (length $self->{tls_wbuf}) {	1335	if (length $self->{_tls_wbuf}) {
649	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1336	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "";	1337	substr $self->{_tls_wbuf}, 0, $tmp, "";
651	}	1338	}
652	}	1339	}
653		1340
654	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	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
		1349	$self->{rbuf} .= $tmp;
		1350	$self->_drain_rbuf unless $self->{_in_drain};
		1351	$self->{tls} or return; # tls session might have gone away in callback
		1352	}
		1353
		1354	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1355
		1356	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
		1357	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
		1358	return $self->_error ($!, 1);
		1359	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
		1360	return $self->_error (&Errno::EIO, 1);
		1361	}
		1362
		1363	# all other errors are fine for our purposes
		1364	}
		1365
		1366	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
655	$self->{wbuf} .= $buf;	1367	$self->{wbuf} .= $tmp;
656	$self->_drain_wbuf;	1368	$self->_drain_wbuf;
657	}
658
659	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
660	$self->{rbuf} .= $buf;
661	$self->_drain_rbuf;
662	}
663
664	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
665
666	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
667	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
668	$self->error;
669	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
670	$! = &Errno::EIO;
671	$self->error;
672	}
673
674	# all others are fine for our purposes
675	}	1369	}
676	}	1370	}
677		1371
678	=item $handle->starttls ($tls[, $tls_ctx])	1372	=item $handle->starttls ($tls[, $tls_ctx])
679		1373
…		…
685	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1379	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
686		1380
687	The second argument is the optional C<Net::SSLeay::CTX> object that is	1381	The second argument is the optional C<Net::SSLeay::CTX> object that is
688	used when AnyEvent::Handle has to create its own TLS connection object.	1382	used when AnyEvent::Handle has to create its own TLS connection object.
689		1383
690	=cut	1384	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1385	call and can be used or changed to your liking. Note that the handshake
		1386	might have already started when this function returns.
691		1387
692	# TODO: maybe document...	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
		1391	=cut
		1392
693	sub starttls {	1393	sub starttls {
694	my ($self, $ssl, $ctx) = @_;	1394	my ($self, $ssl, $ctx) = @_;
695		1395
696	$self->stoptls;	1396	require Net::SSLeay;
697		1397
		1398	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1399	if $self->{tls};
		1400
698	if ($ssl eq "accept") {	1401	if ($ssl eq "accept") {
699	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1402	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
700	Net::SSLeay::set_accept_state ($ssl);	1403	Net::SSLeay::set_accept_state ($ssl);
701	} elsif ($ssl eq "connect") {	1404	} elsif ($ssl eq "connect") {
702	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1405	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
…		…
707		1410
708	# 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)
709	# but the openssl maintainers basically said: "trust us, it just works".	1412	# but the openssl maintainers basically said: "trust us, it just works".
710	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1413	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
711	# and mismaintained ssleay-module doesn't even offer them).	1414	# and mismaintained ssleay-module doesn't even offer them).
		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.
712	Net::SSLeay::CTX_set_mode ($self->{tls},	1423	Net::SSLeay::CTX_set_mode ($self->{tls},
713	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1424	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
714	| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1425	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
715		1426
716	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1427	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
717	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
718		1429
719	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1430	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
720		1431
721	$self->{filter_w} = sub {	1432	&_dotls; # need to trigger the initial handshake
722	$_[0]{tls_wbuf} .= ${$_[1]};	1433	$self->start_read; # make sure we actually do read
723	&_dotls;
724	};
725	$self->{filter_r} = sub {
726	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
727	&_dotls;
728	};
729	}	1434	}
730		1435
731	=item $handle->stoptls	1436	=item $handle->stoptls
732		1437
733	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
734	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.
735		1442
736	=cut	1443	=cut
737		1444
738	sub stoptls {	1445	sub stoptls {
739	my ($self) = @_;	1446	my ($self) = @_;
740		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
741	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1464	Net::SSLeay::free (delete $self->{tls});
742	delete $self->{tls_rbio};	1465
743	delete $self->{tls_wbio};	1466	delete @$self{qw(_rbio _wbio _tls_wbuf)};
744	delete $self->{tls_wbuf};
745	delete $self->{filter_r};
746	delete $self->{filter_w};
747	}	1467	}
748		1468
749	sub DESTROY {	1469	sub DESTROY {
750	my $self = shift;	1470	my $self = shift;
751		1471
752	$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 = ();
753	}	1520	}
754		1521
755	=item AnyEvent::Handle::TLS_CTX	1522	=item AnyEvent::Handle::TLS_CTX
756		1523
757	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
…		…
787	}	1554	}
788	}	1555	}
789		1556
790	=back	1557	=back
791		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
		1631	=head1 SUBCLASSING AnyEvent::Handle
		1632
		1633	In many cases, you might want to subclass AnyEvent::Handle.
		1634
		1635	To make this easier, a given version of AnyEvent::Handle uses these
		1636	conventions:
		1637
		1638	=over 4
		1639
		1640	=item * all constructor arguments become object members.
		1641
		1642	At least initially, when you pass a C<tls>-argument to the constructor it
		1643	will end up in C<< $handle->{tls} >>. Those members might be changed or
		1644	mutated later on (for example C<tls> will hold the TLS connection object).
		1645
		1646	=item * other object member names are prefixed with an C<_>.
		1647
		1648	All object members not explicitly documented (internal use) are prefixed
		1649	with an underscore character, so the remaining non-C<_>-namespace is free
		1650	for use for subclasses.
		1651
		1652	=item * all members not documented here and not prefixed with an underscore
		1653	are free to use in subclasses.
		1654
		1655	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1656	member variables, but thats just life, at least it is documented.
		1657
		1658	=back
		1659
792	=head1 AUTHOR	1660	=head1 AUTHOR
793		1661
794	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1662	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
795		1663
796	=cut	1664	=cut

Diff Legend

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