[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.134 by root, Fri Jul 3 00:09:04 2009 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.45;
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");
…		…
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
…		…
60		63
61	=head1 METHODS	64	=head1 METHODS
62		65
63	=over 4	66	=over 4
64		67
65	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		69
67	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
68		71
69	=over 4	72	=over 4
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detcted,	84	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	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		87
		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
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	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	94	otherwise you might end up with a closed socket while you are still
86	waiting for data.	95	waiting for data.
87		96
		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>.
		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal, $message)
89		101
90	This is the error callback, which is called when, well, some error	102	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	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	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
95	fatal errors the handle object will be shut down and will not be	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
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
		112	AnyEvent::Handle tries to find an appropriate error code for you to check
		113	against, but in some cases (TLS errors), this does not work well. It is
		114	recommended to always output the C<$message> argument in human-readable
		115	error messages (it's usually the same as C<"$!">).
		116
96	usable. Non-fatal errors can be retried by simply returning, but it is	117	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	118	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	119	when this callback is invoked. Examples of non-fatal errors are timeouts
		120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		121
100	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		124	C<EPROTO>).
102		125
103	While not mandatory, it is I<highly> recommended to set this callback, as	126	While not mandatory, it is I<highly> recommended to set this callback, as
104	you will not be notified of errors otherwise. The default simply calls	127	you will not be notified of errors otherwise. The default simply calls
105	C<croak>.	128	C<croak>.
106		129
…		…
110	and no read request is in the queue (unlike read queue callbacks, this	133	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	134	callback will only be called when at least one octet of data is in the
112	read buffer).	135	read buffer).
113		136
114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
115	method or access the C<$handle->{rbuf}> member directly.	138	method or access the C<$handle->{rbuf}> member directly. Note that you
		139	must not enlarge or modify the read buffer, you can only remove data at
		140	the beginning from it.
116		141
117	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
118	feed all the remaining data to the queued callbacks and C<on_read> before	143	feed all the remaining data to the queued callbacks and C<on_read> before
119	calling the C<on_eof> callback. If no progress can be made, then a fatal	144	calling the C<on_eof> callback. If no progress can be made, then a fatal
120	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
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.
		247
		248	=item peername => $string
		249
		250	A string used to identify the remote site - usually the DNS hostname
		251	(I<not> IDN!) used to create the connection, rarely the IP address.
		252
		253	Apart from being useful in error messages, this string is also used in TLS
		254	common name verification (see C<verify_cn> in L<AnyEvent::TLS>).
182		255
183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
184		257
185	When this parameter is given, it enables TLS (SSL) mode, that means it	258	When this parameter is given, it enables TLS (SSL) mode, that means
186	will start making tls handshake and will transparently encrypt/decrypt	259	AnyEvent will start a TLS handshake as soon as the conenction has been
187	data.	260	established and will transparently encrypt/decrypt data afterwards.
		261
		262	All TLS protocol errors will be signalled as C<EPROTO>, with an
		263	appropriate error message.
188		264
189	TLS mode requires Net::SSLeay to be installed (it will be loaded	265	TLS mode requires Net::SSLeay to be installed (it will be loaded
190	automatically when you try to create a TLS handle).	266	automatically when you try to create a TLS handle): this module doesn't
		267	have a dependency on that module, so if your module requires it, you have
		268	to add the dependency yourself.
191		269
192	For the TLS server side, use C<accept>, and for the TLS client side of a	270	Unlike TCP, TLS has a server and client side: for the TLS server side, use
193	connection, use C<connect> mode.	271	C<accept>, and for the TLS client side of a connection, use C<connect>
		272	mode.
194		273
195	You can also provide your own TLS connection object, but you have	274	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>	275	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	276	or C<Net::SSLeay::set_accept_state> on it before you pass it to
198	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
199		279
		280	At some future point, AnyEvent::Handle might switch to another TLS
		281	implementation, then the option to use your own session object will go
		282	away.
		283
		284	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		285	passing in the wrong integer will lead to certain crash. This most often
		286	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		287	segmentation fault.
		288
200	See the C<starttls> method if you need to start TLs negotiation later.	289	See the C<< ->starttls >> method for when need to start TLS negotiation later.
201		290
202	=item tls_ctx => $ssl_ctx	291	=item tls_ctx => $anyevent_tls
203		292
204	Use the given Net::SSLeay::CTX object to create the new TLS connection	293	Use the given C<AnyEvent::TLS> object to create the new TLS connection
205	(unless a connection object was specified directly). If this parameter is	294	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		296
		297	Instead of an object, you can also specify a hash reference with C<< key
		298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		299	new TLS context object.
		300
208	=item json => JSON or JSON::XS object	301	=item json => JSON or JSON::XS object
209		302
210	This is the json coder object used by the C<json> read and write types.	303	This is the json coder object used by the C<json> read and write types.
211		304
212	If you don't supply it, then AnyEvent::Handle will create and use a	305	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.	306	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		307	texts.
214		308
215	Note that you are responsible to depend on the JSON module if you want to	309	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.	310	use this functionality, as AnyEvent does not have a dependency itself.
217		311
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223
224	=back	312	=back
225		313
226	=cut	314	=cut
227		315
228	sub new {	316	sub new {
229	my $class = shift;	317	my $class = shift;
230
231	my $self = bless { @_ }, $class;	318	my $self = bless { @_ }, $class;
232		319
233	$self->{fh} or Carp::croak "mandatory argument fh is missing";	320	$self->{fh} or Carp::croak "mandatory argument fh is missing";
234		321
235	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
236
237	if ($self->{tls}) {
238	require Net::SSLeay;
239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
240	}
241		323
242	$self->{_activity} = AnyEvent->now;	324	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;	325	$self->_timeout;
244		326
		327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		328
		329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		330	if $self->{tls};
		331
245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
246		333
247	$self	334	$self->start_read
		335	if $self->{on_read};
		336
		337	$self->{fh} && $self
248	}	338	}
249		339
250	sub _shutdown {	340	sub _shutdown {
251	my ($self) = @_;	341	my ($self) = @_;
252		342
253	delete $self->{_tw};	343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
254	delete $self->{_rw};	344	$self->{_eof} = 1; # tell starttls et. al to stop trying
255	delete $self->{_ww};
256	delete $self->{fh};
257		345
258	$self->stoptls;	346	&_freetls;
259	}	347	}
260		348
261	sub _error {	349	sub _error {
262	my ($self, $errno, $fatal) = @_;	350	my ($self, $errno, $fatal, $message) = @_;
263		351
264	$self->_shutdown	352	$self->_shutdown
265	if $fatal;	353	if $fatal;
266		354
267	$! = $errno;	355	$! = $errno;
		356	$message \|\|= "$!";
268		357
269	if ($self->{on_error}) {	358	if ($self->{on_error}) {
270	$self->{on_error}($self, $fatal);	359	$self->{on_error}($self, $fatal, $message);
271	} else {	360	} elsif ($self->{fh}) {
272	Carp::croak "AnyEvent::Handle uncaught error: $!";	361	Carp::croak "AnyEvent::Handle uncaught error: $message";
273	}	362	}
274	}	363	}
275		364
276	=item $fh = $handle->fh	365	=item $fh = $handle->fh
277		366
278	This method returns the file handle of the L<AnyEvent::Handle> object.	367	This method returns the file handle used to create the L<AnyEvent::Handle> object.
279		368
280	=cut	369	=cut
281		370
282	sub fh { $_[0]{fh} }	371	sub fh { $_[0]{fh} }
283		372
…		…
301	$_[0]{on_eof} = $_[1];	390	$_[0]{on_eof} = $_[1];
302	}	391	}
303		392
304	=item $handle->on_timeout ($cb)	393	=item $handle->on_timeout ($cb)
305		394
306	Replace the current C<on_timeout> callback, or disables the callback	395	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	396	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
308	argument.	397	argument and method.
309		398
310	=cut	399	=cut
311		400
312	sub on_timeout {	401	sub on_timeout {
313	$_[0]{on_timeout} = $_[1];	402	$_[0]{on_timeout} = $_[1];
		403	}
		404
		405	=item $handle->autocork ($boolean)
		406
		407	Enables or disables the current autocork behaviour (see C<autocork>
		408	constructor argument). Changes will only take effect on the next write.
		409
		410	=cut
		411
		412	sub autocork {
		413	$_[0]{autocork} = $_[1];
		414	}
		415
		416	=item $handle->no_delay ($boolean)
		417
		418	Enables or disables the C<no_delay> setting (see constructor argument of
		419	the same name for details).
		420
		421	=cut
		422
		423	sub no_delay {
		424	$_[0]{no_delay} = $_[1];
		425
		426	eval {
		427	local $SIG{__DIE__};
		428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		429	};
314	}	430	}
315		431
316	#############################################################################	432	#############################################################################
317		433
318	=item $handle->timeout ($seconds)	434	=item $handle->timeout ($seconds)
…		…
396	my ($self, $cb) = @_;	512	my ($self, $cb) = @_;
397		513
398	$self->{on_drain} = $cb;	514	$self->{on_drain} = $cb;
399		515
400	$cb->($self)	516	$cb->($self)
401	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	517	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
402	}	518	}
403		519
404	=item $handle->push_write ($data)	520	=item $handle->push_write ($data)
405		521
406	Queues the given scalar to be written. You can push as much data as you	522	Queues the given scalar to be written. You can push as much data as you
…		…
423	substr $self->{wbuf}, 0, $len, "";	539	substr $self->{wbuf}, 0, $len, "";
424		540
425	$self->{_activity} = AnyEvent->now;	541	$self->{_activity} = AnyEvent->now;
426		542
427	$self->{on_drain}($self)	543	$self->{on_drain}($self)
428	if $self->{low_water_mark} >= length $self->{wbuf}	544	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
429	&& $self->{on_drain};	545	&& $self->{on_drain};
430		546
431	delete $self->{_ww} unless length $self->{wbuf};	547	delete $self->{_ww} unless length $self->{wbuf};
432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
433	$self->_error ($!, 1);	549	$self->_error ($!, 1);
434	}	550	}
435	};	551	};
436		552
437	# try to write data immediately	553	# try to write data immediately
438	$cb->();	554	$cb->() unless $self->{autocork};
439		555
440	# if still data left in wbuf, we need to poll	556	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	557	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
442	if length $self->{wbuf};	558	if length $self->{wbuf};
443	};	559	};
…		…
457		573
458	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	574	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
459	->($self, @_);	575	->($self, @_);
460	}	576	}
461		577
462	if ($self->{filter_w}) {	578	if ($self->{tls}) {
463	$self->{filter_w}($self, \$_[0]);	579	$self->{_tls_wbuf} .= $_[0];
		580
		581	&_dotls ($self);
464	} else {	582	} else {
465	$self->{wbuf} .= $_[0];	583	$self->{wbuf} .= $_[0];
466	$self->_drain_wbuf;	584	$self->_drain_wbuf;
467	}	585	}
468	}	586	}
…		…
485	=cut	603	=cut
486		604
487	register_write_type netstring => sub {	605	register_write_type netstring => sub {
488	my ($self, $string) = @_;	606	my ($self, $string) = @_;
489		607
490	sprintf "%d:%s,", (length $string), $string	608	(length $string) . ":$string,"
491	};	609	};
492		610
493	=item packstring => $format, $data	611	=item packstring => $format, $data
494		612
495	An octet string prefixed with an encoded length. The encoding C<$format>	613	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
500	=cut	618	=cut
501		619
502	register_write_type packstring => sub {	620	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	621	my ($self, $format, $string) = @_;
504		622
505	pack "$format/a", $string	623	pack "$format/a*", $string
506	};	624	};
507		625
508	=item json => $array_or_hashref	626	=item json => $array_or_hashref
509		627
510	Encodes the given hash or array reference into a JSON object. Unless you	628	Encodes the given hash or array reference into a JSON object. Unless you
…		…
544		662
545	$self->{json} ? $self->{json}->encode ($ref)	663	$self->{json} ? $self->{json}->encode ($ref)
546	: JSON::encode_json ($ref)	664	: JSON::encode_json ($ref)
547	};	665	};
548		666
		667	=item storable => $reference
		668
		669	Freezes the given reference using L<Storable> and writes it to the
		670	handle. Uses the C<nfreeze> format.
		671
		672	=cut
		673
		674	register_write_type storable => sub {
		675	my ($self, $ref) = @_;
		676
		677	require Storable;
		678
		679	pack "w/a*", Storable::nfreeze ($ref)
		680	};
		681
549	=back	682	=back
		683
		684	=item $handle->push_shutdown
		685
		686	Sometimes you know you want to close the socket after writing your data
		687	before it was actually written. One way to do that is to replace your
		688	C<on_drain> handler by a callback that shuts down the socket. This method
		689	is a shorthand for just that, and replaces the C<on_drain> callback with:
		690
		691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		692
		693	This simply shuts down the write side and signals an EOF condition to the
		694	the peer.
		695
		696	You can rely on the normal read queue and C<on_eof> handling
		697	afterwards. This is the cleanest way to close a connection.
		698
		699	=cut
		700
		701	sub push_shutdown {
		702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };
		703	}
550		704
551	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
552		706
553	This function (not method) lets you add your own types to C<push_write>.	707	This function (not method) lets you add your own types to C<push_write>.
554	Whenever the given C<type> is used, C<push_write> will invoke the code	708	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
575	ways, the "simple" way, using only C<on_read> and the "complex" way, using	729	ways, the "simple" way, using only C<on_read> and the "complex" way, using
576	a queue.	730	a queue.
577		731
578	In the simple case, you just install an C<on_read> callback and whenever	732	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	733	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	734	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
581	or not.	735	leave the data there if you want to accumulate more (e.g. when only a
		736	partial message has been received so far).
582		737
583	In the more complex case, you want to queue multiple callbacks. In this	738	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	739	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	740	data arrives (also the first time it is queued) and removes it when it has
586	done its job (see C<push_read>, below).	741	done its job (see C<push_read>, below).
…		…
604	# handle xml	759	# handle xml
605	});	760	});
606	});	761	});
607	});	762	});
608		763
609	Example 2: Implement a client for a protocol that replies either with	764	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	765	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	766	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	767	just pipeline sending both requests and manipulate the queue as necessary
613	the callbacks:	768	in the callbacks.
614		769
615	# request one	770	When the first callback is called and sees an "OK" response, it will
		771	C<unshift> another line-read. This line-read will be queued I<before> the
		772	64-byte chunk callback.
		773
		774	# request one, returns either "OK + extra line" or "ERROR"
616	$handle->push_write ("request 1\015\012");	775	$handle->push_write ("request 1\015\012");
617		776
618	# we expect "ERROR" or "OK" as response, so push a line read	777	# we expect "ERROR" or "OK" as response, so push a line read
619	$handle->push_read (line => sub {	778	$handle->push_read (line => sub {
620	# if we got an "OK", we have to _prepend_ another line,	779	# if we got an "OK", we have to _prepend_ another line,
…		…
627	...	786	...
628	});	787	});
629	}	788	}
630	});	789	});
631		790
632	# request two	791	# request two, simply returns 64 octets
633	$handle->push_write ("request 2\015\012");	792	$handle->push_write ("request 2\015\012");
634		793
635	# simply read 64 bytes, always	794	# simply read 64 bytes, always
636	$handle->push_read (chunk => 64, sub {	795	$handle->push_read (chunk => 64, sub {
637	my $response = $_[1];	796	my $response = $_[1];
…		…
649		808
650	if (	809	if (
651	defined $self->{rbuf_max}	810	defined $self->{rbuf_max}
652	&& $self->{rbuf_max} < length $self->{rbuf}	811	&& $self->{rbuf_max} < length $self->{rbuf}
653	) {	812	) {
654	return $self->_error (&Errno::ENOSPC, 1);	813	$self->_error (&Errno::ENOSPC, 1), return;
655	}	814	}
656		815
657	while () {	816	while () {
658	no strict 'refs';	817	# we need to use a separate tls read buffer, as we must not receive data while
		818	# we are draining the buffer, and this can only happen with TLS.
		819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
659		820
660	my $len = length $self->{rbuf};	821	my $len = length $self->{rbuf};
661		822
662	if (my $cb = shift @{ $self->{_queue} }) {	823	if (my $cb = shift @{ $self->{_queue} }) {
663	unless ($cb->($self)) {	824	unless ($cb->($self)) {
664	if ($self->{_eof}) {	825	if ($self->{_eof}) {
665	# no progress can be made (not enough data and no data forthcoming)	826	# no progress can be made (not enough data and no data forthcoming)
666	$self->_error (&Errno::EPIPE, 1), last;	827	$self->_error (&Errno::EPIPE, 1), return;
667	}	828	}
668		829
669	unshift @{ $self->{_queue} }, $cb;	830	unshift @{ $self->{_queue} }, $cb;
670	last;	831	last;
671	}	832	}
…		…
679	&& !@{ $self->{_queue} } # and the queue is still empty	840	&& !@{ $self->{_queue} } # and the queue is still empty
680	&& $self->{on_read} # but we still have on_read	841	&& $self->{on_read} # but we still have on_read
681	) {	842	) {
682	# no further data will arrive	843	# no further data will arrive
683	# so no progress can be made	844	# so no progress can be made
684	$self->_error (&Errno::EPIPE, 1), last	845	$self->_error (&Errno::EPIPE, 1), return
685	if $self->{_eof};	846	if $self->{_eof};
686		847
687	last; # more data might arrive	848	last; # more data might arrive
688	}	849	}
689	} else {	850	} else {
690	# read side becomes idle	851	# read side becomes idle
691	delete $self->{_rw};	852	delete $self->{_rw} unless $self->{tls};
692	last;	853	last;
693	}	854	}
694	}	855	}
695		856
		857	if ($self->{_eof}) {
		858	if ($self->{on_eof}) {
696	$self->{on_eof}($self)	859	$self->{on_eof}($self)
697	if $self->{_eof} && $self->{on_eof};	860	} else {
		861	$self->_error (0, 1);
		862	}
		863	}
698		864
699	# may need to restart read watcher	865	# may need to restart read watcher
700	unless ($self->{_rw}) {	866	unless ($self->{_rw}) {
701	$self->start_read	867	$self->start_read
702	if $self->{on_read} \|\| @{ $self->{_queue} };	868	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
720		886
721	=item $handle->rbuf	887	=item $handle->rbuf
722		888
723	Returns the read buffer (as a modifiable lvalue).	889	Returns the read buffer (as a modifiable lvalue).
724		890
725	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	891	You can access the read buffer directly as the C<< ->{rbuf} >>
726	you want.	892	member, if you want. However, the only operation allowed on the
		893	read buffer (apart from looking at it) is removing data from its
		894	beginning. Otherwise modifying or appending to it is not allowed and will
		895	lead to hard-to-track-down bugs.
727		896
728	NOTE: The read buffer should only be used or modified if the C<on_read>,	897	NOTE: The read buffer should only be used or modified if the C<on_read>,
729	C<push_read> or C<unshift_read> methods are used. The other read methods	898	C<push_read> or C<unshift_read> methods are used. The other read methods
730	automatically manage the read buffer.	899	automatically manage the read buffer.
731		900
…		…
828	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	997	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
829	1	998	1
830	}	999	}
831	};	1000	};
832		1001
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)	1002	=item line => [$eol, ]$cb->($handle, $line, $eol)
843		1003
844	The callback will be called only once a full line (including the end of	1004	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	1005	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	1006	marker) will be passed to the callback as second argument (C<$line>), and
…		…
861	=cut	1021	=cut
862		1022
863	register_read_type line => sub {	1023	register_read_type line => sub {
864	my ($self, $cb, $eol) = @_;	1024	my ($self, $cb, $eol) = @_;
865		1025
866	$eol = qr\|(\015?\012)\| if @_ < 3;	1026	if (@_ < 3) {
		1027	# this is more than twice as fast as the generic code below
		1028	sub {
		1029	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1030
		1031	$cb->($_[0], $1, $2);
		1032	1
		1033	}
		1034	} else {
867	$eol = quotemeta $eol unless ref $eol;	1035	$eol = quotemeta $eol unless ref $eol;
868	$eol = qr\|^(.*?)($eol)\|s;	1036	$eol = qr\|^(.*?)($eol)\|s;
869		1037
870	sub {	1038	sub {
871	$_[0]{rbuf} =~ s/$eol// or return;	1039	$_[0]{rbuf} =~ s/$eol// or return;
872		1040
873	$cb->($_[0], $1, $2);	1041	$cb->($_[0], $1, $2);
		1042	1
874	1	1043	}
875	}	1044	}
876	};	1045	};
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		1046
889	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1047	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
890		1048
891	Makes a regex match against the regex object C<$accept> and returns	1049	Makes a regex match against the regex object C<$accept> and returns
892	everything up to and including the match.	1050	everything up to and including the match.
…		…
997	An octet string prefixed with an encoded length. The encoding C<$format>	1155	An octet string prefixed with an encoded length. The encoding C<$format>
998	uses the same format as a Perl C<pack> format, but must specify a single	1156	uses the same format as a Perl C<pack> format, but must specify a single
999	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1157	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1000	optional C<!>, C<< < >> or C<< > >> modifier).	1158	optional C<!>, C<< < >> or C<< > >> modifier).
1001		1159
1002	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1160	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1161	EPP uses a prefix of C<N> (4 octtes).
1003		1162
1004	Example: read a block of data prefixed by its length in BER-encoded	1163	Example: read a block of data prefixed by its length in BER-encoded
1005	format (very efficient).	1164	format (very efficient).
1006		1165
1007	$handle->push_read (packstring => "w", sub {	1166	$handle->push_read (packstring => "w", sub {
…		…
1013	register_read_type packstring => sub {	1172	register_read_type packstring => sub {
1014	my ($self, $cb, $format) = @_;	1173	my ($self, $cb, $format) = @_;
1015		1174
1016	sub {	1175	sub {
1017	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1176	# 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} })	1177	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1019	or return;	1178	or return;
1020		1179
		1180	$format = length pack $format, $len;
		1181
		1182	# bypass unshift if we already have the remaining chunk
		1183	if ($format + $len <= length $_[0]{rbuf}) {
		1184	my $data = substr $_[0]{rbuf}, $format, $len;
		1185	substr $_[0]{rbuf}, 0, $format + $len, "";
		1186	$cb->($_[0], $data);
		1187	} else {
1021	# remove prefix	1188	# remove prefix
1022	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1189	substr $_[0]{rbuf}, 0, $format, "";
1023		1190
1024	# read rest	1191	# read remaining chunk
1025	$_[0]->unshift_read (chunk => $len, $cb);	1192	$_[0]->unshift_read (chunk => $len, $cb);
		1193	}
1026		1194
1027	1	1195	1
1028	}	1196	}
1029	};	1197	};
1030		1198
1031	=item json => $cb->($handle, $hash_or_arrayref)	1199	=item json => $cb->($handle, $hash_or_arrayref)
1032		1200
1033	Reads a JSON object or array, decodes it and passes it to the callback.	1201	Reads a JSON object or array, decodes it and passes it to the
		1202	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1034		1203
1035	If a C<json> object was passed to the constructor, then that will be used	1204	If a C<json> object was passed to the constructor, then that will be used
1036	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1205	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1037		1206
1038	This read type uses the incremental parser available with JSON version	1207	This read type uses the incremental parser available with JSON version
…		…
1045	the C<json> write type description, above, for an actual example.	1214	the C<json> write type description, above, for an actual example.
1046		1215
1047	=cut	1216	=cut
1048		1217
1049	register_read_type json => sub {	1218	register_read_type json => sub {
1050	my ($self, $cb, $accept, $reject, $skip) = @_;	1219	my ($self, $cb) = @_;
1051		1220
1052	require JSON;	1221	require JSON;
1053		1222
1054	my $data;	1223	my $data;
1055	my $rbuf = \$self->{rbuf};	1224	my $rbuf = \$self->{rbuf};
1056		1225
1057	my $json = $self->{json} \|\|= JSON->new->utf8;	1226	my $json = $self->{json} \|\|= JSON->new->utf8;
1058		1227
1059	sub {	1228	sub {
1060	my $ref = $json->incr_parse ($self->{rbuf});	1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1061		1230
1062	if ($ref) {	1231	if ($ref) {
1063	$self->{rbuf} = $json->incr_text;	1232	$self->{rbuf} = $json->incr_text;
1064	$json->incr_text = "";	1233	$json->incr_text = "";
1065	$cb->($self, $ref);	1234	$cb->($self, $ref);
1066		1235
1067	1	1236	1
		1237	} elsif ($@) {
		1238	# error case
		1239	$json->incr_skip;
		1240
		1241	$self->{rbuf} = $json->incr_text;
		1242	$json->incr_text = "";
		1243
		1244	$self->_error (&Errno::EBADMSG);
		1245
		1246	()
1068	} else {	1247	} else {
1069	$self->{rbuf} = "";	1248	$self->{rbuf} = "";
		1249
1070	()	1250	()
1071	}	1251	}
		1252	}
		1253	};
		1254
		1255	=item storable => $cb->($handle, $ref)
		1256
		1257	Deserialises a L<Storable> frozen representation as written by the
		1258	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1259	data).
		1260
		1261	Raises C<EBADMSG> error if the data could not be decoded.
		1262
		1263	=cut
		1264
		1265	register_read_type storable => sub {
		1266	my ($self, $cb) = @_;
		1267
		1268	require Storable;
		1269
		1270	sub {
		1271	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1272	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1273	or return;
		1274
		1275	my $format = length pack "w", $len;
		1276
		1277	# bypass unshift if we already have the remaining chunk
		1278	if ($format + $len <= length $_[0]{rbuf}) {
		1279	my $data = substr $_[0]{rbuf}, $format, $len;
		1280	substr $_[0]{rbuf}, 0, $format + $len, "";
		1281	$cb->($_[0], Storable::thaw ($data));
		1282	} else {
		1283	# remove prefix
		1284	substr $_[0]{rbuf}, 0, $format, "";
		1285
		1286	# read remaining chunk
		1287	$_[0]->unshift_read (chunk => $len, sub {
		1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1289	$cb->($_[0], $ref);
		1290	} else {
		1291	$self->_error (&Errno::EBADMSG);
		1292	}
		1293	});
		1294	}
		1295
		1296	1
1072	}	1297	}
1073	};	1298	};
1074		1299
1075	=back	1300	=back
1076		1301
…		…
1106	Note that AnyEvent::Handle will automatically C<start_read> for you when	1331	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	1332	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	1333	will automatically C<stop_read> for you when neither C<on_read> is set nor
1109	there are any read requests in the queue.	1334	there are any read requests in the queue.
1110		1335
		1336	These methods will have no effect when in TLS mode (as TLS doesn't support
		1337	half-duplex connections).
		1338
1111	=cut	1339	=cut
1112		1340
1113	sub stop_read {	1341	sub stop_read {
1114	my ($self) = @_;	1342	my ($self) = @_;
1115		1343
1116	delete $self->{_rw};	1344	delete $self->{_rw} unless $self->{tls};
1117	}	1345	}
1118		1346
1119	sub start_read {	1347	sub start_read {
1120	my ($self) = @_;	1348	my ($self) = @_;
1121		1349
1122	unless ($self->{_rw} \|\| $self->{_eof}) {	1350	unless ($self->{_rw} \|\| $self->{_eof}) {
1123	Scalar::Util::weaken $self;	1351	Scalar::Util::weaken $self;
1124		1352
1125	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1126	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1127	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1355	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1128		1356
1129	if ($len > 0) {	1357	if ($len > 0) {
1130	$self->{_activity} = AnyEvent->now;	1358	$self->{_activity} = AnyEvent->now;
1131		1359
1132	$self->{filter_r}	1360	if ($self->{tls}) {
1133	? $self->{filter_r}($self, $rbuf)	1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1134	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1362
		1363	&_dotls ($self);
		1364	} else {
		1365	$self->_drain_rbuf unless $self->{_in_drain};
		1366	}
1135		1367
1136	} elsif (defined $len) {	1368	} elsif (defined $len) {
1137	delete $self->{_rw};	1369	delete $self->{_rw};
1138	$self->{_eof} = 1;	1370	$self->{_eof} = 1;
1139	$self->_drain_rbuf unless $self->{_in_drain};	1371	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1143	}	1375	}
1144	});	1376	});
1145	}	1377	}
1146	}	1378	}
1147		1379
		1380	our $ERROR_SYSCALL;
		1381	our $ERROR_WANT_READ;
		1382	our $ERROR_ZERO_RETURN;
		1383
		1384	sub _tls_error {
		1385	my ($self, $err) = @_;
		1386	warn "$err,$!\n";#d#
		1387
		1388	return $self->_error ($!, 1)
		1389	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1390
		1391	$self->_error (&Errno::EPROTO, 1,
		1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));
		1393	}
		1394
		1395	# poll the write BIO and send the data if applicable
		1396	# also decode read data if possible
		1397	# this is basiclaly our TLS state machine
		1398	# more efficient implementations are possible with openssl,
		1399	# but not with the buggy and incomplete Net::SSLeay.
1148	sub _dotls {	1400	sub _dotls {
1149	my ($self) = @_;	1401	my ($self) = @_;
1150		1402
1151	my $buf;	1403	my $tmp;
1152		1404
1153	if (length $self->{_tls_wbuf}) {	1405	if (length $self->{_tls_wbuf}) {
1154	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1406	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1155	substr $self->{_tls_wbuf}, 0, $len, "";	1407	substr $self->{_tls_wbuf}, 0, $tmp, "";
1156	}	1408	}
1157	}
1158		1409
		1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1411	return $self->_tls_error ($tmp)
		1412	if $tmp != $ERROR_WANT_READ
		1413	&& ($tmp != $ERROR_SYSCALL \|\| $!)
		1414	&& $tmp != $ERROR_ZERO_RETURN;
		1415	}
		1416
		1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1418	unless (length $tmp) {
		1419	# let's treat SSL-eof as we treat normal EOF
		1420	delete $self->{_rw};
		1421	$self->{_eof} = 1;
		1422	&_freetls;
		1423	}
		1424
		1425	$self->{_tls_rbuf} .= $tmp;
		1426	$self->_drain_rbuf unless $self->{_in_drain};
		1427	$self->{tls} or return; # tls session might have gone away in callback
		1428	}
		1429
		1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1431	return $self->_tls_error ($tmp)
		1432	if $tmp != $ERROR_WANT_READ
		1433	&& ($tmp != $ERROR_SYSCALL \|\| $!)
		1434	&& $tmp != $ERROR_ZERO_RETURN;
		1435
1159	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1160	$self->{wbuf} .= $buf;	1437	$self->{wbuf} .= $tmp;
1161	$self->_drain_wbuf;	1438	$self->_drain_wbuf;
1162	}
1163
1164	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1165	if (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
1170	$self->{_eof} = 1;
1171	$self->_shutdown;
1172	return;
1173	}
1174	}
1175
1176	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1177
1178	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1179	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1180	return $self->_error ($!, 1);
1181	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1182	return $self->_error (&Errno::EIO, 1);
1183	}
1184
1185	# all others are fine for our purposes
1186	}	1439	}
1187	}	1440	}
1188		1441
1189	=item $handle->starttls ($tls[, $tls_ctx])	1442	=item $handle->starttls ($tls[, $tls_ctx])
1190		1443
…		…
1193	C<starttls>.	1446	C<starttls>.
1194		1447
1195	The first argument is the same as the C<tls> constructor argument (either	1448	The first argument is the same as the C<tls> constructor argument (either
1196	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1449	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1197		1450
1198	The second argument is the optional C<Net::SSLeay::CTX> object that is	1451	The second argument is the optional C<AnyEvent::TLS> object that is used
1199	used when AnyEvent::Handle has to create its own TLS connection object.	1452	when AnyEvent::Handle has to create its own TLS connection object, or
		1453	a hash reference with C<< key => value >> pairs that will be used to
		1454	construct a new context.
1200		1455
1201	The TLS connection object will end up in C<< $handle->{tls} >> after this	1456	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1202	call and can be used or changed to your liking. Note that the handshake	1457	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1203	might have already started when this function returns.	1458	changed to your liking. Note that the handshake might have already started
		1459	when this function returns.
		1460
		1461	If it an error to start a TLS handshake more than once per
		1462	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1204		1463
1205	=cut	1464	=cut
1206		1465
1207	sub starttls {	1466	sub starttls {
1208	my ($self, $ssl, $ctx) = @_;	1467	my ($self, $ssl, $ctx) = @_;
1209		1468
1210	$self->stoptls;	1469	require Net::SSLeay;
1211		1470
1212	if ($ssl eq "accept") {	1471	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1213	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1472	if $self->{tls};
1214	Net::SSLeay::set_accept_state ($ssl);	1473
1215	} elsif ($ssl eq "connect") {	1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1216	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1217	Net::SSLeay::set_connect_state ($ssl);	1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
		1477
		1478	$ctx \|\|= $self->{tls_ctx};
		1479
		1480	if ("HASH" eq ref $ctx) {
		1481	require AnyEvent::TLS;
		1482
		1483	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1484	$ctx = new AnyEvent::TLS %$ctx;
		1485	}
1218	}	1486
1219		1487	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1220	$self->{tls} = $ssl;	1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1221		1489
1222	# basically, this is deep magic (because SSL_read should have the same issues)	1490	# 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".	1491	# but the openssl maintainers basically said: "trust us, it just works".
1224	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1492	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1225	# and mismaintained ssleay-module doesn't even offer them).	1493	# and mismaintained ssleay-module doesn't even offer them).
1226	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1494	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1495	#
		1496	# in short: this is a mess.
		1497	#
		1498	# note that we do not try to keep the length constant between writes as we are required to do.
		1499	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1500	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1501	# have identity issues in that area.
1227	Net::SSLeay::CTX_set_mode ($self->{tls},	1502	# Net::SSLeay::CTX_set_mode ($ssl,
1228	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1503	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1229	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1504	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1505	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1230		1506
1231	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1232	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1233		1509
1234	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1510	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1235		1511
1236	$self->{filter_w} = sub {	1512	&_dotls; # need to trigger the initial handshake
1237	$_[0]{_tls_wbuf} .= ${$_[1]};	1513	$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	}	1514	}
1245		1515
1246	=item $handle->stoptls	1516	=item $handle->stoptls
1247		1517
1248	Destroys the SSL connection, if any. Partial read or write data will be	1518	Shuts down the SSL connection - this makes a proper EOF handshake by
1249	lost.	1519	sending a close notify to the other side, but since OpenSSL doesn't
		1520	support non-blocking shut downs, it is not possible to re-use the stream
		1521	afterwards.
1250		1522
1251	=cut	1523	=cut
1252		1524
1253	sub stoptls {	1525	sub stoptls {
1254	my ($self) = @_;	1526	my ($self) = @_;
1255		1527
1256	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1528	if ($self->{tls}) {
		1529	Net::SSLeay::shutdown ($self->{tls});
1257		1530
1258	delete $self->{_rbio};	1531	&_dotls;
1259	delete $self->{_wbio};	1532
1260	delete $self->{_tls_wbuf};	1533	# we don't give a shit. no, we do, but we can't. no...
1261	delete $self->{filter_r};	1534	# we, we... have to use openssl :/
1262	delete $self->{filter_w};	1535	&_freetls;
		1536	}
		1537	}
		1538
		1539	sub _freetls {
		1540	my ($self) = @_;
		1541
		1542	return unless $self->{tls};
		1543
		1544	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1545
		1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1263	}	1547	}
1264		1548
1265	sub DESTROY {	1549	sub DESTROY {
1266	my $self = shift;	1550	my ($self) = @_;
1267		1551
1268	$self->stoptls;	1552	&_freetls;
1269		1553
1270	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1554	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1271		1555
1272	if ($linger && length $self->{wbuf}) {	1556	if ($linger && length $self->{wbuf}) {
1273	my $fh = delete $self->{fh};	1557	my $fh = delete $self->{fh};
…		…
1288	@linger = ();	1572	@linger = ();
1289	});	1573	});
1290	}	1574	}
1291	}	1575	}
1292		1576
		1577	=item $handle->destroy
		1578
		1579	Shuts down the handle object as much as possible - this call ensures that
		1580	no further callbacks will be invoked and resources will be freed as much
		1581	as possible. You must not call any methods on the object afterwards.
		1582
		1583	Normally, you can just "forget" any references to an AnyEvent::Handle
		1584	object and it will simply shut down. This works in fatal error and EOF
		1585	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1586	callback, so when you want to destroy the AnyEvent::Handle object from
		1587	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1588	that case.
		1589
		1590	The handle might still linger in the background and write out remaining
		1591	data, as specified by the C<linger> option, however.
		1592
		1593	=cut
		1594
		1595	sub destroy {
		1596	my ($self) = @_;
		1597
		1598	$self->DESTROY;
		1599	%$self = ();
		1600	}
		1601
1293	=item AnyEvent::Handle::TLS_CTX	1602	=item AnyEvent::Handle::TLS_CTX
1294		1603
1295	This function creates and returns the Net::SSLeay::CTX object used by	1604	This function creates and returns the AnyEvent::TLS object used by default
1296	default for TLS mode.	1605	for TLS mode.
1297		1606
1298	The context is created like this:	1607	The context is created by calling L<AnyEvent::TLS> without any arguments.
1299
1300	Net::SSLeay::load_error_strings;
1301	Net::SSLeay::SSLeay_add_ssl_algorithms;
1302	Net::SSLeay::randomize;
1303
1304	my $CTX = Net::SSLeay::CTX_new;
1305
1306	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1307		1608
1308	=cut	1609	=cut
1309		1610
1310	our $TLS_CTX;	1611	our $TLS_CTX;
1311		1612
1312	sub TLS_CTX() {	1613	sub TLS_CTX() {
1313	$TLS_CTX \|\| do {	1614	$TLS_CTX \|\|= do {
1314	require Net::SSLeay;	1615	require AnyEvent::TLS;
1315		1616
1316	Net::SSLeay::load_error_strings ();	1617	new AnyEvent::TLS
1317	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1318	Net::SSLeay::randomize ();
1319
1320	$TLS_CTX = Net::SSLeay::CTX_new ();
1321
1322	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1323
1324	$TLS_CTX
1325	}	1618	}
1326	}	1619	}
1327		1620
1328	=back	1621	=back
		1622
		1623
		1624	=head1 NONFREQUENTLY ASKED QUESTIONS
		1625
		1626	=over 4
		1627
		1628	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1629	still get further invocations!
		1630
		1631	That's because AnyEvent::Handle keeps a reference to itself when handling
		1632	read or write callbacks.
		1633
		1634	It is only safe to "forget" the reference inside EOF or error callbacks,
		1635	from within all other callbacks, you need to explicitly call the C<<
		1636	->destroy >> method.
		1637
		1638	=item I get different callback invocations in TLS mode/Why can't I pause
		1639	reading?
		1640
		1641	Unlike, say, TCP, TLS connections do not consist of two independent
		1642	communication channels, one for each direction. Or put differently. The
		1643	read and write directions are not independent of each other: you cannot
		1644	write data unless you are also prepared to read, and vice versa.
		1645
		1646	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1647	callback invocations when you are not expecting any read data - the reason
		1648	is that AnyEvent::Handle always reads in TLS mode.
		1649
		1650	During the connection, you have to make sure that you always have a
		1651	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1652	connection (or when you no longer want to use it) you can call the
		1653	C<destroy> method.
		1654
		1655	=item How do I read data until the other side closes the connection?
		1656
		1657	If you just want to read your data into a perl scalar, the easiest way
		1658	to achieve this is by setting an C<on_read> callback that does nothing,
		1659	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1660	will be in C<$_[0]{rbuf}>:
		1661
		1662	$handle->on_read (sub { });
		1663	$handle->on_eof (undef);
		1664	$handle->on_error (sub {
		1665	my $data = delete $_[0]{rbuf};
		1666	undef $handle;
		1667	});
		1668
		1669	The reason to use C<on_error> is that TCP connections, due to latencies
		1670	and packets loss, might get closed quite violently with an error, when in
		1671	fact, all data has been received.
		1672
		1673	It is usually better to use acknowledgements when transferring data,
		1674	to make sure the other side hasn't just died and you got the data
		1675	intact. This is also one reason why so many internet protocols have an
		1676	explicit QUIT command.
		1677
		1678	=item I don't want to destroy the handle too early - how do I wait until
		1679	all data has been written?
		1680
		1681	After writing your last bits of data, set the C<on_drain> callback
		1682	and destroy the handle in there - with the default setting of
		1683	C<low_water_mark> this will be called precisely when all data has been
		1684	written to the socket:
		1685
		1686	$handle->push_write (...);
		1687	$handle->on_drain (sub {
		1688	warn "all data submitted to the kernel\n";
		1689	undef $handle;
		1690	});
		1691
		1692	=back
		1693
1329		1694
1330	=head1 SUBCLASSING AnyEvent::Handle	1695	=head1 SUBCLASSING AnyEvent::Handle
1331		1696
1332	In many cases, you might want to subclass AnyEvent::Handle.	1697	In many cases, you might want to subclass AnyEvent::Handle.
1333		1698
…		…
1337	=over 4	1702	=over 4
1338		1703
1339	=item * all constructor arguments become object members.	1704	=item * all constructor arguments become object members.
1340		1705
1341	At least initially, when you pass a C<tls>-argument to the constructor it	1706	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	1707	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).	1708	mutated later on (for example C<tls> will hold the TLS connection object).
1344		1709
1345	=item * other object member names are prefixed with an C<_>.	1710	=item * other object member names are prefixed with an C<_>.
1346		1711
1347	All object members not explicitly documented (internal use) are prefixed	1712	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.134 by root, Fri Jul 3 00:09:04 2009 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.134 by root, Fri Jul 3 00:09:04 2009 UTC