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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.96 by root, Thu Oct 2 08:10:27 2008 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.12;	19	our $VERSION = 4.3;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
59	argument.	62	argument.
60		63
		64	=head2 SIGPIPE is not handled by this module
		65
		66	SIGPIPE is not handled by this module, so one of the practical
		67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
		68	'IGNORE'>). At least, this is highly recommend in a networked program: If
		69	you use AnyEvent::Handle in a filter program (like sort), exiting on
		70	SIGPIPE is probably the right thing to do.
		71
61	=head1 METHODS	72	=head1 METHODS
62		73
63	=over 4	74	=over 4
64		75
65	=item B<new (%args)>	76	=item B<new (%args)>
…		…
70		81
71	=item fh => $filehandle [MANDATORY]	82	=item fh => $filehandle [MANDATORY]
72		83
73	The filehandle this L<AnyEvent::Handle> object will operate on.	84	The filehandle this L<AnyEvent::Handle> object will operate on.
74		85
75	NOTE: The filehandle will be set to non-blocking (using	86	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		88	that mode.
77		89
78	=item on_eof => $cb->($handle)	90	=item on_eof => $cb->($handle)
79		91
80	Set the callback to be called when an end-of-file condition is detcted,	92	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	93	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	94	connection cleanly.
83		95
		96	For sockets, this just means that the other side has stopped sending data,
		97	you can still try to write data, and, in fact, one can return from the eof
		98	callback and continue writing data, as only the read part has been shut
		99	down.
		100
84	While not mandatory, it is highly recommended to set an eof callback,	101	While not mandatory, it is I<highly> recommended to set an eof callback,
85	otherwise you might end up with a closed socket while you are still	102	otherwise you might end up with a closed socket while you are still
86	waiting for data.	103	waiting for data.
		104
		105	If an EOF condition has been detected but no C<on_eof> callback has been
		106	set, then a fatal error will be raised with C<$!> set to <0>.
87		107
88	=item on_error => $cb->($handle, $fatal)	108	=item on_error => $cb->($handle, $fatal)
89		109
90	This is the error callback, which is called when, well, some error	110	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	111	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	112	connect or a read error.
93		113
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	114	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	115	fatal errors the handle object will be shut down and will not be usable
		116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		117	errors are an EOF condition with active (but unsatisifable) read watchers
		118	(C<EPIPE>) or I/O errors.
		119
96	usable. Non-fatal errors can be retried by simply returning, but it is	120	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	121	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	122	when this callback is invoked. Examples of non-fatal errors are timeouts
		123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		124
100	On callback entrance, the value of C<$!> contains the operating system	125	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		127
103	While not mandatory, it is I<highly> recommended to set this callback, as	128	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
105	C<croak>.	130	C<croak>.
106		131
107	=item on_read => $cb->($handle)	132	=item on_read => $cb->($handle)
108		133
109	This sets the default read callback, which is called when data arrives	134	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue.	135	and no read request is in the queue (unlike read queue callbacks, this
		136	callback will only be called when at least one octet of data is in the
		137	read buffer).
111		138
112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113	method or access the C<$handle->{rbuf}> member directly.	140	method or access the C<$handle->{rbuf}> member directly.
114		141
115	When an EOF condition is detected then AnyEvent::Handle will first try to	142	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
122	This sets the callback that is called when the write buffer becomes empty	149	This sets the callback that is called when the write buffer becomes empty
123	(or when the callback is set and the buffer is empty already).	150	(or when the callback is set and the buffer is empty already).
124		151
125	To append to the write buffer, use the C<< ->push_write >> method.	152	To append to the write buffer, use the C<< ->push_write >> method.
126		153
		154	This callback is useful when you don't want to put all of your write data
		155	into the queue at once, for example, when you want to write the contents
		156	of some file to the socket you might not want to read the whole file into
		157	memory and push it into the queue, but instead only read more data from
		158	the file when the write queue becomes empty.
		159
127	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
128		161
129	If non-zero, then this enables an "inactivity" timeout: whenever this many	162	If non-zero, then this enables an "inactivity" timeout: whenever this many
130	seconds pass without a successful read or write on the underlying file	163	seconds pass without a successful read or write on the underlying file
131	handle, the C<on_timeout> callback will be invoked (and if that one is	164	handle, the C<on_timeout> callback will be invoked (and if that one is
132	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
133		166
134	Note that timeout processing is also active when you currently do not have	167	Note that timeout processing is also active when you currently do not have
135	any outstanding read or write requests: If you plan to keep the connection	168	any outstanding read or write requests: If you plan to keep the connection
136	idle then you should disable the timout temporarily or ignore the timeout	169	idle then you should disable the timout temporarily or ignore the timeout
137	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
138		172
139	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
140		174
141	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
142		176
…		…
146		180
147	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
148		182
149	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	183	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
150	when the read buffer ever (strictly) exceeds this size. This is useful to	184	when the read buffer ever (strictly) exceeds this size. This is useful to
151	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
152		186
153	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
154	be configured to accept only so-and-so much data that it cannot act on	188	be configured to accept only so-and-so much data that it cannot act on
155	(for example, when expecting a line, an attacker could send an unlimited	189	(for example, when expecting a line, an attacker could send an unlimited
156	amount of data without a callback ever being called as long as the line	190	amount of data without a callback ever being called as long as the line
157	isn't finished).	191	isn't finished).
158		192
		193	=item autocork => <boolean>
		194
		195	When disabled (the default), then C<push_write> will try to immediately
		196	write the data to the handle, if possible. This avoids having to register
		197	a write watcher and wait for the next event loop iteration, but can
		198	be inefficient if you write multiple small chunks (on the wire, this
		199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
		201
		202	When enabled, then writes will always be queued till the next event loop
		203	iteration. This is efficient when you do many small writes per iteration,
		204	but less efficient when you do a single write only per iteration (or when
		205	the write buffer often is full). It also increases write latency.
		206
		207	=item no_delay => <boolean>
		208
		209	When doing small writes on sockets, your operating system kernel might
		210	wait a bit for more data before actually sending it out. This is called
		211	the Nagle algorithm, and usually it is beneficial.
		212
		213	In some situations you want as low a delay as possible, which can be
		214	accomplishd by setting this option to a true value.
		215
		216	The default is your opertaing system's default behaviour (most likely
		217	enabled), this option explicitly enables or disables it, if possible.
		218
159	=item read_size => <bytes>	219	=item read_size => <bytes>
160		220
161	The default read block size (the amount of bytes this module will try to read	221	The default read block size (the amount of bytes this module will
162	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
163		224
164	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
165		226
166	Sets the amount of bytes (default: C<0>) that make up an "empty" write	227	Sets the amount of bytes (default: C<0>) that make up an "empty" write
167	buffer: If the write reaches this size or gets even samller it is	228	buffer: If the write reaches this size or gets even samller it is
168	considered empty.	229	considered empty.
169		230
		231	Sometimes it can be beneficial (for performance reasons) to add data to
		232	the write buffer before it is fully drained, but this is a rare case, as
		233	the operating system kernel usually buffers data as well, so the default
		234	is good in almost all cases.
		235
		236	=item linger => <seconds>
		237
		238	If non-zero (default: C<3600>), then the destructor of the
		239	AnyEvent::Handle object will check whether there is still outstanding
		240	write data and will install a watcher that will write this data to the
		241	socket. No errors will be reported (this mostly matches how the operating
		242	system treats outstanding data at socket close time).
		243
		244	This will not work for partial TLS data that could not be encoded
		245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
		247
170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
171		249
172	When this parameter is given, it enables TLS (SSL) mode, that means it	250	When this parameter is given, it enables TLS (SSL) mode, that means
173	will start making tls handshake and will transparently encrypt/decrypt	251	AnyEvent will start a TLS handshake as soon as the conenction has been
174	data.	252	established and will transparently encrypt/decrypt data afterwards.
175		253
176	TLS mode requires Net::SSLeay to be installed (it will be loaded	254	TLS mode requires Net::SSLeay to be installed (it will be loaded
177	automatically when you try to create a TLS handle).	255	automatically when you try to create a TLS handle): this module doesn't
		256	have a dependency on that module, so if your module requires it, you have
		257	to add the dependency yourself.
178		258
179	For the TLS server side, use C<accept>, and for the TLS client side of a	259	Unlike TCP, TLS has a server and client side: for the TLS server side, use
180	connection, use C<connect> mode.	260	C<accept>, and for the TLS client side of a connection, use C<connect>
		261	mode.
181		262
182	You can also provide your own TLS connection object, but you have	263	You can also provide your own TLS connection object, but you have
183	to make sure that you call either C<Net::SSLeay::set_connect_state>	264	to make sure that you call either C<Net::SSLeay::set_connect_state>
184	or C<Net::SSLeay::set_accept_state> on it before you pass it to	265	or C<Net::SSLeay::set_accept_state> on it before you pass it to
185	AnyEvent::Handle.	266	AnyEvent::Handle.
186		267
187	See the C<starttls> method if you need to start TLs negotiation later.	268	See the C<< ->starttls >> method for when need to start TLS negotiation later.
188		269
189	=item tls_ctx => $ssl_ctx	270	=item tls_ctx => $ssl_ctx
190		271
191	Use the given Net::SSLeay::CTX object to create the new TLS connection	272	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
192	(unless a connection object was specified directly). If this parameter is	273	(unless a connection object was specified directly). If this parameter is
193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	274	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
194		275
195	=item json => JSON or JSON::XS object	276	=item json => JSON or JSON::XS object
196		277
197	This is the json coder object used by the C<json> read and write types.	278	This is the json coder object used by the C<json> read and write types.
198		279
199	If you don't supply it, then AnyEvent::Handle will create and use a	280	If you don't supply it, then AnyEvent::Handle will create and use a
200	suitable one, which will write and expect UTF-8 encoded JSON texts.	281	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		282	texts.
201		283
202	Note that you are responsible to depend on the JSON module if you want to	284	Note that you are responsible to depend on the JSON module if you want to
203	use this functionality, as AnyEvent does not have a dependency itself.	285	use this functionality, as AnyEvent does not have a dependency itself.
204		286
205	=item filter_r => $cb
206
207	=item filter_w => $cb
208
209	These exist, but are undocumented at this time.
210
211	=back	287	=back
212		288
213	=cut	289	=cut
214		290
215	sub new {	291	sub new {
…		…
219		295
220	$self->{fh} or Carp::croak "mandatory argument fh is missing";	296	$self->{fh} or Carp::croak "mandatory argument fh is missing";
221		297
222	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	298	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
223		299
224	if ($self->{tls}) {
225	require Net::SSLeay;
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
227	}	301	if $self->{tls};
228
229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
230	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
231	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
233		302
234	$self->{_activity} = AnyEvent->now;	303	$self->{_activity} = AnyEvent->now;
235	$self->_timeout;	304	$self->_timeout;
236		305
		306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		308
237	$self->start_read;	309	$self->start_read
		310	if $self->{on_read};
238		311
239	$self	312	$self
240	}	313	}
241		314
242	sub _shutdown {	315	sub _shutdown {
…		…
245	delete $self->{_tw};	318	delete $self->{_tw};
246	delete $self->{_rw};	319	delete $self->{_rw};
247	delete $self->{_ww};	320	delete $self->{_ww};
248	delete $self->{fh};	321	delete $self->{fh};
249		322
250	$self->stoptls;	323	&_freetls;
		324
		325	delete $self->{on_read};
		326	delete $self->{_queue};
251	}	327	}
252		328
253	sub _error {	329	sub _error {
254	my ($self, $errno, $fatal) = @_;	330	my ($self, $errno, $fatal) = @_;
255		331
…		…
265	}	341	}
266	}	342	}
267		343
268	=item $fh = $handle->fh	344	=item $fh = $handle->fh
269		345
270	This method returns the file handle of the L<AnyEvent::Handle> object.	346	This method returns the file handle used to create the L<AnyEvent::Handle> object.
271		347
272	=cut	348	=cut
273		349
274	sub fh { $_[0]{fh} }	350	sub fh { $_[0]{fh} }
275		351
…		…
293	$_[0]{on_eof} = $_[1];	369	$_[0]{on_eof} = $_[1];
294	}	370	}
295		371
296	=item $handle->on_timeout ($cb)	372	=item $handle->on_timeout ($cb)
297		373
298	Replace the current C<on_timeout> callback, or disables the callback	374	Replace the current C<on_timeout> callback, or disables the callback (but
299	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	375	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
300	argument.	376	argument and method.
301		377
302	=cut	378	=cut
303		379
304	sub on_timeout {	380	sub on_timeout {
305	$_[0]{on_timeout} = $_[1];	381	$_[0]{on_timeout} = $_[1];
		382	}
		383
		384	=item $handle->autocork ($boolean)
		385
		386	Enables or disables the current autocork behaviour (see C<autocork>
		387	constructor argument).
		388
		389	=cut
		390
		391	=item $handle->no_delay ($boolean)
		392
		393	Enables or disables the C<no_delay> setting (see constructor argument of
		394	the same name for details).
		395
		396	=cut
		397
		398	sub no_delay {
		399	$_[0]{no_delay} = $_[1];
		400
		401	eval {
		402	local $SIG{__DIE__};
		403	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		404	};
306	}	405	}
307		406
308	#############################################################################	407	#############################################################################
309		408
310	=item $handle->timeout ($seconds)	409	=item $handle->timeout ($seconds)
…		…
388	my ($self, $cb) = @_;	487	my ($self, $cb) = @_;
389		488
390	$self->{on_drain} = $cb;	489	$self->{on_drain} = $cb;
391		490
392	$cb->($self)	491	$cb->($self)
393	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	492	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
394	}	493	}
395		494
396	=item $handle->push_write ($data)	495	=item $handle->push_write ($data)
397		496
398	Queues the given scalar to be written. You can push as much data as you	497	Queues the given scalar to be written. You can push as much data as you
…		…
415	substr $self->{wbuf}, 0, $len, "";	514	substr $self->{wbuf}, 0, $len, "";
416		515
417	$self->{_activity} = AnyEvent->now;	516	$self->{_activity} = AnyEvent->now;
418		517
419	$self->{on_drain}($self)	518	$self->{on_drain}($self)
420	if $self->{low_water_mark} >= length $self->{wbuf}	519	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
421	&& $self->{on_drain};	520	&& $self->{on_drain};
422		521
423	delete $self->{_ww} unless length $self->{wbuf};	522	delete $self->{_ww} unless length $self->{wbuf};
424	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
425	$self->_error ($!, 1);	524	$self->_error ($!, 1);
426	}	525	}
427	};	526	};
428		527
429	# try to write data immediately	528	# try to write data immediately
430	$cb->();	529	$cb->() unless $self->{autocork};
431		530
432	# if still data left in wbuf, we need to poll	531	# if still data left in wbuf, we need to poll
433	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	532	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
434	if length $self->{wbuf};	533	if length $self->{wbuf};
435	};	534	};
…		…
449		548
450	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	549	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
451	->($self, @_);	550	->($self, @_);
452	}	551	}
453		552
454	if ($self->{filter_w}) {	553	if ($self->{tls}) {
455	$self->{filter_w}($self, \$_[0]);	554	$self->{_tls_wbuf} .= $_[0];
		555	&_dotls ($self);
456	} else {	556	} else {
457	$self->{wbuf} .= $_[0];	557	$self->{wbuf} .= $_[0];
458	$self->_drain_wbuf;	558	$self->_drain_wbuf;
459	}	559	}
460	}	560	}
…		…
477	=cut	577	=cut
478		578
479	register_write_type netstring => sub {	579	register_write_type netstring => sub {
480	my ($self, $string) = @_;	580	my ($self, $string) = @_;
481		581
482	sprintf "%d:%s,", (length $string), $string	582	(length $string) . ":$string,"
		583	};
		584
		585	=item packstring => $format, $data
		586
		587	An octet string prefixed with an encoded length. The encoding C<$format>
		588	uses the same format as a Perl C<pack> format, but must specify a single
		589	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		590	optional C<!>, C<< < >> or C<< > >> modifier).
		591
		592	=cut
		593
		594	register_write_type packstring => sub {
		595	my ($self, $format, $string) = @_;
		596
		597	pack "$format/a*", $string
483	};	598	};
484		599
485	=item json => $array_or_hashref	600	=item json => $array_or_hashref
486		601
487	Encodes the given hash or array reference into a JSON object. Unless you	602	Encodes the given hash or array reference into a JSON object. Unless you
…		…
521		636
522	$self->{json} ? $self->{json}->encode ($ref)	637	$self->{json} ? $self->{json}->encode ($ref)
523	: JSON::encode_json ($ref)	638	: JSON::encode_json ($ref)
524	};	639	};
525		640
		641	=item storable => $reference
		642
		643	Freezes the given reference using L<Storable> and writes it to the
		644	handle. Uses the C<nfreeze> format.
		645
		646	=cut
		647
		648	register_write_type storable => sub {
		649	my ($self, $ref) = @_;
		650
		651	require Storable;
		652
		653	pack "w/a*", Storable::nfreeze ($ref)
		654	};
		655
526	=back	656	=back
527		657
528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	658	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
529		659
530	This function (not method) lets you add your own types to C<push_write>.	660	This function (not method) lets you add your own types to C<push_write>.
…		…
552	ways, the "simple" way, using only C<on_read> and the "complex" way, using	682	ways, the "simple" way, using only C<on_read> and the "complex" way, using
553	a queue.	683	a queue.
554		684
555	In the simple case, you just install an C<on_read> callback and whenever	685	In the simple case, you just install an C<on_read> callback and whenever
556	new data arrives, it will be called. You can then remove some data (if	686	new data arrives, it will be called. You can then remove some data (if
557	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	687	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
558	or not.	688	leave the data there if you want to accumulate more (e.g. when only a
		689	partial message has been received so far).
559		690
560	In the more complex case, you want to queue multiple callbacks. In this	691	In the more complex case, you want to queue multiple callbacks. In this
561	case, AnyEvent::Handle will call the first queued callback each time new	692	case, AnyEvent::Handle will call the first queued callback each time new
562	data arrives and removes it when it has done its job (see C<push_read>,	693	data arrives (also the first time it is queued) and removes it when it has
563	below).	694	done its job (see C<push_read>, below).
564		695
565	This way you can, for example, push three line-reads, followed by reading	696	This way you can, for example, push three line-reads, followed by reading
566	a chunk of data, and AnyEvent::Handle will execute them in order.	697	a chunk of data, and AnyEvent::Handle will execute them in order.
567		698
568	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	699	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
…		…
581	# handle xml	712	# handle xml
582	});	713	});
583	});	714	});
584	});	715	});
585		716
586	Example 2: Implement a client for a protocol that replies either with	717	Example 2: Implement a client for a protocol that replies either with "OK"
587	"OK" and another line or "ERROR" for one request, and 64 bytes for the	718	and another line or "ERROR" for the first request that is sent, and 64
588	second request. Due tot he availability of a full queue, we can just	719	bytes for the second request. Due to the availability of a queue, we can
589	pipeline sending both requests and manipulate the queue as necessary in	720	just pipeline sending both requests and manipulate the queue as necessary
590	the callbacks:	721	in the callbacks.
591		722
592	# request one	723	When the first callback is called and sees an "OK" response, it will
		724	C<unshift> another line-read. This line-read will be queued I<before> the
		725	64-byte chunk callback.
		726
		727	# request one, returns either "OK + extra line" or "ERROR"
593	$handle->push_write ("request 1\015\012");	728	$handle->push_write ("request 1\015\012");
594		729
595	# we expect "ERROR" or "OK" as response, so push a line read	730	# we expect "ERROR" or "OK" as response, so push a line read
596	$handle->push_read (line => sub {	731	$handle->push_read (line => sub {
597	# if we got an "OK", we have to _prepend_ another line,	732	# if we got an "OK", we have to _prepend_ another line,
…		…
604	...	739	...
605	});	740	});
606	}	741	}
607	});	742	});
608		743
609	# request two	744	# request two, simply returns 64 octets
610	$handle->push_write ("request 2\015\012");	745	$handle->push_write ("request 2\015\012");
611		746
612	# simply read 64 bytes, always	747	# simply read 64 bytes, always
613	$handle->push_read (chunk => 64, sub {	748	$handle->push_read (chunk => 64, sub {
614	my $response = $_[1];	749	my $response = $_[1];
…		…
620	=cut	755	=cut
621		756
622	sub _drain_rbuf {	757	sub _drain_rbuf {
623	my ($self) = @_;	758	my ($self) = @_;
624		759
		760	local $self->{_in_drain} = 1;
		761
625	if (	762	if (
626	defined $self->{rbuf_max}	763	defined $self->{rbuf_max}
627	&& $self->{rbuf_max} < length $self->{rbuf}	764	&& $self->{rbuf_max} < length $self->{rbuf}
628	) {	765	) {
629	return $self->_error (&Errno::ENOSPC, 1);	766	$self->_error (&Errno::ENOSPC, 1), return;
630	}	767	}
631		768
632	return if $self->{in_drain};	769	while () {
633	local $self->{in_drain} = 1;
634
635	while (my $len = length $self->{rbuf}) {	770	my $len = length $self->{rbuf};
636	no strict 'refs';	771
637	if (my $cb = shift @{ $self->{_queue} }) {	772	if (my $cb = shift @{ $self->{_queue} }) {
638	unless ($cb->($self)) {	773	unless ($cb->($self)) {
639	if ($self->{_eof}) {	774	if ($self->{_eof}) {
640	# no progress can be made (not enough data and no data forthcoming)	775	# no progress can be made (not enough data and no data forthcoming)
641	return $self->_error (&Errno::EPIPE, 1);	776	$self->_error (&Errno::EPIPE, 1), return;
642	}	777	}
643		778
644	unshift @{ $self->{_queue} }, $cb;	779	unshift @{ $self->{_queue} }, $cb;
645	last;	780	last;
646	}	781	}
647	} elsif ($self->{on_read}) {	782	} elsif ($self->{on_read}) {
		783	last unless $len;
		784
648	$self->{on_read}($self);	785	$self->{on_read}($self);
649		786
650	if (	787	if (
651	$len == length $self->{rbuf} # if no data has been consumed	788	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	789	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # but we still have on_read	790	&& $self->{on_read} # but we still have on_read
654	) {	791	) {
655	# no further data will arrive	792	# no further data will arrive
656	# so no progress can be made	793	# so no progress can be made
657	return $self->_error (&Errno::EPIPE, 1)	794	$self->_error (&Errno::EPIPE, 1), return
658	if $self->{_eof};	795	if $self->{_eof};
659		796
660	last; # more data might arrive	797	last; # more data might arrive
661	}	798	}
662	} else {	799	} else {
663	# read side becomes idle	800	# read side becomes idle
664	delete $self->{_rw};	801	delete $self->{_rw} unless $self->{tls};
665	last;	802	last;
666	}	803	}
667	}	804	}
668		805
		806	if ($self->{_eof}) {
		807	if ($self->{on_eof}) {
669	$self->{on_eof}($self)	808	$self->{on_eof}($self)
670	if $self->{_eof} && $self->{on_eof};	809	} else {
		810	$self->_error (0, 1);
		811	}
		812	}
671		813
672	# may need to restart read watcher	814	# may need to restart read watcher
673	unless ($self->{_rw}) {	815	unless ($self->{_rw}) {
674	$self->start_read	816	$self->start_read
675	if $self->{on_read} \|\| @{ $self->{_queue} };	817	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
686		828
687	sub on_read {	829	sub on_read {
688	my ($self, $cb) = @_;	830	my ($self, $cb) = @_;
689		831
690	$self->{on_read} = $cb;	832	$self->{on_read} = $cb;
		833	$self->_drain_rbuf if $cb && !$self->{_in_drain};
691	}	834	}
692		835
693	=item $handle->rbuf	836	=item $handle->rbuf
694		837
695	Returns the read buffer (as a modifiable lvalue).	838	Returns the read buffer (as a modifiable lvalue).
…		…
744	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	887	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
745	->($self, $cb, @_);	888	->($self, $cb, @_);
746	}	889	}
747		890
748	push @{ $self->{_queue} }, $cb;	891	push @{ $self->{_queue} }, $cb;
749	$self->_drain_rbuf;	892	$self->_drain_rbuf unless $self->{_in_drain};
750	}	893	}
751		894
752	sub unshift_read {	895	sub unshift_read {
753	my $self = shift;	896	my $self = shift;
754	my $cb = pop;	897	my $cb = pop;
…		…
760	->($self, $cb, @_);	903	->($self, $cb, @_);
761	}	904	}
762		905
763		906
764	unshift @{ $self->{_queue} }, $cb;	907	unshift @{ $self->{_queue} }, $cb;
765	$self->_drain_rbuf;	908	$self->_drain_rbuf unless $self->{_in_drain};
766	}	909	}
767		910
768	=item $handle->push_read (type => @args, $cb)	911	=item $handle->push_read (type => @args, $cb)
769		912
770	=item $handle->unshift_read (type => @args, $cb)	913	=item $handle->unshift_read (type => @args, $cb)
…		…
800	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	943	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
801	1	944	1
802	}	945	}
803	};	946	};
804		947
805	# compatibility with older API
806	sub push_read_chunk {
807	$_[0]->push_read (chunk => $_[1], $_[2]);
808	}
809
810	sub unshift_read_chunk {
811	$_[0]->unshift_read (chunk => $_[1], $_[2]);
812	}
813
814	=item line => [$eol, ]$cb->($handle, $line, $eol)	948	=item line => [$eol, ]$cb->($handle, $line, $eol)
815		949
816	The callback will be called only once a full line (including the end of	950	The callback will be called only once a full line (including the end of
817	line marker, C<$eol>) has been read. This line (excluding the end of line	951	line marker, C<$eol>) has been read. This line (excluding the end of line
818	marker) will be passed to the callback as second argument (C<$line>), and	952	marker) will be passed to the callback as second argument (C<$line>), and
…		…
833	=cut	967	=cut
834		968
835	register_read_type line => sub {	969	register_read_type line => sub {
836	my ($self, $cb, $eol) = @_;	970	my ($self, $cb, $eol) = @_;
837		971
838	$eol = qr\|(\015?\012)\| if @_ < 3;	972	if (@_ < 3) {
839	$eol = quotemeta $eol unless ref $eol;	973	# this is more than twice as fast as the generic code below
840	$eol = qr\|^(.*?)($eol)\|s;
841
842	sub {	974	sub {
843	$_[0]{rbuf} =~ s/$eol// or return;	975	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
844		976
845	$cb->($_[0], $1, $2);	977	$cb->($_[0], $1, $2);
846	1
847	}
848	};
849
850	# compatibility with older API
851	sub push_read_line {
852	my $self = shift;
853	$self->push_read (line => @_);
854	}
855
856	sub unshift_read_line {
857	my $self = shift;
858	$self->unshift_read (line => @_);
859	}
860
861	=item netstring => $cb->($handle, $string)
862
863	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
864
865	Throws an error with C<$!> set to EBADMSG on format violations.
866
867	=cut
868
869	register_read_type netstring => sub {
870	my ($self, $cb) = @_;
871
872	sub {
873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
874	if ($_[0]{rbuf} =~ /[^0-9]/) {
875	$self->_error (&Errno::EBADMSG);
876	}	978	1
877	return;
878	}	979	}
		980	} else {
		981	$eol = quotemeta $eol unless ref $eol;
		982	$eol = qr\|^(.*?)($eol)\|s;
879		983
880	my $len = $1;	984	sub {
		985	$_[0]{rbuf} =~ s/$eol// or return;
881		986
882	$self->unshift_read (chunk => $len, sub {	987	$cb->($_[0], $1, $2);
883	my $string = $_[1];
884	$_[0]->unshift_read (chunk => 1, sub {
885	if ($_[1] eq ",") {
886	$cb->($_[0], $string);
887	} else {
888	$self->_error (&Errno::EBADMSG);
889	}
890	});	988	1
891	});	989	}
892
893	1
894	}	990	}
895	};	991	};
896		992
897	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	993	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
898		994
…		…
962		1058
963	()	1059	()
964	}	1060	}
965	};	1061	};
966		1062
		1063	=item netstring => $cb->($handle, $string)
		1064
		1065	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1066
		1067	Throws an error with C<$!> set to EBADMSG on format violations.
		1068
		1069	=cut
		1070
		1071	register_read_type netstring => sub {
		1072	my ($self, $cb) = @_;
		1073
		1074	sub {
		1075	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1076	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1077	$self->_error (&Errno::EBADMSG);
		1078	}
		1079	return;
		1080	}
		1081
		1082	my $len = $1;
		1083
		1084	$self->unshift_read (chunk => $len, sub {
		1085	my $string = $_[1];
		1086	$_[0]->unshift_read (chunk => 1, sub {
		1087	if ($_[1] eq ",") {
		1088	$cb->($_[0], $string);
		1089	} else {
		1090	$self->_error (&Errno::EBADMSG);
		1091	}
		1092	});
		1093	});
		1094
		1095	1
		1096	}
		1097	};
		1098
		1099	=item packstring => $format, $cb->($handle, $string)
		1100
		1101	An octet string prefixed with an encoded length. The encoding C<$format>
		1102	uses the same format as a Perl C<pack> format, but must specify a single
		1103	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1104	optional C<!>, C<< < >> or C<< > >> modifier).
		1105
		1106	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1107	EPP uses a prefix of C<N> (4 octtes).
		1108
		1109	Example: read a block of data prefixed by its length in BER-encoded
		1110	format (very efficient).
		1111
		1112	$handle->push_read (packstring => "w", sub {
		1113	my ($handle, $data) = @_;
		1114	});
		1115
		1116	=cut
		1117
		1118	register_read_type packstring => sub {
		1119	my ($self, $cb, $format) = @_;
		1120
		1121	sub {
		1122	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1123	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1124	or return;
		1125
		1126	$format = length pack $format, $len;
		1127
		1128	# bypass unshift if we already have the remaining chunk
		1129	if ($format + $len <= length $_[0]{rbuf}) {
		1130	my $data = substr $_[0]{rbuf}, $format, $len;
		1131	substr $_[0]{rbuf}, 0, $format + $len, "";
		1132	$cb->($_[0], $data);
		1133	} else {
		1134	# remove prefix
		1135	substr $_[0]{rbuf}, 0, $format, "";
		1136
		1137	# read remaining chunk
		1138	$_[0]->unshift_read (chunk => $len, $cb);
		1139	}
		1140
		1141	1
		1142	}
		1143	};
		1144
967	=item json => $cb->($handle, $hash_or_arrayref)	1145	=item json => $cb->($handle, $hash_or_arrayref)
968		1146
969	Reads a JSON object or array, decodes it and passes it to the callback.	1147	Reads a JSON object or array, decodes it and passes it to the callback.
970		1148
971	If a C<json> object was passed to the constructor, then that will be used	1149	If a C<json> object was passed to the constructor, then that will be used
…		…
981	the C<json> write type description, above, for an actual example.	1159	the C<json> write type description, above, for an actual example.
982		1160
983	=cut	1161	=cut
984		1162
985	register_read_type json => sub {	1163	register_read_type json => sub {
986	my ($self, $cb, $accept, $reject, $skip) = @_;	1164	my ($self, $cb) = @_;
987		1165
988	require JSON;	1166	require JSON;
989		1167
990	my $data;	1168	my $data;
991	my $rbuf = \$self->{rbuf};	1169	my $rbuf = \$self->{rbuf};
…		…
1006	()	1184	()
1007	}	1185	}
1008	}	1186	}
1009	};	1187	};
1010		1188
		1189	=item storable => $cb->($handle, $ref)
		1190
		1191	Deserialises a L<Storable> frozen representation as written by the
		1192	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1193	data).
		1194
		1195	Raises C<EBADMSG> error if the data could not be decoded.
		1196
		1197	=cut
		1198
		1199	register_read_type storable => sub {
		1200	my ($self, $cb) = @_;
		1201
		1202	require Storable;
		1203
		1204	sub {
		1205	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1206	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1207	or return;
		1208
		1209	my $format = length pack "w", $len;
		1210
		1211	# bypass unshift if we already have the remaining chunk
		1212	if ($format + $len <= length $_[0]{rbuf}) {
		1213	my $data = substr $_[0]{rbuf}, $format, $len;
		1214	substr $_[0]{rbuf}, 0, $format + $len, "";
		1215	$cb->($_[0], Storable::thaw ($data));
		1216	} else {
		1217	# remove prefix
		1218	substr $_[0]{rbuf}, 0, $format, "";
		1219
		1220	# read remaining chunk
		1221	$_[0]->unshift_read (chunk => $len, sub {
		1222	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1223	$cb->($_[0], $ref);
		1224	} else {
		1225	$self->_error (&Errno::EBADMSG);
		1226	}
		1227	});
		1228	}
		1229
		1230	1
		1231	}
		1232	};
		1233
1011	=back	1234	=back
1012		1235
1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1236	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1014		1237
1015	This function (not method) lets you add your own types to C<push_read>.	1238	This function (not method) lets you add your own types to C<push_read>.
…		…
1033	=item $handle->stop_read	1256	=item $handle->stop_read
1034		1257
1035	=item $handle->start_read	1258	=item $handle->start_read
1036		1259
1037	In rare cases you actually do not want to read anything from the	1260	In rare cases you actually do not want to read anything from the
1038	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1261	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1039	any queued callbacks will be executed then. To start reading again, call	1262	any queued callbacks will be executed then. To start reading again, call
1040	C<start_read>.	1263	C<start_read>.
1041		1264
1042	Note that AnyEvent::Handle will automatically C<start_read> for you when	1265	Note that AnyEvent::Handle will automatically C<start_read> for you when
1043	you change the C<on_read> callback or push/unshift a read callback, and it	1266	you change the C<on_read> callback or push/unshift a read callback, and it
1044	will automatically C<stop_read> for you when neither C<on_read> is set nor	1267	will automatically C<stop_read> for you when neither C<on_read> is set nor
1045	there are any read requests in the queue.	1268	there are any read requests in the queue.
1046		1269
		1270	These methods will have no effect when in TLS mode (as TLS doesn't support
		1271	half-duplex connections).
		1272
1047	=cut	1273	=cut
1048		1274
1049	sub stop_read {	1275	sub stop_read {
1050	my ($self) = @_;	1276	my ($self) = @_;
1051		1277
1052	delete $self->{_rw};	1278	delete $self->{_rw} unless $self->{tls};
1053	}	1279	}
1054		1280
1055	sub start_read {	1281	sub start_read {
1056	my ($self) = @_;	1282	my ($self) = @_;
1057		1283
1058	unless ($self->{_rw} \|\| $self->{_eof}) {	1284	unless ($self->{_rw} \|\| $self->{_eof}) {
1059	Scalar::Util::weaken $self;	1285	Scalar::Util::weaken $self;
1060		1286
1061	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1287	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1062	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1288	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1063	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1289	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1064		1290
1065	if ($len > 0) {	1291	if ($len > 0) {
1066	$self->{_activity} = AnyEvent->now;	1292	$self->{_activity} = AnyEvent->now;
1067		1293
1068	$self->{filter_r}	1294	if ($self->{tls}) {
1069	? $self->{filter_r}($self, $rbuf)	1295	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1070	: $self->_drain_rbuf;	1296	&_dotls ($self);
		1297	} else {
		1298	$self->_drain_rbuf unless $self->{_in_drain};
		1299	}
1071		1300
1072	} elsif (defined $len) {	1301	} elsif (defined $len) {
1073	delete $self->{_rw};	1302	delete $self->{_rw};
1074	$self->{_eof} = 1;	1303	$self->{_eof} = 1;
1075	$self->_drain_rbuf;	1304	$self->_drain_rbuf unless $self->{_in_drain};
1076		1305
1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1078	return $self->_error ($!, 1);	1307	return $self->_error ($!, 1);
1079	}	1308	}
1080	});	1309	});
…		…
1090	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1091	substr $self->{_tls_wbuf}, 0, $len, "";	1320	substr $self->{_tls_wbuf}, 0, $len, "";
1092	}	1321	}
1093	}	1322	}
1094		1323
1095	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1096	$self->{wbuf} .= $buf;
1097	$self->_drain_wbuf;
1098	}
1099
1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1101	if (length $buf) {	1325	unless (length $buf) {
1102	$self->{rbuf} .= $buf;
1103	$self->_drain_rbuf;
1104	} else {
1105	# let's treat SSL-eof as we treat normal EOF	1326	# let's treat SSL-eof as we treat normal EOF
		1327	delete $self->{_rw};
1106	$self->{_eof} = 1;	1328	$self->{_eof} = 1;
1107	$self->_shutdown;	1329	&_freetls;
1108	return;
1109	}	1330	}
		1331
		1332	$self->{rbuf} .= $buf;
		1333	$self->_drain_rbuf unless $self->{_in_drain};
		1334	$self->{tls} or return; # tls session might have gone away in callback
1110	}	1335	}
1111		1336
1112	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1113		1338
1114	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
…		…
1118	return $self->_error (&Errno::EIO, 1);	1343	return $self->_error (&Errno::EIO, 1);
1119	}	1344	}
1120		1345
1121	# all others are fine for our purposes	1346	# all others are fine for our purposes
1122	}	1347	}
		1348
		1349	while (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1350	$self->{wbuf} .= $buf;
		1351	$self->_drain_wbuf;
		1352	}
1123	}	1353	}
1124		1354
1125	=item $handle->starttls ($tls[, $tls_ctx])	1355	=item $handle->starttls ($tls[, $tls_ctx])
1126		1356
1127	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1136		1366
1137	The TLS connection object will end up in C<< $handle->{tls} >> after this	1367	The TLS connection object will end up in C<< $handle->{tls} >> after this
1138	call and can be used or changed to your liking. Note that the handshake	1368	call and can be used or changed to your liking. Note that the handshake
1139	might have already started when this function returns.	1369	might have already started when this function returns.
1140		1370
		1371	If it an error to start a TLS handshake more than once per
		1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1373
1141	=cut	1374	=cut
1142		1375
1143	sub starttls {	1376	sub starttls {
1144	my ($self, $ssl, $ctx) = @_;	1377	my ($self, $ssl, $ctx) = @_;
1145		1378
1146	$self->stoptls;	1379	require Net::SSLeay;
1147		1380
		1381	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
		1382	if $self->{tls};
		1383
1148	if ($ssl eq "accept") {	1384	if ($ssl eq "accept") {
1149	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1385	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1150	Net::SSLeay::set_accept_state ($ssl);	1386	Net::SSLeay::set_accept_state ($ssl);
1151	} elsif ($ssl eq "connect") {	1387	} elsif ($ssl eq "connect") {
1152	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1388	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1158	# basically, this is deep magic (because SSL_read should have the same issues)	1394	# basically, this is deep magic (because SSL_read should have the same issues)
1159	# but the openssl maintainers basically said: "trust us, it just works".	1395	# but the openssl maintainers basically said: "trust us, it just works".
1160	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1396	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1161	# and mismaintained ssleay-module doesn't even offer them).	1397	# and mismaintained ssleay-module doesn't even offer them).
1162	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1398	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1399	#
		1400	# in short: this is a mess.
		1401	#
		1402	# note that we do not try to keep the length constant between writes as we are required to do.
		1403	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1404	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1405	# have identity issues in that area.
1163	Net::SSLeay::CTX_set_mode ($self->{tls},	1406	Net::SSLeay::CTX_set_mode ($self->{tls},
1164	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1407	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1165	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1408	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1166		1409
1167	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1410	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1168	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1411	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1169		1412
1170	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1413	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1171		1414
1172	$self->{filter_w} = sub {	1415	&_dotls; # need to trigger the initial handshake
1173	$_[0]{_tls_wbuf} .= ${$_[1]};	1416	$self->start_read; # make sure we actually do read
1174	&_dotls;
1175	};
1176	$self->{filter_r} = sub {
1177	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1178	&_dotls;
1179	};
1180	}	1417	}
1181		1418
1182	=item $handle->stoptls	1419	=item $handle->stoptls
1183		1420
1184	Destroys the SSL connection, if any. Partial read or write data will be	1421	Shuts down the SSL connection - this makes a proper EOF handshake by
1185	lost.	1422	sending a close notify to the other side, but since OpenSSL doesn't
		1423	support non-blocking shut downs, it is not possible to re-use the stream
		1424	afterwards.
1186		1425
1187	=cut	1426	=cut
1188		1427
1189	sub stoptls {	1428	sub stoptls {
1190	my ($self) = @_;	1429	my ($self) = @_;
1191		1430
		1431	if ($self->{tls}) {
		1432	Net::SSLeay::shutdown ($self->{tls});
		1433
		1434	&_dotls;
		1435
		1436	# we don't give a shit. no, we do, but we can't. no...
		1437	# we, we... have to use openssl :/
		1438	&_freetls;
		1439	}
		1440	}
		1441
		1442	sub _freetls {
		1443	my ($self) = @_;
		1444
		1445	return unless $self->{tls};
		1446
1192	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1447	Net::SSLeay::free (delete $self->{tls});
1193		1448
1194	delete $self->{_rbio};	1449	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1195	delete $self->{_wbio};
1196	delete $self->{_tls_wbuf};
1197	delete $self->{filter_r};
1198	delete $self->{filter_w};
1199	}	1450	}
1200		1451
1201	sub DESTROY {	1452	sub DESTROY {
1202	my $self = shift;	1453	my $self = shift;
1203		1454
1204	$self->stoptls;	1455	&_freetls;
		1456
		1457	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1458
		1459	if ($linger && length $self->{wbuf}) {
		1460	my $fh = delete $self->{fh};
		1461	my $wbuf = delete $self->{wbuf};
		1462
		1463	my @linger;
		1464
		1465	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1466	my $len = syswrite $fh, $wbuf, length $wbuf;
		1467
		1468	if ($len > 0) {
		1469	substr $wbuf, 0, $len, "";
		1470	} else {
		1471	@linger = (); # end
		1472	}
		1473	});
		1474	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1475	@linger = ();
		1476	});
		1477	}
1205	}	1478	}
1206		1479
1207	=item AnyEvent::Handle::TLS_CTX	1480	=item AnyEvent::Handle::TLS_CTX
1208		1481
1209	This function creates and returns the Net::SSLeay::CTX object used by	1482	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1239	}	1512	}
1240	}	1513	}
1241		1514
1242	=back	1515	=back
1243		1516
		1517
		1518	=head1 NONFREQUENTLY ASKED QUESTIONS
		1519
		1520	=over 4
		1521
		1522	=item How do I read data until the other side closes the connection?
		1523
		1524	If you just want to read your data into a perl scalar, the easiest way
		1525	to achieve this is by setting an C<on_read> callback that does nothing,
		1526	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1527	will be in C<$_[0]{rbuf}>:
		1528
		1529	$handle->on_read (sub { });
		1530	$handle->on_eof (undef);
		1531	$handle->on_error (sub {
		1532	my $data = delete $_[0]{rbuf};
		1533	undef $handle;
		1534	});
		1535
		1536	The reason to use C<on_error> is that TCP connections, due to latencies
		1537	and packets loss, might get closed quite violently with an error, when in
		1538	fact, all data has been received.
		1539
		1540	It is usually better to use acknowledgements when transfering data,
		1541	to make sure the other side hasn't just died and you got the data
		1542	intact. This is also one reason why so many internet protocols have an
		1543	explicit QUIT command.
		1544
		1545
		1546	=item I don't want to destroy the handle too early - how do I wait until
		1547	all data has been written?
		1548
		1549	After writing your last bits of data, set the C<on_drain> callback
		1550	and destroy the handle in there - with the default setting of
		1551	C<low_water_mark> this will be called precisely when all data has been
		1552	written to the socket:
		1553
		1554	$handle->push_write (...);
		1555	$handle->on_drain (sub {
		1556	warn "all data submitted to the kernel\n";
		1557	undef $handle;
		1558	});
		1559
		1560	=back
		1561
		1562
1244	=head1 SUBCLASSING AnyEvent::Handle	1563	=head1 SUBCLASSING AnyEvent::Handle
1245		1564
1246	In many cases, you might want to subclass AnyEvent::Handle.	1565	In many cases, you might want to subclass AnyEvent::Handle.
1247		1566
1248	To make this easier, a given version of AnyEvent::Handle uses these	1567	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1251	=over 4	1570	=over 4
1252		1571
1253	=item * all constructor arguments become object members.	1572	=item * all constructor arguments become object members.
1254		1573
1255	At least initially, when you pass a C<tls>-argument to the constructor it	1574	At least initially, when you pass a C<tls>-argument to the constructor it
1256	will end up in C<< $handle->{tls} >>. Those members might be changes or	1575	will end up in C<< $handle->{tls} >>. Those members might be changed or
1257	mutated later on (for example C<tls> will hold the TLS connection object).	1576	mutated later on (for example C<tls> will hold the TLS connection object).
1258		1577
1259	=item * other object member names are prefixed with an C<_>.	1578	=item * other object member names are prefixed with an C<_>.
1260		1579
1261	All object members not explicitly documented (internal use) are prefixed	1580	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs. Revision 1.96 by root, Thu Oct 2 08:10:27 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.96 by root, Thu Oct 2 08:10:27 2008 UTC