[docs] [issue21430] Document ssl.pending()

[Bas Wijnen]

New submission from Bas Wijnen:

In order to use ssl sockets asynchronously, it is important to use the pending() method, otherwise the internal buffer will be ignored, and select may block for new data while it's already waiting.  See bug #16976 and http://stackoverflow.com/questions/21663705/how-to-use-select-with-python-ssl-socket-buffering

Using pending() works fine, but is entirely undocumented.  https://docs.python.org/2.7/library/ssl.html (and all other versions) don't even mention the existence of the method.  I hope this can be changed; using an undocumented feature isn't nice, but in this case there is no other good solution.

----------
assignee: docs at python
components: Documentation
messages: 217884
nosy: docs at python, shevek
priority: normal
severity: normal
status: open
title: Document ssl.pending()
versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue21430>
_______________________________________