[Python-checkins] cpython (3.2): #12781: Mention SO_REUSEADDR flag near socket examples

[sandro.tosi]

http://hg.python.org/cpython/rev/c4588cd2d59a
changeset:   72204:c4588cd2d59a
branch:      3.2
parent:      72194:83c16d258fec
user:        Sandro Tosi <sandro.tosi at gmail.com>
date:        Fri Sep 02 20:06:31 2011 +0200
summary:
  #12781: Mention SO_REUSEADDR flag near socket examples

files:
  Doc/library/socket.rst |  19 +++++++++++++++++++
  1 files changed, 19 insertions(+), 0 deletions(-)


diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -1014,6 +1014,25 @@
    s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)
 
 
+Running an example several times with too small delay between executions, could
+lead to this error::
+
+   socket.error: [Errno 98] Address already in use
+
+This is because the previous execution has left the socket in a ``TIME_WAIT``
+state, and can't be immediately reused.
+
+There is a :mod:`socket` flag to set, in order to prevent this,
+:data:`socket.SO_REUSEADDR`::
+
+   s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+   s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+   s.bind((HOST, PORT))
+
+the :data:`SO_REUSEADDR` flag tells the kernel to reuse a local socket in
+``TIME_WAIT`` state, without waiting for its natural timeout to expire.
+
+
 .. seealso::
 
    For an introduction to socket programming (in C), see the following papers:

-- 
Repository URL: http://hg.python.org/cpython