[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.146 by root, Wed Jul 8 13:46:46 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.8;
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");
…		…
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
66	=over 4	66	=over 4
67		67
68	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		69
70	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
75		75
…		…
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>.
99		99
100	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal, $message)
101		101
102	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
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
		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<"$!">).
111		116
112	Non-fatal errors can be retried by simply returning, but it is recommended	117	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	118	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	119	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		121
117	On callback entrance, the value of C<$!> contains the operating system	122	On callback entrance, the value of C<$!> contains the operating system
118	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>).
119		125
120	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
121	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
122	C<croak>.	128	C<croak>.
123		129
…		…
127	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
128	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
129	read buffer).	135	read buffer).
130		136
131	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 >>
132	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.
133		141
134	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
135	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
136	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
137	error will be raised (with C<$!> set to C<EPIPE>).	145	error will be raised (with C<$!> set to C<EPIPE>).
…		…
152	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
153		161
154	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
155	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
156	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
157	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
158		166
159	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
160	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
161	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
162	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
163		172
164	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
165		174
166	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
167		176
…		…
171		180
172	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
173		182
174	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>)
175	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
176	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
177		186
178	For example, a server accepting connections from untrusted sources should	187	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	188	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	189	(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	190	amount of data without a callback ever being called as long as the line
182	isn't finished).	191	isn't finished).
183		192
184	=item autocork => <boolean>	193	=item autocork => <boolean>
185		194
186	When disabled (the default), then C<push_write> will try to immediately	195	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	196	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	197	a write watcher and wait for the next event loop iteration, but can
189	inefficient if you write multiple small chunks (this disadvantage is	198	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>).	199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
191		201
192	When enabled, then writes will always be queued till the next event loop	202	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,	203	iteration. This is efficient when you do many small writes per iteration,
194	but less efficient when you do a single write only.	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.
195		206
196	=item no_delay => <boolean>	207	=item no_delay => <boolean>
197		208
198	When doing small writes on sockets, your operating system kernel might	209	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	210	wait a bit for more data before actually sending it out. This is called
200	the Nagle algorithm, and usually it is beneficial.	211	the Nagle algorithm, and usually it is beneficial.
201		212
202	In some situations you want as low a delay as possible, which cna be	213	In some situations you want as low a delay as possible, which can be
203	accomplishd by setting this option to true.	214	accomplishd by setting this option to a true value.
204		215
205	The default is your opertaing system's default behaviour, this option	216	The default is your opertaing system's default behaviour (most likely
206	explicitly enables or disables it, if possible.	217	enabled), this option explicitly enables or disables it, if possible.
207		218
208	=item read_size => <bytes>	219	=item read_size => <bytes>
209		220
210	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
211	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
212		224
213	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
214		226
215	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
216	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
217	considered empty.	229	considered empty.
218		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
219	=item linger => <seconds>	236	=item linger => <seconds>
220		237
221	If non-zero (default: C<3600>), then the destructor of the	238	If non-zero (default: C<3600>), then the destructor of the
222	AnyEvent::Handle object will check wether there is still outstanding write	239	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	240	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	241	socket. No errors will be reported (this mostly matches how the operating
225	outstanding data at socket close time).	242	system treats outstanding data at socket close time).
226		243
227	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
228	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	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		255	verification will be skipped when C<peername> is not specified or
		256	C<undef>.
229		257
230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	258	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
231		259
232	When this parameter is given, it enables TLS (SSL) mode, that means	260	When this parameter is given, it enables TLS (SSL) mode, that means
233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt	261	AnyEvent will start a TLS handshake as soon as the conenction has been
234	data.	262	established and will transparently encrypt/decrypt data afterwards.
		263
		264	All TLS protocol errors will be signalled as C<EPROTO>, with an
		265	appropriate error message.
235		266
236	TLS mode requires Net::SSLeay to be installed (it will be loaded	267	TLS mode requires Net::SSLeay to be installed (it will be loaded
237	automatically when you try to create a TLS handle).	268	automatically when you try to create a TLS handle): this module doesn't
		269	have a dependency on that module, so if your module requires it, you have
		270	to add the dependency yourself.
238		271
239	Unlike TCP, TLS has a server and client side: for the TLS server side, use	272	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>	273	C<accept>, and for the TLS client side of a connection, use C<connect>
241	mode.	274	mode.
242		275
243	You can also provide your own TLS connection object, but you have	276	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>	277	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	278	or C<Net::SSLeay::set_accept_state> on it before you pass it to
246	AnyEvent::Handle.	279	AnyEvent::Handle. Also, this module will take ownership of this connection
		280	object.
247		281
		282	At some future point, AnyEvent::Handle might switch to another TLS
		283	implementation, then the option to use your own session object will go
		284	away.
		285
		286	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		287	passing in the wrong integer will lead to certain crash. This most often
		288	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		289	segmentation fault.
		290
248	See the C<starttls> method for when need to start TLS negotiation later.	291	See the C<< ->starttls >> method for when need to start TLS negotiation later.
249		292
250	=item tls_ctx => $ssl_ctx	293	=item tls_ctx => $anyevent_tls
251		294
252	Use the given Net::SSLeay::CTX object to create the new TLS connection	295	Use the given C<AnyEvent::TLS> object to create the new TLS connection
253	(unless a connection object was specified directly). If this parameter is	296	(unless a connection object was specified directly). If this parameter is
254	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	297	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		298
		299	Instead of an object, you can also specify a hash reference with C<< key
		300	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		301	new TLS context object.
		302
		303	=item on_starttls => $cb->($handle, $success[, $error_message])
		304
		305	This callback will be invoked when the TLS/SSL handshake has finished. If
		306	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		307	(C<on_stoptls> will not be called in this case).
		308
		309	The session in C<< $handle->{tls} >> can still be examined in this
		310	callback, even when the handshake was not successful.
		311
		312	TLS handshake failures will not cause C<on_error> to be invoked when this
		313	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		314
		315	Without this callback, handshake failures lead to C<on_error> being
		316	called, as normal.
		317
		318	Note that you cannot call C<starttls> right again in this callback. If you
		319	need to do that, start an zero-second timer instead whose callback can
		320	then call C<< ->starttls >> again.
		321
		322	=item on_stoptls => $cb->($handle)
		323
		324	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		325	set, then it will be invoked after freeing the TLS session. If it is not,
		326	then a TLS shutdown condition will be treated like a normal EOF condition
		327	on the handle.
		328
		329	The session in C<< $handle->{tls} >> can still be examined in this
		330	callback.
		331
		332	This callback will only be called on TLS shutdowns, not when the
		333	underlying handle signals EOF.
255		334
256	=item json => JSON or JSON::XS object	335	=item json => JSON or JSON::XS object
257		336
258	This is the json coder object used by the C<json> read and write types.	337	This is the json coder object used by the C<json> read and write types.
259		338
…		…
262	texts.	341	texts.
263		342
264	Note that you are responsible to depend on the JSON module if you want to	343	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.	344	use this functionality, as AnyEvent does not have a dependency itself.
266		345
267	=item filter_r => $cb
268
269	=item filter_w => $cb
270
271	These exist, but are undocumented at this time.
272
273	=back	346	=back
274		347
275	=cut	348	=cut
276		349
277	sub new {	350	sub new {
278	my $class = shift;	351	my $class = shift;
279
280	my $self = bless { @_ }, $class;	352	my $self = bless { @_ }, $class;
281		353
282	$self->{fh} or Carp::croak "mandatory argument fh is missing";	354	$self->{fh} or Carp::croak "mandatory argument fh is missing";
283		355
284	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
285
286	if ($self->{tls}) {
287	require Net::SSLeay;
288	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
289	}
290		357
291	$self->{_activity} = AnyEvent->now;	358	$self->{_activity} = AnyEvent->now;
292	$self->_timeout;	359	$self->_timeout;
293		360
294	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
295	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	361	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		362
		363	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		364	if $self->{tls};
		365
		366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
296		367
297	$self->start_read	368	$self->start_read
298	if $self->{on_read};	369	if $self->{on_read};
299		370
300	$self	371	$self->{fh} && $self
301	}	372	}
302		373
303	sub _shutdown {	374	sub _shutdown {
304	my ($self) = @_;	375	my ($self) = @_;
305		376
306	delete $self->{_tw};	377	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
307	delete $self->{_rw};	378	$self->{_eof} = 1; # tell starttls et. al to stop trying
308	delete $self->{_ww};
309	delete $self->{fh};
310		379
311	$self->stoptls;	380	&_freetls;
312
313	delete $self->{on_read};
314	delete $self->{_queue};
315	}	381	}
316		382
317	sub _error {	383	sub _error {
318	my ($self, $errno, $fatal) = @_;	384	my ($self, $errno, $fatal, $message) = @_;
319		385
320	$self->_shutdown	386	$self->_shutdown
321	if $fatal;	387	if $fatal;
322		388
323	$! = $errno;	389	$! = $errno;
		390	$message \|\|= "$!";
324		391
325	if ($self->{on_error}) {	392	if ($self->{on_error}) {
326	$self->{on_error}($self, $fatal);	393	$self->{on_error}($self, $fatal, $message);
327	} else {	394	} elsif ($self->{fh}) {
328	Carp::croak "AnyEvent::Handle uncaught error: $!";	395	Carp::croak "AnyEvent::Handle uncaught error: $message";
329	}	396	}
330	}	397	}
331		398
332	=item $fh = $handle->fh	399	=item $fh = $handle->fh
333		400
334	This method returns the file handle of the L<AnyEvent::Handle> object.	401	This method returns the file handle used to create the L<AnyEvent::Handle> object.
335		402
336	=cut	403	=cut
337		404
338	sub fh { $_[0]{fh} }	405	sub fh { $_[0]{fh} }
339		406
…		…
357	$_[0]{on_eof} = $_[1];	424	$_[0]{on_eof} = $_[1];
358	}	425	}
359		426
360	=item $handle->on_timeout ($cb)	427	=item $handle->on_timeout ($cb)
361		428
362	Replace the current C<on_timeout> callback, or disables the callback	429	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	430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
364	argument.	431	argument and method.
365		432
366	=cut	433	=cut
367		434
368	sub on_timeout {	435	sub on_timeout {
369	$_[0]{on_timeout} = $_[1];	436	$_[0]{on_timeout} = $_[1];
370	}	437	}
371		438
372	=item $handle->autocork ($boolean)	439	=item $handle->autocork ($boolean)
373		440
374	Enables or disables the current autocork behaviour (see C<autocork>	441	Enables or disables the current autocork behaviour (see C<autocork>
375	constructor argument).	442	constructor argument). Changes will only take effect on the next write.
376		443
377	=cut	444	=cut
		445
		446	sub autocork {
		447	$_[0]{autocork} = $_[1];
		448	}
378		449
379	=item $handle->no_delay ($boolean)	450	=item $handle->no_delay ($boolean)
380		451
381	Enables or disables the C<no_delay> setting (see constructor argument of	452	Enables or disables the C<no_delay> setting (see constructor argument of
382	the same name for details).	453	the same name for details).
…		…
388		459
389	eval {	460	eval {
390	local $SIG{__DIE__};	461	local $SIG{__DIE__};
391	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
392	};	463	};
		464	}
		465
		466	=item $handle->on_starttls ($cb)
		467
		468	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		469
		470	=cut
		471
		472	sub on_starttls {
		473	$_[0]{on_starttls} = $_[1];
		474	}
		475
		476	=item $handle->on_stoptls ($cb)
		477
		478	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		479
		480	=cut
		481
		482	sub on_starttls {
		483	$_[0]{on_stoptls} = $_[1];
393	}	484	}
394		485
395	#############################################################################	486	#############################################################################
396		487
397	=item $handle->timeout ($seconds)	488	=item $handle->timeout ($seconds)
…		…
475	my ($self, $cb) = @_;	566	my ($self, $cb) = @_;
476		567
477	$self->{on_drain} = $cb;	568	$self->{on_drain} = $cb;
478		569
479	$cb->($self)	570	$cb->($self)
480	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	571	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
481	}	572	}
482		573
483	=item $handle->push_write ($data)	574	=item $handle->push_write ($data)
484		575
485	Queues the given scalar to be written. You can push as much data as you	576	Queues the given scalar to be written. You can push as much data as you
…		…
496	Scalar::Util::weaken $self;	587	Scalar::Util::weaken $self;
497		588
498	my $cb = sub {	589	my $cb = sub {
499	my $len = syswrite $self->{fh}, $self->{wbuf};	590	my $len = syswrite $self->{fh}, $self->{wbuf};
500		591
501	if ($len >= 0) {	592	if (defined $len) {
502	substr $self->{wbuf}, 0, $len, "";	593	substr $self->{wbuf}, 0, $len, "";
503		594
504	$self->{_activity} = AnyEvent->now;	595	$self->{_activity} = AnyEvent->now;
505		596
506	$self->{on_drain}($self)	597	$self->{on_drain}($self)
507	if $self->{low_water_mark} >= length $self->{wbuf}	598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
508	&& $self->{on_drain};	599	&& $self->{on_drain};
509		600
510	delete $self->{_ww} unless length $self->{wbuf};	601	delete $self->{_ww} unless length $self->{wbuf};
511	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	602	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
512	$self->_error ($!, 1);	603	$self->_error ($!, 1);
…		…
536		627
537	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	628	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
538	->($self, @_);	629	->($self, @_);
539	}	630	}
540		631
541	if ($self->{filter_w}) {	632	if ($self->{tls}) {
542	$self->{filter_w}($self, \$_[0]);	633	$self->{_tls_wbuf} .= $_[0];
		634
		635	&_dotls ($self);
543	} else {	636	} else {
544	$self->{wbuf} .= $_[0];	637	$self->{wbuf} .= $_[0];
545	$self->_drain_wbuf;	638	$self->_drain_wbuf;
546	}	639	}
547	}	640	}
…		…
564	=cut	657	=cut
565		658
566	register_write_type netstring => sub {	659	register_write_type netstring => sub {
567	my ($self, $string) = @_;	660	my ($self, $string) = @_;
568		661
569	sprintf "%d:%s,", (length $string), $string	662	(length $string) . ":$string,"
570	};	663	};
571		664
572	=item packstring => $format, $data	665	=item packstring => $format, $data
573		666
574	An octet string prefixed with an encoded length. The encoding C<$format>	667	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
639		732
640	pack "w/a*", Storable::nfreeze ($ref)	733	pack "w/a*", Storable::nfreeze ($ref)
641	};	734	};
642		735
643	=back	736	=back
		737
		738	=item $handle->push_shutdown
		739
		740	Sometimes you know you want to close the socket after writing your data
		741	before it was actually written. One way to do that is to replace your
		742	C<on_drain> handler by a callback that shuts down the socket (and set
		743	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		744	replaces the C<on_drain> callback with:
		745
		746	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		747
		748	This simply shuts down the write side and signals an EOF condition to the
		749	the peer.
		750
		751	You can rely on the normal read queue and C<on_eof> handling
		752	afterwards. This is the cleanest way to close a connection.
		753
		754	=cut
		755
		756	sub push_shutdown {
		757	my ($self) = @_;
		758
		759	delete $self->{low_water_mark};
		760	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		761	}
644		762
645	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	763	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
646		764
647	This function (not method) lets you add your own types to C<push_write>.	765	This function (not method) lets you add your own types to C<push_write>.
648	Whenever the given C<type> is used, C<push_write> will invoke the code	766	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
752	) {	870	) {
753	$self->_error (&Errno::ENOSPC, 1), return;	871	$self->_error (&Errno::ENOSPC, 1), return;
754	}	872	}
755		873
756	while () {	874	while () {
		875	# we need to use a separate tls read buffer, as we must not receive data while
		876	# we are draining the buffer, and this can only happen with TLS.
		877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		878
757	my $len = length $self->{rbuf};	879	my $len = length $self->{rbuf};
758		880
759	if (my $cb = shift @{ $self->{_queue} }) {	881	if (my $cb = shift @{ $self->{_queue} }) {
760	unless ($cb->($self)) {	882	unless ($cb->($self)) {
761	if ($self->{_eof}) {	883	if ($self->{_eof}) {
…		…
783		905
784	last; # more data might arrive	906	last; # more data might arrive
785	}	907	}
786	} else {	908	} else {
787	# read side becomes idle	909	# read side becomes idle
788	delete $self->{_rw};	910	delete $self->{_rw} unless $self->{tls};
789	last;	911	last;
790	}	912	}
791	}	913	}
792		914
793	if ($self->{_eof}) {	915	if ($self->{_eof}) {
794	if ($self->{on_eof}) {	916	if ($self->{on_eof}) {
795	$self->{on_eof}($self)	917	$self->{on_eof}($self)
796	} else {	918	} else {
797	$self->_error (0, 1);	919	$self->_error (0, 1, "Unexpected end-of-file");
798	}	920	}
799	}	921	}
800		922
801	# may need to restart read watcher	923	# may need to restart read watcher
802	unless ($self->{_rw}) {	924	unless ($self->{_rw}) {
…		…
822		944
823	=item $handle->rbuf	945	=item $handle->rbuf
824		946
825	Returns the read buffer (as a modifiable lvalue).	947	Returns the read buffer (as a modifiable lvalue).
826		948
827	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	949	You can access the read buffer directly as the C<< ->{rbuf} >>
828	you want.	950	member, if you want. However, the only operation allowed on the
		951	read buffer (apart from looking at it) is removing data from its
		952	beginning. Otherwise modifying or appending to it is not allowed and will
		953	lead to hard-to-track-down bugs.
829		954
830	NOTE: The read buffer should only be used or modified if the C<on_read>,	955	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	956	C<push_read> or C<unshift_read> methods are used. The other read methods
832	automatically manage the read buffer.	957	automatically manage the read buffer.
833		958
…		…
1088	An octet string prefixed with an encoded length. The encoding C<$format>	1213	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	1214	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	1215	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1091	optional C<!>, C<< < >> or C<< > >> modifier).	1216	optional C<!>, C<< < >> or C<< > >> modifier).
1092		1217
1093	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1218	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1219	EPP uses a prefix of C<N> (4 octtes).
1094		1220
1095	Example: read a block of data prefixed by its length in BER-encoded	1221	Example: read a block of data prefixed by its length in BER-encoded
1096	format (very efficient).	1222	format (very efficient).
1097		1223
1098	$handle->push_read (packstring => "w", sub {	1224	$handle->push_read (packstring => "w", sub {
…		…
1128	}	1254	}
1129	};	1255	};
1130		1256
1131	=item json => $cb->($handle, $hash_or_arrayref)	1257	=item json => $cb->($handle, $hash_or_arrayref)
1132		1258
1133	Reads a JSON object or array, decodes it and passes it to the callback.	1259	Reads a JSON object or array, decodes it and passes it to the
		1260	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1134		1261
1135	If a C<json> object was passed to the constructor, then that will be used	1262	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.	1263	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1137		1264
1138	This read type uses the incremental parser available with JSON version	1265	This read type uses the incremental parser available with JSON version
…		…
1147	=cut	1274	=cut
1148		1275
1149	register_read_type json => sub {	1276	register_read_type json => sub {
1150	my ($self, $cb) = @_;	1277	my ($self, $cb) = @_;
1151		1278
1152	require JSON;	1279	my $json = $self->{json} \|\|=
		1280	eval { require JSON::XS; JSON::XS->new->utf8 }
		1281	\|\| do { require JSON; JSON->new->utf8 };
1153		1282
1154	my $data;	1283	my $data;
1155	my $rbuf = \$self->{rbuf};	1284	my $rbuf = \$self->{rbuf};
1156		1285
1157	my $json = $self->{json} \|\|= JSON->new->utf8;
1158
1159	sub {	1286	sub {
1160	my $ref = $json->incr_parse ($self->{rbuf});	1287	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1161		1288
1162	if ($ref) {	1289	if ($ref) {
1163	$self->{rbuf} = $json->incr_text;	1290	$self->{rbuf} = $json->incr_text;
1164	$json->incr_text = "";	1291	$json->incr_text = "";
1165	$cb->($self, $ref);	1292	$cb->($self, $ref);
1166		1293
1167	1	1294	1
		1295	} elsif ($@) {
		1296	# error case
		1297	$json->incr_skip;
		1298
		1299	$self->{rbuf} = $json->incr_text;
		1300	$json->incr_text = "";
		1301
		1302	$self->_error (&Errno::EBADMSG);
		1303
		1304	()
1168	} else {	1305	} else {
1169	$self->{rbuf} = "";	1306	$self->{rbuf} = "";
		1307
1170	()	1308	()
1171	}	1309	}
1172	}	1310	}
1173	};	1311	};
1174		1312
…		…
1251	Note that AnyEvent::Handle will automatically C<start_read> for you when	1389	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	1390	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	1391	will automatically C<stop_read> for you when neither C<on_read> is set nor
1254	there are any read requests in the queue.	1392	there are any read requests in the queue.
1255		1393
		1394	These methods will have no effect when in TLS mode (as TLS doesn't support
		1395	half-duplex connections).
		1396
1256	=cut	1397	=cut
1257		1398
1258	sub stop_read {	1399	sub stop_read {
1259	my ($self) = @_;	1400	my ($self) = @_;
1260		1401
1261	delete $self->{_rw};	1402	delete $self->{_rw} unless $self->{tls};
1262	}	1403	}
1263		1404
1264	sub start_read {	1405	sub start_read {
1265	my ($self) = @_;	1406	my ($self) = @_;
1266		1407
1267	unless ($self->{_rw} \|\| $self->{_eof}) {	1408	unless ($self->{_rw} \|\| $self->{_eof}) {
1268	Scalar::Util::weaken $self;	1409	Scalar::Util::weaken $self;
1269		1410
1270	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1271	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1272	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1273		1414
1274	if ($len > 0) {	1415	if ($len > 0) {
1275	$self->{_activity} = AnyEvent->now;	1416	$self->{_activity} = AnyEvent->now;
1276		1417
1277	$self->{filter_r}	1418	if ($self->{tls}) {
1278	? $self->{filter_r}($self, $rbuf)	1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1279	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1420
		1421	&_dotls ($self);
		1422	} else {
		1423	$self->_drain_rbuf unless $self->{_in_drain};
		1424	}
1280		1425
1281	} elsif (defined $len) {	1426	} elsif (defined $len) {
1282	delete $self->{_rw};	1427	delete $self->{_rw};
1283	$self->{_eof} = 1;	1428	$self->{_eof} = 1;
1284	$self->_drain_rbuf unless $self->{_in_drain};	1429	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1288	}	1433	}
1289	});	1434	});
1290	}	1435	}
1291	}	1436	}
1292		1437
		1438	our $ERROR_SYSCALL;
		1439	our $ERROR_WANT_READ;
		1440
		1441	sub _tls_error {
		1442	my ($self, $err) = @_;
		1443
		1444	return $self->_error ($!, 1)
		1445	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1446
		1447	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1448
		1449	# reduce error string to look less scary
		1450	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1451
		1452	if ($self->{_on_starttls}) {
		1453	(delete $self->{_on_starttls})->($self, undef, $err);
		1454	&_freetls;
		1455	} else {
		1456	&_freetls;
		1457	$self->_error (&Errno::EPROTO, 1, $err);
		1458	}
		1459	}
		1460
		1461	# poll the write BIO and send the data if applicable
		1462	# also decode read data if possible
		1463	# this is basiclaly our TLS state machine
		1464	# more efficient implementations are possible with openssl,
		1465	# but not with the buggy and incomplete Net::SSLeay.
1293	sub _dotls {	1466	sub _dotls {
1294	my ($self) = @_;	1467	my ($self) = @_;
1295		1468
1296	my $buf;	1469	my $tmp;
1297		1470
1298	if (length $self->{_tls_wbuf}) {	1471	if (length $self->{_tls_wbuf}) {
1299	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1472	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1300	substr $self->{_tls_wbuf}, 0, $len, "";	1473	substr $self->{_tls_wbuf}, 0, $tmp, "";
1301	}	1474	}
1302	}
1303		1475
		1476	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1477	return $self->_tls_error ($tmp)
		1478	if $tmp != $ERROR_WANT_READ
		1479	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1480	}
		1481
		1482	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1483	unless (length $tmp) {
		1484	$self->{_on_starttls}
		1485	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1486	&_freetls;
		1487
		1488	if ($self->{on_stoptls}) {
		1489	$self->{on_stoptls}($self);
		1490	return;
		1491	} else {
		1492	# let's treat SSL-eof as we treat normal EOF
		1493	delete $self->{_rw};
		1494	$self->{_eof} = 1;
		1495	}
		1496	}
		1497
		1498	$self->{_tls_rbuf} .= $tmp;
		1499	$self->_drain_rbuf unless $self->{_in_drain};
		1500	$self->{tls} or return; # tls session might have gone away in callback
		1501	}
		1502
		1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1504	return $self->_tls_error ($tmp)
		1505	if $tmp != $ERROR_WANT_READ
		1506	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1507
1304	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1508	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1305	$self->{wbuf} .= $buf;	1509	$self->{wbuf} .= $tmp;
1306	$self->_drain_wbuf;	1510	$self->_drain_wbuf;
1307	}	1511	}
1308		1512
1309	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1513	$self->{_on_starttls}
1310	if (length $buf) {	1514	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1311	$self->{rbuf} .= $buf;	1515	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1312	$self->_drain_rbuf unless $self->{_in_drain};
1313	} else {
1314	# let's treat SSL-eof as we treat normal EOF
1315	$self->{_eof} = 1;
1316	$self->_shutdown;
1317	return;
1318	}
1319	}
1320
1321	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1322
1323	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1324	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1325	return $self->_error ($!, 1);
1326	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1327	return $self->_error (&Errno::EIO, 1);
1328	}
1329
1330	# all others are fine for our purposes
1331	}
1332	}	1516	}
1333		1517
1334	=item $handle->starttls ($tls[, $tls_ctx])	1518	=item $handle->starttls ($tls[, $tls_ctx])
1335		1519
1336	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1338	C<starttls>.	1522	C<starttls>.
1339		1523
1340	The first argument is the same as the C<tls> constructor argument (either	1524	The first argument is the same as the C<tls> constructor argument (either
1341	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1342		1526
1343	The second argument is the optional C<Net::SSLeay::CTX> object that is	1527	The second argument is the optional C<AnyEvent::TLS> object that is used
1344	used when AnyEvent::Handle has to create its own TLS connection object.	1528	when AnyEvent::Handle has to create its own TLS connection object, or
		1529	a hash reference with C<< key => value >> pairs that will be used to
		1530	construct a new context.
1345		1531
1346	The TLS connection object will end up in C<< $handle->{tls} >> after this	1532	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1347	call and can be used or changed to your liking. Note that the handshake	1533	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1348	might have already started when this function returns.	1534	changed to your liking. Note that the handshake might have already started
		1535	when this function returns.
1349		1536
		1537	If it an error to start a TLS handshake more than once per
		1538	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1539
1350	=cut	1540	=cut
		1541
		1542	our %TLS_CACHE; #TODO not yet documented, should we?
1351		1543
1352	sub starttls {	1544	sub starttls {
1353	my ($self, $ssl, $ctx) = @_;	1545	my ($self, $ssl, $ctx) = @_;
1354		1546
1355	$self->stoptls;	1547	require Net::SSLeay;
1356		1548
1357	if ($ssl eq "accept") {	1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1358	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1550	if $self->{tls};
1359	Net::SSLeay::set_accept_state ($ssl);	1551
1360	} elsif ($ssl eq "connect") {	1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1361	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1362	Net::SSLeay::set_connect_state ($ssl);	1554
		1555	$ctx \|\|= $self->{tls_ctx};
		1556
		1557	if ("HASH" eq ref $ctx) {
		1558	require AnyEvent::TLS;
		1559
		1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1561
		1562	if ($ctx->{cache}) {
		1563	my $key = $ctx+0;
		1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1565	} else {
		1566	$ctx = new AnyEvent::TLS %$ctx;
		1567	}
		1568	}
1363	}	1569
1364		1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1365	$self->{tls} = $ssl;	1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1366		1572
1367	# basically, this is deep magic (because SSL_read should have the same issues)	1573	# 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".	1574	# but the openssl maintainers basically said: "trust us, it just works".
1369	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1370	# and mismaintained ssleay-module doesn't even offer them).	1576	# and mismaintained ssleay-module doesn't even offer them).
1371	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1577	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1578	#
		1579	# in short: this is a mess.
		1580	#
		1581	# note that we do not try to keep the length constant between writes as we are required to do.
		1582	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1583	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1584	# have identity issues in that area.
1372	Net::SSLeay::CTX_set_mode ($self->{tls},	1585	# Net::SSLeay::CTX_set_mode ($ssl,
1373	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1374	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1587	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1375		1589
1376	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1377	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1378		1592
1379	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1380		1594
1381	$self->{filter_w} = sub {	1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1382	$_[0]{_tls_wbuf} .= ${$_[1]};	1596	if $self->{on_starttls};
1383	&_dotls;	1597
1384	};	1598	&_dotls; # need to trigger the initial handshake
1385	$self->{filter_r} = sub {	1599	$self->start_read; # make sure we actually do read
1386	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1387	&_dotls;
1388	};
1389	}	1600	}
1390		1601
1391	=item $handle->stoptls	1602	=item $handle->stoptls
1392		1603
1393	Destroys the SSL connection, if any. Partial read or write data will be	1604	Shuts down the SSL connection - this makes a proper EOF handshake by
1394	lost.	1605	sending a close notify to the other side, but since OpenSSL doesn't
		1606	support non-blocking shut downs, it is not possible to re-use the stream
		1607	afterwards.
1395		1608
1396	=cut	1609	=cut
1397		1610
1398	sub stoptls {	1611	sub stoptls {
1399	my ($self) = @_;	1612	my ($self) = @_;
1400		1613
1401	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1614	if ($self->{tls}) {
		1615	Net::SSLeay::shutdown ($self->{tls});
1402		1616
1403	delete $self->{_rbio};	1617	&_dotls;
1404	delete $self->{_wbio};	1618
1405	delete $self->{_tls_wbuf};	1619	# # we don't give a shit. no, we do, but we can't. no...#d#
1406	delete $self->{filter_r};	1620	# # we, we... have to use openssl :/#d#
1407	delete $self->{filter_w};	1621	# &_freetls;#d#
		1622	}
		1623	}
		1624
		1625	sub _freetls {
		1626	my ($self) = @_;
		1627
		1628	return unless $self->{tls};
		1629
		1630	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1631
		1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1408	}	1633	}
1409		1634
1410	sub DESTROY {	1635	sub DESTROY {
1411	my $self = shift;	1636	my ($self) = @_;
1412		1637
1413	$self->stoptls;	1638	&_freetls;
1414		1639
1415	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1416		1641
1417	if ($linger && length $self->{wbuf}) {	1642	if ($linger && length $self->{wbuf}) {
1418	my $fh = delete $self->{fh};	1643	my $fh = delete $self->{fh};
…		…
1433	@linger = ();	1658	@linger = ();
1434	});	1659	});
1435	}	1660	}
1436	}	1661	}
1437		1662
		1663	=item $handle->destroy
		1664
		1665	Shuts down the handle object as much as possible - this call ensures that
		1666	no further callbacks will be invoked and as many resources as possible
		1667	will be freed. You must not call any methods on the object afterwards.
		1668
		1669	Normally, you can just "forget" any references to an AnyEvent::Handle
		1670	object and it will simply shut down. This works in fatal error and EOF
		1671	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1672	callback, so when you want to destroy the AnyEvent::Handle object from
		1673	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1674	that case.
		1675
		1676	The handle might still linger in the background and write out remaining
		1677	data, as specified by the C<linger> option, however.
		1678
		1679	=cut
		1680
		1681	sub destroy {
		1682	my ($self) = @_;
		1683
		1684	$self->DESTROY;
		1685	%$self = ();
		1686	}
		1687
1438	=item AnyEvent::Handle::TLS_CTX	1688	=item AnyEvent::Handle::TLS_CTX
1439		1689
1440	This function creates and returns the Net::SSLeay::CTX object used by	1690	This function creates and returns the AnyEvent::TLS object used by default
1441	default for TLS mode.	1691	for TLS mode.
1442		1692
1443	The context is created like this:	1693	The context is created by calling L<AnyEvent::TLS> without any arguments.
1444
1445	Net::SSLeay::load_error_strings;
1446	Net::SSLeay::SSLeay_add_ssl_algorithms;
1447	Net::SSLeay::randomize;
1448
1449	my $CTX = Net::SSLeay::CTX_new;
1450
1451	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1452		1694
1453	=cut	1695	=cut
1454		1696
1455	our $TLS_CTX;	1697	our $TLS_CTX;
1456		1698
1457	sub TLS_CTX() {	1699	sub TLS_CTX() {
1458	$TLS_CTX \|\| do {	1700	$TLS_CTX \|\|= do {
1459	require Net::SSLeay;	1701	require AnyEvent::TLS;
1460		1702
1461	Net::SSLeay::load_error_strings ();	1703	new AnyEvent::TLS
1462	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1463	Net::SSLeay::randomize ();
1464
1465	$TLS_CTX = Net::SSLeay::CTX_new ();
1466
1467	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1468
1469	$TLS_CTX
1470	}	1704	}
1471	}	1705	}
1472		1706
1473	=back	1707	=back
		1708
		1709
		1710	=head1 NONFREQUENTLY ASKED QUESTIONS
		1711
		1712	=over 4
		1713
		1714	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1715	still get further invocations!
		1716
		1717	That's because AnyEvent::Handle keeps a reference to itself when handling
		1718	read or write callbacks.
		1719
		1720	It is only safe to "forget" the reference inside EOF or error callbacks,
		1721	from within all other callbacks, you need to explicitly call the C<<
		1722	->destroy >> method.
		1723
		1724	=item I get different callback invocations in TLS mode/Why can't I pause
		1725	reading?
		1726
		1727	Unlike, say, TCP, TLS connections do not consist of two independent
		1728	communication channels, one for each direction. Or put differently. The
		1729	read and write directions are not independent of each other: you cannot
		1730	write data unless you are also prepared to read, and vice versa.
		1731
		1732	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1733	callback invocations when you are not expecting any read data - the reason
		1734	is that AnyEvent::Handle always reads in TLS mode.
		1735
		1736	During the connection, you have to make sure that you always have a
		1737	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1738	connection (or when you no longer want to use it) you can call the
		1739	C<destroy> method.
		1740
		1741	=item How do I read data until the other side closes the connection?
		1742
		1743	If you just want to read your data into a perl scalar, the easiest way
		1744	to achieve this is by setting an C<on_read> callback that does nothing,
		1745	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1746	will be in C<$_[0]{rbuf}>:
		1747
		1748	$handle->on_read (sub { });
		1749	$handle->on_eof (undef);
		1750	$handle->on_error (sub {
		1751	my $data = delete $_[0]{rbuf};
		1752	undef $handle;
		1753	});
		1754
		1755	The reason to use C<on_error> is that TCP connections, due to latencies
		1756	and packets loss, might get closed quite violently with an error, when in
		1757	fact, all data has been received.
		1758
		1759	It is usually better to use acknowledgements when transferring data,
		1760	to make sure the other side hasn't just died and you got the data
		1761	intact. This is also one reason why so many internet protocols have an
		1762	explicit QUIT command.
		1763
		1764	=item I don't want to destroy the handle too early - how do I wait until
		1765	all data has been written?
		1766
		1767	After writing your last bits of data, set the C<on_drain> callback
		1768	and destroy the handle in there - with the default setting of
		1769	C<low_water_mark> this will be called precisely when all data has been
		1770	written to the socket:
		1771
		1772	$handle->push_write (...);
		1773	$handle->on_drain (sub {
		1774	warn "all data submitted to the kernel\n";
		1775	undef $handle;
		1776	});
		1777
		1778	If you just want to queue some data and then signal EOF to the other side,
		1779	consider using C<< ->push_shutdown >> instead.
		1780
		1781	=item I want to contact a TLS/SSL server, I don't care about security.
		1782
		1783	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1784	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1785	parameter:
		1786
		1787	tcp_connect $host, $port, sub {
		1788	my ($fh) = @_;
		1789
		1790	my $handle = new AnyEvent::Handle
		1791	fh => $fh,
		1792	tls => "connect",
		1793	on_error => sub { ... };
		1794
		1795	$handle->push_write (...);
		1796	};
		1797
		1798	=item I want to contact a TLS/SSL server, I do care about security.
		1799
		1800	Then you should additionally enable certificate verification, including
		1801	peername verification, if the protocol you use supports it (see
		1802	L<AnyEvent::TLS>, C<verify_peername>).
		1803
		1804	E.g. for HTTPS:
		1805
		1806	tcp_connect $host, $port, sub {
		1807	my ($fh) = @_;
		1808
		1809	my $handle = new AnyEvent::Handle
		1810	fh => $fh,
		1811	peername => $host,
		1812	tls => "connect",
		1813	tls_ctx => { verify => 1, verify_peername => "https" },
		1814	...
		1815
		1816	Note that you must specify the hostname you connected to (or whatever
		1817	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1818	peername verification will be done.
		1819
		1820	The above will use the system-dependent default set of trusted CA
		1821	certificates. If you want to check against a specific CA, add the
		1822	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1823
		1824	tls_ctx => {
		1825	verify => 1,
		1826	verify_peername => "https",
		1827	ca_file => "my-ca-cert.pem",
		1828	},
		1829
		1830	=item I want to create a TLS/SSL server, how do I do that?
		1831
		1832	Well, you first need to get a server certificate and key. You have
		1833	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1834	self-signed certificate (cheap. check the search engine of your choice,
		1835	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1836	nice program for that purpose).
		1837
		1838	Then create a file with your private key (in PEM format, see
		1839	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1840	file should then look like this:
		1841
		1842	-----BEGIN RSA PRIVATE KEY-----
		1843	...header data
		1844	... lots of base64'y-stuff
		1845	-----END RSA PRIVATE KEY-----
		1846
		1847	-----BEGIN CERTIFICATE-----
		1848	... lots of base64'y-stuff
		1849	-----END CERTIFICATE-----
		1850
		1851	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1852	specify this file as C<cert_file>:
		1853
		1854	tcp_server undef, $port, sub {
		1855	my ($fh) = @_;
		1856
		1857	my $handle = new AnyEvent::Handle
		1858	fh => $fh,
		1859	tls => "accept",
		1860	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1861	...
		1862
		1863	When you have intermediate CA certificates that your clients might not
		1864	know about, just append them to the C<cert_file>.
		1865
		1866	=back
		1867
1474		1868
1475	=head1 SUBCLASSING AnyEvent::Handle	1869	=head1 SUBCLASSING AnyEvent::Handle
1476		1870
1477	In many cases, you might want to subclass AnyEvent::Handle.	1871	In many cases, you might want to subclass AnyEvent::Handle.
1478		1872

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.146 by root, Wed Jul 8 13:46:46 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.146 by root, Wed Jul 8 13:46:46 2009 UTC