Mercurial > cpython-lru_cache-weakref

annotate Doc/libmactcp.tex @ 4566:6403c94de50d legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added safeguard against failure in __del__.
author Guido van Rossum <guido@python.org>
date Wed, 27 Nov 1996 19:39:58 +0000
parents b916d614e363
children 3468ea8645ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
1 \section{Built-in Module \sectcode{mactcp}}
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
2 \bimodindex{mactcp}
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
3
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
4 \renewcommand{\indexsubitem}{(in module mactcp)}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
5
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
6 This module provides an interface to the Macintosh TCP/IP driver
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
7 MacTCP\@. There is an accompanying module \code{macdnr} which provides an
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
8 interface to the name-server (allowing you to translate hostnames to
3758
b916d614e363 changes by Jack to Mac docs
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
9 ip-addresses), a module \code{MACTCPconst} which has symbolic names for
b916d614e363 changes by Jack to Mac docs
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
10 constants constants used by MacTCP. Since the builtin module
b916d614e363 changes by Jack to Mac docs
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
11 \code{socket} is also available on the mac it is usually easier to use
b916d614e363 changes by Jack to Mac docs
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
12 sockets in stead of the mac-specific MacTCP API.
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
13
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
14 A complete description of the MacTCP interface can be found in the
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
15 Apple MacTCP API documentation.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
16
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
17 \begin{funcdesc}{MTU}{}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
18 Return the Maximum Transmit Unit (the packet size) of the network
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
19 interface.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
20 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
21
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
22 \begin{funcdesc}{IPAddr}{}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
23 Return the 32-bit integer IP address of the network interface.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
24 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
25
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
26 \begin{funcdesc}{NetMask}{}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
27 Return the 32-bit integer network mask of the interface.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
28 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
29
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
30 \begin{funcdesc}{TCPCreate}{size}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
31 Create a TCP Stream object. \var{size} is the size of the receive
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
32 buffer, \code{4096} is suggested by various sources.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
33 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
34
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
35 \begin{funcdesc}{UDPCreate}{size, port}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
36 Create a UDP stream object. \var{size} is the size of the receive
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
37 buffer (and, hence, the size of the biggest datagram you can receive
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
38 on this port). \var{port} is the UDP port number you want to receive
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
39 datagrams on, a value of zero will make MacTCP select a free port.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
40 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
41
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
42 \subsection{TCP Stream Objects}
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
43
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
44 \renewcommand{\indexsubitem}{(TCP stream attribute)}
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
45
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
46 \begin{datadesc}{asr}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
47 When set to a value different than \code{None} this should point to a
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
48 function with two integer parameters:\ an event code and a detail. This
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
49 function will be called upon network-generated events such as urgent
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
50 data arrival. In addition, it is called with eventcode
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
51 \code{MACTCP.PassiveOpenDone} when a \code{PassiveOpen} completes. This
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
52 is a Python addition to the MacTCP semantics.
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
53 It is safe to do further calls from the \code{asr}.
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
54 \end{datadesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
55
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
56 \renewcommand{\indexsubitem}{(TCP stream method)}
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
57
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
58 \begin{funcdesc}{PassiveOpen}{port}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
59 Wait for an incoming connection on TCP port \var{port} (zero makes the
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
60 system pick a free port). The call returns immediately, and you should
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
61 use \var{wait} to wait for completion. You should not issue any method
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
62 calls other than
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
63 \code{wait}, \code{isdone} or \code{GetSockName} before the call
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
64 completes.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
65 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
66
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
67 \begin{funcdesc}{wait}{}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
68 Wait for \code{PassiveOpen} to complete.
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
69 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
70
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
71 \begin{funcdesc}{isdone}{}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
72 Return 1 if a \code{PassiveOpen} has completed.
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
73 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
74
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
75 \begin{funcdesc}{GetSockName}{}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
76 Return the TCP address of this side of a connection as a 2-tuple
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
77 \code{(host, port)}, both integers.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
78 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
79
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
80 \begin{funcdesc}{ActiveOpen}{lport\, host\, rport}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
81 Open an outgoing connection to TCP address \code{(\var{host}, \var{rport})}. Use
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
82 local port \var{lport} (zero makes the system pick a free port). This
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
83 call blocks until the connection has been established.
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
84 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
85
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
86 \begin{funcdesc}{Send}{buf\, push\, urgent}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
87 Send data \var{buf} over the connection. \var{Push} and \var{urgent}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
88 are flags as specified by the TCP standard.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
89 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
90
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
91 \begin{funcdesc}{Rcv}{timeout}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
92 Receive data. The call returns when \var{timeout} seconds have passed
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
93 or when (according to the MacTCP documentation) ``a reasonable amount
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
94 of data has been received''. The return value is a 3-tuple
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
95 \code{(\var{data}, \var{urgent}, \var{mark})}. If urgent data is outstanding \code{Rcv}
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
96 will always return that before looking at any normal data. The first
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
97 call returning urgent data will have the \var{urgent} flag set, the
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
98 last will have the \var{mark} flag set.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
99 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
100
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
101 \begin{funcdesc}{Close}{}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
102 Tell MacTCP that no more data will be transmitted on this
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
103 connection. The call returns when all data has been acknowledged by
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
104 the receiving side.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
105 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
106
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
107 \begin{funcdesc}{Abort}{}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
108 Forcibly close both sides of a connection, ignoring outstanding data.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
109 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
110
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
111 \begin{funcdesc}{Status}{}
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
112 Return a TCP status object for this stream giving the current status
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
113 (see below).
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
114 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
115
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
116 \subsection{TCP Status Objects}
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
117 This object has no methods, only some members holding information on
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
118 the connection. A complete description of all fields in this objects
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
119 can be found in the Apple documentation. The most interesting ones are:
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
120
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
121 \renewcommand{\indexsubitem}{(TCP status attribute)}
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
122
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
123 \begin{datadesc}{localHost}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
124 \dataline{localPort}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
125 \dataline{remoteHost}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
126 \dataline{remotePort}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
127 The integer IP-addresses and port numbers of both endpoints of the
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
128 connection.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
129 \end{datadesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
130
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
131 \begin{datadesc}{sendWindow}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
132 The current window size.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
133 \end{datadesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
134
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
135 \begin{datadesc}{amtUnackedData}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
136 The number of bytes sent but not yet acknowledged. \code{sendWindow -
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
137 amtUnackedData} is what you can pass to \code{Send} without blocking.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
138 \end{datadesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
139
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
140 \begin{datadesc}{amtUnreadData}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
141 The number of bytes received but not yet read (what you can \code{Recv}
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
142 without blocking).
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
143 \end{datadesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
144
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
145
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
146
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
147 \subsection{UDP Stream Objects}
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
148 Note that, unlike the name suggests, there is nothing stream-like
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
149 about UDP.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
150
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
151 \renewcommand{\indexsubitem}{(UDP stream attribute)}
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
152
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
153 \begin{datadesc}{asr}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
154 The asynchronous service routine to be called on events such as
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
155 datagram arrival without outstanding \code{Read} call. The \code{asr} has a
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
156 single argument, the event code.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
157 \end{datadesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
158
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
159 \begin{datadesc}{port}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
160 A read-only member giving the port number of this UDP stream.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
161 \end{datadesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
162
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
163 \renewcommand{\indexsubitem}{(UDP stream method)}
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
164
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
165 \begin{funcdesc}{Read}{timeout}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 2461
diff changeset
166 Read a datagram, waiting at most \var{timeout} seconds ($-1$ is
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2527
diff changeset
167 infinite). Return the data.
2461
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
168 \end{funcdesc}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
169
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
170 \begin{funcdesc}{Write}{host\, port\, buf}
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
171 Send \var{buf} as a datagram to IP-address \var{host}, port
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
172 \var{port}.
d94045bd4a04 Half the mactcp documentation (macdnr still to come)
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
173 \end{funcdesc}