ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC vs.
Revision 1.75 by root, Fri Jul 18 02:14:44 2008 UTC

… …
14 14
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 16
17=cut 17=cut
18 18
19our $VERSION = 4.151; 19our $VERSION = 4.22;
20 20
21=head1 SYNOPSIS 21=head1 SYNOPSIS
22 22
23 use AnyEvent; 23 use AnyEvent;
24 use AnyEvent::Handle; 24 use AnyEvent::Handle;
… …
75NOTE: The filehandle will be set to non-blocking (using 75NOTE: The filehandle will be set to non-blocking (using
76AnyEvent::Util::fh_nonblocking). 76AnyEvent::Util::fh_nonblocking).
77 77
78=item on_eof => $cb->($handle) 78=item on_eof => $cb->($handle)
79 79
80Set the callback to be called when an end-of-file condition is detcted, 80Set the callback to be called when an end-of-file condition is detected,
81i.e. in the case of a socket, when the other side has closed the 81i.e. in the case of a socket, when the other side has closed the
82connection cleanly. 82connection cleanly.
83 83
84While not mandatory, it is highly recommended to set an eof callback, 84While not mandatory, it is highly recommended to set an eof callback,
85otherwise you might end up with a closed socket while you are still 85otherwise you might end up with a closed socket while you are still
… …
162be configured to accept only so-and-so much data that it cannot act on 162be 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 163(for example, when expecting a line, an attacker could send an unlimited
164amount of data without a callback ever being called as long as the line 164amount of data without a callback ever being called as long as the line
165isn't finished). 165isn't finished).
166 166
167=item autocork => <boolean>
168
169When disabled (the default), then C<push_write> will try to immediately
170write the data to the handle if possible. This avoids having to register
171a write watcher and wait for the next event loop iteration, but can be
172inefficient if you write multiple small chunks (this disadvantage is
173usually avoided by your kernel's nagle algorithm, see C<low_delay>).
174
175When enabled, then writes will always be queued till the next event loop
176iteration. This is efficient when you do many small writes per iteration,
177but less efficient when you do a single write only.
178
179=item no_delay => <boolean>
180
181When doing small writes on sockets, your operating system kernel might
182wait a bit for more data before actually sending it out. This is called
183the Nagle algorithm, and usually it is beneficial.
184
185In some situations you want as low a delay as possible, which cna be
186accomplishd by setting this option to true.
187
188The default is your opertaing system's default behaviour, this option
189explicitly enables or disables it, if possible.
190
167=item read_size => <bytes> 191=item read_size => <bytes>
168 192
169The default read block size (the amount of bytes this module will try to read 193The default read block size (the amount of bytes this module will try to read
170during each (loop iteration). Default: C<8192>. 194during each (loop iteration). Default: C<8192>.
171 195
… …
201You can also provide your own TLS connection object, but you have 225You can also provide your own TLS connection object, but you have
202to make sure that you call either C<Net::SSLeay::set_connect_state> 226to make sure that you call either C<Net::SSLeay::set_connect_state>
203or C<Net::SSLeay::set_accept_state> on it before you pass it to 227or C<Net::SSLeay::set_accept_state> on it before you pass it to
204AnyEvent::Handle. 228AnyEvent::Handle.
205 229
206See the C<starttls> method if you need to start TLs negotiation later. 230See the C<starttls> method if you need to start TLS negotiation later.
207 231
208=item tls_ctx => $ssl_ctx 232=item tls_ctx => $ssl_ctx
209 233
210Use the given Net::SSLeay::CTX object to create the new TLS connection 234Use the given Net::SSLeay::CTX object to create the new TLS connection
211(unless a connection object was specified directly). If this parameter is 235(unless a connection object was specified directly). If this parameter is
… …
246 } 270 }
247 271
248 $self->{_activity} = AnyEvent->now; 272 $self->{_activity} = AnyEvent->now;
249 $self->_timeout; 273 $self->_timeout;
250 274
251 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 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};
252 277
253 $self->start_read 278 $self->start_read
254 if $self->{on_read}; 279 if $self->{on_read};
255 280
256 $self 281 $self
… …
318 343
319=cut 344=cut
320 345
321sub on_timeout { 346sub on_timeout {
322 $_[0]{on_timeout} = $_[1]; 347 $_[0]{on_timeout} = $_[1];
348}
349
350=item $handle->autocork ($boolean)
351
352Enables or disables the current autocork behaviour (see C<autocork>
353constructor argument).
354
355=cut
356
357=item $handle->no_delay ($boolean)
358
359Enables or disables the C<no_delay> setting (see constructor argument of
360the same name for details).
361
362=cut
363
364sub no_delay {
365 $_[0]{no_delay} = $_[1];
366
367 eval {
368 local $SIG{__DIE__};
369 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
370 };
323} 371}
324 372
325############################################################################# 373#############################################################################
326 374
327=item $handle->timeout ($seconds) 375=item $handle->timeout ($seconds)
… …
442 $self->_error ($!, 1); 490 $self->_error ($!, 1);
443 } 491 }
444 }; 492 };
445 493
446 # try to write data immediately 494 # try to write data immediately
447 $cb->(); 495 $cb->() unless $self->{autocork};
448 496
449 # if still data left in wbuf, we need to poll 497 # if still data left in wbuf, we need to poll
450 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 498 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
451 if length $self->{wbuf}; 499 if length $self->{wbuf};
452 }; 500 };
… …
1400=over 4 1448=over 4
1401 1449
1402=item * all constructor arguments become object members. 1450=item * all constructor arguments become object members.
1403 1451
1404At least initially, when you pass a C<tls>-argument to the constructor it 1452At least initially, when you pass a C<tls>-argument to the constructor it
1405will end up in C<< $handle->{tls} >>. Those members might be changes or 1453will end up in C<< $handle->{tls} >>. Those members might be changed or
1406mutated later on (for example C<tls> will hold the TLS connection object). 1454mutated later on (for example C<tls> will hold the TLS connection object).
1407 1455
1408=item * other object member names are prefixed with an C<_>. 1456=item * other object member names are prefixed with an C<_>.
1409 1457
1410All object members not explicitly documented (internal use) are prefixed 1458All object members not explicitly documented (internal use) are prefixed

Diff Legend

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