Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libsocket.tex @ 28646:193b8aec00ce legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Changes from Jonathan Riehl to allow his pgen extension (PEP 269) to work. This includes some more code that used to be part of pgen in the main parser; I'm okay with that. I'll see if the Windows build needs work next.
author Guido van Rossum <guido@python.org>
date Thu, 17 Apr 2003 14:55:42 +0000
parents 02ce22830ab9
children 57e61588571b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8880
diff changeset
1 \section{\module{socket} ---
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
2 Low-level networking interface}
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
3
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
4 \declaremodule{builtin}{socket}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
5 \modulesynopsis{Low-level networking interface.}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
6
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
7096
5bb884527446 Consistency: "{\bf ...}" ==> "\strong{...}"
Fred Drake <fdrake@acm.org>
parents: 6804
diff changeset
8 This module provides access to the BSD \emph{socket} interface.
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11463
diff changeset
9 It is available on all modern \UNIX{} systems, Windows, MacOS, BeOS,
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11463
diff changeset
10 OS/2, and probably additional platforms.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
11
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 For an introduction to socket programming (in C), see the following
11463
17e12305973e Use \citetitle and \programopt as appropriate.
Fred Drake <fdrake@acm.org>
parents: 11291
diff changeset
13 papers: \citetitle{An Introductory 4.3BSD Interprocess Communication
17e12305973e Use \citetitle and \programopt as appropriate.
Fred Drake <fdrake@acm.org>
parents: 11291
diff changeset
14 Tutorial}, by Stuart Sechrest and \citetitle{An Advanced 4.3BSD
17e12305973e Use \citetitle and \programopt as appropriate.
Fred Drake <fdrake@acm.org>
parents: 11291
diff changeset
15 Interprocess Communication Tutorial}, by Samuel J. Leffler et al,
17e12305973e Use \citetitle and \programopt as appropriate.
Fred Drake <fdrake@acm.org>
parents: 11291
diff changeset
16 both in the \citetitle{\UNIX{} Programmer's Manual, Supplementary Documents 1}
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11463
diff changeset
17 (sections PS1:7 and PS1:8). The platform-specific reference material
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11463
diff changeset
18 for the various socket-related system calls are also a valuable source
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11463
diff changeset
19 of information on the details of socket semantics. For \UNIX, refer
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11463
diff changeset
20 to the manual pages; for Windows, see the WinSock (or Winsock 2)
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11463
diff changeset
21 specification.
20127
697206e74763 Fix some markup errors.
Fred Drake <fdrake@acm.org>
parents: 20082
diff changeset
22 For IPv6-ready APIs, readers may want to refer to \rfc{2553} titled
697206e74763 Fix some markup errors.
Fred Drake <fdrake@acm.org>
parents: 20082
diff changeset
23 \citetitle{Basic Socket Interface Extensions for IPv6}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
24
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 The Python interface is a straightforward transliteration of the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 \UNIX{} system call and library interface for sockets to Python's
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
27 object-oriented style: the \function{socket()} function returns a
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
28 \dfn{socket object}\obindex{socket} whose methods implement the
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
29 various socket system calls. Parameter types are somewhat
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
30 higher-level than in the C interface: as with \method{read()} and
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
31 \method{write()} operations on Python files, buffer allocation on
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
32 receive operations is automatic, and buffer length is implicit on send
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
33 operations.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
34
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
35 Socket addresses are represented as follows:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
36 A single string is used for the \constant{AF_UNIX} address family.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
37 A pair \code{(\var{host}, \var{port})} is used for the
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
38 \constant{AF_INET} address family, where \var{host} is a string
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
39 representing either a hostname in Internet domain notation like
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
40 \code{'daring.cwi.nl'} or an IPv4 address like \code{'100.50.200.5'},
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
41 and \var{port} is an integral port number.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
42 For \constant{AF_INET6} address family, a four-tuple
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
43 \code{(\var{host}, \var{port}, \var{flowinfo}, \var{scopeid})} is
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
44 used, where \var{flowinfo} and \var{scopeid} represents
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
45 \code{sin6_flowinfo} and \code{sin6_scope_id} member in
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
46 \constant{struct sockaddr_in6} in C.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
47 For \module{socket} module methods, \var{flowinfo} and \var{scopeid}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
48 can be omitted just for backward compatibility. Note, however,
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
49 omission of \var{scopeid} can cause problems in manipulating scoped
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
50 IPv6 addresses. Other address families are currently not supported.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
51 The address format required by a particular socket object is
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
52 automatically selected based on the address family specified when the
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
53 socket object was created.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
54
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
55 For IPv4 addresses, two special forms are accepted instead of a host
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
56 address: the empty string represents \constant{INADDR_ANY}, and the string
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
57 \code{'<broadcast>'} represents \constant{INADDR_BROADCAST}.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
58 The behavior is not available for IPv6 for backward compatibility,
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
59 therefore, you may want to avoid these if you intend to support IPv6 with
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
60 your Python programs.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
61
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
62 If you use a hostname in the \var{host} portion of IPv4/v6 socket
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
63 address, the program may show a nondeterministic behavior, as Python
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
64 uses the first address returned from the DNS resolution. The socket
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
65 address will be resolved differently into an actual IPv4/v6 address,
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
66 depending on the results from DNS resolution and/or the host
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
67 configuration. For deterministic behavior use a numeric address in
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
68 \var{host} portion.
5461
0ded63bcf5de Document "" and "<broadcast>".
Guido van Rossum <guido@python.org>
parents: 4929
diff changeset
69
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
70 All errors raise exceptions. The normal exceptions for invalid
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 argument types and out-of-memory conditions can be raised; errors
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
72 related to socket or address semantics raise the error
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
73 \exception{socket.error}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
74
23815
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
75 Non-blocking mode is supported through
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
76 \method{setblocking()}. A generalization of this based on timeouts
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
77 is supported through \method{settimeout()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
78
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
79 The module \module{socket} exports the following constants and functions:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
80
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
81
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 \begin{excdesc}{error}
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
83 This exception is raised for socket-related errors.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 The accompanying value is either a string telling what went wrong or a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
85 pair \code{(\var{errno}, \var{string})}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
86 representing an error returned by a system
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
87 call, similar to the value accompanying \exception{os.error}.
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
88 See the module \refmodule{errno}\refbimodindex{errno}, which contains
7200
98a9da520f1d Add ref to errno module, and change ref to posix.error to os.error.
Guido van Rossum <guido@python.org>
parents: 7135
diff changeset
89 names for the error codes defined by the underlying operating system.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 \end{excdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
91
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
92 \begin{excdesc}{herror}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
93 This exception is raised for address-related errors, i.e. for
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
94 functions that use \var{h_errno} in the C API, including
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
95 \function{gethostbyname_ex()} and \function{gethostbyaddr()}.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
96
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
97 The accompanying value is a pair \code{(\var{h_errno}, \var{string})}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
98 representing an error returned by a library call. \var{string}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
99 represents the description of \var{h_errno}, as returned by
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
100 the \cfunction{hstrerror()} C function.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
101 \end{excdesc}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
102
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
103 \begin{excdesc}{gaierror}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
104 This exception is raised for address-related errors, for
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
105 \function{getaddrinfo()} and \function{getnameinfo()}.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
106 The accompanying value is a pair \code{(\var{error}, \var{string})}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
107 representing an error returned by a library call.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
108 \var{string} represents the description of \var{error}, as returned
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
109 by the \cfunction{gai_strerror()} C function.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
110 \end{excdesc}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
111
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
112 \begin{datadesc}{AF_UNIX}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 \dataline{AF_INET}
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
114 \dataline{AF_INET6}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
115 These constants represent the address (and protocol) families,
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
116 used for the first argument to \function{socket()}. If the
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
117 \constant{AF_UNIX} constant is not defined then this protocol is
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
118 unsupported.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
119 \end{datadesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
120
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
121 \begin{datadesc}{SOCK_STREAM}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
122 \dataline{SOCK_DGRAM}
1759
4d421f9e8373 * Doc/libsocket.tex (subsection{Socket Object Methods}):
Guido van Rossum <guido@python.org>
parents: 1750
diff changeset
123 \dataline{SOCK_RAW}
4d421f9e8373 * Doc/libsocket.tex (subsection{Socket Object Methods}):
Guido van Rossum <guido@python.org>
parents: 1750
diff changeset
124 \dataline{SOCK_RDM}
4d421f9e8373 * Doc/libsocket.tex (subsection{Socket Object Methods}):
Guido van Rossum <guido@python.org>
parents: 1750
diff changeset
125 \dataline{SOCK_SEQPACKET}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
126 These constants represent the socket types,
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
127 used for the second argument to \function{socket()}.
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
128 (Only \constant{SOCK_STREAM} and
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
129 \constant{SOCK_DGRAM} appear to be generally useful.)
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 \end{datadesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
131
2354
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
132 \begin{datadesc}{SO_*}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
133 \dataline{SOMAXCONN}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
134 \dataline{MSG_*}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
135 \dataline{SOL_*}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
136 \dataline{IPPROTO_*}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
137 \dataline{IPPORT_*}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
138 \dataline{INADDR_*}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
139 \dataline{IP_*}
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
140 \dataline{IPV6_*}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
141 \dataline{EAI_*}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
142 \dataline{AI_*}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
143 \dataline{NI_*}
21528
ac3ce1faec68 Fix the erroneous availability annotation for s.makefile() from the last
Fred Drake <fdrake@acm.org>
parents: 21521
diff changeset
144 \dataline{TCP_*}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
145 Many constants of these forms, documented in the \UNIX{} documentation on
2354
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
146 sockets and/or the IP protocol, are also defined in the socket module.
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
147 They are generally used in arguments to the \method{setsockopt()} and
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
148 \method{getsockopt()} methods of socket objects. In most cases, only
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2453
diff changeset
149 those symbols that are defined in the \UNIX{} header files are defined;
2354
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
150 for a few symbols, default values are provided.
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
151 \end{datadesc}
fbaf54169711 added lots of constants
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
152
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
153 \begin{funcdesc}{getaddrinfo}{host, port\optional{, family, socktype, proto, flags}}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
154
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
155 Resolves the \var{host}/\var{port} argument, into a sequence of
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
156 5-tuples that contain all the necessary argument for the sockets
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
157 manipulation. \var{host} is a domain name, a string representation of
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
158 IPv4/v6 address or \code{None}.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
159 \var{port} is a string service name (like \code{``http''}), a numeric
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
160 port number or \code{None}.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
161
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
162 The rest of the arguments are optional and must be numeric if
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
163 specified. For \var{host} and \var{port}, by passing either an empty
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
164 string or \code{None}, you can pass \code{NULL} to the C API. The
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
165 \function{getaddrinfo()} function returns a list of 5-tuples with
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
166 the following structure:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
167
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
168 \code{(\var{family}, \var{socktype}, \var{proto}, \var{canonname}, \var{sockaddr})}.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
169
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
170 \var{family}, \var{socktype}, \var{proto} are all integer and are meant to
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
171 be passed to the \function{socket()} function.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
172 \var{canonname} is a string representing the canonical name of the \var{host}.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
173 It can be a numeric IPv4/v6 address when \code{AI_CANONNAME} is specified
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
174 for a numeric \var{host}.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
175 \var{sockaddr} is a tuple describing a socket address, as described above.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
176 See \code{Lib/httplib.py} and other library files
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
177 for a typical usage of the function.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
178 \versionadded{2.2}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
179 \end{funcdesc}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
180
14010
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
181 \begin{funcdesc}{getfqdn}{\optional{name}}
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
182 Return a fully qualified domain name for \var{name}.
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
183 If \var{name} is omitted or empty, it is interpreted as the local
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
184 host. To find the fully qualified name, the hostname returned by
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
185 \function{gethostbyaddr()} is checked, then aliases for the host, if
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
186 available. The first name which includes a period is selected. In
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
187 case no fully qualified domain name is available, the hostname is
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
188 returned.
14437
e348ed946d1f Added a \versionadded statement to the getfqdn() description.
Fred Drake <fdrake@acm.org>
parents: 14010
diff changeset
189 \versionadded{2.0}
14010
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
190 \end{funcdesc}
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
191
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
192 \begin{funcdesc}{gethostbyname}{hostname}
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
193 Translate a host name to IPv4 address format. The IPv4 address is
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
194 returned as a string, such as \code{'100.50.200.5'}. If the host name
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
195 is an IPv4 address itself it is returned unchanged. See
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
196 \function{gethostbyname_ex()} for a more complete interface.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
197 \function{gethostbyname()} does not support IPv6 name resolution, and
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
198 \function{getaddrinfo()} should be used instead for IPv4/v6 dual stack support.
8880
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
199 \end{funcdesc}
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
200
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
201 \begin{funcdesc}{gethostbyname_ex}{hostname}
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
202 Translate a host name to IPv4 address format, extended interface.
8880
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
203 Return a triple \code{(hostname, aliaslist, ipaddrlist)} where
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
204 \code{hostname} is the primary host name responding to the given
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
205 \var{ip_address}, \code{aliaslist} is a (possibly empty) list of
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
206 alternative host names for the same address, and \code{ipaddrlist} is
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
207 a list of IPv4 addresses for the same interface on the same
8880
a9eb265d2f57 Document gethostbyname_ex().
Guido van Rossum <guido@python.org>
parents: 8716
diff changeset
208 host (often but not always a single address).
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
209 \function{gethostbyname_ex()} does not support IPv6 name resolution, and
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
210 \function{getaddrinfo()} should be used instead for IPv4/v6 dual stack support.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
211 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
212
1759
4d421f9e8373 * Doc/libsocket.tex (subsection{Socket Object Methods}):
Guido van Rossum <guido@python.org>
parents: 1750
diff changeset
213 \begin{funcdesc}{gethostname}{}
1767
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
Guido van Rossum <guido@python.org>
parents: 1759
diff changeset
214 Return a string containing the hostname of the machine where
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
215 the Python interpreter is currently executing.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
216 If you want to know the current machine's IP address, you may want to use
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
217 \code{gethostbyname(gethostname())}.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
218 This operation assumes that there is a valid address-to-host mapping for
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
219 the host, and the assumption does not always hold.
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
220 Note: \function{gethostname()} doesn't always return the fully qualified
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
221 domain name; use \code{gethostbyaddr(gethostname())}
4929
5126d4b819e9 Added warning that gethostname() doesn't always return fqdn, and show
Guido van Rossum <guido@python.org>
parents: 4882
diff changeset
222 (see below).
2064
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1871
diff changeset
223 \end{funcdesc}
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1871
diff changeset
224
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1871
diff changeset
225 \begin{funcdesc}{gethostbyaddr}{ip_address}
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
226 Return a triple \code{(\var{hostname}, \var{aliaslist},
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
227 \var{ipaddrlist})} where \var{hostname} is the primary host name
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
228 responding to the given \var{ip_address}, \var{aliaslist} is a
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
229 (possibly empty) list of alternative host names for the same address,
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
230 and \var{ipaddrlist} is a list of IPv4/v6 addresses for the same interface
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
231 on the same host (most likely containing only a single address).
14010
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
232 To find the fully qualified domain name, use the function
49c7a4dd9f61 Document socket.getfqdn().
Fred Drake <fdrake@acm.org>
parents: 14002
diff changeset
233 \function{getfqdn()}.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
234 \function{gethostbyaddr} supports both IPv4 and IPv6.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
235 \end{funcdesc}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
236
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
237 \begin{funcdesc}{getnameinfo}{sockaddr, flags}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
238 Translate a socket address \var{sockaddr} into a 2-tuple
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
239 \code{(\var{host}, \var{port})}.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
240 Depending on the settings of \var{flags}, the result can contain a
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
241 fully-qualified domain name or numeric address representation in
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
242 \var{host}. Similarly, \var{port} can contain a string port name or a
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
243 numeric port number.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
244 \versionadded{2.2}
1759
4d421f9e8373 * Doc/libsocket.tex (subsection{Socket Object Methods}):
Guido van Rossum <guido@python.org>
parents: 1750
diff changeset
245 \end{funcdesc}
4d421f9e8373 * Doc/libsocket.tex (subsection{Socket Object Methods}):
Guido van Rossum <guido@python.org>
parents: 1750
diff changeset
246
4784
e43362910a5e Documented getprotobyname() interface.
Guido van Rossum <guido@python.org>
parents: 4576
diff changeset
247 \begin{funcdesc}{getprotobyname}{protocolname}
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
248 Translate an Internet protocol name (for example, \code{'icmp'}) to a constant
4784
e43362910a5e Documented getprotobyname() interface.
Guido van Rossum <guido@python.org>
parents: 4576
diff changeset
249 suitable for passing as the (optional) third argument to the
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
250 \function{socket()} function. This is usually only needed for sockets
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
251 opened in ``raw'' mode (\constant{SOCK_RAW}); for the normal socket
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
252 modes, the correct protocol is chosen automatically if the protocol is
4784
e43362910a5e Documented getprotobyname() interface.
Guido van Rossum <guido@python.org>
parents: 4576
diff changeset
253 omitted or zero.
e43362910a5e Documented getprotobyname() interface.
Guido van Rossum <guido@python.org>
parents: 4576
diff changeset
254 \end{funcdesc}
e43362910a5e Documented getprotobyname() interface.
Guido van Rossum <guido@python.org>
parents: 4576
diff changeset
255
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
256 \begin{funcdesc}{getservbyname}{servicename, protocolname}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
257 Translate an Internet service name and protocol name to a port number
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
258 for that service. The protocol name should be \code{'tcp'} or
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
259 \code{'udp'}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
260 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
261
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
262 \begin{funcdesc}{socket}{family, type\optional{, proto}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
263 Create a new socket using the given address family, socket type and
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
264 protocol number. The address family should be \constant{AF_INET}, \constant{AF_INET6} or
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
265 \constant{AF_UNIX}. The socket type should be \constant{SOCK_STREAM},
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
266 \constant{SOCK_DGRAM} or perhaps one of the other \samp{SOCK_} constants.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
267 The protocol number is usually zero and may be omitted in that case.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
268 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
269
20375
3ab3b535daf2 Document that keyfile and certfile are now optional.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 20127
diff changeset
270 \begin{funcdesc}{ssl}{sock\optional{, keyfile, certfile}}
20082
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
271 Initiate a SSL connection over the socket \var{sock}. \var{keyfile} is
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
272 the name of a PEM formatted file that contains your private
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
273 key. \var{certfile} is a PEM formatted certificate chain file. On
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
274 success, a new \class{SSLObject} is returned.
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
275
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 20574
diff changeset
276 \warning{This does not do any certificate verification!}
20082
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
277 \end{funcdesc}
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
278
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
279 \begin{funcdesc}{fromfd}{fd, family, type\optional{, proto}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
280 Build a socket object from an existing file descriptor (an integer as
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
281 returned by a file object's \method{fileno()} method). Address family,
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
282 socket type and protocol number are as for the \function{socket()} function
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 above. The file descriptor should refer to a socket, but this is not
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
284 checked --- subsequent operations on the object may fail if the file
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
285 descriptor is invalid. This function is rarely needed, but can be
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
286 used to get or set socket options on a socket passed to a program as
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
287 standard input or output (such as a server started by the \UNIX{} inet
23815
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
288 daemon). The socket is assumed to be in blocking mode.
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
289 Availability: \UNIX.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
290 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
291
4576
c3b0895c90fb Added [nh]to[hn][sl]().
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
292 \begin{funcdesc}{ntohl}{x}
6783
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
293 Convert 32-bit integers from network to host byte order. On machines
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
294 where the host byte order is the same as network byte order, this is a
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
295 no-op; otherwise, it performs a 4-byte swap operation.
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
296 \end{funcdesc}
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
297
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
298 \begin{funcdesc}{ntohs}{x}
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
299 Convert 16-bit integers from network to host byte order. On machines
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
300 where the host byte order is the same as network byte order, this is a
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
301 no-op; otherwise, it performs a 2-byte swap operation.
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
302 \end{funcdesc}
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
303
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
304 \begin{funcdesc}{htonl}{x}
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
305 Convert 32-bit integers from host to network byte order. On machines
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
306 where the host byte order is the same as network byte order, this is a
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
307 no-op; otherwise, it performs a 4-byte swap operation.
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
308 \end{funcdesc}
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
309
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
310 \begin{funcdesc}{htons}{x}
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
311 Convert 16-bit integers from host to network byte order. On machines
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
312 where the host byte order is the same as network byte order, this is a
c18501770895 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
Fred Drake <fdrake@acm.org>
parents: 6587
diff changeset
313 no-op; otherwise, it performs a 2-byte swap operation.
4576
c3b0895c90fb Added [nh]to[hn][sl]().
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
314 \end{funcdesc}
c3b0895c90fb Added [nh]to[hn][sl]().
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
315
11291
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
316 \begin{funcdesc}{inet_aton}{ip_string}
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
317 Convert an IPv4 address from dotted-quad string format (for example,
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
318 '123.45.67.89') to 32-bit packed binary format, as a string four
11291
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
319 characters in length.
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
320
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
321 Useful when conversing with a program that uses the standard C library
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
322 and needs objects of type \ctype{struct in_addr}, which is the C type
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
323 for the 32-bit packed binary this function returns.
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
324
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
325 If the IPv4 address string passed to this function is invalid,
11291
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
326 \exception{socket.error} will be raised. Note that exactly what is
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
327 valid depends on the underlying C implementation of
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
328 \cfunction{inet_aton()}.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
329
21528
ac3ce1faec68 Fix the erroneous availability annotation for s.makefile() from the last
Fred Drake <fdrake@acm.org>
parents: 21521
diff changeset
330 \function{inet_aton()} does not support IPv6, and
ac3ce1faec68 Fix the erroneous availability annotation for s.makefile() from the last
Fred Drake <fdrake@acm.org>
parents: 21521
diff changeset
331 \function{getnameinfo()} should be used instead for IPv4/v6 dual stack
ac3ce1faec68 Fix the erroneous availability annotation for s.makefile() from the last
Fred Drake <fdrake@acm.org>
parents: 21521
diff changeset
332 support.
11291
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
333 \end{funcdesc}
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
334
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
335 \begin{funcdesc}{inet_ntoa}{packed_ip}
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
336 Convert a 32-bit packed IPv4 address (a string four characters in
11291
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
337 length) to its standard dotted-quad string representation
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
338 (for example, '123.45.67.89').
11291
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
339
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
340 Useful when conversing with a program that uses the standard C library
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
341 and needs objects of type \ctype{struct in_addr}, which is the C type
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
342 for the 32-bit packed binary this function takes as an argument.
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
343
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
344 If the string passed to this function is not exactly 4 bytes in
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
345 length, \exception{socket.error} will be raised.
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
346
21528
ac3ce1faec68 Fix the erroneous availability annotation for s.makefile() from the last
Fred Drake <fdrake@acm.org>
parents: 21521
diff changeset
347 \function{inet_ntoa()} does not support IPv6, and
ac3ce1faec68 Fix the erroneous availability annotation for s.makefile() from the last
Fred Drake <fdrake@acm.org>
parents: 21521
diff changeset
348 \function{getnameinfo()} should be used instead for IPv4/v6 dual stack
ac3ce1faec68 Fix the erroneous availability annotation for s.makefile() from the last
Fred Drake <fdrake@acm.org>
parents: 21521
diff changeset
349 support.
11291
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
350 \end{funcdesc}
d970af0cece9 Added documentation for inet_aton() and inet_ntoa(), from Ben
Fred Drake <fdrake@acm.org>
parents: 11178
diff changeset
351
28330
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
352 \begin{funcdesc}{getdefaulttimeout}{}
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
353 Return the default timeout in floating seconds for new socket objects.
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
354 A value of \code{None} indicates that new socket objects have no timeout.
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
355 When the socket module is first imported, the default is \code{None}.
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
356 \versionadded{2.3}
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
357 \end{funcdesc}
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
358
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
359 \begin{funcdesc}{setdefaulttimeout}{timeout}
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
360 Set the default timeout in floating seconds for new socket objects.
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
361 A value of \code{None} indicates that new socket objects have no timeout.
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
362 When the socket module is first imported, the default is \code{None}.
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
363 \versionadded{2.3}
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
364 \end{funcdesc}
02ce22830ab9 add descriptions of {get,set}defaulttimeout.
Skip Montanaro <skip@pobox.com>
parents: 23815
diff changeset
365
6482
d311b68754c1 socket_type ==> SocketType
Fred Drake <fdrake@acm.org>
parents: 5818
diff changeset
366 \begin{datadesc}{SocketType}
5574
84d7cc5e63cd Added description of socket_type.
Guido van Rossum <guido@python.org>
parents: 5461
diff changeset
367 This is a Python type object that represents the socket object type.
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
368 It is the same as \code{type(socket(...))}.
5574
84d7cc5e63cd Added description of socket_type.
Guido van Rossum <guido@python.org>
parents: 5461
diff changeset
369 \end{datadesc}
84d7cc5e63cd Added description of socket_type.
Guido van Rossum <guido@python.org>
parents: 5461
diff changeset
370
13386
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
371
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
372 \begin{seealso}
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
373 \seemodule{SocketServer}{Classes that simplify writing network servers.}
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
374 \end{seealso}
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
375
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
376
11178
245d2b605036 Add index entry "I/O control, buffering" for makefile().
Fred Drake <fdrake@acm.org>
parents: 10836
diff changeset
377 \subsection{Socket Objects \label{socket-objects}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
378
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
379 Socket objects have the following methods. Except for
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
380 \method{makefile()} these correspond to \UNIX{} system calls
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
381 applicable to sockets.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
382
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
383 \begin{methoddesc}[socket]{accept}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
384 Accept a connection.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
385 The socket must be bound to an address and listening for connections.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
386 The return value is a pair \code{(\var{conn}, \var{address})}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
387 where \var{conn} is a \emph{new} socket object usable to send and
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
388 receive data on the connection, and \var{address} is the address bound
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
389 to the socket on the other end of the connection.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
390 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
391
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
392 \begin{methoddesc}[socket]{bind}{address}
1682
2bcddc905da0 clarify the meaning of address for those methods that or return addresses
Guido van Rossum <guido@python.org>
parents: 1567
diff changeset
393 Bind the socket to \var{address}. The socket must not already be bound.
12230
7bf8b10ce2ab Added notes about the eventual disappearance of two-parameter bind(),
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
394 (The format of \var{address} depends on the address family --- see
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 20574
diff changeset
395 above.) \note{This method has historically accepted a pair
12230
7bf8b10ce2ab Added notes about the eventual disappearance of two-parameter bind(),
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
396 of parameters for \constant{AF_INET} addresses instead of only a
15800
3a260274bcc6 SourceForge patch #103140, checked in at fdrake's invitation. Minor fixes and
Eric S. Raymond <esr@thyrsus.com>
parents: 15146
diff changeset
397 tuple. This was never intentional and is no longer be available in
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 20574
diff changeset
398 Python 2.0.}
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
399 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
400
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
401 \begin{methoddesc}[socket]{close}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
402 Close the socket. All future operations on the socket object will fail.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
403 The remote end will receive no more data (after queued data is flushed).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
404 Sockets are automatically closed when they are garbage-collected.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
405 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
406
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
407 \begin{methoddesc}[socket]{connect}{address}
1682
2bcddc905da0 clarify the meaning of address for those methods that or return addresses
Guido van Rossum <guido@python.org>
parents: 1567
diff changeset
408 Connect to a remote socket at \var{address}.
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
409 (The format of \var{address} depends on the address family --- see
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 20574
diff changeset
410 above.) \note{This method has historically accepted a pair
12230
7bf8b10ce2ab Added notes about the eventual disappearance of two-parameter bind(),
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
411 of parameters for \constant{AF_INET} addresses instead of only a
15800
3a260274bcc6 SourceForge patch #103140, checked in at fdrake's invitation. Minor fixes and
Eric S. Raymond <esr@thyrsus.com>
parents: 15146
diff changeset
412 tuple. This was never intentional and is no longer available in
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 20574
diff changeset
413 Python 2.0 and later.}
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
414 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
415
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
416 \begin{methoddesc}[socket]{connect_ex}{address}
6804
e224c41bdac6 Fix a little mess (Likecode{...} -> Like \code{...}) in recently added text.
Guido van Rossum <guido@python.org>
parents: 6783
diff changeset
417 Like \code{connect(\var{address})}, but return an error indicator
10836
efd1573a4b03 Updated connect_ex() documentation based on comments in the newgroup
Fred Drake <fdrake@acm.org>
parents: 10655
diff changeset
418 instead of raising an exception for errors returned by the C-level
efd1573a4b03 Updated connect_ex() documentation based on comments in the newgroup
Fred Drake <fdrake@acm.org>
parents: 10655
diff changeset
419 \cfunction{connect()} call (other problems, such as ``host not found,''
efd1573a4b03 Updated connect_ex() documentation based on comments in the newgroup
Fred Drake <fdrake@acm.org>
parents: 10655
diff changeset
420 can still raise exceptions). The error indicator is \code{0} if the
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
421 operation succeeded, otherwise the value of the \cdata{errno}
21521
e0a5d16a9cb9 Add notes that fromfd() and s.makefile() are Unix-specific.
Fred Drake <fdrake@acm.org>
parents: 21213
diff changeset
422 variable. This is useful to support, for example, asynchronous connects.
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 20574
diff changeset
423 \note{This method has historically accepted a pair of
12230
7bf8b10ce2ab Added notes about the eventual disappearance of two-parameter bind(),
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
424 parameters for \constant{AF_INET} addresses instead of only a tuple.
15800
3a260274bcc6 SourceForge patch #103140, checked in at fdrake's invitation. Minor fixes and
Eric S. Raymond <esr@thyrsus.com>
parents: 15146
diff changeset
425 This was never intentional and is no longer be available in Python
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 20574
diff changeset
426 2.0 and later.}
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
427 \end{methoddesc}
6587
e0e667bbc971 Document s.connect_ex(), which does not raise an exception on error.
Guido van Rossum <guido@python.org>
parents: 6482
diff changeset
428
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
429 \begin{methoddesc}[socket]{fileno}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
430 Return the socket's file descriptor (a small integer). This is useful
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
431 with \function{select.select()}.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
432 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
433
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
434 \begin{methoddesc}[socket]{getpeername}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
435 Return the remote address to which the socket is connected. This is
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
436 useful to find out the port number of a remote IPv4/v6 socket, for instance.
2453
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2447
diff changeset
437 (The format of the address returned depends on the address family ---
1759
4d421f9e8373 * Doc/libsocket.tex (subsection{Socket Object Methods}):
Guido van Rossum <guido@python.org>
parents: 1750
diff changeset
438 see above.) On some systems this function is not supported.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
439 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
440
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
441 \begin{methoddesc}[socket]{getsockname}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
442 Return the socket's own address. This is useful to find out the port
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
443 number of an IPv4/v6 socket, for instance.
2453
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2447
diff changeset
444 (The format of the address returned depends on the address family ---
1682
2bcddc905da0 clarify the meaning of address for those methods that or return addresses
Guido van Rossum <guido@python.org>
parents: 1567
diff changeset
445 see above.)
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
446 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
447
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
448 \begin{methoddesc}[socket]{getsockopt}{level, optname\optional{, buflen}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
449 Return the value of the given socket option (see the \UNIX{} man page
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
450 \manpage{getsockopt}{2}). The needed symbolic constants
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
451 (\constant{SO_*} etc.) are defined in this module. If \var{buflen}
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
452 is absent, an integer option is assumed and its integer value
2447
73499a667e78 changes refs to SO_* symbols
Guido van Rossum <guido@python.org>
parents: 2354
diff changeset
453 is returned by the function. If \var{buflen} is present, it specifies
73499a667e78 changes refs to SO_* symbols
Guido van Rossum <guido@python.org>
parents: 2354
diff changeset
454 the maximum length of the buffer used to receive the option in, and
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
455 this buffer is returned as a string. It is up to the caller to decode
2447
73499a667e78 changes refs to SO_* symbols
Guido van Rossum <guido@python.org>
parents: 2354
diff changeset
456 the contents of the buffer (see the optional built-in module
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
457 \refmodule{struct} for a way to decode C structures encoded as strings).
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
458 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
459
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
460 \begin{methoddesc}[socket]{listen}{backlog}
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
461 Listen for connections made to the socket. The \var{backlog} argument
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
462 specifies the maximum number of queued connections and should be at
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
463 least 1; the maximum value is system-dependent (usually 5).
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
464 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
465
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
466 \begin{methoddesc}[socket]{makefile}{\optional{mode\optional{, bufsize}}}
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
467 Return a \dfn{file object} associated with the socket. (File objects
11178
245d2b605036 Add index entry "I/O control, buffering" for makefile().
Fred Drake <fdrake@acm.org>
parents: 10836
diff changeset
468 are described in \ref{bltin-file-objects}, ``File Objects.'')
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
469 The file object references a \cfunction{dup()}ped version of the
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
470 socket file descriptor, so the file object and socket object may be
11178
245d2b605036 Add index entry "I/O control, buffering" for makefile().
Fred Drake <fdrake@acm.org>
parents: 10836
diff changeset
471 closed or garbage-collected independently.
23730
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
472 The socket should be in blocking mode.
11178
245d2b605036 Add index entry "I/O control, buffering" for makefile().
Fred Drake <fdrake@acm.org>
parents: 10836
diff changeset
473 \index{I/O control!buffering}The optional \var{mode}
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
474 and \var{bufsize} arguments are interpreted the same way as by the
20574
5af6c89c8cb7 When stating that some parameters to makefile() are similar to the open()
Fred Drake <fdrake@acm.org>
parents: 20375
diff changeset
475 built-in \function{file()} function; see ``Built-in Functions''
5af6c89c8cb7 When stating that some parameters to makefile() are similar to the open()
Fred Drake <fdrake@acm.org>
parents: 20375
diff changeset
476 (section \ref{built-in-funcs}) for more information.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
477 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
478
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
479 \begin{methoddesc}[socket]{recv}{bufsize\optional{, flags}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
480 Receive data from the socket. The return value is a string representing
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
481 the data received. The maximum amount of data to be received
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
482 at once is specified by \var{bufsize}. See the \UNIX{} manual page
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
483 \manpage{recv}{2} for the meaning of the optional argument
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
484 \var{flags}; it defaults to zero.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
485 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
486
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
487 \begin{methoddesc}[socket]{recvfrom}{bufsize\optional{, flags}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
488 Receive data from the socket. The return value is a pair
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
489 \code{(\var{string}, \var{address})} where \var{string} is a string
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
490 representing the data received and \var{address} is the address of the
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
491 socket sending the data. The optional \var{flags} argument has the
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
492 same meaning as for \method{recv()} above.
2453
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2447
diff changeset
493 (The format of \var{address} depends on the address family --- see above.)
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
494 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
495
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
496 \begin{methoddesc}[socket]{send}{string\optional{, flags}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
497 Send data to the socket. The socket must be connected to a remote
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
498 socket. The optional \var{flags} argument has the same meaning as for
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
499 \method{recv()} above. Returns the number of bytes sent.
21213
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
500 Applications are responsible for checking that all data has been sent;
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
501 if only some of the data was transmitted, the application needs to
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
502 attempt delivery of the remaining data.
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
503 \end{methoddesc}
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
504
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
505 \begin{methoddesc}[socket]{sendall}{string\optional{, flags}}
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
506 Send data to the socket. The socket must be connected to a remote
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
507 socket. The optional \var{flags} argument has the same meaning as for
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
508 \method{recv()} above. Unlike \method{send()}, this method continues
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
509 to send data from \var{string} until either all data has been sent or
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
510 an error occurs. \code{None} is returned on success. On error, an
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
511 exception is raised, and there is no way to determine how much data,
3b09ea723ece Added documentation of the sendall() method, and a note to the send() method
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
512 if any, was successfully sent.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
513 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
514
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
515 \begin{methoddesc}[socket]{sendto}{string\optional{, flags}, address}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
516 Send data to the socket. The socket should not be connected to a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
517 remote socket, since the destination socket is specified by
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
518 \var{address}. The optional \var{flags} argument has the same
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
519 meaning as for \method{recv()} above. Return the number of bytes sent.
2453
cdd3a721b40e a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents: 2447
diff changeset
520 (The format of \var{address} depends on the address family --- see above.)
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
521 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
522
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
523 \begin{methoddesc}[socket]{setblocking}{flag}
1871
10a12473ee93 added Tommy Burnette's setblocking() method
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
524 Set blocking or non-blocking mode of the socket: if \var{flag} is 0,
10a12473ee93 added Tommy Burnette's setblocking() method
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
525 the socket is set to non-blocking, else to blocking mode. Initially
10a12473ee93 added Tommy Burnette's setblocking() method
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
526 all sockets are in blocking mode. In non-blocking mode, if a
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
527 \method{recv()} call doesn't find any data, or if a
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
528 \method{send()} call can't immediately dispose of the data, a
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
529 \exception{error} exception is raised; in blocking mode, the calls
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
530 block until they can proceed.
23815
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
531 \code{s.setblocking(0)} is equivalent to \code{s.settimeout(0)};
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
532 \code{s.setblocking(1)} is equivalent to \code{s.settimeout(None)}.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
533 \end{methoddesc}
1871
10a12473ee93 added Tommy Burnette's setblocking() method
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
534
23717
77154cef29d1 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21528
diff changeset
535 \begin{methoddesc}[socket]{settimeout}{value}
23815
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
536 Set a timeout on blocking socket operations. The \var{value} argument
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
537 can be a nonnegative float expressing seconds, or \code{None}.
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
538 If a float is
23729
5f85cae25e18 Fix typo
Neal Norwitz <nnorwitz@gmail.com>
parents: 23728
diff changeset
539 given, subsequent socket operations will raise an \exception{error}
23728
5562a499fb7f Clarify the interaction between blocking and timeouts. Explain that
Guido van Rossum <guido@python.org>
parents: 23720
diff changeset
540 exception if the timeout period \var{value} has elapsed before the
5562a499fb7f Clarify the interaction between blocking and timeouts. Explain that
Guido van Rossum <guido@python.org>
parents: 23720
diff changeset
541 operation has completed. Setting a timeout of \code{None} disables
5562a499fb7f Clarify the interaction between blocking and timeouts. Explain that
Guido van Rossum <guido@python.org>
parents: 23720
diff changeset
542 timeouts on socket operations.
23815
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
543 \code{s.settimeout(0.0)} is equivalent to \code{s.blocking(0)};
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
544 \code{s.settimeout(None)} is equivalent to \code{s.setblocking(1)}.
23720
b062085c1ff2 Add version info, and fix another typo and wording spotted by /F. I think this is what he meant. :-)
Neal Norwitz <nnorwitz@gmail.com>
parents: 23719
diff changeset
545 \versionadded{2.3}
23717
77154cef29d1 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21528
diff changeset
546 \end{methoddesc}
77154cef29d1 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21528
diff changeset
547
77154cef29d1 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21528
diff changeset
548 \begin{methoddesc}[socket]{gettimeout}{}
23718
444954c5434c Fix some markup errors and adjust wording slightly.
Fred Drake <fdrake@acm.org>
parents: 23717
diff changeset
549 Returns the timeout in floating seconds associated with socket
23815
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
550 operations, or \code{None} if no timeout is set. This reflects
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
551 the last call to \method{setblocking()} or \method{settimeout()}.
23720
b062085c1ff2 Add version info, and fix another typo and wording spotted by /F. I think this is what he meant. :-)
Neal Norwitz <nnorwitz@gmail.com>
parents: 23719
diff changeset
552 \versionadded{2.3}
23717
77154cef29d1 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21528
diff changeset
553 \end{methoddesc}
77154cef29d1 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21528
diff changeset
554
23815
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
555 Some notes on socket blocking and timeouts: A socket object can be in
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
556 one of three modes: blocking, non-blocking, or timout. Sockets are
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
557 always created in blocking mode. In blocking mode, operations block
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
558 until complete. In non-blocking mode, operations fail (with an error
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
559 that is unfortunately system-dependent) if they cannot be completed
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
560 immediately. In timeout mode, operations fail if they cannot be
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
561 completed within the timeout specified for the socket. The
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
562 \method{setblocking()} method is simply a shorthand for certain
203d1412a7e8 Major overhaul of timeout sockets:
Guido van Rossum <guido@python.org>
parents: 23730
diff changeset
563 \method{settimeout()} calls.
23717
77154cef29d1 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21528
diff changeset
564
23730
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
565 Timeout mode internally sets the socket in non-blocking mode. The
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
566 blocking and timeout modes are shared between file descriptors and
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
567 socket objects that refer to the same network endpoint. A consequence
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
568 of this is that file objects returned by the \method{makefile()}
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
569 method should only be used when the socket is in blocking mode; in
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
570 timeout or non-blocking mode file operations that cannot be completed
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
571 immediately will fail.
af8d40e4c377 Clarify the interaction between timeout/non-blocking mode, makefile
Guido van Rossum <guido@python.org>
parents: 23729
diff changeset
572
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
573 \begin{methoddesc}[socket]{setsockopt}{level, optname, value}
13178
d37374552a15 Say "manual page", not "man page", when referring to the Unix manual.
Fred Drake <fdrake@acm.org>
parents: 12571
diff changeset
574 Set the value of the given socket option (see the \UNIX{} manual page
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
575 \manpage{setsockopt}{2}). The needed symbolic constants are defined in
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
576 the \module{socket} module (\code{SO_*} etc.). The value can be an
2447
73499a667e78 changes refs to SO_* symbols
Guido van Rossum <guido@python.org>
parents: 2354
diff changeset
577 integer or a string representing a buffer. In the latter case it is
73499a667e78 changes refs to SO_* symbols
Guido van Rossum <guido@python.org>
parents: 2354
diff changeset
578 up to the caller to ensure that the string contains the proper bits
73499a667e78 changes refs to SO_* symbols
Guido van Rossum <guido@python.org>
parents: 2354
diff changeset
579 (see the optional built-in module
10655
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
580 \refmodule{struct}\refbimodindex{struct} for a way to encode C
299bf53e6861 Logical markup nits.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
581 structures as strings).
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
582 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
583
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
584 \begin{methoddesc}[socket]{shutdown}{how}
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
585 Shut down one or both halves of the connection. If \var{how} is
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
586 \code{0}, further receives are disallowed. If \var{how} is \code{1},
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
587 further sends are disallowed. If \var{how} is \code{2}, further sends
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
588 and receives are disallowed.
7823
0575d5a17218 Use {methoddesc} as appropriate.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
589 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
590
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
591 Note that there are no methods \method{read()} or \method{write()};
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
592 use \method{recv()} and \method{send()} without \var{flags} argument
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
593 instead.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
594
13386
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
595
20082
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
596 \subsection{SSL Objects \label{ssl-objects}}
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
597
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
598 SSL objects have the following methods.
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
599
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
600 \begin{methoddesc}{write}{s}
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
601 Writes the string \var{s} to the on the object's SSL connection.
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
602 The return value is the number of bytes written.
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
603 \end{methoddesc}
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
604
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
605 \begin{methoddesc}{read}{\optional{n}}
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
606 If \var{n} is provided, read \var{n} bytes from the SSL connection, otherwise
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
607 read until EOF. The return value is a string of the bytes read.
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
608 \end{methoddesc}
18df32f6cea1 Added documentation for the SSL interface, contributed by Gerhard Häring.
Fred Drake <fdrake@acm.org>
parents: 18995
diff changeset
609
13386
3f08bedc1c26 Clean up markup to be more like recommended practice; only small changes
Fred Drake <fdrake@acm.org>
parents: 13178
diff changeset
610 \subsection{Example \label{socket-example}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
611
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
612 Here are four minimal example programs using the TCP/IP protocol:\ a
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
613 server that echoes all data that it receives back (servicing only one
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
614 client), and a client using it. Note that a server must perform the
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
615 sequence \function{socket()}, \method{bind()}, \method{listen()},
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
616 \method{accept()} (possibly repeating the \method{accept()} to service
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
617 more than one client), while a client only needs the sequence
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
618 \function{socket()}, \method{connect()}. Also note that the server
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
619 does not \method{send()}/\method{recv()} on the
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
620 socket it is listening on but on the new socket returned by
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
621 \method{accept()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
622
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
623 The first two examples support IPv4 only.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
624
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 7200
diff changeset
625 \begin{verbatim}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
626 # Echo server program
15146
5cf0a02a574b Revise the examples not to use the "from socket import *", and adjust
Fred Drake <fdrake@acm.org>
parents: 14437
diff changeset
627 import socket
5cf0a02a574b Revise the examples not to use the "from socket import *", and adjust
Fred Drake <fdrake@acm.org>
parents: 14437
diff changeset
628
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
629 HOST = '' # Symbolic name meaning the local host
15146
5cf0a02a574b Revise the examples not to use the "from socket import *", and adjust
Fred Drake <fdrake@acm.org>
parents: 14437
diff changeset
630 PORT = 50007 # Arbitrary non-privileged port
5cf0a02a574b Revise the examples not to use the "from socket import *", and adjust
Fred Drake <fdrake@acm.org>
parents: 14437
diff changeset
631 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
12571
8bcd14313c11 Someone found the examples of poor practice on socket addresses!
Fred Drake <fdrake@acm.org>
parents: 12230
diff changeset
632 s.bind((HOST, PORT))
1567
dddcba2038bc adapt to min value of 1 for listen() backlog argument
Guido van Rossum <guido@python.org>
parents: 1483
diff changeset
633 s.listen(1)
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
634 conn, addr = s.accept()
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
635 print 'Connected by', addr
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
636 while 1:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
637 data = conn.recv(1024)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
638 if not data: break
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
639 conn.send(data)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
640 conn.close()
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 7200
diff changeset
641 \end{verbatim}
7632
d22cf666fa2c Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
642
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 7200
diff changeset
643 \begin{verbatim}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
644 # Echo client program
15146
5cf0a02a574b Revise the examples not to use the "from socket import *", and adjust
Fred Drake <fdrake@acm.org>
parents: 14437
diff changeset
645 import socket
5cf0a02a574b Revise the examples not to use the "from socket import *", and adjust
Fred Drake <fdrake@acm.org>
parents: 14437
diff changeset
646
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
647 HOST = 'daring.cwi.nl' # The remote host
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
648 PORT = 50007 # The same port as used by the server
15146
5cf0a02a574b Revise the examples not to use the "from socket import *", and adjust
Fred Drake <fdrake@acm.org>
parents: 14437
diff changeset
649 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
12571
8bcd14313c11 Someone found the examples of poor practice on socket addresses!
Fred Drake <fdrake@acm.org>
parents: 12230
diff changeset
650 s.connect((HOST, PORT))
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
651 s.send('Hello, world')
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
652 data = s.recv(1024)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
653 s.close()
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
654 print 'Received', `data`
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 7200
diff changeset
655 \end{verbatim}
18995
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
656
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
657 The next two examples are identical to the above two, but support both
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
658 IPv4 and IPv6.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
659 The server side will listen to the first address family available
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
660 (it should listen to both instead).
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
661 On most of IPv6-ready systems, IPv6 will take precedence
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
662 and the server may not accept IPv4 traffic.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
663 The client side will try to connect to the all addresses returned as a result
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
664 of the name resolution, and sends traffic to the first one connected
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
665 successfully.
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
666
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
667 \begin{verbatim}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
668 # Echo server program
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
669 import socket
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
670 import sys
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
671
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
672 HOST = '' # Symbolic name meaning the local host
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
673 PORT = 50007 # Arbitrary non-privileged port
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
674 s = None
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
675 for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
676 af, socktype, proto, canonname, sa = res
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
677 try:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
678 s = socket.socket(af, socktype, proto)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
679 except socket.error, msg:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
680 s = None
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
681 continue
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
682 try:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
683 s.bind(sa)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
684 s.listen(1)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
685 except socket.error, msg:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
686 s.close()
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
687 s = None
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
688 continue
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
689 break
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
690 if s is None:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
691 print 'could not open socket'
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
692 sys.exit(1)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
693 conn, addr = s.accept()
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
694 print 'Connected by', addr
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
695 while 1:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
696 data = conn.recv(1024)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
697 if not data: break
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
698 conn.send(data)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
699 conn.close()
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
700 \end{verbatim}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
701
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
702 \begin{verbatim}
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
703 # Echo client program
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
704 import socket
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
705 import sys
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
706
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
707 HOST = 'daring.cwi.nl' # The remote host
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
708 PORT = 50007 # The same port as used by the server
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
709 s = None
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
710 for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
711 af, socktype, proto, canonname, sa = res
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
712 try:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
713 s = socket.socket(af, socktype, proto)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
714 except socket.error, msg:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
715 s = None
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
716 continue
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
717 try:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
718 s.connect(sa)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
719 except socket.error, msg:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
720 s.close()
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
721 s = None
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
722 continue
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
723 break
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
724 if s is None:
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
725 print 'could not open socket'
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
726 sys.exit(1)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
727 s.send('Hello, world')
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
728 data = s.recv(1024)
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
729 s.close()
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
730 print 'Received', `data`
805090ce328a Document IPv6 changes. Contributed by itojun.
Martin v. Löwis <martin@v.loewis.de>
parents: 15800
diff changeset
731 \end{verbatim}