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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.59 by root, Thu Jun 5 16:53:11 2008 UTC vs.
Revision 1.92 by root, Wed Oct 1 08:52:06 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.13;	19	our $VERSION = 4.3;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
59	argument.	62	argument.
60		63
		64	=head2 SIGPIPE is not handled by this module
		65
		66	SIGPIPE is not handled by this module, so one of the practical
		67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
		68	'IGNORE'>). At least, this is highly recommend in a networked program: If
		69	you use AnyEvent::Handle in a filter program (like sort), exiting on
		70	SIGPIPE is probably the right thing to do.
		71
61	=head1 METHODS	72	=head1 METHODS
62		73
63	=over 4	74	=over 4
64		75
65	=item B<new (%args)>	76	=item B<new (%args)>
…		…
70		81
71	=item fh => $filehandle [MANDATORY]	82	=item fh => $filehandle [MANDATORY]
72		83
73	The filehandle this L<AnyEvent::Handle> object will operate on.	84	The filehandle this L<AnyEvent::Handle> object will operate on.
74		85
75	NOTE: The filehandle will be set to non-blocking (using	86	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		88	that mode.
77		89
78	=item on_eof => $cb->($handle)	90	=item on_eof => $cb->($handle)
79		91
80	Set the callback to be called when an end-of-file condition is detcted,	92	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	93	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	94	connection cleanly.
83		95
		96	For sockets, this just means that the other side has stopped sending data,
		97	you can still try to write data, and, in fact, one can return from the eof
		98	callback and continue writing data, as only the read part has been shut
		99	down.
		100
84	While not mandatory, it is highly recommended to set an eof callback,	101	While not mandatory, it is I<highly> recommended to set an eof callback,
85	otherwise you might end up with a closed socket while you are still	102	otherwise you might end up with a closed socket while you are still
86	waiting for data.	103	waiting for data.
		104
		105	If an EOF condition has been detected but no C<on_eof> callback has been
		106	set, then a fatal error will be raised with C<$!> set to <0>.
87		107
88	=item on_error => $cb->($handle, $fatal)	108	=item on_error => $cb->($handle, $fatal)
89		109
90	This is the error callback, which is called when, well, some error	110	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	111	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	112	connect or a read error.
93		113
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	114	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	115	fatal errors the handle object will be shut down and will not be usable
		116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		117	errors are an EOF condition with active (but unsatisifable) read watchers
		118	(C<EPIPE>) or I/O errors.
		119
96	usable. Non-fatal errors can be retried by simply returning, but it is	120	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	121	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	122	when this callback is invoked. Examples of non-fatal errors are timeouts
		123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		124
100	On callback entrance, the value of C<$!> contains the operating system	125	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		127
103	While not mandatory, it is I<highly> recommended to set this callback, as	128	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
105	C<croak>.	130	C<croak>.
106		131
107	=item on_read => $cb->($handle)	132	=item on_read => $cb->($handle)
108		133
109	This sets the default read callback, which is called when data arrives	134	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue.	135	and no read request is in the queue (unlike read queue callbacks, this
		136	callback will only be called when at least one octet of data is in the
		137	read buffer).
111		138
112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113	method or access the C<$handle->{rbuf}> member directly.	140	method or access the C<$handle->{rbuf}> member directly.
114		141
115	When an EOF condition is detected then AnyEvent::Handle will first try to	142	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
122	This sets the callback that is called when the write buffer becomes empty	149	This sets the callback that is called when the write buffer becomes empty
123	(or when the callback is set and the buffer is empty already).	150	(or when the callback is set and the buffer is empty already).
124		151
125	To append to the write buffer, use the C<< ->push_write >> method.	152	To append to the write buffer, use the C<< ->push_write >> method.
126		153
		154	This callback is useful when you don't want to put all of your write data
		155	into the queue at once, for example, when you want to write the contents
		156	of some file to the socket you might not want to read the whole file into
		157	memory and push it into the queue, but instead only read more data from
		158	the file when the write queue becomes empty.
		159
127	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
128		161
129	If non-zero, then this enables an "inactivity" timeout: whenever this many	162	If non-zero, then this enables an "inactivity" timeout: whenever this many
130	seconds pass without a successful read or write on the underlying file	163	seconds pass without a successful read or write on the underlying file
131	handle, the C<on_timeout> callback will be invoked (and if that one is	164	handle, the C<on_timeout> callback will be invoked (and if that one is
132	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
133		166
134	Note that timeout processing is also active when you currently do not have	167	Note that timeout processing is also active when you currently do not have
135	any outstanding read or write requests: If you plan to keep the connection	168	any outstanding read or write requests: If you plan to keep the connection
136	idle then you should disable the timout temporarily or ignore the timeout	169	idle then you should disable the timout temporarily or ignore the timeout
137	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
138		172
139	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
140		174
141	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
142		176
…		…
146		180
147	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
148		182
149	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	183	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
150	when the read buffer ever (strictly) exceeds this size. This is useful to	184	when the read buffer ever (strictly) exceeds this size. This is useful to
151	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
152		186
153	For example, a server accepting connections from untrusted sources should	187	For example, a server accepting connections from untrusted sources should
154	be configured to accept only so-and-so much data that it cannot act on	188	be configured to accept only so-and-so much data that it cannot act on
155	(for example, when expecting a line, an attacker could send an unlimited	189	(for example, when expecting a line, an attacker could send an unlimited
156	amount of data without a callback ever being called as long as the line	190	amount of data without a callback ever being called as long as the line
157	isn't finished).	191	isn't finished).
158		192
		193	=item autocork => <boolean>
		194
		195	When disabled (the default), then C<push_write> will try to immediately
		196	write the data to the handle, if possible. This avoids having to register
		197	a write watcher and wait for the next event loop iteration, but can
		198	be inefficient if you write multiple small chunks (on the wire, this
		199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
		201
		202	When enabled, then writes will always be queued till the next event loop
		203	iteration. This is efficient when you do many small writes per iteration,
		204	but less efficient when you do a single write only per iteration (or when
		205	the write buffer often is full). It also increases write latency.
		206
		207	=item no_delay => <boolean>
		208
		209	When doing small writes on sockets, your operating system kernel might
		210	wait a bit for more data before actually sending it out. This is called
		211	the Nagle algorithm, and usually it is beneficial.
		212
		213	In some situations you want as low a delay as possible, which can be
		214	accomplishd by setting this option to a true value.
		215
		216	The default is your opertaing system's default behaviour (most likely
		217	enabled), this option explicitly enables or disables it, if possible.
		218
159	=item read_size => <bytes>	219	=item read_size => <bytes>
160		220
161	The default read block size (the amount of bytes this module will try to read	221	The default read block size (the amount of bytes this module will
162	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
163		224
164	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
165		226
166	Sets the amount of bytes (default: C<0>) that make up an "empty" write	227	Sets the amount of bytes (default: C<0>) that make up an "empty" write
167	buffer: If the write reaches this size or gets even samller it is	228	buffer: If the write reaches this size or gets even samller it is
168	considered empty.	229	considered empty.
169		230
		231	Sometimes it can be beneficial (for performance reasons) to add data to
		232	the write buffer before it is fully drained, but this is a rare case, as
		233	the operating system kernel usually buffers data as well, so the default
		234	is good in almost all cases.
		235
		236	=item linger => <seconds>
		237
		238	If non-zero (default: C<3600>), then the destructor of the
		239	AnyEvent::Handle object will check whether there is still outstanding
		240	write data and will install a watcher that will write this data to the
		241	socket. No errors will be reported (this mostly matches how the operating
		242	system treats outstanding data at socket close time).
		243
		244	This will not work for partial TLS data that could not be encoded
		245	yet. This data will be lost.
		246
170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
171		248
172	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
173	will start making tls handshake and will transparently encrypt/decrypt	250	AnyEvent will start a TLS handshake as soon as the conenction has been
174	data.	251	established and will transparently encrypt/decrypt data afterwards.
175		252
176	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
177	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.
178		257
179	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
180	connection, use C<connect> mode.	259	C<accept>, and for the TLS client side of a connection, use C<connect>
		260	mode.
181		261
182	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
183	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>
184	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
185	AnyEvent::Handle.	265	AnyEvent::Handle.
186		266
187	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.
188		268
189	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
190		270
191	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
192	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
194		274
195	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
196		276
197	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.
198		278
199	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
200	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.
201		282
202	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
203	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
204		285
205	=item filter_r => $cb	286	=item filter_r => $cb
206		287
207	=item filter_w => $cb	288	=item filter_w => $cb
208		289
209	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).
210		292
211	=back	293	=back
212		294
213	=cut	295	=cut
214		296
…		…
227	}	309	}
228		310
229	$self->{_activity} = AnyEvent->now;	311	$self->{_activity} = AnyEvent->now;
230	$self->_timeout;	312	$self->_timeout;
231		313
232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
233	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		316
		317	$self->start_read
		318	if $self->{on_read};
234		319
235	$self	320	$self
236	}	321	}
237		322
238	sub _shutdown {	323	sub _shutdown {
…		…
241	delete $self->{_tw};	326	delete $self->{_tw};
242	delete $self->{_rw};	327	delete $self->{_rw};
243	delete $self->{_ww};	328	delete $self->{_ww};
244	delete $self->{fh};	329	delete $self->{fh};
245		330
246	$self->stoptls;	331	&_freetls;
		332
		333	delete $self->{on_read};
		334	delete $self->{_queue};
247	}	335	}
248		336
249	sub _error {	337	sub _error {
250	my ($self, $errno, $fatal) = @_;	338	my ($self, $errno, $fatal) = @_;
251		339
…		…
261	}	349	}
262	}	350	}
263		351
264	=item $fh = $handle->fh	352	=item $fh = $handle->fh
265		353
266	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.
267		355
268	=cut	356	=cut
269		357
270	sub fh { $_[0]{fh} }	358	sub fh { $_[0]{fh} }
271		359
…		…
289	$_[0]{on_eof} = $_[1];	377	$_[0]{on_eof} = $_[1];
290	}	378	}
291		379
292	=item $handle->on_timeout ($cb)	380	=item $handle->on_timeout ($cb)
293		381
294	Replace the current C<on_timeout> callback, or disables the callback	382	Replace the current C<on_timeout> callback, or disables the callback (but
295	(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
296	argument.	384	argument and method.
297		385
298	=cut	386	=cut
299		387
300	sub on_timeout {	388	sub on_timeout {
301	$_[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	};
302	}	413	}
303		414
304	#############################################################################	415	#############################################################################
305		416
306	=item $handle->timeout ($seconds)	417	=item $handle->timeout ($seconds)
…		…
421	$self->_error ($!, 1);	532	$self->_error ($!, 1);
422	}	533	}
423	};	534	};
424		535
425	# try to write data immediately	536	# try to write data immediately
426	$cb->();	537	$cb->() unless $self->{autocork};
427		538
428	# if still data left in wbuf, we need to poll	539	# if still data left in wbuf, we need to poll
429	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	540	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
430	if length $self->{wbuf};	541	if length $self->{wbuf};
431	};	542	};
…		…
476	my ($self, $string) = @_;	587	my ($self, $string) = @_;
477		588
478	sprintf "%d:%s,", (length $string), $string	589	sprintf "%d:%s,", (length $string), $string
479	};	590	};
480		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
		605	};
		606
481	=item json => $array_or_hashref	607	=item json => $array_or_hashref
482		608
483	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
484	provide your own JSON object, this means it will be encoded to JSON text	610	provide your own JSON object, this means it will be encoded to JSON text
485	in UTF-8.	611	in UTF-8.
…		…
517		643
518	$self->{json} ? $self->{json}->encode ($ref)	644	$self->{json} ? $self->{json}->encode ($ref)
519	: JSON::encode_json ($ref)	645	: JSON::encode_json ($ref)
520	};	646	};
521		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
522	=back	663	=back
523		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>.
…		…
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
…		…
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,
…		…
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];
…		…
622		768
623	if (	769	if (
624	defined $self->{rbuf_max}	770	defined $self->{rbuf_max}
625	&& $self->{rbuf_max} < length $self->{rbuf}	771	&& $self->{rbuf_max} < length $self->{rbuf}
626	) {	772	) {
627	return $self->_error (&Errno::ENOSPC, 1);	773	$self->_error (&Errno::ENOSPC, 1), return;
628	}	774	}
629		775
630	while () {	776	while () {
631	no strict 'refs';
632
633	my $len = length $self->{rbuf};	777	my $len = length $self->{rbuf};
634		778
635	if (my $cb = shift @{ $self->{_queue} }) {	779	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	780	unless ($cb->($self)) {
637	if ($self->{_eof}) {	781	if ($self->{_eof}) {
638	# 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)
639	return $self->_error (&Errno::EPIPE, 1);	783	$self->_error (&Errno::EPIPE, 1), return;
640	}	784	}
641		785
642	unshift @{ $self->{_queue} }, $cb;	786	unshift @{ $self->{_queue} }, $cb;
643	last;	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	$len == length $self->{rbuf} # if no data has been consumed	795	$len == length $self->{rbuf} # if no data has been consumed
650	&& !@{ $self->{_queue} } # and the queue is still empty	796	&& !@{ $self->{_queue} } # and the queue is still empty
651	&& $self->{on_read} # but we still have on_read	797	&& $self->{on_read} # but we still have on_read
652	) {	798	) {
653	# no further data will arrive	799	# no further data will arrive
654	# so no progress can be made	800	# so no progress can be made
655	return $self->_error (&Errno::EPIPE, 1)	801	$self->_error (&Errno::EPIPE, 1), return
656	if $self->{_eof};	802	if $self->{_eof};
657		803
658	last; # more data might arrive	804	last; # more data might arrive
659	}	805	}
660	} else {	806	} else {
…		…
662	delete $self->{_rw};	808	delete $self->{_rw};
663	last;	809	last;
664	}	810	}
665	}	811	}
666		812
		813	if ($self->{_eof}) {
		814	if ($self->{on_eof}) {
667	$self->{on_eof}($self)	815	$self->{on_eof}($self)
668	if $self->{_eof} && $self->{on_eof};	816	} else {
		817	$self->_error (0, 1);
		818	}
		819	}
669		820
670	# may need to restart read watcher	821	# may need to restart read watcher
671	unless ($self->{_rw}) {	822	unless ($self->{_rw}) {
672	$self->start_read	823	$self->start_read
673	if $self->{on_read} \|\| @{ $self->{_queue} };	824	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
799	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	950	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
800	1	951	1
801	}	952	}
802	};	953	};
803		954
804	# compatibility with older API
805	sub push_read_chunk {
806	$_[0]->push_read (chunk => $_[1], $_[2]);
807	}
808
809	sub unshift_read_chunk {
810	$_[0]->unshift_read (chunk => $_[1], $_[2]);
811	}
812
813	=item line => [$eol, ]$cb->($handle, $line, $eol)	955	=item line => [$eol, ]$cb->($handle, $line, $eol)
814		956
815	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
816	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
817	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
…		…
832	=cut	974	=cut
833		975
834	register_read_type line => sub {	976	register_read_type line => sub {
835	my ($self, $cb, $eol) = @_;	977	my ($self, $cb, $eol) = @_;
836		978
837	$eol = qr\|(\015?\012)\| if @_ < 3;	979	if (@_ < 3) {
838	$eol = quotemeta $eol unless ref $eol;	980	# this is more than twice as fast as the generic code below
839	$eol = qr\|^(.*?)($eol)\|s;
840
841	sub {	981	sub {
842	$_[0]{rbuf} =~ s/$eol// or return;	982	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
843		983
844	$cb->($_[0], $1, $2);	984	$cb->($_[0], $1, $2);
845	1
846	}
847	};
848
849	# compatibility with older API
850	sub push_read_line {
851	my $self = shift;
852	$self->push_read (line => @_);
853	}
854
855	sub unshift_read_line {
856	my $self = shift;
857	$self->unshift_read (line => @_);
858	}
859
860	=item netstring => $cb->($handle, $string)
861
862	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
863
864	Throws an error with C<$!> set to EBADMSG on format violations.
865
866	=cut
867
868	register_read_type netstring => sub {
869	my ($self, $cb) = @_;
870
871	sub {
872	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
873	if ($_[0]{rbuf} =~ /[^0-9]/) {
874	$self->_error (&Errno::EBADMSG);
875	}	985	1
876	return;
877	}	986	}
		987	} else {
		988	$eol = quotemeta $eol unless ref $eol;
		989	$eol = qr\|^(.*?)($eol)\|s;
878		990
879	my $len = $1;	991	sub {
		992	$_[0]{rbuf} =~ s/$eol// or return;
880		993
881	$self->unshift_read (chunk => $len, sub {	994	$cb->($_[0], $1, $2);
882	my $string = $_[1];
883	$_[0]->unshift_read (chunk => 1, sub {
884	if ($_[1] eq ",") {
885	$cb->($_[0], $string);
886	} else {
887	$self->_error (&Errno::EBADMSG);
888	}
889	});	995	1
890	});	996	}
891
892	1
893	}	997	}
894	};	998	};
895		999
896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1000	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
897		1001
…		…
961		1065
962	()	1066	()
963	}	1067	}
964	};	1068	};
965		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
966	=item json => $cb->($handle, $hash_or_arrayref)	1151	=item json => $cb->($handle, $hash_or_arrayref)
967		1152
968	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.
969		1154
970	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
…		…
980	the C<json> write type description, above, for an actual example.	1165	the C<json> write type description, above, for an actual example.
981		1166
982	=cut	1167	=cut
983		1168
984	register_read_type json => sub {	1169	register_read_type json => sub {
985	my ($self, $cb, $accept, $reject, $skip) = @_;	1170	my ($self, $cb) = @_;
986		1171
987	require JSON;	1172	require JSON;
988		1173
989	my $data;	1174	my $data;
990	my $rbuf = \$self->{rbuf};	1175	my $rbuf = \$self->{rbuf};
…		…
1005	()	1190	()
1006	}	1191	}
1007	}	1192	}
1008	};	1193	};
1009		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
1010	=back	1240	=back
1011		1241
1012	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1242	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1013		1243
1014	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>.
…		…
1089	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) {
1090	substr $self->{_tls_wbuf}, 0, $len, "";	1320	substr $self->{_tls_wbuf}, 0, $len, "";
1091	}	1321	}
1092	}	1322	}
1093		1323
1094	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1095	$self->{wbuf} .= $buf;
1096	$self->_drain_wbuf;
1097	}
1098
1099	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1100	if (length $buf) {	1325	unless (length $buf) {
1101	$self->{rbuf} .= $buf;
1102	$self->_drain_rbuf unless $self->{_in_drain};
1103	} else {
1104	# let's treat SSL-eof as we treat normal EOF	1326	# let's treat SSL-eof as we treat normal EOF
		1327	delete $self->{_rw};
1105	$self->{_eof} = 1;	1328	$self->{_eof} = 1;
1106	$self->_shutdown;	1329	&_freetls;
1107	return;
1108	}	1330	}
		1331
		1332	$self->{rbuf} .= $buf;
		1333	$self->_drain_rbuf unless $self->{_in_drain};
		1334	$self->{tls} or return; # tls session might have gone away in callback
1109	}	1335	}
1110		1336
1111	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1112		1338
1113	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
…		…
1117	return $self->_error (&Errno::EIO, 1);	1343	return $self->_error (&Errno::EIO, 1);
1118	}	1344	}
1119		1345
1120	# all others are fine for our purposes	1346	# all others are fine for our purposes
1121	}	1347	}
		1348
		1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1350	$self->{wbuf} .= $buf;
		1351	$self->_drain_wbuf;
		1352	}
1122	}	1353	}
1123		1354
1124	=item $handle->starttls ($tls[, $tls_ctx])	1355	=item $handle->starttls ($tls[, $tls_ctx])
1125		1356
1126	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1135		1366
1136	The TLS connection object will end up in C<< $handle->{tls} >> after this	1367	The TLS connection object will end up in C<< $handle->{tls} >> after this
1137	call and can be used or changed to your liking. Note that the handshake	1368	call and can be used or changed to your liking. Note that the handshake
1138	might have already started when this function returns.	1369	might have already started when this function returns.
1139		1370
		1371	If it an error to start a TLS handshake more than once per
		1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1373
1140	=cut	1374	=cut
1141		1375
1142	sub starttls {	1376	sub starttls {
1143	my ($self, $ssl, $ctx) = @_;	1377	my ($self, $ssl, $ctx) = @_;
1144		1378
1145	$self->stoptls;	1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
1146		1380	if $self->{tls};
		1381
1147	if ($ssl eq "accept") {	1382	if ($ssl eq "accept") {
1148	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1149	Net::SSLeay::set_accept_state ($ssl);	1384	Net::SSLeay::set_accept_state ($ssl);
1150	} elsif ($ssl eq "connect") {	1385	} elsif ($ssl eq "connect") {
1151	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1386	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1157	# basically, this is deep magic (because SSL_read should have the same issues)	1392	# basically, this is deep magic (because SSL_read should have the same issues)
1158	# but the openssl maintainers basically said: "trust us, it just works".	1393	# but the openssl maintainers basically said: "trust us, it just works".
1159	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1160	# and mismaintained ssleay-module doesn't even offer them).	1395	# and mismaintained ssleay-module doesn't even offer them).
1161	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1397	#
		1398	# in short: this is a mess.
		1399	#
		1400	# note that we do not try to kepe the length constant between writes as we are required to do.
		1401	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1402	# and we drive openssl fully in blocking mode here.
1162	Net::SSLeay::CTX_set_mode ($self->{tls},	1403	Net::SSLeay::CTX_set_mode ($self->{tls},
1163	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1164	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1405	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1165		1406
1166	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
…		…
1174	};	1415	};
1175	$self->{filter_r} = sub {	1416	$self->{filter_r} = sub {
1176	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});	1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1177	&_dotls;	1418	&_dotls;
1178	};	1419	};
		1420
		1421	&_dotls; # need to trigger the initial negotiation exchange
1179	}	1422	}
1180		1423
1181	=item $handle->stoptls	1424	=item $handle->stoptls
1182		1425
1183	Destroys the SSL connection, if any. Partial read or write data will be	1426	Shuts down the SSL connection - this makes a proper EOF handshake by
1184	lost.	1427	sending a close notify to the other side, but since OpenSSL doesn't
		1428	support non-blocking shut downs, it is not possible to re-use the stream
		1429	afterwards.
1185		1430
1186	=cut	1431	=cut
1187		1432
1188	sub stoptls {	1433	sub stoptls {
1189	my ($self) = @_;	1434	my ($self) = @_;
1190		1435
		1436	if ($self->{tls}) {
		1437	Net::SSLeay::shutdown $self->{tls};
		1438
		1439	&_dotls;
		1440
		1441	# we don't give a shit. no, we do, but we can't. no...
		1442	# we, we... have to use openssl :/
		1443	&_freetls;
		1444	}
		1445	}
		1446
		1447	sub _freetls {
		1448	my ($self) = @_;
		1449
		1450	return unless $self->{tls};
		1451
1191	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1452	Net::SSLeay::free (delete $self->{tls});
1192		1453
1193	delete $self->{_rbio};	1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};
1194	delete $self->{_wbio};
1195	delete $self->{_tls_wbuf};
1196	delete $self->{filter_r};
1197	delete $self->{filter_w};
1198	}	1455	}
1199		1456
1200	sub DESTROY {	1457	sub DESTROY {
1201	my $self = shift;	1458	my $self = shift;
1202		1459
1203	$self->stoptls;	1460	&_freetls;
		1461
		1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1463
		1464	if ($linger && length $self->{wbuf}) {
		1465	my $fh = delete $self->{fh};
		1466	my $wbuf = delete $self->{wbuf};
		1467
		1468	my @linger;
		1469
		1470	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1471	my $len = syswrite $fh, $wbuf, length $wbuf;
		1472
		1473	if ($len > 0) {
		1474	substr $wbuf, 0, $len, "";
		1475	} else {
		1476	@linger = (); # end
		1477	}
		1478	});
		1479	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1480	@linger = ();
		1481	});
		1482	}
1204	}	1483	}
1205		1484
1206	=item AnyEvent::Handle::TLS_CTX	1485	=item AnyEvent::Handle::TLS_CTX
1207		1486
1208	This function creates and returns the Net::SSLeay::CTX object used by	1487	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1250	=over 4	1529	=over 4
1251		1530
1252	=item * all constructor arguments become object members.	1531	=item * all constructor arguments become object members.
1253		1532
1254	At least initially, when you pass a C<tls>-argument to the constructor it	1533	At least initially, when you pass a C<tls>-argument to the constructor it
1255	will end up in C<< $handle->{tls} >>. Those members might be changes or	1534	will end up in C<< $handle->{tls} >>. Those members might be changed or
1256	mutated later on (for example C<tls> will hold the TLS connection object).	1535	mutated later on (for example C<tls> will hold the TLS connection object).
1257		1536
1258	=item * other object member names are prefixed with an C<_>.	1537	=item * other object member names are prefixed with an C<_>.
1259		1538
1260	All object members not explicitly documented (internal use) are prefixed	1539	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.59 by root, Thu Jun 5 16:53:11 2008 UTC vs. Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.59 by root, Thu Jun 5 16:53:11 2008 UTC vs.
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC