Fred Drake | 295da24 | 1998-08-10 19:42:37 +0000 | [diff] [blame] | 1 | \section{\module{socket} --- |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 2 | Low-level networking interface} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 3 | |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 4 | \declaremodule{builtin}{socket} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 5 | \modulesynopsis{Low-level networking interface.} |
| 6 | |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 7 | |
Fred Drake | af8a015 | 1998-01-14 14:51:31 +0000 | [diff] [blame] | 8 | This module provides access to the BSD \emph{socket} interface. |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 9 | It is available on all modern \UNIX{} systems, Windows, MacOS, BeOS, |
| 10 | OS/2, and probably additional platforms. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 11 | |
| 12 | For an introduction to socket programming (in C), see the following |
Fred Drake | 37f1574 | 1999-11-10 16:21:37 +0000 | [diff] [blame] | 13 | papers: \citetitle{An Introductory 4.3BSD Interprocess Communication |
| 14 | Tutorial}, by Stuart Sechrest and \citetitle{An Advanced 4.3BSD |
| 15 | Interprocess Communication Tutorial}, by Samuel J. Leffler et al, |
| 16 | both in the \citetitle{\UNIX{} Programmer's Manual, Supplementary Documents 1} |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 17 | (sections PS1:7 and PS1:8). The platform-specific reference material |
| 18 | for the various socket-related system calls are also a valuable source |
| 19 | of information on the details of socket semantics. For \UNIX, refer |
| 20 | to the manual pages; for Windows, see the WinSock (or Winsock 2) |
| 21 | specification. |
Fred Drake | 3fc291a | 2001-09-27 04:17:20 +0000 | [diff] [blame] | 22 | For IPv6-ready APIs, readers may want to refer to \rfc{2553} titled |
| 23 | \citetitle{Basic Socket Interface Extensions for IPv6}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 24 | |
| 25 | The Python interface is a straightforward transliteration of the |
| 26 | \UNIX{} system call and library interface for sockets to Python's |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 27 | object-oriented style: the \function{socket()} function returns a |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 28 | \dfn{socket object}\obindex{socket} whose methods implement the |
| 29 | various socket system calls. Parameter types are somewhat |
| 30 | higher-level than in the C interface: as with \method{read()} and |
| 31 | \method{write()} operations on Python files, buffer allocation on |
| 32 | receive operations is automatic, and buffer length is implicit on send |
| 33 | operations. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 34 | |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 35 | Socket addresses are represented as follows: |
| 36 | A single string is used for the \constant{AF_UNIX} address family. |
| 37 | A pair \code{(\var{host}, \var{port})} is used for the |
| 38 | \constant{AF_INET} address family, where \var{host} is a string |
| 39 | representing either a hostname in Internet domain notation like |
| 40 | \code{'daring.cwi.nl'} or an IPv4 address like \code{'100.50.200.5'}, |
| 41 | and \var{port} is an integral port number. |
| 42 | For \constant{AF_INET6} address family, a four-tuple |
| 43 | \code{(\var{host}, \var{port}, \var{flowinfo}, \var{scopeid})} is |
| 44 | used, where \var{flowinfo} and \var{scopeid} represents |
| 45 | \code{sin6_flowinfo} and \code{sin6_scope_id} member in |
| 46 | \constant{struct sockaddr_in6} in C. |
| 47 | For \module{socket} module methods, \var{flowinfo} and \var{scopeid} |
| 48 | can be omitted just for backward compatibility. Note, however, |
| 49 | omission of \var{scopeid} can cause problems in manipulating scoped |
| 50 | IPv6 addresses. Other address families are currently not supported. |
| 51 | The address format required by a particular socket object is |
| 52 | automatically selected based on the address family specified when the |
| 53 | socket object was created. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 54 | |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 55 | For IPv4 addresses, two special forms are accepted instead of a host |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 56 | address: the empty string represents \constant{INADDR_ANY}, and the string |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 57 | \code{'<broadcast>'} represents \constant{INADDR_BROADCAST}. |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 58 | The behavior is not available for IPv6 for backward compatibility, |
| 59 | therefore, you may want to avoid these if you intend to support IPv6 with |
| 60 | your Python programs. |
| 61 | |
| 62 | If you use a hostname in the \var{host} portion of IPv4/v6 socket |
| 63 | address, the program may show a nondeterministic behavior, as Python |
| 64 | uses the first address returned from the DNS resolution. The socket |
| 65 | address will be resolved differently into an actual IPv4/v6 address, |
| 66 | depending on the results from DNS resolution and/or the host |
| 67 | configuration. For deterministic behavior use a numeric address in |
| 68 | \var{host} portion. |
Guido van Rossum | e4f347e | 1997-05-09 02:21:51 +0000 | [diff] [blame] | 69 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 70 | All errors raise exceptions. The normal exceptions for invalid |
| 71 | argument types and out-of-memory conditions can be raised; errors |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 72 | related to socket or address semantics raise the error |
| 73 | \exception{socket.error}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 74 | |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 75 | Non-blocking mode is supported through the |
| 76 | \method{setblocking()} method. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 77 | |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 78 | The module \module{socket} exports the following constants and functions: |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 79 | |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 80 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 81 | \begin{excdesc}{error} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 82 | This exception is raised for socket-related errors. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 83 | The accompanying value is either a string telling what went wrong or a |
| 84 | pair \code{(\var{errno}, \var{string})} |
| 85 | representing an error returned by a system |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 86 | call, similar to the value accompanying \exception{os.error}. |
| 87 | See the module \refmodule{errno}\refbimodindex{errno}, which contains |
Guido van Rossum | 8e1e68d | 1998-02-06 15:18:25 +0000 | [diff] [blame] | 88 | names for the error codes defined by the underlying operating system. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 89 | \end{excdesc} |
| 90 | |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 91 | \begin{excdesc}{herror} |
| 92 | This exception is raised for address-related errors, i.e. for |
| 93 | functions that use \var{h_errno} in C API, including |
| 94 | \function{gethostbyname_ex} and \function{gethostbyaddr}. |
| 95 | |
| 96 | The accompanying value is a pair \code{(\var{h_errno}, \var{string})} |
| 97 | representing an error returned by a library call. \var{string} |
| 98 | represents the description of \var{h_errno}, as returned by |
| 99 | \cfunction{hstrerror} C API. |
| 100 | \end{excdesc} |
| 101 | |
| 102 | \begin{excdesc}{gaierror} |
| 103 | This exception is raised for address-related errors, for |
| 104 | \function{getaddrinfo} and \function{getnameinfo}. |
| 105 | The accompanying value is a pair \code{(\var{error}, \var{string})} |
| 106 | representing an error returned by a library call. |
| 107 | \var{string} represents the description of \var{error}, as returned |
| 108 | by \cfunction{gai_strerror} C API. |
| 109 | \end{excdesc} |
| 110 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 111 | \begin{datadesc}{AF_UNIX} |
| 112 | \dataline{AF_INET} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 113 | \dataline{AF_INET6} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 114 | These constants represent the address (and protocol) families, |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 115 | used for the first argument to \function{socket()}. If the |
| 116 | \constant{AF_UNIX} constant is not defined then this protocol is |
| 117 | unsupported. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 118 | \end{datadesc} |
| 119 | |
| 120 | \begin{datadesc}{SOCK_STREAM} |
| 121 | \dataline{SOCK_DGRAM} |
Guido van Rossum | 781db5d | 1994-08-05 13:37:36 +0000 | [diff] [blame] | 122 | \dataline{SOCK_RAW} |
| 123 | \dataline{SOCK_RDM} |
| 124 | \dataline{SOCK_SEQPACKET} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 125 | These constants represent the socket types, |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 126 | used for the second argument to \function{socket()}. |
| 127 | (Only \constant{SOCK_STREAM} and |
| 128 | \constant{SOCK_DGRAM} appear to be generally useful.) |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 129 | \end{datadesc} |
| 130 | |
Guido van Rossum | ed2bad8 | 1995-02-16 16:29:18 +0000 | [diff] [blame] | 131 | \begin{datadesc}{SO_*} |
| 132 | \dataline{SOMAXCONN} |
| 133 | \dataline{MSG_*} |
| 134 | \dataline{SOL_*} |
| 135 | \dataline{IPPROTO_*} |
| 136 | \dataline{IPPORT_*} |
| 137 | \dataline{INADDR_*} |
| 138 | \dataline{IP_*} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 139 | \dataline{IPV6_*} |
| 140 | \dataline{EAI_*} |
| 141 | \dataline{AI_*} |
| 142 | \dataline{NI_*} |
Guido van Rossum | 6bb1adc | 1995-03-13 10:03:32 +0000 | [diff] [blame] | 143 | Many constants of these forms, documented in the \UNIX{} documentation on |
Guido van Rossum | ed2bad8 | 1995-02-16 16:29:18 +0000 | [diff] [blame] | 144 | sockets and/or the IP protocol, are also defined in the socket module. |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 145 | They are generally used in arguments to the \method{setsockopt()} and |
| 146 | \method{getsockopt()} methods of socket objects. In most cases, only |
Guido van Rossum | 6bb1adc | 1995-03-13 10:03:32 +0000 | [diff] [blame] | 147 | those symbols that are defined in the \UNIX{} header files are defined; |
Guido van Rossum | ed2bad8 | 1995-02-16 16:29:18 +0000 | [diff] [blame] | 148 | for a few symbols, default values are provided. |
| 149 | \end{datadesc} |
| 150 | |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 151 | \begin{funcdesc}{getaddrinfo}{host, port\optional{, family, socktype, proto, flags}} |
| 152 | |
| 153 | Resolves the \var{host}/\var{port} argument, into a sequence of |
| 154 | 5-tuples that contain all the necessary argument for the sockets |
| 155 | manipulation. \var{host} is a domain name, a string representation of |
| 156 | IPv4/v6 address or \code{None}. |
| 157 | \var{port} is a string service name (like \code{``http''}), a numeric |
| 158 | port number or \code{None}. |
| 159 | |
| 160 | The rest of the arguments are optional and must be numeric if |
| 161 | specified. For \var{host} and \var{port}, by passing either an empty |
| 162 | string or \code{None}, you can pass \code{NULL} to the C API. The |
| 163 | \function{getaddrinfo()} function returns a list of 5-tuples with |
| 164 | the following structure: |
| 165 | |
| 166 | \code{(\var{family}, \var{socktype}, \var{proto}, \var{canonname}, \var{sockaddr})}. |
| 167 | |
| 168 | \var{family}, \var{socktype}, \var{proto} are all integer and are meant to |
| 169 | be passed to the \function{socket()} function. |
| 170 | \var{canonname} is a string representing the canonical name of the \var{host}. |
| 171 | It can be a numeric IPv4/v6 address when \code{AI_CANONNAME} is specified |
| 172 | for a numeric \var{host}. |
| 173 | \var{sockaddr} is a tuple describing a socket address, as described above. |
| 174 | See \code{Lib/httplib.py} and other library files |
| 175 | for a typical usage of the function. |
| 176 | \versionadded{2.2} |
| 177 | \end{funcdesc} |
| 178 | |
Fred Drake | 5772c86 | 2000-08-16 14:21:42 +0000 | [diff] [blame] | 179 | \begin{funcdesc}{getfqdn}{\optional{name}} |
| 180 | Return a fully qualified domain name for \var{name}. |
| 181 | If \var{name} is omitted or empty, it is interpreted as the local |
| 182 | host. To find the fully qualified name, the hostname returned by |
| 183 | \function{gethostbyaddr()} is checked, then aliases for the host, if |
| 184 | available. The first name which includes a period is selected. In |
| 185 | case no fully qualified domain name is available, the hostname is |
| 186 | returned. |
Fred Drake | 8b2e8f8 | 2000-09-06 02:22:16 +0000 | [diff] [blame] | 187 | \versionadded{2.0} |
Fred Drake | 5772c86 | 2000-08-16 14:21:42 +0000 | [diff] [blame] | 188 | \end{funcdesc} |
| 189 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 190 | \begin{funcdesc}{gethostbyname}{hostname} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 191 | Translate a host name to IPv4 address format. The IPv4 address is |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 192 | returned as a string, e.g., \code{'100.50.200.5'}. If the host name |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 193 | is an IPv4 address itself it is returned unchanged. See |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 194 | \function{gethostbyname_ex()} for a more complete interface. |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 195 | \function{gethostbyname()} does not support IPv6 name resolution, and |
| 196 | \function{getaddrinfo()} should be used instead for IPv4/v6 dual stack support. |
Guido van Rossum | cdf6af1 | 1998-08-07 18:07:36 +0000 | [diff] [blame] | 197 | \end{funcdesc} |
| 198 | |
| 199 | \begin{funcdesc}{gethostbyname_ex}{hostname} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 200 | Translate a host name to IPv4 address format, extended interface. |
Guido van Rossum | cdf6af1 | 1998-08-07 18:07:36 +0000 | [diff] [blame] | 201 | Return a triple \code{(hostname, aliaslist, ipaddrlist)} where |
| 202 | \code{hostname} is the primary host name responding to the given |
| 203 | \var{ip_address}, \code{aliaslist} is a (possibly empty) list of |
| 204 | alternative host names for the same address, and \code{ipaddrlist} is |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 205 | a list of IPv4 addresses for the same interface on the same |
Guido van Rossum | cdf6af1 | 1998-08-07 18:07:36 +0000 | [diff] [blame] | 206 | host (often but not always a single address). |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 207 | \function{gethostbyname_ex()} does not support IPv6 name resolution, and |
| 208 | \function{getaddrinfo()} should be used instead for IPv4/v6 dual stack support. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 209 | \end{funcdesc} |
| 210 | |
Guido van Rossum | 781db5d | 1994-08-05 13:37:36 +0000 | [diff] [blame] | 211 | \begin{funcdesc}{gethostname}{} |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 212 | Return a string containing the hostname of the machine where |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 213 | the Python interpreter is currently executing. |
| 214 | If you want to know the current machine's IP address, you may want to use |
| 215 | \code{gethostbyname(gethostname())}. |
| 216 | This operation assumes that there is a valid address-to-host mapping for |
| 217 | the host, and the assumption does not always hold. |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 218 | Note: \function{gethostname()} doesn't always return the fully qualified |
| 219 | domain name; use \code{gethostbyaddr(gethostname())} |
Guido van Rossum | fe27a50 | 1997-01-11 17:04:56 +0000 | [diff] [blame] | 220 | (see below). |
Guido van Rossum | 31cce97 | 1995-01-04 19:17:34 +0000 | [diff] [blame] | 221 | \end{funcdesc} |
| 222 | |
| 223 | \begin{funcdesc}{gethostbyaddr}{ip_address} |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 224 | Return a triple \code{(\var{hostname}, \var{aliaslist}, |
| 225 | \var{ipaddrlist})} where \var{hostname} is the primary host name |
| 226 | responding to the given \var{ip_address}, \var{aliaslist} is a |
| 227 | (possibly empty) list of alternative host names for the same address, |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 228 | and \var{ipaddrlist} is a list of IPv4/v6 addresses for the same interface |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 229 | on the same host (most likely containing only a single address). |
Fred Drake | 5772c86 | 2000-08-16 14:21:42 +0000 | [diff] [blame] | 230 | To find the fully qualified domain name, use the function |
| 231 | \function{getfqdn()}. |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 232 | \function{gethostbyaddr} supports both IPv4 and IPv6. |
| 233 | \end{funcdesc} |
| 234 | |
| 235 | \begin{funcdesc}{getnameinfo}{sockaddr, flags} |
| 236 | Translate a socket address \var{sockaddr} into a 2-tuple |
| 237 | \code{(\var{host}, \var{port})}. |
| 238 | Depending on the settings of \var{flags}, the result can contain a |
| 239 | fully-qualified domain name or numeric address representation in |
| 240 | \var{host}. Similarly, \var{port} can contain a string port name or a |
| 241 | numeric port number. |
| 242 | \versionadded{2.2} |
Guido van Rossum | 781db5d | 1994-08-05 13:37:36 +0000 | [diff] [blame] | 243 | \end{funcdesc} |
| 244 | |
Guido van Rossum | 62ac99e | 1996-12-19 16:43:25 +0000 | [diff] [blame] | 245 | \begin{funcdesc}{getprotobyname}{protocolname} |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 246 | Translate an Internet protocol name (e.g.\ \code{'icmp'}) to a constant |
Guido van Rossum | 62ac99e | 1996-12-19 16:43:25 +0000 | [diff] [blame] | 247 | suitable for passing as the (optional) third argument to the |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 248 | \function{socket()} function. This is usually only needed for sockets |
| 249 | opened in ``raw'' mode (\constant{SOCK_RAW}); for the normal socket |
| 250 | modes, the correct protocol is chosen automatically if the protocol is |
Guido van Rossum | 62ac99e | 1996-12-19 16:43:25 +0000 | [diff] [blame] | 251 | omitted or zero. |
| 252 | \end{funcdesc} |
| 253 | |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 254 | \begin{funcdesc}{getservbyname}{servicename, protocolname} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 255 | Translate an Internet service name and protocol name to a port number |
| 256 | for that service. The protocol name should be \code{'tcp'} or |
| 257 | \code{'udp'}. |
| 258 | \end{funcdesc} |
| 259 | |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 260 | \begin{funcdesc}{socket}{family, type\optional{, proto}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 261 | Create a new socket using the given address family, socket type and |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 262 | protocol number. The address family should be \constant{AF_INET}, \constant{AF_INET6} or |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 263 | \constant{AF_UNIX}. The socket type should be \constant{SOCK_STREAM}, |
| 264 | \constant{SOCK_DGRAM} or perhaps one of the other \samp{SOCK_} constants. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 265 | The protocol number is usually zero and may be omitted in that case. |
| 266 | \end{funcdesc} |
| 267 | |
Fred Drake | 9081bb1 | 2001-09-25 15:48:11 +0000 | [diff] [blame] | 268 | \begin{funcdesc}{ssl}{sock, keyfile, certfile} |
| 269 | Initiate a SSL connection over the socket \var{sock}. \var{keyfile} is |
| 270 | the name of a PEM formatted file that contains your private |
| 271 | key. \var{certfile} is a PEM formatted certificate chain file. On |
| 272 | success, a new \class{SSLObject} is returned. |
| 273 | |
| 274 | \strong{Warning:} This does not do any certificate verification! |
| 275 | \end{funcdesc} |
| 276 | |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 277 | \begin{funcdesc}{fromfd}{fd, family, type\optional{, proto}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 278 | Build a socket object from an existing file descriptor (an integer as |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 279 | returned by a file object's \method{fileno()} method). Address family, |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 280 | socket type and protocol number are as for the \function{socket()} function |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 281 | above. The file descriptor should refer to a socket, but this is not |
| 282 | checked --- subsequent operations on the object may fail if the file |
| 283 | descriptor is invalid. This function is rarely needed, but can be |
| 284 | used to get or set socket options on a socket passed to a program as |
Guido van Rossum | 6bb1adc | 1995-03-13 10:03:32 +0000 | [diff] [blame] | 285 | standard input or output (e.g.\ a server started by the \UNIX{} inet |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 286 | daemon). |
| 287 | \end{funcdesc} |
| 288 | |
Guido van Rossum | bda7ca7 | 1996-12-02 17:24:10 +0000 | [diff] [blame] | 289 | \begin{funcdesc}{ntohl}{x} |
Fred Drake | c5aec05 | 1997-12-08 21:25:41 +0000 | [diff] [blame] | 290 | Convert 32-bit integers from network to host byte order. On machines |
| 291 | where the host byte order is the same as network byte order, this is a |
| 292 | no-op; otherwise, it performs a 4-byte swap operation. |
| 293 | \end{funcdesc} |
| 294 | |
| 295 | \begin{funcdesc}{ntohs}{x} |
| 296 | Convert 16-bit integers from network to host byte order. On machines |
| 297 | where the host byte order is the same as network byte order, this is a |
| 298 | no-op; otherwise, it performs a 2-byte swap operation. |
| 299 | \end{funcdesc} |
| 300 | |
| 301 | \begin{funcdesc}{htonl}{x} |
| 302 | Convert 32-bit integers from host to network byte order. On machines |
| 303 | where the host byte order is the same as network byte order, this is a |
| 304 | no-op; otherwise, it performs a 4-byte swap operation. |
| 305 | \end{funcdesc} |
| 306 | |
| 307 | \begin{funcdesc}{htons}{x} |
| 308 | Convert 16-bit integers from host to network byte order. On machines |
| 309 | where the host byte order is the same as network byte order, this is a |
| 310 | no-op; otherwise, it performs a 2-byte swap operation. |
Guido van Rossum | bda7ca7 | 1996-12-02 17:24:10 +0000 | [diff] [blame] | 311 | \end{funcdesc} |
| 312 | |
Fred Drake | e6fb1c4 | 1999-09-16 15:50:00 +0000 | [diff] [blame] | 313 | \begin{funcdesc}{inet_aton}{ip_string} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 314 | Convert an IPv4 address from dotted-quad string format |
Fred Drake | e6fb1c4 | 1999-09-16 15:50:00 +0000 | [diff] [blame] | 315 | (e.g.\ '123.45.67.89') to 32-bit packed binary format, as a string four |
| 316 | characters in length. |
| 317 | |
| 318 | Useful when conversing with a program that uses the standard C library |
| 319 | and needs objects of type \ctype{struct in_addr}, which is the C type |
| 320 | for the 32-bit packed binary this function returns. |
| 321 | |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 322 | If the IPv4 address string passed to this function is invalid, |
Fred Drake | e6fb1c4 | 1999-09-16 15:50:00 +0000 | [diff] [blame] | 323 | \exception{socket.error} will be raised. Note that exactly what is |
| 324 | valid depends on the underlying C implementation of |
| 325 | \cfunction{inet_aton()}. |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 326 | |
| 327 | \function{inet_aton} does not support IPv6, and |
| 328 | \function{getnameinfo()} should be used instead for IPv4/v6 dual stack support. |
Fred Drake | e6fb1c4 | 1999-09-16 15:50:00 +0000 | [diff] [blame] | 329 | \end{funcdesc} |
| 330 | |
| 331 | \begin{funcdesc}{inet_ntoa}{packed_ip} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 332 | Convert a 32-bit packed IPv4 address (a string four characters in |
Fred Drake | e6fb1c4 | 1999-09-16 15:50:00 +0000 | [diff] [blame] | 333 | length) to its standard dotted-quad string representation |
| 334 | (e.g. '123.45.67.89'). |
| 335 | |
| 336 | Useful when conversing with a program that uses the standard C library |
| 337 | and needs objects of type \ctype{struct in_addr}, which is the C type |
| 338 | for the 32-bit packed binary this function takes as an argument. |
| 339 | |
| 340 | If the string passed to this function is not exactly 4 bytes in |
| 341 | length, \exception{socket.error} will be raised. |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 342 | |
| 343 | \function{inet_ntoa} does not support IPv6, and |
| 344 | \function{getnameinfo()} should be used instead for IPv4/v6 dual stack support. |
Fred Drake | e6fb1c4 | 1999-09-16 15:50:00 +0000 | [diff] [blame] | 345 | \end{funcdesc} |
| 346 | |
Fred Drake | 5451d67 | 1997-10-13 21:31:02 +0000 | [diff] [blame] | 347 | \begin{datadesc}{SocketType} |
Guido van Rossum | 2335c5e | 1997-05-21 14:41:42 +0000 | [diff] [blame] | 348 | This is a Python type object that represents the socket object type. |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 349 | It is the same as \code{type(socket(...))}. |
Guido van Rossum | 2335c5e | 1997-05-21 14:41:42 +0000 | [diff] [blame] | 350 | \end{datadesc} |
| 351 | |
Fred Drake | aa7524c | 2000-07-06 18:37:08 +0000 | [diff] [blame] | 352 | |
| 353 | \begin{seealso} |
| 354 | \seemodule{SocketServer}{Classes that simplify writing network servers.} |
| 355 | \end{seealso} |
| 356 | |
| 357 | |
Fred Drake | a94f676 | 1999-08-05 13:41:04 +0000 | [diff] [blame] | 358 | \subsection{Socket Objects \label{socket-objects}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 359 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 360 | Socket objects have the following methods. Except for |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 361 | \method{makefile()} these correspond to \UNIX{} system calls |
| 362 | applicable to sockets. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 363 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 364 | \begin{methoddesc}[socket]{accept}{} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 365 | Accept a connection. |
| 366 | The socket must be bound to an address and listening for connections. |
| 367 | The return value is a pair \code{(\var{conn}, \var{address})} |
| 368 | where \var{conn} is a \emph{new} socket object usable to send and |
| 369 | receive data on the connection, and \var{address} is the address bound |
| 370 | to the socket on the other end of the connection. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 371 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 372 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 373 | \begin{methoddesc}[socket]{bind}{address} |
Guido van Rossum | a84ec51 | 1994-06-23 12:13:52 +0000 | [diff] [blame] | 374 | Bind the socket to \var{address}. The socket must not already be bound. |
Fred Drake | 7d68690 | 2000-04-04 17:48:30 +0000 | [diff] [blame] | 375 | (The format of \var{address} depends on the address family --- see |
| 376 | above.) \strong{Note:} This method has historically accepted a pair |
| 377 | of parameters for \constant{AF_INET} addresses instead of only a |
Eric S. Raymond | 8321026 | 2001-01-10 19:34:52 +0000 | [diff] [blame] | 378 | tuple. This was never intentional and is no longer be available in |
| 379 | Python 2.0. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 380 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 381 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 382 | \begin{methoddesc}[socket]{close}{} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 383 | Close the socket. All future operations on the socket object will fail. |
| 384 | The remote end will receive no more data (after queued data is flushed). |
| 385 | Sockets are automatically closed when they are garbage-collected. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 386 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 387 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 388 | \begin{methoddesc}[socket]{connect}{address} |
Guido van Rossum | a84ec51 | 1994-06-23 12:13:52 +0000 | [diff] [blame] | 389 | Connect to a remote socket at \var{address}. |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 390 | (The format of \var{address} depends on the address family --- see |
Fred Drake | 7d68690 | 2000-04-04 17:48:30 +0000 | [diff] [blame] | 391 | above.) \strong{Note:} This method has historically accepted a pair |
| 392 | of parameters for \constant{AF_INET} addresses instead of only a |
Eric S. Raymond | 8321026 | 2001-01-10 19:34:52 +0000 | [diff] [blame] | 393 | tuple. This was never intentional and is no longer available in |
| 394 | Python 2.0 and later. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 395 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 396 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 397 | \begin{methoddesc}[socket]{connect_ex}{address} |
Guido van Rossum | eefcba6 | 1997-12-09 19:47:24 +0000 | [diff] [blame] | 398 | Like \code{connect(\var{address})}, but return an error indicator |
Fred Drake | b0bc7f2 | 1999-05-06 22:03:50 +0000 | [diff] [blame] | 399 | instead of raising an exception for errors returned by the C-level |
| 400 | \cfunction{connect()} call (other problems, such as ``host not found,'' |
| 401 | can still raise exceptions). The error indicator is \code{0} if the |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 402 | operation succeeded, otherwise the value of the \cdata{errno} |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 403 | variable. This is useful, e.g., for asynchronous connects. |
Fred Drake | 7d68690 | 2000-04-04 17:48:30 +0000 | [diff] [blame] | 404 | \strong{Note:} This method has historically accepted a pair of |
| 405 | parameters for \constant{AF_INET} addresses instead of only a tuple. |
Eric S. Raymond | 8321026 | 2001-01-10 19:34:52 +0000 | [diff] [blame] | 406 | This was never intentional and is no longer be available in Python |
| 407 | 2.0 and later. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 408 | \end{methoddesc} |
Guido van Rossum | f7790c6 | 1997-11-18 15:29:20 +0000 | [diff] [blame] | 409 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 410 | \begin{methoddesc}[socket]{fileno}{} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 411 | Return the socket's file descriptor (a small integer). This is useful |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 412 | with \function{select.select()}. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 413 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 414 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 415 | \begin{methoddesc}[socket]{getpeername}{} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 416 | Return the remote address to which the socket is connected. This is |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 417 | useful to find out the port number of a remote IPv4/v6 socket, for instance. |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 418 | (The format of the address returned depends on the address family --- |
Guido van Rossum | 781db5d | 1994-08-05 13:37:36 +0000 | [diff] [blame] | 419 | see above.) On some systems this function is not supported. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 420 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 421 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 422 | \begin{methoddesc}[socket]{getsockname}{} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 423 | Return the socket's own address. This is useful to find out the port |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 424 | number of an IPv4/v6 socket, for instance. |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 425 | (The format of the address returned depends on the address family --- |
Guido van Rossum | a84ec51 | 1994-06-23 12:13:52 +0000 | [diff] [blame] | 426 | see above.) |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 427 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 428 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 429 | \begin{methoddesc}[socket]{getsockopt}{level, optname\optional{, buflen}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 430 | Return the value of the given socket option (see the \UNIX{} man page |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 431 | \manpage{getsockopt}{2}). The needed symbolic constants |
| 432 | (\constant{SO_*} etc.) are defined in this module. If \var{buflen} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 433 | is absent, an integer option is assumed and its integer value |
Guido van Rossum | 8df3637 | 1995-02-27 17:52:15 +0000 | [diff] [blame] | 434 | is returned by the function. If \var{buflen} is present, it specifies |
| 435 | the maximum length of the buffer used to receive the option in, and |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 436 | this buffer is returned as a string. It is up to the caller to decode |
Guido van Rossum | 8df3637 | 1995-02-27 17:52:15 +0000 | [diff] [blame] | 437 | the contents of the buffer (see the optional built-in module |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 438 | \refmodule{struct} for a way to decode C structures encoded as strings). |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 439 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 440 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 441 | \begin{methoddesc}[socket]{listen}{backlog} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 442 | Listen for connections made to the socket. The \var{backlog} argument |
| 443 | specifies the maximum number of queued connections and should be at |
| 444 | least 1; the maximum value is system-dependent (usually 5). |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 445 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 446 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 447 | \begin{methoddesc}[socket]{makefile}{\optional{mode\optional{, bufsize}}} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 448 | Return a \dfn{file object} associated with the socket. (File objects |
Fred Drake | a94f676 | 1999-08-05 13:41:04 +0000 | [diff] [blame] | 449 | are described in \ref{bltin-file-objects}, ``File Objects.'') |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 450 | The file object references a \cfunction{dup()}ped version of the |
| 451 | socket file descriptor, so the file object and socket object may be |
Fred Drake | a94f676 | 1999-08-05 13:41:04 +0000 | [diff] [blame] | 452 | closed or garbage-collected independently. |
| 453 | \index{I/O control!buffering}The optional \var{mode} |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 454 | and \var{bufsize} arguments are interpreted the same way as by the |
| 455 | built-in \function{open()} function. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 456 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 457 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 458 | \begin{methoddesc}[socket]{recv}{bufsize\optional{, flags}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 459 | Receive data from the socket. The return value is a string representing |
| 460 | the data received. The maximum amount of data to be received |
| 461 | at once is specified by \var{bufsize}. See the \UNIX{} manual page |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 462 | \manpage{recv}{2} for the meaning of the optional argument |
| 463 | \var{flags}; it defaults to zero. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 464 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 465 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 466 | \begin{methoddesc}[socket]{recvfrom}{bufsize\optional{, flags}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 467 | Receive data from the socket. The return value is a pair |
| 468 | \code{(\var{string}, \var{address})} where \var{string} is a string |
| 469 | representing the data received and \var{address} is the address of the |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 470 | socket sending the data. The optional \var{flags} argument has the |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 471 | same meaning as for \method{recv()} above. |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 472 | (The format of \var{address} depends on the address family --- see above.) |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 473 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 474 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 475 | \begin{methoddesc}[socket]{send}{string\optional{, flags}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 476 | Send data to the socket. The socket must be connected to a remote |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 477 | socket. The optional \var{flags} argument has the same meaning as for |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 478 | \method{recv()} above. Returns the number of bytes sent. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 479 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 480 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 481 | \begin{methoddesc}[socket]{sendto}{string\optional{, flags}, address} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 482 | Send data to the socket. The socket should not be connected to a |
| 483 | remote socket, since the destination socket is specified by |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 484 | \var{address}. The optional \var{flags} argument has the same |
| 485 | meaning as for \method{recv()} above. Return the number of bytes sent. |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 486 | (The format of \var{address} depends on the address family --- see above.) |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 487 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 488 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 489 | \begin{methoddesc}[socket]{setblocking}{flag} |
Guido van Rossum | 9195148 | 1994-09-07 14:39:14 +0000 | [diff] [blame] | 490 | Set blocking or non-blocking mode of the socket: if \var{flag} is 0, |
| 491 | the socket is set to non-blocking, else to blocking mode. Initially |
| 492 | all sockets are in blocking mode. In non-blocking mode, if a |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 493 | \method{recv()} call doesn't find any data, or if a |
| 494 | \method{send()} call can't immediately dispose of the data, a |
| 495 | \exception{error} exception is raised; in blocking mode, the calls |
| 496 | block until they can proceed. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 497 | \end{methoddesc} |
Guido van Rossum | 9195148 | 1994-09-07 14:39:14 +0000 | [diff] [blame] | 498 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 499 | \begin{methoddesc}[socket]{setsockopt}{level, optname, value} |
Fred Drake | 9a748aa | 2000-06-30 04:21:41 +0000 | [diff] [blame] | 500 | Set the value of the given socket option (see the \UNIX{} manual page |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 501 | \manpage{setsockopt}{2}). The needed symbolic constants are defined in |
| 502 | the \module{socket} module (\code{SO_*} etc.). The value can be an |
Guido van Rossum | 8df3637 | 1995-02-27 17:52:15 +0000 | [diff] [blame] | 503 | integer or a string representing a buffer. In the latter case it is |
| 504 | up to the caller to ensure that the string contains the proper bits |
| 505 | (see the optional built-in module |
Fred Drake | 318c0b1 | 1999-04-21 17:29:14 +0000 | [diff] [blame] | 506 | \refmodule{struct}\refbimodindex{struct} for a way to encode C |
| 507 | structures as strings). |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 508 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 509 | |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 510 | \begin{methoddesc}[socket]{shutdown}{how} |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 511 | Shut down one or both halves of the connection. If \var{how} is |
| 512 | \code{0}, further receives are disallowed. If \var{how} is \code{1}, |
| 513 | further sends are disallowed. If \var{how} is \code{2}, further sends |
| 514 | and receives are disallowed. |
Fred Drake | 3f1c472 | 1998-04-03 07:04:45 +0000 | [diff] [blame] | 515 | \end{methoddesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 516 | |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 517 | Note that there are no methods \method{read()} or \method{write()}; |
| 518 | use \method{recv()} and \method{send()} without \var{flags} argument |
| 519 | instead. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 520 | |
Fred Drake | aa7524c | 2000-07-06 18:37:08 +0000 | [diff] [blame] | 521 | |
Fred Drake | 9081bb1 | 2001-09-25 15:48:11 +0000 | [diff] [blame] | 522 | \subsection{SSL Objects \label{ssl-objects}} |
| 523 | |
| 524 | SSL objects have the following methods. |
| 525 | |
| 526 | \begin{methoddesc}{write}{s} |
| 527 | Writes the string \var{s} to the on the object's SSL connection. |
| 528 | The return value is the number of bytes written. |
| 529 | \end{methoddesc} |
| 530 | |
| 531 | \begin{methoddesc}{read}{\optional{n}} |
| 532 | If \var{n} is provided, read \var{n} bytes from the SSL connection, otherwise |
| 533 | read until EOF. The return value is a string of the bytes read. |
| 534 | \end{methoddesc} |
| 535 | |
Fred Drake | aa7524c | 2000-07-06 18:37:08 +0000 | [diff] [blame] | 536 | \subsection{Example \label{socket-example}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 537 | |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 538 | Here are four minimal example programs using the TCP/IP protocol:\ a |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 539 | server that echoes all data that it receives back (servicing only one |
| 540 | client), and a client using it. Note that a server must perform the |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 541 | sequence \function{socket()}, \method{bind()}, \method{listen()}, |
| 542 | \method{accept()} (possibly repeating the \method{accept()} to service |
| 543 | more than one client), while a client only needs the sequence |
| 544 | \function{socket()}, \method{connect()}. Also note that the server |
| 545 | does not \method{send()}/\method{recv()} on the |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 546 | socket it is listening on but on the new socket returned by |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 547 | \method{accept()}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 548 | |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 549 | The first two examples support IPv4 only. |
| 550 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 551 | \begin{verbatim} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 552 | # Echo server program |
Fred Drake | ef52f60 | 2000-10-10 20:36:29 +0000 | [diff] [blame] | 553 | import socket |
| 554 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 555 | HOST = '' # Symbolic name meaning the local host |
Fred Drake | ef52f60 | 2000-10-10 20:36:29 +0000 | [diff] [blame] | 556 | PORT = 50007 # Arbitrary non-privileged port |
| 557 | s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
Fred Drake | 3d69c0e | 2000-05-03 19:40:32 +0000 | [diff] [blame] | 558 | s.bind((HOST, PORT)) |
Guido van Rossum | 5da5755 | 1994-03-02 10:52:16 +0000 | [diff] [blame] | 559 | s.listen(1) |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 560 | conn, addr = s.accept() |
| 561 | print 'Connected by', addr |
| 562 | while 1: |
| 563 | data = conn.recv(1024) |
| 564 | if not data: break |
| 565 | conn.send(data) |
| 566 | conn.close() |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 567 | \end{verbatim} |
Fred Drake | d883ca1 | 1998-03-10 05:20:33 +0000 | [diff] [blame] | 568 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 569 | \begin{verbatim} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 570 | # Echo client program |
Fred Drake | ef52f60 | 2000-10-10 20:36:29 +0000 | [diff] [blame] | 571 | import socket |
| 572 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 573 | HOST = 'daring.cwi.nl' # The remote host |
| 574 | PORT = 50007 # The same port as used by the server |
Fred Drake | ef52f60 | 2000-10-10 20:36:29 +0000 | [diff] [blame] | 575 | s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
Fred Drake | 3d69c0e | 2000-05-03 19:40:32 +0000 | [diff] [blame] | 576 | s.connect((HOST, PORT)) |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 577 | s.send('Hello, world') |
| 578 | data = s.recv(1024) |
| 579 | s.close() |
| 580 | print 'Received', `data` |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 581 | \end{verbatim} |
Martin v. Löwis | c9908c4 | 2001-08-04 22:22:45 +0000 | [diff] [blame] | 582 | |
| 583 | The next two examples are identical to the above two, but support both |
| 584 | IPv4 and IPv6. |
| 585 | The server side will listen to the first address family available |
| 586 | (it should listen to both instead). |
| 587 | On most of IPv6-ready systems, IPv6 will take precedence |
| 588 | and the server may not accept IPv4 traffic. |
| 589 | The client side will try to connect to the all addresses returned as a result |
| 590 | of the name resolution, and sends traffic to the first one connected |
| 591 | successfully. |
| 592 | |
| 593 | \begin{verbatim} |
| 594 | # Echo server program |
| 595 | import socket |
| 596 | import sys |
| 597 | |
| 598 | HOST = '' # Symbolic name meaning the local host |
| 599 | PORT = 50007 # Arbitrary non-privileged port |
| 600 | s = None |
| 601 | for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM, 0, socket.AI_PASSIVE): |
| 602 | af, socktype, proto, canonname, sa = res |
| 603 | try: |
| 604 | s = socket.socket(af, socktype, proto) |
| 605 | except socket.error, msg: |
| 606 | s = None |
| 607 | continue |
| 608 | try: |
| 609 | s.bind(sa) |
| 610 | s.listen(1) |
| 611 | except socket.error, msg: |
| 612 | s.close() |
| 613 | s = None |
| 614 | continue |
| 615 | break |
| 616 | if s is None: |
| 617 | print 'could not open socket' |
| 618 | sys.exit(1) |
| 619 | conn, addr = s.accept() |
| 620 | print 'Connected by', addr |
| 621 | while 1: |
| 622 | data = conn.recv(1024) |
| 623 | if not data: break |
| 624 | conn.send(data) |
| 625 | conn.close() |
| 626 | \end{verbatim} |
| 627 | |
| 628 | \begin{verbatim} |
| 629 | # Echo client program |
| 630 | import socket |
| 631 | import sys |
| 632 | |
| 633 | HOST = 'daring.cwi.nl' # The remote host |
| 634 | PORT = 50007 # The same port as used by the server |
| 635 | s = None |
| 636 | for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM): |
| 637 | af, socktype, proto, canonname, sa = res |
| 638 | try: |
| 639 | s = socket.socket(af, socktype, proto) |
| 640 | except socket.error, msg: |
| 641 | s = None |
| 642 | continue |
| 643 | try: |
| 644 | s.connect(sa) |
| 645 | except socket.error, msg: |
| 646 | s.close() |
| 647 | s = None |
| 648 | continue |
| 649 | break |
| 650 | if s is None: |
| 651 | print 'could not open socket' |
| 652 | sys.exit(1) |
| 653 | s.send('Hello, world') |
| 654 | data = s.recv(1024) |
| 655 | s.close() |
| 656 | print 'Received', `data` |
| 657 | \end{verbatim} |