diff options
Diffstat (limited to 'docs/library/select.rst')
| -rw-r--r-- | docs/library/select.rst | 35 |
1 files changed, 25 insertions, 10 deletions
diff --git a/docs/library/select.rst b/docs/library/select.rst index aceb190720..22e4c2097b 100644 --- a/docs/library/select.rst +++ b/docs/library/select.rst @@ -1,37 +1,52 @@ -:mod:`select` --- Provides select function to wait for events on a stream -========================================================================= +: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. +Pyboard specifics +----------------- + +Polling is an efficient way of waiting for read/write activity on multiple +objects. Current objects that support polling are: :class:`pyb.UART`, +:class:`pyb.USB_VCP`. Functions --------- .. function:: poll() + Create an instance of the Poll class. .. function:: select(rlist, wlist, xlist[, timeout]) + Wait for activity on a set of objects. -class Poll ----------- +.. _class: Poll +class ``Poll`` +-------------- Methods -------- +~~~~~~~ -.. method:: poll.modify(obj, eventmask) +.. method:: poll.register(obj[, eventmask]) + Register ``obj`` for polling. ``eventmask`` is 1 for read, 2 for + write, 3 for read-write. -.. method:: poll.poll([timeout]) +.. method:: poll.unregister(obj) - Timeout is in milliseconds. + Unregister ``obj`` from polling. -.. method:: poll.register(obj[, eventmask]) +.. method:: poll.modify(obj, eventmask) + Modify the ``eventmask`` for ``obj``. -.. method:: poll.unregister(obj) +.. method:: poll.poll([timeout]) + + Wait for one of the registered objects to become ready. + Timeout is in milliseconds. |