mirror of
https://github.com/python/cpython.git
synced 2024-12-15 21:04:00 +08:00
asyncio: improve the documentation of servers
- Fix the documentation of Server.close(): it closes sockets - Replace AbstractServer with Server - Document Server.sockets attribute
This commit is contained in:
parent
b28dbac86d
commit
8ebeb03740
@ -263,8 +263,9 @@ Creating listening connections
|
||||
|
||||
.. method:: BaseEventLoop.create_server(protocol_factory, host=None, port=None, \*, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None)
|
||||
|
||||
Create a TCP server bound to host and port. Return an
|
||||
:class:`AbstractServer` object which can be used to stop the service.
|
||||
Create a TCP server bound to host and port. Return a :class:`Server` object,
|
||||
its :attr:`~Server.sockets` attribute contains created sockets. Use the
|
||||
:meth:`Server.close` method to stop the server: close listening sockets.
|
||||
|
||||
This method is a :ref:`coroutine <coroutine>`.
|
||||
|
||||
@ -557,17 +558,31 @@ Debug mode
|
||||
Server
|
||||
------
|
||||
|
||||
.. class:: AbstractServer
|
||||
.. class:: Server
|
||||
|
||||
Abstract server returned by :func:`BaseEventLoop.create_server`.
|
||||
Server listening on sockets.
|
||||
|
||||
Object created by the :meth:`BaseEventLoop.create_server` method and the
|
||||
:func:`start_server` function. Don't instanciate the class directly.
|
||||
|
||||
.. method:: close()
|
||||
|
||||
Stop serving. This leaves existing connections open.
|
||||
Stop serving: close all sockets and set the :attr:`sockets` attribute to
|
||||
``None``.
|
||||
|
||||
The server is closed asynchonously, use the :meth:`wait_closed` coroutine
|
||||
to wait until the server is closed.
|
||||
|
||||
.. method:: wait_closed()
|
||||
|
||||
A :ref:`coroutine <coroutine>` to wait until service is closed.
|
||||
Wait until the :meth:`close` method completes.
|
||||
|
||||
This method is a :ref:`coroutine <coroutine>`.
|
||||
|
||||
.. attribute:: sockets
|
||||
|
||||
List of :class:`socket.socket` objects the server is listening to, or
|
||||
``None`` if the server is closed.
|
||||
|
||||
|
||||
Handle
|
||||
|
@ -34,29 +34,26 @@ Stream functions
|
||||
|
||||
.. function:: start_server(client_connected_cb, host=None, port=None, \*, loop=None, limit=None, **kwds)
|
||||
|
||||
Start a socket server, with a callback for each client connected.
|
||||
Start a socket server, with a callback for each client connected. The return
|
||||
value is the same as :meth:`~BaseEventLoop.create_server()`.
|
||||
|
||||
The first parameter, *client_connected_cb*, takes two parameters:
|
||||
The *client_connected_cb* parameter is called with two parameters:
|
||||
*client_reader*, *client_writer*. *client_reader* is a
|
||||
:class:`StreamReader` object, while *client_writer* is a
|
||||
:class:`StreamWriter` object. This parameter can either be a plain callback
|
||||
function or a :ref:`coroutine function <coroutine>`; if it is a coroutine
|
||||
function, it will be automatically wrapped in a future using the
|
||||
:meth:`BaseEventLoop.create_task` method.
|
||||
:class:`StreamWriter` object. The *client_connected_cb* parameter can
|
||||
either be a plain callback function or a :ref:`coroutine function
|
||||
<coroutine>`; if it is a coroutine function, it will be automatically
|
||||
wrapped in a future using the :meth:`BaseEventLoop.create_task` method.
|
||||
|
||||
The rest of the arguments are all the usual arguments to
|
||||
:meth:`~BaseEventLoop.create_server()` except *protocol_factory*; most
|
||||
common are positional host and port, with various optional keyword arguments
|
||||
following. The return value is the same as
|
||||
:meth:`~BaseEventLoop.create_server()`.
|
||||
common are positional *host* and *port*, with various optional keyword
|
||||
arguments following.
|
||||
|
||||
Additional optional keyword arguments are *loop* (to set the event loop
|
||||
instance to use) and *limit* (to set the buffer limit passed to the
|
||||
:class:`StreamReader`).
|
||||
|
||||
The return value is the same as :meth:`~BaseEventLoop.create_server()`, i.e.
|
||||
a :class:`AbstractServer` object which can be used to stop the service.
|
||||
|
||||
This function is a :ref:`coroutine <coroutine>`.
|
||||
|
||||
.. function:: open_unix_connection(path=None, \*, loop=None, limit=None, **kwds)
|
||||
|
@ -110,6 +110,8 @@ class Server(events.AbstractServer):
|
||||
return
|
||||
self.sockets = None
|
||||
for sock in sockets:
|
||||
# closing sockets will call asynchronously the _detach() method
|
||||
# which calls _wakeup() for the last socket
|
||||
self._loop._stop_serving(sock)
|
||||
if self._active_count == 0:
|
||||
self._wakeup()
|
||||
@ -626,7 +628,7 @@ class BaseEventLoop(events.AbstractEventLoop):
|
||||
reuse_address=None):
|
||||
"""Create a TCP server bound to host and port.
|
||||
|
||||
Return an AbstractServer object which can be used to stop the service.
|
||||
Return an Server object which can be used to stop the service.
|
||||
|
||||
This method is a coroutine.
|
||||
"""
|
||||
|
Loading…
Reference in New Issue
Block a user