summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-10-12 09:25:10 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-10-12 09:25:10 (GMT)
commit65dc79b7a59ac400119ad5a53b58fc5a9a44f263 (patch)
tree93b5d4953e05dd67d276497c45dce00ddb480645 /Doc/library
parent74895df8fb58e2dc31a7584fa9f8c1ba0af0d706 (diff)
parentc7edffdddd30baab8ecd93ee4b071b01858eac58 (diff)
downloadcpython-65dc79b7a59ac400119ad5a53b58fc5a9a44f263.zip
cpython-65dc79b7a59ac400119ad5a53b58fc5a9a44f263.tar.gz
cpython-65dc79b7a59ac400119ad5a53b58fc5a9a44f263.tar.bz2
Merge 3.4 (asyncio doc)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/asyncio-eventloop.rst3
-rw-r--r--Doc/library/asyncio-protocol.rst103
2 files changed, 99 insertions, 7 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index 0d9b8f4..5ffbea7 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -243,6 +243,9 @@ Creating connections
On Windows with :class:`ProactorEventLoop`, this method is not supported.
+ See :ref:`UDP echo client protocol <asyncio-udp-echo-client-protocol>` and
+ :ref:`UDP echo server protocol <asyncio-udp-echo-server-protocol>` examples.
+
.. method:: BaseEventLoop.create_unix_connection(protocol_factory, path, \*, ssl=None, sock=None, server_hostname=None)
diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst
index 52da1b4..d2f1369 100644
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -473,6 +473,7 @@ having to write a short coroutine to handle the exception and stop the
running loop. At :meth:`~BaseEventLoop.run_until_complete` exit, the loop is
no longer running, so there is no need to stop the loop in case of an error.
+
TCP echo server
---------------
@@ -483,34 +484,122 @@ TCP echo server example, send back received data and close the connection::
class EchoServer(asyncio.Protocol):
def connection_made(self, transport):
peername = transport.get_extra_info('peername')
- print('connection from {}'.format(peername))
+ print('Connection from {}'.format(peername))
self.transport = transport
def data_received(self, data):
- print('data received: {}'.format(data.decode()))
+ message = data.decode()
+ print('Data received: {!r}'.format(message))
+
+ print('Send: {!r}'.format(message))
self.transport.write(data)
- # close the socket
+ print('Close the socket')
self.transport.close()
loop = asyncio.get_event_loop()
coro = loop.create_server(EchoServer, '127.0.0.1', 8888)
server = loop.run_until_complete(coro)
- print('serving on {}'.format(server.sockets[0].getsockname()))
+ # Server requests until CTRL+c is pressed
+ print('Serving on {}'.format(server.sockets[0].getsockname()))
try:
loop.run_forever()
except KeyboardInterrupt:
print("exit")
- finally:
- server.close()
- loop.close()
+
+ # Close the server
+ server.close()
+ loop.run_until_complete(server.wait_closed())
+ loop.close()
:meth:`Transport.close` can be called immediately after
:meth:`WriteTransport.write` even if data are not sent yet on the socket: both
methods are asynchronous. ``yield from`` is not needed because these transport
methods are not coroutines.
+
+.. _asyncio-udp-echo-client-protocol:
+
+UDP echo client protocol
+------------------------
+
+UDP echo client using the :meth:`BaseEventLoop.create_datagram_endpoint`
+method, send data and close the transport when we received the answer::
+
+ import asyncio
+
+ class EchoClientProtocol:
+ def __init__(self, message, loop):
+ self.message = message
+ self.loop = loop
+ self.transport = None
+
+ def connection_made(self, transport):
+ self.transport = transport
+ print('Send:', self.message)
+ self.transport.sendto(self.message.encode())
+
+ def datagram_received(self, data, addr):
+ print("Received:", data.decode())
+
+ print("Close the socket")
+ self.transport.close()
+
+ def error_received(self, exc):
+ print('Error received:', exc)
+
+ def connection_lost(self, exc):
+ print("Socket closed, stop the event loop")
+ loop = asyncio.get_event_loop()
+ loop.stop()
+
+ loop = asyncio.get_event_loop()
+ message = "Hello World!"
+ connect = loop.create_datagram_endpoint(
+ lambda: EchoClientProtocol(message, loop),
+ remote_addr=('127.0.0.1', 9999))
+ transport, protocol = loop.run_until_complete(connect)
+ loop.run_forever()
+ transport.close()
+ loop.close()
+
+
+.. _asyncio-udp-echo-server-protocol:
+
+UDP echo server protocol
+------------------------
+
+UDP echo server using the :meth:`BaseEventLoop.create_datagram_endpoint`
+method, send back received data::
+
+ import asyncio
+
+ class EchoServerClientProtocol:
+ def connection_made(self, transport):
+ self.transport = transport
+
+ def datagram_received(self, data, addr):
+ message = data.decode()
+ print('Received %r from %s' % (message, addr))
+ print('Send %r to %s' % (message, addr))
+ self.transport.sendto(data, addr)
+
+ loop = asyncio.get_event_loop()
+ print("Starting UDP server")
+ listen = loop.create_datagram_endpoint(
+ EchoServerClientProtocol, local_addr=('127.0.0.1', 9999))
+ transport, protocol = loop.run_until_complete(listen)
+
+ try:
+ loop.run_forever()
+ except KeyboardInterrupt:
+ pass
+
+ transport.close()
+ loop.close()
+
+
.. _asyncio-register-socket:
Register an open socket to wait for data using a protocol