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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.86 by root, Thu Aug 21 20:41:16 2008 UTC vs.
Revision 1.118 by root, Thu Feb 12 17:33:38 2009 UTC

…		…
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.232;	19	our $VERSION = 4.34;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
84	Set the callback to be called when an end-of-file condition is detected,	84	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	86	connection cleanly.
87		87
88	For sockets, this just means that the other side has stopped sending data,	88	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the eof	89	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	90	callback and continue writing data, as only the read part has been shut
91	down.	91	down.
92		92
93	While not mandatory, it is I<highly> recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
95	waiting for data.	95	waiting for data.
96		96
97	If an EOF condition has been detected but no C<on_eof> callback has been	97	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	98	set, then a fatal error will be raised with C<$!> set to <0>.
…		…
103	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	104	connect or a read error.
105		105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable	107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C< ->rbuf >). Examples of fatal	108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers	109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.	110	(C<EPIPE>) or I/O errors.
111		111
112	Non-fatal errors can be retried by simply returning, but it is recommended	112	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	113	to simply ignore this parameter and instead abondon the handle object
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the	128	callback will only be called when at least one octet of data is in the
129	read buffer).	129	read buffer).
130		130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly. Note that you
		133	must not enlarge or modify the read buffer, you can only remove data at
		134	the beginning from it.
133		135
134	When an EOF condition is detected then AnyEvent::Handle will first try to	136	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before	137	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal	138	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).	139	error will be raised (with C<$!> set to C<EPIPE>).
…		…
152	=item timeout => $fractional_seconds	154	=item timeout => $fractional_seconds
153		155
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	156	If non-zero, then this enables an "inactivity" timeout: whenever this many
155	seconds pass without a successful read or write on the underlying file	157	seconds pass without a successful read or write on the underlying file
156	handle, the C<on_timeout> callback will be invoked (and if that one is	158	handle, the C<on_timeout> callback will be invoked (and if that one is
157	missing, an C<ETIMEDOUT> error will be raised).	159	missing, a non-fatal C<ETIMEDOUT> error will be raised).
158		160
159	Note that timeout processing is also active when you currently do not have	161	Note that timeout processing is also active when you currently do not have
160	any outstanding read or write requests: If you plan to keep the connection	162	any outstanding read or write requests: If you plan to keep the connection
161	idle then you should disable the timout temporarily or ignore the timeout	163	idle then you should disable the timout temporarily or ignore the timeout
162	in the C<on_timeout> callback.	164	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		165	restart the timeout.
163		166
164	Zero (the default) disables this timeout.	167	Zero (the default) disables this timeout.
165		168
166	=item on_timeout => $cb->($handle)	169	=item on_timeout => $cb->($handle)
167		170
…		…
171		174
172	=item rbuf_max => <bytes>	175	=item rbuf_max => <bytes>
173		176
174	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	177	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
175	when the read buffer ever (strictly) exceeds this size. This is useful to	178	when the read buffer ever (strictly) exceeds this size. This is useful to
176	avoid denial-of-service attacks.	179	avoid some forms of denial-of-service attacks.
177		180
178	For example, a server accepting connections from untrusted sources should	181	For example, a server accepting connections from untrusted sources should
179	be configured to accept only so-and-so much data that it cannot act on	182	be configured to accept only so-and-so much data that it cannot act on
180	(for example, when expecting a line, an attacker could send an unlimited	183	(for example, when expecting a line, an attacker could send an unlimited
181	amount of data without a callback ever being called as long as the line	184	amount of data without a callback ever being called as long as the line
182	isn't finished).	185	isn't finished).
183		186
184	=item autocork => <boolean>	187	=item autocork => <boolean>
185		188
186	When disabled (the default), then C<push_write> will try to immediately	189	When disabled (the default), then C<push_write> will try to immediately
187	write the data to the handle if possible. This avoids having to register	190	write the data to the handle, if possible. This avoids having to register
188	a write watcher and wait for the next event loop iteration, but can be	191	a write watcher and wait for the next event loop iteration, but can
189	inefficient if you write multiple small chunks (this disadvantage is	192	be inefficient if you write multiple small chunks (on the wire, this
190	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	193	disadvantage is usually avoided by your kernel's nagle algorithm, see
		194	C<no_delay>, but this option can save costly syscalls).
191		195
192	When enabled, then writes will always be queued till the next event loop	196	When enabled, then writes will always be queued till the next event loop
193	iteration. This is efficient when you do many small writes per iteration,	197	iteration. This is efficient when you do many small writes per iteration,
194	but less efficient when you do a single write only.	198	but less efficient when you do a single write only per iteration (or when
		199	the write buffer often is full). It also increases write latency.
195		200
196	=item no_delay => <boolean>	201	=item no_delay => <boolean>
197		202
198	When doing small writes on sockets, your operating system kernel might	203	When doing small writes on sockets, your operating system kernel might
199	wait a bit for more data before actually sending it out. This is called	204	wait a bit for more data before actually sending it out. This is called
200	the Nagle algorithm, and usually it is beneficial.	205	the Nagle algorithm, and usually it is beneficial.
201		206
202	In some situations you want as low a delay as possible, which cna be	207	In some situations you want as low a delay as possible, which can be
203	accomplishd by setting this option to true.	208	accomplishd by setting this option to a true value.
204		209
205	The default is your opertaing system's default behaviour, this option	210	The default is your opertaing system's default behaviour (most likely
206	explicitly enables or disables it, if possible.	211	enabled), this option explicitly enables or disables it, if possible.
207		212
208	=item read_size => <bytes>	213	=item read_size => <bytes>
209		214
210	The default read block size (the amount of bytes this module will try to read	215	The default read block size (the amount of bytes this module will
211	during each (loop iteration). Default: C<8192>.	216	try to read during each loop iteration, which affects memory
		217	requirements). Default: C<8192>.
212		218
213	=item low_water_mark => <bytes>	219	=item low_water_mark => <bytes>
214		220
215	Sets the amount of bytes (default: C<0>) that make up an "empty" write	221	Sets the amount of bytes (default: C<0>) that make up an "empty" write
216	buffer: If the write reaches this size or gets even samller it is	222	buffer: If the write reaches this size or gets even samller it is
217	considered empty.	223	considered empty.
218		224
		225	Sometimes it can be beneficial (for performance reasons) to add data to
		226	the write buffer before it is fully drained, but this is a rare case, as
		227	the operating system kernel usually buffers data as well, so the default
		228	is good in almost all cases.
		229
219	=item linger => <seconds>	230	=item linger => <seconds>
220		231
221	If non-zero (default: C<3600>), then the destructor of the	232	If non-zero (default: C<3600>), then the destructor of the
222	AnyEvent::Handle object will check wether there is still outstanding write	233	AnyEvent::Handle object will check whether there is still outstanding
223	data and will install a watcher that will write out this data. No errors	234	write data and will install a watcher that will write this data to the
224	will be reported (this mostly matches how the operating system treats	235	socket. No errors will be reported (this mostly matches how the operating
225	outstanding data at socket close time).	236	system treats outstanding data at socket close time).
226		237
227	This will not work for partial TLS data that could not yet been	238	This will not work for partial TLS data that could not be encoded
228	encoded. This data will be lost.	239	yet. This data will be lost. Calling the C<stoptls> method in time might
		240	help.
229		241
230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
231		243
232	When this parameter is given, it enables TLS (SSL) mode, that means	244	When this parameter is given, it enables TLS (SSL) mode, that means
233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt	245	AnyEvent will start a TLS handshake as soon as the conenction has been
234	data.	246	established and will transparently encrypt/decrypt data afterwards.
235		247
236	TLS mode requires Net::SSLeay to be installed (it will be loaded	248	TLS mode requires Net::SSLeay to be installed (it will be loaded
237	automatically when you try to create a TLS handle).	249	automatically when you try to create a TLS handle): this module doesn't
		250	have a dependency on that module, so if your module requires it, you have
		251	to add the dependency yourself.
238		252
239	Unlike TCP, TLS has a server and client side: for the TLS server side, use	253	Unlike TCP, TLS has a server and client side: for the TLS server side, use
240	C<accept>, and for the TLS client side of a connection, use C<connect>	254	C<accept>, and for the TLS client side of a connection, use C<connect>
241	mode.	255	mode.
242		256
243	You can also provide your own TLS connection object, but you have	257	You can also provide your own TLS connection object, but you have
244	to make sure that you call either C<Net::SSLeay::set_connect_state>	258	to make sure that you call either C<Net::SSLeay::set_connect_state>
245	or C<Net::SSLeay::set_accept_state> on it before you pass it to	259	or C<Net::SSLeay::set_accept_state> on it before you pass it to
246	AnyEvent::Handle.	260	AnyEvent::Handle.
247		261
		262	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		263	passing in the wrong integer will lead to certain crash. This most often
		264	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		265	segmentation fault.
		266
248	See the C<starttls> method for when need to start TLS negotiation later.	267	See the C<< ->starttls >> method for when need to start TLS negotiation later.
249		268
250	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
251		270
252	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
253	(unless a connection object was specified directly). If this parameter is	272	(unless a connection object was specified directly). If this parameter is
254	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
255		274
256	=item json => JSON or JSON::XS object	275	=item json => JSON or JSON::XS object
257		276
…		…
262	texts.	281	texts.
263		282
264	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
265	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
266		285
267	=item filter_r => $cb
268
269	=item filter_w => $cb
270
271	These exist, but are undocumented at this time.
272
273	=back	286	=back
274		287
275	=cut	288	=cut
276		289
277	sub new {	290	sub new {
…		…
281		294
282	$self->{fh} or Carp::croak "mandatory argument fh is missing";	295	$self->{fh} or Carp::croak "mandatory argument fh is missing";
283		296
284	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
285		298
286	if ($self->{tls}) {
287	require Net::SSLeay;
288	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
289	}	300	if $self->{tls};
290		301
291	$self->{_activity} = AnyEvent->now;	302	$self->{_activity} = AnyEvent->now;
292	$self->_timeout;	303	$self->_timeout;
293		304
294	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
306	delete $self->{_tw};	317	delete $self->{_tw};
307	delete $self->{_rw};	318	delete $self->{_rw};
308	delete $self->{_ww};	319	delete $self->{_ww};
309	delete $self->{fh};	320	delete $self->{fh};
310		321
311	$self->stoptls;	322	&_freetls;
312		323
313	delete $self->{on_read};	324	delete $self->{on_read};
314	delete $self->{_queue};	325	delete $self->{_queue};
315	}	326	}
316		327
…		…
322		333
323	$! = $errno;	334	$! = $errno;
324		335
325	if ($self->{on_error}) {	336	if ($self->{on_error}) {
326	$self->{on_error}($self, $fatal);	337	$self->{on_error}($self, $fatal);
327	} else {	338	} elsif ($self->{fh}) {
328	Carp::croak "AnyEvent::Handle uncaught error: $!";	339	Carp::croak "AnyEvent::Handle uncaught error: $!";
329	}	340	}
330	}	341	}
331		342
332	=item $fh = $handle->fh	343	=item $fh = $handle->fh
333		344
334	This method returns the file handle of the L<AnyEvent::Handle> object.	345	This method returns the file handle used to create the L<AnyEvent::Handle> object.
335		346
336	=cut	347	=cut
337		348
338	sub fh { $_[0]{fh} }	349	sub fh { $_[0]{fh} }
339		350
…		…
357	$_[0]{on_eof} = $_[1];	368	$_[0]{on_eof} = $_[1];
358	}	369	}
359		370
360	=item $handle->on_timeout ($cb)	371	=item $handle->on_timeout ($cb)
361		372
362	Replace the current C<on_timeout> callback, or disables the callback	373	Replace the current C<on_timeout> callback, or disables the callback (but
363	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	374	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
364	argument.	375	argument and method.
365		376
366	=cut	377	=cut
367		378
368	sub on_timeout {	379	sub on_timeout {
369	$_[0]{on_timeout} = $_[1];	380	$_[0]{on_timeout} = $_[1];
370	}	381	}
371		382
372	=item $handle->autocork ($boolean)	383	=item $handle->autocork ($boolean)
373		384
374	Enables or disables the current autocork behaviour (see C<autocork>	385	Enables or disables the current autocork behaviour (see C<autocork>
375	constructor argument).	386	constructor argument). Changes will only take effect on the next write.
376		387
377	=cut	388	=cut
		389
		390	sub autocork {
		391	$_[0]{autocork} = $_[1];
		392	}
378		393
379	=item $handle->no_delay ($boolean)	394	=item $handle->no_delay ($boolean)
380		395
381	Enables or disables the C<no_delay> setting (see constructor argument of	396	Enables or disables the C<no_delay> setting (see constructor argument of
382	the same name for details).	397	the same name for details).
…		…
475	my ($self, $cb) = @_;	490	my ($self, $cb) = @_;
476		491
477	$self->{on_drain} = $cb;	492	$self->{on_drain} = $cb;
478		493
479	$cb->($self)	494	$cb->($self)
480	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	495	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
481	}	496	}
482		497
483	=item $handle->push_write ($data)	498	=item $handle->push_write ($data)
484		499
485	Queues the given scalar to be written. You can push as much data as you	500	Queues the given scalar to be written. You can push as much data as you
…		…
502	substr $self->{wbuf}, 0, $len, "";	517	substr $self->{wbuf}, 0, $len, "";
503		518
504	$self->{_activity} = AnyEvent->now;	519	$self->{_activity} = AnyEvent->now;
505		520
506	$self->{on_drain}($self)	521	$self->{on_drain}($self)
507	if $self->{low_water_mark} >= length $self->{wbuf}	522	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
508	&& $self->{on_drain};	523	&& $self->{on_drain};
509		524
510	delete $self->{_ww} unless length $self->{wbuf};	525	delete $self->{_ww} unless length $self->{wbuf};
511	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	526	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
512	$self->_error ($!, 1);	527	$self->_error ($!, 1);
…		…
536		551
537	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	552	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
538	->($self, @_);	553	->($self, @_);
539	}	554	}
540		555
541	if ($self->{filter_w}) {	556	if ($self->{tls}) {
542	$self->{filter_w}($self, \$_[0]);	557	$self->{_tls_wbuf} .= $_[0];
		558
		559	&_dotls ($self);
543	} else {	560	} else {
544	$self->{wbuf} .= $_[0];	561	$self->{wbuf} .= $_[0];
545	$self->_drain_wbuf;	562	$self->_drain_wbuf;
546	}	563	}
547	}	564	}
…		…
564	=cut	581	=cut
565		582
566	register_write_type netstring => sub {	583	register_write_type netstring => sub {
567	my ($self, $string) = @_;	584	my ($self, $string) = @_;
568		585
569	sprintf "%d:%s,", (length $string), $string	586	(length $string) . ":$string,"
570	};	587	};
571		588
572	=item packstring => $format, $data	589	=item packstring => $format, $data
573		590
574	An octet string prefixed with an encoded length. The encoding C<$format>	591	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
752	) {	769	) {
753	$self->_error (&Errno::ENOSPC, 1), return;	770	$self->_error (&Errno::ENOSPC, 1), return;
754	}	771	}
755		772
756	while () {	773	while () {
		774	# we need to use a separate tls read buffer, as we must not receive data while
		775	# we are draining the buffer, and this can only happen with TLS.
		776	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		777
757	my $len = length $self->{rbuf};	778	my $len = length $self->{rbuf};
758		779
759	if (my $cb = shift @{ $self->{_queue} }) {	780	if (my $cb = shift @{ $self->{_queue} }) {
760	unless ($cb->($self)) {	781	unless ($cb->($self)) {
761	if ($self->{_eof}) {	782	if ($self->{_eof}) {
…		…
783		804
784	last; # more data might arrive	805	last; # more data might arrive
785	}	806	}
786	} else {	807	} else {
787	# read side becomes idle	808	# read side becomes idle
788	delete $self->{_rw};	809	delete $self->{_rw} unless $self->{tls};
789	last;	810	last;
790	}	811	}
791	}	812	}
792		813
793	if ($self->{_eof}) {	814	if ($self->{_eof}) {
…		…
822		843
823	=item $handle->rbuf	844	=item $handle->rbuf
824		845
825	Returns the read buffer (as a modifiable lvalue).	846	Returns the read buffer (as a modifiable lvalue).
826		847
827	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	848	You can access the read buffer directly as the C<< ->{rbuf} >>
828	you want.	849	member, if you want. However, the only operation allowed on the
		850	read buffer (apart from looking at it) is removing data from its
		851	beginning. Otherwise modifying or appending to it is not allowed and will
		852	lead to hard-to-track-down bugs.
829		853
830	NOTE: The read buffer should only be used or modified if the C<on_read>,	854	NOTE: The read buffer should only be used or modified if the C<on_read>,
831	C<push_read> or C<unshift_read> methods are used. The other read methods	855	C<push_read> or C<unshift_read> methods are used. The other read methods
832	automatically manage the read buffer.	856	automatically manage the read buffer.
833		857
…		…
1088	An octet string prefixed with an encoded length. The encoding C<$format>	1112	An octet string prefixed with an encoded length. The encoding C<$format>
1089	uses the same format as a Perl C<pack> format, but must specify a single	1113	uses the same format as a Perl C<pack> format, but must specify a single
1090	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1114	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1091	optional C<!>, C<< < >> or C<< > >> modifier).	1115	optional C<!>, C<< < >> or C<< > >> modifier).
1092		1116
1093	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1117	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1118	EPP uses a prefix of C<N> (4 octtes).
1094		1119
1095	Example: read a block of data prefixed by its length in BER-encoded	1120	Example: read a block of data prefixed by its length in BER-encoded
1096	format (very efficient).	1121	format (very efficient).
1097		1122
1098	$handle->push_read (packstring => "w", sub {	1123	$handle->push_read (packstring => "w", sub {
…		…
1128	}	1153	}
1129	};	1154	};
1130		1155
1131	=item json => $cb->($handle, $hash_or_arrayref)	1156	=item json => $cb->($handle, $hash_or_arrayref)
1132		1157
1133	Reads a JSON object or array, decodes it and passes it to the callback.	1158	Reads a JSON object or array, decodes it and passes it to the
		1159	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1134		1160
1135	If a C<json> object was passed to the constructor, then that will be used	1161	If a C<json> object was passed to the constructor, then that will be used
1136	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1162	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1137		1163
1138	This read type uses the incremental parser available with JSON version	1164	This read type uses the incremental parser available with JSON version
…		…
1155	my $rbuf = \$self->{rbuf};	1181	my $rbuf = \$self->{rbuf};
1156		1182
1157	my $json = $self->{json} \|\|= JSON->new->utf8;	1183	my $json = $self->{json} \|\|= JSON->new->utf8;
1158		1184
1159	sub {	1185	sub {
1160	my $ref = $json->incr_parse ($self->{rbuf});	1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1161		1187
1162	if ($ref) {	1188	if ($ref) {
1163	$self->{rbuf} = $json->incr_text;	1189	$self->{rbuf} = $json->incr_text;
1164	$json->incr_text = "";	1190	$json->incr_text = "";
1165	$cb->($self, $ref);	1191	$cb->($self, $ref);
1166		1192
1167	1	1193	1
		1194	} elsif ($@) {
		1195	# error case
		1196	$json->incr_skip;
		1197
		1198	$self->{rbuf} = $json->incr_text;
		1199	$json->incr_text = "";
		1200
		1201	$self->_error (&Errno::EBADMSG);
		1202
		1203	()
1168	} else {	1204	} else {
1169	$self->{rbuf} = "";	1205	$self->{rbuf} = "";
		1206
1170	()	1207	()
1171	}	1208	}
1172	}	1209	}
1173	};	1210	};
1174		1211
…		…
1251	Note that AnyEvent::Handle will automatically C<start_read> for you when	1288	Note that AnyEvent::Handle will automatically C<start_read> for you when
1252	you change the C<on_read> callback or push/unshift a read callback, and it	1289	you change the C<on_read> callback or push/unshift a read callback, and it
1253	will automatically C<stop_read> for you when neither C<on_read> is set nor	1290	will automatically C<stop_read> for you when neither C<on_read> is set nor
1254	there are any read requests in the queue.	1291	there are any read requests in the queue.
1255		1292
		1293	These methods will have no effect when in TLS mode (as TLS doesn't support
		1294	half-duplex connections).
		1295
1256	=cut	1296	=cut
1257		1297
1258	sub stop_read {	1298	sub stop_read {
1259	my ($self) = @_;	1299	my ($self) = @_;
1260		1300
1261	delete $self->{_rw};	1301	delete $self->{_rw} unless $self->{tls};
1262	}	1302	}
1263		1303
1264	sub start_read {	1304	sub start_read {
1265	my ($self) = @_;	1305	my ($self) = @_;
1266		1306
1267	unless ($self->{_rw} \|\| $self->{_eof}) {	1307	unless ($self->{_rw} \|\| $self->{_eof}) {
1268	Scalar::Util::weaken $self;	1308	Scalar::Util::weaken $self;
1269		1309
1270	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1310	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1271	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1311	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1272	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1312	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1273		1313
1274	if ($len > 0) {	1314	if ($len > 0) {
1275	$self->{_activity} = AnyEvent->now;	1315	$self->{_activity} = AnyEvent->now;
1276		1316
1277	$self->{filter_r}	1317	if ($self->{tls}) {
1278	? $self->{filter_r}($self, $rbuf)	1318	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1279	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1319
		1320	&_dotls ($self);
		1321	} else {
		1322	$self->_drain_rbuf unless $self->{_in_drain};
		1323	}
1280		1324
1281	} elsif (defined $len) {	1325	} elsif (defined $len) {
1282	delete $self->{_rw};	1326	delete $self->{_rw};
1283	$self->{_eof} = 1;	1327	$self->{_eof} = 1;
1284	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1288	}	1332	}
1289	});	1333	});
1290	}	1334	}
1291	}	1335	}
1292		1336
		1337	# poll the write BIO and send the data if applicable
1293	sub _dotls {	1338	sub _dotls {
1294	my ($self) = @_;	1339	my ($self) = @_;
1295		1340
1296	my $buf;	1341	my $tmp;
1297		1342
1298	if (length $self->{_tls_wbuf}) {	1343	if (length $self->{_tls_wbuf}) {
1299	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1300	substr $self->{_tls_wbuf}, 0, $len, "";	1345	substr $self->{_tls_wbuf}, 0, $tmp, "";
1301	}	1346	}
1302	}	1347	}
1303		1348
1304	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1305	$self->{wbuf} .= $buf;
1306	$self->_drain_wbuf;
1307	}
1308
1309	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1310	if (length $buf) {	1350	unless (length $tmp) {
1311	$self->{rbuf} .= $buf;
1312	$self->_drain_rbuf unless $self->{_in_drain};
1313	} else {
1314	# let's treat SSL-eof as we treat normal EOF	1351	# let's treat SSL-eof as we treat normal EOF
		1352	delete $self->{_rw};
1315	$self->{_eof} = 1;	1353	$self->{_eof} = 1;
1316	$self->_shutdown;	1354	&_freetls;
1317	return;
1318	}	1355	}
1319	}
1320		1356
		1357	$self->{_tls_rbuf} .= $tmp;
		1358	$self->_drain_rbuf unless $self->{_in_drain};
		1359	$self->{tls} or return; # tls session might have gone away in callback
		1360	}
		1361
1321	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1322		1363
1323	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1324	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1325	return $self->_error ($!, 1);	1366	return $self->_error ($!, 1);
1326	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1327	return $self->_error (&Errno::EIO, 1);	1368	return $self->_error (&Errno::EIO, 1);
1328	}	1369	}
1329		1370
1330	# all others are fine for our purposes	1371	# all other errors are fine for our purposes
		1372	}
		1373
		1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1375	$self->{wbuf} .= $tmp;
		1376	$self->_drain_wbuf;
1331	}	1377	}
1332	}	1378	}
1333		1379
1334	=item $handle->starttls ($tls[, $tls_ctx])	1380	=item $handle->starttls ($tls[, $tls_ctx])
1335		1381
…		…
1345		1391
1346	The TLS connection object will end up in C<< $handle->{tls} >> after this	1392	The TLS connection object will end up in C<< $handle->{tls} >> after this
1347	call and can be used or changed to your liking. Note that the handshake	1393	call and can be used or changed to your liking. Note that the handshake
1348	might have already started when this function returns.	1394	might have already started when this function returns.
1349		1395
		1396	If it an error to start a TLS handshake more than once per
		1397	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1398
1350	=cut	1399	=cut
1351		1400
1352	sub starttls {	1401	sub starttls {
1353	my ($self, $ssl, $ctx) = @_;	1402	my ($self, $ssl, $ctx) = @_;
1354		1403
1355	$self->stoptls;	1404	require Net::SSLeay;
1356		1405
		1406	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1407	if $self->{tls};
		1408
1357	if ($ssl eq "accept") {	1409	if ($ssl eq "accept") {
1358	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1410	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1359	Net::SSLeay::set_accept_state ($ssl);	1411	Net::SSLeay::set_accept_state ($ssl);
1360	} elsif ($ssl eq "connect") {	1412	} elsif ($ssl eq "connect") {
1361	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1413	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1367	# basically, this is deep magic (because SSL_read should have the same issues)	1419	# basically, this is deep magic (because SSL_read should have the same issues)
1368	# but the openssl maintainers basically said: "trust us, it just works".	1420	# but the openssl maintainers basically said: "trust us, it just works".
1369	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1421	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1370	# and mismaintained ssleay-module doesn't even offer them).	1422	# and mismaintained ssleay-module doesn't even offer them).
1371	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1423	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1424	#
		1425	# in short: this is a mess.
		1426	#
		1427	# note that we do not try to keep the length constant between writes as we are required to do.
		1428	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1429	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1430	# have identity issues in that area.
1372	Net::SSLeay::CTX_set_mode ($self->{tls},	1431	Net::SSLeay::CTX_set_mode ($self->{tls},
1373	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1374	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1433	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1375		1434
1376	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1377	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1378		1437
1379	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1438	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1380		1439
1381	$self->{filter_w} = sub {	1440	&_dotls; # need to trigger the initial handshake
1382	$_[0]{_tls_wbuf} .= ${$_[1]};	1441	$self->start_read; # make sure we actually do read
1383	&_dotls;
1384	};
1385	$self->{filter_r} = sub {
1386	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1387	&_dotls;
1388	};
1389	}	1442	}
1390		1443
1391	=item $handle->stoptls	1444	=item $handle->stoptls
1392		1445
1393	Destroys the SSL connection, if any. Partial read or write data will be	1446	Shuts down the SSL connection - this makes a proper EOF handshake by
1394	lost.	1447	sending a close notify to the other side, but since OpenSSL doesn't
		1448	support non-blocking shut downs, it is not possible to re-use the stream
		1449	afterwards.
1395		1450
1396	=cut	1451	=cut
1397		1452
1398	sub stoptls {	1453	sub stoptls {
1399	my ($self) = @_;	1454	my ($self) = @_;
1400		1455
		1456	if ($self->{tls}) {
		1457	Net::SSLeay::shutdown ($self->{tls});
		1458
		1459	&_dotls;
		1460
		1461	# we don't give a shit. no, we do, but we can't. no...
		1462	# we, we... have to use openssl :/
		1463	&_freetls;
		1464	}
		1465	}
		1466
		1467	sub _freetls {
		1468	my ($self) = @_;
		1469
		1470	return unless $self->{tls};
		1471
1401	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1472	Net::SSLeay::free (delete $self->{tls});
1402		1473
1403	delete $self->{_rbio};	1474	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1404	delete $self->{_wbio};
1405	delete $self->{_tls_wbuf};
1406	delete $self->{filter_r};
1407	delete $self->{filter_w};
1408	}	1475	}
1409		1476
1410	sub DESTROY {	1477	sub DESTROY {
1411	my $self = shift;	1478	my $self = shift;
1412		1479
1413	$self->stoptls;	1480	&_freetls;
1414		1481
1415	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1482	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1416		1483
1417	if ($linger && length $self->{wbuf}) {	1484	if ($linger && length $self->{wbuf}) {
1418	my $fh = delete $self->{fh};	1485	my $fh = delete $self->{fh};
…		…
1433	@linger = ();	1500	@linger = ();
1434	});	1501	});
1435	}	1502	}
1436	}	1503	}
1437		1504
		1505	=item $handle->destroy
		1506
		1507	Shuts down the handle object as much as possible - this call ensures that
		1508	no further callbacks will be invoked and resources will be freed as much
		1509	as possible. You must not call any methods on the object afterwards.
		1510
		1511	Normally, you can just "forget" any references to an AnyEvent::Handle
		1512	object and it will simply shut down. This works in fatal error and EOF
		1513	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1514	callback, so when you want to destroy the AnyEvent::Handle object from
		1515	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1516	that case.
		1517
		1518	The handle might still linger in the background and write out remaining
		1519	data, as specified by the C<linger> option, however.
		1520
		1521	=cut
		1522
		1523	sub destroy {
		1524	my ($self) = @_;
		1525
		1526	$self->DESTROY;
		1527	%$self = ();
		1528	}
		1529
1438	=item AnyEvent::Handle::TLS_CTX	1530	=item AnyEvent::Handle::TLS_CTX
1439		1531
1440	This function creates and returns the Net::SSLeay::CTX object used by	1532	This function creates and returns the Net::SSLeay::CTX object used by
1441	default for TLS mode.	1533	default for TLS mode.
1442		1534
…		…
1470	}	1562	}
1471	}	1563	}
1472		1564
1473	=back	1565	=back
1474		1566
		1567
		1568	=head1 NONFREQUENTLY ASKED QUESTIONS
		1569
		1570	=over 4
		1571
		1572	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1573	still get further invocations!
		1574
		1575	That's because AnyEvent::Handle keeps a reference to itself when handling
		1576	read or write callbacks.
		1577
		1578	It is only safe to "forget" the reference inside EOF or error callbacks,
		1579	from within all other callbacks, you need to explicitly call the C<<
		1580	->destroy >> method.
		1581
		1582	=item I get different callback invocations in TLS mode/Why can't I pause
		1583	reading?
		1584
		1585	Unlike, say, TCP, TLS connections do not consist of two independent
		1586	communication channels, one for each direction. Or put differently. The
		1587	read and write directions are not independent of each other: you cannot
		1588	write data unless you are also prepared to read, and vice versa.
		1589
		1590	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1591	callback invocations when you are not expecting any read data - the reason
		1592	is that AnyEvent::Handle always reads in TLS mode.
		1593
		1594	During the connection, you have to make sure that you always have a
		1595	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1596	connection (or when you no longer want to use it) you can call the
		1597	C<destroy> method.
		1598
		1599	=item How do I read data until the other side closes the connection?
		1600
		1601	If you just want to read your data into a perl scalar, the easiest way
		1602	to achieve this is by setting an C<on_read> callback that does nothing,
		1603	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1604	will be in C<$_[0]{rbuf}>:
		1605
		1606	$handle->on_read (sub { });
		1607	$handle->on_eof (undef);
		1608	$handle->on_error (sub {
		1609	my $data = delete $_[0]{rbuf};
		1610	undef $handle;
		1611	});
		1612
		1613	The reason to use C<on_error> is that TCP connections, due to latencies
		1614	and packets loss, might get closed quite violently with an error, when in
		1615	fact, all data has been received.
		1616
		1617	It is usually better to use acknowledgements when transferring data,
		1618	to make sure the other side hasn't just died and you got the data
		1619	intact. This is also one reason why so many internet protocols have an
		1620	explicit QUIT command.
		1621
		1622	=item I don't want to destroy the handle too early - how do I wait until
		1623	all data has been written?
		1624
		1625	After writing your last bits of data, set the C<on_drain> callback
		1626	and destroy the handle in there - with the default setting of
		1627	C<low_water_mark> this will be called precisely when all data has been
		1628	written to the socket:
		1629
		1630	$handle->push_write (...);
		1631	$handle->on_drain (sub {
		1632	warn "all data submitted to the kernel\n";
		1633	undef $handle;
		1634	});
		1635
		1636	=back
		1637
		1638
1475	=head1 SUBCLASSING AnyEvent::Handle	1639	=head1 SUBCLASSING AnyEvent::Handle
1476		1640
1477	In many cases, you might want to subclass AnyEvent::Handle.	1641	In many cases, you might want to subclass AnyEvent::Handle.
1478		1642
1479	To make this easier, a given version of AnyEvent::Handle uses these	1643	To make this easier, a given version of AnyEvent::Handle uses these

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.86 by root, Thu Aug 21 20:41:16 2008 UTC vs. Revision 1.118 by root, Thu Feb 12 17:33:38 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.86 by root, Thu Aug 21 20:41:16 2008 UTC vs.
Revision 1.118 by root, Thu Feb 12 17:33:38 2009 UTC