Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 1 | # Wrapper module for _socket, providing some additional facilities |
| 2 | # implemented in Python. |
| 3 | |
| 4 | """\ |
| 5 | This module provides socket operations and some related functions. |
| 6 | On Unix, it supports IP (Internet Protocol) and Unix domain sockets. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 7 | On other systems, it only supports IP. Functions specific for a |
Martin v. Löwis | af484d5 | 2000-09-30 11:34:30 +0000 | [diff] [blame] | 8 | socket are available as methods of the socket object. |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 9 | |
| 10 | Functions: |
| 11 | |
| 12 | socket() -- create a new socket object |
Dave Cole | 331708b | 2004-08-09 04:51:41 +0000 | [diff] [blame] | 13 | socketpair() -- create a pair of new socket objects [*] |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 14 | fromfd() -- create a socket object from an open file descriptor [*] |
| 15 | gethostname() -- return the current hostname |
| 16 | gethostbyname() -- map a hostname to its IP number |
| 17 | gethostbyaddr() -- map an IP number or hostname to DNS info |
| 18 | getservbyname() -- map a service name and a protocol name to a port number |
Mark Dickinson | 5c91bf3 | 2009-06-02 07:41:26 +0000 | [diff] [blame] | 19 | getprotobyname() -- map a protocol name (e.g. 'tcp') to a number |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 20 | ntohs(), ntohl() -- convert 16, 32 bit int from network to host byte order |
| 21 | htons(), htonl() -- convert 16, 32 bit int from host to network byte order |
| 22 | inet_aton() -- convert IP addr string (123.45.67.89) to 32-bit packed format |
| 23 | inet_ntoa() -- convert 32-bit packed format IP to string (123.45.67.89) |
Guido van Rossum | 9d0c8ce | 2002-07-18 17:08:35 +0000 | [diff] [blame] | 24 | socket.getdefaulttimeout() -- get the default timeout value |
| 25 | socket.setdefaulttimeout() -- set the default timeout value |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 26 | create_connection() -- connects to an address, with an optional timeout and |
| 27 | optional source address. |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 28 | |
| 29 | [*] not available on all platforms! |
| 30 | |
| 31 | Special objects: |
| 32 | |
| 33 | SocketType -- type object for socket objects |
| 34 | error -- exception raised for I/O errors |
Guido van Rossum | 47dfa4a | 2003-04-25 05:48:32 +0000 | [diff] [blame] | 35 | has_ipv6 -- boolean value indicating if IPv6 is supported |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 36 | |
| 37 | Integer constants: |
| 38 | |
| 39 | AF_INET, AF_UNIX -- socket domains (first argument to socket() call) |
| 40 | SOCK_STREAM, SOCK_DGRAM, SOCK_RAW -- socket types (second argument) |
| 41 | |
| 42 | Many other constants may be defined; these may be used in calls to |
| 43 | the setsockopt() and getsockopt() methods. |
| 44 | """ |
| 45 | |
Tim Peters | 18e6778 | 2002-02-17 04:25:24 +0000 | [diff] [blame] | 46 | import _socket |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 47 | from _socket import * |
Tim Peters | 18e6778 | 2002-02-17 04:25:24 +0000 | [diff] [blame] | 48 | |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 49 | import os, sys, io |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 50 | |
Fred Drake | 70d566b | 2003-04-29 19:50:25 +0000 | [diff] [blame] | 51 | try: |
Gregory P. Smith | aafdca8 | 2010-01-04 04:50:36 +0000 | [diff] [blame] | 52 | import errno |
Fred Drake | 70d566b | 2003-04-29 19:50:25 +0000 | [diff] [blame] | 53 | except ImportError: |
Gregory P. Smith | aafdca8 | 2010-01-04 04:50:36 +0000 | [diff] [blame] | 54 | errno = None |
| 55 | EBADF = getattr(errno, 'EBADF', 9) |
| 56 | EINTR = getattr(errno, 'EINTR', 4) |
Antoine Pitrou | 98b4670 | 2010-09-18 22:59:00 +0000 | [diff] [blame] | 57 | EAGAIN = getattr(errno, 'EAGAIN', 11) |
| 58 | EWOULDBLOCK = getattr(errno, 'EWOULDBLOCK', 11) |
Fred Drake | 70d566b | 2003-04-29 19:50:25 +0000 | [diff] [blame] | 59 | |
Benjamin Peterson | ef3e4c2 | 2009-04-11 19:48:14 +0000 | [diff] [blame] | 60 | __all__ = ["getfqdn", "create_connection"] |
Skip Montanaro | 0de6580 | 2001-02-15 22:15:14 +0000 | [diff] [blame] | 61 | __all__.extend(os._get_exports_list(_socket)) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 62 | |
| 63 | |
| 64 | _realsocket = socket |
Skip Montanaro | 0de6580 | 2001-02-15 22:15:14 +0000 | [diff] [blame] | 65 | |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 66 | # WSA error codes |
| 67 | if sys.platform.lower().startswith("win"): |
| 68 | errorTab = {} |
| 69 | errorTab[10004] = "The operation was interrupted." |
| 70 | errorTab[10009] = "A bad file handle was passed." |
| 71 | errorTab[10013] = "Permission denied." |
| 72 | errorTab[10014] = "A fault occurred on the network??" # WSAEFAULT |
| 73 | errorTab[10022] = "An invalid operation was attempted." |
| 74 | errorTab[10035] = "The socket operation would block" |
| 75 | errorTab[10036] = "A blocking operation is already in progress." |
| 76 | errorTab[10048] = "The network address is in use." |
| 77 | errorTab[10054] = "The connection has been reset." |
| 78 | errorTab[10058] = "The network has been shut down." |
| 79 | errorTab[10060] = "The operation timed out." |
| 80 | errorTab[10061] = "Connection refused." |
| 81 | errorTab[10063] = "The name is too long." |
| 82 | errorTab[10064] = "The host is down." |
| 83 | errorTab[10065] = "The host is unreachable." |
Skip Montanaro | 64de1a4 | 2001-03-18 19:53:21 +0000 | [diff] [blame] | 84 | __all__.append("errorTab") |
Guido van Rossum | de7cade | 2002-08-08 15:25:28 +0000 | [diff] [blame] | 85 | |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 86 | |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 87 | class socket(_socket.socket): |
| 88 | |
| 89 | """A subclass of _socket.socket adding the makefile() method.""" |
| 90 | |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 91 | __slots__ = ["__weakref__", "_io_refs", "_closed"] |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 92 | |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 93 | def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None): |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 94 | _socket.socket.__init__(self, family, type, proto, fileno) |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 95 | self._io_refs = 0 |
| 96 | self._closed = False |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 97 | |
Giampaolo Rodolà | b383dbb | 2010-09-08 22:44:12 +0000 | [diff] [blame] | 98 | def __enter__(self): |
| 99 | return self |
| 100 | |
| 101 | def __exit__(self, *args): |
| 102 | if not self._closed: |
| 103 | self.close() |
| 104 | |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 105 | def __repr__(self): |
| 106 | """Wrap __repr__() to reveal the real class name.""" |
| 107 | s = _socket.socket.__repr__(self) |
| 108 | if s.startswith("<socket object"): |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 109 | s = "<%s.%s%s%s" % (self.__class__.__module__, |
| 110 | self.__class__.__name__, |
Antoine Pitrou | e033e06 | 2010-10-29 10:38:18 +0000 | [diff] [blame] | 111 | getattr(self, '_closed', False) and " [closed] " or "", |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 112 | s[7:]) |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 113 | return s |
| 114 | |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 115 | def dup(self): |
| 116 | """dup() -> socket object |
| 117 | |
| 118 | Return a new socket object connected to the same system resource. |
| 119 | """ |
| 120 | fd = dup(self.fileno()) |
| 121 | sock = self.__class__(self.family, self.type, self.proto, fileno=fd) |
| 122 | sock.settimeout(self.gettimeout()) |
| 123 | return sock |
| 124 | |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 125 | def accept(self): |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 126 | """accept() -> (socket object, address info) |
| 127 | |
| 128 | Wait for an incoming connection. Return a new socket |
| 129 | representing the connection, and the address of the client. |
| 130 | For IP sockets, the address info is a pair (hostaddr, port). |
| 131 | """ |
| 132 | fd, addr = self._accept() |
Antoine Pitrou | 600232b | 2011-01-05 21:03:42 +0000 | [diff] [blame] | 133 | sock = socket(self.family, self.type, self.proto, fileno=fd) |
| 134 | # Issue #7995: if no default timeout is set and the listening |
| 135 | # socket had a (non-zero) timeout, force the new socket in blocking |
| 136 | # mode to override platform-specific socket flags inheritance. |
| 137 | if getdefaulttimeout() is None and self.gettimeout(): |
| 138 | sock.setblocking(True) |
| 139 | return sock, addr |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 140 | |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 141 | def makefile(self, mode="r", buffering=None, *, |
Antoine Pitrou | 834bd81 | 2010-10-13 16:17:14 +0000 | [diff] [blame] | 142 | encoding=None, errors=None, newline=None): |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 143 | """makefile(...) -> an I/O stream connected to the socket |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 144 | |
| 145 | The arguments are as for io.open() after the filename, |
| 146 | except the only mode characters supported are 'r', 'w' and 'b'. |
| 147 | The semantics are similar too. (XXX refactor to share code?) |
| 148 | """ |
| 149 | for c in mode: |
| 150 | if c not in {"r", "w", "b"}: |
| 151 | raise ValueError("invalid mode %r (only r, w, b allowed)") |
| 152 | writing = "w" in mode |
| 153 | reading = "r" in mode or not writing |
| 154 | assert reading or writing |
| 155 | binary = "b" in mode |
| 156 | rawmode = "" |
| 157 | if reading: |
| 158 | rawmode += "r" |
| 159 | if writing: |
| 160 | rawmode += "w" |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 161 | raw = SocketIO(self, rawmode) |
| 162 | self._io_refs += 1 |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 163 | if buffering is None: |
| 164 | buffering = -1 |
| 165 | if buffering < 0: |
| 166 | buffering = io.DEFAULT_BUFFER_SIZE |
| 167 | if buffering == 0: |
| 168 | if not binary: |
| 169 | raise ValueError("unbuffered streams must be binary") |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 170 | return raw |
| 171 | if reading and writing: |
| 172 | buffer = io.BufferedRWPair(raw, raw, buffering) |
| 173 | elif reading: |
| 174 | buffer = io.BufferedReader(raw, buffering) |
| 175 | else: |
| 176 | assert writing |
| 177 | buffer = io.BufferedWriter(raw, buffering) |
| 178 | if binary: |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 179 | return buffer |
Antoine Pitrou | 834bd81 | 2010-10-13 16:17:14 +0000 | [diff] [blame] | 180 | text = io.TextIOWrapper(buffer, encoding, errors, newline) |
Guido van Rossum | 93adc5d | 2007-07-17 20:41:19 +0000 | [diff] [blame] | 181 | text.mode = mode |
Guido van Rossum | 7d0a826 | 2007-05-21 23:13:11 +0000 | [diff] [blame] | 182 | return text |
| 183 | |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 184 | def _decref_socketios(self): |
| 185 | if self._io_refs > 0: |
| 186 | self._io_refs -= 1 |
| 187 | if self._closed: |
| 188 | self.close() |
| 189 | |
Daniel Stutzbach | 19d6a4f | 2010-08-31 20:08:07 +0000 | [diff] [blame] | 190 | def _real_close(self, _ss=_socket.socket): |
Benjamin Peterson | 49203dc | 2010-08-31 20:10:55 +0000 | [diff] [blame] | 191 | # This function should not reference any globals. See issue #808164. |
Daniel Stutzbach | 19d6a4f | 2010-08-31 20:08:07 +0000 | [diff] [blame] | 192 | _ss.close(self) |
Bill Janssen | 54cc54c | 2007-12-14 22:08:56 +0000 | [diff] [blame] | 193 | |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 194 | def close(self): |
Benjamin Peterson | 49203dc | 2010-08-31 20:10:55 +0000 | [diff] [blame] | 195 | # This function should not reference any globals. See issue #808164. |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 196 | self._closed = True |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 197 | if self._io_refs <= 0: |
Bill Janssen | 54cc54c | 2007-12-14 22:08:56 +0000 | [diff] [blame] | 198 | self._real_close() |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 199 | |
Antoine Pitrou | 70deb3d | 2012-04-01 01:00:17 +0200 | [diff] [blame] | 200 | def detach(self): |
| 201 | """detach() -> file descriptor |
| 202 | |
| 203 | Close the socket object without closing the underlying file descriptor. |
| 204 | The object cannot be used after this call, but the file descriptor |
| 205 | can be reused for other purposes. The file descriptor is returned. |
| 206 | """ |
| 207 | self._closed = True |
| 208 | return super().detach() |
| 209 | |
| 210 | |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 211 | def fromfd(fd, family, type, proto=0): |
| 212 | """ fromfd(fd, family, type[, proto]) -> socket object |
| 213 | |
| 214 | Create a socket object from a duplicate of the given file |
| 215 | descriptor. The remaining arguments are the same as for socket(). |
| 216 | """ |
| 217 | nfd = dup(fd) |
| 218 | return socket(family, type, proto, nfd) |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 219 | |
| 220 | |
Antoine Pitrou | 9e0b864 | 2010-09-14 18:00:02 +0000 | [diff] [blame] | 221 | if hasattr(_socket, "socketpair"): |
| 222 | |
| 223 | def socketpair(family=None, type=SOCK_STREAM, proto=0): |
| 224 | """socketpair([family[, type[, proto]]]) -> (socket object, socket object) |
| 225 | |
| 226 | Create a pair of socket objects from the sockets returned by the platform |
| 227 | socketpair() function. |
| 228 | The arguments are the same as for socket() except the default family is |
| 229 | AF_UNIX if defined on the platform; otherwise, the default is AF_INET. |
| 230 | """ |
| 231 | if family is None: |
| 232 | try: |
| 233 | family = AF_UNIX |
| 234 | except NameError: |
| 235 | family = AF_INET |
| 236 | a, b = _socket.socketpair(family, type, proto) |
| 237 | a = socket(family, type, proto, a.detach()) |
| 238 | b = socket(family, type, proto, b.detach()) |
| 239 | return a, b |
| 240 | |
| 241 | |
Antoine Pitrou | 98b4670 | 2010-09-18 22:59:00 +0000 | [diff] [blame] | 242 | _blocking_errnos = { EAGAIN, EWOULDBLOCK } |
| 243 | |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 244 | class SocketIO(io.RawIOBase): |
| 245 | |
| 246 | """Raw I/O implementation for stream sockets. |
| 247 | |
| 248 | This class supports the makefile() method on sockets. It provides |
| 249 | the raw I/O interface on top of a socket object. |
| 250 | """ |
| 251 | |
Antoine Pitrou | 872b79d | 2010-09-15 08:39:25 +0000 | [diff] [blame] | 252 | # One might wonder why not let FileIO do the job instead. There are two |
| 253 | # main reasons why FileIO is not adapted: |
| 254 | # - it wouldn't work under Windows (where you can't used read() and |
| 255 | # write() on a socket handle) |
| 256 | # - it wouldn't work with socket timeouts (FileIO would ignore the |
| 257 | # timeout and consider the socket non-blocking) |
| 258 | |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 259 | # XXX More docs |
| 260 | |
Guido van Rossum | 86bc33c | 2007-11-14 22:32:02 +0000 | [diff] [blame] | 261 | def __init__(self, sock, mode): |
Benjamin Peterson | 44309e6 | 2008-11-22 00:41:45 +0000 | [diff] [blame] | 262 | if mode not in ("r", "w", "rw", "rb", "wb", "rwb"): |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 263 | raise ValueError("invalid mode: %r" % mode) |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 264 | io.RawIOBase.__init__(self) |
| 265 | self._sock = sock |
Benjamin Peterson | 44309e6 | 2008-11-22 00:41:45 +0000 | [diff] [blame] | 266 | if "b" not in mode: |
| 267 | mode += "b" |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 268 | self._mode = mode |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 269 | self._reading = "r" in mode |
| 270 | self._writing = "w" in mode |
Antoine Pitrou | 5d5381e | 2011-02-25 23:14:08 +0000 | [diff] [blame] | 271 | self._timeout_occurred = False |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 272 | |
| 273 | def readinto(self, b): |
Antoine Pitrou | 5aa0d10 | 2010-09-15 09:32:45 +0000 | [diff] [blame] | 274 | """Read up to len(b) bytes into the writable buffer *b* and return |
| 275 | the number of bytes read. If the socket is non-blocking and no bytes |
| 276 | are available, None is returned. |
| 277 | |
| 278 | If *b* is non-empty, a 0 return value indicates that the connection |
| 279 | was shutdown at the other end. |
| 280 | """ |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 281 | self._checkClosed() |
| 282 | self._checkReadable() |
Antoine Pitrou | 5d5381e | 2011-02-25 23:14:08 +0000 | [diff] [blame] | 283 | if self._timeout_occurred: |
| 284 | raise IOError("cannot read from timed out object") |
Gregory P. Smith | aafdca8 | 2010-01-04 04:50:36 +0000 | [diff] [blame] | 285 | while True: |
| 286 | try: |
| 287 | return self._sock.recv_into(b) |
Antoine Pitrou | 5d5381e | 2011-02-25 23:14:08 +0000 | [diff] [blame] | 288 | except timeout: |
| 289 | self._timeout_occurred = True |
| 290 | raise |
Gregory P. Smith | aafdca8 | 2010-01-04 04:50:36 +0000 | [diff] [blame] | 291 | except error as e: |
Antoine Pitrou | 98b4670 | 2010-09-18 22:59:00 +0000 | [diff] [blame] | 292 | n = e.args[0] |
| 293 | if n == EINTR: |
Gregory P. Smith | aafdca8 | 2010-01-04 04:50:36 +0000 | [diff] [blame] | 294 | continue |
Antoine Pitrou | 98b4670 | 2010-09-18 22:59:00 +0000 | [diff] [blame] | 295 | if n in _blocking_errnos: |
| 296 | return None |
Gregory P. Smith | aafdca8 | 2010-01-04 04:50:36 +0000 | [diff] [blame] | 297 | raise |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 298 | |
| 299 | def write(self, b): |
Antoine Pitrou | 5aa0d10 | 2010-09-15 09:32:45 +0000 | [diff] [blame] | 300 | """Write the given bytes or bytearray object *b* to the socket |
| 301 | and return the number of bytes written. This can be less than |
| 302 | len(b) if not all data could be written. If the socket is |
| 303 | non-blocking and no bytes could be written None is returned. |
| 304 | """ |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 305 | self._checkClosed() |
| 306 | self._checkWritable() |
Antoine Pitrou | 98b4670 | 2010-09-18 22:59:00 +0000 | [diff] [blame] | 307 | try: |
| 308 | return self._sock.send(b) |
| 309 | except error as e: |
| 310 | # XXX what about EINTR? |
| 311 | if e.args[0] in _blocking_errnos: |
| 312 | return None |
| 313 | raise |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 314 | |
| 315 | def readable(self): |
Antoine Pitrou | 5aa0d10 | 2010-09-15 09:32:45 +0000 | [diff] [blame] | 316 | """True if the SocketIO is open for reading. |
| 317 | """ |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 318 | return self._reading and not self.closed |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 319 | |
| 320 | def writable(self): |
Antoine Pitrou | 5aa0d10 | 2010-09-15 09:32:45 +0000 | [diff] [blame] | 321 | """True if the SocketIO is open for writing. |
| 322 | """ |
Guido van Rossum | 5abbf75 | 2007-08-27 17:39:33 +0000 | [diff] [blame] | 323 | return self._writing and not self.closed |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 324 | |
| 325 | def fileno(self): |
Antoine Pitrou | 5aa0d10 | 2010-09-15 09:32:45 +0000 | [diff] [blame] | 326 | """Return the file descriptor of the underlying socket. |
| 327 | """ |
Gregory P. Smith | de3369f | 2009-01-12 04:50:11 +0000 | [diff] [blame] | 328 | self._checkClosed() |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 329 | return self._sock.fileno() |
| 330 | |
Amaury Forgeot d'Arc | 9d24ff0 | 2008-11-20 23:15:52 +0000 | [diff] [blame] | 331 | @property |
| 332 | def name(self): |
Victor Stinner | c3a51ec | 2011-01-04 11:00:45 +0000 | [diff] [blame] | 333 | if not self.closed: |
| 334 | return self.fileno() |
| 335 | else: |
| 336 | return -1 |
Amaury Forgeot d'Arc | 9d24ff0 | 2008-11-20 23:15:52 +0000 | [diff] [blame] | 337 | |
| 338 | @property |
| 339 | def mode(self): |
| 340 | return self._mode |
| 341 | |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 342 | def close(self): |
Antoine Pitrou | 5aa0d10 | 2010-09-15 09:32:45 +0000 | [diff] [blame] | 343 | """Close the SocketIO object. This doesn't close the underlying |
| 344 | socket, except if all references to it have disappeared. |
| 345 | """ |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 346 | if self.closed: |
| 347 | return |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 348 | io.RawIOBase.close(self) |
Gregory P. Smith | de3369f | 2009-01-12 04:50:11 +0000 | [diff] [blame] | 349 | self._sock._decref_socketios() |
| 350 | self._sock = None |
Jeremy Hylton | 5accbdb | 2007-08-03 20:40:09 +0000 | [diff] [blame] | 351 | |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 352 | |
| 353 | def getfqdn(name=''): |
| 354 | """Get fully qualified domain name from name. |
| 355 | |
| 356 | An empty argument is interpreted as meaning the local host. |
| 357 | |
| 358 | First the hostname returned by gethostbyaddr() is checked, then |
| 359 | possibly existing aliases. In case no FQDN is available, hostname |
Brett Cannon | 01668a1 | 2005-03-11 00:04:17 +0000 | [diff] [blame] | 360 | from gethostname() is returned. |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 361 | """ |
| 362 | name = name.strip() |
Peter Schneider-Kamp | 2d2785a | 2000-08-16 20:30:21 +0000 | [diff] [blame] | 363 | if not name or name == '0.0.0.0': |
Fred Drake | a6070f0 | 2000-08-16 14:14:32 +0000 | [diff] [blame] | 364 | name = gethostname() |
| 365 | try: |
| 366 | hostname, aliases, ipaddrs = gethostbyaddr(name) |
| 367 | except error: |
| 368 | pass |
| 369 | else: |
| 370 | aliases.insert(0, hostname) |
| 371 | for name in aliases: |
| 372 | if '.' in name: |
| 373 | break |
| 374 | else: |
| 375 | name = hostname |
| 376 | return name |
| 377 | |
| 378 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 379 | _GLOBAL_DEFAULT_TIMEOUT = object() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 380 | |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 381 | def create_connection(address, timeout=_GLOBAL_DEFAULT_TIMEOUT, |
| 382 | source_address=None): |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 383 | """Connect to *address* and return the socket object. |
| 384 | |
| 385 | Convenience function. Connect to *address* (a 2-tuple ``(host, |
| 386 | port)``) and return the socket object. Passing the optional |
| 387 | *timeout* parameter will set the timeout on the socket instance |
| 388 | before attempting to connect. If no *timeout* is supplied, the |
| 389 | global default timeout setting returned by :func:`getdefaulttimeout` |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 390 | is used. If *source_address* is set it must be a tuple of (host, port) |
| 391 | for the socket to bind as a source address before making the connection. |
| 392 | An host of '' or port 0 tells the OS to use the default. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 393 | """ |
| 394 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 395 | host, port = address |
Antoine Pitrou | 4b92b5f | 2010-09-07 21:05:49 +0000 | [diff] [blame] | 396 | err = None |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 397 | for res in getaddrinfo(host, port, 0, SOCK_STREAM): |
| 398 | af, socktype, proto, canonname, sa = res |
| 399 | sock = None |
| 400 | try: |
| 401 | sock = socket(af, socktype, proto) |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 402 | if timeout is not _GLOBAL_DEFAULT_TIMEOUT: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 403 | sock.settimeout(timeout) |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 404 | if source_address: |
| 405 | sock.bind(source_address) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 406 | sock.connect(sa) |
| 407 | return sock |
| 408 | |
Antoine Pitrou | 4b92b5f | 2010-09-07 21:05:49 +0000 | [diff] [blame] | 409 | except error as _: |
| 410 | err = _ |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 411 | if sock is not None: |
| 412 | sock.close() |
| 413 | |
Antoine Pitrou | 4b92b5f | 2010-09-07 21:05:49 +0000 | [diff] [blame] | 414 | if err is not None: |
| 415 | raise err |
| 416 | else: |
| 417 | raise error("getaddrinfo returns an empty list") |