summaryrefslogtreecommitdiffstats
path: root/Doc/library/socket.rst
diff options
context:
space:
mode:
authorChristian Heimes <christian@cheimes.de>2008-01-07 17:19:16 (GMT)
committerChristian Heimes <christian@cheimes.de>2008-01-07 17:19:16 (GMT)
commit043d6f67c7b79a6d268c6ad31d8ff7710ac3e5ee (patch)
tree0ea113cd3a06b4ecbb27a82154174e1846ce1804 /Doc/library/socket.rst
parent13a7a21258f0cd241c2cf1367a954d6742daa2a6 (diff)
downloadcpython-043d6f67c7b79a6d268c6ad31d8ff7710ac3e5ee.zip
cpython-043d6f67c7b79a6d268c6ad31d8ff7710ac3e5ee.tar.gz
cpython-043d6f67c7b79a6d268c6ad31d8ff7710ac3e5ee.tar.bz2
Copied doc for reload() from trunk's function.rst to imp.rst
Diffstat (limited to 'Doc/library/socket.rst')
-rw-r--r--Doc/library/socket.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index cc16150..406c136 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -65,6 +65,27 @@ numeric address in *host* portion.
AF_NETLINK sockets are represented as pairs ``pid, groups``.
+
+Linux-only support for TIPC is also available using the :const:`AF_TIPC`
+address family. TIPC is an open, non-IP based networked protocol designed
+for use in clustered computer environments. Addresses are represented by a
+tuple, and the fields depend on the address type. The general tuple form is
+``(addr_type, v1, v2, v3 [, scope])``, where:
+
+ - *addr_type* is one of TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, or
+ TIPC_ADDR_ID.
+ - *scope* is one of TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE, and
+ TIPC_NODE_SCOPE.
+ - If *addr_type* is TIPC_ADDR_NAME, then *v1* is the server type, *v2* is
+ the port identifier, and *v3* should be 0.
+
+ If *addr_type* is TIPC_ADDR_NAMESEQ, then *v1* is the server type, *v2*
+ is the lower port number, and *v3* is the upper port number.
+
+ If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the
+ reference, and *v3* should be set to 0.
+
+
All errors raise exceptions. The normal exceptions for invalid argument types
and out-of-memory conditions can be raised; errors related to socket or address
semantics raise the error :exc:`socket.error`.
@@ -162,6 +183,12 @@ The module :mod:`socket` exports the following constants and functions:
:meth:`ioctl` method of socket objects.
+.. data:: TIPC_*
+
+ TIPC related constants, matching the ones exported by the C socket API. See
+ the TIPC documentation for more information.
+
+
.. data:: has_ipv6
This constant contains a boolean value which indicates if IPv6 is supported on