Detect socket hangup without sending or receiving?

Question

I'm writing a TCP server that can take 15 seconds or more to begin generating the body of a response to certain requests. Some clients like to close the connection at their end if the response takes more than a few seconds to complete.

Since generating the response is very CPU-intensive, I'd prefer to halt the task the instant the client closes the connection. At present, I don't find this out until I send the first payload and receive various hang-up errors.

How can I detect that the peer has closed the connection without sending or receiving any data? That means for recv that all data remains in the kernel, or for send that no data is actually transmitted.

Answer 1

The select module contains what you'll need. If you only need Linux support and have a sufficiently recent kernel, select.epoll() should give you the information you need. Most Unix systems will support select.poll().

If you need cross-platform support, the standard way is to use select.select() to check if the socket is marked as having data available to read. If it is, but recv() returns zero bytes, the other end has hung up.

I've always found Beej's Guide to Network Programming good (note it is written for C, but is generally applicable to standard socket operations), while the Socket Programming How-To has a decent Python overview.

Edit: The following is an example of how a simple server could be written to queue incoming commands but quit processing as soon as it finds the connection has been closed at the remote end.

import select import socket import time  # Create the server. serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) serversocket.bind((socket.gethostname(), 7557)) serversocket.listen(1)  # Wait for an incoming connection. clientsocket, address = serversocket.accept() print 'Connection from', address[0]  # Control variables. queue = [] cancelled = False  while True:     # If nothing queued, wait for incoming request.     if not queue:         queue.append(clientsocket.recv(1024))      # Receive data of length zero ==> connection closed.     if len(queue[0]) == 0:         break      # Get the next request and remove the trailing newline.     request = queue.pop(0)[:-1]     print 'Starting request', request      # Main processing loop.     for i in xrange(15):         # Do some of the processing.         time.sleep(1.0)          # See if the socket is marked as having data ready.         r, w, e = select.select((clientsocket,), (), (), 0)         if r:             data = clientsocket.recv(1024)              # Length of zero ==> connection closed.             if len(data) == 0:                 cancelled = True                 break              # Add this request to the queue.             queue.append(data)             print 'Queueing request', data[:-1]      # Request was cancelled.     if cancelled:         print 'Request cancelled.'         break      # Done with this request.     print 'Request finished.'  # If we got here, the connection was closed. print 'Connection closed.' serversocket.close() 

To use it, run the script and in another terminal telnet to localhost, port 7557. The output from an example run I did, queueing three requests but closing the connection during the processing of the third one:

Connection from 127.0.0.1 Starting request 1 Queueing request 2 Queueing request 3 Request finished. Starting request 2 Request finished. Starting request 3 Request cancelled. Connection closed. 

epoll alternative

Another edit: I've worked up another example using select.epoll to monitor events. I don't think it offers much over the original example as I cannot see a way to receive an event when the remote end hangs up. You still have to monitor the data received event and check for zero length messages (again, I'd love to be proved wrong on this statement).

import select import socket import time  port = 7557  # Create the server. serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) serversocket.bind((socket.gethostname(), port)) serversocket.listen(1) serverfd = serversocket.fileno() print "Listening on", socket.gethostname(), "port", port  # Make the socket non-blocking. serversocket.setblocking(0)  # Initialise the list of clients. clients = {}  # Create an epoll object and register our interest in read events on the server # socket. ep = select.epoll() ep.register(serverfd, select.EPOLLIN)  while True:     # Check for events.     events = ep.poll(0)     for fd, event in events:         # New connection to server.         if fd == serverfd and event & select.EPOLLIN:             # Accept the connection.             connection, address = serversocket.accept()             connection.setblocking(0)              # We want input notifications.             ep.register(connection.fileno(), select.EPOLLIN)              # Store some information about this client.             clients[connection.fileno()] = {                 'delay': 0.0,                 'input': "",                 'response': "",                 'connection': connection,                 'address': address,             }              # Done.             print "Accepted connection from", address          # A socket was closed on our end.         elif event & select.EPOLLHUP:             print "Closed connection to", clients[fd]['address']             ep.unregister(fd)             del clients[fd]          # Error on a connection.         elif event & select.EPOLLERR:             print "Error on connection to", clients[fd]['address']             ep.modify(fd, 0)             clients[fd]['connection'].shutdown(socket.SHUT_RDWR)          # Incoming data.         elif event & select.EPOLLIN:             print "Incoming data from", clients[fd]['address']             data = clients[fd]['connection'].recv(1024)              # Zero length = remote closure.             if not data:                 print "Remote close on ", clients[fd]['address']                 ep.modify(fd, 0)                 clients[fd]['connection'].shutdown(socket.SHUT_RDWR)              # Store the input.             else:                 print data                 clients[fd]['input'] += data          # Run when the client is ready to accept some output. The processing         # loop registers for this event when the response is complete.         elif event & select.EPOLLOUT:             print "Sending output to", clients[fd]['address']              # Write as much as we can.             written = clients[fd]['connection'].send(clients[fd]['response'])              # Delete what we have already written from the complete response.             clients[fd]['response'] = clients[fd]['response'][written:]              # When all the the response is written, shut the connection.             if not clients[fd]['response']:                 ep.modify(fd, 0)                 clients[fd]['connection'].shutdown(socket.SHUT_RDWR)      # Processing loop.     for client in clients.keys():         clients[client]['delay'] += 0.1          # When the 'processing' has finished.         if clients[client]['delay'] >= 15.0:             # Reverse the input to form the response.             clients[client]['response'] = clients[client]['input'][::-1]              # Register for the ready-to-send event. The network loop uses this             # as the signal to send the response.             ep.modify(client, select.EPOLLOUT)          # Processing delay.         time.sleep(0.1) 

Note: This only detects proper shutdowns. If the remote end just stops listening without sending the proper messages, you won't know until you try to write and get an error. Checking for that is left as an exercise for the reader. Also, you probably want to perform some error checking on the overall loop so the server itself is shutdown gracefully if something breaks inside it.