summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-10-12 09:24:26 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-10-12 09:24:26 (GMT)
commitc7edffdddd30baab8ecd93ee4b071b01858eac58 (patch)
tree3d2d03e6ca15eca67ce0d2bb1f89015e5bc26ef4 /Doc/library
parentc2721b41d38cf9f95009e0aa16a07cfea432de57 (diff)
downloadcpython-c7edffdddd30baab8ecd93ee4b071b01858eac58.zip
cpython-c7edffdddd30baab8ecd93ee4b071b01858eac58.tar.gz
cpython-c7edffdddd30baab8ecd93ee4b071b01858eac58.tar.bz2
asyncio doc: add UDP client and server examples
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/asyncio-eventloop.rst3
-rw-r--r--Doc/library/asyncio-protocol.rst82
2 files changed, 85 insertions, 0 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 ec6a479..d2f1369 100644
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -518,6 +518,88 @@ TCP echo server example, send back received data and close the connection::
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