Update to Tornado 3.0

libs/tornado/tcpserver.py

@@ -28,13 +28,13 @@ from tornado.iostream import IOStream, SSLIOStream
 from tornado.netutil import bind_sockets, add_accept_handler, ssl_wrap_socket
 from tornado import process
 
+
 class TCPServer(object):
     r"""A non-blocking, single-threaded TCP server.
 
     To use `TCPServer`, define a subclass which overrides the `handle_stream`
     method.
 
-    `TCPServer` can serve SSL traffic with Python 2.6+ and OpenSSL.
     To make this server serve SSL traffic, send the ssl_options dictionary
     argument with the arguments required for the `ssl.wrap_socket` method,
     including "certfile" and "keyfile"::
@@ -59,9 +59,9 @@ class TCPServer(object):
             server.start(0)  # Forks multiple sub-processes
             IOLoop.instance().start()
 
-       When using this interface, an `IOLoop` must *not* be passed
+       When using this interface, an `.IOLoop` must *not* be passed
        to the `TCPServer` constructor.  `start` will always start
-       the server on the default singleton `IOLoop`.
+       the server on the default singleton `.IOLoop`.
 
     3. `add_sockets`: advanced multi-process::
 
@@ -76,7 +76,7 @@ class TCPServer(object):
        flexibility in when the fork happens.  `add_sockets` can
        also be used in single-process servers if you want to create
        your listening sockets in some way other than
-       `bind_sockets`.
+       `~tornado.netutil.bind_sockets`.
     """
     def __init__(self, io_loop=None, ssl_options=None):
         self.io_loop = io_loop
@@ -108,7 +108,7 @@ class TCPServer(object):
         This method may be called more than once to listen on multiple ports.
         `listen` takes effect immediately; it is not necessary to call
         `TCPServer.start` afterwards.  It is, however, necessary to start
-        the `IOLoop`.
+        the `.IOLoop`.
         """
         sockets = bind_sockets(port, address=address)
         self.add_sockets(sockets)
@@ -117,13 +117,13 @@ class TCPServer(object):
         """Makes this server start accepting connections on the given sockets.
 
         The ``sockets`` parameter is a list of socket objects such as
-        those returned by `bind_sockets`.
+        those returned by `~tornado.netutil.bind_sockets`.
         `add_sockets` is typically used in combination with that
         method and `tornado.process.fork_processes` to provide greater
         control over the initialization of a multi-process server.
         """
         if self.io_loop is None:
-            self.io_loop = IOLoop.instance()
+            self.io_loop = IOLoop.current()
 
         for sock in sockets:
             self._sockets[sock.fileno()] = sock
@@ -144,12 +144,12 @@ class TCPServer(object):
         Address may be either an IP address or hostname.  If it's a hostname,
         the server will listen on all IP addresses associated with the
         name.  Address may be an empty string or None to listen on all
-        available interfaces.  Family may be set to either ``socket.AF_INET``
-        or ``socket.AF_INET6`` to restrict to ipv4 or ipv6 addresses, otherwise
+        available interfaces.  Family may be set to either `socket.AF_INET`
+        or `socket.AF_INET6` to restrict to IPv4 or IPv6 addresses, otherwise
         both will be used if available.
 
         The ``backlog`` argument has the same meaning as for
-        `socket.listen`.
+        `socket.listen <socket.socket.listen>`.
 
         This method may be called multiple times prior to `start` to listen
         on multiple ports or interfaces.
@@ -162,7 +162,7 @@ class TCPServer(object):
             self._pending_sockets.extend(sockets)
 
     def start(self, num_processes=1):
-        """Starts this server in the IOLoop.
+        """Starts this server in the `.IOLoop`.
 
         By default, we run the server in this process and do not fork any
         additional child process.
@@ -199,7 +199,7 @@ class TCPServer(object):
             sock.close()
 
     def handle_stream(self, stream, address):
-        """Override to handle a new `IOStream` from an incoming connection."""
+        """Override to handle a new `.IOStream` from an incoming connection."""
         raise NotImplementedError()
 
     def _handle_connection(self, connection, address):