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.207 by root, Mon Nov 15 22:29:36 2010 UTC vs.
Revision 1.208 by root, Sun Dec 5 11:41:45 2010 UTC

2135 2135
2136It is only safe to "forget" the reference inside EOF or error callbacks, 2136It is only safe to "forget" the reference inside EOF or error callbacks,
2137from within all other callbacks, you need to explicitly call the C<< 2137from within all other callbacks, you need to explicitly call the C<<
2138->destroy >> method. 2138->destroy >> method.
2139 2139
2140=item Why is my C<on_eof> callback never called?
2141
2142Probably because your C<on_error> callback is being called instead: When
2143you have outstanding requests in your read queue, then an EOF is
2144considered an error as you clearly expected some data.
2145
2146To avoid this, make sure you have an empty read queue whenever your handle
2147is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
2148an C<on_read> handler that simply pushes the first read requests in the
2149queue.
2150
2151See also the next question, which explains this in a bit more detail.
2152
2153=item How can I serve requests in a loop?
2154
2155Most protocols consist of some setup phase (authentication for example)
2156followed by a request handling phase, where the server waits for requests
2157and handles them, in a loop.
2158
2159There are two important variants: The first (traditional, better) variant
2160handles requests until the server gets some QUIT command, causing it to
2161close the connection first (highly desirable for a busy TCP server). A
2162client dropping the connection is an error, which means this variant can
2163detect an unexpected detection close.
2164
2165To handle this case, always make sure you have a on-empty read queue, by
2166pushing the "read request start" handler on it:
2167
2168 # we assume a request starts with a single line
2169 my @start_request; @start_request = (line => sub {
2170 my ($hdl, $line) = @_;
2171
2172 ... handle request
2173
2174 # push next request read, possibly from a nested callback
2175 $hdl->push_read (@start_request);
2176 });
2177
2178 # auth done, now go into request handling loop
2179 # now push the first @start_request
2180 $hdl->push_read (@start_request);
2181
2182By always having an outstanding C<push_read>, the handle always expects
2183some data and raises the C<EPIPE> error when the connction is dropped
2184unexpectedly.
2185
2186The second variant is a protocol where the client can drop the connection
2187at any time. For TCP, this means that the server machine may run out of
2188sockets easier, and in general, it means you cnanot distinguish a protocl
2189failure/client crash from a normal connection close. Nevertheless, these
2190kinds of protocols are common (and sometimes even the best solution to the
2191problem).
2192
2193Having an outstanding read request at all times is possible if you ignore
2194C<EPIPE> errors, but this doesn't help with when the client drops the
2195connection during a request, which would still be an error.
2196
2197A better solution is to push the initial request read in an C<on_read>
2198callback. This avoids an error, as when the server doesn't expect data
2199(i.e. is idly waiting for the next request, an EOF will not raise an
2200error, but simply result in an C<on_eof> callback. It is also a bit slower
2201and simpler:
2202
2203 # auth done, now go into request handling loop
2204 $hdl->on_read (sub {
2205 my ($hdl) = @_;
2206
2207 # called each time we receive data but the read queue is empty
2208 # simply start read the request
2209
2210 $hdl->push_read (line => sub {
2211 my ($hdl, $line) = @_;
2212
2213 ... handle request
2214
2215 # do nothing special when the request has been handled, just
2216 # let the request queue go empty.
2217 });
2218 });
2219
2140=item I get different callback invocations in TLS mode/Why can't I pause 2220=item I get different callback invocations in TLS mode/Why can't I pause
2141reading? 2221reading?
2142 2222
2143Unlike, say, TCP, TLS connections do not consist of two independent 2223Unlike, say, TCP, TLS connections do not consist of two independent
2144communication channels, one for each direction. Or put differently, the 2224communication channels, one for each direction. Or put differently, the

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines