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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.62 by root, Fri Jun 6 10:49:20 2008 UTC vs.
Revision 1.93 by root, Wed Oct 1 14:49:23 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.14;	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
…		…
124	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
125	(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).
126		151
127	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.
128		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
129	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
130		161
131	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
132	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
133	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
134	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		166
136	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
137	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
138	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
139	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
140		172
141	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
142		174
143	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
144		176
…		…
148		180
149	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
150		182
151	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>)
152	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
153	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
154		186
155	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
156	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
157	(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
158	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
159	isn't finished).	191	isn't finished).
160		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
161	=item read_size => <bytes>	219	=item read_size => <bytes>
162		220
163	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
164	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
165		224
166	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
167		226
168	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
169	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
170	considered empty.	229	considered empty.
171		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
172	=item linger => <seconds>	236	=item linger => <seconds>
173		237
174	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	239	AnyEvent::Handle object will check whether there is still outstanding
176	data and will install a watcher that will write out this data. No errors	240	write data and will install a watcher that will write this data to the
177	will be reported (this mostly matches how the operating system treats	241	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
179		243
180	This will not work for partial TLS data that could not yet been	244	This will not work for partial TLS data that could not be encoded
181	encoded. This data will be lost.	245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
182		247
183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
184		249
185	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
186	will start making tls handshake and will transparently encrypt/decrypt	251	AnyEvent will start a TLS handshake as soon as the conenction has been
187	data.	252	established and will transparently encrypt/decrypt data afterwards.
188		253
189	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
190	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.
191		258
192	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
193	connection, use C<connect> mode.	260	C<accept>, and for the TLS client side of a connection, use C<connect>
		261	mode.
194		262
195	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
196	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>
197	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
198	AnyEvent::Handle.	266	AnyEvent::Handle.
199		267
200	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.
201		269
202	=item tls_ctx => $ssl_ctx	270	=item tls_ctx => $ssl_ctx
203		271
204	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
205	(unless a connection object was specified directly). If this parameter is	273	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	274	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		275
208	=item json => JSON or JSON::XS object	276	=item json => JSON or JSON::XS object
209		277
210	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.
211		279
212	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
213	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.
214		283
215	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
216	use this functionality, as AnyEvent does not have a dependency itself.	285	use this functionality, as AnyEvent does not have a dependency itself.
217
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223		286
224	=back	287	=back
225		288
226	=cut	289	=cut
227		290
…		…
240	}	303	}
241		304
242	$self->{_activity} = AnyEvent->now;	305	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;	306	$self->_timeout;
244		307
245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	308	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		309	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		310
		311	$self->start_read
		312	if $self->{on_read};
246		313
247	$self	314	$self
248	}	315	}
249		316
250	sub _shutdown {	317	sub _shutdown {
…		…
253	delete $self->{_tw};	320	delete $self->{_tw};
254	delete $self->{_rw};	321	delete $self->{_rw};
255	delete $self->{_ww};	322	delete $self->{_ww};
256	delete $self->{fh};	323	delete $self->{fh};
257		324
258	$self->stoptls;	325	&_freetls;
		326
		327	delete $self->{on_read};
		328	delete $self->{_queue};
259	}	329	}
260		330
261	sub _error {	331	sub _error {
262	my ($self, $errno, $fatal) = @_;	332	my ($self, $errno, $fatal) = @_;
263		333
…		…
273	}	343	}
274	}	344	}
275		345
276	=item $fh = $handle->fh	346	=item $fh = $handle->fh
277		347
278	This method returns the file handle of the L<AnyEvent::Handle> object.	348	This method returns the file handle used to create the L<AnyEvent::Handle> object.
279		349
280	=cut	350	=cut
281		351
282	sub fh { $_[0]{fh} }	352	sub fh { $_[0]{fh} }
283		353
…		…
301	$_[0]{on_eof} = $_[1];	371	$_[0]{on_eof} = $_[1];
302	}	372	}
303		373
304	=item $handle->on_timeout ($cb)	374	=item $handle->on_timeout ($cb)
305		375
306	Replace the current C<on_timeout> callback, or disables the callback	376	Replace the current C<on_timeout> callback, or disables the callback (but
307	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	377	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
308	argument.	378	argument and method.
309		379
310	=cut	380	=cut
311		381
312	sub on_timeout {	382	sub on_timeout {
313	$_[0]{on_timeout} = $_[1];	383	$_[0]{on_timeout} = $_[1];
		384	}
		385
		386	=item $handle->autocork ($boolean)
		387
		388	Enables or disables the current autocork behaviour (see C<autocork>
		389	constructor argument).
		390
		391	=cut
		392
		393	=item $handle->no_delay ($boolean)
		394
		395	Enables or disables the C<no_delay> setting (see constructor argument of
		396	the same name for details).
		397
		398	=cut
		399
		400	sub no_delay {
		401	$_[0]{no_delay} = $_[1];
		402
		403	eval {
		404	local $SIG{__DIE__};
		405	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		406	};
314	}	407	}
315		408
316	#############################################################################	409	#############################################################################
317		410
318	=item $handle->timeout ($seconds)	411	=item $handle->timeout ($seconds)
…		…
396	my ($self, $cb) = @_;	489	my ($self, $cb) = @_;
397		490
398	$self->{on_drain} = $cb;	491	$self->{on_drain} = $cb;
399		492
400	$cb->($self)	493	$cb->($self)
401	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	494	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
402	}	495	}
403		496
404	=item $handle->push_write ($data)	497	=item $handle->push_write ($data)
405		498
406	Queues the given scalar to be written. You can push as much data as you	499	Queues the given scalar to be written. You can push as much data as you
…		…
423	substr $self->{wbuf}, 0, $len, "";	516	substr $self->{wbuf}, 0, $len, "";
424		517
425	$self->{_activity} = AnyEvent->now;	518	$self->{_activity} = AnyEvent->now;
426		519
427	$self->{on_drain}($self)	520	$self->{on_drain}($self)
428	if $self->{low_water_mark} >= length $self->{wbuf}	521	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
429	&& $self->{on_drain};	522	&& $self->{on_drain};
430		523
431	delete $self->{_ww} unless length $self->{wbuf};	524	delete $self->{_ww} unless length $self->{wbuf};
432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	525	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
433	$self->_error ($!, 1);	526	$self->_error ($!, 1);
434	}	527	}
435	};	528	};
436		529
437	# try to write data immediately	530	# try to write data immediately
438	$cb->();	531	$cb->() unless $self->{autocork};
439		532
440	# if still data left in wbuf, we need to poll	533	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	534	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
442	if length $self->{wbuf};	535	if length $self->{wbuf};
443	};	536	};
…		…
457		550
458	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	551	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
459	->($self, @_);	552	->($self, @_);
460	}	553	}
461		554
462	if ($self->{filter_w}) {	555	if ($self->{tls}) {
463	$self->{filter_w}($self, \$_[0]);	556	$self->{_tls_wbuf} .= $_[0];
		557	&_dotls ($self);
464	} else {	558	} else {
465	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
466	$self->_drain_wbuf;	560	$self->_drain_wbuf;
467	}	561	}
468	}	562	}
…		…
500	=cut	594	=cut
501		595
502	register_write_type packstring => sub {	596	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	597	my ($self, $format, $string) = @_;
504		598
505	pack "$format/a", $string	599	pack "$format/a*", $string
506	};	600	};
507		601
508	=item json => $array_or_hashref	602	=item json => $array_or_hashref
509		603
510	Encodes the given hash or array reference into a JSON object. Unless you	604	Encodes the given hash or array reference into a JSON object. Unless you
…		…
544		638
545	$self->{json} ? $self->{json}->encode ($ref)	639	$self->{json} ? $self->{json}->encode ($ref)
546	: JSON::encode_json ($ref)	640	: JSON::encode_json ($ref)
547	};	641	};
548		642
		643	=item storable => $reference
		644
		645	Freezes the given reference using L<Storable> and writes it to the
		646	handle. Uses the C<nfreeze> format.
		647
		648	=cut
		649
		650	register_write_type storable => sub {
		651	my ($self, $ref) = @_;
		652
		653	require Storable;
		654
		655	pack "w/a*", Storable::nfreeze ($ref)
		656	};
		657
549	=back	658	=back
550		659
551	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
552		661
553	This function (not method) lets you add your own types to C<push_write>.	662	This function (not method) lets you add your own types to C<push_write>.
…		…
575	ways, the "simple" way, using only C<on_read> and the "complex" way, using	684	ways, the "simple" way, using only C<on_read> and the "complex" way, using
576	a queue.	685	a queue.
577		686
578	In the simple case, you just install an C<on_read> callback and whenever	687	In the simple case, you just install an C<on_read> callback and whenever
579	new data arrives, it will be called. You can then remove some data (if	688	new data arrives, it will be called. You can then remove some data (if
580	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	689	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
581	or not.	690	leave the data there if you want to accumulate more (e.g. when only a
		691	partial message has been received so far).
582		692
583	In the more complex case, you want to queue multiple callbacks. In this	693	In the more complex case, you want to queue multiple callbacks. In this
584	case, AnyEvent::Handle will call the first queued callback each time new	694	case, AnyEvent::Handle will call the first queued callback each time new
585	data arrives (also the first time it is queued) and removes it when it has	695	data arrives (also the first time it is queued) and removes it when it has
586	done its job (see C<push_read>, below).	696	done its job (see C<push_read>, below).
…		…
604	# handle xml	714	# handle xml
605	});	715	});
606	});	716	});
607	});	717	});
608		718
609	Example 2: Implement a client for a protocol that replies either with	719	Example 2: Implement a client for a protocol that replies either with "OK"
610	"OK" and another line or "ERROR" for one request, and 64 bytes for the	720	and another line or "ERROR" for the first request that is sent, and 64
611	second request. Due tot he availability of a full queue, we can just	721	bytes for the second request. Due to the availability of a queue, we can
612	pipeline sending both requests and manipulate the queue as necessary in	722	just pipeline sending both requests and manipulate the queue as necessary
613	the callbacks:	723	in the callbacks.
614		724
615	# request one	725	When the first callback is called and sees an "OK" response, it will
		726	C<unshift> another line-read. This line-read will be queued I<before> the
		727	64-byte chunk callback.
		728
		729	# request one, returns either "OK + extra line" or "ERROR"
616	$handle->push_write ("request 1\015\012");	730	$handle->push_write ("request 1\015\012");
617		731
618	# we expect "ERROR" or "OK" as response, so push a line read	732	# we expect "ERROR" or "OK" as response, so push a line read
619	$handle->push_read (line => sub {	733	$handle->push_read (line => sub {
620	# if we got an "OK", we have to _prepend_ another line,	734	# if we got an "OK", we have to _prepend_ another line,
…		…
627	...	741	...
628	});	742	});
629	}	743	}
630	});	744	});
631		745
632	# request two	746	# request two, simply returns 64 octets
633	$handle->push_write ("request 2\015\012");	747	$handle->push_write ("request 2\015\012");
634		748
635	# simply read 64 bytes, always	749	# simply read 64 bytes, always
636	$handle->push_read (chunk => 64, sub {	750	$handle->push_read (chunk => 64, sub {
637	my $response = $_[1];	751	my $response = $_[1];
…		…
649		763
650	if (	764	if (
651	defined $self->{rbuf_max}	765	defined $self->{rbuf_max}
652	&& $self->{rbuf_max} < length $self->{rbuf}	766	&& $self->{rbuf_max} < length $self->{rbuf}
653	) {	767	) {
654	return $self->_error (&Errno::ENOSPC, 1);	768	$self->_error (&Errno::ENOSPC, 1), return;
655	}	769	}
656		770
657	while () {	771	while () {
658	no strict 'refs';
659
660	my $len = length $self->{rbuf};	772	my $len = length $self->{rbuf};
661		773
662	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
663	unless ($cb->($self)) {	775	unless ($cb->($self)) {
664	if ($self->{_eof}) {	776	if ($self->{_eof}) {
665	# no progress can be made (not enough data and no data forthcoming)	777	# no progress can be made (not enough data and no data forthcoming)
666	$self->_error (&Errno::EPIPE, 1), last;	778	$self->_error (&Errno::EPIPE, 1), return;
667	}	779	}
668		780
669	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
670	last;	782	last;
671	}	783	}
…		…
679	&& !@{ $self->{_queue} } # and the queue is still empty	791	&& !@{ $self->{_queue} } # and the queue is still empty
680	&& $self->{on_read} # but we still have on_read	792	&& $self->{on_read} # but we still have on_read
681	) {	793	) {
682	# no further data will arrive	794	# no further data will arrive
683	# so no progress can be made	795	# so no progress can be made
684	$self->_error (&Errno::EPIPE, 1), last	796	$self->_error (&Errno::EPIPE, 1), return
685	if $self->{_eof};	797	if $self->{_eof};
686		798
687	last; # more data might arrive	799	last; # more data might arrive
688	}	800	}
689	} else {	801	} else {
690	# read side becomes idle	802	# read side becomes idle
691	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
692	last;	804	last;
693	}	805	}
694	}	806	}
695		807
		808	if ($self->{_eof}) {
		809	if ($self->{on_eof}) {
696	$self->{on_eof}($self)	810	$self->{on_eof}($self)
697	if $self->{_eof} && $self->{on_eof};	811	} else {
		812	$self->_error (0, 1);
		813	}
		814	}
698		815
699	# may need to restart read watcher	816	# may need to restart read watcher
700	unless ($self->{_rw}) {	817	unless ($self->{_rw}) {
701	$self->start_read	818	$self->start_read
702	if $self->{on_read} \|\| @{ $self->{_queue} };	819	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
828	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	945	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
829	1	946	1
830	}	947	}
831	};	948	};
832		949
833	# compatibility with older API
834	sub push_read_chunk {
835	$_[0]->push_read (chunk => $_[1], $_[2]);
836	}
837
838	sub unshift_read_chunk {
839	$_[0]->unshift_read (chunk => $_[1], $_[2]);
840	}
841
842	=item line => [$eol, ]$cb->($handle, $line, $eol)	950	=item line => [$eol, ]$cb->($handle, $line, $eol)
843		951
844	The callback will be called only once a full line (including the end of	952	The callback will be called only once a full line (including the end of
845	line marker, C<$eol>) has been read. This line (excluding the end of line	953	line marker, C<$eol>) has been read. This line (excluding the end of line
846	marker) will be passed to the callback as second argument (C<$line>), and	954	marker) will be passed to the callback as second argument (C<$line>), and
…		…
861	=cut	969	=cut
862		970
863	register_read_type line => sub {	971	register_read_type line => sub {
864	my ($self, $cb, $eol) = @_;	972	my ($self, $cb, $eol) = @_;
865		973
866	$eol = qr\|(\015?\012)\| if @_ < 3;	974	if (@_ < 3) {
		975	# this is more than twice as fast as the generic code below
		976	sub {
		977	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		978
		979	$cb->($_[0], $1, $2);
		980	1
		981	}
		982	} else {
867	$eol = quotemeta $eol unless ref $eol;	983	$eol = quotemeta $eol unless ref $eol;
868	$eol = qr\|^(.*?)($eol)\|s;	984	$eol = qr\|^(.*?)($eol)\|s;
869		985
870	sub {	986	sub {
871	$_[0]{rbuf} =~ s/$eol// or return;	987	$_[0]{rbuf} =~ s/$eol// or return;
872		988
873	$cb->($_[0], $1, $2);	989	$cb->($_[0], $1, $2);
		990	1
874	1	991	}
875	}	992	}
876	};	993	};
877
878	# compatibility with older API
879	sub push_read_line {
880	my $self = shift;
881	$self->push_read (line => @_);
882	}
883
884	sub unshift_read_line {
885	my $self = shift;
886	$self->unshift_read (line => @_);
887	}
888		994
889	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	995	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
890		996
891	Makes a regex match against the regex object C<$accept> and returns	997	Makes a regex match against the regex object C<$accept> and returns
892	everything up to and including the match.	998	everything up to and including the match.
…		…
1013	register_read_type packstring => sub {	1119	register_read_type packstring => sub {
1014	my ($self, $cb, $format) = @_;	1120	my ($self, $cb, $format) = @_;
1015		1121
1016	sub {	1122	sub {
1017	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1123	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1018	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1124	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1019	or return;	1125	or return;
1020		1126
		1127	$format = length pack $format, $len;
		1128
		1129	# bypass unshift if we already have the remaining chunk
		1130	if ($format + $len <= length $_[0]{rbuf}) {
		1131	my $data = substr $_[0]{rbuf}, $format, $len;
		1132	substr $_[0]{rbuf}, 0, $format + $len, "";
		1133	$cb->($_[0], $data);
		1134	} else {
1021	# remove prefix	1135	# remove prefix
1022	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1136	substr $_[0]{rbuf}, 0, $format, "";
1023		1137
1024	# read rest	1138	# read remaining chunk
1025	$_[0]->unshift_read (chunk => $len, $cb);	1139	$_[0]->unshift_read (chunk => $len, $cb);
		1140	}
1026		1141
1027	1	1142	1
1028	}	1143	}
1029	};	1144	};
1030		1145
…		…
1045	the C<json> write type description, above, for an actual example.	1160	the C<json> write type description, above, for an actual example.
1046		1161
1047	=cut	1162	=cut
1048		1163
1049	register_read_type json => sub {	1164	register_read_type json => sub {
1050	my ($self, $cb, $accept, $reject, $skip) = @_;	1165	my ($self, $cb) = @_;
1051		1166
1052	require JSON;	1167	require JSON;
1053		1168
1054	my $data;	1169	my $data;
1055	my $rbuf = \$self->{rbuf};	1170	my $rbuf = \$self->{rbuf};
…		…
1070	()	1185	()
1071	}	1186	}
1072	}	1187	}
1073	};	1188	};
1074		1189
		1190	=item storable => $cb->($handle, $ref)
		1191
		1192	Deserialises a L<Storable> frozen representation as written by the
		1193	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1194	data).
		1195
		1196	Raises C<EBADMSG> error if the data could not be decoded.
		1197
		1198	=cut
		1199
		1200	register_read_type storable => sub {
		1201	my ($self, $cb) = @_;
		1202
		1203	require Storable;
		1204
		1205	sub {
		1206	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1207	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1208	or return;
		1209
		1210	my $format = length pack "w", $len;
		1211
		1212	# bypass unshift if we already have the remaining chunk
		1213	if ($format + $len <= length $_[0]{rbuf}) {
		1214	my $data = substr $_[0]{rbuf}, $format, $len;
		1215	substr $_[0]{rbuf}, 0, $format + $len, "";
		1216	$cb->($_[0], Storable::thaw ($data));
		1217	} else {
		1218	# remove prefix
		1219	substr $_[0]{rbuf}, 0, $format, "";
		1220
		1221	# read remaining chunk
		1222	$_[0]->unshift_read (chunk => $len, sub {
		1223	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1224	$cb->($_[0], $ref);
		1225	} else {
		1226	$self->_error (&Errno::EBADMSG);
		1227	}
		1228	});
		1229	}
		1230
		1231	1
		1232	}
		1233	};
		1234
1075	=back	1235	=back
1076		1236
1077	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1237	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1078		1238
1079	This function (not method) lets you add your own types to C<push_read>.	1239	This function (not method) lets you add your own types to C<push_read>.
…		…
1106	Note that AnyEvent::Handle will automatically C<start_read> for you when	1266	Note that AnyEvent::Handle will automatically C<start_read> for you when
1107	you change the C<on_read> callback or push/unshift a read callback, and it	1267	you change the C<on_read> callback or push/unshift a read callback, and it
1108	will automatically C<stop_read> for you when neither C<on_read> is set nor	1268	will automatically C<stop_read> for you when neither C<on_read> is set nor
1109	there are any read requests in the queue.	1269	there are any read requests in the queue.
1110		1270
		1271	These methods will have no effect when in TLS mode (as TLS doesn't support
		1272	half-duplex connections).
		1273
1111	=cut	1274	=cut
1112		1275
1113	sub stop_read {	1276	sub stop_read {
1114	my ($self) = @_;	1277	my ($self) = @_;
1115		1278
1116	delete $self->{_rw};	1279	delete $self->{_rw} unless $self->{tls};
1117	}	1280	}
1118		1281
1119	sub start_read {	1282	sub start_read {
1120	my ($self) = @_;	1283	my ($self) = @_;
1121		1284
1122	unless ($self->{_rw} \|\| $self->{_eof}) {	1285	unless ($self->{_rw} \|\| $self->{_eof}) {
1123	Scalar::Util::weaken $self;	1286	Scalar::Util::weaken $self;
1124		1287
1125	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1288	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1126	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1289	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1127	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1290	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1128		1291
1129	if ($len > 0) {	1292	if ($len > 0) {
1130	$self->{_activity} = AnyEvent->now;	1293	$self->{_activity} = AnyEvent->now;
1131		1294
1132	$self->{filter_r}	1295	if ($self->{tls}) {
1133	? $self->{filter_r}($self, $rbuf)	1296	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1134	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1297	&_dotls ($self);
		1298	} else {
		1299	$self->_drain_rbuf unless $self->{_in_drain};
		1300	}
1135		1301
1136	} elsif (defined $len) {	1302	} elsif (defined $len) {
1137	delete $self->{_rw};	1303	delete $self->{_rw};
1138	$self->{_eof} = 1;	1304	$self->{_eof} = 1;
1139	$self->_drain_rbuf unless $self->{_in_drain};	1305	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1154	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1320	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1155	substr $self->{_tls_wbuf}, 0, $len, "";	1321	substr $self->{_tls_wbuf}, 0, $len, "";
1156	}	1322	}
1157	}	1323	}
1158		1324
1159	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1160	$self->{wbuf} .= $buf;
1161	$self->_drain_wbuf;
1162	}
1163
1164	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1325	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1165	if (length $buf) {	1326	unless (length $buf) {
1166	$self->{rbuf} .= $buf;
1167	$self->_drain_rbuf unless $self->{_in_drain};
1168	} else {
1169	# let's treat SSL-eof as we treat normal EOF	1327	# let's treat SSL-eof as we treat normal EOF
		1328	delete $self->{_rw};
1170	$self->{_eof} = 1;	1329	$self->{_eof} = 1;
1171	$self->_shutdown;	1330	&_freetls;
1172	return;
1173	}	1331	}
		1332
		1333	$self->{rbuf} .= $buf;
		1334	$self->_drain_rbuf unless $self->{_in_drain};
		1335	$self->{tls} or return; # tls session might have gone away in callback
1174	}	1336	}
1175		1337
1176	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1338	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1177		1339
1178	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1340	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
…		…
1182	return $self->_error (&Errno::EIO, 1);	1344	return $self->_error (&Errno::EIO, 1);
1183	}	1345	}
1184		1346
1185	# all others are fine for our purposes	1347	# all others are fine for our purposes
1186	}	1348	}
		1349
		1350	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1351	$self->{wbuf} .= $buf;
		1352	$self->_drain_wbuf;
		1353	}
1187	}	1354	}
1188		1355
1189	=item $handle->starttls ($tls[, $tls_ctx])	1356	=item $handle->starttls ($tls[, $tls_ctx])
1190		1357
1191	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1358	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1200		1367
1201	The TLS connection object will end up in C<< $handle->{tls} >> after this	1368	The TLS connection object will end up in C<< $handle->{tls} >> after this
1202	call and can be used or changed to your liking. Note that the handshake	1369	call and can be used or changed to your liking. Note that the handshake
1203	might have already started when this function returns.	1370	might have already started when this function returns.
1204		1371
		1372	If it an error to start a TLS handshake more than once per
		1373	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1374
1205	=cut	1375	=cut
1206		1376
1207	sub starttls {	1377	sub starttls {
1208	my ($self, $ssl, $ctx) = @_;	1378	my ($self, $ssl, $ctx) = @_;
1209		1379
1210	$self->stoptls;	1380	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
1211		1381	if $self->{tls};
		1382
1212	if ($ssl eq "accept") {	1383	if ($ssl eq "accept") {
1213	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1384	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1214	Net::SSLeay::set_accept_state ($ssl);	1385	Net::SSLeay::set_accept_state ($ssl);
1215	} elsif ($ssl eq "connect") {	1386	} elsif ($ssl eq "connect") {
1216	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1387	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1222	# basically, this is deep magic (because SSL_read should have the same issues)	1393	# basically, this is deep magic (because SSL_read should have the same issues)
1223	# but the openssl maintainers basically said: "trust us, it just works".	1394	# but the openssl maintainers basically said: "trust us, it just works".
1224	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1395	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1225	# and mismaintained ssleay-module doesn't even offer them).	1396	# and mismaintained ssleay-module doesn't even offer them).
1226	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1397	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1398	#
		1399	# in short: this is a mess.
		1400	#
		1401	# note that we do not try to keep the length constant between writes as we are required to do.
		1402	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1403	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1404	# have identity issues in that area.
1227	Net::SSLeay::CTX_set_mode ($self->{tls},	1405	Net::SSLeay::CTX_set_mode ($self->{tls},
1228	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1406	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1229	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1407	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1230		1408
1231	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1409	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1232	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1410	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1233		1411
1234	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1412	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1235		1413
1236	$self->{filter_w} = sub {	1414	&_dotls; # need to trigger the initial handshake
1237	$_[0]{_tls_wbuf} .= ${$_[1]};	1415	$self->start_read; # make sure we actually do read
1238	&_dotls;
1239	};
1240	$self->{filter_r} = sub {
1241	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1242	&_dotls;
1243	};
1244	}	1416	}
1245		1417
1246	=item $handle->stoptls	1418	=item $handle->stoptls
1247		1419
1248	Destroys the SSL connection, if any. Partial read or write data will be	1420	Shuts down the SSL connection - this makes a proper EOF handshake by
1249	lost.	1421	sending a close notify to the other side, but since OpenSSL doesn't
		1422	support non-blocking shut downs, it is not possible to re-use the stream
		1423	afterwards.
1250		1424
1251	=cut	1425	=cut
1252		1426
1253	sub stoptls {	1427	sub stoptls {
1254	my ($self) = @_;	1428	my ($self) = @_;
1255		1429
		1430	if ($self->{tls}) {
		1431	Net::SSLeay::shutdown $self->{tls};
		1432
		1433	&_dotls;
		1434
		1435	# we don't give a shit. no, we do, but we can't. no...
		1436	# we, we... have to use openssl :/
		1437	&_freetls;
		1438	}
		1439	}
		1440
		1441	sub _freetls {
		1442	my ($self) = @_;
		1443
		1444	return unless $self->{tls};
		1445
1256	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1446	Net::SSLeay::free (delete $self->{tls});
1257		1447
1258	delete $self->{_rbio};	1448	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1259	delete $self->{_wbio};
1260	delete $self->{_tls_wbuf};
1261	delete $self->{filter_r};
1262	delete $self->{filter_w};
1263	}	1449	}
1264		1450
1265	sub DESTROY {	1451	sub DESTROY {
1266	my $self = shift;	1452	my $self = shift;
1267		1453
1268	$self->stoptls;	1454	&_freetls;
1269		1455
1270	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1456	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1271		1457
1272	if ($linger && length $self->{wbuf}) {	1458	if ($linger && length $self->{wbuf}) {
1273	my $fh = delete $self->{fh};	1459	my $fh = delete $self->{fh};
…		…
1337	=over 4	1523	=over 4
1338		1524
1339	=item * all constructor arguments become object members.	1525	=item * all constructor arguments become object members.
1340		1526
1341	At least initially, when you pass a C<tls>-argument to the constructor it	1527	At least initially, when you pass a C<tls>-argument to the constructor it
1342	will end up in C<< $handle->{tls} >>. Those members might be changes or	1528	will end up in C<< $handle->{tls} >>. Those members might be changed or
1343	mutated later on (for example C<tls> will hold the TLS connection object).	1529	mutated later on (for example C<tls> will hold the TLS connection object).
1344		1530
1345	=item * other object member names are prefixed with an C<_>.	1531	=item * other object member names are prefixed with an C<_>.
1346		1532
1347	All object members not explicitly documented (internal use) are prefixed	1533	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.62 by root, Fri Jun 6 10:49:20 2008 UTC vs. Revision 1.93 by root, Wed Oct 1 14:49:23 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.62 by root, Fri Jun 6 10:49:20 2008 UTC vs.
Revision 1.93 by root, Wed Oct 1 14:49:23 2008 UTC