cpython: 7aaf8cff23e5 (original) (raw)
Mercurial > cpython
changeset 103236:7aaf8cff23e5 2.7
#26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs. [#26209]
R David Murray rdmurray@bitdance.com | |
---|---|
date | Wed, 07 Sep 2016 14:09:51 -0400 |
parents | 923a27028cec |
children | 26397c1ea557 |
files | Doc/library/smtpd.rst Doc/library/socket.rst |
diffstat | 2 files changed, 6 insertions(+), 3 deletions(-)[+] [-] Doc/library/smtpd.rst 7 Doc/library/socket.rst 2 |
line wrap: on
line diff
--- a/Doc/library/smtpd.rst
+++ b/Doc/library/smtpd.rst
@@ -23,9 +23,10 @@ SMTPServer Objects
.. class:: SMTPServer(localaddr, remoteaddr)
Create a new :class:SMTPServer
object, which binds to local address
- localaddr. It will treat remoteaddr as an upstream SMTP relayer. It
- inherits from :class:
asyncore.dispatcher
, and so will insert itself into - :mod:
asyncore
's event loop on instantiation.
- localaddr. It will treat remoteaddr as an upstream SMTP relayer. Both
- localaddr and remoteaddr should be a :ref:
(host, port) <host_port>
- tuple. The object inherits from :class:
asyncore.dispatcher
, and so will - insert itself into :mod:
asyncore
's event loop on instantiation.
.. method:: process_message(peer, mailfrom, rcpttos, data)
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -34,6 +34,8 @@ in the C interface: as with :meth:read
files, buffer allocation on receive operations is automatic, and buffer length
is implicit on send operations.
+.. _host_port:
+
Socket addresses are represented as follows: A single string is used for the
:const:AF_UNIX
address family. A pair (host, port)
is used for the
:const:AF_INET
address family, where host is a string representing either a