diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-01-28 14:46:58 +0300 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-01-28 14:46:58 +0300 |
| commit | 74fcb122f0afa8be19b691e720c35f5730175f96 (patch) | |
| tree | a6b942d5267397626b1124f9a25c86ef9e63dc7a | |
| parent | 59540dccf125452a8cf4e55f260788a46f7838dc (diff) | |
| download | micropython-74fcb122f0afa8be19b691e720c35f5730175f96.tar.gz micropython-74fcb122f0afa8be19b691e720c35f5730175f96.zip | |
docs/usocket: Elaborate "Constants" section.
| -rw-r--r-- | docs/library/usocket.rst | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/docs/library/usocket.rst b/docs/library/usocket.rst index 64afa6f59b..16ba66c2b9 100644 --- a/docs/library/usocket.rst +++ b/docs/library/usocket.rst @@ -74,21 +74,33 @@ Constants --------- .. data:: socket.AF_INET + socket.AF_INET6 - family types + Address family types. Availability depends on a particular board. .. data:: socket.SOCK_STREAM -.. data:: socket.SOCK_DGRAM + socket.SOCK_DGRAM - socket types + Socket types. .. data:: socket.IPPROTO_UDP -.. data:: socket.IPPROTO_TCP -.. only:: port_wipy + socket.IPPROTO_TCP - .. data:: socket.IPPROTO_SEC + IP protocol numbers. - protocol numbers +.. data:: socket.SOL_* + + Socket option levels (an argument to ``setsockopt()``). The exact inventory depends on a board. + +.. data:: socket.SO_* + + Socket options (an argument to ``setsockopt()``). The exact inventory depends on a board. + +Constants specific to WiPy: + +.. data:: socket.IPPROTO_SEC + + Special protocol value to create SSL-compatible socket. class socket ============ |