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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC vs.
Revision 1.149 by root, Thu Jul 16 03:48:33 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.22;	19	our $VERSION = 4.82;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $handle =	28	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	29	fh => \*STDIN,
31	on_eof => sub {	30	on_error => sub {
32	$cv->broadcast;	31	warn "got error $_[2]\n";
33	},	32	$cv->send;
34	);	33	);
35		34
36	# send some request line	35	# send some request line
37	$handle->push_write ("getinfo\015\012");	36	$hdl->push_write ("getinfo\015\012");
38		37
39	# read the response line	38	# read the response line
40	$handle->push_read (line => sub {	39	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	40	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	41	warn "got line <$line>\n";
43	$cv->send;	42	$cv->send;
44	});	43	});
45		44
46	$cv->recv;	45	$cv->recv;
47		46
…		…
49		48
50	This module is a helper module to make it easier to do event-based I/O on	49	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	50	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	51	on sockets see L<AnyEvent::Util>.
53		52
		53	The L<AnyEvent::Intro> tutorial contains some well-documented
		54	AnyEvent::Handle examples.
		55
54	In the following, when the documentation refers to of "bytes" then this	56	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	57	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	58	treatment of characters applies to this module as well.
57		59
58	All callbacks will be invoked with the handle object as their first	60	All callbacks will be invoked with the handle object as their first
…		…
60		62
61	=head1 METHODS	63	=head1 METHODS
62		64
63	=over 4	65	=over 4
64		66
65	=item B<new (%args)>	67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
66		68
67	The constructor supports these arguments (all as key => value pairs).	69	The constructor supports these arguments (all as C<< key => value >> pairs).
68		70
69	=over 4	71	=over 4
70		72
71	=item fh => $filehandle [MANDATORY]	73	=item fh => $filehandle [MANDATORY]
72		74
73	The filehandle this L<AnyEvent::Handle> object will operate on.	75	The filehandle this L<AnyEvent::Handle> object will operate on.
74		76
75	NOTE: The filehandle will be set to non-blocking (using	77	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		79	that mode.
77		80
78	=item on_eof => $cb->($handle)	81	=item on_eof => $cb->($handle)
79		82
80	Set the callback to be called when an end-of-file condition is detected,	83	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	84	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	85	connection cleanly.
83		86
		87	For sockets, this just means that the other side has stopped sending data,
		88	you can still try to write data, and, in fact, one can return from the EOF
		89	callback and continue writing data, as only the read part has been shut
		90	down.
		91
84	While not mandatory, it is highly recommended to set an eof callback,	92	While not mandatory, it is I<highly> recommended to set an EOF callback,
85	otherwise you might end up with a closed socket while you are still	93	otherwise you might end up with a closed socket while you are still
86	waiting for data.	94	waiting for data.
87		95
		96	If an EOF condition has been detected but no C<on_eof> callback has been
		97	set, then a fatal error will be raised with C<$!> set to <0>.
		98
88	=item on_error => $cb->($handle, $fatal)	99	=item on_error => $cb->($handle, $fatal, $message)
89		100
90	This is the error callback, which is called when, well, some error	101	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	102	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	103	connect or a read error.
93		104
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	105	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	106	fatal errors the handle object will be destroyed (by a call to C<< ->
		107	destroy >>) after invoking the error callback (which means you are free to
		108	examine the handle object). Examples of fatal errors are an EOF condition
		109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		110
		111	AnyEvent::Handle tries to find an appropriate error code for you to check
		112	against, but in some cases (TLS errors), this does not work well. It is
		113	recommended to always output the C<$message> argument in human-readable
		114	error messages (it's usually the same as C<"$!">).
		115
96	usable. Non-fatal errors can be retried by simply returning, but it is	116	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	117	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	118	when this callback is invoked. Examples of non-fatal errors are timeouts
		119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		120
100	On callback entrance, the value of C<$!> contains the operating system	121	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		123	C<EPROTO>).
102		124
103	While not mandatory, it is I<highly> recommended to set this callback, as	125	While not mandatory, it is I<highly> recommended to set this callback, as
104	you will not be notified of errors otherwise. The default simply calls	126	you will not be notified of errors otherwise. The default simply calls
105	C<croak>.	127	C<croak>.
106		128
…		…
110	and no read request is in the queue (unlike read queue callbacks, this	132	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	133	callback will only be called when at least one octet of data is in the
112	read buffer).	134	read buffer).
113		135
114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
115	method or access the C<$handle->{rbuf}> member directly.	137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		138	must not enlarge or modify the read buffer, you can only remove data at
		139	the beginning from it.
116		140
117	When an EOF condition is detected then AnyEvent::Handle will first try to	141	When an EOF condition is detected then AnyEvent::Handle will first try to
118	feed all the remaining data to the queued callbacks and C<on_read> before	142	feed all the remaining data to the queued callbacks and C<on_read> before
119	calling the C<on_eof> callback. If no progress can be made, then a fatal	143	calling the C<on_eof> callback. If no progress can be made, then a fatal
120	error will be raised (with C<$!> set to C<EPIPE>).	144	error will be raised (with C<$!> set to C<EPIPE>).
…		…
135	=item timeout => $fractional_seconds	159	=item timeout => $fractional_seconds
136		160
137	If non-zero, then this enables an "inactivity" timeout: whenever this many	161	If non-zero, then this enables an "inactivity" timeout: whenever this many
138	seconds pass without a successful read or write on the underlying file	162	seconds pass without a successful read or write on the underlying file
139	handle, the C<on_timeout> callback will be invoked (and if that one is	163	handle, the C<on_timeout> callback will be invoked (and if that one is
140	missing, an C<ETIMEDOUT> error will be raised).	164	missing, a non-fatal C<ETIMEDOUT> error will be raised).
141		165
142	Note that timeout processing is also active when you currently do not have	166	Note that timeout processing is also active when you currently do not have
143	any outstanding read or write requests: If you plan to keep the connection	167	any outstanding read or write requests: If you plan to keep the connection
144	idle then you should disable the timout temporarily or ignore the timeout	168	idle then you should disable the timout temporarily or ignore the timeout
145	in the C<on_timeout> callback.	169	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		170	restart the timeout.
146		171
147	Zero (the default) disables this timeout.	172	Zero (the default) disables this timeout.
148		173
149	=item on_timeout => $cb->($handle)	174	=item on_timeout => $cb->($handle)
150		175
…		…
154		179
155	=item rbuf_max => <bytes>	180	=item rbuf_max => <bytes>
156		181
157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	182	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158	when the read buffer ever (strictly) exceeds this size. This is useful to	183	when the read buffer ever (strictly) exceeds this size. This is useful to
159	avoid denial-of-service attacks.	184	avoid some forms of denial-of-service attacks.
160		185
161	For example, a server accepting connections from untrusted sources should	186	For example, a server accepting connections from untrusted sources should
162	be configured to accept only so-and-so much data that it cannot act on	187	be configured to accept only so-and-so much data that it cannot act on
163	(for example, when expecting a line, an attacker could send an unlimited	188	(for example, when expecting a line, an attacker could send an unlimited
164	amount of data without a callback ever being called as long as the line	189	amount of data without a callback ever being called as long as the line
165	isn't finished).	190	isn't finished).
166		191
167	=item autocork => <boolean>	192	=item autocork => <boolean>
168		193
169	When disabled (the default), then C<push_write> will try to immediately	194	When disabled (the default), then C<push_write> will try to immediately
170	write the data to the handle if possible. This avoids having to register	195	write the data to the handle, if possible. This avoids having to register
171	a write watcher and wait for the next event loop iteration, but can be	196	a write watcher and wait for the next event loop iteration, but can
172	inefficient if you write multiple small chunks (this disadvantage is	197	be inefficient if you write multiple small chunks (on the wire, this
173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	198	disadvantage is usually avoided by your kernel's nagle algorithm, see
		199	C<no_delay>, but this option can save costly syscalls).
174		200
175	When enabled, then writes will always be queued till the next event loop	201	When enabled, then writes will always be queued till the next event loop
176	iteration. This is efficient when you do many small writes per iteration,	202	iteration. This is efficient when you do many small writes per iteration,
177	but less efficient when you do a single write only.	203	but less efficient when you do a single write only per iteration (or when
		204	the write buffer often is full). It also increases write latency.
178		205
179	=item no_delay => <boolean>	206	=item no_delay => <boolean>
180		207
181	When doing small writes on sockets, your operating system kernel might	208	When doing small writes on sockets, your operating system kernel might
182	wait a bit for more data before actually sending it out. This is called	209	wait a bit for more data before actually sending it out. This is called
183	the Nagle algorithm, and usually it is beneficial.	210	the Nagle algorithm, and usually it is beneficial.
184		211
185	In some situations you want as low a delay as possible, which cna be	212	In some situations you want as low a delay as possible, which can be
186	accomplishd by setting this option to true.	213	accomplishd by setting this option to a true value.
187		214
188	The default is your opertaing system's default behaviour, this option	215	The default is your opertaing system's default behaviour (most likely
189	explicitly enables or disables it, if possible.	216	enabled), this option explicitly enables or disables it, if possible.
190		217
191	=item read_size => <bytes>	218	=item read_size => <bytes>
192		219
193	The default read block size (the amount of bytes this module will try to read	220	The default read block size (the amount of bytes this module will
194	during each (loop iteration). Default: C<8192>.	221	try to read during each loop iteration, which affects memory
		222	requirements). Default: C<8192>.
195		223
196	=item low_water_mark => <bytes>	224	=item low_water_mark => <bytes>
197		225
198	Sets the amount of bytes (default: C<0>) that make up an "empty" write	226	Sets the amount of bytes (default: C<0>) that make up an "empty" write
199	buffer: If the write reaches this size or gets even samller it is	227	buffer: If the write reaches this size or gets even samller it is
200	considered empty.	228	considered empty.
201		229
		230	Sometimes it can be beneficial (for performance reasons) to add data to
		231	the write buffer before it is fully drained, but this is a rare case, as
		232	the operating system kernel usually buffers data as well, so the default
		233	is good in almost all cases.
		234
202	=item linger => <seconds>	235	=item linger => <seconds>
203		236
204	If non-zero (default: C<3600>), then the destructor of the	237	If non-zero (default: C<3600>), then the destructor of the
205	AnyEvent::Handle object will check wether there is still outstanding write	238	AnyEvent::Handle object will check whether there is still outstanding
206	data and will install a watcher that will write out this data. No errors	239	write data and will install a watcher that will write this data to the
207	will be reported (this mostly matches how the operating system treats	240	socket. No errors will be reported (this mostly matches how the operating
208	outstanding data at socket close time).	241	system treats outstanding data at socket close time).
209		242
210	This will not work for partial TLS data that could not yet been	243	This will not work for partial TLS data that could not be encoded
211	encoded. This data will be lost.	244	yet. This data will be lost. Calling the C<stoptls> method in time might
		245	help.
		246
		247	=item peername => $string
		248
		249	A string used to identify the remote site - usually the DNS hostname
		250	(I<not> IDN!) used to create the connection, rarely the IP address.
		251
		252	Apart from being useful in error messages, this string is also used in TLS
		253	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		254	verification will be skipped when C<peername> is not specified or
		255	C<undef>.
212		256
213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	257	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
214		258
215	When this parameter is given, it enables TLS (SSL) mode, that means it	259	When this parameter is given, it enables TLS (SSL) mode, that means
216	will start making tls handshake and will transparently encrypt/decrypt	260	AnyEvent will start a TLS handshake as soon as the conenction has been
217	data.	261	established and will transparently encrypt/decrypt data afterwards.
		262
		263	All TLS protocol errors will be signalled as C<EPROTO>, with an
		264	appropriate error message.
218		265
219	TLS mode requires Net::SSLeay to be installed (it will be loaded	266	TLS mode requires Net::SSLeay to be installed (it will be loaded
220	automatically when you try to create a TLS handle).	267	automatically when you try to create a TLS handle): this module doesn't
		268	have a dependency on that module, so if your module requires it, you have
		269	to add the dependency yourself.
221		270
222	For the TLS server side, use C<accept>, and for the TLS client side of a	271	Unlike TCP, TLS has a server and client side: for the TLS server side, use
223	connection, use C<connect> mode.	272	C<accept>, and for the TLS client side of a connection, use C<connect>
		273	mode.
224		274
225	You can also provide your own TLS connection object, but you have	275	You can also provide your own TLS connection object, but you have
226	to make sure that you call either C<Net::SSLeay::set_connect_state>	276	to make sure that you call either C<Net::SSLeay::set_connect_state>
227	or C<Net::SSLeay::set_accept_state> on it before you pass it to	277	or C<Net::SSLeay::set_accept_state> on it before you pass it to
228	AnyEvent::Handle.	278	AnyEvent::Handle. Also, this module will take ownership of this connection
		279	object.
229		280
		281	At some future point, AnyEvent::Handle might switch to another TLS
		282	implementation, then the option to use your own session object will go
		283	away.
		284
		285	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		286	passing in the wrong integer will lead to certain crash. This most often
		287	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		288	segmentation fault.
		289
230	See the C<starttls> method if you need to start TLS negotiation later.	290	See the C<< ->starttls >> method for when need to start TLS negotiation later.
231		291
232	=item tls_ctx => $ssl_ctx	292	=item tls_ctx => $anyevent_tls
233		293
234	Use the given Net::SSLeay::CTX object to create the new TLS connection	294	Use the given C<AnyEvent::TLS> object to create the new TLS connection
235	(unless a connection object was specified directly). If this parameter is	295	(unless a connection object was specified directly). If this parameter is
236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	296	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
237		297
		298	Instead of an object, you can also specify a hash reference with C<< key
		299	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		300	new TLS context object.
		301
		302	=item on_starttls => $cb->($handle, $success[, $error_message])
		303
		304	This callback will be invoked when the TLS/SSL handshake has finished. If
		305	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		306	(C<on_stoptls> will not be called in this case).
		307
		308	The session in C<< $handle->{tls} >> can still be examined in this
		309	callback, even when the handshake was not successful.
		310
		311	TLS handshake failures will not cause C<on_error> to be invoked when this
		312	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		313
		314	Without this callback, handshake failures lead to C<on_error> being
		315	called, as normal.
		316
		317	Note that you cannot call C<starttls> right again in this callback. If you
		318	need to do that, start an zero-second timer instead whose callback can
		319	then call C<< ->starttls >> again.
		320
		321	=item on_stoptls => $cb->($handle)
		322
		323	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		324	set, then it will be invoked after freeing the TLS session. If it is not,
		325	then a TLS shutdown condition will be treated like a normal EOF condition
		326	on the handle.
		327
		328	The session in C<< $handle->{tls} >> can still be examined in this
		329	callback.
		330
		331	This callback will only be called on TLS shutdowns, not when the
		332	underlying handle signals EOF.
		333
238	=item json => JSON or JSON::XS object	334	=item json => JSON or JSON::XS object
239		335
240	This is the json coder object used by the C<json> read and write types.	336	This is the json coder object used by the C<json> read and write types.
241		337
242	If you don't supply it, then AnyEvent::Handle will create and use a	338	If you don't supply it, then AnyEvent::Handle will create and use a
243	suitable one, which will write and expect UTF-8 encoded JSON texts.	339	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		340	texts.
244		341
245	Note that you are responsible to depend on the JSON module if you want to	342	Note that you are responsible to depend on the JSON module if you want to
246	use this functionality, as AnyEvent does not have a dependency itself.	343	use this functionality, as AnyEvent does not have a dependency itself.
247		344
248	=item filter_r => $cb
249
250	=item filter_w => $cb
251
252	These exist, but are undocumented at this time.
253
254	=back	345	=back
255		346
256	=cut	347	=cut
257		348
258	sub new {	349	sub new {
259	my $class = shift;	350	my $class = shift;
260
261	my $self = bless { @_ }, $class;	351	my $self = bless { @_ }, $class;
262		352
263	$self->{fh} or Carp::croak "mandatory argument fh is missing";	353	$self->{fh} or Carp::croak "mandatory argument fh is missing";
264		354
265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	355	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
266
267	if ($self->{tls}) {
268	require Net::SSLeay;
269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
270	}
271		356
272	$self->{_activity} = AnyEvent->now;	357	$self->{_activity} = AnyEvent->now;
273	$self->_timeout;	358	$self->_timeout;
274		359
275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	360	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		361
		362	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		363	if $self->{tls};
		364
		365	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
277		366
278	$self->start_read	367	$self->start_read
279	if $self->{on_read};	368	if $self->{on_read};
280		369
281	$self	370	$self->{fh} && $self
282	}	371	}
283		372
284	sub _shutdown {	373	#sub _shutdown {
285	my ($self) = @_;	374	# my ($self) = @_;
286		375	#
287	delete $self->{_tw};	376	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
288	delete $self->{_rw};	377	# $self->{_eof} = 1; # tell starttls et. al to stop trying
289	delete $self->{_ww};	378	#
290	delete $self->{fh};	379	# &_freetls;
291		380	#}
292	$self->stoptls;
293	}
294		381
295	sub _error {	382	sub _error {
296	my ($self, $errno, $fatal) = @_;	383	my ($self, $errno, $fatal, $message) = @_;
297
298	$self->_shutdown
299	if $fatal;
300		384
301	$! = $errno;	385	$! = $errno;
		386	$message \|\|= "$!";
302		387
303	if ($self->{on_error}) {	388	if ($self->{on_error}) {
304	$self->{on_error}($self, $fatal);	389	$self->{on_error}($self, $fatal, $message);
305	} else {	390	$self->destroy;
		391	} elsif ($self->{fh}) {
		392	$self->destroy;
306	Carp::croak "AnyEvent::Handle uncaught error: $!";	393	Carp::croak "AnyEvent::Handle uncaught error: $message";
307	}	394	}
308	}	395	}
309		396
310	=item $fh = $handle->fh	397	=item $fh = $handle->fh
311		398
312	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.
313		400
314	=cut	401	=cut
315		402
316	sub fh { $_[0]{fh} }	403	sub fh { $_[0]{fh} }
317		404
…		…
335	$_[0]{on_eof} = $_[1];	422	$_[0]{on_eof} = $_[1];
336	}	423	}
337		424
338	=item $handle->on_timeout ($cb)	425	=item $handle->on_timeout ($cb)
339		426
340	Replace the current C<on_timeout> callback, or disables the callback	427	Replace the current C<on_timeout> callback, or disables the callback (but
341	(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
342	argument.	429	argument and method.
343		430
344	=cut	431	=cut
345		432
346	sub on_timeout {	433	sub on_timeout {
347	$_[0]{on_timeout} = $_[1];	434	$_[0]{on_timeout} = $_[1];
348	}	435	}
349		436
350	=item $handle->autocork ($boolean)	437	=item $handle->autocork ($boolean)
351		438
352	Enables or disables the current autocork behaviour (see C<autocork>	439	Enables or disables the current autocork behaviour (see C<autocork>
353	constructor argument).	440	constructor argument). Changes will only take effect on the next write.
354		441
355	=cut	442	=cut
		443
		444	sub autocork {
		445	$_[0]{autocork} = $_[1];
		446	}
356		447
357	=item $handle->no_delay ($boolean)	448	=item $handle->no_delay ($boolean)
358		449
359	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
360	the same name for details).	451	the same name for details).
…		…
366		457
367	eval {	458	eval {
368	local $SIG{__DIE__};	459	local $SIG{__DIE__};
369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
370	};	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];
371	}	482	}
372		483
373	#############################################################################	484	#############################################################################
374		485
375	=item $handle->timeout ($seconds)	486	=item $handle->timeout ($seconds)
…		…
453	my ($self, $cb) = @_;	564	my ($self, $cb) = @_;
454		565
455	$self->{on_drain} = $cb;	566	$self->{on_drain} = $cb;
456		567
457	$cb->($self)	568	$cb->($self)
458	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	569	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
459	}	570	}
460		571
461	=item $handle->push_write ($data)	572	=item $handle->push_write ($data)
462		573
463	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
…		…
474	Scalar::Util::weaken $self;	585	Scalar::Util::weaken $self;
475		586
476	my $cb = sub {	587	my $cb = sub {
477	my $len = syswrite $self->{fh}, $self->{wbuf};	588	my $len = syswrite $self->{fh}, $self->{wbuf};
478		589
479	if ($len >= 0) {	590	if (defined $len) {
480	substr $self->{wbuf}, 0, $len, "";	591	substr $self->{wbuf}, 0, $len, "";
481		592
482	$self->{_activity} = AnyEvent->now;	593	$self->{_activity} = AnyEvent->now;
483		594
484	$self->{on_drain}($self)	595	$self->{on_drain}($self)
485	if $self->{low_water_mark} >= length $self->{wbuf}	596	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
486	&& $self->{on_drain};	597	&& $self->{on_drain};
487		598
488	delete $self->{_ww} unless length $self->{wbuf};	599	delete $self->{_ww} unless length $self->{wbuf};
489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	600	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
490	$self->_error ($!, 1);	601	$self->_error ($!, 1);
…		…
514		625
515	@_ = ($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")
516	->($self, @_);	627	->($self, @_);
517	}	628	}
518		629
519	if ($self->{filter_w}) {	630	if ($self->{tls}) {
520	$self->{filter_w}($self, \$_[0]);	631	$self->{_tls_wbuf} .= $_[0];
		632
		633	&_dotls ($self);
521	} else {	634	} else {
522	$self->{wbuf} .= $_[0];	635	$self->{wbuf} .= $_[0];
523	$self->_drain_wbuf;	636	$self->_drain_wbuf;
524	}	637	}
525	}	638	}
…		…
542	=cut	655	=cut
543		656
544	register_write_type netstring => sub {	657	register_write_type netstring => sub {
545	my ($self, $string) = @_;	658	my ($self, $string) = @_;
546		659
547	sprintf "%d:%s,", (length $string), $string	660	(length $string) . ":$string,"
548	};	661	};
549		662
550	=item packstring => $format, $data	663	=item packstring => $format, $data
551		664
552	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>
…		…
617		730
618	pack "w/a*", Storable::nfreeze ($ref)	731	pack "w/a*", Storable::nfreeze ($ref)
619	};	732	};
620		733
621	=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	}
622		760
623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	761	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
624		762
625	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>.
626	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
…		…
726		864
727	if (	865	if (
728	defined $self->{rbuf_max}	866	defined $self->{rbuf_max}
729	&& $self->{rbuf_max} < length $self->{rbuf}	867	&& $self->{rbuf_max} < length $self->{rbuf}
730	) {	868	) {
731	return $self->_error (&Errno::ENOSPC, 1);	869	$self->_error (&Errno::ENOSPC, 1), return;
732	}	870	}
733		871
734	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
735	my $len = length $self->{rbuf};	877	my $len = length $self->{rbuf};
736		878
737	if (my $cb = shift @{ $self->{_queue} }) {	879	if (my $cb = shift @{ $self->{_queue} }) {
738	unless ($cb->($self)) {	880	unless ($cb->($self)) {
739	if ($self->{_eof}) {	881	if ($self->{_eof}) {
740	# no progress can be made (not enough data and no data forthcoming)	882	# no progress can be made (not enough data and no data forthcoming)
741	$self->_error (&Errno::EPIPE, 1), last;	883	$self->_error (&Errno::EPIPE, 1), return;
742	}	884	}
743		885
744	unshift @{ $self->{_queue} }, $cb;	886	unshift @{ $self->{_queue} }, $cb;
745	last;	887	last;
746	}	888	}
…		…
754	&& !@{ $self->{_queue} } # and the queue is still empty	896	&& !@{ $self->{_queue} } # and the queue is still empty
755	&& $self->{on_read} # but we still have on_read	897	&& $self->{on_read} # but we still have on_read
756	) {	898	) {
757	# no further data will arrive	899	# no further data will arrive
758	# so no progress can be made	900	# so no progress can be made
759	$self->_error (&Errno::EPIPE, 1), last	901	$self->_error (&Errno::EPIPE, 1), return
760	if $self->{_eof};	902	if $self->{_eof};
761		903
762	last; # more data might arrive	904	last; # more data might arrive
763	}	905	}
764	} else {	906	} else {
765	# read side becomes idle	907	# read side becomes idle
766	delete $self->{_rw};	908	delete $self->{_rw} unless $self->{tls};
767	last;	909	last;
768	}	910	}
769	}	911	}
770		912
		913	if ($self->{_eof}) {
		914	if ($self->{on_eof}) {
771	$self->{on_eof}($self)	915	$self->{on_eof}($self)
772	if $self->{_eof} && $self->{on_eof};	916	} else {
		917	$self->_error (0, 1, "Unexpected end-of-file");
		918	}
		919	}
773		920
774	# may need to restart read watcher	921	# may need to restart read watcher
775	unless ($self->{_rw}) {	922	unless ($self->{_rw}) {
776	$self->start_read	923	$self->start_read
777	if $self->{on_read} \|\| @{ $self->{_queue} };	924	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
795		942
796	=item $handle->rbuf	943	=item $handle->rbuf
797		944
798	Returns the read buffer (as a modifiable lvalue).	945	Returns the read buffer (as a modifiable lvalue).
799		946
800	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} >>
801	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.
802		952
803	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>,
804	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
805	automatically manage the read buffer.	955	automatically manage the read buffer.
806		956
…		…
1061	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>
1062	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
1063	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1213	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1064	optional C<!>, C<< < >> or C<< > >> modifier).	1214	optional C<!>, C<< < >> or C<< > >> modifier).
1065		1215
1066	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).
1067		1218
1068	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
1069	format (very efficient).	1220	format (very efficient).
1070		1221
1071	$handle->push_read (packstring => "w", sub {	1222	$handle->push_read (packstring => "w", sub {
…		…
1101	}	1252	}
1102	};	1253	};
1103		1254
1104	=item json => $cb->($handle, $hash_or_arrayref)	1255	=item json => $cb->($handle, $hash_or_arrayref)
1105		1256
1106	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.
1107		1259
1108	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
1109	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.
1110		1262
1111	This read type uses the incremental parser available with JSON version	1263	This read type uses the incremental parser available with JSON version
…		…
1120	=cut	1272	=cut
1121		1273
1122	register_read_type json => sub {	1274	register_read_type json => sub {
1123	my ($self, $cb) = @_;	1275	my ($self, $cb) = @_;
1124		1276
1125	require JSON;	1277	my $json = $self->{json} \|\|=
		1278	eval { require JSON::XS; JSON::XS->new->utf8 }
		1279	\|\| do { require JSON; JSON->new->utf8 };
1126		1280
1127	my $data;	1281	my $data;
1128	my $rbuf = \$self->{rbuf};	1282	my $rbuf = \$self->{rbuf};
1129		1283
1130	my $json = $self->{json} \|\|= JSON->new->utf8;
1131
1132	sub {	1284	sub {
1133	my $ref = $json->incr_parse ($self->{rbuf});	1285	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1134		1286
1135	if ($ref) {	1287	if ($ref) {
1136	$self->{rbuf} = $json->incr_text;	1288	$self->{rbuf} = $json->incr_text;
1137	$json->incr_text = "";	1289	$json->incr_text = "";
1138	$cb->($self, $ref);	1290	$cb->($self, $ref);
1139		1291
1140	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	()
1141	} else {	1303	} else {
1142	$self->{rbuf} = "";	1304	$self->{rbuf} = "";
		1305
1143	()	1306	()
1144	}	1307	}
1145	}	1308	}
1146	};	1309	};
1147		1310
…		…
1224	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
1225	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
1226	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
1227	there are any read requests in the queue.	1390	there are any read requests in the queue.
1228		1391
		1392	These methods will have no effect when in TLS mode (as TLS doesn't support
		1393	half-duplex connections).
		1394
1229	=cut	1395	=cut
1230		1396
1231	sub stop_read {	1397	sub stop_read {
1232	my ($self) = @_;	1398	my ($self) = @_;
1233		1399
1234	delete $self->{_rw};	1400	delete $self->{_rw} unless $self->{tls};
1235	}	1401	}
1236		1402
1237	sub start_read {	1403	sub start_read {
1238	my ($self) = @_;	1404	my ($self) = @_;
1239		1405
1240	unless ($self->{_rw} \|\| $self->{_eof}) {	1406	unless ($self->{_rw} \|\| $self->{_eof}) {
1241	Scalar::Util::weaken $self;	1407	Scalar::Util::weaken $self;
1242		1408
1243	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1409	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1244	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1410	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1245	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;
1246		1412
1247	if ($len > 0) {	1413	if ($len > 0) {
1248	$self->{_activity} = AnyEvent->now;	1414	$self->{_activity} = AnyEvent->now;
1249		1415
1250	$self->{filter_r}	1416	if ($self->{tls}) {
1251	? $self->{filter_r}($self, $rbuf)	1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1252	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1418
		1419	&_dotls ($self);
		1420	} else {
		1421	$self->_drain_rbuf unless $self->{_in_drain};
		1422	}
1253		1423
1254	} elsif (defined $len) {	1424	} elsif (defined $len) {
1255	delete $self->{_rw};	1425	delete $self->{_rw};
1256	$self->{_eof} = 1;	1426	$self->{_eof} = 1;
1257	$self->_drain_rbuf unless $self->{_in_drain};	1427	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1261	}	1431	}
1262	});	1432	});
1263	}	1433	}
1264	}	1434	}
1265		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.
1266	sub _dotls {	1464	sub _dotls {
1267	my ($self) = @_;	1465	my ($self) = @_;
1268		1466
1269	my $buf;	1467	my $tmp;
1270		1468
1271	if (length $self->{_tls_wbuf}) {	1469	if (length $self->{_tls_wbuf}) {
1272	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1470	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1273	substr $self->{_tls_wbuf}, 0, $len, "";	1471	substr $self->{_tls_wbuf}, 0, $tmp, "";
1274	}	1472	}
1275	}
1276		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
1277	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1506	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1278	$self->{wbuf} .= $buf;	1507	$self->{wbuf} .= $tmp;
1279	$self->_drain_wbuf;	1508	$self->_drain_wbuf;
1280	}	1509	}
1281		1510
1282	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1511	$self->{_on_starttls}
1283	if (length $buf) {	1512	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1284	$self->{rbuf} .= $buf;	1513	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1285	$self->_drain_rbuf unless $self->{_in_drain};
1286	} else {
1287	# let's treat SSL-eof as we treat normal EOF
1288	$self->{_eof} = 1;
1289	$self->_shutdown;
1290	return;
1291	}
1292	}
1293
1294	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1295
1296	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1297	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1298	return $self->_error ($!, 1);
1299	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1300	return $self->_error (&Errno::EIO, 1);
1301	}
1302
1303	# all others are fine for our purposes
1304	}
1305	}	1514	}
1306		1515
1307	=item $handle->starttls ($tls[, $tls_ctx])	1516	=item $handle->starttls ($tls[, $tls_ctx])
1308		1517
1309	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1311	C<starttls>.	1520	C<starttls>.
1312		1521
1313	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
1314	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1315		1524
1316	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
1317	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.
1318		1529
1319	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
1320	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
1321	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.
1322		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
1323	=cut	1538	=cut
		1539
		1540	our %TLS_CACHE; #TODO not yet documented, should we?
1324		1541
1325	sub starttls {	1542	sub starttls {
1326	my ($self, $ssl, $ctx) = @_;	1543	my ($self, $ssl, $ctx) = @_;
1327		1544
1328	$self->stoptls;	1545	require Net::SSLeay;
1329		1546
1330	if ($ssl eq "accept") {	1547	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1331	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1548	if $self->{tls};
1332	Net::SSLeay::set_accept_state ($ssl);	1549
1333	} elsif ($ssl eq "connect") {	1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1334	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1335	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	}
1336	}	1567
1337		1568	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1338	$self->{tls} = $ssl;	1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1339		1570
1340	# 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)
1341	# but the openssl maintainers basically said: "trust us, it just works".	1572	# but the openssl maintainers basically said: "trust us, it just works".
1342	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1343	# and mismaintained ssleay-module doesn't even offer them).	1574	# and mismaintained ssleay-module doesn't even offer them).
1344	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1575	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1576	#
		1577	# in short: this is a mess.
		1578	#
		1579	# note that we do not try to keep the length constant between writes as we are required to do.
		1580	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		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.
1345	Net::SSLeay::CTX_set_mode ($self->{tls},	1583	# Net::SSLeay::CTX_set_mode ($ssl,
1346	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1347	\| (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);
1348		1587
1349	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1350	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1351		1590
1352	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1353		1592
1354	$self->{filter_w} = sub {	1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1355	$_[0]{_tls_wbuf} .= ${$_[1]};	1594	if $self->{on_starttls};
1356	&_dotls;	1595
1357	};	1596	&_dotls; # need to trigger the initial handshake
1358	$self->{filter_r} = sub {	1597	$self->start_read; # make sure we actually do read
1359	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1360	&_dotls;
1361	};
1362	}	1598	}
1363		1599
1364	=item $handle->stoptls	1600	=item $handle->stoptls
1365		1601
1366	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
1367	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.
1368		1606
1369	=cut	1607	=cut
1370		1608
1371	sub stoptls {	1609	sub stoptls {
1372	my ($self) = @_;	1610	my ($self) = @_;
1373		1611
1374	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1612	if ($self->{tls}) {
		1613	Net::SSLeay::shutdown ($self->{tls});
1375		1614
1376	delete $self->{_rbio};	1615	&_dotls;
1377	delete $self->{_wbio};	1616
1378	delete $self->{_tls_wbuf};	1617	# # we don't give a shit. no, we do, but we can't. no...#d#
1379	delete $self->{filter_r};	1618	# # we, we... have to use openssl :/#d#
1380	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)};
1381	}	1631	}
1382		1632
1383	sub DESTROY {	1633	sub DESTROY {
1384	my $self = shift;	1634	my ($self) = @_;
1385		1635
1386	$self->stoptls;	1636	&_freetls;
1387		1637
1388	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1389		1639
1390	if ($linger && length $self->{wbuf}) {	1640	if ($linger && length $self->{wbuf}) {
1391	my $fh = delete $self->{fh};	1641	my $fh = delete $self->{fh};
…		…
1406	@linger = ();	1656	@linger = ();
1407	});	1657	});
1408	}	1658	}
1409	}	1659	}
1410		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	Destroying the handle object in this way has the advantage that callbacks
		1675	will be removed as well, so if those are the only reference holders (as
		1676	is common), then one doesn't need to do anything special to break any
		1677	reference cycles.
		1678
		1679	The handle might still linger in the background and write out remaining
		1680	data, as specified by the C<linger> option, however.
		1681
		1682	=cut
		1683
		1684	sub destroy {
		1685	my ($self) = @_;
		1686
		1687	$self->DESTROY;
		1688	%$self = ();
		1689	}
		1690
1411	=item AnyEvent::Handle::TLS_CTX	1691	=item AnyEvent::Handle::TLS_CTX
1412		1692
1413	This function creates and returns the Net::SSLeay::CTX object used by	1693	This function creates and returns the AnyEvent::TLS object used by default
1414	default for TLS mode.	1694	for TLS mode.
1415		1695
1416	The context is created like this:	1696	The context is created by calling L<AnyEvent::TLS> without any arguments.
1417
1418	Net::SSLeay::load_error_strings;
1419	Net::SSLeay::SSLeay_add_ssl_algorithms;
1420	Net::SSLeay::randomize;
1421
1422	my $CTX = Net::SSLeay::CTX_new;
1423
1424	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1425		1697
1426	=cut	1698	=cut
1427		1699
1428	our $TLS_CTX;	1700	our $TLS_CTX;
1429		1701
1430	sub TLS_CTX() {	1702	sub TLS_CTX() {
1431	$TLS_CTX \|\| do {	1703	$TLS_CTX \|\|= do {
1432	require Net::SSLeay;	1704	require AnyEvent::TLS;
1433		1705
1434	Net::SSLeay::load_error_strings ();	1706	new AnyEvent::TLS
1435	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1436	Net::SSLeay::randomize ();
1437
1438	$TLS_CTX = Net::SSLeay::CTX_new ();
1439
1440	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1441
1442	$TLS_CTX
1443	}	1707	}
1444	}	1708	}
1445		1709
1446	=back	1710	=back
		1711
		1712
		1713	=head1 NONFREQUENTLY ASKED QUESTIONS
		1714
		1715	=over 4
		1716
		1717	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1718	still get further invocations!
		1719
		1720	That's because AnyEvent::Handle keeps a reference to itself when handling
		1721	read or write callbacks.
		1722
		1723	It is only safe to "forget" the reference inside EOF or error callbacks,
		1724	from within all other callbacks, you need to explicitly call the C<<
		1725	->destroy >> method.
		1726
		1727	=item I get different callback invocations in TLS mode/Why can't I pause
		1728	reading?
		1729
		1730	Unlike, say, TCP, TLS connections do not consist of two independent
		1731	communication channels, one for each direction. Or put differently. The
		1732	read and write directions are not independent of each other: you cannot
		1733	write data unless you are also prepared to read, and vice versa.
		1734
		1735	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1736	callback invocations when you are not expecting any read data - the reason
		1737	is that AnyEvent::Handle always reads in TLS mode.
		1738
		1739	During the connection, you have to make sure that you always have a
		1740	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1741	connection (or when you no longer want to use it) you can call the
		1742	C<destroy> method.
		1743
		1744	=item How do I read data until the other side closes the connection?
		1745
		1746	If you just want to read your data into a perl scalar, the easiest way
		1747	to achieve this is by setting an C<on_read> callback that does nothing,
		1748	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1749	will be in C<$_[0]{rbuf}>:
		1750
		1751	$handle->on_read (sub { });
		1752	$handle->on_eof (undef);
		1753	$handle->on_error (sub {
		1754	my $data = delete $_[0]{rbuf};
		1755	});
		1756
		1757	The reason to use C<on_error> is that TCP connections, due to latencies
		1758	and packets loss, might get closed quite violently with an error, when in
		1759	fact, all data has been received.
		1760
		1761	It is usually better to use acknowledgements when transferring data,
		1762	to make sure the other side hasn't just died and you got the data
		1763	intact. This is also one reason why so many internet protocols have an
		1764	explicit QUIT command.
		1765
		1766	=item I don't want to destroy the handle too early - how do I wait until
		1767	all data has been written?
		1768
		1769	After writing your last bits of data, set the C<on_drain> callback
		1770	and destroy the handle in there - with the default setting of
		1771	C<low_water_mark> this will be called precisely when all data has been
		1772	written to the socket:
		1773
		1774	$handle->push_write (...);
		1775	$handle->on_drain (sub {
		1776	warn "all data submitted to the kernel\n";
		1777	undef $handle;
		1778	});
		1779
		1780	If you just want to queue some data and then signal EOF to the other side,
		1781	consider using C<< ->push_shutdown >> instead.
		1782
		1783	=item I want to contact a TLS/SSL server, I don't care about security.
		1784
		1785	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1786	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1787	parameter:
		1788
		1789	tcp_connect $host, $port, sub {
		1790	my ($fh) = @_;
		1791
		1792	my $handle = new AnyEvent::Handle
		1793	fh => $fh,
		1794	tls => "connect",
		1795	on_error => sub { ... };
		1796
		1797	$handle->push_write (...);
		1798	};
		1799
		1800	=item I want to contact a TLS/SSL server, I do care about security.
		1801
		1802	Then you should additionally enable certificate verification, including
		1803	peername verification, if the protocol you use supports it (see
		1804	L<AnyEvent::TLS>, C<verify_peername>).
		1805
		1806	E.g. for HTTPS:
		1807
		1808	tcp_connect $host, $port, sub {
		1809	my ($fh) = @_;
		1810
		1811	my $handle = new AnyEvent::Handle
		1812	fh => $fh,
		1813	peername => $host,
		1814	tls => "connect",
		1815	tls_ctx => { verify => 1, verify_peername => "https" },
		1816	...
		1817
		1818	Note that you must specify the hostname you connected to (or whatever
		1819	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1820	peername verification will be done.
		1821
		1822	The above will use the system-dependent default set of trusted CA
		1823	certificates. If you want to check against a specific CA, add the
		1824	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1825
		1826	tls_ctx => {
		1827	verify => 1,
		1828	verify_peername => "https",
		1829	ca_file => "my-ca-cert.pem",
		1830	},
		1831
		1832	=item I want to create a TLS/SSL server, how do I do that?
		1833
		1834	Well, you first need to get a server certificate and key. You have
		1835	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1836	self-signed certificate (cheap. check the search engine of your choice,
		1837	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1838	nice program for that purpose).
		1839
		1840	Then create a file with your private key (in PEM format, see
		1841	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1842	file should then look like this:
		1843
		1844	-----BEGIN RSA PRIVATE KEY-----
		1845	...header data
		1846	... lots of base64'y-stuff
		1847	-----END RSA PRIVATE KEY-----
		1848
		1849	-----BEGIN CERTIFICATE-----
		1850	... lots of base64'y-stuff
		1851	-----END CERTIFICATE-----
		1852
		1853	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1854	specify this file as C<cert_file>:
		1855
		1856	tcp_server undef, $port, sub {
		1857	my ($fh) = @_;
		1858
		1859	my $handle = new AnyEvent::Handle
		1860	fh => $fh,
		1861	tls => "accept",
		1862	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1863	...
		1864
		1865	When you have intermediate CA certificates that your clients might not
		1866	know about, just append them to the C<cert_file>.
		1867
		1868	=back
		1869
1447		1870
1448	=head1 SUBCLASSING AnyEvent::Handle	1871	=head1 SUBCLASSING AnyEvent::Handle
1449		1872
1450	In many cases, you might want to subclass AnyEvent::Handle.	1873	In many cases, you might want to subclass AnyEvent::Handle.
1451		1874

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC vs. Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC vs.
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC