Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`socket` --- Low-level networking interface |
| 2 | ================================================ |
| 3 | |
| 4 | .. module:: socket |
| 5 | :synopsis: Low-level networking interface. |
| 6 | |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 7 | **Source code:** :source:`Lib/socket.py` |
| 8 | |
| 9 | -------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 10 | |
| 11 | This module provides access to the BSD *socket* interface. It is available on |
Andrew Kuchling | 98f2bbf | 2014-03-01 07:53:28 -0500 | [diff] [blame] | 12 | all modern Unix systems, Windows, MacOS, and probably additional platforms. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 13 | |
| 14 | .. note:: |
| 15 | |
| 16 | Some behavior may be platform dependent, since calls are made to the operating |
| 17 | system socket APIs. |
| 18 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 19 | .. index:: object: socket |
| 20 | |
| 21 | The Python interface is a straightforward transliteration of the Unix system |
| 22 | call and library interface for sockets to Python's object-oriented style: the |
Ezio Melotti | c048d98 | 2013-04-17 04:10:26 +0300 | [diff] [blame] | 23 | :func:`.socket` function returns a :dfn:`socket object` whose methods implement |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 24 | the various socket system calls. Parameter types are somewhat higher-level than |
| 25 | in the C interface: as with :meth:`read` and :meth:`write` operations on Python |
| 26 | files, buffer allocation on receive operations is automatic, and buffer length |
| 27 | is implicit on send operations. |
| 28 | |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 29 | |
Antoine Pitrou | e1bc898 | 2011-01-02 22:12:22 +0000 | [diff] [blame] | 30 | .. seealso:: |
| 31 | |
| 32 | Module :mod:`socketserver` |
| 33 | Classes that simplify writing network servers. |
| 34 | |
| 35 | Module :mod:`ssl` |
| 36 | A TLS/SSL wrapper for socket objects. |
| 37 | |
| 38 | |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 39 | Socket families |
| 40 | --------------- |
| 41 | |
| 42 | Depending on the system and the build options, various socket families |
| 43 | are supported by this module. |
| 44 | |
Antoine Pitrou | 6ec29e2 | 2011-12-16 14:46:36 +0100 | [diff] [blame] | 45 | The address format required by a particular socket object is automatically |
| 46 | selected based on the address family specified when the socket object was |
| 47 | created. Socket addresses are represented as follows: |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 48 | |
Antoine Pitrou | 6ec29e2 | 2011-12-16 14:46:36 +0100 | [diff] [blame] | 49 | - The address of an :const:`AF_UNIX` socket bound to a file system node |
| 50 | is represented as a string, using the file system encoding and the |
| 51 | ``'surrogateescape'`` error handler (see :pep:`383`). An address in |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 52 | Linux's abstract namespace is returned as a :term:`bytes-like object` with |
Antoine Pitrou | 6ec29e2 | 2011-12-16 14:46:36 +0100 | [diff] [blame] | 53 | an initial null byte; note that sockets in this namespace can |
| 54 | communicate with normal file system sockets, so programs intended to |
| 55 | run on Linux may need to deal with both types of address. A string or |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 56 | bytes-like object can be used for either type of address when |
Antoine Pitrou | 6ec29e2 | 2011-12-16 14:46:36 +0100 | [diff] [blame] | 57 | passing it as an argument. |
| 58 | |
| 59 | .. versionchanged:: 3.3 |
| 60 | Previously, :const:`AF_UNIX` socket paths were assumed to use UTF-8 |
| 61 | encoding. |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 62 | |
Berker Peksag | 253739d | 2016-01-30 19:23:29 +0200 | [diff] [blame] | 63 | .. versionchanged:: 3.5 |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 64 | Writable :term:`bytes-like object` is now accepted. |
| 65 | |
R David Murray | 6b46ec7 | 2016-09-07 14:01:23 -0400 | [diff] [blame] | 66 | .. _host_port: |
| 67 | |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 68 | - A pair ``(host, port)`` is used for the :const:`AF_INET` address family, |
| 69 | where *host* is a string representing either a hostname in Internet domain |
| 70 | notation like ``'daring.cwi.nl'`` or an IPv4 address like ``'100.50.200.5'``, |
Sandro Tosi | 27b130e | 2012-06-14 00:37:09 +0200 | [diff] [blame] | 71 | and *port* is an integer. |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 72 | |
johnthagen | 95dfb9c | 2018-07-28 06:03:23 -0400 | [diff] [blame] | 73 | - For IPv4 addresses, two special forms are accepted instead of a host |
| 74 | address: ``''`` represents :const:`INADDR_ANY`, which is used to bind to all |
| 75 | interfaces, and the string ``'<broadcast>'`` represents |
| 76 | :const:`INADDR_BROADCAST`. This behavior is not compatible with IPv6, |
| 77 | therefore, you may want to avoid these if you intend to support IPv6 with your |
| 78 | Python programs. |
| 79 | |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 80 | - For :const:`AF_INET6` address family, a four-tuple ``(host, port, flowinfo, |
| 81 | scopeid)`` is used, where *flowinfo* and *scopeid* represent the ``sin6_flowinfo`` |
| 82 | and ``sin6_scope_id`` members in :const:`struct sockaddr_in6` in C. For |
| 83 | :mod:`socket` module methods, *flowinfo* and *scopeid* can be omitted just for |
| 84 | backward compatibility. Note, however, omission of *scopeid* can cause problems |
| 85 | in manipulating scoped IPv6 addresses. |
| 86 | |
Коренберг Марк | 7766b96 | 2018-02-13 00:47:42 +0500 | [diff] [blame] | 87 | .. versionchanged:: 3.7 |
| 88 | For multicast addresses (with *scopeid* meaningful) *address* may not contain |
| 89 | ``%scope`` (or ``zone id``) part. This information is superfluous and may |
| 90 | be safely omitted (recommended). |
| 91 | |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 92 | - :const:`AF_NETLINK` sockets are represented as pairs ``(pid, groups)``. |
| 93 | |
| 94 | - Linux-only support for TIPC is available using the :const:`AF_TIPC` |
| 95 | address family. TIPC is an open, non-IP based networked protocol designed |
| 96 | for use in clustered computer environments. Addresses are represented by a |
| 97 | tuple, and the fields depend on the address type. The general tuple form is |
| 98 | ``(addr_type, v1, v2, v3 [, scope])``, where: |
| 99 | |
Éric Araujo | c4d7d8c | 2011-11-29 16:46:38 +0100 | [diff] [blame] | 100 | - *addr_type* is one of :const:`TIPC_ADDR_NAMESEQ`, :const:`TIPC_ADDR_NAME`, |
| 101 | or :const:`TIPC_ADDR_ID`. |
| 102 | - *scope* is one of :const:`TIPC_ZONE_SCOPE`, :const:`TIPC_CLUSTER_SCOPE`, and |
| 103 | :const:`TIPC_NODE_SCOPE`. |
| 104 | - If *addr_type* is :const:`TIPC_ADDR_NAME`, then *v1* is the server type, *v2* is |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 105 | the port identifier, and *v3* should be 0. |
| 106 | |
Éric Araujo | c4d7d8c | 2011-11-29 16:46:38 +0100 | [diff] [blame] | 107 | If *addr_type* is :const:`TIPC_ADDR_NAMESEQ`, then *v1* is the server type, *v2* |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 108 | is the lower port number, and *v3* is the upper port number. |
| 109 | |
Éric Araujo | c4d7d8c | 2011-11-29 16:46:38 +0100 | [diff] [blame] | 110 | If *addr_type* is :const:`TIPC_ADDR_ID`, then *v1* is the node, *v2* is the |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 111 | reference, and *v3* should be set to 0. |
| 112 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 113 | - A tuple ``(interface, )`` is used for the :const:`AF_CAN` address family, |
| 114 | where *interface* is a string representing a network interface name like |
| 115 | ``'can0'``. The network interface name ``''`` can be used to receive packets |
| 116 | from all network interfaces of this family. |
| 117 | |
Pier-Yves Lessard | a30f6d4 | 2017-08-28 04:32:44 -0400 | [diff] [blame] | 118 | - :const:`CAN_ISOTP` protocol require a tuple ``(interface, rx_addr, tx_addr)`` |
| 119 | where both additional parameters are unsigned long integer that represent a |
| 120 | CAN identifier (standard or extended). |
| 121 | |
Martin v. Löwis | 9d6c669 | 2012-02-03 17:44:58 +0100 | [diff] [blame] | 122 | - A string or a tuple ``(id, unit)`` is used for the :const:`SYSPROTO_CONTROL` |
| 123 | protocol of the :const:`PF_SYSTEM` family. The string is the name of a |
| 124 | kernel control using a dynamically-assigned ID. The tuple can be used if ID |
| 125 | and unit number of the kernel control are known or if a registered ID is |
| 126 | used. |
| 127 | |
| 128 | .. versionadded:: 3.3 |
| 129 | |
Martin Panter | d1a9858 | 2015-09-09 06:47:58 +0000 | [diff] [blame] | 130 | - :const:`AF_BLUETOOTH` supports the following protocols and address |
| 131 | formats: |
| 132 | |
| 133 | - :const:`BTPROTO_L2CAP` accepts ``(bdaddr, psm)`` where ``bdaddr`` is |
| 134 | the Bluetooth address as a string and ``psm`` is an integer. |
| 135 | |
| 136 | - :const:`BTPROTO_RFCOMM` accepts ``(bdaddr, channel)`` where ``bdaddr`` |
| 137 | is the Bluetooth address as a string and ``channel`` is an integer. |
| 138 | |
| 139 | - :const:`BTPROTO_HCI` accepts ``(device_id,)`` where ``device_id`` is |
| 140 | either an integer or a string with the Bluetooth address of the |
| 141 | interface. (This depends on your OS; NetBSD and DragonFlyBSD expect |
| 142 | a Bluetooth address while everything else expects an integer.) |
| 143 | |
| 144 | .. versionchanged:: 3.2 |
| 145 | NetBSD and DragonFlyBSD support added. |
| 146 | |
| 147 | - :const:`BTPROTO_SCO` accepts ``bdaddr`` where ``bdaddr`` is a |
Martin Panter | d830262 | 2015-09-11 02:23:41 +0000 | [diff] [blame] | 148 | :class:`bytes` object containing the Bluetooth address in a |
Martin Panter | d1a9858 | 2015-09-09 06:47:58 +0000 | [diff] [blame] | 149 | string format. (ex. ``b'12:23:34:45:56:67'``) This protocol is not |
| 150 | supported under FreeBSD. |
| 151 | |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 152 | - :const:`AF_ALG` is a Linux-only socket based interface to Kernel |
| 153 | cryptography. An algorithm socket is configured with a tuple of two to four |
| 154 | elements ``(type, name [, feat [, mask]])``, where: |
| 155 | |
| 156 | - *type* is the algorithm type as string, e.g. ``aead``, ``hash``, |
Christian Heimes | 8c21ab0 | 2016-09-06 00:07:02 +0200 | [diff] [blame] | 157 | ``skcipher`` or ``rng``. |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 158 | |
| 159 | - *name* is the algorithm name and operation mode as string, e.g. |
| 160 | ``sha256``, ``hmac(sha256)``, ``cbc(aes)`` or ``drbg_nopr_ctr_aes256``. |
| 161 | |
| 162 | - *feat* and *mask* are unsigned 32bit integers. |
| 163 | |
| 164 | Availability Linux 2.6.38, some algorithm types require more recent Kernels. |
| 165 | |
| 166 | .. versionadded:: 3.6 |
| 167 | |
caavery | effc12f | 2017-09-06 18:18:10 -0400 | [diff] [blame] | 168 | - :const:`AF_VSOCK` allows communication between virtual machines and |
| 169 | their hosts. The sockets are represented as a ``(CID, port)`` tuple |
| 170 | where the context ID or CID and port are integers. |
| 171 | |
| 172 | Availability: Linux >= 4.8 QEMU >= 2.8 ESX >= 4.0 ESX Workstation >= 6.5 |
| 173 | |
| 174 | .. versionadded:: 3.7 |
| 175 | |
Martin Panter | d1a9858 | 2015-09-09 06:47:58 +0000 | [diff] [blame] | 176 | - Certain other address families (:const:`AF_PACKET`, :const:`AF_CAN`) |
| 177 | support specific representations. |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 178 | |
| 179 | .. XXX document them! |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 180 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 181 | If you use a hostname in the *host* portion of IPv4/v6 socket address, the |
| 182 | program may show a nondeterministic behavior, as Python uses the first address |
| 183 | returned from the DNS resolution. The socket address will be resolved |
| 184 | differently into an actual IPv4/v6 address, depending on the results from DNS |
| 185 | resolution and/or the host configuration. For deterministic behavior use a |
| 186 | numeric address in *host* portion. |
| 187 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 188 | All errors raise exceptions. The normal exceptions for invalid argument types |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 189 | and out-of-memory conditions can be raised; starting from Python 3.3, errors |
| 190 | related to socket or address semantics raise :exc:`OSError` or one of its |
| 191 | subclasses (they used to raise :exc:`socket.error`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 192 | |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 193 | Non-blocking mode is supported through :meth:`~socket.setblocking`. A |
| 194 | generalization of this based on timeouts is supported through |
| 195 | :meth:`~socket.settimeout`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 196 | |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 197 | |
| 198 | Module contents |
| 199 | --------------- |
| 200 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 201 | The module :mod:`socket` exports the following elements. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 202 | |
| 203 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 204 | Exceptions |
| 205 | ^^^^^^^^^^ |
| 206 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 207 | .. exception:: error |
| 208 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 209 | A deprecated alias of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 210 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 211 | .. versionchanged:: 3.3 |
| 212 | Following :pep:`3151`, this class was made an alias of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 213 | |
| 214 | |
| 215 | .. exception:: herror |
| 216 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 217 | A subclass of :exc:`OSError`, this exception is raised for |
Antoine Pitrou | f06576d | 2011-02-28 22:38:07 +0000 | [diff] [blame] | 218 | address-related errors, i.e. for functions that use *h_errno* in the POSIX |
| 219 | C API, including :func:`gethostbyname_ex` and :func:`gethostbyaddr`. |
| 220 | The accompanying value is a pair ``(h_errno, string)`` representing an |
| 221 | error returned by a library call. *h_errno* is a numeric value, while |
| 222 | *string* represents the description of *h_errno*, as returned by the |
| 223 | :c:func:`hstrerror` C function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 224 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 225 | .. versionchanged:: 3.3 |
| 226 | This class was made a subclass of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 227 | |
| 228 | .. exception:: gaierror |
| 229 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 230 | A subclass of :exc:`OSError`, this exception is raised for |
Antoine Pitrou | f06576d | 2011-02-28 22:38:07 +0000 | [diff] [blame] | 231 | address-related errors by :func:`getaddrinfo` and :func:`getnameinfo`. |
| 232 | The accompanying value is a pair ``(error, string)`` representing an error |
| 233 | returned by a library call. *string* represents the description of |
| 234 | *error*, as returned by the :c:func:`gai_strerror` C function. The |
| 235 | numeric *error* value will match one of the :const:`EAI_\*` constants |
| 236 | defined in this module. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 237 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 238 | .. versionchanged:: 3.3 |
| 239 | This class was made a subclass of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 240 | |
| 241 | .. exception:: timeout |
| 242 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 243 | A subclass of :exc:`OSError`, this exception is raised when a timeout |
Antoine Pitrou | f06576d | 2011-02-28 22:38:07 +0000 | [diff] [blame] | 244 | occurs on a socket which has had timeouts enabled via a prior call to |
| 245 | :meth:`~socket.settimeout` (or implicitly through |
| 246 | :func:`~socket.setdefaulttimeout`). The accompanying value is a string |
| 247 | whose value is currently always "timed out". |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 248 | |
Antoine Pitrou | 70fa31c | 2011-10-12 16:20:53 +0200 | [diff] [blame] | 249 | .. versionchanged:: 3.3 |
| 250 | This class was made a subclass of :exc:`OSError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 251 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 252 | |
| 253 | Constants |
| 254 | ^^^^^^^^^ |
| 255 | |
Ethan Furman | 7184bac | 2014-10-14 18:56:53 -0700 | [diff] [blame] | 256 | The AF_* and SOCK_* constants are now :class:`AddressFamily` and |
| 257 | :class:`SocketKind` :class:`.IntEnum` collections. |
| 258 | |
| 259 | .. versionadded:: 3.4 |
| 260 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 261 | .. data:: AF_UNIX |
| 262 | AF_INET |
| 263 | AF_INET6 |
| 264 | |
| 265 | These constants represent the address (and protocol) families, used for the |
Ezio Melotti | c048d98 | 2013-04-17 04:10:26 +0300 | [diff] [blame] | 266 | first argument to :func:`.socket`. If the :const:`AF_UNIX` constant is not |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 267 | defined then this protocol is unsupported. More constants may be available |
| 268 | depending on the system. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 269 | |
| 270 | |
| 271 | .. data:: SOCK_STREAM |
| 272 | SOCK_DGRAM |
| 273 | SOCK_RAW |
| 274 | SOCK_RDM |
| 275 | SOCK_SEQPACKET |
| 276 | |
| 277 | These constants represent the socket types, used for the second argument to |
Ezio Melotti | c048d98 | 2013-04-17 04:10:26 +0300 | [diff] [blame] | 278 | :func:`.socket`. More constants may be available depending on the system. |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 279 | (Only :const:`SOCK_STREAM` and :const:`SOCK_DGRAM` appear to be generally |
| 280 | useful.) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 281 | |
Antoine Pitrou | b1c5496 | 2010-10-14 15:05:38 +0000 | [diff] [blame] | 282 | .. data:: SOCK_CLOEXEC |
| 283 | SOCK_NONBLOCK |
| 284 | |
| 285 | These two constants, if defined, can be combined with the socket types and |
| 286 | allow you to set some flags atomically (thus avoiding possible race |
| 287 | conditions and the need for separate calls). |
| 288 | |
| 289 | .. seealso:: |
| 290 | |
| 291 | `Secure File Descriptor Handling <http://udrepper.livejournal.com/20407.html>`_ |
| 292 | for a more thorough explanation. |
| 293 | |
| 294 | Availability: Linux >= 2.6.27. |
| 295 | |
| 296 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 297 | |
| 298 | .. data:: SO_* |
| 299 | SOMAXCONN |
| 300 | MSG_* |
| 301 | SOL_* |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 302 | SCM_* |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 303 | IPPROTO_* |
| 304 | IPPORT_* |
| 305 | INADDR_* |
| 306 | IP_* |
| 307 | IPV6_* |
| 308 | EAI_* |
| 309 | AI_* |
| 310 | NI_* |
| 311 | TCP_* |
| 312 | |
| 313 | Many constants of these forms, documented in the Unix documentation on sockets |
| 314 | and/or the IP protocol, are also defined in the socket module. They are |
| 315 | generally used in arguments to the :meth:`setsockopt` and :meth:`getsockopt` |
| 316 | methods of socket objects. In most cases, only those symbols that are defined |
| 317 | in the Unix header files are defined; for a few symbols, default values are |
| 318 | provided. |
| 319 | |
R David Murray | bdfa0eb | 2016-08-23 21:12:40 -0400 | [diff] [blame] | 320 | .. versionchanged:: 3.6 |
Victor Stinner | 01f5ae7 | 2017-01-23 12:30:00 +0100 | [diff] [blame] | 321 | ``SO_DOMAIN``, ``SO_PROTOCOL``, ``SO_PEERSEC``, ``SO_PASSSEC``, |
| 322 | ``TCP_USER_TIMEOUT``, ``TCP_CONGESTION`` were added. |
R David Murray | bdfa0eb | 2016-08-23 21:12:40 -0400 | [diff] [blame] | 323 | |
animalize | 19e7d48 | 2018-02-27 02:10:36 +0800 | [diff] [blame] | 324 | .. versionchanged:: 3.6.5 |
| 325 | On Windows, ``TCP_FASTOPEN``, ``TCP_KEEPCNT`` appear if run-time Windows |
| 326 | supports. |
| 327 | |
Nathaniel J. Smith | 1e2147b | 2017-03-22 20:56:55 -0700 | [diff] [blame] | 328 | .. versionchanged:: 3.7 |
| 329 | ``TCP_NOTSENT_LOWAT`` was added. |
| 330 | |
animalize | 19e7d48 | 2018-02-27 02:10:36 +0800 | [diff] [blame] | 331 | On Windows, ``TCP_KEEPIDLE``, ``TCP_KEEPINTVL`` appear if run-time Windows |
| 332 | supports. |
| 333 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 334 | .. data:: AF_CAN |
| 335 | PF_CAN |
| 336 | SOL_CAN_* |
| 337 | CAN_* |
| 338 | |
| 339 | Many constants of these forms, documented in the Linux documentation, are |
| 340 | also defined in the socket module. |
| 341 | |
| 342 | Availability: Linux >= 2.6.25. |
| 343 | |
| 344 | .. versionadded:: 3.3 |
| 345 | |
Charles-François Natali | 773e42d | 2013-02-05 19:42:01 +0100 | [diff] [blame] | 346 | .. data:: CAN_BCM |
| 347 | CAN_BCM_* |
| 348 | |
| 349 | CAN_BCM, in the CAN protocol family, is the broadcast manager (BCM) protocol. |
| 350 | Broadcast manager constants, documented in the Linux documentation, are also |
| 351 | defined in the socket module. |
| 352 | |
| 353 | Availability: Linux >= 2.6.25. |
| 354 | |
| 355 | .. versionadded:: 3.4 |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 356 | |
Larry Hastings | a6cc551 | 2015-04-13 17:48:40 -0400 | [diff] [blame] | 357 | .. data:: CAN_RAW_FD_FRAMES |
| 358 | |
| 359 | Enables CAN FD support in a CAN_RAW socket. This is disabled by default. |
| 360 | This allows your application to send both CAN and CAN FD frames; however, |
| 361 | you one must accept both CAN and CAN FD frames when reading from the socket. |
| 362 | |
| 363 | This constant is documented in the Linux documentation. |
| 364 | |
| 365 | Availability: Linux >= 3.6. |
| 366 | |
| 367 | .. versionadded:: 3.5 |
| 368 | |
Pier-Yves Lessard | a30f6d4 | 2017-08-28 04:32:44 -0400 | [diff] [blame] | 369 | .. data:: CAN_ISOTP |
| 370 | |
| 371 | CAN_ISOTP, in the CAN protocol family, is the ISO-TP (ISO 15765-2) protocol. |
| 372 | ISO-TP constants, documented in the Linux documentation. |
| 373 | |
| 374 | Availability: Linux >= 2.6.25 |
| 375 | |
| 376 | .. versionadded:: 3.7 |
| 377 | |
| 378 | |
Charles-François Natali | 10b8cf4 | 2011-11-10 19:21:37 +0100 | [diff] [blame] | 379 | .. data:: AF_RDS |
| 380 | PF_RDS |
| 381 | SOL_RDS |
| 382 | RDS_* |
| 383 | |
| 384 | Many constants of these forms, documented in the Linux documentation, are |
| 385 | also defined in the socket module. |
| 386 | |
| 387 | Availability: Linux >= 2.6.30. |
| 388 | |
| 389 | .. versionadded:: 3.3 |
| 390 | |
| 391 | |
Steve Dower | ea93ac0 | 2016-06-17 12:52:18 -0700 | [diff] [blame] | 392 | .. data:: SIO_RCVALL |
| 393 | SIO_KEEPALIVE_VALS |
| 394 | SIO_LOOPBACK_FAST_PATH |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 395 | RCVALL_* |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 396 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 397 | Constants for Windows' WSAIoctl(). The constants are used as arguments to the |
Serhiy Storchaka | bfdcd43 | 2013-10-13 23:09:14 +0300 | [diff] [blame] | 398 | :meth:`~socket.socket.ioctl` method of socket objects. |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 399 | |
Steve Dower | ea93ac0 | 2016-06-17 12:52:18 -0700 | [diff] [blame] | 400 | .. versionchanged:: 3.6 |
| 401 | ``SIO_LOOPBACK_FAST_PATH`` was added. |
| 402 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 403 | |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 404 | .. data:: TIPC_* |
| 405 | |
| 406 | TIPC related constants, matching the ones exported by the C socket API. See |
| 407 | the TIPC documentation for more information. |
| 408 | |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 409 | .. data:: AF_ALG |
| 410 | SOL_ALG |
| 411 | ALG_* |
| 412 | |
| 413 | Constants for Linux Kernel cryptography. |
| 414 | |
| 415 | Availability: Linux >= 2.6.38. |
| 416 | |
| 417 | .. versionadded:: 3.6 |
| 418 | |
caavery | effc12f | 2017-09-06 18:18:10 -0400 | [diff] [blame] | 419 | |
| 420 | .. data:: AF_VSOCK |
| 421 | IOCTL_VM_SOCKETS_GET_LOCAL_CID |
| 422 | VMADDR* |
| 423 | SO_VM* |
| 424 | |
| 425 | Constants for Linux host/guest communication. |
| 426 | |
| 427 | Availability: Linux >= 4.8. |
| 428 | |
| 429 | .. versionadded:: 3.7 |
| 430 | |
Giampaolo Rodola' | 80e1c43 | 2013-05-21 21:02:04 +0200 | [diff] [blame] | 431 | .. data:: AF_LINK |
| 432 | |
| 433 | Availability: BSD, OSX. |
| 434 | |
| 435 | .. versionadded:: 3.4 |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 436 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 437 | .. data:: has_ipv6 |
| 438 | |
| 439 | This constant contains a boolean value which indicates if IPv6 is supported on |
| 440 | this platform. |
| 441 | |
Martin Panter | ea7266d | 2015-09-11 23:14:57 +0000 | [diff] [blame] | 442 | .. data:: BDADDR_ANY |
| 443 | BDADDR_LOCAL |
| 444 | |
| 445 | These are string constants containing Bluetooth addresses with special |
| 446 | meanings. For example, :const:`BDADDR_ANY` can be used to indicate |
| 447 | any address when specifying the binding socket with |
| 448 | :const:`BTPROTO_RFCOMM`. |
| 449 | |
| 450 | .. data:: HCI_FILTER |
| 451 | HCI_TIME_STAMP |
| 452 | HCI_DATA_DIR |
| 453 | |
| 454 | For use with :const:`BTPROTO_HCI`. :const:`HCI_FILTER` is not |
| 455 | available for NetBSD or DragonFlyBSD. :const:`HCI_TIME_STAMP` and |
| 456 | :const:`HCI_DATA_DIR` are not available for FreeBSD, NetBSD, or |
| 457 | DragonFlyBSD. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 458 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 459 | Functions |
| 460 | ^^^^^^^^^ |
| 461 | |
| 462 | Creating sockets |
| 463 | '''''''''''''''' |
| 464 | |
| 465 | The following functions all create :ref:`socket objects <socket-objects>`. |
| 466 | |
| 467 | |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 468 | .. function:: socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None) |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 469 | |
| 470 | Create a new socket using the given address family, socket type and protocol |
| 471 | number. The address family should be :const:`AF_INET` (the default), |
| 472 | :const:`AF_INET6`, :const:`AF_UNIX`, :const:`AF_CAN` or :const:`AF_RDS`. The |
| 473 | socket type should be :const:`SOCK_STREAM` (the default), |
| 474 | :const:`SOCK_DGRAM`, :const:`SOCK_RAW` or perhaps one of the other ``SOCK_`` |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 475 | constants. The protocol number is usually zero and may be omitted or in the |
| 476 | case where the address family is :const:`AF_CAN` the protocol should be one |
Christian Heimes | b6e43af | 2018-01-29 22:37:58 +0100 | [diff] [blame] | 477 | of :const:`CAN_RAW`, :const:`CAN_BCM` or :const:`CAN_ISOTP` |
| 478 | |
| 479 | If *fileno* is specified, the values for *family*, *type*, and *proto* are |
| 480 | auto-detected from the specified file descriptor. Auto-detection can be |
| 481 | overruled by calling the function with explicit *family*, *type*, or *proto* |
| 482 | arguments. This only affects how Python represents e.g. the return value |
| 483 | of :meth:`socket.getpeername` but not the actual OS resource. Unlike |
| 484 | :func:`socket.fromfd`, *fileno* will return the same socket and not a |
| 485 | duplicate. This may help close a detached socket using |
Berker Peksag | 24a6109 | 2015-10-08 06:34:01 +0300 | [diff] [blame] | 486 | :meth:`socket.close()`. |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 487 | |
| 488 | The newly created socket is :ref:`non-inheritable <fd_inheritance>`. |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 489 | |
| 490 | .. versionchanged:: 3.3 |
| 491 | The AF_CAN family was added. |
| 492 | The AF_RDS family was added. |
| 493 | |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 494 | .. versionchanged:: 3.4 |
| 495 | The CAN_BCM protocol was added. |
| 496 | |
| 497 | .. versionchanged:: 3.4 |
| 498 | The returned socket is now non-inheritable. |
| 499 | |
Pier-Yves Lessard | a30f6d4 | 2017-08-28 04:32:44 -0400 | [diff] [blame] | 500 | .. versionchanged:: 3.7 |
| 501 | The CAN_ISOTP protocol was added. |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 502 | |
Yury Selivanov | 9818142 | 2017-12-18 20:02:54 -0500 | [diff] [blame] | 503 | .. versionchanged:: 3.7 |
| 504 | When :const:`SOCK_NONBLOCK` or :const:`SOCK_CLOEXEC` |
| 505 | bit flags are applied to *type* they are cleared, and |
| 506 | :attr:`socket.type` will not reflect them. They are still passed |
| 507 | to the underlying system `socket()` call. Therefore:: |
| 508 | |
| 509 | sock = socket.socket( |
| 510 | socket.AF_INET, |
| 511 | socket.SOCK_STREAM | socket.SOCK_NONBLOCK) |
| 512 | |
| 513 | will still create a non-blocking socket on OSes that support |
| 514 | ``SOCK_NONBLOCK``, but ``sock.type`` will be set to |
| 515 | ``socket.SOCK_STREAM``. |
| 516 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 517 | .. function:: socketpair([family[, type[, proto]]]) |
| 518 | |
| 519 | Build a pair of connected socket objects using the given address family, socket |
| 520 | type, and protocol number. Address family, socket type, and protocol number are |
| 521 | as for the :func:`.socket` function above. The default family is :const:`AF_UNIX` |
| 522 | if defined on the platform; otherwise, the default is :const:`AF_INET`. |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 523 | |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 524 | The newly created sockets are :ref:`non-inheritable <fd_inheritance>`. |
| 525 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 526 | .. versionchanged:: 3.2 |
| 527 | The returned socket objects now support the whole socket API, rather |
| 528 | than a subset. |
| 529 | |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 530 | .. versionchanged:: 3.4 |
| 531 | The returned sockets are now non-inheritable. |
| 532 | |
Charles-François Natali | 98c745a | 2014-10-14 21:22:44 +0100 | [diff] [blame] | 533 | .. versionchanged:: 3.5 |
| 534 | Windows support added. |
| 535 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 536 | |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 537 | .. function:: create_connection(address[, timeout[, source_address]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 538 | |
Antoine Pitrou | 889a510 | 2012-01-12 08:06:19 +0100 | [diff] [blame] | 539 | Connect to a TCP service listening on the Internet *address* (a 2-tuple |
| 540 | ``(host, port)``), and return the socket object. This is a higher-level |
| 541 | function than :meth:`socket.connect`: if *host* is a non-numeric hostname, |
| 542 | it will try to resolve it for both :data:`AF_INET` and :data:`AF_INET6`, |
| 543 | and then try to connect to all possible addresses in turn until a |
| 544 | connection succeeds. This makes it easy to write clients that are |
| 545 | compatible to both IPv4 and IPv6. |
| 546 | |
| 547 | Passing the optional *timeout* parameter will set the timeout on the |
| 548 | socket instance before attempting to connect. If no *timeout* is |
| 549 | supplied, the global default timeout setting returned by |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 550 | :func:`getdefaulttimeout` is used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 551 | |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 552 | If supplied, *source_address* must be a 2-tuple ``(host, port)`` for the |
| 553 | socket to bind to as its source address before connecting. If host or port |
| 554 | are '' or 0 respectively the OS default behavior will be used. |
| 555 | |
| 556 | .. versionchanged:: 3.2 |
| 557 | *source_address* was added. |
| 558 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 559 | |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 560 | .. function:: fromfd(fd, family, type, proto=0) |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 561 | |
| 562 | Duplicate the file descriptor *fd* (an integer as returned by a file object's |
| 563 | :meth:`fileno` method) and build a socket object from the result. Address |
| 564 | family, socket type and protocol number are as for the :func:`.socket` function |
| 565 | above. The file descriptor should refer to a socket, but this is not checked --- |
| 566 | subsequent operations on the object may fail if the file descriptor is invalid. |
| 567 | This function is rarely needed, but can be used to get or set socket options on |
| 568 | a socket passed to a program as standard input or output (such as a server |
| 569 | started by the Unix inet daemon). The socket is assumed to be in blocking mode. |
| 570 | |
Antoine Pitrou | f9c5494 | 2013-12-04 21:15:24 +0100 | [diff] [blame] | 571 | The newly created socket is :ref:`non-inheritable <fd_inheritance>`. |
| 572 | |
| 573 | .. versionchanged:: 3.4 |
| 574 | The returned socket is now non-inheritable. |
| 575 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 576 | |
| 577 | .. function:: fromshare(data) |
| 578 | |
| 579 | Instantiate a socket from data obtained from the :meth:`socket.share` |
| 580 | method. The socket is assumed to be in blocking mode. |
| 581 | |
| 582 | Availability: Windows. |
| 583 | |
| 584 | .. versionadded:: 3.3 |
| 585 | |
| 586 | |
| 587 | .. data:: SocketType |
| 588 | |
| 589 | This is a Python type object that represents the socket object type. It is the |
| 590 | same as ``type(socket(...))``. |
| 591 | |
| 592 | |
| 593 | Other functions |
| 594 | ''''''''''''''' |
| 595 | |
| 596 | The :mod:`socket` module also offers various network-related services: |
| 597 | |
| 598 | |
Christian Heimes | d0e31b9 | 2018-01-27 09:54:13 +0100 | [diff] [blame] | 599 | .. function:: close(fd) |
| 600 | |
| 601 | Close a socket file descriptor. This is like :func:`os.close`, but for |
| 602 | sockets. On some platforms (most noticeable Windows) :func:`os.close` |
| 603 | does not work for socket file descriptors. |
| 604 | |
| 605 | .. versionadded:: 3.7 |
| 606 | |
Giampaolo Rodolà | ccfb91c | 2010-08-17 15:30:23 +0000 | [diff] [blame] | 607 | .. function:: getaddrinfo(host, port, family=0, type=0, proto=0, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 608 | |
Antoine Pitrou | 9103597 | 2010-05-31 17:04:40 +0000 | [diff] [blame] | 609 | Translate the *host*/*port* argument into a sequence of 5-tuples that contain |
| 610 | all the necessary arguments for creating a socket connected to that service. |
| 611 | *host* is a domain name, a string representation of an IPv4/v6 address |
| 612 | or ``None``. *port* is a string service name such as ``'http'``, a numeric |
| 613 | port number or ``None``. By passing ``None`` as the value of *host* |
| 614 | and *port*, you can pass ``NULL`` to the underlying C API. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 615 | |
Giampaolo Rodolà | ccfb91c | 2010-08-17 15:30:23 +0000 | [diff] [blame] | 616 | The *family*, *type* and *proto* arguments can be optionally specified |
Antoine Pitrou | 9103597 | 2010-05-31 17:04:40 +0000 | [diff] [blame] | 617 | in order to narrow the list of addresses returned. Passing zero as a |
| 618 | value for each of these arguments selects the full range of results. |
| 619 | The *flags* argument can be one or several of the ``AI_*`` constants, |
| 620 | and will influence how results are computed and returned. |
| 621 | For example, :const:`AI_NUMERICHOST` will disable domain name resolution |
| 622 | and will raise an error if *host* is a domain name. |
| 623 | |
| 624 | The function returns a list of 5-tuples with the following structure: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 625 | |
Giampaolo Rodolà | ccfb91c | 2010-08-17 15:30:23 +0000 | [diff] [blame] | 626 | ``(family, type, proto, canonname, sockaddr)`` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 627 | |
Giampaolo Rodolà | ccfb91c | 2010-08-17 15:30:23 +0000 | [diff] [blame] | 628 | In these tuples, *family*, *type*, *proto* are all integers and are |
Ezio Melotti | c048d98 | 2013-04-17 04:10:26 +0300 | [diff] [blame] | 629 | meant to be passed to the :func:`.socket` function. *canonname* will be |
Antoine Pitrou | 9103597 | 2010-05-31 17:04:40 +0000 | [diff] [blame] | 630 | a string representing the canonical name of the *host* if |
| 631 | :const:`AI_CANONNAME` is part of the *flags* argument; else *canonname* |
| 632 | will be empty. *sockaddr* is a tuple describing a socket address, whose |
| 633 | format depends on the returned *family* (a ``(address, port)`` 2-tuple for |
| 634 | :const:`AF_INET`, a ``(address, port, flow info, scope id)`` 4-tuple for |
| 635 | :const:`AF_INET6`), and is meant to be passed to the :meth:`socket.connect` |
| 636 | method. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 637 | |
Antoine Pitrou | 9103597 | 2010-05-31 17:04:40 +0000 | [diff] [blame] | 638 | The following example fetches address information for a hypothetical TCP |
Ned Deily | 11cf4f6 | 2015-06-01 21:19:30 -0700 | [diff] [blame] | 639 | connection to ``example.org`` on port 80 (results may differ on your |
Antoine Pitrou | 9103597 | 2010-05-31 17:04:40 +0000 | [diff] [blame] | 640 | system if IPv6 isn't enabled):: |
| 641 | |
Ned Deily | 11cf4f6 | 2015-06-01 21:19:30 -0700 | [diff] [blame] | 642 | >>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP) |
Ned Deily | 1b79e2d | 2015-06-01 18:52:48 -0700 | [diff] [blame] | 643 | [(<AddressFamily.AF_INET6: 10>, <SocketType.SOCK_STREAM: 1>, |
Ned Deily | 11cf4f6 | 2015-06-01 21:19:30 -0700 | [diff] [blame] | 644 | 6, '', ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)), |
Ned Deily | 1b79e2d | 2015-06-01 18:52:48 -0700 | [diff] [blame] | 645 | (<AddressFamily.AF_INET: 2>, <SocketType.SOCK_STREAM: 1>, |
Ned Deily | 11cf4f6 | 2015-06-01 21:19:30 -0700 | [diff] [blame] | 646 | 6, '', ('93.184.216.34', 80))] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 647 | |
Giampaolo Rodolà | ccfb91c | 2010-08-17 15:30:23 +0000 | [diff] [blame] | 648 | .. versionchanged:: 3.2 |
Andrew Kuchling | 46ff4ee | 2014-02-15 16:39:37 -0500 | [diff] [blame] | 649 | parameters can now be passed using keyword arguments. |
Giampaolo Rodolà | ccfb91c | 2010-08-17 15:30:23 +0000 | [diff] [blame] | 650 | |
Коренберг Марк | 7766b96 | 2018-02-13 00:47:42 +0500 | [diff] [blame] | 651 | .. versionchanged:: 3.7 |
| 652 | for IPv6 multicast addresses, string representing an address will not |
| 653 | contain ``%scope`` part. |
| 654 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 655 | .. function:: getfqdn([name]) |
| 656 | |
| 657 | Return a fully qualified domain name for *name*. If *name* is omitted or empty, |
| 658 | it is interpreted as the local host. To find the fully qualified name, the |
Benjamin Peterson | e9bbc8b | 2008-09-28 02:06:32 +0000 | [diff] [blame] | 659 | hostname returned by :func:`gethostbyaddr` is checked, followed by aliases for the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 660 | host, if available. The first name which includes a period is selected. In |
| 661 | case no fully qualified domain name is available, the hostname as returned by |
| 662 | :func:`gethostname` is returned. |
| 663 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 664 | |
| 665 | .. function:: gethostbyname(hostname) |
| 666 | |
| 667 | Translate a host name to IPv4 address format. The IPv4 address is returned as a |
| 668 | string, such as ``'100.50.200.5'``. If the host name is an IPv4 address itself |
| 669 | it is returned unchanged. See :func:`gethostbyname_ex` for a more complete |
| 670 | interface. :func:`gethostbyname` does not support IPv6 name resolution, and |
| 671 | :func:`getaddrinfo` should be used instead for IPv4/v6 dual stack support. |
| 672 | |
| 673 | |
| 674 | .. function:: gethostbyname_ex(hostname) |
| 675 | |
| 676 | Translate a host name to IPv4 address format, extended interface. Return a |
| 677 | triple ``(hostname, aliaslist, ipaddrlist)`` where *hostname* is the primary |
| 678 | host name responding to the given *ip_address*, *aliaslist* is a (possibly |
| 679 | empty) list of alternative host names for the same address, and *ipaddrlist* is |
| 680 | a list of IPv4 addresses for the same interface on the same host (often but not |
| 681 | always a single address). :func:`gethostbyname_ex` does not support IPv6 name |
| 682 | resolution, and :func:`getaddrinfo` should be used instead for IPv4/v6 dual |
| 683 | stack support. |
| 684 | |
| 685 | |
| 686 | .. function:: gethostname() |
| 687 | |
| 688 | Return a string containing the hostname of the machine where the Python |
Benjamin Peterson | 65676e4 | 2008-11-05 21:42:45 +0000 | [diff] [blame] | 689 | interpreter is currently executing. |
| 690 | |
Benjamin Peterson | 65676e4 | 2008-11-05 21:42:45 +0000 | [diff] [blame] | 691 | Note: :func:`gethostname` doesn't always return the fully qualified domain |
Berker Peksag | 2a8baed | 2015-05-19 01:31:00 +0300 | [diff] [blame] | 692 | name; use :func:`getfqdn` for that. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 693 | |
| 694 | |
| 695 | .. function:: gethostbyaddr(ip_address) |
| 696 | |
| 697 | Return a triple ``(hostname, aliaslist, ipaddrlist)`` where *hostname* is the |
| 698 | primary host name responding to the given *ip_address*, *aliaslist* is a |
| 699 | (possibly empty) list of alternative host names for the same address, and |
| 700 | *ipaddrlist* is a list of IPv4/v6 addresses for the same interface on the same |
| 701 | host (most likely containing only a single address). To find the fully qualified |
| 702 | domain name, use the function :func:`getfqdn`. :func:`gethostbyaddr` supports |
| 703 | both IPv4 and IPv6. |
| 704 | |
| 705 | |
| 706 | .. function:: getnameinfo(sockaddr, flags) |
| 707 | |
| 708 | Translate a socket address *sockaddr* into a 2-tuple ``(host, port)``. Depending |
| 709 | on the settings of *flags*, the result can contain a fully-qualified domain name |
| 710 | or numeric address representation in *host*. Similarly, *port* can contain a |
| 711 | string port name or a numeric port number. |
| 712 | |
Коренберг Марк | 7766b96 | 2018-02-13 00:47:42 +0500 | [diff] [blame] | 713 | For IPv6 addresses, ``%scope`` is appended to the host part if *sockaddr* |
| 714 | contains meaningful *scopeid*. Usually this happens for multicast addresses. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 715 | |
| 716 | .. function:: getprotobyname(protocolname) |
| 717 | |
| 718 | Translate an Internet protocol name (for example, ``'icmp'``) to a constant |
Ezio Melotti | c048d98 | 2013-04-17 04:10:26 +0300 | [diff] [blame] | 719 | suitable for passing as the (optional) third argument to the :func:`.socket` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 720 | function. This is usually only needed for sockets opened in "raw" mode |
| 721 | (:const:`SOCK_RAW`); for the normal socket modes, the correct protocol is chosen |
| 722 | automatically if the protocol is omitted or zero. |
| 723 | |
| 724 | |
| 725 | .. function:: getservbyname(servicename[, protocolname]) |
| 726 | |
| 727 | Translate an Internet service name and protocol name to a port number for that |
| 728 | service. The optional protocol name, if given, should be ``'tcp'`` or |
| 729 | ``'udp'``, otherwise any protocol will match. |
| 730 | |
| 731 | |
| 732 | .. function:: getservbyport(port[, protocolname]) |
| 733 | |
| 734 | Translate an Internet port number and protocol name to a service name for that |
| 735 | service. The optional protocol name, if given, should be ``'tcp'`` or |
| 736 | ``'udp'``, otherwise any protocol will match. |
| 737 | |
| 738 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 739 | .. function:: ntohl(x) |
| 740 | |
| 741 | Convert 32-bit positive integers from network to host byte order. On machines |
| 742 | where the host byte order is the same as network byte order, this is a no-op; |
| 743 | otherwise, it performs a 4-byte swap operation. |
| 744 | |
| 745 | |
| 746 | .. function:: ntohs(x) |
| 747 | |
| 748 | Convert 16-bit positive integers from network to host byte order. On machines |
| 749 | where the host byte order is the same as network byte order, this is a no-op; |
| 750 | otherwise, it performs a 2-byte swap operation. |
| 751 | |
Serhiy Storchaka | 6a7d348 | 2016-10-02 12:34:40 +0300 | [diff] [blame] | 752 | .. deprecated:: 3.7 |
| 753 | In case *x* does not fit in 16-bit unsigned integer, but does fit in a |
| 754 | positive C int, it is silently truncated to 16-bit unsigned integer. |
| 755 | This silent truncation feature is deprecated, and will raise an |
| 756 | exception in future versions of Python. |
| 757 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 758 | |
| 759 | .. function:: htonl(x) |
| 760 | |
| 761 | Convert 32-bit positive integers from host to network byte order. On machines |
| 762 | where the host byte order is the same as network byte order, this is a no-op; |
| 763 | otherwise, it performs a 4-byte swap operation. |
| 764 | |
| 765 | |
| 766 | .. function:: htons(x) |
| 767 | |
| 768 | Convert 16-bit positive integers from host to network byte order. On machines |
| 769 | where the host byte order is the same as network byte order, this is a no-op; |
| 770 | otherwise, it performs a 2-byte swap operation. |
| 771 | |
Serhiy Storchaka | 6a7d348 | 2016-10-02 12:34:40 +0300 | [diff] [blame] | 772 | .. deprecated:: 3.7 |
| 773 | In case *x* does not fit in 16-bit unsigned integer, but does fit in a |
| 774 | positive C int, it is silently truncated to 16-bit unsigned integer. |
| 775 | This silent truncation feature is deprecated, and will raise an |
| 776 | exception in future versions of Python. |
| 777 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 778 | |
| 779 | .. function:: inet_aton(ip_string) |
| 780 | |
| 781 | Convert an IPv4 address from dotted-quad string format (for example, |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 782 | '123.45.67.89') to 32-bit packed binary format, as a bytes object four characters in |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 783 | length. This is useful when conversing with a program that uses the standard C |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 784 | library and needs objects of type :c:type:`struct in_addr`, which is the C type |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 785 | for the 32-bit packed binary this function returns. |
| 786 | |
Georg Brandl | f5123ef | 2009-06-04 10:28:36 +0000 | [diff] [blame] | 787 | :func:`inet_aton` also accepts strings with less than three dots; see the |
| 788 | Unix manual page :manpage:`inet(3)` for details. |
| 789 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 790 | If the IPv4 address string passed to this function is invalid, |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 791 | :exc:`OSError` will be raised. Note that exactly what is valid depends on |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 792 | the underlying C implementation of :c:func:`inet_aton`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 793 | |
Georg Brandl | 5f25972 | 2009-05-04 20:50:30 +0000 | [diff] [blame] | 794 | :func:`inet_aton` does not support IPv6, and :func:`inet_pton` should be used |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 795 | instead for IPv4/v6 dual stack support. |
| 796 | |
| 797 | |
| 798 | .. function:: inet_ntoa(packed_ip) |
| 799 | |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 800 | Convert a 32-bit packed IPv4 address (a :term:`bytes-like object` four |
| 801 | bytes in length) to its standard dotted-quad string representation (for example, |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 802 | '123.45.67.89'). This is useful when conversing with a program that uses the |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 803 | standard C library and needs objects of type :c:type:`struct in_addr`, which |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 804 | is the C type for the 32-bit packed binary data this function takes as an |
| 805 | argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 806 | |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 807 | If the byte sequence passed to this function is not exactly 4 bytes in |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 808 | length, :exc:`OSError` will be raised. :func:`inet_ntoa` does not |
Georg Brandl | 5f25972 | 2009-05-04 20:50:30 +0000 | [diff] [blame] | 809 | support IPv6, and :func:`inet_ntop` should be used instead for IPv4/v6 dual |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 810 | stack support. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 811 | |
Georg Brandl | 8c16cb9 | 2016-02-25 20:17:45 +0100 | [diff] [blame] | 812 | .. versionchanged:: 3.5 |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 813 | Writable :term:`bytes-like object` is now accepted. |
| 814 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 815 | |
| 816 | .. function:: inet_pton(address_family, ip_string) |
| 817 | |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 818 | Convert an IP address from its family-specific string format to a packed, |
| 819 | binary format. :func:`inet_pton` is useful when a library or network protocol |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 820 | calls for an object of type :c:type:`struct in_addr` (similar to |
| 821 | :func:`inet_aton`) or :c:type:`struct in6_addr`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 822 | |
| 823 | Supported values for *address_family* are currently :const:`AF_INET` and |
| 824 | :const:`AF_INET6`. If the IP address string *ip_string* is invalid, |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 825 | :exc:`OSError` will be raised. Note that exactly what is valid depends on |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 826 | both the value of *address_family* and the underlying implementation of |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 827 | :c:func:`inet_pton`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 828 | |
Atsuo Ishimoto | da0fc14 | 2012-07-16 15:16:54 +0900 | [diff] [blame] | 829 | Availability: Unix (maybe not all platforms), Windows. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 830 | |
R David Murray | 6c50101 | 2014-03-07 21:22:39 -0500 | [diff] [blame] | 831 | .. versionchanged:: 3.4 |
| 832 | Windows support added |
| 833 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 834 | |
| 835 | .. function:: inet_ntop(address_family, packed_ip) |
| 836 | |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 837 | Convert a packed IP address (a :term:`bytes-like object` of some number of |
| 838 | bytes) to its standard, family-specific string representation (for |
| 839 | example, ``'7.10.0.5'`` or ``'5aef:2b::8'``). |
| 840 | :func:`inet_ntop` is useful when a library or network protocol returns an |
| 841 | object of type :c:type:`struct in_addr` (similar to :func:`inet_ntoa`) or |
| 842 | :c:type:`struct in6_addr`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 843 | |
| 844 | Supported values for *address_family* are currently :const:`AF_INET` and |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 845 | :const:`AF_INET6`. If the bytes object *packed_ip* is not the correct |
| 846 | length for the specified address family, :exc:`ValueError` will be raised. |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 847 | :exc:`OSError` is raised for errors from the call to :func:`inet_ntop`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 848 | |
Atsuo Ishimoto | da0fc14 | 2012-07-16 15:16:54 +0900 | [diff] [blame] | 849 | Availability: Unix (maybe not all platforms), Windows. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 850 | |
R David Murray | 6c50101 | 2014-03-07 21:22:39 -0500 | [diff] [blame] | 851 | .. versionchanged:: 3.4 |
| 852 | Windows support added |
| 853 | |
Georg Brandl | 8c16cb9 | 2016-02-25 20:17:45 +0100 | [diff] [blame] | 854 | .. versionchanged:: 3.5 |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 855 | Writable :term:`bytes-like object` is now accepted. |
| 856 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 857 | |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 858 | .. |
| 859 | XXX: Are sendmsg(), recvmsg() and CMSG_*() available on any |
| 860 | non-Unix platforms? The old (obsolete?) 4.2BSD form of the |
| 861 | interface, in which struct msghdr has no msg_control or |
| 862 | msg_controllen members, is not currently supported. |
| 863 | |
| 864 | .. function:: CMSG_LEN(length) |
| 865 | |
| 866 | Return the total length, without trailing padding, of an ancillary |
| 867 | data item with associated data of the given *length*. This value |
| 868 | can often be used as the buffer size for :meth:`~socket.recvmsg` to |
| 869 | receive a single item of ancillary data, but :rfc:`3542` requires |
| 870 | portable applications to use :func:`CMSG_SPACE` and thus include |
| 871 | space for padding, even when the item will be the last in the |
| 872 | buffer. Raises :exc:`OverflowError` if *length* is outside the |
| 873 | permissible range of values. |
| 874 | |
| 875 | Availability: most Unix platforms, possibly others. |
| 876 | |
| 877 | .. versionadded:: 3.3 |
| 878 | |
| 879 | |
| 880 | .. function:: CMSG_SPACE(length) |
| 881 | |
| 882 | Return the buffer size needed for :meth:`~socket.recvmsg` to |
| 883 | receive an ancillary data item with associated data of the given |
| 884 | *length*, along with any trailing padding. The buffer space needed |
| 885 | to receive multiple items is the sum of the :func:`CMSG_SPACE` |
| 886 | values for their associated data lengths. Raises |
| 887 | :exc:`OverflowError` if *length* is outside the permissible range |
| 888 | of values. |
| 889 | |
| 890 | Note that some systems might support ancillary data without |
| 891 | providing this function. Also note that setting the buffer size |
| 892 | using the results of this function may not precisely limit the |
| 893 | amount of ancillary data that can be received, since additional |
| 894 | data may be able to fit into the padding area. |
| 895 | |
| 896 | Availability: most Unix platforms, possibly others. |
| 897 | |
| 898 | .. versionadded:: 3.3 |
| 899 | |
| 900 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 901 | .. function:: getdefaulttimeout() |
| 902 | |
Ezio Melotti | 388c945 | 2011-08-14 08:28:57 +0300 | [diff] [blame] | 903 | Return the default timeout in seconds (float) for new socket objects. A value |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 904 | of ``None`` indicates that new socket objects have no timeout. When the socket |
| 905 | module is first imported, the default is ``None``. |
| 906 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 907 | |
| 908 | .. function:: setdefaulttimeout(timeout) |
| 909 | |
Ezio Melotti | 388c945 | 2011-08-14 08:28:57 +0300 | [diff] [blame] | 910 | Set the default timeout in seconds (float) for new socket objects. When |
Antoine Pitrou | dfad7e3 | 2011-01-05 21:17:36 +0000 | [diff] [blame] | 911 | the socket module is first imported, the default is ``None``. See |
| 912 | :meth:`~socket.settimeout` for possible values and their respective |
| 913 | meanings. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 914 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 915 | |
Antoine Pitrou | 061cfb5 | 2011-02-28 22:25:22 +0000 | [diff] [blame] | 916 | .. function:: sethostname(name) |
| 917 | |
Serhiy Storchaka | d65c949 | 2015-11-02 14:10:23 +0200 | [diff] [blame] | 918 | Set the machine's hostname to *name*. This will raise an |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 919 | :exc:`OSError` if you don't have enough rights. |
Antoine Pitrou | 061cfb5 | 2011-02-28 22:25:22 +0000 | [diff] [blame] | 920 | |
| 921 | Availability: Unix. |
| 922 | |
| 923 | .. versionadded:: 3.3 |
| 924 | |
| 925 | |
Gregory P. Smith | 5ed2e77 | 2011-05-15 00:26:45 -0700 | [diff] [blame] | 926 | .. function:: if_nameindex() |
| 927 | |
Gregory P. Smith | b6471db | 2011-05-22 22:47:55 -0700 | [diff] [blame] | 928 | Return a list of network interface information |
| 929 | (index int, name string) tuples. |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 930 | :exc:`OSError` if the system call fails. |
Gregory P. Smith | 5ed2e77 | 2011-05-15 00:26:45 -0700 | [diff] [blame] | 931 | |
| 932 | Availability: Unix. |
| 933 | |
| 934 | .. versionadded:: 3.3 |
| 935 | |
| 936 | |
| 937 | .. function:: if_nametoindex(if_name) |
| 938 | |
Gregory P. Smith | b6471db | 2011-05-22 22:47:55 -0700 | [diff] [blame] | 939 | Return a network interface index number corresponding to an |
| 940 | interface name. |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 941 | :exc:`OSError` if no interface with the given name exists. |
Gregory P. Smith | 5ed2e77 | 2011-05-15 00:26:45 -0700 | [diff] [blame] | 942 | |
| 943 | Availability: Unix. |
| 944 | |
| 945 | .. versionadded:: 3.3 |
| 946 | |
| 947 | |
| 948 | .. function:: if_indextoname(if_index) |
| 949 | |
Serhiy Storchaka | d65c949 | 2015-11-02 14:10:23 +0200 | [diff] [blame] | 950 | Return a network interface name corresponding to an |
Gregory P. Smith | b6471db | 2011-05-22 22:47:55 -0700 | [diff] [blame] | 951 | interface index number. |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 952 | :exc:`OSError` if no interface with the given index exists. |
Gregory P. Smith | 5ed2e77 | 2011-05-15 00:26:45 -0700 | [diff] [blame] | 953 | |
| 954 | Availability: Unix. |
| 955 | |
| 956 | .. versionadded:: 3.3 |
| 957 | |
| 958 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 959 | .. _socket-objects: |
| 960 | |
| 961 | Socket Objects |
| 962 | -------------- |
| 963 | |
Antoine Pitrou | e3658a7 | 2013-12-04 21:02:42 +0100 | [diff] [blame] | 964 | Socket objects have the following methods. Except for |
| 965 | :meth:`~socket.makefile`, these correspond to Unix system calls applicable |
| 966 | to sockets. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 967 | |
Martin Panter | e37fc18 | 2016-04-24 04:24:36 +0000 | [diff] [blame] | 968 | .. versionchanged:: 3.2 |
| 969 | Support for the :term:`context manager` protocol was added. Exiting the |
| 970 | context manager is equivalent to calling :meth:`~socket.close`. |
| 971 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 972 | |
| 973 | .. method:: socket.accept() |
| 974 | |
| 975 | Accept a connection. The socket must be bound to an address and listening for |
| 976 | connections. The return value is a pair ``(conn, address)`` where *conn* is a |
| 977 | *new* socket object usable to send and receive data on the connection, and |
| 978 | *address* is the address bound to the socket on the other end of the connection. |
| 979 | |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 980 | The newly created socket is :ref:`non-inheritable <fd_inheritance>`. |
| 981 | |
| 982 | .. versionchanged:: 3.4 |
| 983 | The socket is now non-inheritable. |
| 984 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 985 | .. versionchanged:: 3.5 |
| 986 | If the system call is interrupted and the signal handler does not raise |
| 987 | an exception, the method now retries the system call instead of raising |
| 988 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 989 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 990 | |
| 991 | .. method:: socket.bind(address) |
| 992 | |
| 993 | Bind the socket to *address*. The socket must not already be bound. (The format |
| 994 | of *address* depends on the address family --- see above.) |
| 995 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 996 | |
| 997 | .. method:: socket.close() |
| 998 | |
Antoine Pitrou | e3658a7 | 2013-12-04 21:02:42 +0100 | [diff] [blame] | 999 | Mark the socket closed. The underlying system resource (e.g. a file |
| 1000 | descriptor) is also closed when all file objects from :meth:`makefile()` |
| 1001 | are closed. Once that happens, all future operations on the socket |
| 1002 | object will fail. The remote end will receive no more data (after |
| 1003 | queued data is flushed). |
| 1004 | |
| 1005 | Sockets are automatically closed when they are garbage-collected, but |
| 1006 | it is recommended to :meth:`close` them explicitly, or to use a |
| 1007 | :keyword:`with` statement around them. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1008 | |
Martin Panter | 50ab1a3 | 2016-04-11 00:38:12 +0000 | [diff] [blame] | 1009 | .. versionchanged:: 3.6 |
| 1010 | :exc:`OSError` is now raised if an error occurs when the underlying |
| 1011 | :c:func:`close` call is made. |
| 1012 | |
Antoine Pitrou | 4a67a46 | 2011-01-02 22:06:53 +0000 | [diff] [blame] | 1013 | .. note:: |
Éric Araujo | fa5e6e4 | 2014-03-12 19:51:00 -0400 | [diff] [blame] | 1014 | |
Antoine Pitrou | 4a67a46 | 2011-01-02 22:06:53 +0000 | [diff] [blame] | 1015 | :meth:`close()` releases the resource associated with a connection but |
| 1016 | does not necessarily close the connection immediately. If you want |
| 1017 | to close the connection in a timely fashion, call :meth:`shutdown()` |
| 1018 | before :meth:`close()`. |
| 1019 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1020 | |
| 1021 | .. method:: socket.connect(address) |
| 1022 | |
| 1023 | Connect to a remote socket at *address*. (The format of *address* depends on the |
| 1024 | address family --- see above.) |
| 1025 | |
Victor Stinner | 81c41db | 2015-04-02 11:50:57 +0200 | [diff] [blame] | 1026 | If the connection is interrupted by a signal, the method waits until the |
| 1027 | connection completes, or raise a :exc:`socket.timeout` on timeout, if the |
| 1028 | signal handler doesn't raise an exception and the socket is blocking or has |
| 1029 | a timeout. For non-blocking sockets, the method raises an |
| 1030 | :exc:`InterruptedError` exception if the connection is interrupted by a |
| 1031 | signal (or the exception raised by the signal handler). |
| 1032 | |
| 1033 | .. versionchanged:: 3.5 |
| 1034 | The method now waits until the connection completes instead of raising an |
| 1035 | :exc:`InterruptedError` exception if the connection is interrupted by a |
| 1036 | signal, the signal handler doesn't raise an exception and the socket is |
| 1037 | blocking or has a timeout (see the :pep:`475` for the rationale). |
| 1038 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1039 | |
| 1040 | .. method:: socket.connect_ex(address) |
| 1041 | |
| 1042 | Like ``connect(address)``, but return an error indicator instead of raising an |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1043 | exception for errors returned by the C-level :c:func:`connect` call (other |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1044 | problems, such as "host not found," can still raise exceptions). The error |
| 1045 | indicator is ``0`` if the operation succeeded, otherwise the value of the |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1046 | :c:data:`errno` variable. This is useful to support, for example, asynchronous |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1047 | connects. |
| 1048 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1049 | |
Antoine Pitrou | 6e451df | 2010-08-09 20:39:54 +0000 | [diff] [blame] | 1050 | .. method:: socket.detach() |
| 1051 | |
| 1052 | Put the socket object into closed state without actually closing the |
| 1053 | underlying file descriptor. The file descriptor is returned, and can |
| 1054 | be reused for other purposes. |
| 1055 | |
| 1056 | .. versionadded:: 3.2 |
| 1057 | |
| 1058 | |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 1059 | .. method:: socket.dup() |
| 1060 | |
| 1061 | Duplicate the socket. |
| 1062 | |
| 1063 | The newly created socket is :ref:`non-inheritable <fd_inheritance>`. |
| 1064 | |
| 1065 | .. versionchanged:: 3.4 |
| 1066 | The socket is now non-inheritable. |
| 1067 | |
| 1068 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1069 | .. method:: socket.fileno() |
| 1070 | |
Kushal Das | 89beb27 | 2016-06-04 10:20:12 -0700 | [diff] [blame] | 1071 | Return the socket's file descriptor (a small integer), or -1 on failure. This |
| 1072 | is useful with :func:`select.select`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1073 | |
| 1074 | Under Windows the small integer returned by this method cannot be used where a |
| 1075 | file descriptor can be used (such as :func:`os.fdopen`). Unix does not have |
| 1076 | this limitation. |
| 1077 | |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 1078 | .. method:: socket.get_inheritable() |
| 1079 | |
| 1080 | Get the :ref:`inheritable flag <fd_inheritance>` of the socket's file |
| 1081 | descriptor or socket's handle: ``True`` if the socket can be inherited in |
| 1082 | child processes, ``False`` if it cannot. |
| 1083 | |
| 1084 | .. versionadded:: 3.4 |
| 1085 | |
| 1086 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1087 | .. method:: socket.getpeername() |
| 1088 | |
| 1089 | Return the remote address to which the socket is connected. This is useful to |
| 1090 | find out the port number of a remote IPv4/v6 socket, for instance. (The format |
| 1091 | of the address returned depends on the address family --- see above.) On some |
| 1092 | systems this function is not supported. |
| 1093 | |
| 1094 | |
| 1095 | .. method:: socket.getsockname() |
| 1096 | |
| 1097 | Return the socket's own address. This is useful to find out the port number of |
| 1098 | an IPv4/v6 socket, for instance. (The format of the address returned depends on |
| 1099 | the address family --- see above.) |
| 1100 | |
| 1101 | |
| 1102 | .. method:: socket.getsockopt(level, optname[, buflen]) |
| 1103 | |
| 1104 | Return the value of the given socket option (see the Unix man page |
| 1105 | :manpage:`getsockopt(2)`). The needed symbolic constants (:const:`SO_\*` etc.) |
| 1106 | are defined in this module. If *buflen* is absent, an integer option is assumed |
| 1107 | and its integer value is returned by the function. If *buflen* is present, it |
| 1108 | specifies the maximum length of the buffer used to receive the option in, and |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1109 | this buffer is returned as a bytes object. It is up to the caller to decode the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1110 | contents of the buffer (see the optional built-in module :mod:`struct` for a way |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1111 | to decode C structures encoded as byte strings). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1112 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1113 | |
Yury Selivanov | f11b460 | 2018-01-28 17:27:38 -0500 | [diff] [blame] | 1114 | .. method:: socket.getblocking() |
| 1115 | |
| 1116 | Return ``True`` if socket is in blocking mode, ``False`` if in |
| 1117 | non-blocking. |
| 1118 | |
| 1119 | This is equivalent to checking ``socket.gettimeout() == 0``. |
| 1120 | |
| 1121 | .. versionadded:: 3.7 |
| 1122 | |
| 1123 | |
Antoine Pitrou | dfad7e3 | 2011-01-05 21:17:36 +0000 | [diff] [blame] | 1124 | .. method:: socket.gettimeout() |
| 1125 | |
Ezio Melotti | 388c945 | 2011-08-14 08:28:57 +0300 | [diff] [blame] | 1126 | Return the timeout in seconds (float) associated with socket operations, |
Antoine Pitrou | dfad7e3 | 2011-01-05 21:17:36 +0000 | [diff] [blame] | 1127 | or ``None`` if no timeout is set. This reflects the last call to |
| 1128 | :meth:`setblocking` or :meth:`settimeout`. |
| 1129 | |
| 1130 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 1131 | .. method:: socket.ioctl(control, option) |
| 1132 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1133 | :platform: Windows |
| 1134 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 1135 | The :meth:`ioctl` method is a limited interface to the WSAIoctl system |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 1136 | interface. Please refer to the `Win32 documentation |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 1137 | <https://msdn.microsoft.com/en-us/library/ms741621%28VS.85%29.aspx>`_ for more |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 1138 | information. |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1139 | |
Alexandre Vassalotti | 6d3dfc3 | 2009-07-29 19:54:39 +0000 | [diff] [blame] | 1140 | On other platforms, the generic :func:`fcntl.fcntl` and :func:`fcntl.ioctl` |
| 1141 | functions may be used; they accept a socket object as their first argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1142 | |
Steve Dower | ea93ac0 | 2016-06-17 12:52:18 -0700 | [diff] [blame] | 1143 | Currently only the following control codes are supported: |
| 1144 | ``SIO_RCVALL``, ``SIO_KEEPALIVE_VALS``, and ``SIO_LOOPBACK_FAST_PATH``. |
| 1145 | |
| 1146 | .. versionchanged:: 3.6 |
| 1147 | ``SIO_LOOPBACK_FAST_PATH`` was added. |
| 1148 | |
Charles-François Natali | 644b8f5 | 2014-05-22 19:45:39 +0100 | [diff] [blame] | 1149 | .. method:: socket.listen([backlog]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1150 | |
Charles-François Natali | 644b8f5 | 2014-05-22 19:45:39 +0100 | [diff] [blame] | 1151 | Enable a server to accept connections. If *backlog* is specified, it must |
| 1152 | be at least 0 (if it is lower, it is set to 0); it specifies the number of |
| 1153 | unaccepted connections that the system will allow before refusing new |
| 1154 | connections. If not specified, a default reasonable value is chosen. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1155 | |
Charles-François Natali | 644b8f5 | 2014-05-22 19:45:39 +0100 | [diff] [blame] | 1156 | .. versionchanged:: 3.5 |
| 1157 | The *backlog* parameter is now optional. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1158 | |
Georg Brandl | e9e8c9b | 2010-12-28 11:49:41 +0000 | [diff] [blame] | 1159 | .. method:: socket.makefile(mode='r', buffering=None, *, encoding=None, \ |
| 1160 | errors=None, newline=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1161 | |
| 1162 | .. index:: single: I/O control; buffering |
| 1163 | |
Georg Brandl | e9e8c9b | 2010-12-28 11:49:41 +0000 | [diff] [blame] | 1164 | Return a :term:`file object` associated with the socket. The exact returned |
| 1165 | type depends on the arguments given to :meth:`makefile`. These arguments are |
Berker Peksag | 3fe64d0 | 2016-02-18 17:34:00 +0200 | [diff] [blame] | 1166 | interpreted the same way as by the built-in :func:`open` function, except |
| 1167 | the only supported *mode* values are ``'r'`` (default), ``'w'`` and ``'b'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1168 | |
Antoine Pitrou | e3658a7 | 2013-12-04 21:02:42 +0100 | [diff] [blame] | 1169 | The socket must be in blocking mode; it can have a timeout, but the file |
Martin Panter | 7462b649 | 2015-11-02 03:37:02 +0000 | [diff] [blame] | 1170 | object's internal buffer may end up in an inconsistent state if a timeout |
Antoine Pitrou | e3658a7 | 2013-12-04 21:02:42 +0100 | [diff] [blame] | 1171 | occurs. |
| 1172 | |
| 1173 | Closing the file object returned by :meth:`makefile` won't close the |
| 1174 | original socket unless all other file objects have been closed and |
| 1175 | :meth:`socket.close` has been called on the socket object. |
Georg Brandl | e9e8c9b | 2010-12-28 11:49:41 +0000 | [diff] [blame] | 1176 | |
| 1177 | .. note:: |
| 1178 | |
| 1179 | On Windows, the file-like object created by :meth:`makefile` cannot be |
| 1180 | used where a file object with a file descriptor is expected, such as the |
| 1181 | stream arguments of :meth:`subprocess.Popen`. |
Antoine Pitrou | 4adb288 | 2010-01-04 18:50:53 +0000 | [diff] [blame] | 1182 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1183 | |
| 1184 | .. method:: socket.recv(bufsize[, flags]) |
| 1185 | |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1186 | Receive data from the socket. The return value is a bytes object representing the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1187 | data received. The maximum amount of data to be received at once is specified |
| 1188 | by *bufsize*. See the Unix manual page :manpage:`recv(2)` for the meaning of |
| 1189 | the optional argument *flags*; it defaults to zero. |
| 1190 | |
| 1191 | .. note:: |
| 1192 | |
| 1193 | For best match with hardware and network realities, the value of *bufsize* |
| 1194 | should be a relatively small power of 2, for example, 4096. |
| 1195 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1196 | .. versionchanged:: 3.5 |
| 1197 | If the system call is interrupted and the signal handler does not raise |
| 1198 | an exception, the method now retries the system call instead of raising |
| 1199 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 1200 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1201 | |
| 1202 | .. method:: socket.recvfrom(bufsize[, flags]) |
| 1203 | |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1204 | Receive data from the socket. The return value is a pair ``(bytes, address)`` |
| 1205 | where *bytes* is a bytes object representing the data received and *address* is the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1206 | address of the socket sending the data. See the Unix manual page |
| 1207 | :manpage:`recv(2)` for the meaning of the optional argument *flags*; it defaults |
| 1208 | to zero. (The format of *address* depends on the address family --- see above.) |
| 1209 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1210 | .. versionchanged:: 3.5 |
| 1211 | If the system call is interrupted and the signal handler does not raise |
| 1212 | an exception, the method now retries the system call instead of raising |
| 1213 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 1214 | |
Коренберг Марк | 7766b96 | 2018-02-13 00:47:42 +0500 | [diff] [blame] | 1215 | .. versionchanged:: 3.7 |
| 1216 | For multicast IPv6 address, first item of *address* does not contain |
| 1217 | ``%scope`` part anymore. In order to get full IPv6 address use |
| 1218 | :func:`getnameinfo`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1219 | |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1220 | .. method:: socket.recvmsg(bufsize[, ancbufsize[, flags]]) |
| 1221 | |
| 1222 | Receive normal data (up to *bufsize* bytes) and ancillary data from |
| 1223 | the socket. The *ancbufsize* argument sets the size in bytes of |
| 1224 | the internal buffer used to receive the ancillary data; it defaults |
| 1225 | to 0, meaning that no ancillary data will be received. Appropriate |
| 1226 | buffer sizes for ancillary data can be calculated using |
| 1227 | :func:`CMSG_SPACE` or :func:`CMSG_LEN`, and items which do not fit |
| 1228 | into the buffer might be truncated or discarded. The *flags* |
| 1229 | argument defaults to 0 and has the same meaning as for |
| 1230 | :meth:`recv`. |
| 1231 | |
| 1232 | The return value is a 4-tuple: ``(data, ancdata, msg_flags, |
| 1233 | address)``. The *data* item is a :class:`bytes` object holding the |
| 1234 | non-ancillary data received. The *ancdata* item is a list of zero |
| 1235 | or more tuples ``(cmsg_level, cmsg_type, cmsg_data)`` representing |
| 1236 | the ancillary data (control messages) received: *cmsg_level* and |
| 1237 | *cmsg_type* are integers specifying the protocol level and |
| 1238 | protocol-specific type respectively, and *cmsg_data* is a |
| 1239 | :class:`bytes` object holding the associated data. The *msg_flags* |
| 1240 | item is the bitwise OR of various flags indicating conditions on |
| 1241 | the received message; see your system documentation for details. |
| 1242 | If the receiving socket is unconnected, *address* is the address of |
| 1243 | the sending socket, if available; otherwise, its value is |
| 1244 | unspecified. |
| 1245 | |
| 1246 | On some systems, :meth:`sendmsg` and :meth:`recvmsg` can be used to |
| 1247 | pass file descriptors between processes over an :const:`AF_UNIX` |
| 1248 | socket. When this facility is used (it is often restricted to |
| 1249 | :const:`SOCK_STREAM` sockets), :meth:`recvmsg` will return, in its |
| 1250 | ancillary data, items of the form ``(socket.SOL_SOCKET, |
| 1251 | socket.SCM_RIGHTS, fds)``, where *fds* is a :class:`bytes` object |
| 1252 | representing the new file descriptors as a binary array of the |
| 1253 | native C :c:type:`int` type. If :meth:`recvmsg` raises an |
| 1254 | exception after the system call returns, it will first attempt to |
| 1255 | close any file descriptors received via this mechanism. |
| 1256 | |
| 1257 | Some systems do not indicate the truncated length of ancillary data |
| 1258 | items which have been only partially received. If an item appears |
| 1259 | to extend beyond the end of the buffer, :meth:`recvmsg` will issue |
| 1260 | a :exc:`RuntimeWarning`, and will return the part of it which is |
| 1261 | inside the buffer provided it has not been truncated before the |
| 1262 | start of its associated data. |
| 1263 | |
| 1264 | On systems which support the :const:`SCM_RIGHTS` mechanism, the |
| 1265 | following function will receive up to *maxfds* file descriptors, |
| 1266 | returning the message data and a list containing the descriptors |
| 1267 | (while ignoring unexpected conditions such as unrelated control |
| 1268 | messages being received). See also :meth:`sendmsg`. :: |
| 1269 | |
| 1270 | import socket, array |
| 1271 | |
| 1272 | def recv_fds(sock, msglen, maxfds): |
| 1273 | fds = array.array("i") # Array of ints |
| 1274 | msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize)) |
| 1275 | for cmsg_level, cmsg_type, cmsg_data in ancdata: |
| 1276 | if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS): |
| 1277 | # Append data, ignoring any truncated integers at the end. |
| 1278 | fds.fromstring(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)]) |
| 1279 | return msg, list(fds) |
| 1280 | |
| 1281 | Availability: most Unix platforms, possibly others. |
| 1282 | |
| 1283 | .. versionadded:: 3.3 |
| 1284 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1285 | .. versionchanged:: 3.5 |
| 1286 | If the system call is interrupted and the signal handler does not raise |
| 1287 | an exception, the method now retries the system call instead of raising |
| 1288 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 1289 | |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1290 | |
| 1291 | .. method:: socket.recvmsg_into(buffers[, ancbufsize[, flags]]) |
| 1292 | |
| 1293 | Receive normal data and ancillary data from the socket, behaving as |
| 1294 | :meth:`recvmsg` would, but scatter the non-ancillary data into a |
| 1295 | series of buffers instead of returning a new bytes object. The |
| 1296 | *buffers* argument must be an iterable of objects that export |
| 1297 | writable buffers (e.g. :class:`bytearray` objects); these will be |
| 1298 | filled with successive chunks of the non-ancillary data until it |
| 1299 | has all been written or there are no more buffers. The operating |
| 1300 | system may set a limit (:func:`~os.sysconf` value ``SC_IOV_MAX``) |
| 1301 | on the number of buffers that can be used. The *ancbufsize* and |
| 1302 | *flags* arguments have the same meaning as for :meth:`recvmsg`. |
| 1303 | |
| 1304 | The return value is a 4-tuple: ``(nbytes, ancdata, msg_flags, |
| 1305 | address)``, where *nbytes* is the total number of bytes of |
| 1306 | non-ancillary data written into the buffers, and *ancdata*, |
| 1307 | *msg_flags* and *address* are the same as for :meth:`recvmsg`. |
| 1308 | |
| 1309 | Example:: |
| 1310 | |
| 1311 | >>> import socket |
| 1312 | >>> s1, s2 = socket.socketpair() |
| 1313 | >>> b1 = bytearray(b'----') |
| 1314 | >>> b2 = bytearray(b'0123456789') |
| 1315 | >>> b3 = bytearray(b'--------------') |
| 1316 | >>> s1.send(b'Mary had a little lamb') |
| 1317 | 22 |
| 1318 | >>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3]) |
| 1319 | (22, [], 0, None) |
| 1320 | >>> [b1, b2, b3] |
| 1321 | [bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')] |
| 1322 | |
| 1323 | Availability: most Unix platforms, possibly others. |
| 1324 | |
| 1325 | .. versionadded:: 3.3 |
| 1326 | |
| 1327 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1328 | .. method:: socket.recvfrom_into(buffer[, nbytes[, flags]]) |
| 1329 | |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1330 | Receive data from the socket, writing it into *buffer* instead of creating a |
| 1331 | new bytestring. The return value is a pair ``(nbytes, address)`` where *nbytes* is |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1332 | the number of bytes received and *address* is the address of the socket sending |
| 1333 | the data. See the Unix manual page :manpage:`recv(2)` for the meaning of the |
| 1334 | optional argument *flags*; it defaults to zero. (The format of *address* |
| 1335 | depends on the address family --- see above.) |
| 1336 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1337 | |
| 1338 | .. method:: socket.recv_into(buffer[, nbytes[, flags]]) |
| 1339 | |
| 1340 | Receive up to *nbytes* bytes from the socket, storing the data into a buffer |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1341 | rather than creating a new bytestring. If *nbytes* is not specified (or 0), |
Benjamin Peterson | 08bf91c | 2010-04-11 16:12:57 +0000 | [diff] [blame] | 1342 | receive up to the size available in the given buffer. Returns the number of |
| 1343 | bytes received. See the Unix manual page :manpage:`recv(2)` for the meaning |
| 1344 | of the optional argument *flags*; it defaults to zero. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1345 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1346 | |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1347 | .. method:: socket.send(bytes[, flags]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1348 | |
| 1349 | Send data to the socket. The socket must be connected to a remote socket. The |
| 1350 | optional *flags* argument has the same meaning as for :meth:`recv` above. |
| 1351 | Returns the number of bytes sent. Applications are responsible for checking that |
| 1352 | all data has been sent; if only some of the data was transmitted, the |
Senthil Kumaran | 6e13f13 | 2012-02-09 17:54:17 +0800 | [diff] [blame] | 1353 | application needs to attempt delivery of the remaining data. For further |
| 1354 | information on this topic, consult the :ref:`socket-howto`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1355 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1356 | .. versionchanged:: 3.5 |
| 1357 | If the system call is interrupted and the signal handler does not raise |
| 1358 | an exception, the method now retries the system call instead of raising |
| 1359 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 1360 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1361 | |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1362 | .. method:: socket.sendall(bytes[, flags]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1363 | |
| 1364 | Send data to the socket. The socket must be connected to a remote socket. The |
| 1365 | optional *flags* argument has the same meaning as for :meth:`recv` above. |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1366 | Unlike :meth:`send`, this method continues to send data from *bytes* until |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1367 | either all data has been sent or an error occurs. ``None`` is returned on |
| 1368 | success. On error, an exception is raised, and there is no way to determine how |
| 1369 | much data, if any, was successfully sent. |
| 1370 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1371 | .. versionchanged:: 3.5 |
Martin Panter | eb99570 | 2016-07-28 01:11:04 +0000 | [diff] [blame] | 1372 | The socket timeout is no more reset each time data is sent successfully. |
Victor Stinner | 8912d14 | 2015-04-06 23:16:34 +0200 | [diff] [blame] | 1373 | The socket timeout is now the maximum total duration to send all data. |
| 1374 | |
| 1375 | .. versionchanged:: 3.5 |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1376 | If the system call is interrupted and the signal handler does not raise |
| 1377 | an exception, the method now retries the system call instead of raising |
| 1378 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 1379 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1380 | |
Ezio Melotti | e0add76 | 2012-09-14 06:32:35 +0300 | [diff] [blame] | 1381 | .. method:: socket.sendto(bytes, address) |
| 1382 | socket.sendto(bytes, flags, address) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1383 | |
| 1384 | Send data to the socket. The socket should not be connected to a remote socket, |
| 1385 | since the destination socket is specified by *address*. The optional *flags* |
| 1386 | argument has the same meaning as for :meth:`recv` above. Return the number of |
| 1387 | bytes sent. (The format of *address* depends on the address family --- see |
| 1388 | above.) |
| 1389 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1390 | .. versionchanged:: 3.5 |
| 1391 | If the system call is interrupted and the signal handler does not raise |
| 1392 | an exception, the method now retries the system call instead of raising |
| 1393 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 1394 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1395 | |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1396 | .. method:: socket.sendmsg(buffers[, ancdata[, flags[, address]]]) |
| 1397 | |
| 1398 | Send normal and ancillary data to the socket, gathering the |
| 1399 | non-ancillary data from a series of buffers and concatenating it |
| 1400 | into a single message. The *buffers* argument specifies the |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 1401 | non-ancillary data as an iterable of |
| 1402 | :term:`bytes-like objects <bytes-like object>` |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1403 | (e.g. :class:`bytes` objects); the operating system may set a limit |
| 1404 | (:func:`~os.sysconf` value ``SC_IOV_MAX``) on the number of buffers |
| 1405 | that can be used. The *ancdata* argument specifies the ancillary |
| 1406 | data (control messages) as an iterable of zero or more tuples |
| 1407 | ``(cmsg_level, cmsg_type, cmsg_data)``, where *cmsg_level* and |
| 1408 | *cmsg_type* are integers specifying the protocol level and |
| 1409 | protocol-specific type respectively, and *cmsg_data* is a |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 1410 | bytes-like object holding the associated data. Note that |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1411 | some systems (in particular, systems without :func:`CMSG_SPACE`) |
| 1412 | might support sending only one control message per call. The |
| 1413 | *flags* argument defaults to 0 and has the same meaning as for |
| 1414 | :meth:`send`. If *address* is supplied and not ``None``, it sets a |
| 1415 | destination address for the message. The return value is the |
| 1416 | number of bytes of non-ancillary data sent. |
| 1417 | |
| 1418 | The following function sends the list of file descriptors *fds* |
| 1419 | over an :const:`AF_UNIX` socket, on systems which support the |
| 1420 | :const:`SCM_RIGHTS` mechanism. See also :meth:`recvmsg`. :: |
| 1421 | |
| 1422 | import socket, array |
| 1423 | |
| 1424 | def send_fds(sock, msg, fds): |
| 1425 | return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))]) |
| 1426 | |
| 1427 | Availability: most Unix platforms, possibly others. |
| 1428 | |
| 1429 | .. versionadded:: 3.3 |
| 1430 | |
Victor Stinner | 708d9ba | 2015-04-02 11:49:42 +0200 | [diff] [blame] | 1431 | .. versionchanged:: 3.5 |
| 1432 | If the system call is interrupted and the signal handler does not raise |
| 1433 | an exception, the method now retries the system call instead of raising |
| 1434 | an :exc:`InterruptedError` exception (see :pep:`475` for the rationale). |
| 1435 | |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 1436 | .. method:: socket.sendmsg_afalg([msg], *, op[, iv[, assoclen[, flags]]]) |
| 1437 | |
| 1438 | Specialized version of :meth:`~socket.sendmsg` for :const:`AF_ALG` socket. |
| 1439 | Set mode, IV, AEAD associated data length and flags for :const:`AF_ALG` socket. |
| 1440 | |
| 1441 | Availability: Linux >= 2.6.38 |
| 1442 | |
| 1443 | .. versionadded:: 3.6 |
| 1444 | |
Giampaolo Rodola' | 915d141 | 2014-06-11 03:54:30 +0200 | [diff] [blame] | 1445 | .. method:: socket.sendfile(file, offset=0, count=None) |
| 1446 | |
| 1447 | Send a file until EOF is reached by using high-performance |
| 1448 | :mod:`os.sendfile` and return the total number of bytes which were sent. |
| 1449 | *file* must be a regular file object opened in binary mode. If |
| 1450 | :mod:`os.sendfile` is not available (e.g. Windows) or *file* is not a |
| 1451 | regular file :meth:`send` will be used instead. *offset* tells from where to |
| 1452 | start reading the file. If specified, *count* is the total number of bytes |
| 1453 | to transmit as opposed to sending the file until EOF is reached. File |
| 1454 | position is updated on return or also in case of error in which case |
| 1455 | :meth:`file.tell() <io.IOBase.tell>` can be used to figure out the number of |
Martin Panter | 8f13783 | 2017-01-14 08:24:20 +0000 | [diff] [blame] | 1456 | bytes which were sent. The socket must be of :const:`SOCK_STREAM` type. |
| 1457 | Non-blocking sockets are not supported. |
Giampaolo Rodola' | 915d141 | 2014-06-11 03:54:30 +0200 | [diff] [blame] | 1458 | |
| 1459 | .. versionadded:: 3.5 |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1460 | |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 1461 | .. method:: socket.set_inheritable(inheritable) |
| 1462 | |
| 1463 | Set the :ref:`inheritable flag <fd_inheritance>` of the socket's file |
| 1464 | descriptor or socket's handle. |
| 1465 | |
| 1466 | .. versionadded:: 3.4 |
| 1467 | |
| 1468 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1469 | .. method:: socket.setblocking(flag) |
| 1470 | |
Antoine Pitrou | dfad7e3 | 2011-01-05 21:17:36 +0000 | [diff] [blame] | 1471 | Set blocking or non-blocking mode of the socket: if *flag* is false, the |
| 1472 | socket is set to non-blocking, else to blocking mode. |
| 1473 | |
| 1474 | This method is a shorthand for certain :meth:`~socket.settimeout` calls: |
| 1475 | |
| 1476 | * ``sock.setblocking(True)`` is equivalent to ``sock.settimeout(None)`` |
| 1477 | |
| 1478 | * ``sock.setblocking(False)`` is equivalent to ``sock.settimeout(0.0)`` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1479 | |
Yury Selivanov | 9818142 | 2017-12-18 20:02:54 -0500 | [diff] [blame] | 1480 | .. versionchanged:: 3.7 |
| 1481 | The method no longer applies :const:`SOCK_NONBLOCK` flag on |
| 1482 | :attr:`socket.type`. |
| 1483 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1484 | |
| 1485 | .. method:: socket.settimeout(value) |
| 1486 | |
| 1487 | Set a timeout on blocking socket operations. The *value* argument can be a |
Antoine Pitrou | dfad7e3 | 2011-01-05 21:17:36 +0000 | [diff] [blame] | 1488 | nonnegative floating point number expressing seconds, or ``None``. |
| 1489 | If a non-zero value is given, subsequent socket operations will raise a |
| 1490 | :exc:`timeout` exception if the timeout period *value* has elapsed before |
| 1491 | the operation has completed. If zero is given, the socket is put in |
| 1492 | non-blocking mode. If ``None`` is given, the socket is put in blocking mode. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1493 | |
Antoine Pitrou | dfad7e3 | 2011-01-05 21:17:36 +0000 | [diff] [blame] | 1494 | For further information, please consult the :ref:`notes on socket timeouts <socket-timeouts>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1495 | |
Yury Selivanov | 9818142 | 2017-12-18 20:02:54 -0500 | [diff] [blame] | 1496 | .. versionchanged:: 3.7 |
| 1497 | The method no longer toggles :const:`SOCK_NONBLOCK` flag on |
| 1498 | :attr:`socket.type`. |
| 1499 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1500 | |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 1501 | .. method:: socket.setsockopt(level, optname, value: int) |
| 1502 | .. method:: socket.setsockopt(level, optname, value: buffer) |
| 1503 | .. method:: socket.setsockopt(level, optname, None, optlen: int) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1504 | |
| 1505 | .. index:: module: struct |
| 1506 | |
| 1507 | Set the value of the given socket option (see the Unix manual page |
| 1508 | :manpage:`setsockopt(2)`). The needed symbolic constants are defined in the |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 1509 | :mod:`socket` module (:const:`SO_\*` etc.). The value can be an integer, |
Serhiy Storchaka | 989db5c | 2016-10-19 16:37:13 +0300 | [diff] [blame] | 1510 | ``None`` or a :term:`bytes-like object` representing a buffer. In the later |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 1511 | case it is up to the caller to ensure that the bytestring contains the |
| 1512 | proper bits (see the optional built-in module :mod:`struct` for a way to |
Serhiy Storchaka | 989db5c | 2016-10-19 16:37:13 +0300 | [diff] [blame] | 1513 | encode C structures as bytestrings). When value is set to ``None``, |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 1514 | optlen argument is required. It's equivalent to call setsockopt C |
| 1515 | function with optval=NULL and optlen=optlen. |
| 1516 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1517 | |
Georg Brandl | 8c16cb9 | 2016-02-25 20:17:45 +0100 | [diff] [blame] | 1518 | .. versionchanged:: 3.5 |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 1519 | Writable :term:`bytes-like object` is now accepted. |
| 1520 | |
Christian Heimes | dffa394 | 2016-09-05 23:54:41 +0200 | [diff] [blame] | 1521 | .. versionchanged:: 3.6 |
| 1522 | setsockopt(level, optname, None, optlen: int) form added. |
| 1523 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1524 | |
| 1525 | .. method:: socket.shutdown(how) |
| 1526 | |
| 1527 | Shut down one or both halves of the connection. If *how* is :const:`SHUT_RD`, |
| 1528 | further receives are disallowed. If *how* is :const:`SHUT_WR`, further sends |
| 1529 | are disallowed. If *how* is :const:`SHUT_RDWR`, further sends and receives are |
Charles-François Natali | cdc878e | 2012-01-29 16:42:54 +0100 | [diff] [blame] | 1530 | disallowed. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1531 | |
Kristján Valur Jónsson | 10f383a | 2012-04-07 11:23:31 +0000 | [diff] [blame] | 1532 | |
| 1533 | .. method:: socket.share(process_id) |
| 1534 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 1535 | Duplicate a socket and prepare it for sharing with a target process. The |
| 1536 | target process must be provided with *process_id*. The resulting bytes object |
| 1537 | can then be passed to the target process using some form of interprocess |
| 1538 | communication and the socket can be recreated there using :func:`fromshare`. |
| 1539 | Once this method has been called, it is safe to close the socket since |
| 1540 | the operating system has already duplicated it for the target process. |
Kristján Valur Jónsson | 10f383a | 2012-04-07 11:23:31 +0000 | [diff] [blame] | 1541 | |
Antoine Pitrou | a5cc9d6 | 2013-12-04 21:11:03 +0100 | [diff] [blame] | 1542 | Availability: Windows. |
Kristján Valur Jónsson | 10f383a | 2012-04-07 11:23:31 +0000 | [diff] [blame] | 1543 | |
| 1544 | .. versionadded:: 3.3 |
| 1545 | |
| 1546 | |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 1547 | Note that there are no methods :meth:`read` or :meth:`write`; use |
| 1548 | :meth:`~socket.recv` and :meth:`~socket.send` without *flags* argument instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1549 | |
| 1550 | Socket objects also have these (read-only) attributes that correspond to the |
Serhiy Storchaka | ee1b01a | 2016-12-02 23:13:53 +0200 | [diff] [blame] | 1551 | values given to the :class:`~socket.socket` constructor. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1552 | |
| 1553 | |
| 1554 | .. attribute:: socket.family |
| 1555 | |
| 1556 | The socket family. |
| 1557 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1558 | |
| 1559 | .. attribute:: socket.type |
| 1560 | |
| 1561 | The socket type. |
| 1562 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1563 | |
| 1564 | .. attribute:: socket.proto |
| 1565 | |
| 1566 | The socket protocol. |
| 1567 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1568 | |
Antoine Pitrou | dfad7e3 | 2011-01-05 21:17:36 +0000 | [diff] [blame] | 1569 | |
| 1570 | .. _socket-timeouts: |
| 1571 | |
| 1572 | Notes on socket timeouts |
| 1573 | ------------------------ |
| 1574 | |
| 1575 | A socket object can be in one of three modes: blocking, non-blocking, or |
| 1576 | timeout. Sockets are by default always created in blocking mode, but this |
| 1577 | can be changed by calling :func:`setdefaulttimeout`. |
| 1578 | |
| 1579 | * In *blocking mode*, operations block until complete or the system returns |
| 1580 | an error (such as connection timed out). |
| 1581 | |
| 1582 | * In *non-blocking mode*, operations fail (with an error that is unfortunately |
| 1583 | system-dependent) if they cannot be completed immediately: functions from the |
| 1584 | :mod:`select` can be used to know when and whether a socket is available for |
| 1585 | reading or writing. |
| 1586 | |
| 1587 | * In *timeout mode*, operations fail if they cannot be completed within the |
| 1588 | timeout specified for the socket (they raise a :exc:`timeout` exception) |
| 1589 | or if the system returns an error. |
| 1590 | |
| 1591 | .. note:: |
| 1592 | At the operating system level, sockets in *timeout mode* are internally set |
| 1593 | in non-blocking mode. Also, the blocking and timeout modes are shared between |
| 1594 | file descriptors and socket objects that refer to the same network endpoint. |
| 1595 | This implementation detail can have visible consequences if e.g. you decide |
| 1596 | to use the :meth:`~socket.fileno()` of a socket. |
| 1597 | |
| 1598 | Timeouts and the ``connect`` method |
| 1599 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1600 | |
| 1601 | The :meth:`~socket.connect` operation is also subject to the timeout |
| 1602 | setting, and in general it is recommended to call :meth:`~socket.settimeout` |
| 1603 | before calling :meth:`~socket.connect` or pass a timeout parameter to |
| 1604 | :meth:`create_connection`. However, the system network stack may also |
| 1605 | return a connection timeout error of its own regardless of any Python socket |
| 1606 | timeout setting. |
| 1607 | |
| 1608 | Timeouts and the ``accept`` method |
| 1609 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1610 | |
| 1611 | If :func:`getdefaulttimeout` is not :const:`None`, sockets returned by |
| 1612 | the :meth:`~socket.accept` method inherit that timeout. Otherwise, the |
| 1613 | behaviour depends on settings of the listening socket: |
| 1614 | |
| 1615 | * if the listening socket is in *blocking mode* or in *timeout mode*, |
| 1616 | the socket returned by :meth:`~socket.accept` is in *blocking mode*; |
| 1617 | |
| 1618 | * if the listening socket is in *non-blocking mode*, whether the socket |
| 1619 | returned by :meth:`~socket.accept` is in blocking or non-blocking mode |
| 1620 | is operating system-dependent. If you want to ensure cross-platform |
| 1621 | behaviour, it is recommended you manually override this setting. |
| 1622 | |
| 1623 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1624 | .. _socket-example: |
| 1625 | |
| 1626 | Example |
| 1627 | ------- |
| 1628 | |
| 1629 | Here are four minimal example programs using the TCP/IP protocol: a server that |
| 1630 | echoes all data that it receives back (servicing only one client), and a client |
Ezio Melotti | c048d98 | 2013-04-17 04:10:26 +0300 | [diff] [blame] | 1631 | using it. Note that a server must perform the sequence :func:`.socket`, |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 1632 | :meth:`~socket.bind`, :meth:`~socket.listen`, :meth:`~socket.accept` (possibly |
| 1633 | repeating the :meth:`~socket.accept` to service more than one client), while a |
Ezio Melotti | c048d98 | 2013-04-17 04:10:26 +0300 | [diff] [blame] | 1634 | client only needs the sequence :func:`.socket`, :meth:`~socket.connect`. Also |
Senthil Kumaran | 6e13f13 | 2012-02-09 17:54:17 +0800 | [diff] [blame] | 1635 | note that the server does not :meth:`~socket.sendall`/:meth:`~socket.recv` on |
| 1636 | the socket it is listening on but on the new socket returned by |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 1637 | :meth:`~socket.accept`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1638 | |
| 1639 | The first two examples support IPv4 only. :: |
| 1640 | |
| 1641 | # Echo server program |
| 1642 | import socket |
| 1643 | |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 1644 | HOST = '' # Symbolic name meaning all available interfaces |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1645 | PORT = 50007 # Arbitrary non-privileged port |
Martin Panter | e37fc18 | 2016-04-24 04:24:36 +0000 | [diff] [blame] | 1646 | with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: |
| 1647 | s.bind((HOST, PORT)) |
| 1648 | s.listen(1) |
| 1649 | conn, addr = s.accept() |
| 1650 | with conn: |
| 1651 | print('Connected by', addr) |
| 1652 | while True: |
| 1653 | data = conn.recv(1024) |
| 1654 | if not data: break |
| 1655 | conn.sendall(data) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1656 | |
| 1657 | :: |
| 1658 | |
| 1659 | # Echo client program |
| 1660 | import socket |
| 1661 | |
| 1662 | HOST = 'daring.cwi.nl' # The remote host |
| 1663 | PORT = 50007 # The same port as used by the server |
Martin Panter | e37fc18 | 2016-04-24 04:24:36 +0000 | [diff] [blame] | 1664 | with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: |
| 1665 | s.connect((HOST, PORT)) |
| 1666 | s.sendall(b'Hello, world') |
| 1667 | data = s.recv(1024) |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1668 | print('Received', repr(data)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1669 | |
| 1670 | The next two examples are identical to the above two, but support both IPv4 and |
| 1671 | IPv6. The server side will listen to the first address family available (it |
| 1672 | should listen to both instead). On most of IPv6-ready systems, IPv6 will take |
| 1673 | precedence and the server may not accept IPv4 traffic. The client side will try |
| 1674 | to connect to the all addresses returned as a result of the name resolution, and |
| 1675 | sends traffic to the first one connected successfully. :: |
| 1676 | |
| 1677 | # Echo server program |
| 1678 | import socket |
| 1679 | import sys |
| 1680 | |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 1681 | HOST = None # Symbolic name meaning all available interfaces |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1682 | PORT = 50007 # Arbitrary non-privileged port |
| 1683 | s = None |
Georg Brandl | 42b2f2e | 2008-08-14 11:50:32 +0000 | [diff] [blame] | 1684 | for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, |
| 1685 | socket.SOCK_STREAM, 0, socket.AI_PASSIVE): |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1686 | af, socktype, proto, canonname, sa = res |
| 1687 | try: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1688 | s = socket.socket(af, socktype, proto) |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 1689 | except OSError as msg: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1690 | s = None |
| 1691 | continue |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1692 | try: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1693 | s.bind(sa) |
| 1694 | s.listen(1) |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 1695 | except OSError as msg: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1696 | s.close() |
| 1697 | s = None |
| 1698 | continue |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1699 | break |
| 1700 | if s is None: |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1701 | print('could not open socket') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1702 | sys.exit(1) |
| 1703 | conn, addr = s.accept() |
Martin Panter | e37fc18 | 2016-04-24 04:24:36 +0000 | [diff] [blame] | 1704 | with conn: |
| 1705 | print('Connected by', addr) |
| 1706 | while True: |
| 1707 | data = conn.recv(1024) |
| 1708 | if not data: break |
| 1709 | conn.send(data) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1710 | |
| 1711 | :: |
| 1712 | |
| 1713 | # Echo client program |
| 1714 | import socket |
| 1715 | import sys |
| 1716 | |
| 1717 | HOST = 'daring.cwi.nl' # The remote host |
| 1718 | PORT = 50007 # The same port as used by the server |
| 1719 | s = None |
| 1720 | for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM): |
| 1721 | af, socktype, proto, canonname, sa = res |
| 1722 | try: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1723 | s = socket.socket(af, socktype, proto) |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 1724 | except OSError as msg: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1725 | s = None |
| 1726 | continue |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1727 | try: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1728 | s.connect(sa) |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 1729 | except OSError as msg: |
Georg Brandl | a1c6a1c | 2009-01-03 21:26:05 +0000 | [diff] [blame] | 1730 | s.close() |
| 1731 | s = None |
| 1732 | continue |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1733 | break |
| 1734 | if s is None: |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1735 | print('could not open socket') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1736 | sys.exit(1) |
Martin Panter | e37fc18 | 2016-04-24 04:24:36 +0000 | [diff] [blame] | 1737 | with s: |
| 1738 | s.sendall(b'Hello, world') |
| 1739 | data = s.recv(1024) |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1740 | print('Received', repr(data)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1741 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1742 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1743 | The next example shows how to write a very simple network sniffer with raw |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 1744 | sockets on Windows. The example requires administrator privileges to modify |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 1745 | the interface:: |
| 1746 | |
| 1747 | import socket |
| 1748 | |
| 1749 | # the public network interface |
| 1750 | HOST = socket.gethostbyname(socket.gethostname()) |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1751 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 1752 | # create a raw socket and bind it to the public interface |
| 1753 | s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP) |
| 1754 | s.bind((HOST, 0)) |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1755 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 1756 | # Include IP headers |
| 1757 | s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1) |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1758 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 1759 | # receive all packages |
| 1760 | s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON) |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1761 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 1762 | # receive a package |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 1763 | print(s.recvfrom(65565)) |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1764 | |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 1765 | # disabled promiscuous mode |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 1766 | s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF) |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 1767 | |
Pier-Yves Lessard | a30f6d4 | 2017-08-28 04:32:44 -0400 | [diff] [blame] | 1768 | The next example shows how to use the socket interface to communicate to a CAN |
Charles-François Natali | 773e42d | 2013-02-05 19:42:01 +0100 | [diff] [blame] | 1769 | network using the raw socket protocol. To use CAN with the broadcast |
| 1770 | manager protocol instead, open a socket with:: |
| 1771 | |
| 1772 | socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM) |
| 1773 | |
| 1774 | After binding (:const:`CAN_RAW`) or connecting (:const:`CAN_BCM`) the socket, you |
Mark Dickinson | d80b16d | 2013-02-10 18:43:16 +0000 | [diff] [blame] | 1775 | can use the :meth:`socket.send`, and the :meth:`socket.recv` operations (and |
Charles-François Natali | 773e42d | 2013-02-05 19:42:01 +0100 | [diff] [blame] | 1776 | their counterparts) on the socket object as usual. |
| 1777 | |
Pier-Yves Lessard | a30f6d4 | 2017-08-28 04:32:44 -0400 | [diff] [blame] | 1778 | This last example might require special privileges:: |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1779 | |
| 1780 | import socket |
| 1781 | import struct |
| 1782 | |
| 1783 | |
Georg Brandl | a673eb8 | 2012-03-04 16:17:05 +0100 | [diff] [blame] | 1784 | # CAN frame packing/unpacking (see 'struct can_frame' in <linux/can.h>) |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1785 | |
| 1786 | can_frame_fmt = "=IB3x8s" |
Victor Stinner | b09460f | 2011-10-06 20:27:20 +0200 | [diff] [blame] | 1787 | can_frame_size = struct.calcsize(can_frame_fmt) |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1788 | |
| 1789 | def build_can_frame(can_id, data): |
| 1790 | can_dlc = len(data) |
| 1791 | data = data.ljust(8, b'\x00') |
| 1792 | return struct.pack(can_frame_fmt, can_id, can_dlc, data) |
| 1793 | |
| 1794 | def dissect_can_frame(frame): |
| 1795 | can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame) |
| 1796 | return (can_id, can_dlc, data[:can_dlc]) |
| 1797 | |
| 1798 | |
Georg Brandl | a673eb8 | 2012-03-04 16:17:05 +0100 | [diff] [blame] | 1799 | # create a raw socket and bind it to the 'vcan0' interface |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1800 | s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW) |
| 1801 | s.bind(('vcan0',)) |
| 1802 | |
| 1803 | while True: |
Victor Stinner | b09460f | 2011-10-06 20:27:20 +0200 | [diff] [blame] | 1804 | cf, addr = s.recvfrom(can_frame_size) |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1805 | |
| 1806 | print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf)) |
| 1807 | |
| 1808 | try: |
| 1809 | s.send(cf) |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 1810 | except OSError: |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1811 | print('Error sending CAN frame') |
| 1812 | |
| 1813 | try: |
| 1814 | s.send(build_can_frame(0x01, b'\x01\x02\x03')) |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 1815 | except OSError: |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1816 | print('Error sending CAN frame') |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 1817 | |
Sandro Tosi | 172f374 | 2011-09-02 20:06:31 +0200 | [diff] [blame] | 1818 | Running an example several times with too small delay between executions, could |
| 1819 | lead to this error:: |
| 1820 | |
Antoine Pitrou | 5574c30 | 2011-10-12 17:53:43 +0200 | [diff] [blame] | 1821 | OSError: [Errno 98] Address already in use |
Sandro Tosi | 172f374 | 2011-09-02 20:06:31 +0200 | [diff] [blame] | 1822 | |
| 1823 | This is because the previous execution has left the socket in a ``TIME_WAIT`` |
| 1824 | state, and can't be immediately reused. |
| 1825 | |
| 1826 | There is a :mod:`socket` flag to set, in order to prevent this, |
| 1827 | :data:`socket.SO_REUSEADDR`:: |
| 1828 | |
| 1829 | s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 1830 | s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |
| 1831 | s.bind((HOST, PORT)) |
| 1832 | |
| 1833 | the :data:`SO_REUSEADDR` flag tells the kernel to reuse a local socket in |
| 1834 | ``TIME_WAIT`` state, without waiting for its natural timeout to expire. |
| 1835 | |
| 1836 | |
Antoine Pitrou | 7bdfe77 | 2010-12-12 20:57:12 +0000 | [diff] [blame] | 1837 | .. seealso:: |
| 1838 | |
| 1839 | For an introduction to socket programming (in C), see the following papers: |
| 1840 | |
| 1841 | - *An Introductory 4.3BSD Interprocess Communication Tutorial*, by Stuart Sechrest |
| 1842 | |
| 1843 | - *An Advanced 4.3BSD Interprocess Communication Tutorial*, by Samuel J. Leffler et |
| 1844 | al, |
| 1845 | |
| 1846 | both in the UNIX Programmer's Manual, Supplementary Documents 1 (sections |
| 1847 | PS1:7 and PS1:8). The platform-specific reference material for the various |
| 1848 | socket-related system calls are also a valuable source of information on the |
| 1849 | details of socket semantics. For Unix, refer to the manual pages; for Windows, |
| 1850 | see the WinSock (or Winsock 2) specification. For IPv6-ready APIs, readers may |
| 1851 | want to refer to :rfc:`3493` titled Basic Socket Interface Extensions for IPv6. |