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.12 by elmex, Thu May 15 09:03:43 2008 UTC vs.
Revision 1.108 by root, Tue Jan 6 20:08:05 2009 UTC

1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util ();	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 filehandles 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 = '0.02';	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;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
29
30	#TODO
31
32	# or use the constructor to pass the callback:
33
34	my $ae_fh2 =
35	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
36	fh => \*STDIN,	30	fh => \*STDIN,
37	on_eof => sub {	31	on_eof => sub {
38	$cv->broadcast;	32	$cv->send;
39	},	33	},
40	#TODO
41	);	34	);
42		35
43	$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;
44		47
45	=head1 DESCRIPTION	48	=head1 DESCRIPTION
46		49
47	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
48	filehandles (and sockets, see L<AnyEvent::Socket> for an easy way to make	51	filehandles. For utility functions for doing non-blocking connects and accepts
49	non-blocking resolves and connects).	52	on sockets see L<AnyEvent::Util>.
		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
50		56
51	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
52	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
53	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
54		60
…		…
67		73
68	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
69		75
70	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
71		77
72	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
73	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
74		81
75	=item on_eof => $cb->($self) [MANDATORY]
76
77	Set the callback to be called on EOF.
78
79	=item on_error => $cb->($self)	82	=item on_eof => $cb->($handle)
80		83
		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.
		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
		93	While not mandatory, it is I<highly> recommended to set an EOF callback,
		94	otherwise you might end up with a closed socket while you are still
		95	waiting for data.
		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
		99
		100	=item on_error => $cb->($handle, $fatal)
		101
81	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
82	ocurs, 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
83	or a read error.	104	connect or a read error.
84		105
85	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
86	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>).
87		116
88	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
89	error (or C<ENOSPC> or C<EPIPE>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
90		119
91	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
92	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
93	die.	122	C<croak>.
94		123
95	=item on_read => $cb->($self)	124	=item on_read => $cb->($handle)
96		125
97	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
98	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).
99		130
100	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 >>
101	method or acces sthe C<$self->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
102		133
103	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
104	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
105	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
106	error will be raised (with C<$!> set to C<EPIPE>).	137	error will be raised (with C<$!> set to C<EPIPE>).
107		138
108	=item on_drain => $cb->()	139	=item on_drain => $cb->($handle)
109		140
110	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
111	(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).
112		143
113	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.
114		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
115	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
116		174
117	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>)
118	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
119	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
120		178
121	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
122	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
123	(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
124	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
125	isn't finished).	183	isn't finished).
126		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
127	=item read_size => <bytes>	211	=item read_size => <bytes>
128		212
129	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
130	on each [loop iteration). Default: C<4096>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
131		216
132	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
133		218
134	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
135	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
136	considered empty.	221	considered empty.
137		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
		240	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
		241
		242	When this parameter is given, it enables TLS (SSL) mode, that means
		243	AnyEvent will start a TLS handshake as soon as the conenction has been
		244	established and will transparently encrypt/decrypt data afterwards.
		245
		246	TLS mode requires Net::SSLeay to be installed (it will be loaded
		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.
		254
		255	You can also provide your own TLS connection object, but you have
		256	to make sure that you call either C<Net::SSLeay::set_connect_state>
		257	or C<Net::SSLeay::set_accept_state> on it before you pass it to
		258	AnyEvent::Handle.
		259
		260	See the C<< ->starttls >> method for when need to start TLS negotiation later.
		261
		262	=item tls_ctx => $ssl_ctx
		263
		264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
		265	(unless a connection object was specified directly). If this parameter is
		266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		267
		268	=item json => JSON or JSON::XS object
		269
		270	This is the json coder object used by the C<json> read and write types.
		271
		272	If you don't supply it, then AnyEvent::Handle will create and use a
		273	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		274	texts.
		275
		276	Note that you are responsible to depend on the JSON module if you want to
		277	use this functionality, as AnyEvent does not have a dependency itself.
		278
138	=back	279	=back
139		280
140	=cut	281	=cut
141		282
142	sub new {	283	sub new {
…		…
146		287
147	$self->{fh} or Carp::croak "mandatory argument fh is missing";	288	$self->{fh} or Carp::croak "mandatory argument fh is missing";
148		289
149	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
150		291
151	$self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing");	292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		293	if $self->{tls};
152		294
153	$self->on_error (delete $self->{on_error}) if $self->{on_error};	295	$self->{_activity} = AnyEvent->now;
		296	$self->_timeout;
		297
154	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
155	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
156		300
157	$self->start_read;	301	$self->start_read
		302	if $self->{on_read};
158		303
159	$self	304	$self
160	}	305	}
161		306
162	sub _shutdown {	307	sub _shutdown {
163	my ($self) = @_;	308	my ($self) = @_;
164		309
		310	delete $self->{_tw};
165	delete $self->{rw};	311	delete $self->{_rw};
166	delete $self->{ww};	312	delete $self->{_ww};
167	delete $self->{fh};	313	delete $self->{fh};
168	}
169		314
		315	&_freetls;
		316
		317	delete $self->{on_read};
		318	delete $self->{_queue};
		319	}
		320
170	sub error {	321	sub _error {
171	my ($self) = @_;	322	my ($self, $errno, $fatal) = @_;
172		323
173	{
174	local $!;
175	$self->_shutdown;	324	$self->_shutdown
176	}	325	if $fatal;
		326
		327	$! = $errno;
177		328
178	if ($self->{on_error}) {	329	if ($self->{on_error}) {
179	$self->{on_error}($self);	330	$self->{on_error}($self, $fatal);
180	} else {	331	} elsif ($self->{fh}) {
181	die "AnyEvent::Handle uncaught fatal error: $!";	332	Carp::croak "AnyEvent::Handle uncaught error: $!";
182	}	333	}
183	}	334	}
184		335
185	=item $fh = $handle->fh	336	=item $fh = $handle->fh
186		337
187	This method returns the filehandle of the L<AnyEvent::Handle> object.	338	This method returns the file handle used to create the L<AnyEvent::Handle> object.
188		339
189	=cut	340	=cut
190		341
191	sub fh { $_[0]->{fh} }	342	sub fh { $_[0]{fh} }
192		343
193	=item $handle->on_error ($cb)	344	=item $handle->on_error ($cb)
194		345
195	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	346	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
196		347
…		…
208		359
209	sub on_eof {	360	sub on_eof {
210	$_[0]{on_eof} = $_[1];	361	$_[0]{on_eof} = $_[1];
211	}	362	}
212		363
		364	=item $handle->on_timeout ($cb)
		365
		366	Replace the current C<on_timeout> callback, or disables the callback (but
		367	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
		368	argument and method.
		369
		370	=cut
		371
		372	sub on_timeout {
		373	$_[0]{on_timeout} = $_[1];
		374	}
		375
		376	=item $handle->autocork ($boolean)
		377
		378	Enables or disables the current autocork behaviour (see C<autocork>
		379	constructor argument). Changes will only take effect on the next write.
		380
		381	=cut
		382
		383	sub autocork {
		384	$_[0]{autocork} = $_[1];
		385	}
		386
		387	=item $handle->no_delay ($boolean)
		388
		389	Enables or disables the C<no_delay> setting (see constructor argument of
		390	the same name for details).
		391
		392	=cut
		393
		394	sub no_delay {
		395	$_[0]{no_delay} = $_[1];
		396
		397	eval {
		398	local $SIG{__DIE__};
		399	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		400	};
		401	}
		402
		403	#############################################################################
		404
		405	=item $handle->timeout ($seconds)
		406
		407	Configures (or disables) the inactivity timeout.
		408
		409	=cut
		410
		411	sub timeout {
		412	my ($self, $timeout) = @_;
		413
		414	$self->{timeout} = $timeout;
		415	$self->_timeout;
		416	}
		417
		418	# reset the timeout watcher, as neccessary
		419	# also check for time-outs
		420	sub _timeout {
		421	my ($self) = @_;
		422
		423	if ($self->{timeout}) {
		424	my $NOW = AnyEvent->now;
		425
		426	# when would the timeout trigger?
		427	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		428
		429	# now or in the past already?
		430	if ($after <= 0) {
		431	$self->{_activity} = $NOW;
		432
		433	if ($self->{on_timeout}) {
		434	$self->{on_timeout}($self);
		435	} else {
		436	$self->_error (&Errno::ETIMEDOUT);
		437	}
		438
		439	# callback could have changed timeout value, optimise
		440	return unless $self->{timeout};
		441
		442	# calculate new after
		443	$after = $self->{timeout};
		444	}
		445
		446	Scalar::Util::weaken $self;
		447	return unless $self; # ->error could have destroyed $self
		448
		449	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		450	delete $self->{_tw};
		451	$self->_timeout;
		452	});
		453	} else {
		454	delete $self->{_tw};
		455	}
		456	}
		457
213	#############################################################################	458	#############################################################################
214		459
215	=back	460	=back
216		461
217	=head2 WRITE QUEUE	462	=head2 WRITE QUEUE
…		…
220	for reading.	465	for reading.
221		466
222	The write queue is very simple: you can add data to its end, and	467	The write queue is very simple: you can add data to its end, and
223	AnyEvent::Handle will automatically try to get rid of it for you.	468	AnyEvent::Handle will automatically try to get rid of it for you.
224		469
225	When data could be writtena nd the write buffer is shorter then the low	470	When data could be written and the write buffer is shorter then the low
226	water mark, the C<on_drain> callback will be invoked.	471	water mark, the C<on_drain> callback will be invoked.
227		472
228	=over 4	473	=over 4
229		474
230	=item $handle->on_drain ($cb)	475	=item $handle->on_drain ($cb)
…		…
238	my ($self, $cb) = @_;	483	my ($self, $cb) = @_;
239		484
240	$self->{on_drain} = $cb;	485	$self->{on_drain} = $cb;
241		486
242	$cb->($self)	487	$cb->($self)
243	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	488	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
244	}	489	}
245		490
246	=item $handle->push_write ($data)	491	=item $handle->push_write ($data)
247		492
248	Queues the given scalar to be written. You can push as much data as you	493	Queues the given scalar to be written. You can push as much data as you
249	want (only limited by the available memory), as C<AnyEvent::Handle>	494	want (only limited by the available memory), as C<AnyEvent::Handle>
250	buffers it independently of the kernel.	495	buffers it independently of the kernel.
251		496
252	=cut	497	=cut
253		498
254	sub push_write {	499	sub _drain_wbuf {
255	my ($self, $data) = @_;	500	my ($self) = @_;
256		501
257	$self->{wbuf} .= $data;	502	if (!$self->{_ww} && length $self->{wbuf}) {
258		503
259	unless ($self->{ww}) {
260	Scalar::Util::weaken $self;	504	Scalar::Util::weaken $self;
		505
261	my $cb = sub {	506	my $cb = sub {
262	my $len = syswrite $self->{fh}, $self->{wbuf};	507	my $len = syswrite $self->{fh}, $self->{wbuf};
263		508
264	if ($len > 0) {	509	if ($len >= 0) {
265	substr $self->{wbuf}, 0, $len, "";	510	substr $self->{wbuf}, 0, $len, "";
266		511
		512	$self->{_activity} = AnyEvent->now;
267		513
268	$self->{on_drain}($self)	514	$self->{on_drain}($self)
269	if $self->{low_water_mark} >= length $self->{wbuf}	515	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
270	&& $self->{on_drain};	516	&& $self->{on_drain};
271		517
272	delete $self->{ww} unless length $self->{wbuf};	518	delete $self->{_ww} unless length $self->{wbuf};
273	} elsif ($! != EAGAIN && $! != EINTR) {	519	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
274	$self->error;	520	$self->_error ($!, 1);
275	}	521	}
276	};	522	};
277		523
		524	# try to write data immediately
		525	$cb->() unless $self->{autocork};
		526
		527	# if still data left in wbuf, we need to poll
278	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	528	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
279		529	if length $self->{wbuf};
280	$cb->($self);
281	};	530	};
282	}	531	}
		532
		533	our %WH;
		534
		535	sub register_write_type($$) {
		536	$WH{$_[0]} = $_[1];
		537	}
		538
		539	sub push_write {
		540	my $self = shift;
		541
		542	if (@_ > 1) {
		543	my $type = shift;
		544
		545	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		546	->($self, @_);
		547	}
		548
		549	if ($self->{tls}) {
		550	$self->{_tls_wbuf} .= $_[0];
		551
		552	&_dotls ($self);
		553	} else {
		554	$self->{wbuf} .= $_[0];
		555	$self->_drain_wbuf;
		556	}
		557	}
		558
		559	=item $handle->push_write (type => @args)
		560
		561	Instead of formatting your data yourself, you can also let this module do
		562	the job by specifying a type and type-specific arguments.
		563
		564	Predefined types are (if you have ideas for additional types, feel free to
		565	drop by and tell us):
		566
		567	=over 4
		568
		569	=item netstring => $string
		570
		571	Formats the given value as netstring
		572	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		573
		574	=cut
		575
		576	register_write_type netstring => sub {
		577	my ($self, $string) = @_;
		578
		579	(length $string) . ":$string,"
		580	};
		581
		582	=item packstring => $format, $data
		583
		584	An octet string prefixed with an encoded length. The encoding C<$format>
		585	uses the same format as a Perl C<pack> format, but must specify a single
		586	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		587	optional C<!>, C<< < >> or C<< > >> modifier).
		588
		589	=cut
		590
		591	register_write_type packstring => sub {
		592	my ($self, $format, $string) = @_;
		593
		594	pack "$format/a*", $string
		595	};
		596
		597	=item json => $array_or_hashref
		598
		599	Encodes the given hash or array reference into a JSON object. Unless you
		600	provide your own JSON object, this means it will be encoded to JSON text
		601	in UTF-8.
		602
		603	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		604	one end of a handle and read them at the other end without using any
		605	additional framing.
		606
		607	The generated JSON text is guaranteed not to contain any newlines: While
		608	this module doesn't need delimiters after or between JSON texts to be
		609	able to read them, many other languages depend on that.
		610
		611	A simple RPC protocol that interoperates easily with others is to send
		612	JSON arrays (or objects, although arrays are usually the better choice as
		613	they mimic how function argument passing works) and a newline after each
		614	JSON text:
		615
		616	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		617	$handle->push_write ("\012");
		618
		619	An AnyEvent::Handle receiver would simply use the C<json> read type and
		620	rely on the fact that the newline will be skipped as leading whitespace:
		621
		622	$handle->push_read (json => sub { my $array = $_[1]; ... });
		623
		624	Other languages could read single lines terminated by a newline and pass
		625	this line into their JSON decoder of choice.
		626
		627	=cut
		628
		629	register_write_type json => sub {
		630	my ($self, $ref) = @_;
		631
		632	require JSON;
		633
		634	$self->{json} ? $self->{json}->encode ($ref)
		635	: JSON::encode_json ($ref)
		636	};
		637
		638	=item storable => $reference
		639
		640	Freezes the given reference using L<Storable> and writes it to the
		641	handle. Uses the C<nfreeze> format.
		642
		643	=cut
		644
		645	register_write_type storable => sub {
		646	my ($self, $ref) = @_;
		647
		648	require Storable;
		649
		650	pack "w/a*", Storable::nfreeze ($ref)
		651	};
		652
		653	=back
		654
		655	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		656
		657	This function (not method) lets you add your own types to C<push_write>.
		658	Whenever the given C<type> is used, C<push_write> will invoke the code
		659	reference with the handle object and the remaining arguments.
		660
		661	The code reference is supposed to return a single octet string that will
		662	be appended to the write buffer.
		663
		664	Note that this is a function, and all types registered this way will be
		665	global, so try to use unique names.
		666
		667	=cut
283		668
284	#############################################################################	669	#############################################################################
285		670
286	=back	671	=back
287		672
…		…
294	ways, the "simple" way, using only C<on_read> and the "complex" way, using	679	ways, the "simple" way, using only C<on_read> and the "complex" way, using
295	a queue.	680	a queue.
296		681
297	In the simple case, you just install an C<on_read> callback and whenever	682	In the simple case, you just install an C<on_read> callback and whenever
298	new data arrives, it will be called. You can then remove some data (if	683	new data arrives, it will be called. You can then remove some data (if
299	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	684	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
300	or not.	685	leave the data there if you want to accumulate more (e.g. when only a
		686	partial message has been received so far).
301		687
302	In the more complex case, you want to queue multiple callbacks. In this	688	In the more complex case, you want to queue multiple callbacks. In this
303	case, AnyEvent::Handle will call the first queued callback each time new	689	case, AnyEvent::Handle will call the first queued callback each time new
304	data arrives and removes it when it has done its job (see C<push_read>,	690	data arrives (also the first time it is queued) and removes it when it has
305	below).	691	done its job (see C<push_read>, below).
306		692
307	This way you can, for example, push three line-reads, followed by reading	693	This way you can, for example, push three line-reads, followed by reading
308	a chunk of data, and AnyEvent::Handle will execute them in order.	694	a chunk of data, and AnyEvent::Handle will execute them in order.
309		695
310	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	696	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
311	the specified number of bytes which give an XML datagram.	697	the specified number of bytes which give an XML datagram.
312		698
313	# in the default state, expect some header bytes	699	# in the default state, expect some header bytes
314	$handle->on_read (sub {	700	$handle->on_read (sub {
315	# some data is here, now queue the length-header-read (4 octets)	701	# some data is here, now queue the length-header-read (4 octets)
316	shift->unshift_read_chunk (4, sub {	702	shift->unshift_read (chunk => 4, sub {
317	# header arrived, decode	703	# header arrived, decode
318	my $len = unpack "N", $_[1];	704	my $len = unpack "N", $_[1];
319		705
320	# now read the payload	706	# now read the payload
321	shift->unshift_read_chunk ($len, sub {	707	shift->unshift_read (chunk => $len, sub {
322	my $xml = $_[1];	708	my $xml = $_[1];
323	# handle xml	709	# handle xml
324	});	710	});
325	});	711	});
326	});	712	});
327		713
328	Example 2: Implement a client for a protocol that replies either with	714	Example 2: Implement a client for a protocol that replies either with "OK"
329	"OK" and another line or "ERROR" for one request, and 64 bytes for the	715	and another line or "ERROR" for the first request that is sent, and 64
330	second request. Due tot he availability of a full queue, we can just	716	bytes for the second request. Due to the availability of a queue, we can
331	pipeline sending both requests and manipulate the queue as necessary in	717	just pipeline sending both requests and manipulate the queue as necessary
332	the callbacks:	718	in the callbacks.
333		719
334	# request one	720	When the first callback is called and sees an "OK" response, it will
		721	C<unshift> another line-read. This line-read will be queued I<before> the
		722	64-byte chunk callback.
		723
		724	# request one, returns either "OK + extra line" or "ERROR"
335	$handle->push_write ("request 1\015\012");	725	$handle->push_write ("request 1\015\012");
336		726
337	# we expect "ERROR" or "OK" as response, so push a line read	727	# we expect "ERROR" or "OK" as response, so push a line read
338	$handle->push_read_line (sub {	728	$handle->push_read (line => sub {
339	# if we got an "OK", we have to _prepend_ another line,	729	# if we got an "OK", we have to _prepend_ another line,
340	# so it will be read before the second request reads its 64 bytes	730	# so it will be read before the second request reads its 64 bytes
341	# which are already in the queue when this callback is called	731	# which are already in the queue when this callback is called
342	# we don't do this in case we got an error	732	# we don't do this in case we got an error
343	if ($_[1] eq "OK") {	733	if ($_[1] eq "OK") {
344	$_[0]->unshift_read_line (sub {	734	$_[0]->unshift_read (line => sub {
345	my $response = $_[1];	735	my $response = $_[1];
346	...	736	...
347	});	737	});
348	}	738	}
349	});	739	});
350		740
351	# request two	741	# request two, simply returns 64 octets
352	$handle->push_write ("request 2\015\012");	742	$handle->push_write ("request 2\015\012");
353		743
354	# simply read 64 bytes, always	744	# simply read 64 bytes, always
355	$handle->push_read_chunk (64, sub {	745	$handle->push_read (chunk => 64, sub {
356	my $response = $_[1];	746	my $response = $_[1];
357	...	747	...
358	});	748	});
359		749
360	=over 4	750	=over 4
…		…
362	=cut	752	=cut
363		753
364	sub _drain_rbuf {	754	sub _drain_rbuf {
365	my ($self) = @_;	755	my ($self) = @_;
366		756
367	return if $self->{in_drain};
368	local $self->{in_drain} = 1;	757	local $self->{_in_drain} = 1;
369		758
		759	if (
		760	defined $self->{rbuf_max}
		761	&& $self->{rbuf_max} < length $self->{rbuf}
		762	) {
		763	$self->_error (&Errno::ENOSPC, 1), return;
		764	}
		765
		766	while () {
370	while (my $len = length $self->{rbuf}) {	767	my $len = length $self->{rbuf};
371	no strict 'refs';	768
372	if (my $cb = shift @{ $self->{queue} }) {	769	if (my $cb = shift @{ $self->{_queue} }) {
373	if (!$cb->($self)) {	770	unless ($cb->($self)) {
374	if ($self->{eof}) {	771	if ($self->{_eof}) {
375	# no progress can be made (not enough data and no data forthcoming)	772	# no progress can be made (not enough data and no data forthcoming)
376	$! = &Errno::EPIPE; return $self->error;	773	$self->_error (&Errno::EPIPE, 1), return;
377	}	774	}
378		775
379	unshift @{ $self->{queue} }, $cb;	776	unshift @{ $self->{_queue} }, $cb;
380	return;	777	last;
381	}	778	}
382	} elsif ($self->{on_read}) {	779	} elsif ($self->{on_read}) {
		780	last unless $len;
		781
383	$self->{on_read}($self);	782	$self->{on_read}($self);
384		783
385	if (	784	if (
386	$self->{eof} # if no further data will arrive
387	&& $len == length $self->{rbuf} # and no data has been consumed	785	$len == length $self->{rbuf} # if no data has been consumed
388	&& !@{ $self->{queue} } # and the queue is still empty	786	&& !@{ $self->{_queue} } # and the queue is still empty
389	&& $self->{on_read} # and we still want to read data	787	&& $self->{on_read} # but we still have on_read
390	) {	788	) {
		789	# no further data will arrive
391	# then no progress can be made	790	# so no progress can be made
392	$! = &Errno::EPIPE; return $self->error;	791	$self->_error (&Errno::EPIPE, 1), return
		792	if $self->{_eof};
		793
		794	last; # more data might arrive
393	}	795	}
394	} else {	796	} else {
395	# read side becomes idle	797	# read side becomes idle
396	delete $self->{rw};	798	delete $self->{_rw} unless $self->{tls};
397	return;	799	last;
398	}	800	}
399	}	801	}
400		802
401	if ($self->{eof}) {	803	if ($self->{_eof}) {
402	$self->_shutdown;	804	if ($self->{on_eof}) {
403	$self->{on_eof}($self);	805	$self->{on_eof}($self)
		806	} else {
		807	$self->_error (0, 1);
		808	}
		809	}
		810
		811	# may need to restart read watcher
		812	unless ($self->{_rw}) {
		813	$self->start_read
		814	if $self->{on_read} || @{ $self->{_queue} };
404	}	815	}
405	}	816	}
406		817
407	=item $handle->on_read ($cb)	818	=item $handle->on_read ($cb)
408		819
…		…
414		825
415	sub on_read {	826	sub on_read {
416	my ($self, $cb) = @_;	827	my ($self, $cb) = @_;
417		828
418	$self->{on_read} = $cb;	829	$self->{on_read} = $cb;
		830	$self->_drain_rbuf if $cb && !$self->{_in_drain};
419	}	831	}
420		832
421	=item $handle->rbuf	833	=item $handle->rbuf
422		834
423	Returns the read buffer (as a modifiable lvalue).	835	Returns the read buffer (as a modifiable lvalue).
…		…
442	Append the given callback to the end of the queue (C<push_read>) or	854	Append the given callback to the end of the queue (C<push_read>) or
443	prepend it (C<unshift_read>).	855	prepend it (C<unshift_read>).
444		856
445	The callback is called each time some additional read data arrives.	857	The callback is called each time some additional read data arrives.
446		858
447	It must check wether enough data is in the read buffer already.	859	It must check whether enough data is in the read buffer already.
448		860
449	If not enough data is available, it must return the empty list or a false	861	If not enough data is available, it must return the empty list or a false
450	value, in which case it will be called repeatedly until enough data is	862	value, in which case it will be called repeatedly until enough data is
451	available (or an error condition is detected).	863	available (or an error condition is detected).
452		864
…		…
454	interested in (which can be none at all) and return a true value. After returning	866	interested in (which can be none at all) and return a true value. After returning
455	true, it will be removed from the queue.	867	true, it will be removed from the queue.
456		868
457	=cut	869	=cut
458		870
		871	our %RH;
		872
		873	sub register_read_type($$) {
		874	$RH{$_[0]} = $_[1];
		875	}
		876
459	sub push_read {	877	sub push_read {
460	my ($self, $cb) = @_;	878	my $self = shift;
		879	my $cb = pop;
461		880
		881	if (@_) {
		882	my $type = shift;
		883
		884	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		885	->($self, $cb, @_);
		886	}
		887
462	push @{ $self->{queue} }, $cb;	888	push @{ $self->{_queue} }, $cb;
463	$self->_drain_rbuf;	889	$self->_drain_rbuf unless $self->{_in_drain};
464	}	890	}
465		891
466	sub unshift_read {	892	sub unshift_read {
467	my ($self, $cb) = @_;	893	my $self = shift;
		894	my $cb = pop;
468		895
		896	if (@_) {
		897	my $type = shift;
		898
		899	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		900	->($self, $cb, @_);
		901	}
		902
		903
469	push @{ $self->{queue} }, $cb;	904	unshift @{ $self->{_queue} }, $cb;
470	$self->_drain_rbuf;	905	$self->_drain_rbuf unless $self->{_in_drain};
471	}	906	}
472		907
473	=item $handle->push_read_chunk ($len, $cb->($self, $data))	908	=item $handle->push_read (type => @args, $cb)
474		909
475	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	910	=item $handle->unshift_read (type => @args, $cb)
476		911
477	Append the given callback to the end of the queue (C<push_read_chunk>) or	912	Instead of providing a callback that parses the data itself you can chose
478	prepend it (C<unshift_read_chunk>).	913	between a number of predefined parsing formats, for chunks of data, lines
		914	etc.
479		915
480	The callback will be called only once C<$len> bytes have been read, and	916	Predefined types are (if you have ideas for additional types, feel free to
481	these C<$len> bytes will be passed to the callback.	917	drop by and tell us):
482		918
483	=cut	919	=over 4
484		920
485	sub _read_chunk($$) {	921	=item chunk => $octets, $cb->($handle, $data)
		922
		923	Invoke the callback only once C<$octets> bytes have been read. Pass the
		924	data read to the callback. The callback will never be called with less
		925	data.
		926
		927	Example: read 2 bytes.
		928
		929	$handle->push_read (chunk => 2, sub {
		930	warn "yay ", unpack "H*", $_[1];
		931	});
		932
		933	=cut
		934
		935	register_read_type chunk => sub {
486	my ($self, $len, $cb) = @_;	936	my ($self, $cb, $len) = @_;
487		937
488	sub {	938	sub {
489	$len <= length $_[0]{rbuf} or return;	939	$len <= length $_[0]{rbuf} or return;
490	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	940	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
491	1	941	1
492	}	942	}
493	}	943	};
494		944
495	sub push_read_chunk {	945	=item line => [$eol, ]$cb->($handle, $line, $eol)
496	$_[0]->push_read (&_read_chunk);
497	}
498
499
500	sub unshift_read_chunk {
501	$_[0]->unshift_read (&_read_chunk);
502	}
503
504	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))
505
506	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
507
508	Append the given callback to the end of the queue (C<push_read_line>) or
509	prepend it (C<unshift_read_line>).
510		946
511	The callback will be called only once a full line (including the end of	947	The callback will be called only once a full line (including the end of
512	line marker, C<$eol>) has been read. This line (excluding the end of line	948	line marker, C<$eol>) has been read. This line (excluding the end of line
513	marker) will be passed to the callback as second argument (C<$line>), and	949	marker) will be passed to the callback as second argument (C<$line>), and
514	the end of line marker as the third argument (C<$eol>).	950	the end of line marker as the third argument (C<$eol>).
…		…
525	Partial lines at the end of the stream will never be returned, as they are	961	Partial lines at the end of the stream will never be returned, as they are
526	not marked by the end of line marker.	962	not marked by the end of line marker.
527		963
528	=cut	964	=cut
529		965
530	sub _read_line($$) {	966	register_read_type line => sub {
531	my $self = shift;	967	my ($self, $cb, $eol) = @_;
532	my $cb = pop;
533	my $eol = @_ ? shift : qr|(\015?\012)|;
534	my $pos;
535		968
		969	if (@_ < 3) {
		970	# this is more than twice as fast as the generic code below
		971	sub {
		972	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		973
		974	$cb->($_[0], $1, $2);
		975	1
		976	}
		977	} else {
536	$eol = qr|(\Q$eol\E)| unless ref $eol;	978	$eol = quotemeta $eol unless ref $eol;
537	$eol = qr|^(.*?)($eol)|;	979	$eol = qr|^(.*?)($eol)|s;
		980
		981	sub {
		982	$_[0]{rbuf} =~ s/$eol// or return;
		983
		984	$cb->($_[0], $1, $2);
		985	1
		986	}
		987	}
		988	};
		989
		990	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		991
		992	Makes a regex match against the regex object C<$accept> and returns
		993	everything up to and including the match.
		994
		995	Example: read a single line terminated by '\n'.
		996
		997	$handle->push_read (regex => qr<\n>, sub { ... });
		998
		999	If C<$reject> is given and not undef, then it determines when the data is
		1000	to be rejected: it is matched against the data when the C<$accept> regex
		1001	does not match and generates an C<EBADMSG> error when it matches. This is
		1002	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		1003	receive buffer overflow).
		1004
		1005	Example: expect a single decimal number followed by whitespace, reject
		1006	anything else (not the use of an anchor).
		1007
		1008	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		1009
		1010	If C<$skip> is given and not C<undef>, then it will be matched against
		1011	the receive buffer when neither C<$accept> nor C<$reject> match,
		1012	and everything preceding and including the match will be accepted
		1013	unconditionally. This is useful to skip large amounts of data that you
		1014	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		1015	have to start matching from the beginning. This is purely an optimisation
		1016	and is usually worth only when you expect more than a few kilobytes.
		1017
		1018	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		1019	expect the header to be very large (it isn't in practise, but...), we use
		1020	a skip regex to skip initial portions. The skip regex is tricky in that
		1021	it only accepts something not ending in either \015 or \012, as these are
		1022	required for the accept regex.
		1023
		1024	$handle->push_read (regex =>
		1025	qr<\015\012\015\012>,
		1026	undef, # no reject
		1027	qr<^.*[^\015\012]>,
		1028	sub { ... });
		1029
		1030	=cut
		1031
		1032	register_read_type regex => sub {
		1033	my ($self, $cb, $accept, $reject, $skip) = @_;
		1034
		1035	my $data;
		1036	my $rbuf = \$self->{rbuf};
538		1037
539	sub {	1038	sub {
540	$_[0]{rbuf} =~ s/$eol// or return;	1039	# accept
		1040	if ($$rbuf =~ $accept) {
		1041	$data .= substr $$rbuf, 0, $+[0], "";
		1042	$cb->($self, $data);
		1043	return 1;
		1044	}
		1045
		1046	# reject
		1047	if ($reject && $$rbuf =~ $reject) {
		1048	$self->_error (&Errno::EBADMSG);
		1049	}
541		1050
542	$cb->($_[0], $1, $2);	1051	# skip
		1052	if ($skip && $$rbuf =~ $skip) {
		1053	$data .= substr $$rbuf, 0, $+[0], "";
		1054	}
		1055
		1056	()
		1057	}
		1058	};
		1059
		1060	=item netstring => $cb->($handle, $string)
		1061
		1062	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1063
		1064	Throws an error with C<$!> set to EBADMSG on format violations.
		1065
		1066	=cut
		1067
		1068	register_read_type netstring => sub {
		1069	my ($self, $cb) = @_;
		1070
		1071	sub {
		1072	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1073	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1074	$self->_error (&Errno::EBADMSG);
		1075	}
		1076	return;
		1077	}
		1078
		1079	my $len = $1;
		1080
		1081	$self->unshift_read (chunk => $len, sub {
		1082	my $string = $_[1];
		1083	$_[0]->unshift_read (chunk => 1, sub {
		1084	if ($_[1] eq ",") {
		1085	$cb->($_[0], $string);
		1086	} else {
		1087	$self->_error (&Errno::EBADMSG);
		1088	}
		1089	});
		1090	});
		1091
543	1	1092	1
544	}	1093	}
545	}	1094	};
546		1095
547	sub push_read_line {	1096	=item packstring => $format, $cb->($handle, $string)
548	$_[0]->push_read (&_read_line);
549	}
550		1097
551	sub unshift_read_line {	1098	An octet string prefixed with an encoded length. The encoding C<$format>
552	$_[0]->unshift_read (&_read_line);	1099	uses the same format as a Perl C<pack> format, but must specify a single
553	}	1100	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1101	optional C<!>, C<< < >> or C<< > >> modifier).
		1102
		1103	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1104	EPP uses a prefix of C<N> (4 octtes).
		1105
		1106	Example: read a block of data prefixed by its length in BER-encoded
		1107	format (very efficient).
		1108
		1109	$handle->push_read (packstring => "w", sub {
		1110	my ($handle, $data) = @_;
		1111	});
		1112
		1113	=cut
		1114
		1115	register_read_type packstring => sub {
		1116	my ($self, $cb, $format) = @_;
		1117
		1118	sub {
		1119	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1120	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1121	or return;
		1122
		1123	$format = length pack $format, $len;
		1124
		1125	# bypass unshift if we already have the remaining chunk
		1126	if ($format + $len <= length $_[0]{rbuf}) {
		1127	my $data = substr $_[0]{rbuf}, $format, $len;
		1128	substr $_[0]{rbuf}, 0, $format + $len, "";
		1129	$cb->($_[0], $data);
		1130	} else {
		1131	# remove prefix
		1132	substr $_[0]{rbuf}, 0, $format, "";
		1133
		1134	# read remaining chunk
		1135	$_[0]->unshift_read (chunk => $len, $cb);
		1136	}
		1137
		1138	1
		1139	}
		1140	};
		1141
		1142	=item json => $cb->($handle, $hash_or_arrayref)
		1143
		1144	Reads a JSON object or array, decodes it and passes it to the callback.
		1145
		1146	If a C<json> object was passed to the constructor, then that will be used
		1147	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1148
		1149	This read type uses the incremental parser available with JSON version
		1150	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1151	dependency on your own: this module will load the JSON module, but
		1152	AnyEvent does not depend on it itself.
		1153
		1154	Since JSON texts are fully self-delimiting, the C<json> read and write
		1155	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1156	the C<json> write type description, above, for an actual example.
		1157
		1158	=cut
		1159
		1160	register_read_type json => sub {
		1161	my ($self, $cb) = @_;
		1162
		1163	require JSON;
		1164
		1165	my $data;
		1166	my $rbuf = \$self->{rbuf};
		1167
		1168	my $json = $self->{json} ||= JSON->new->utf8;
		1169
		1170	sub {
		1171	my $ref = $json->incr_parse ($self->{rbuf});
		1172
		1173	if ($ref) {
		1174	$self->{rbuf} = $json->incr_text;
		1175	$json->incr_text = "";
		1176	$cb->($self, $ref);
		1177
		1178	1
		1179	} else {
		1180	$self->{rbuf} = "";
		1181	()
		1182	}
		1183	}
		1184	};
		1185
		1186	=item storable => $cb->($handle, $ref)
		1187
		1188	Deserialises a L<Storable> frozen representation as written by the
		1189	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1190	data).
		1191
		1192	Raises C<EBADMSG> error if the data could not be decoded.
		1193
		1194	=cut
		1195
		1196	register_read_type storable => sub {
		1197	my ($self, $cb) = @_;
		1198
		1199	require Storable;
		1200
		1201	sub {
		1202	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1203	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1204	or return;
		1205
		1206	my $format = length pack "w", $len;
		1207
		1208	# bypass unshift if we already have the remaining chunk
		1209	if ($format + $len <= length $_[0]{rbuf}) {
		1210	my $data = substr $_[0]{rbuf}, $format, $len;
		1211	substr $_[0]{rbuf}, 0, $format + $len, "";
		1212	$cb->($_[0], Storable::thaw ($data));
		1213	} else {
		1214	# remove prefix
		1215	substr $_[0]{rbuf}, 0, $format, "";
		1216
		1217	# read remaining chunk
		1218	$_[0]->unshift_read (chunk => $len, sub {
		1219	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1220	$cb->($_[0], $ref);
		1221	} else {
		1222	$self->_error (&Errno::EBADMSG);
		1223	}
		1224	});
		1225	}
		1226
		1227	1
		1228	}
		1229	};
		1230
		1231	=back
		1232
		1233	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1234
		1235	This function (not method) lets you add your own types to C<push_read>.
		1236
		1237	Whenever the given C<type> is used, C<push_read> will invoke the code
		1238	reference with the handle object, the callback and the remaining
		1239	arguments.
		1240
		1241	The code reference is supposed to return a callback (usually a closure)
		1242	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1243
		1244	It should invoke the passed callback when it is done reading (remember to
		1245	pass C<$handle> as first argument as all other callbacks do that).
		1246
		1247	Note that this is a function, and all types registered this way will be
		1248	global, so try to use unique names.
		1249
		1250	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1251	search for C<register_read_type>)).
554		1252
555	=item $handle->stop_read	1253	=item $handle->stop_read
556		1254
557	=item $handle->start_read	1255	=item $handle->start_read
558		1256
559	In rare cases you actually do not want to read anything form the	1257	In rare cases you actually do not want to read anything from the
560	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1258	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
561	any queued callbacks will be executed then. To start readign again, call	1259	any queued callbacks will be executed then. To start reading again, call
562	C<start_read>.	1260	C<start_read>.
		1261
		1262	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1263	you change the C<on_read> callback or push/unshift a read callback, and it
		1264	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1265	there are any read requests in the queue.
		1266
		1267	These methods will have no effect when in TLS mode (as TLS doesn't support
		1268	half-duplex connections).
563		1269
564	=cut	1270	=cut
565		1271
566	sub stop_read {	1272	sub stop_read {
567	my ($self) = @_;	1273	my ($self) = @_;
568		1274
569	delete $self->{rw};	1275	delete $self->{_rw} unless $self->{tls};
570	}	1276	}
571		1277
572	sub start_read {	1278	sub start_read {
573	my ($self) = @_;	1279	my ($self) = @_;
574		1280
575	unless ($self->{rw} || $self->{eof}) {	1281	unless ($self->{_rw} || $self->{_eof}) {
576	Scalar::Util::weaken $self;	1282	Scalar::Util::weaken $self;
577		1283
578	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1284	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
		1285	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
579	my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} || 8192, length $self->{rbuf};	1286	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
580		1287
581	if ($len > 0) {	1288	if ($len > 0) {
582	if (defined $self->{rbuf_max}) {	1289	$self->{_activity} = AnyEvent->now;
583	if ($self->{rbuf_max} < length $self->{rbuf}) {	1290
584	$! = &Errno::ENOSPC; return $self->error;	1291	if ($self->{tls}) {
585	}	1292	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1293
		1294	&_dotls ($self);
		1295	} else {
		1296	$self->_drain_rbuf unless $self->{_in_drain};
586	}	1297	}
587		1298
588	} elsif (defined $len) {	1299	} elsif (defined $len) {
589	$self->{eof} = 1;
590	delete $self->{rw};	1300	delete $self->{_rw};
		1301	$self->{_eof} = 1;
		1302	$self->_drain_rbuf unless $self->{_in_drain};
591		1303
592	} elsif ($! != EAGAIN && $! != EINTR) {	1304	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
593	return $self->error;	1305	return $self->_error ($!, 1);
594	}	1306	}
595
596	$self->_drain_rbuf;
597	});	1307	});
598	}	1308	}
599	}	1309	}
600		1310
		1311	# poll the write BIO and send the data if applicable
		1312	sub _dotls {
		1313	my ($self) = @_;
		1314
		1315	my $tmp;
		1316
		1317	if (length $self->{_tls_wbuf}) {
		1318	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
		1319	substr $self->{_tls_wbuf}, 0, $tmp, "";
		1320	}
		1321	}
		1322
		1323	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1324	unless (length $tmp) {
		1325	# let's treat SSL-eof as we treat normal EOF
		1326	delete $self->{_rw};
		1327	$self->{_eof} = 1;
		1328	&_freetls;
		1329	}
		1330
		1331	$self->{rbuf} .= $tmp;
		1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	$self->{tls} or return; # tls session might have gone away in callback
		1334	}
		1335
		1336	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1337
		1338	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
		1339	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
		1340	return $self->_error ($!, 1);
		1341	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
		1342	return $self->_error (&Errno::EIO, 1);
		1343	}
		1344
		1345	# all other errors are fine for our purposes
		1346	}
		1347
		1348	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1349	$self->{wbuf} .= $tmp;
		1350	$self->_drain_wbuf;
		1351	}
		1352	}
		1353
		1354	=item $handle->starttls ($tls[, $tls_ctx])
		1355
		1356	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		1357	object is created, you can also do that at a later time by calling
		1358	C<starttls>.
		1359
		1360	The first argument is the same as the C<tls> constructor argument (either
		1361	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1362
		1363	The second argument is the optional C<Net::SSLeay::CTX> object that is
		1364	used when AnyEvent::Handle has to create its own TLS connection object.
		1365
		1366	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1367	call and can be used or changed to your liking. Note that the handshake
		1368	might have already started when this function returns.
		1369
		1370	If it an error to start a TLS handshake more than once per
		1371	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1372
		1373	=cut
		1374
		1375	sub starttls {
		1376	my ($self, $ssl, $ctx) = @_;
		1377
		1378	require Net::SSLeay;
		1379
		1380	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1381	if $self->{tls};
		1382
		1383	if ($ssl eq "accept") {
		1384	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
		1385	Net::SSLeay::set_accept_state ($ssl);
		1386	} elsif ($ssl eq "connect") {
		1387	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
		1388	Net::SSLeay::set_connect_state ($ssl);
		1389	}
		1390
		1391	$self->{tls} = $ssl;
		1392
		1393	# basically, this is deep magic (because SSL_read should have the same issues)
		1394	# but the openssl maintainers basically said: "trust us, it just works".
		1395	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		1396	# and mismaintained ssleay-module doesn't even offer them).
		1397	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1398	#
		1399	# in short: this is a mess.
		1400	#
		1401	# note that we do not try to keep the length constant between writes as we are required to do.
		1402	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1403	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1404	# have identity issues in that area.
		1405	Net::SSLeay::CTX_set_mode ($self->{tls},
		1406	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
		1407	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1408
		1409	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1410	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1411
		1412	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
		1413
		1414	&_dotls; # need to trigger the initial handshake
		1415	$self->start_read; # make sure we actually do read
		1416	}
		1417
		1418	=item $handle->stoptls
		1419
		1420	Shuts down the SSL connection - this makes a proper EOF handshake by
		1421	sending a close notify to the other side, but since OpenSSL doesn't
		1422	support non-blocking shut downs, it is not possible to re-use the stream
		1423	afterwards.
		1424
		1425	=cut
		1426
		1427	sub stoptls {
		1428	my ($self) = @_;
		1429
		1430	if ($self->{tls}) {
		1431	Net::SSLeay::shutdown ($self->{tls});
		1432
		1433	&_dotls;
		1434
		1435	# we don't give a shit. no, we do, but we can't. no...
		1436	# we, we... have to use openssl :/
		1437	&_freetls;
		1438	}
		1439	}
		1440
		1441	sub _freetls {
		1442	my ($self) = @_;
		1443
		1444	return unless $self->{tls};
		1445
		1446	Net::SSLeay::free (delete $self->{tls});
		1447
		1448	delete @$self{qw(_rbio _wbio _tls_wbuf)};
		1449	}
		1450
		1451	sub DESTROY {
		1452	my $self = shift;
		1453
		1454	&_freetls;
		1455
		1456	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1457
		1458	if ($linger && length $self->{wbuf}) {
		1459	my $fh = delete $self->{fh};
		1460	my $wbuf = delete $self->{wbuf};
		1461
		1462	my @linger;
		1463
		1464	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1465	my $len = syswrite $fh, $wbuf, length $wbuf;
		1466
		1467	if ($len > 0) {
		1468	substr $wbuf, 0, $len, "";
		1469	} else {
		1470	@linger = (); # end
		1471	}
		1472	});
		1473	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1474	@linger = ();
		1475	});
		1476	}
		1477	}
		1478
		1479	=item $handle->destroy
		1480
		1481	Shuts down the handle object as much as possible - this call ensures that
		1482	no further callbacks will be invoked and resources will be freed as much
		1483	as possible. You must not call any methods on the object afterwards.
		1484
		1485	Normally, you can just "forget" any references to an AnyEvent::Handle
		1486	object and it will simply shut down. This works in fatal error and EOF
		1487	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1488	callback, so when you want to destroy the AnyEvent::Handle object from
		1489	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1490	that case.
		1491
		1492	The handle might still linger in the background and write out remaining
		1493	data, as specified by the C<linger> option, however.
		1494
		1495	=cut
		1496
		1497	sub destroy {
		1498	my ($self) = @_;
		1499
		1500	$self->DESTROY;
		1501	%$self = ();
		1502	}
		1503
		1504	=item AnyEvent::Handle::TLS_CTX
		1505
		1506	This function creates and returns the Net::SSLeay::CTX object used by
		1507	default for TLS mode.
		1508
		1509	The context is created like this:
		1510
		1511	Net::SSLeay::load_error_strings;
		1512	Net::SSLeay::SSLeay_add_ssl_algorithms;
		1513	Net::SSLeay::randomize;
		1514
		1515	my $CTX = Net::SSLeay::CTX_new;
		1516
		1517	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
		1518
		1519	=cut
		1520
		1521	our $TLS_CTX;
		1522
		1523	sub TLS_CTX() {
		1524	$TLS_CTX || do {
		1525	require Net::SSLeay;
		1526
		1527	Net::SSLeay::load_error_strings ();
		1528	Net::SSLeay::SSLeay_add_ssl_algorithms ();
		1529	Net::SSLeay::randomize ();
		1530
		1531	$TLS_CTX = Net::SSLeay::CTX_new ();
		1532
		1533	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
		1534
		1535	$TLS_CTX
		1536	}
		1537	}
		1538
601	=back	1539	=back
602		1540
		1541
		1542	=head1 NONFREQUENTLY ASKED QUESTIONS
		1543
		1544	=over 4
		1545
		1546	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1547	still get further invocations!
		1548
		1549	That's because AnyEvent::Handle keeps a reference to itself when handling
		1550	read or write callbacks.
		1551
		1552	It is only safe to "forget" the reference inside EOF or error callbacks,
		1553	from within all other callbacks, you need to explicitly call the C<<
		1554	->destroy >> method.
		1555
		1556	=item I get different callback invocations in TLS mode/Why can't I pause
		1557	reading?
		1558
		1559	Unlike, say, TCP, TLS connections do not consist of two independent
		1560	communication channels, one for each direction. Or put differently. The
		1561	read and write directions are not independent of each other: you cannot
		1562	write data unless you are also prepared to read, and vice versa.
		1563
		1564	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1565	callback invocations when you are not expecting any read data - the reason
		1566	is that AnyEvent::Handle always reads in TLS mode.
		1567
		1568	During the connection, you have to make sure that you always have a
		1569	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1570	connection (or when you no longer want to use it) you can call the
		1571	C<destroy> method.
		1572
		1573	=item How do I read data until the other side closes the connection?
		1574
		1575	If you just want to read your data into a perl scalar, the easiest way
		1576	to achieve this is by setting an C<on_read> callback that does nothing,
		1577	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1578	will be in C<$_[0]{rbuf}>:
		1579
		1580	$handle->on_read (sub { });
		1581	$handle->on_eof (undef);
		1582	$handle->on_error (sub {
		1583	my $data = delete $_[0]{rbuf};
		1584	undef $handle;
		1585	});
		1586
		1587	The reason to use C<on_error> is that TCP connections, due to latencies
		1588	and packets loss, might get closed quite violently with an error, when in
		1589	fact, all data has been received.
		1590
		1591	It is usually better to use acknowledgements when transferring data,
		1592	to make sure the other side hasn't just died and you got the data
		1593	intact. This is also one reason why so many internet protocols have an
		1594	explicit QUIT command.
		1595
		1596	=item I don't want to destroy the handle too early - how do I wait until
		1597	all data has been written?
		1598
		1599	After writing your last bits of data, set the C<on_drain> callback
		1600	and destroy the handle in there - with the default setting of
		1601	C<low_water_mark> this will be called precisely when all data has been
		1602	written to the socket:
		1603
		1604	$handle->push_write (...);
		1605	$handle->on_drain (sub {
		1606	warn "all data submitted to the kernel\n";
		1607	undef $handle;
		1608	});
		1609
		1610	=back
		1611
		1612
		1613	=head1 SUBCLASSING AnyEvent::Handle
		1614
		1615	In many cases, you might want to subclass AnyEvent::Handle.
		1616
		1617	To make this easier, a given version of AnyEvent::Handle uses these
		1618	conventions:
		1619
		1620	=over 4
		1621
		1622	=item * all constructor arguments become object members.
		1623
		1624	At least initially, when you pass a C<tls>-argument to the constructor it
		1625	will end up in C<< $handle->{tls} >>. Those members might be changed or
		1626	mutated later on (for example C<tls> will hold the TLS connection object).
		1627
		1628	=item * other object member names are prefixed with an C<_>.
		1629
		1630	All object members not explicitly documented (internal use) are prefixed
		1631	with an underscore character, so the remaining non-C<_>-namespace is free
		1632	for use for subclasses.
		1633
		1634	=item * all members not documented here and not prefixed with an underscore
		1635	are free to use in subclasses.
		1636
		1637	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1638	member variables, but thats just life, at least it is documented.
		1639
		1640	=back
		1641
603	=head1 AUTHOR	1642	=head1 AUTHOR
604		1643
605	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1644	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
606		1645
607	=cut	1646	=cut

Diff Legend

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