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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC vs.
Revision 1.143 by root, Mon Jul 6 21:02:34 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.452;
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>).
229		255
230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
231		257
232	When this parameter is given, it enables TLS (SSL) mode, that means	258	When this parameter is given, it enables TLS (SSL) mode, that means
233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt	259	AnyEvent will start a TLS handshake as soon as the conenction has been
234	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.
235		264
236	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
237	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.
238		269
239	Unlike TCP, TLS has a server and client side: for the TLS server side, use	270	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>	271	C<accept>, and for the TLS client side of a connection, use C<connect>
241	mode.	272	mode.
242		273
243	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
244	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>
245	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
246	AnyEvent::Handle.	277	AnyEvent::Handle. Also, this module will take ownership of this connection
		278	object.
247		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
248	See the C<starttls> method for when need to start TLS negotiation later.	289	See the C<< ->starttls >> method for when need to start TLS negotiation later.
249		290
250	=item tls_ctx => $ssl_ctx	291	=item tls_ctx => $anyevent_tls
251		292
252	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
253	(unless a connection object was specified directly). If this parameter is	294	(unless a connection object was specified directly). If this parameter is
254	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	295	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		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
		301	=item on_starttls => $cb->($handle, $success[, $error_message])
		302
		303	This callback will be invoked when the TLS/SSL handshake has finished. If
		304	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		305	(C<on_stoptls> will not be called in this case).
		306
		307	The session in C<< $handle->{tls} >> can still be examined in this
		308	callback, even when the handshake was not successful.
		309
		310	TLS handshake failures will not cause C<on_error> to be invoked when this
		311	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		312
		313	Without this callback, handshake failures lead to C<on_error> being
		314	called, as normal.
		315
		316	Note that you cannot call C<starttls> right again in this callback. If you
		317	need to do that, start an zero-second timer instead whose callback can
		318	then call C<< ->starttls >> again.
		319
		320	=item on_stoptls => $cb->($handle)
		321
		322	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		323	set, then it will be invoked after freeing the TLS session. If it is not,
		324	then a TLS shutdown condition will be treated like a normal EOF condition
		325	on the handle.
		326
		327	The session in C<< $handle->{tls} >> can still be examined in this
		328	callback.
		329
		330	This callback will only be called on TLS shutdowns, not when the
		331	underlying handle signals EOF.
255		332
256	=item json => JSON or JSON::XS object	333	=item json => JSON or JSON::XS object
257		334
258	This is the json coder object used by the C<json> read and write types.	335	This is the json coder object used by the C<json> read and write types.
259		336
…		…
262	texts.	339	texts.
263		340
264	Note that you are responsible to depend on the JSON module if you want to	341	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.	342	use this functionality, as AnyEvent does not have a dependency itself.
266		343
267	=item filter_r => $cb
268
269	=item filter_w => $cb
270
271	These exist, but are undocumented at this time. (They are used internally
272	by the TLS code).
273
274	=back	344	=back
275		345
276	=cut	346	=cut
277		347
278	sub new {	348	sub new {
279	my $class = shift;	349	my $class = shift;
280
281	my $self = bless { @_ }, $class;	350	my $self = bless { @_ }, $class;
282		351
283	$self->{fh} or Carp::croak "mandatory argument fh is missing";	352	$self->{fh} or Carp::croak "mandatory argument fh is missing";
284		353
285	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	354	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
286
287	if ($self->{tls}) {
288	require Net::SSLeay;
289	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
290	}
291		355
292	$self->{_activity} = AnyEvent->now;	356	$self->{_activity} = AnyEvent->now;
293	$self->_timeout;	357	$self->_timeout;
294		358
295	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
296	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	359	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		360
		361	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		362	if $self->{tls};
		363
		364	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
297		365
298	$self->start_read	366	$self->start_read
299	if $self->{on_read};	367	if $self->{on_read};
300		368
301	$self	369	$self->{fh} && $self
302	}	370	}
303		371
304	sub _shutdown {	372	sub _shutdown {
305	my ($self) = @_;	373	my ($self) = @_;
306		374
307	delete $self->{_tw};	375	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
308	delete $self->{_rw};	376	$self->{_eof} = 1; # tell starttls et. al to stop trying
309	delete $self->{_ww};
310	delete $self->{fh};
311		377
312	$self->stoptls;	378	&_freetls;
313
314	delete $self->{on_read};
315	delete $self->{_queue};
316	}	379	}
317		380
318	sub _error {	381	sub _error {
319	my ($self, $errno, $fatal) = @_;	382	my ($self, $errno, $fatal, $message) = @_;
320		383
321	$self->_shutdown	384	$self->_shutdown
322	if $fatal;	385	if $fatal;
323		386
324	$! = $errno;	387	$! = $errno;
		388	$message \|\|= "$!";
325		389
326	if ($self->{on_error}) {	390	if ($self->{on_error}) {
327	$self->{on_error}($self, $fatal);	391	$self->{on_error}($self, $fatal, $message);
328	} else {	392	} elsif ($self->{fh}) {
329	Carp::croak "AnyEvent::Handle uncaught error: $!";	393	Carp::croak "AnyEvent::Handle uncaught error: $message";
330	}	394	}
331	}	395	}
332		396
333	=item $fh = $handle->fh	397	=item $fh = $handle->fh
334		398
335	This method returns the file handle of the L<AnyEvent::Handle> object.	399	This method returns the file handle used to create the L<AnyEvent::Handle> object.
336		400
337	=cut	401	=cut
338		402
339	sub fh { $_[0]{fh} }	403	sub fh { $_[0]{fh} }
340		404
…		…
358	$_[0]{on_eof} = $_[1];	422	$_[0]{on_eof} = $_[1];
359	}	423	}
360		424
361	=item $handle->on_timeout ($cb)	425	=item $handle->on_timeout ($cb)
362		426
363	Replace the current C<on_timeout> callback, or disables the callback	427	Replace the current C<on_timeout> callback, or disables the callback (but
364	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	428	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
365	argument.	429	argument and method.
366		430
367	=cut	431	=cut
368		432
369	sub on_timeout {	433	sub on_timeout {
370	$_[0]{on_timeout} = $_[1];	434	$_[0]{on_timeout} = $_[1];
371	}	435	}
372		436
373	=item $handle->autocork ($boolean)	437	=item $handle->autocork ($boolean)
374		438
375	Enables or disables the current autocork behaviour (see C<autocork>	439	Enables or disables the current autocork behaviour (see C<autocork>
376	constructor argument).	440	constructor argument). Changes will only take effect on the next write.
377		441
378	=cut	442	=cut
		443
		444	sub autocork {
		445	$_[0]{autocork} = $_[1];
		446	}
379		447
380	=item $handle->no_delay ($boolean)	448	=item $handle->no_delay ($boolean)
381		449
382	Enables or disables the C<no_delay> setting (see constructor argument of	450	Enables or disables the C<no_delay> setting (see constructor argument of
383	the same name for details).	451	the same name for details).
…		…
389		457
390	eval {	458	eval {
391	local $SIG{__DIE__};	459	local $SIG{__DIE__};
392	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
393	};	461	};
		462	}
		463
		464	=item $handle->on_starttls ($cb)
		465
		466	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		467
		468	=cut
		469
		470	sub on_starttls {
		471	$_[0]{on_starttls} = $_[1];
		472	}
		473
		474	=item $handle->on_stoptls ($cb)
		475
		476	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		477
		478	=cut
		479
		480	sub on_starttls {
		481	$_[0]{on_stoptls} = $_[1];
394	}	482	}
395		483
396	#############################################################################	484	#############################################################################
397		485
398	=item $handle->timeout ($seconds)	486	=item $handle->timeout ($seconds)
…		…
476	my ($self, $cb) = @_;	564	my ($self, $cb) = @_;
477		565
478	$self->{on_drain} = $cb;	566	$self->{on_drain} = $cb;
479		567
480	$cb->($self)	568	$cb->($self)
481	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	569	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
482	}	570	}
483		571
484	=item $handle->push_write ($data)	572	=item $handle->push_write ($data)
485		573
486	Queues the given scalar to be written. You can push as much data as you	574	Queues the given scalar to be written. You can push as much data as you
…		…
503	substr $self->{wbuf}, 0, $len, "";	591	substr $self->{wbuf}, 0, $len, "";
504		592
505	$self->{_activity} = AnyEvent->now;	593	$self->{_activity} = AnyEvent->now;
506		594
507	$self->{on_drain}($self)	595	$self->{on_drain}($self)
508	if $self->{low_water_mark} >= length $self->{wbuf}	596	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
509	&& $self->{on_drain};	597	&& $self->{on_drain};
510		598
511	delete $self->{_ww} unless length $self->{wbuf};	599	delete $self->{_ww} unless length $self->{wbuf};
512	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	600	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
513	$self->_error ($!, 1);	601	$self->_error ($!, 1);
…		…
537		625
538	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	626	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
539	->($self, @_);	627	->($self, @_);
540	}	628	}
541		629
542	if ($self->{filter_w}) {	630	if ($self->{tls}) {
543	$self->{filter_w}($self, \$_[0]);	631	$self->{_tls_wbuf} .= $_[0];
		632
		633	&_dotls ($self);
544	} else {	634	} else {
545	$self->{wbuf} .= $_[0];	635	$self->{wbuf} .= $_[0];
546	$self->_drain_wbuf;	636	$self->_drain_wbuf;
547	}	637	}
548	}	638	}
…		…
565	=cut	655	=cut
566		656
567	register_write_type netstring => sub {	657	register_write_type netstring => sub {
568	my ($self, $string) = @_;	658	my ($self, $string) = @_;
569		659
570	sprintf "%d:%s,", (length $string), $string	660	(length $string) . ":$string,"
571	};	661	};
572		662
573	=item packstring => $format, $data	663	=item packstring => $format, $data
574		664
575	An octet string prefixed with an encoded length. The encoding C<$format>	665	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
640		730
641	pack "w/a*", Storable::nfreeze ($ref)	731	pack "w/a*", Storable::nfreeze ($ref)
642	};	732	};
643		733
644	=back	734	=back
		735
		736	=item $handle->push_shutdown
		737
		738	Sometimes you know you want to close the socket after writing your data
		739	before it was actually written. One way to do that is to replace your
		740	C<on_drain> handler by a callback that shuts down the socket (and set
		741	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		742	replaces the C<on_drain> callback with:
		743
		744	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		745
		746	This simply shuts down the write side and signals an EOF condition to the
		747	the peer.
		748
		749	You can rely on the normal read queue and C<on_eof> handling
		750	afterwards. This is the cleanest way to close a connection.
		751
		752	=cut
		753
		754	sub push_shutdown {
		755	my ($self) = @_;
		756
		757	delete $self->{low_water_mark};
		758	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		759	}
645		760
646	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	761	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
647		762
648	This function (not method) lets you add your own types to C<push_write>.	763	This function (not method) lets you add your own types to C<push_write>.
649	Whenever the given C<type> is used, C<push_write> will invoke the code	764	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
753	) {	868	) {
754	$self->_error (&Errno::ENOSPC, 1), return;	869	$self->_error (&Errno::ENOSPC, 1), return;
755	}	870	}
756		871
757	while () {	872	while () {
		873	# we need to use a separate tls read buffer, as we must not receive data while
		874	# we are draining the buffer, and this can only happen with TLS.
		875	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		876
758	my $len = length $self->{rbuf};	877	my $len = length $self->{rbuf};
759		878
760	if (my $cb = shift @{ $self->{_queue} }) {	879	if (my $cb = shift @{ $self->{_queue} }) {
761	unless ($cb->($self)) {	880	unless ($cb->($self)) {
762	if ($self->{_eof}) {	881	if ($self->{_eof}) {
…		…
784		903
785	last; # more data might arrive	904	last; # more data might arrive
786	}	905	}
787	} else {	906	} else {
788	# read side becomes idle	907	# read side becomes idle
789	delete $self->{_rw};	908	delete $self->{_rw} unless $self->{tls};
790	last;	909	last;
791	}	910	}
792	}	911	}
793		912
794	if ($self->{_eof}) {	913	if ($self->{_eof}) {
795	if ($self->{on_eof}) {	914	if ($self->{on_eof}) {
796	$self->{on_eof}($self)	915	$self->{on_eof}($self)
797	} else {	916	} else {
798	$self->_error (0, 1);	917	$self->_error (0, 1, "Unexpected end-of-file");
799	}	918	}
800	}	919	}
801		920
802	# may need to restart read watcher	921	# may need to restart read watcher
803	unless ($self->{_rw}) {	922	unless ($self->{_rw}) {
…		…
823		942
824	=item $handle->rbuf	943	=item $handle->rbuf
825		944
826	Returns the read buffer (as a modifiable lvalue).	945	Returns the read buffer (as a modifiable lvalue).
827		946
828	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	947	You can access the read buffer directly as the C<< ->{rbuf} >>
829	you want.	948	member, if you want. However, the only operation allowed on the
		949	read buffer (apart from looking at it) is removing data from its
		950	beginning. Otherwise modifying or appending to it is not allowed and will
		951	lead to hard-to-track-down bugs.
830		952
831	NOTE: The read buffer should only be used or modified if the C<on_read>,	953	NOTE: The read buffer should only be used or modified if the C<on_read>,
832	C<push_read> or C<unshift_read> methods are used. The other read methods	954	C<push_read> or C<unshift_read> methods are used. The other read methods
833	automatically manage the read buffer.	955	automatically manage the read buffer.
834		956
…		…
1089	An octet string prefixed with an encoded length. The encoding C<$format>	1211	An octet string prefixed with an encoded length. The encoding C<$format>
1090	uses the same format as a Perl C<pack> format, but must specify a single	1212	uses the same format as a Perl C<pack> format, but must specify a single
1091	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1213	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1092	optional C<!>, C<< < >> or C<< > >> modifier).	1214	optional C<!>, C<< < >> or C<< > >> modifier).
1093		1215
1094	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1216	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1217	EPP uses a prefix of C<N> (4 octtes).
1095		1218
1096	Example: read a block of data prefixed by its length in BER-encoded	1219	Example: read a block of data prefixed by its length in BER-encoded
1097	format (very efficient).	1220	format (very efficient).
1098		1221
1099	$handle->push_read (packstring => "w", sub {	1222	$handle->push_read (packstring => "w", sub {
…		…
1129	}	1252	}
1130	};	1253	};
1131		1254
1132	=item json => $cb->($handle, $hash_or_arrayref)	1255	=item json => $cb->($handle, $hash_or_arrayref)
1133		1256
1134	Reads a JSON object or array, decodes it and passes it to the callback.	1257	Reads a JSON object or array, decodes it and passes it to the
		1258	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1135		1259
1136	If a C<json> object was passed to the constructor, then that will be used	1260	If a C<json> object was passed to the constructor, then that will be used
1137	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1261	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1138		1262
1139	This read type uses the incremental parser available with JSON version	1263	This read type uses the incremental parser available with JSON version
…		…
1148	=cut	1272	=cut
1149		1273
1150	register_read_type json => sub {	1274	register_read_type json => sub {
1151	my ($self, $cb) = @_;	1275	my ($self, $cb) = @_;
1152		1276
1153	require JSON;	1277	my $json = $self->{json} \|\|=
		1278	eval { require JSON::XS; JSON::XS->new->utf8 }
		1279	\|\| do { require JSON; JSON->new->utf8 };
1154		1280
1155	my $data;	1281	my $data;
1156	my $rbuf = \$self->{rbuf};	1282	my $rbuf = \$self->{rbuf};
1157		1283
1158	my $json = $self->{json} \|\|= JSON->new->utf8;
1159
1160	sub {	1284	sub {
1161	my $ref = $json->incr_parse ($self->{rbuf});	1285	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1162		1286
1163	if ($ref) {	1287	if ($ref) {
1164	$self->{rbuf} = $json->incr_text;	1288	$self->{rbuf} = $json->incr_text;
1165	$json->incr_text = "";	1289	$json->incr_text = "";
1166	$cb->($self, $ref);	1290	$cb->($self, $ref);
1167		1291
1168	1	1292	1
		1293	} elsif ($@) {
		1294	# error case
		1295	$json->incr_skip;
		1296
		1297	$self->{rbuf} = $json->incr_text;
		1298	$json->incr_text = "";
		1299
		1300	$self->_error (&Errno::EBADMSG);
		1301
		1302	()
1169	} else {	1303	} else {
1170	$self->{rbuf} = "";	1304	$self->{rbuf} = "";
		1305
1171	()	1306	()
1172	}	1307	}
1173	}	1308	}
1174	};	1309	};
1175		1310
…		…
1252	Note that AnyEvent::Handle will automatically C<start_read> for you when	1387	Note that AnyEvent::Handle will automatically C<start_read> for you when
1253	you change the C<on_read> callback or push/unshift a read callback, and it	1388	you change the C<on_read> callback or push/unshift a read callback, and it
1254	will automatically C<stop_read> for you when neither C<on_read> is set nor	1389	will automatically C<stop_read> for you when neither C<on_read> is set nor
1255	there are any read requests in the queue.	1390	there are any read requests in the queue.
1256		1391
		1392	These methods will have no effect when in TLS mode (as TLS doesn't support
		1393	half-duplex connections).
		1394
1257	=cut	1395	=cut
1258		1396
1259	sub stop_read {	1397	sub stop_read {
1260	my ($self) = @_;	1398	my ($self) = @_;
1261		1399
1262	delete $self->{_rw};	1400	delete $self->{_rw} unless $self->{tls};
1263	}	1401	}
1264		1402
1265	sub start_read {	1403	sub start_read {
1266	my ($self) = @_;	1404	my ($self) = @_;
1267		1405
1268	unless ($self->{_rw} \|\| $self->{_eof}) {	1406	unless ($self->{_rw} \|\| $self->{_eof}) {
1269	Scalar::Util::weaken $self;	1407	Scalar::Util::weaken $self;
1270		1408
1271	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1409	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1272	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1410	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1273	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1411	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1274		1412
1275	if ($len > 0) {	1413	if ($len > 0) {
1276	$self->{_activity} = AnyEvent->now;	1414	$self->{_activity} = AnyEvent->now;
1277		1415
1278	$self->{filter_r}	1416	if ($self->{tls}) {
1279	? $self->{filter_r}($self, $rbuf)	1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1280	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1418
		1419	&_dotls ($self);
		1420	} else {
		1421	$self->_drain_rbuf unless $self->{_in_drain};
		1422	}
1281		1423
1282	} elsif (defined $len) {	1424	} elsif (defined $len) {
1283	delete $self->{_rw};	1425	delete $self->{_rw};
1284	$self->{_eof} = 1;	1426	$self->{_eof} = 1;
1285	$self->_drain_rbuf unless $self->{_in_drain};	1427	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1289	}	1431	}
1290	});	1432	});
1291	}	1433	}
1292	}	1434	}
1293		1435
		1436	our $ERROR_SYSCALL;
		1437	our $ERROR_WANT_READ;
		1438
		1439	sub _tls_error {
		1440	my ($self, $err) = @_;
		1441
		1442	return $self->_error ($!, 1)
		1443	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1444
		1445	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1446
		1447	# reduce error string to look less scary
		1448	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1449
		1450	if ($self->{_on_starttls}) {
		1451	(delete $self->{_on_starttls})->($self, undef, $err);
		1452	&_freetls;
		1453	} else {
		1454	&_freetls;
		1455	$self->_error (&Errno::EPROTO, 1, $err);
		1456	}
		1457	}
		1458
		1459	# poll the write BIO and send the data if applicable
		1460	# also decode read data if possible
		1461	# this is basiclaly our TLS state machine
		1462	# more efficient implementations are possible with openssl,
		1463	# but not with the buggy and incomplete Net::SSLeay.
1294	sub _dotls {	1464	sub _dotls {
1295	my ($self) = @_;	1465	my ($self) = @_;
1296		1466
1297	my $buf;	1467	my $tmp;
1298		1468
1299	if (length $self->{_tls_wbuf}) {	1469	if (length $self->{_tls_wbuf}) {
1300	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1470	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1301	substr $self->{_tls_wbuf}, 0, $len, "";	1471	substr $self->{_tls_wbuf}, 0, $tmp, "";
1302	}	1472	}
1303	}
1304		1473
		1474	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1475	return $self->_tls_error ($tmp)
		1476	if $tmp != $ERROR_WANT_READ
		1477	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1478	}
		1479
		1480	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1481	unless (length $tmp) {
		1482	$self->{_on_starttls}
		1483	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1484	&_freetls;
		1485
		1486	if ($self->{on_stoptls}) {
		1487	$self->{on_stoptls}($self);
		1488	return;
		1489	} else {
		1490	# let's treat SSL-eof as we treat normal EOF
		1491	delete $self->{_rw};
		1492	$self->{_eof} = 1;
		1493	}
		1494	}
		1495
		1496	$self->{_tls_rbuf} .= $tmp;
		1497	$self->_drain_rbuf unless $self->{_in_drain};
		1498	$self->{tls} or return; # tls session might have gone away in callback
		1499	}
		1500
		1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		1502	return $self->_tls_error ($tmp)
		1503	if $tmp != $ERROR_WANT_READ
		1504	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1505
1305	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1506	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1306	$self->{wbuf} .= $buf;	1507	$self->{wbuf} .= $tmp;
1307	$self->_drain_wbuf;	1508	$self->_drain_wbuf;
1308	}	1509	}
1309		1510
1310	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1511	$self->{_on_starttls}
1311	if (length $buf) {	1512	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1312	$self->{rbuf} .= $buf;	1513	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1313	$self->_drain_rbuf unless $self->{_in_drain};
1314	} else {
1315	# let's treat SSL-eof as we treat normal EOF
1316	$self->{_eof} = 1;
1317	$self->_shutdown;
1318	return;
1319	}
1320	}
1321
1322	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1323
1324	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1325	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1326	return $self->_error ($!, 1);
1327	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1328	return $self->_error (&Errno::EIO, 1);
1329	}
1330
1331	# all others are fine for our purposes
1332	}
1333	}	1514	}
1334		1515
1335	=item $handle->starttls ($tls[, $tls_ctx])	1516	=item $handle->starttls ($tls[, $tls_ctx])
1336		1517
1337	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1339	C<starttls>.	1520	C<starttls>.
1340		1521
1341	The first argument is the same as the C<tls> constructor argument (either	1522	The first argument is the same as the C<tls> constructor argument (either
1342	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1343		1524
1344	The second argument is the optional C<Net::SSLeay::CTX> object that is	1525	The second argument is the optional C<AnyEvent::TLS> object that is used
1345	used when AnyEvent::Handle has to create its own TLS connection object.	1526	when AnyEvent::Handle has to create its own TLS connection object, or
		1527	a hash reference with C<< key => value >> pairs that will be used to
		1528	construct a new context.
1346		1529
1347	The TLS connection object will end up in C<< $handle->{tls} >> after this	1530	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1348	call and can be used or changed to your liking. Note that the handshake	1531	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1349	might have already started when this function returns.	1532	changed to your liking. Note that the handshake might have already started
		1533	when this function returns.
1350		1534
		1535	If it an error to start a TLS handshake more than once per
		1536	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1537
1351	=cut	1538	=cut
		1539
		1540	our %TLS_CACHE; #TODO not yet documented, should we?
1352		1541
1353	sub starttls {	1542	sub starttls {
1354	my ($self, $ssl, $ctx) = @_;	1543	my ($self, $ssl, $ctx) = @_;
1355		1544
1356	$self->stoptls;	1545	require Net::SSLeay;
1357		1546
1358	if ($ssl eq "accept") {	1547	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1359	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1548	if $self->{tls};
1360	Net::SSLeay::set_accept_state ($ssl);	1549
1361	} elsif ($ssl eq "connect") {	1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1362	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1363	Net::SSLeay::set_connect_state ($ssl);	1552
		1553	$ctx \|\|= $self->{tls_ctx};
		1554
		1555	if ("HASH" eq ref $ctx) {
		1556	require AnyEvent::TLS;
		1557
		1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1559
		1560	if ($ctx->{cache}) {
		1561	my $key = $ctx+0;
		1562	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1563	} else {
		1564	$ctx = new AnyEvent::TLS %$ctx;
		1565	}
		1566	}
1364	}	1567
1365		1568	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1366	$self->{tls} = $ssl;	1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1367		1570
1368	# basically, this is deep magic (because SSL_read should have the same issues)	1571	# basically, this is deep magic (because SSL_read should have the same issues)
1369	# but the openssl maintainers basically said: "trust us, it just works".	1572	# but the openssl maintainers basically said: "trust us, it just works".
1370	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1371	# and mismaintained ssleay-module doesn't even offer them).	1574	# and mismaintained ssleay-module doesn't even offer them).
1372	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1575	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1373	#	1576	#
1374	# in short: this is a mess.	1577	# in short: this is a mess.
1375	#	1578	#
1376	# note that we do not try to kepe the length constant between writes as we are required to do.	1579	# note that we do not try to keep the length constant between writes as we are required to do.
1377	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1580	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1378	# and we drive openssl fully in blocking mode here.	1581	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1582	# have identity issues in that area.
1379	Net::SSLeay::CTX_set_mode ($self->{tls},	1583	# Net::SSLeay::CTX_set_mode ($ssl,
1380	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1381	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1585	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1586	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1382		1587
1383	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1384	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1385		1590
1386	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1387		1592
1388	$self->{filter_w} = sub {	1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1389	$_[0]{_tls_wbuf} .= ${$_[1]};	1594	if $self->{on_starttls};
1390	&_dotls;	1595
1391	};	1596	&_dotls; # need to trigger the initial handshake
1392	$self->{filter_r} = sub {	1597	$self->start_read; # make sure we actually do read
1393	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1394	&_dotls;
1395	};
1396	}	1598	}
1397		1599
1398	=item $handle->stoptls	1600	=item $handle->stoptls
1399		1601
1400	Destroys the SSL connection, if any. Partial read or write data will be	1602	Shuts down the SSL connection - this makes a proper EOF handshake by
1401	lost.	1603	sending a close notify to the other side, but since OpenSSL doesn't
		1604	support non-blocking shut downs, it is not possible to re-use the stream
		1605	afterwards.
1402		1606
1403	=cut	1607	=cut
1404		1608
1405	sub stoptls {	1609	sub stoptls {
1406	my ($self) = @_;	1610	my ($self) = @_;
1407		1611
1408	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1612	if ($self->{tls}) {
		1613	Net::SSLeay::shutdown ($self->{tls});
1409		1614
1410	delete $self->{_rbio};	1615	&_dotls;
1411	delete $self->{_wbio};	1616
1412	delete $self->{_tls_wbuf};	1617	# # we don't give a shit. no, we do, but we can't. no...#d#
1413	delete $self->{filter_r};	1618	# # we, we... have to use openssl :/#d#
1414	delete $self->{filter_w};	1619	# &_freetls;#d#
		1620	}
		1621	}
		1622
		1623	sub _freetls {
		1624	my ($self) = @_;
		1625
		1626	return unless $self->{tls};
		1627
		1628	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1629
		1630	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1415	}	1631	}
1416		1632
1417	sub DESTROY {	1633	sub DESTROY {
1418	my $self = shift;	1634	my ($self) = @_;
1419		1635
1420	$self->stoptls;	1636	&_freetls;
1421		1637
1422	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1423		1639
1424	if ($linger && length $self->{wbuf}) {	1640	if ($linger && length $self->{wbuf}) {
1425	my $fh = delete $self->{fh};	1641	my $fh = delete $self->{fh};
…		…
1440	@linger = ();	1656	@linger = ();
1441	});	1657	});
1442	}	1658	}
1443	}	1659	}
1444		1660
		1661	=item $handle->destroy
		1662
		1663	Shuts down the handle object as much as possible - this call ensures that
		1664	no further callbacks will be invoked and as many resources as possible
		1665	will be freed. You must not call any methods on the object afterwards.
		1666
		1667	Normally, you can just "forget" any references to an AnyEvent::Handle
		1668	object and it will simply shut down. This works in fatal error and EOF
		1669	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1670	callback, so when you want to destroy the AnyEvent::Handle object from
		1671	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1672	that case.
		1673
		1674	The handle might still linger in the background and write out remaining
		1675	data, as specified by the C<linger> option, however.
		1676
		1677	=cut
		1678
		1679	sub destroy {
		1680	my ($self) = @_;
		1681
		1682	$self->DESTROY;
		1683	%$self = ();
		1684	}
		1685
1445	=item AnyEvent::Handle::TLS_CTX	1686	=item AnyEvent::Handle::TLS_CTX
1446		1687
1447	This function creates and returns the Net::SSLeay::CTX object used by	1688	This function creates and returns the AnyEvent::TLS object used by default
1448	default for TLS mode.	1689	for TLS mode.
1449		1690
1450	The context is created like this:	1691	The context is created by calling L<AnyEvent::TLS> without any arguments.
1451
1452	Net::SSLeay::load_error_strings;
1453	Net::SSLeay::SSLeay_add_ssl_algorithms;
1454	Net::SSLeay::randomize;
1455
1456	my $CTX = Net::SSLeay::CTX_new;
1457
1458	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1459		1692
1460	=cut	1693	=cut
1461		1694
1462	our $TLS_CTX;	1695	our $TLS_CTX;
1463		1696
1464	sub TLS_CTX() {	1697	sub TLS_CTX() {
1465	$TLS_CTX \|\| do {	1698	$TLS_CTX \|\|= do {
1466	require Net::SSLeay;	1699	require AnyEvent::TLS;
1467		1700
1468	Net::SSLeay::load_error_strings ();	1701	new AnyEvent::TLS
1469	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1470	Net::SSLeay::randomize ();
1471
1472	$TLS_CTX = Net::SSLeay::CTX_new ();
1473
1474	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1475
1476	$TLS_CTX
1477	}	1702	}
1478	}	1703	}
1479		1704
1480	=back	1705	=back
		1706
		1707
		1708	=head1 NONFREQUENTLY ASKED QUESTIONS
		1709
		1710	=over 4
		1711
		1712	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1713	still get further invocations!
		1714
		1715	That's because AnyEvent::Handle keeps a reference to itself when handling
		1716	read or write callbacks.
		1717
		1718	It is only safe to "forget" the reference inside EOF or error callbacks,
		1719	from within all other callbacks, you need to explicitly call the C<<
		1720	->destroy >> method.
		1721
		1722	=item I get different callback invocations in TLS mode/Why can't I pause
		1723	reading?
		1724
		1725	Unlike, say, TCP, TLS connections do not consist of two independent
		1726	communication channels, one for each direction. Or put differently. The
		1727	read and write directions are not independent of each other: you cannot
		1728	write data unless you are also prepared to read, and vice versa.
		1729
		1730	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1731	callback invocations when you are not expecting any read data - the reason
		1732	is that AnyEvent::Handle always reads in TLS mode.
		1733
		1734	During the connection, you have to make sure that you always have a
		1735	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1736	connection (or when you no longer want to use it) you can call the
		1737	C<destroy> method.
		1738
		1739	=item How do I read data until the other side closes the connection?
		1740
		1741	If you just want to read your data into a perl scalar, the easiest way
		1742	to achieve this is by setting an C<on_read> callback that does nothing,
		1743	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1744	will be in C<$_[0]{rbuf}>:
		1745
		1746	$handle->on_read (sub { });
		1747	$handle->on_eof (undef);
		1748	$handle->on_error (sub {
		1749	my $data = delete $_[0]{rbuf};
		1750	undef $handle;
		1751	});
		1752
		1753	The reason to use C<on_error> is that TCP connections, due to latencies
		1754	and packets loss, might get closed quite violently with an error, when in
		1755	fact, all data has been received.
		1756
		1757	It is usually better to use acknowledgements when transferring data,
		1758	to make sure the other side hasn't just died and you got the data
		1759	intact. This is also one reason why so many internet protocols have an
		1760	explicit QUIT command.
		1761
		1762	=item I don't want to destroy the handle too early - how do I wait until
		1763	all data has been written?
		1764
		1765	After writing your last bits of data, set the C<on_drain> callback
		1766	and destroy the handle in there - with the default setting of
		1767	C<low_water_mark> this will be called precisely when all data has been
		1768	written to the socket:
		1769
		1770	$handle->push_write (...);
		1771	$handle->on_drain (sub {
		1772	warn "all data submitted to the kernel\n";
		1773	undef $handle;
		1774	});
		1775
		1776	If you just want to queue some data and then signal EOF to the other side,
		1777	consider using C<< ->push_shutdown >> instead.
		1778
		1779	=item I want to contact a TLS/SSL server, I don't care about security.
		1780
		1781	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1782	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1783	parameter:
		1784
		1785	my $handle = new AnyEvent::Handle
		1786	fh => $fh,
		1787	tls => "connect",
		1788	on_error => sub { ... };
		1789
		1790	$handle->push_write (...);
		1791
		1792	=item I want to contact a TLS/SSL server, I do care about security.
		1793
		1794	Then you #x##TODO#
		1795
		1796
		1797
		1798	=back
		1799
1481		1800
1482	=head1 SUBCLASSING AnyEvent::Handle	1801	=head1 SUBCLASSING AnyEvent::Handle
1483		1802
1484	In many cases, you might want to subclass AnyEvent::Handle.	1803	In many cases, you might want to subclass AnyEvent::Handle.
1485		1804

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC vs. Revision 1.143 by root, Mon Jul 6 21:02:34 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.87 by root, Thu Aug 21 20:52:39 2008 UTC vs.
Revision 1.143 by root, Mon Jul 6 21:02:34 2009 UTC