aboutsummaryrefslogtreecommitdiff
path: root/docs/library/select.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/select.rst')
-rw-r--r--docs/library/select.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/library/select.rst b/docs/library/select.rst
new file mode 100644
index 000000000..aceb19072
--- /dev/null
+++ b/docs/library/select.rst
@@ -0,0 +1,37 @@
+:mod:`select` --- Provides select function to wait for events on a stream
+=========================================================================
+
+.. module:: select
+ :synopsis: Provides select function to wait for events on a stream
+
+This module provides the select function.
+
+
+Functions
+---------
+
+.. function:: poll()
+
+
+.. function:: select(rlist, wlist, xlist[, timeout])
+
+
+class Poll
+----------
+
+
+Methods
+-------
+
+.. method:: poll.modify(obj, eventmask)
+
+
+.. method:: poll.poll([timeout])
+
+ Timeout is in milliseconds.
+
+.. method:: poll.register(obj[, eventmask])
+
+
+.. method:: poll.unregister(obj)
+