summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Panter <vadmium>2015-09-11 23:14:57 (GMT)
committerMartin Panter <vadmium>2015-09-11 23:14:57 (GMT)
commitea7266d7c6cde6b973e63d8dc06975660dbc11dd (patch)
treef9817c70701d499eb6288c700b357724bfccca45
parent79e5088a604365e66cf2879b946fb49c74597202 (diff)
downloadcpython-ea7266d7c6cde6b973e63d8dc06975660dbc11dd.zip
cpython-ea7266d7c6cde6b973e63d8dc06975660dbc11dd.tar.gz
cpython-ea7266d7c6cde6b973e63d8dc06975660dbc11dd.tar.bz2
Issue #25043: Document BDADDR_ and HCI_ Bluetooth socket constants
Patch from Tim Tisdall.
-rw-r--r--Doc/library/socket.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index f13fd7e..271dda8 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -334,6 +334,22 @@ Constants
This constant contains a boolean value which indicates if IPv6 is supported on
this platform.
+.. data:: BDADDR_ANY
+ BDADDR_LOCAL
+
+ These are string constants containing Bluetooth addresses with special
+ meanings. For example, :const:`BDADDR_ANY` can be used to indicate
+ any address when specifying the binding socket with
+ :const:`BTPROTO_RFCOMM`.
+
+.. data:: HCI_FILTER
+ HCI_TIME_STAMP
+ HCI_DATA_DIR
+
+ For use with :const:`BTPROTO_HCI`. :const:`HCI_FILTER` is not
+ available for NetBSD or DragonFlyBSD. :const:`HCI_TIME_STAMP` and
+ :const:`HCI_DATA_DIR` are not available for FreeBSD, NetBSD, or
+ DragonFlyBSD.
Functions
^^^^^^^^^