[Python-checkins] cpython (3.4): Issue #25043: Document BDADDR_ and HCI_ Bluetooth socket constants

[martin.panter]

https://hg.python.org/cpython/rev/152568976062
changeset:   97927:152568976062
branch:      3.4
parent:      97918:4488e321fe85
user:        Martin Panter <vadmium>
date:        Fri Sep 11 23:14:57 2015 +0000
summary:
  Issue #25043: Document BDADDR_ and HCI_ Bluetooth socket constants

Patch from Tim Tisdall.

files:
  Doc/library/socket.rst |  16 ++++++++++++++++
  1 files changed, 16 insertions(+), 0 deletions(-)


diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -334,6 +334,22 @@
    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
 ^^^^^^^^^

-- 
Repository URL: https://hg.python.org/cpython