blob: e8109ebb6e3984ff292cbc42970b646aa2fdc84a [file] [log] [blame]
Fred Drake295da241998-08-10 19:42:37 +00001\section{\module{socket} ---
Fred Drake318c0b11999-04-21 17:29:14 +00002 Low-level networking interface}
Fred Drakeb91e9341998-07-23 17:59:49 +00003
Fred Drake318c0b11999-04-21 17:29:14 +00004\declaremodule{builtin}{socket}
Fred Drakeb91e9341998-07-23 17:59:49 +00005\modulesynopsis{Low-level networking interface.}
6
Fred Draked883ca11998-03-10 05:20:33 +00007
Fred Drakeaf8a0151998-01-14 14:51:31 +00008This module provides access to the BSD \emph{socket} interface.
Fred Drake38e5d272000-04-03 20:13:55 +00009It is available on all modern \UNIX{} systems, Windows, MacOS, BeOS,
10OS/2, and probably additional platforms.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000011
12For an introduction to socket programming (in C), see the following
Fred Drake37f15741999-11-10 16:21:37 +000013papers: \citetitle{An Introductory 4.3BSD Interprocess Communication
14Tutorial}, by Stuart Sechrest and \citetitle{An Advanced 4.3BSD
15Interprocess Communication Tutorial}, by Samuel J. Leffler et al,
16both in the \citetitle{\UNIX{} Programmer's Manual, Supplementary Documents 1}
Fred Drake38e5d272000-04-03 20:13:55 +000017(sections PS1:7 and PS1:8). The platform-specific reference material
18for the various socket-related system calls are also a valuable source
19of information on the details of socket semantics. For \UNIX, refer
20to the manual pages; for Windows, see the WinSock (or Winsock 2)
21specification.
Fred Drake3fc291a2001-09-27 04:17:20 +000022For IPv6-ready APIs, readers may want to refer to \rfc{2553} titled
23\citetitle{Basic Socket Interface Extensions for IPv6}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000024
25The Python interface is a straightforward transliteration of the
26\UNIX{} system call and library interface for sockets to Python's
Fred Draked883ca11998-03-10 05:20:33 +000027object-oriented style: the \function{socket()} function returns a
Fred Drake318c0b11999-04-21 17:29:14 +000028\dfn{socket object}\obindex{socket} whose methods implement the
29various socket system calls. Parameter types are somewhat
30higher-level than in the C interface: as with \method{read()} and
31\method{write()} operations on Python files, buffer allocation on
32receive operations is automatic, and buffer length is implicit on send
33operations.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000034
Martin v. Löwisc9908c42001-08-04 22:22:45 +000035Socket addresses are represented as follows:
36A single string is used for the \constant{AF_UNIX} address family.
37A pair \code{(\var{host}, \var{port})} is used for the
38\constant{AF_INET} address family, where \var{host} is a string
39representing either a hostname in Internet domain notation like
40\code{'daring.cwi.nl'} or an IPv4 address like \code{'100.50.200.5'},
41and \var{port} is an integral port number.
42For \constant{AF_INET6} address family, a four-tuple
43\code{(\var{host}, \var{port}, \var{flowinfo}, \var{scopeid})} is
44used, 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.
47For \module{socket} module methods, \var{flowinfo} and \var{scopeid}
48can be omitted just for backward compatibility. Note, however,
49omission of \var{scopeid} can cause problems in manipulating scoped
50IPv6 addresses. Other address families are currently not supported.
51The address format required by a particular socket object is
52automatically selected based on the address family specified when the
53socket object was created.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000054
Martin v. Löwisc9908c42001-08-04 22:22:45 +000055For IPv4 addresses, two special forms are accepted instead of a host
Fred Draked883ca11998-03-10 05:20:33 +000056address: the empty string represents \constant{INADDR_ANY}, and the string
Fred Drake318c0b11999-04-21 17:29:14 +000057\code{'<broadcast>'} represents \constant{INADDR_BROADCAST}.
Martin v. Löwisc9908c42001-08-04 22:22:45 +000058The behavior is not available for IPv6 for backward compatibility,
59therefore, you may want to avoid these if you intend to support IPv6 with
60your Python programs.
61
62If you use a hostname in the \var{host} portion of IPv4/v6 socket
63address, the program may show a nondeterministic behavior, as Python
64uses the first address returned from the DNS resolution. The socket
65address will be resolved differently into an actual IPv4/v6 address,
66depending on the results from DNS resolution and/or the host
67configuration. For deterministic behavior use a numeric address in
68\var{host} portion.
Guido van Rossume4f347e1997-05-09 02:21:51 +000069
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000070All errors raise exceptions. The normal exceptions for invalid
71argument types and out-of-memory conditions can be raised; errors
Fred Drake318c0b11999-04-21 17:29:14 +000072related to socket or address semantics raise the error
73\exception{socket.error}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000074
Fred Drake318c0b11999-04-21 17:29:14 +000075Non-blocking mode is supported through the
76\method{setblocking()} method.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000077
Fred Draked883ca11998-03-10 05:20:33 +000078The module \module{socket} exports the following constants and functions:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000079
Fred Draked883ca11998-03-10 05:20:33 +000080
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000081\begin{excdesc}{error}
Martin v. Löwisc9908c42001-08-04 22:22:45 +000082This exception is raised for socket-related errors.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000083The accompanying value is either a string telling what went wrong or a
84pair \code{(\var{errno}, \var{string})}
85representing an error returned by a system
Fred Drake318c0b11999-04-21 17:29:14 +000086call, similar to the value accompanying \exception{os.error}.
87See the module \refmodule{errno}\refbimodindex{errno}, which contains
Guido van Rossum8e1e68d1998-02-06 15:18:25 +000088names for the error codes defined by the underlying operating system.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000089\end{excdesc}
90
Martin v. Löwisc9908c42001-08-04 22:22:45 +000091\begin{excdesc}{herror}
92This exception is raised for address-related errors, i.e. for
93functions that use \var{h_errno} in C API, including
94\function{gethostbyname_ex} and \function{gethostbyaddr}.
95
96The accompanying value is a pair \code{(\var{h_errno}, \var{string})}
97representing an error returned by a library call. \var{string}
98represents the description of \var{h_errno}, as returned by
99\cfunction{hstrerror} C API.
100\end{excdesc}
101
102\begin{excdesc}{gaierror}
103This exception is raised for address-related errors, for
104\function{getaddrinfo} and \function{getnameinfo}.
105The accompanying value is a pair \code{(\var{error}, \var{string})}
106representing an error returned by a library call.
107\var{string} represents the description of \var{error}, as returned
108by \cfunction{gai_strerror} C API.
109\end{excdesc}
110
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000111\begin{datadesc}{AF_UNIX}
112\dataline{AF_INET}
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000113\dataline{AF_INET6}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000114These constants represent the address (and protocol) families,
Fred Draked883ca11998-03-10 05:20:33 +0000115used for the first argument to \function{socket()}. If the
116\constant{AF_UNIX} constant is not defined then this protocol is
117unsupported.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000118\end{datadesc}
119
120\begin{datadesc}{SOCK_STREAM}
121\dataline{SOCK_DGRAM}
Guido van Rossum781db5d1994-08-05 13:37:36 +0000122\dataline{SOCK_RAW}
123\dataline{SOCK_RDM}
124\dataline{SOCK_SEQPACKET}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000125These constants represent the socket types,
Fred Draked883ca11998-03-10 05:20:33 +0000126used for the second argument to \function{socket()}.
127(Only \constant{SOCK_STREAM} and
128\constant{SOCK_DGRAM} appear to be generally useful.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000129\end{datadesc}
130
Guido van Rossumed2bad81995-02-16 16:29:18 +0000131\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öwisc9908c42001-08-04 22:22:45 +0000139\dataline{IPV6_*}
140\dataline{EAI_*}
141\dataline{AI_*}
142\dataline{NI_*}
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000143Many constants of these forms, documented in the \UNIX{} documentation on
Guido van Rossumed2bad81995-02-16 16:29:18 +0000144sockets and/or the IP protocol, are also defined in the socket module.
Fred Draked883ca11998-03-10 05:20:33 +0000145They are generally used in arguments to the \method{setsockopt()} and
146\method{getsockopt()} methods of socket objects. In most cases, only
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000147those symbols that are defined in the \UNIX{} header files are defined;
Guido van Rossumed2bad81995-02-16 16:29:18 +0000148for a few symbols, default values are provided.
149\end{datadesc}
150
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000151\begin{funcdesc}{getaddrinfo}{host, port\optional{, family, socktype, proto, flags}}
152
153Resolves the \var{host}/\var{port} argument, into a sequence of
1545-tuples that contain all the necessary argument for the sockets
155manipulation. \var{host} is a domain name, a string representation of
156IPv4/v6 address or \code{None}.
157\var{port} is a string service name (like \code{``http''}), a numeric
158port number or \code{None}.
159
160The rest of the arguments are optional and must be numeric if
161specified. For \var{host} and \var{port}, by passing either an empty
162string or \code{None}, you can pass \code{NULL} to the C API. The
163\function{getaddrinfo()} function returns a list of 5-tuples with
164the 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
169be passed to the \function{socket()} function.
170\var{canonname} is a string representing the canonical name of the \var{host}.
171It can be a numeric IPv4/v6 address when \code{AI_CANONNAME} is specified
172for a numeric \var{host}.
173\var{sockaddr} is a tuple describing a socket address, as described above.
174See \code{Lib/httplib.py} and other library files
175for a typical usage of the function.
176\versionadded{2.2}
177\end{funcdesc}
178
Fred Drake5772c862000-08-16 14:21:42 +0000179\begin{funcdesc}{getfqdn}{\optional{name}}
180Return a fully qualified domain name for \var{name}.
181If \var{name} is omitted or empty, it is interpreted as the local
182host. To find the fully qualified name, the hostname returned by
183\function{gethostbyaddr()} is checked, then aliases for the host, if
184available. The first name which includes a period is selected. In
185case no fully qualified domain name is available, the hostname is
186returned.
Fred Drake8b2e8f82000-09-06 02:22:16 +0000187\versionadded{2.0}
Fred Drake5772c862000-08-16 14:21:42 +0000188\end{funcdesc}
189
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000190\begin{funcdesc}{gethostbyname}{hostname}
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000191Translate a host name to IPv4 address format. The IPv4 address is
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000192returned as a string, e.g., \code{'100.50.200.5'}. If the host name
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000193is an IPv4 address itself it is returned unchanged. See
Fred Drake318c0b11999-04-21 17:29:14 +0000194\function{gethostbyname_ex()} for a more complete interface.
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000195\function{gethostbyname()} does not support IPv6 name resolution, and
196\function{getaddrinfo()} should be used instead for IPv4/v6 dual stack support.
Guido van Rossumcdf6af11998-08-07 18:07:36 +0000197\end{funcdesc}
198
199\begin{funcdesc}{gethostbyname_ex}{hostname}
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000200Translate a host name to IPv4 address format, extended interface.
Guido van Rossumcdf6af11998-08-07 18:07:36 +0000201Return 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
204alternative host names for the same address, and \code{ipaddrlist} is
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000205a list of IPv4 addresses for the same interface on the same
Guido van Rossumcdf6af11998-08-07 18:07:36 +0000206host (often but not always a single address).
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000207\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 Rossum5fdeeea1994-01-02 01:22:07 +0000209\end{funcdesc}
210
Guido van Rossum781db5d1994-08-05 13:37:36 +0000211\begin{funcdesc}{gethostname}{}
Guido van Rossum16d6e711994-08-08 12:30:22 +0000212Return a string containing the hostname of the machine where
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000213the Python interpreter is currently executing.
214If you want to know the current machine's IP address, you may want to use
215\code{gethostbyname(gethostname())}.
216This operation assumes that there is a valid address-to-host mapping for
217the host, and the assumption does not always hold.
Fred Draked883ca11998-03-10 05:20:33 +0000218Note: \function{gethostname()} doesn't always return the fully qualified
219domain name; use \code{gethostbyaddr(gethostname())}
Guido van Rossumfe27a501997-01-11 17:04:56 +0000220(see below).
Guido van Rossum31cce971995-01-04 19:17:34 +0000221\end{funcdesc}
222
223\begin{funcdesc}{gethostbyaddr}{ip_address}
Fred Draked883ca11998-03-10 05:20:33 +0000224Return a triple \code{(\var{hostname}, \var{aliaslist},
225\var{ipaddrlist})} where \var{hostname} is the primary host name
226responding 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öwisc9908c42001-08-04 22:22:45 +0000228and \var{ipaddrlist} is a list of IPv4/v6 addresses for the same interface
Fred Draked883ca11998-03-10 05:20:33 +0000229on the same host (most likely containing only a single address).
Fred Drake5772c862000-08-16 14:21:42 +0000230To find the fully qualified domain name, use the function
231\function{getfqdn()}.
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000232\function{gethostbyaddr} supports both IPv4 and IPv6.
233\end{funcdesc}
234
235\begin{funcdesc}{getnameinfo}{sockaddr, flags}
236Translate a socket address \var{sockaddr} into a 2-tuple
237\code{(\var{host}, \var{port})}.
238Depending on the settings of \var{flags}, the result can contain a
239fully-qualified domain name or numeric address representation in
240\var{host}. Similarly, \var{port} can contain a string port name or a
241numeric port number.
242\versionadded{2.2}
Guido van Rossum781db5d1994-08-05 13:37:36 +0000243\end{funcdesc}
244
Guido van Rossum62ac99e1996-12-19 16:43:25 +0000245\begin{funcdesc}{getprotobyname}{protocolname}
Fred Drake318c0b11999-04-21 17:29:14 +0000246Translate an Internet protocol name (e.g.\ \code{'icmp'}) to a constant
Guido van Rossum62ac99e1996-12-19 16:43:25 +0000247suitable for passing as the (optional) third argument to the
Fred Draked883ca11998-03-10 05:20:33 +0000248\function{socket()} function. This is usually only needed for sockets
249opened in ``raw'' mode (\constant{SOCK_RAW}); for the normal socket
250modes, the correct protocol is chosen automatically if the protocol is
Guido van Rossum62ac99e1996-12-19 16:43:25 +0000251omitted or zero.
252\end{funcdesc}
253
Fred Draked883ca11998-03-10 05:20:33 +0000254\begin{funcdesc}{getservbyname}{servicename, protocolname}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000255Translate an Internet service name and protocol name to a port number
256for that service. The protocol name should be \code{'tcp'} or
257\code{'udp'}.
258\end{funcdesc}
259
Fred Draked883ca11998-03-10 05:20:33 +0000260\begin{funcdesc}{socket}{family, type\optional{, proto}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000261Create a new socket using the given address family, socket type and
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000262protocol number. The address family should be \constant{AF_INET}, \constant{AF_INET6} or
Fred Draked883ca11998-03-10 05:20:33 +0000263\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 Rossum5fdeeea1994-01-02 01:22:07 +0000265The protocol number is usually zero and may be omitted in that case.
266\end{funcdesc}
267
Jeremy Hyltoncb43c082001-10-11 16:17:22 +0000268\begin{funcdesc}{ssl}{sock\optional{, keyfile, certfile}}
Fred Drake9081bb12001-09-25 15:48:11 +0000269Initiate a SSL connection over the socket \var{sock}. \var{keyfile} is
270the name of a PEM formatted file that contains your private
271key. \var{certfile} is a PEM formatted certificate chain file. On
272success, a new \class{SSLObject} is returned.
273
274\strong{Warning:} This does not do any certificate verification!
275\end{funcdesc}
276
Fred Draked883ca11998-03-10 05:20:33 +0000277\begin{funcdesc}{fromfd}{fd, family, type\optional{, proto}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000278Build a socket object from an existing file descriptor (an integer as
Fred Draked883ca11998-03-10 05:20:33 +0000279returned by a file object's \method{fileno()} method). Address family,
Fred Drake318c0b11999-04-21 17:29:14 +0000280socket type and protocol number are as for the \function{socket()} function
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000281above. The file descriptor should refer to a socket, but this is not
282checked --- subsequent operations on the object may fail if the file
283descriptor is invalid. This function is rarely needed, but can be
284used to get or set socket options on a socket passed to a program as
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000285standard input or output (e.g.\ a server started by the \UNIX{} inet
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000286daemon).
287\end{funcdesc}
288
Guido van Rossumbda7ca71996-12-02 17:24:10 +0000289\begin{funcdesc}{ntohl}{x}
Fred Drakec5aec051997-12-08 21:25:41 +0000290Convert 32-bit integers from network to host byte order. On machines
291where the host byte order is the same as network byte order, this is a
292no-op; otherwise, it performs a 4-byte swap operation.
293\end{funcdesc}
294
295\begin{funcdesc}{ntohs}{x}
296Convert 16-bit integers from network to host byte order. On machines
297where the host byte order is the same as network byte order, this is a
298no-op; otherwise, it performs a 2-byte swap operation.
299\end{funcdesc}
300
301\begin{funcdesc}{htonl}{x}
302Convert 32-bit integers from host to network byte order. On machines
303where the host byte order is the same as network byte order, this is a
304no-op; otherwise, it performs a 4-byte swap operation.
305\end{funcdesc}
306
307\begin{funcdesc}{htons}{x}
308Convert 16-bit integers from host to network byte order. On machines
309where the host byte order is the same as network byte order, this is a
310no-op; otherwise, it performs a 2-byte swap operation.
Guido van Rossumbda7ca71996-12-02 17:24:10 +0000311\end{funcdesc}
312
Fred Drakee6fb1c41999-09-16 15:50:00 +0000313\begin{funcdesc}{inet_aton}{ip_string}
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000314Convert an IPv4 address from dotted-quad string format
Fred Drakee6fb1c41999-09-16 15:50:00 +0000315(e.g.\ '123.45.67.89') to 32-bit packed binary format, as a string four
316characters in length.
317
318Useful when conversing with a program that uses the standard C library
319and needs objects of type \ctype{struct in_addr}, which is the C type
320for the 32-bit packed binary this function returns.
321
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000322If the IPv4 address string passed to this function is invalid,
Fred Drakee6fb1c41999-09-16 15:50:00 +0000323\exception{socket.error} will be raised. Note that exactly what is
324valid depends on the underlying C implementation of
325\cfunction{inet_aton()}.
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000326
327\function{inet_aton} does not support IPv6, and
328\function{getnameinfo()} should be used instead for IPv4/v6 dual stack support.
Fred Drakee6fb1c41999-09-16 15:50:00 +0000329\end{funcdesc}
330
331\begin{funcdesc}{inet_ntoa}{packed_ip}
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000332Convert a 32-bit packed IPv4 address (a string four characters in
Fred Drakee6fb1c41999-09-16 15:50:00 +0000333length) to its standard dotted-quad string representation
334(e.g. '123.45.67.89').
335
336Useful when conversing with a program that uses the standard C library
337and needs objects of type \ctype{struct in_addr}, which is the C type
338for the 32-bit packed binary this function takes as an argument.
339
340If the string passed to this function is not exactly 4 bytes in
341length, \exception{socket.error} will be raised.
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000342
343\function{inet_ntoa} does not support IPv6, and
344\function{getnameinfo()} should be used instead for IPv4/v6 dual stack support.
Fred Drakee6fb1c41999-09-16 15:50:00 +0000345\end{funcdesc}
346
Fred Drake5451d671997-10-13 21:31:02 +0000347\begin{datadesc}{SocketType}
Guido van Rossum2335c5e1997-05-21 14:41:42 +0000348This is a Python type object that represents the socket object type.
Fred Draked883ca11998-03-10 05:20:33 +0000349It is the same as \code{type(socket(...))}.
Guido van Rossum2335c5e1997-05-21 14:41:42 +0000350\end{datadesc}
351
Fred Drakeaa7524c2000-07-06 18:37:08 +0000352
353\begin{seealso}
354 \seemodule{SocketServer}{Classes that simplify writing network servers.}
355\end{seealso}
356
357
Fred Drakea94f6761999-08-05 13:41:04 +0000358\subsection{Socket Objects \label{socket-objects}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000359
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000360Socket objects have the following methods. Except for
Fred Draked883ca11998-03-10 05:20:33 +0000361\method{makefile()} these correspond to \UNIX{} system calls
362applicable to sockets.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000363
Fred Drake3f1c4721998-04-03 07:04:45 +0000364\begin{methoddesc}[socket]{accept}{}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000365Accept a connection.
366The socket must be bound to an address and listening for connections.
367The return value is a pair \code{(\var{conn}, \var{address})}
368where \var{conn} is a \emph{new} socket object usable to send and
369receive data on the connection, and \var{address} is the address bound
370to the socket on the other end of the connection.
Fred Drake3f1c4721998-04-03 07:04:45 +0000371\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000372
Fred Drake3f1c4721998-04-03 07:04:45 +0000373\begin{methoddesc}[socket]{bind}{address}
Guido van Rossuma84ec511994-06-23 12:13:52 +0000374Bind the socket to \var{address}. The socket must not already be bound.
Fred Drake7d686902000-04-04 17:48:30 +0000375(The format of \var{address} depends on the address family --- see
376above.) \strong{Note:} This method has historically accepted a pair
377of parameters for \constant{AF_INET} addresses instead of only a
Eric S. Raymond83210262001-01-10 19:34:52 +0000378tuple. This was never intentional and is no longer be available in
379Python 2.0.
Fred Drake3f1c4721998-04-03 07:04:45 +0000380\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000381
Fred Drake3f1c4721998-04-03 07:04:45 +0000382\begin{methoddesc}[socket]{close}{}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000383Close the socket. All future operations on the socket object will fail.
384The remote end will receive no more data (after queued data is flushed).
385Sockets are automatically closed when they are garbage-collected.
Fred Drake3f1c4721998-04-03 07:04:45 +0000386\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000387
Fred Drake3f1c4721998-04-03 07:04:45 +0000388\begin{methoddesc}[socket]{connect}{address}
Guido van Rossuma84ec511994-06-23 12:13:52 +0000389Connect to a remote socket at \var{address}.
Fred Draked883ca11998-03-10 05:20:33 +0000390(The format of \var{address} depends on the address family --- see
Fred Drake7d686902000-04-04 17:48:30 +0000391above.) \strong{Note:} This method has historically accepted a pair
392of parameters for \constant{AF_INET} addresses instead of only a
Eric S. Raymond83210262001-01-10 19:34:52 +0000393tuple. This was never intentional and is no longer available in
394Python 2.0 and later.
Fred Drake3f1c4721998-04-03 07:04:45 +0000395\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000396
Fred Drake3f1c4721998-04-03 07:04:45 +0000397\begin{methoddesc}[socket]{connect_ex}{address}
Guido van Rossumeefcba61997-12-09 19:47:24 +0000398Like \code{connect(\var{address})}, but return an error indicator
Fred Drakeb0bc7f21999-05-06 22:03:50 +0000399instead of raising an exception for errors returned by the C-level
400\cfunction{connect()} call (other problems, such as ``host not found,''
401can still raise exceptions). The error indicator is \code{0} if the
Fred Draked883ca11998-03-10 05:20:33 +0000402operation succeeded, otherwise the value of the \cdata{errno}
Fred Drake3f1c4721998-04-03 07:04:45 +0000403variable. This is useful, e.g., for asynchronous connects.
Fred Drake7d686902000-04-04 17:48:30 +0000404\strong{Note:} This method has historically accepted a pair of
405parameters for \constant{AF_INET} addresses instead of only a tuple.
Eric S. Raymond83210262001-01-10 19:34:52 +0000406This was never intentional and is no longer be available in Python
4072.0 and later.
Fred Drake3f1c4721998-04-03 07:04:45 +0000408\end{methoddesc}
Guido van Rossumf7790c61997-11-18 15:29:20 +0000409
Fred Drake3f1c4721998-04-03 07:04:45 +0000410\begin{methoddesc}[socket]{fileno}{}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000411Return the socket's file descriptor (a small integer). This is useful
Fred Draked883ca11998-03-10 05:20:33 +0000412with \function{select.select()}.
Fred Drake3f1c4721998-04-03 07:04:45 +0000413\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000414
Fred Drake3f1c4721998-04-03 07:04:45 +0000415\begin{methoddesc}[socket]{getpeername}{}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000416Return the remote address to which the socket is connected. This is
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000417useful to find out the port number of a remote IPv4/v6 socket, for instance.
Guido van Rossum86751151995-02-28 17:14:32 +0000418(The format of the address returned depends on the address family ---
Guido van Rossum781db5d1994-08-05 13:37:36 +0000419see above.) On some systems this function is not supported.
Fred Drake3f1c4721998-04-03 07:04:45 +0000420\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000421
Fred Drake3f1c4721998-04-03 07:04:45 +0000422\begin{methoddesc}[socket]{getsockname}{}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000423Return the socket's own address. This is useful to find out the port
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000424number of an IPv4/v6 socket, for instance.
Guido van Rossum86751151995-02-28 17:14:32 +0000425(The format of the address returned depends on the address family ---
Guido van Rossuma84ec511994-06-23 12:13:52 +0000426see above.)
Fred Drake3f1c4721998-04-03 07:04:45 +0000427\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000428
Fred Drake3f1c4721998-04-03 07:04:45 +0000429\begin{methoddesc}[socket]{getsockopt}{level, optname\optional{, buflen}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000430Return the value of the given socket option (see the \UNIX{} man page
Fred Draked883ca11998-03-10 05:20:33 +0000431\manpage{getsockopt}{2}). The needed symbolic constants
432(\constant{SO_*} etc.) are defined in this module. If \var{buflen}
Guido van Rossum470be141995-03-17 16:07:09 +0000433is absent, an integer option is assumed and its integer value
Guido van Rossum8df36371995-02-27 17:52:15 +0000434is returned by the function. If \var{buflen} is present, it specifies
435the maximum length of the buffer used to receive the option in, and
Guido van Rossum470be141995-03-17 16:07:09 +0000436this buffer is returned as a string. It is up to the caller to decode
Guido van Rossum8df36371995-02-27 17:52:15 +0000437the contents of the buffer (see the optional built-in module
Fred Drake318c0b11999-04-21 17:29:14 +0000438\refmodule{struct} for a way to decode C structures encoded as strings).
Fred Drake3f1c4721998-04-03 07:04:45 +0000439\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000440
Fred Drake3f1c4721998-04-03 07:04:45 +0000441\begin{methoddesc}[socket]{listen}{backlog}
Guido van Rossum470be141995-03-17 16:07:09 +0000442Listen for connections made to the socket. The \var{backlog} argument
443specifies the maximum number of queued connections and should be at
444least 1; the maximum value is system-dependent (usually 5).
Fred Drake3f1c4721998-04-03 07:04:45 +0000445\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000446
Fred Drake3f1c4721998-04-03 07:04:45 +0000447\begin{methoddesc}[socket]{makefile}{\optional{mode\optional{, bufsize}}}
Guido van Rossum470be141995-03-17 16:07:09 +0000448Return a \dfn{file object} associated with the socket. (File objects
Fred Drakea94f6761999-08-05 13:41:04 +0000449are described in \ref{bltin-file-objects}, ``File Objects.'')
Fred Draked883ca11998-03-10 05:20:33 +0000450The file object references a \cfunction{dup()}ped version of the
451socket file descriptor, so the file object and socket object may be
Fred Drakea94f6761999-08-05 13:41:04 +0000452closed or garbage-collected independently.
453\index{I/O control!buffering}The optional \var{mode}
Fred Draked883ca11998-03-10 05:20:33 +0000454and \var{bufsize} arguments are interpreted the same way as by the
Fred Drakeaad8bb52001-10-19 17:22:29 +0000455built-in \function{file()} function; see ``Built-in Functions''
456(section \ref{built-in-funcs}) for more information.
Fred Drake3f1c4721998-04-03 07:04:45 +0000457\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000458
Fred Drake3f1c4721998-04-03 07:04:45 +0000459\begin{methoddesc}[socket]{recv}{bufsize\optional{, flags}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000460Receive data from the socket. The return value is a string representing
461the data received. The maximum amount of data to be received
462at once is specified by \var{bufsize}. See the \UNIX{} manual page
Fred Draked883ca11998-03-10 05:20:33 +0000463\manpage{recv}{2} for the meaning of the optional argument
464\var{flags}; it defaults to zero.
Fred Drake3f1c4721998-04-03 07:04:45 +0000465\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000466
Fred Drake3f1c4721998-04-03 07:04:45 +0000467\begin{methoddesc}[socket]{recvfrom}{bufsize\optional{, flags}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000468Receive data from the socket. The return value is a pair
469\code{(\var{string}, \var{address})} where \var{string} is a string
470representing the data received and \var{address} is the address of the
Guido van Rossum470be141995-03-17 16:07:09 +0000471socket sending the data. The optional \var{flags} argument has the
Fred Draked883ca11998-03-10 05:20:33 +0000472same meaning as for \method{recv()} above.
Guido van Rossum86751151995-02-28 17:14:32 +0000473(The format of \var{address} depends on the address family --- see above.)
Fred Drake3f1c4721998-04-03 07:04:45 +0000474\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000475
Fred Drake3f1c4721998-04-03 07:04:45 +0000476\begin{methoddesc}[socket]{send}{string\optional{, flags}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000477Send data to the socket. The socket must be connected to a remote
Guido van Rossum470be141995-03-17 16:07:09 +0000478socket. The optional \var{flags} argument has the same meaning as for
Fred Draked883ca11998-03-10 05:20:33 +0000479\method{recv()} above. Returns the number of bytes sent.
Fred Drake3f1c4721998-04-03 07:04:45 +0000480\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000481
Fred Drake3f1c4721998-04-03 07:04:45 +0000482\begin{methoddesc}[socket]{sendto}{string\optional{, flags}, address}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000483Send data to the socket. The socket should not be connected to a
484remote socket, since the destination socket is specified by
Fred Draked883ca11998-03-10 05:20:33 +0000485\var{address}. The optional \var{flags} argument has the same
486meaning as for \method{recv()} above. Return the number of bytes sent.
Guido van Rossum86751151995-02-28 17:14:32 +0000487(The format of \var{address} depends on the address family --- see above.)
Fred Drake3f1c4721998-04-03 07:04:45 +0000488\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000489
Fred Drake3f1c4721998-04-03 07:04:45 +0000490\begin{methoddesc}[socket]{setblocking}{flag}
Guido van Rossum91951481994-09-07 14:39:14 +0000491Set blocking or non-blocking mode of the socket: if \var{flag} is 0,
492the socket is set to non-blocking, else to blocking mode. Initially
493all sockets are in blocking mode. In non-blocking mode, if a
Fred Drake318c0b11999-04-21 17:29:14 +0000494\method{recv()} call doesn't find any data, or if a
495\method{send()} call can't immediately dispose of the data, a
496\exception{error} exception is raised; in blocking mode, the calls
497block until they can proceed.
Fred Drake3f1c4721998-04-03 07:04:45 +0000498\end{methoddesc}
Guido van Rossum91951481994-09-07 14:39:14 +0000499
Fred Drake3f1c4721998-04-03 07:04:45 +0000500\begin{methoddesc}[socket]{setsockopt}{level, optname, value}
Fred Drake9a748aa2000-06-30 04:21:41 +0000501Set the value of the given socket option (see the \UNIX{} manual page
Fred Draked883ca11998-03-10 05:20:33 +0000502\manpage{setsockopt}{2}). The needed symbolic constants are defined in
503the \module{socket} module (\code{SO_*} etc.). The value can be an
Guido van Rossum8df36371995-02-27 17:52:15 +0000504integer or a string representing a buffer. In the latter case it is
505up to the caller to ensure that the string contains the proper bits
506(see the optional built-in module
Fred Drake318c0b11999-04-21 17:29:14 +0000507\refmodule{struct}\refbimodindex{struct} for a way to encode C
508structures as strings).
Fred Drake3f1c4721998-04-03 07:04:45 +0000509\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000510
Fred Drake3f1c4721998-04-03 07:04:45 +0000511\begin{methoddesc}[socket]{shutdown}{how}
Fred Draked883ca11998-03-10 05:20:33 +0000512Shut down one or both halves of the connection. If \var{how} is
513\code{0}, further receives are disallowed. If \var{how} is \code{1},
514further sends are disallowed. If \var{how} is \code{2}, further sends
515and receives are disallowed.
Fred Drake3f1c4721998-04-03 07:04:45 +0000516\end{methoddesc}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000517
Fred Draked883ca11998-03-10 05:20:33 +0000518Note that there are no methods \method{read()} or \method{write()};
519use \method{recv()} and \method{send()} without \var{flags} argument
520instead.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000521
Fred Drakeaa7524c2000-07-06 18:37:08 +0000522
Fred Drake9081bb12001-09-25 15:48:11 +0000523\subsection{SSL Objects \label{ssl-objects}}
524
525SSL objects have the following methods.
526
527\begin{methoddesc}{write}{s}
528Writes the string \var{s} to the on the object's SSL connection.
529The return value is the number of bytes written.
530\end{methoddesc}
531
532\begin{methoddesc}{read}{\optional{n}}
533If \var{n} is provided, read \var{n} bytes from the SSL connection, otherwise
534read until EOF. The return value is a string of the bytes read.
535\end{methoddesc}
536
Fred Drakeaa7524c2000-07-06 18:37:08 +0000537\subsection{Example \label{socket-example}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000538
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000539Here are four minimal example programs using the TCP/IP protocol:\ a
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000540server that echoes all data that it receives back (servicing only one
541client), and a client using it. Note that a server must perform the
Fred Draked883ca11998-03-10 05:20:33 +0000542sequence \function{socket()}, \method{bind()}, \method{listen()},
543\method{accept()} (possibly repeating the \method{accept()} to service
544more than one client), while a client only needs the sequence
545\function{socket()}, \method{connect()}. Also note that the server
546does not \method{send()}/\method{recv()} on the
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000547socket it is listening on but on the new socket returned by
Fred Draked883ca11998-03-10 05:20:33 +0000548\method{accept()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000549
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000550The first two examples support IPv4 only.
551
Fred Drake19479911998-02-13 06:58:54 +0000552\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000553# Echo server program
Fred Drakeef52f602000-10-10 20:36:29 +0000554import socket
555
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000556HOST = '' # Symbolic name meaning the local host
Fred Drakeef52f602000-10-10 20:36:29 +0000557PORT = 50007 # Arbitrary non-privileged port
558s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Fred Drake3d69c0e2000-05-03 19:40:32 +0000559s.bind((HOST, PORT))
Guido van Rossum5da57551994-03-02 10:52:16 +0000560s.listen(1)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000561conn, addr = s.accept()
562print 'Connected by', addr
563while 1:
564 data = conn.recv(1024)
565 if not data: break
566 conn.send(data)
567conn.close()
Fred Drake19479911998-02-13 06:58:54 +0000568\end{verbatim}
Fred Draked883ca11998-03-10 05:20:33 +0000569
Fred Drake19479911998-02-13 06:58:54 +0000570\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000571# Echo client program
Fred Drakeef52f602000-10-10 20:36:29 +0000572import socket
573
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000574HOST = 'daring.cwi.nl' # The remote host
575PORT = 50007 # The same port as used by the server
Fred Drakeef52f602000-10-10 20:36:29 +0000576s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Fred Drake3d69c0e2000-05-03 19:40:32 +0000577s.connect((HOST, PORT))
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000578s.send('Hello, world')
579data = s.recv(1024)
580s.close()
581print 'Received', `data`
Fred Drake19479911998-02-13 06:58:54 +0000582\end{verbatim}
Martin v. Löwisc9908c42001-08-04 22:22:45 +0000583
584The next two examples are identical to the above two, but support both
585IPv4 and IPv6.
586The server side will listen to the first address family available
587(it should listen to both instead).
588On most of IPv6-ready systems, IPv6 will take precedence
589and the server may not accept IPv4 traffic.
590The client side will try to connect to the all addresses returned as a result
591of the name resolution, and sends traffic to the first one connected
592successfully.
593
594\begin{verbatim}
595# Echo server program
596import socket
597import sys
598
599HOST = '' # Symbolic name meaning the local host
600PORT = 50007 # Arbitrary non-privileged port
601s = None
602for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
603 af, socktype, proto, canonname, sa = res
604 try:
605 s = socket.socket(af, socktype, proto)
606 except socket.error, msg:
607 s = None
608 continue
609 try:
610 s.bind(sa)
611 s.listen(1)
612 except socket.error, msg:
613 s.close()
614 s = None
615 continue
616 break
617if s is None:
618 print 'could not open socket'
619 sys.exit(1)
620conn, addr = s.accept()
621print 'Connected by', addr
622while 1:
623 data = conn.recv(1024)
624 if not data: break
625 conn.send(data)
626conn.close()
627\end{verbatim}
628
629\begin{verbatim}
630# Echo client program
631import socket
632import sys
633
634HOST = 'daring.cwi.nl' # The remote host
635PORT = 50007 # The same port as used by the server
636s = None
637for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
638 af, socktype, proto, canonname, sa = res
639 try:
640 s = socket.socket(af, socktype, proto)
641 except socket.error, msg:
642 s = None
643 continue
644 try:
645 s.connect(sa)
646 except socket.error, msg:
647 s.close()
648 s = None
649 continue
650 break
651if s is None:
652 print 'could not open socket'
653 sys.exit(1)
654s.send('Hello, world')
655data = s.recv(1024)
656s.close()
657print 'Received', `data`
658\end{verbatim}