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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC vs.
Revision 1.90 by root, Mon Sep 29 02:08:57 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 = '0.04';	19	our $VERSION = 4.234;
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 on EOF.	92	Set the callback to be called when an end-of-file condition is detected,
		93	i.e. in the case of a socket, when the other side has closed the
		94	connection cleanly.
81		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
82	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,
83	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
84	waiting for data.	103	waiting for data.
85		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>.
		107
86	=item on_error => $cb->($handle)	108	=item on_error => $cb->($handle, $fatal)
87		109
88	This is the fatal error callback, that is called when, well, a fatal error	110	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	111	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	112	connect or a read error.
91		113
92	The object will not be in a usable state when this callback has been	114	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	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
		120	Non-fatal errors can be retried by simply returning, but it is recommended
		121	to simply ignore this parameter and instead abondon the handle object
		122	when this callback is invoked. Examples of non-fatal errors are timeouts
		123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
94		124
95	On callback entrance, the value of C<$!> contains the operating system	125	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		127
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100
101	While not mandatory, it is I<highly> recommended to set this callback, as	128	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	129	you will not be notified of errors otherwise. The default simply calls
103	die.	130	C<croak>.
104		131
105	=item on_read => $cb->($handle)	132	=item on_read => $cb->($handle)
106		133
107	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
108	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).
109		138
110	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 >>
111	method or access the C<$handle->{rbuf}> member directly.	140	method or access the C<$handle->{rbuf}> member directly.
112		141
113	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
…		…
120	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
121	(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).
122		151
123	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.
124		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
125	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
126		161
127	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
128	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
129	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
130	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
131		166
132	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
133	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
134	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
135	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
136		172
137	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
138		174
139	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
140		176
…		…
144		180
145	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
146		182
147	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>)
148	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
149	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
150		186
151	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
152	be configured to accept only so-and-so much data that it cannot act on	188	be configured to accept only so-and-so much data that it cannot act on
153	(for example, when expecting a line, an attacker could send an unlimited	189	(for example, when expecting a line, an attacker could send an unlimited
154	amount of data without a callback ever being called as long as the line	190	amount of data without a callback ever being called as long as the line
155	isn't finished).	191	isn't finished).
156		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
157	=item read_size => <bytes>	219	=item read_size => <bytes>
158		220
159	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
160	on each [loop iteration). Default: C<4096>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
161		224
162	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
163		226
164	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
165	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
166	considered empty.	229	considered empty.
167		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.
		246
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		248
170	When this parameter is given, it enables TLS (SSL) mode, that means it	249	When this parameter is given, it enables TLS (SSL) mode, that means
171	will start making tls handshake and will transparently encrypt/decrypt	250	AnyEvent will start a TLS handshake as soon as the conenction has been
172	data.	251	established and will transparently encrypt/decrypt data afterwards.
173		252
174	TLS mode requires Net::SSLeay to be installed (it will be loaded	253	TLS mode requires Net::SSLeay to be installed (it will be loaded
175	automatically when you try to create a TLS handle).	254	automatically when you try to create a TLS handle): this module doesn't
		255	have a dependency on that module, so if your module requires it, you have
		256	to add the dependency yourself.
176		257
177	For the TLS server side, use C<accept>, and for the TLS client side of a	258	Unlike TCP, TLS has a server and client side: for the TLS server side, use
178	connection, use C<connect> mode.	259	C<accept>, and for the TLS client side of a connection, use C<connect>
		260	mode.
179		261
180	You can also provide your own TLS connection object, but you have	262	You can also provide your own TLS connection object, but you have
181	to make sure that you call either C<Net::SSLeay::set_connect_state>	263	to make sure that you call either C<Net::SSLeay::set_connect_state>
182	or C<Net::SSLeay::set_accept_state> on it before you pass it to	264	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	265	AnyEvent::Handle.
184		266
185	See the C<starttls> method if you need to start TLs negotiation later.	267	See the C<< ->starttls >> method for when need to start TLS negotiation later.
186		268
187	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
188		270
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
192		274
193	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
194		276
195	This is the json coder object used by the C<json> read and write types.	277	This is the json coder object used by the C<json> read and write types.
196		278
197	If you don't supply it, then AnyEvent::Handle will create and use a	279	If you don't supply it, then AnyEvent::Handle will create and use a
198	suitable one, which will write and expect UTF-8 encoded JSON texts.	280	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		281	texts.
199		282
200	Note that you are responsible to depend on the JSON module if you want to	283	Note that you are responsible to depend on the JSON module if you want to
201	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
202		285
203	=item filter_r => $cb	286	=item filter_r => $cb
204		287
205	=item filter_w => $cb	288	=item filter_w => $cb
206		289
207	These exist, but are undocumented at this time.	290	These exist, but are undocumented at this time. (They are used internally
		291	by the TLS code).
208		292
209	=back	293	=back
210		294
211	=cut	295	=cut
212		296
…		…
222	if ($self->{tls}) {	306	if ($self->{tls}) {
223	require Net::SSLeay;	307	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}	309	}
226		310
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231
232	$self->{_activity} = AnyEvent->now;	311	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	312	$self->_timeout;
234		313
		314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		316
235	$self->start_read;	317	$self->start_read
		318	if $self->{on_read};
236		319
237	$self	320	$self
238	}	321	}
239		322
240	sub _shutdown {	323	sub _shutdown {
241	my ($self) = @_;	324	my ($self) = @_;
242		325
		326	delete $self->{_tw};
243	delete $self->{_rw};	327	delete $self->{_rw};
244	delete $self->{_ww};	328	delete $self->{_ww};
245	delete $self->{fh};	329	delete $self->{fh};
246	}
247		330
		331	$self->stoptls;
		332
		333	delete $self->{on_read};
		334	delete $self->{_queue};
		335	}
		336
248	sub error {	337	sub _error {
249	my ($self) = @_;	338	my ($self, $errno, $fatal) = @_;
250		339
251	{
252	local $!;
253	$self->_shutdown;	340	$self->_shutdown
254	}	341	if $fatal;
255		342
256	$self->{on_error}($self)	343	$! = $errno;
		344
257	if $self->{on_error};	345	if ($self->{on_error}) {
258		346	$self->{on_error}($self, $fatal);
		347	} else {
259	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	348	Carp::croak "AnyEvent::Handle uncaught error: $!";
		349	}
260	}	350	}
261		351
262	=item $fh = $handle->fh	352	=item $fh = $handle->fh
263		353
264	This method returns the file handle of the L<AnyEvent::Handle> object.	354	This method returns the file handle used to create the L<AnyEvent::Handle> object.
265		355
266	=cut	356	=cut
267		357
268	sub fh { $_[0]{fh} }	358	sub fh { $_[0]{fh} }
269		359
…		…
287	$_[0]{on_eof} = $_[1];	377	$_[0]{on_eof} = $_[1];
288	}	378	}
289		379
290	=item $handle->on_timeout ($cb)	380	=item $handle->on_timeout ($cb)
291		381
292	Replace the current C<on_timeout> callback, or disables the callback	382	Replace the current C<on_timeout> callback, or disables the callback (but
293	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	383	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
294	argument.	384	argument and method.
295		385
296	=cut	386	=cut
297		387
298	sub on_timeout {	388	sub on_timeout {
299	$_[0]{on_timeout} = $_[1];	389	$_[0]{on_timeout} = $_[1];
		390	}
		391
		392	=item $handle->autocork ($boolean)
		393
		394	Enables or disables the current autocork behaviour (see C<autocork>
		395	constructor argument).
		396
		397	=cut
		398
		399	=item $handle->no_delay ($boolean)
		400
		401	Enables or disables the C<no_delay> setting (see constructor argument of
		402	the same name for details).
		403
		404	=cut
		405
		406	sub no_delay {
		407	$_[0]{no_delay} = $_[1];
		408
		409	eval {
		410	local $SIG{__DIE__};
		411	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		412	};
300	}	413	}
301		414
302	#############################################################################	415	#############################################################################
303		416
304	=item $handle->timeout ($seconds)	417	=item $handle->timeout ($seconds)
…		…
328	# now or in the past already?	441	# now or in the past already?
329	if ($after <= 0) {	442	if ($after <= 0) {
330	$self->{_activity} = $NOW;	443	$self->{_activity} = $NOW;
331		444
332	if ($self->{on_timeout}) {	445	if ($self->{on_timeout}) {
333	$self->{on_timeout}->($self);	446	$self->{on_timeout}($self);
334	} else {	447	} else {
335	$! = Errno::ETIMEDOUT;	448	$self->_error (&Errno::ETIMEDOUT);
336	$self->error;
337	}	449	}
338		450
339	# callbakx could have changed timeout value, optimise	451	# callback could have changed timeout value, optimise
340	return unless $self->{timeout};	452	return unless $self->{timeout};
341		453
342	# calculate new after	454	# calculate new after
343	$after = $self->{timeout};	455	$after = $self->{timeout};
344	}	456	}
345		457
346	Scalar::Util::weaken $self;	458	Scalar::Util::weaken $self;
		459	return unless $self; # ->error could have destroyed $self
347		460
348	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	461	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
349	delete $self->{_tw};	462	delete $self->{_tw};
350	$self->_timeout;	463	$self->_timeout;
351	});	464	});
…		…
414	if $self->{low_water_mark} >= length $self->{wbuf}	527	if $self->{low_water_mark} >= length $self->{wbuf}
415	&& $self->{on_drain};	528	&& $self->{on_drain};
416		529
417	delete $self->{_ww} unless length $self->{wbuf};	530	delete $self->{_ww} unless length $self->{wbuf};
418	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
419	$self->error;	532	$self->_error ($!, 1);
420	}	533	}
421	};	534	};
422		535
423	# try to write data immediately	536	# try to write data immediately
424	$cb->();	537	$cb->() unless $self->{autocork};
425		538
426	# if still data left in wbuf, we need to poll	539	# if still data left in wbuf, we need to poll
427	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	540	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
428	if length $self->{wbuf};	541	if length $self->{wbuf};
429	};	542	};
…		…
444	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	557	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
445	->($self, @_);	558	->($self, @_);
446	}	559	}
447		560
448	if ($self->{filter_w}) {	561	if ($self->{filter_w}) {
449	$self->{filter_w}->($self, \$_[0]);	562	$self->{filter_w}($self, \$_[0]);
450	} else {	563	} else {
451	$self->{wbuf} .= $_[0];	564	$self->{wbuf} .= $_[0];
452	$self->_drain_wbuf;	565	$self->_drain_wbuf;
453	}	566	}
454	}	567	}
455		568
456	=item $handle->push_write (type => @args)	569	=item $handle->push_write (type => @args)
457		570
458	=item $handle->unshift_write (type => @args)
459
460	Instead of formatting your data yourself, you can also let this module do	571	Instead of formatting your data yourself, you can also let this module do
461	the job by specifying a type and type-specific arguments.	572	the job by specifying a type and type-specific arguments.
462		573
463	Predefined types are (if you have ideas for additional types, feel free to	574	Predefined types are (if you have ideas for additional types, feel free to
464	drop by and tell us):	575	drop by and tell us):
…		…
468	=item netstring => $string	579	=item netstring => $string
469		580
470	Formats the given value as netstring	581	Formats the given value as netstring
471	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	582	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
472		583
473	=back
474
475	=cut	584	=cut
476		585
477	register_write_type netstring => sub {	586	register_write_type netstring => sub {
478	my ($self, $string) = @_;	587	my ($self, $string) = @_;
479		588
480	sprintf "%d:%s,", (length $string), $string	589	sprintf "%d:%s,", (length $string), $string
		590	};
		591
		592	=item packstring => $format, $data
		593
		594	An octet string prefixed with an encoded length. The encoding C<$format>
		595	uses the same format as a Perl C<pack> format, but must specify a single
		596	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		597	optional C<!>, C<< < >> or C<< > >> modifier).
		598
		599	=cut
		600
		601	register_write_type packstring => sub {
		602	my ($self, $format, $string) = @_;
		603
		604	pack "$format/a*", $string
481	};	605	};
482		606
483	=item json => $array_or_hashref	607	=item json => $array_or_hashref
484		608
485	Encodes the given hash or array reference into a JSON object. Unless you	609	Encodes the given hash or array reference into a JSON object. Unless you
…		…
519		643
520	$self->{json} ? $self->{json}->encode ($ref)	644	$self->{json} ? $self->{json}->encode ($ref)
521	: JSON::encode_json ($ref)	645	: JSON::encode_json ($ref)
522	};	646	};
523		647
		648	=item storable => $reference
		649
		650	Freezes the given reference using L<Storable> and writes it to the
		651	handle. Uses the C<nfreeze> format.
		652
		653	=cut
		654
		655	register_write_type storable => sub {
		656	my ($self, $ref) = @_;
		657
		658	require Storable;
		659
		660	pack "w/a*", Storable::nfreeze ($ref)
		661	};
		662
		663	=back
		664
524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525		666
526	This function (not method) lets you add your own types to C<push_write>.	667	This function (not method) lets you add your own types to C<push_write>.
527	Whenever the given C<type> is used, C<push_write> will invoke the code	668	Whenever the given C<type> is used, C<push_write> will invoke the code
528	reference with the handle object and the remaining arguments.	669	reference with the handle object and the remaining arguments.
…		…
548	ways, the "simple" way, using only C<on_read> and the "complex" way, using	689	ways, the "simple" way, using only C<on_read> and the "complex" way, using
549	a queue.	690	a queue.
550		691
551	In the simple case, you just install an C<on_read> callback and whenever	692	In the simple case, you just install an C<on_read> callback and whenever
552	new data arrives, it will be called. You can then remove some data (if	693	new data arrives, it will be called. You can then remove some data (if
553	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	694	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
554	or not.	695	leave the data there if you want to accumulate more (e.g. when only a
		696	partial message has been received so far).
555		697
556	In the more complex case, you want to queue multiple callbacks. In this	698	In the more complex case, you want to queue multiple callbacks. In this
557	case, AnyEvent::Handle will call the first queued callback each time new	699	case, AnyEvent::Handle will call the first queued callback each time new
558	data arrives and removes it when it has done its job (see C<push_read>,	700	data arrives (also the first time it is queued) and removes it when it has
559	below).	701	done its job (see C<push_read>, below).
560		702
561	This way you can, for example, push three line-reads, followed by reading	703	This way you can, for example, push three line-reads, followed by reading
562	a chunk of data, and AnyEvent::Handle will execute them in order.	704	a chunk of data, and AnyEvent::Handle will execute them in order.
563		705
564	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	706	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
565	the specified number of bytes which give an XML datagram.	707	the specified number of bytes which give an XML datagram.
566		708
567	# in the default state, expect some header bytes	709	# in the default state, expect some header bytes
568	$handle->on_read (sub {	710	$handle->on_read (sub {
569	# some data is here, now queue the length-header-read (4 octets)	711	# some data is here, now queue the length-header-read (4 octets)
570	shift->unshift_read_chunk (4, sub {	712	shift->unshift_read (chunk => 4, sub {
571	# header arrived, decode	713	# header arrived, decode
572	my $len = unpack "N", $_[1];	714	my $len = unpack "N", $_[1];
573		715
574	# now read the payload	716	# now read the payload
575	shift->unshift_read_chunk ($len, sub {	717	shift->unshift_read (chunk => $len, sub {
576	my $xml = $_[1];	718	my $xml = $_[1];
577	# handle xml	719	# handle xml
578	});	720	});
579	});	721	});
580	});	722	});
581		723
582	Example 2: Implement a client for a protocol that replies either with	724	Example 2: Implement a client for a protocol that replies either with "OK"
583	"OK" and another line or "ERROR" for one request, and 64 bytes for the	725	and another line or "ERROR" for the first request that is sent, and 64
584	second request. Due tot he availability of a full queue, we can just	726	bytes for the second request. Due to the availability of a queue, we can
585	pipeline sending both requests and manipulate the queue as necessary in	727	just pipeline sending both requests and manipulate the queue as necessary
586	the callbacks:	728	in the callbacks.
587		729
588	# request one	730	When the first callback is called and sees an "OK" response, it will
		731	C<unshift> another line-read. This line-read will be queued I<before> the
		732	64-byte chunk callback.
		733
		734	# request one, returns either "OK + extra line" or "ERROR"
589	$handle->push_write ("request 1\015\012");	735	$handle->push_write ("request 1\015\012");
590		736
591	# we expect "ERROR" or "OK" as response, so push a line read	737	# we expect "ERROR" or "OK" as response, so push a line read
592	$handle->push_read_line (sub {	738	$handle->push_read (line => sub {
593	# if we got an "OK", we have to _prepend_ another line,	739	# if we got an "OK", we have to _prepend_ another line,
594	# so it will be read before the second request reads its 64 bytes	740	# so it will be read before the second request reads its 64 bytes
595	# which are already in the queue when this callback is called	741	# which are already in the queue when this callback is called
596	# we don't do this in case we got an error	742	# we don't do this in case we got an error
597	if ($_[1] eq "OK") {	743	if ($_[1] eq "OK") {
598	$_[0]->unshift_read_line (sub {	744	$_[0]->unshift_read (line => sub {
599	my $response = $_[1];	745	my $response = $_[1];
600	...	746	...
601	});	747	});
602	}	748	}
603	});	749	});
604		750
605	# request two	751	# request two, simply returns 64 octets
606	$handle->push_write ("request 2\015\012");	752	$handle->push_write ("request 2\015\012");
607		753
608	# simply read 64 bytes, always	754	# simply read 64 bytes, always
609	$handle->push_read_chunk (64, sub {	755	$handle->push_read (chunk => 64, sub {
610	my $response = $_[1];	756	my $response = $_[1];
611	...	757	...
612	});	758	});
613		759
614	=over 4	760	=over 4
615		761
616	=cut	762	=cut
617		763
618	sub _drain_rbuf {	764	sub _drain_rbuf {
619	my ($self) = @_;	765	my ($self) = @_;
		766
		767	local $self->{_in_drain} = 1;
620		768
621	if (	769	if (
622	defined $self->{rbuf_max}	770	defined $self->{rbuf_max}
623	&& $self->{rbuf_max} < length $self->{rbuf}	771	&& $self->{rbuf_max} < length $self->{rbuf}
624	) {	772	) {
625	$! = &Errno::ENOSPC;	773	$self->_error (&Errno::ENOSPC, 1), return;
626	$self->error;
627	}	774	}
628		775
629	return if $self->{in_drain};	776	while () {
630	local $self->{in_drain} = 1;
631
632	while (my $len = length $self->{rbuf}) {	777	my $len = length $self->{rbuf};
633	no strict 'refs';	778
634	if (my $cb = shift @{ $self->{_queue} }) {	779	if (my $cb = shift @{ $self->{_queue} }) {
635	unless ($cb->($self)) {	780	unless ($cb->($self)) {
636	if ($self->{_eof}) {	781	if ($self->{_eof}) {
637	# no progress can be made (not enough data and no data forthcoming)	782	# no progress can be made (not enough data and no data forthcoming)
638	$! = &Errno::EPIPE;	783	$self->_error (&Errno::EPIPE, 1), return;
639	$self->error;
640	}	784	}
641		785
642	unshift @{ $self->{_queue} }, $cb;	786	unshift @{ $self->{_queue} }, $cb;
643	return;	787	last;
644	}	788	}
645	} elsif ($self->{on_read}) {	789	} elsif ($self->{on_read}) {
		790	last unless $len;
		791
646	$self->{on_read}($self);	792	$self->{on_read}($self);
647		793
648	if (	794	if (
649	$self->{_eof} # if no further data will arrive
650	&& $len == length $self->{rbuf} # and no data has been consumed	795	$len == length $self->{rbuf} # if no data has been consumed
651	&& !@{ $self->{_queue} } # and the queue is still empty	796	&& !@{ $self->{_queue} } # and the queue is still empty
652	&& $self->{on_read} # and we still want to read data	797	&& $self->{on_read} # but we still have on_read
653	) {	798	) {
		799	# no further data will arrive
654	# then no progress can be made	800	# so no progress can be made
655	$! = &Errno::EPIPE;	801	$self->_error (&Errno::EPIPE, 1), return
656	$self->error;	802	if $self->{_eof};
		803
		804	last; # more data might arrive
657	}	805	}
658	} else {	806	} else {
659	# read side becomes idle	807	# read side becomes idle
660	delete $self->{_rw};	808	delete $self->{_rw};
661	return;	809	last;
662	}	810	}
663	}	811	}
664		812
665	if ($self->{_eof}) {	813	if ($self->{_eof}) {
666	$self->_shutdown;	814	if ($self->{on_eof}) {
667	$self->{on_eof}($self)	815	$self->{on_eof}($self)
668	if $self->{on_eof};	816	} else {
		817	$self->_error (0, 1);
		818	}
		819	}
		820
		821	# may need to restart read watcher
		822	unless ($self->{_rw}) {
		823	$self->start_read
		824	if $self->{on_read} \|\| @{ $self->{_queue} };
669	}	825	}
670	}	826	}
671		827
672	=item $handle->on_read ($cb)	828	=item $handle->on_read ($cb)
673		829
…		…
679		835
680	sub on_read {	836	sub on_read {
681	my ($self, $cb) = @_;	837	my ($self, $cb) = @_;
682		838
683	$self->{on_read} = $cb;	839	$self->{on_read} = $cb;
		840	$self->_drain_rbuf if $cb && !$self->{_in_drain};
684	}	841	}
685		842
686	=item $handle->rbuf	843	=item $handle->rbuf
687		844
688	Returns the read buffer (as a modifiable lvalue).	845	Returns the read buffer (as a modifiable lvalue).
…		…
737	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	894	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
738	->($self, $cb, @_);	895	->($self, $cb, @_);
739	}	896	}
740		897
741	push @{ $self->{_queue} }, $cb;	898	push @{ $self->{_queue} }, $cb;
742	$self->_drain_rbuf;	899	$self->_drain_rbuf unless $self->{_in_drain};
743	}	900	}
744		901
745	sub unshift_read {	902	sub unshift_read {
746	my $self = shift;	903	my $self = shift;
747	my $cb = pop;	904	my $cb = pop;
…		…
753	->($self, $cb, @_);	910	->($self, $cb, @_);
754	}	911	}
755		912
756		913
757	unshift @{ $self->{_queue} }, $cb;	914	unshift @{ $self->{_queue} }, $cb;
758	$self->_drain_rbuf;	915	$self->_drain_rbuf unless $self->{_in_drain};
759	}	916	}
760		917
761	=item $handle->push_read (type => @args, $cb)	918	=item $handle->push_read (type => @args, $cb)
762		919
763	=item $handle->unshift_read (type => @args, $cb)	920	=item $handle->unshift_read (type => @args, $cb)
…		…
793	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	950	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
794	1	951	1
795	}	952	}
796	};	953	};
797		954
798	# compatibility with older API
799	sub push_read_chunk {
800	$_[0]->push_read (chunk => $_[1], $_[2]);
801	}
802
803	sub unshift_read_chunk {
804	$_[0]->unshift_read (chunk => $_[1], $_[2]);
805	}
806
807	=item line => [$eol, ]$cb->($handle, $line, $eol)	955	=item line => [$eol, ]$cb->($handle, $line, $eol)
808		956
809	The callback will be called only once a full line (including the end of	957	The callback will be called only once a full line (including the end of
810	line marker, C<$eol>) has been read. This line (excluding the end of line	958	line marker, C<$eol>) has been read. This line (excluding the end of line
811	marker) will be passed to the callback as second argument (C<$line>), and	959	marker) will be passed to the callback as second argument (C<$line>), and
…		…
826	=cut	974	=cut
827		975
828	register_read_type line => sub {	976	register_read_type line => sub {
829	my ($self, $cb, $eol) = @_;	977	my ($self, $cb, $eol) = @_;
830		978
831	$eol = qr\|(\015?\012)\| if @_ < 3;	979	if (@_ < 3) {
832	$eol = quotemeta $eol unless ref $eol;	980	# this is more than twice as fast as the generic code below
833	$eol = qr\|^(.*?)($eol)\|s;
834
835	sub {	981	sub {
836	$_[0]{rbuf} =~ s/$eol// or return;	982	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
837		983
838	$cb->($_[0], $1, $2);	984	$cb->($_[0], $1, $2);
839	1
840	}
841	};
842
843	# compatibility with older API
844	sub push_read_line {
845	my $self = shift;
846	$self->push_read (line => @_);
847	}
848
849	sub unshift_read_line {
850	my $self = shift;
851	$self->unshift_read (line => @_);
852	}
853
854	=item netstring => $cb->($handle, $string)
855
856	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
857
858	Throws an error with C<$!> set to EBADMSG on format violations.
859
860	=cut
861
862	register_read_type netstring => sub {
863	my ($self, $cb) = @_;
864
865	sub {
866	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
867	if ($_[0]{rbuf} =~ /[^0-9]/) {
868	$! = &Errno::EBADMSG;
869	$self->error;
870	}	985	1
871	return;
872	}	986	}
		987	} else {
		988	$eol = quotemeta $eol unless ref $eol;
		989	$eol = qr\|^(.*?)($eol)\|s;
873		990
874	my $len = $1;	991	sub {
		992	$_[0]{rbuf} =~ s/$eol// or return;
875		993
876	$self->unshift_read (chunk => $len, sub {	994	$cb->($_[0], $1, $2);
877	my $string = $_[1];
878	$_[0]->unshift_read (chunk => 1, sub {
879	if ($_[1] eq ",") {
880	$cb->($_[0], $string);
881	} else {
882	$! = &Errno::EBADMSG;
883	$self->error;
884	}
885	});	995	1
886	});	996	}
887
888	1
889	}	997	}
890	};	998	};
891		999
892	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1000	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
893		1001
…		…
945	return 1;	1053	return 1;
946	}	1054	}
947		1055
948	# reject	1056	# reject
949	if ($reject && $$rbuf =~ $reject) {	1057	if ($reject && $$rbuf =~ $reject) {
950	$! = &Errno::EBADMSG;	1058	$self->_error (&Errno::EBADMSG);
951	$self->error;
952	}	1059	}
953		1060
954	# skip	1061	# skip
955	if ($skip && $$rbuf =~ $skip) {	1062	if ($skip && $$rbuf =~ $skip) {
956	$data .= substr $$rbuf, 0, $+[0], "";	1063	$data .= substr $$rbuf, 0, $+[0], "";
…		…
958		1065
959	()	1066	()
960	}	1067	}
961	};	1068	};
962		1069
		1070	=item netstring => $cb->($handle, $string)
		1071
		1072	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1073
		1074	Throws an error with C<$!> set to EBADMSG on format violations.
		1075
		1076	=cut
		1077
		1078	register_read_type netstring => sub {
		1079	my ($self, $cb) = @_;
		1080
		1081	sub {
		1082	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1083	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1084	$self->_error (&Errno::EBADMSG);
		1085	}
		1086	return;
		1087	}
		1088
		1089	my $len = $1;
		1090
		1091	$self->unshift_read (chunk => $len, sub {
		1092	my $string = $_[1];
		1093	$_[0]->unshift_read (chunk => 1, sub {
		1094	if ($_[1] eq ",") {
		1095	$cb->($_[0], $string);
		1096	} else {
		1097	$self->_error (&Errno::EBADMSG);
		1098	}
		1099	});
		1100	});
		1101
		1102	1
		1103	}
		1104	};
		1105
		1106	=item packstring => $format, $cb->($handle, $string)
		1107
		1108	An octet string prefixed with an encoded length. The encoding C<$format>
		1109	uses the same format as a Perl C<pack> format, but must specify a single
		1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1111	optional C<!>, C<< < >> or C<< > >> modifier).
		1112
		1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1114
		1115	Example: read a block of data prefixed by its length in BER-encoded
		1116	format (very efficient).
		1117
		1118	$handle->push_read (packstring => "w", sub {
		1119	my ($handle, $data) = @_;
		1120	});
		1121
		1122	=cut
		1123
		1124	register_read_type packstring => sub {
		1125	my ($self, $cb, $format) = @_;
		1126
		1127	sub {
		1128	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1129	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1130	or return;
		1131
		1132	$format = length pack $format, $len;
		1133
		1134	# bypass unshift if we already have the remaining chunk
		1135	if ($format + $len <= length $_[0]{rbuf}) {
		1136	my $data = substr $_[0]{rbuf}, $format, $len;
		1137	substr $_[0]{rbuf}, 0, $format + $len, "";
		1138	$cb->($_[0], $data);
		1139	} else {
		1140	# remove prefix
		1141	substr $_[0]{rbuf}, 0, $format, "";
		1142
		1143	# read remaining chunk
		1144	$_[0]->unshift_read (chunk => $len, $cb);
		1145	}
		1146
		1147	1
		1148	}
		1149	};
		1150
963	=item json => $cb->($handle, $hash_or_arrayref)	1151	=item json => $cb->($handle, $hash_or_arrayref)
964		1152
965	Reads a JSON object or array, decodes it and passes it to the callback.	1153	Reads a JSON object or array, decodes it and passes it to the callback.
966		1154
967	If a C<json> object was passed to the constructor, then that will be used	1155	If a C<json> object was passed to the constructor, then that will be used
…		…
977	the C<json> write type description, above, for an actual example.	1165	the C<json> write type description, above, for an actual example.
978		1166
979	=cut	1167	=cut
980		1168
981	register_read_type json => sub {	1169	register_read_type json => sub {
982	my ($self, $cb, $accept, $reject, $skip) = @_;	1170	my ($self, $cb) = @_;
983		1171
984	require JSON;	1172	require JSON;
985		1173
986	my $data;	1174	my $data;
987	my $rbuf = \$self->{rbuf};	1175	my $rbuf = \$self->{rbuf};
…		…
1002	()	1190	()
1003	}	1191	}
1004	}	1192	}
1005	};	1193	};
1006		1194
		1195	=item storable => $cb->($handle, $ref)
		1196
		1197	Deserialises a L<Storable> frozen representation as written by the
		1198	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1199	data).
		1200
		1201	Raises C<EBADMSG> error if the data could not be decoded.
		1202
		1203	=cut
		1204
		1205	register_read_type storable => sub {
		1206	my ($self, $cb) = @_;
		1207
		1208	require Storable;
		1209
		1210	sub {
		1211	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1212	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1213	or return;
		1214
		1215	my $format = length pack "w", $len;
		1216
		1217	# bypass unshift if we already have the remaining chunk
		1218	if ($format + $len <= length $_[0]{rbuf}) {
		1219	my $data = substr $_[0]{rbuf}, $format, $len;
		1220	substr $_[0]{rbuf}, 0, $format + $len, "";
		1221	$cb->($_[0], Storable::thaw ($data));
		1222	} else {
		1223	# remove prefix
		1224	substr $_[0]{rbuf}, 0, $format, "";
		1225
		1226	# read remaining chunk
		1227	$_[0]->unshift_read (chunk => $len, sub {
		1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1229	$cb->($_[0], $ref);
		1230	} else {
		1231	$self->_error (&Errno::EBADMSG);
		1232	}
		1233	});
		1234	}
		1235
		1236	1
		1237	}
		1238	};
		1239
1007	=back	1240	=back
1008		1241
1009	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1242	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1010		1243
1011	This function (not method) lets you add your own types to C<push_read>.	1244	This function (not method) lets you add your own types to C<push_read>.
…		…
1029	=item $handle->stop_read	1262	=item $handle->stop_read
1030		1263
1031	=item $handle->start_read	1264	=item $handle->start_read
1032		1265
1033	In rare cases you actually do not want to read anything from the	1266	In rare cases you actually do not want to read anything from the
1034	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1267	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1035	any queued callbacks will be executed then. To start reading again, call	1268	any queued callbacks will be executed then. To start reading again, call
1036	C<start_read>.	1269	C<start_read>.
		1270
		1271	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1272	you change the C<on_read> callback or push/unshift a read callback, and it
		1273	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1274	there are any read requests in the queue.
1037		1275
1038	=cut	1276	=cut
1039		1277
1040	sub stop_read {	1278	sub stop_read {
1041	my ($self) = @_;	1279	my ($self) = @_;
…		…
1055		1293
1056	if ($len > 0) {	1294	if ($len > 0) {
1057	$self->{_activity} = AnyEvent->now;	1295	$self->{_activity} = AnyEvent->now;
1058		1296
1059	$self->{filter_r}	1297	$self->{filter_r}
1060	? $self->{filter_r}->($self, $rbuf)	1298	? $self->{filter_r}($self, $rbuf)
1061	: $self->_drain_rbuf;	1299	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1062		1300
1063	} elsif (defined $len) {	1301	} elsif (defined $len) {
1064	delete $self->{_rw};	1302	delete $self->{_rw};
1065	delete $self->{_ww};
1066	delete $self->{_tw};
1067	$self->{_eof} = 1;	1303	$self->{_eof} = 1;
1068	$self->_drain_rbuf;	1304	$self->_drain_rbuf unless $self->{_in_drain};
1069		1305
1070	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1071	return $self->error;	1307	return $self->_error ($!, 1);
1072	}	1308	}
1073	});	1309	});
1074	}	1310	}
1075	}	1311	}
1076		1312
1077	sub _dotls {	1313	sub _dotls {
1078	my ($self) = @_;	1314	my ($self) = @_;
		1315
		1316	my $buf;
1079		1317
1080	if (length $self->{_tls_wbuf}) {	1318	if (length $self->{_tls_wbuf}) {
1081	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) {
1082	substr $self->{_tls_wbuf}, 0, $len, "";	1320	substr $self->{_tls_wbuf}, 0, $len, "";
1083	}	1321	}
1084	}	1322	}
1085		1323
1086	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1324	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1087	$self->{wbuf} .= $buf;	1325	$self->{wbuf} .= $buf;
1088	$self->_drain_wbuf;	1326	$self->_drain_wbuf;
1089	}	1327	}
1090		1328
1091	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1329	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1330	if (length $buf) {
1092	$self->{rbuf} .= $buf;	1331	$self->{rbuf} .= $buf;
1093	$self->_drain_rbuf;	1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	} else {
		1334	# let's treat SSL-eof as we treat normal EOF
		1335	$self->{_eof} = 1;
		1336	$self->_shutdown;
		1337	return;
		1338	}
1094	}	1339	}
1095		1340
1096	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1341	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1097		1342
1098	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1343	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1099	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1344	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1100	$self->error;	1345	return $self->_error ($!, 1);
1101	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1346	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1102	$! = &Errno::EIO;	1347	return $self->_error (&Errno::EIO, 1);
1103	$self->error;
1104	}	1348	}
1105		1349
1106	# all others are fine for our purposes	1350	# all others are fine for our purposes
1107	}	1351	}
1108	}	1352	}
…		…
1123	call and can be used or changed to your liking. Note that the handshake	1367	call and can be used or changed to your liking. Note that the handshake
1124	might have already started when this function returns.	1368	might have already started when this function returns.
1125		1369
1126	=cut	1370	=cut
1127		1371
1128	# TODO: maybe document...
1129	sub starttls {	1372	sub starttls {
1130	my ($self, $ssl, $ctx) = @_;	1373	my ($self, $ssl, $ctx) = @_;
1131		1374
1132	$self->stoptls;	1375	$self->stoptls;
1133		1376
…		…
1144	# basically, this is deep magic (because SSL_read should have the same issues)	1387	# basically, this is deep magic (because SSL_read should have the same issues)
1145	# but the openssl maintainers basically said: "trust us, it just works".	1388	# but the openssl maintainers basically said: "trust us, it just works".
1146	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1389	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1147	# and mismaintained ssleay-module doesn't even offer them).	1390	# and mismaintained ssleay-module doesn't even offer them).
1148	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1391	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1392	#
		1393	# in short: this is a mess.
		1394	#
		1395	# note that we do not try to kepe the length constant between writes as we are required to do.
		1396	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1397	# and we drive openssl fully in blocking mode here.
1149	Net::SSLeay::CTX_set_mode ($self->{tls},	1398	Net::SSLeay::CTX_set_mode ($self->{tls},
1150	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1399	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1151	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1400	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1152		1401
1153	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1402	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
…		…
1186		1435
1187	sub DESTROY {	1436	sub DESTROY {
1188	my $self = shift;	1437	my $self = shift;
1189		1438
1190	$self->stoptls;	1439	$self->stoptls;
		1440
		1441	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1442
		1443	if ($linger && length $self->{wbuf}) {
		1444	my $fh = delete $self->{fh};
		1445	my $wbuf = delete $self->{wbuf};
		1446
		1447	my @linger;
		1448
		1449	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1450	my $len = syswrite $fh, $wbuf, length $wbuf;
		1451
		1452	if ($len > 0) {
		1453	substr $wbuf, 0, $len, "";
		1454	} else {
		1455	@linger = (); # end
		1456	}
		1457	});
		1458	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1459	@linger = ();
		1460	});
		1461	}
1191	}	1462	}
1192		1463
1193	=item AnyEvent::Handle::TLS_CTX	1464	=item AnyEvent::Handle::TLS_CTX
1194		1465
1195	This function creates and returns the Net::SSLeay::CTX object used by	1466	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1237	=over 4	1508	=over 4
1238		1509
1239	=item * all constructor arguments become object members.	1510	=item * all constructor arguments become object members.
1240		1511
1241	At least initially, when you pass a C<tls>-argument to the constructor it	1512	At least initially, when you pass a C<tls>-argument to the constructor it
1242	will end up in C<< $handle->{tls} >>. Those members might be changes or	1513	will end up in C<< $handle->{tls} >>. Those members might be changed or
1243	mutated later on (for example C<tls> will hold the TLS connection object).	1514	mutated later on (for example C<tls> will hold the TLS connection object).
1244		1515
1245	=item * other object member names are prefixed with an C<_>.	1516	=item * other object member names are prefixed with an C<_>.
1246		1517
1247	All object members not explicitly documented (internal use) are prefixed	1518	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.45 by root, Thu May 29 00:20:39 2008 UTC vs. Revision 1.90 by root, Mon Sep 29 02:08:57 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC vs.
Revision 1.90 by root, Mon Sep 29 02:08:57 2008 UTC