mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
micropython/docs/library/select.rst

58 lines
1.3 KiB
ReStructuredText
Raw Normal View History

docs: select: Describe extra details.
2014-11-08 18:14:05 +00:00
:mod:`select` -- wait for events on a set of streams
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
========================================================================
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
.. module:: select
docs: select: Describe extra details.
2014-11-08 18:14:05 +00:00
:synopsis: wait for events on a set of streams
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: select: Describe extra details.
2014-11-08 18:14:05 +00:00
This module provides functions to wait for events on streams (select streams
which are ready for operations).
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
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`.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Functions
---------
.. function:: poll()
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Create an instance of the Poll class.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
.. function:: select(rlist, wlist, xlist[, timeout])
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Wait for activity on a set of objects.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: select: Describe extra details.
2014-11-08 18:14:05 +00:00
This function is provided for compatibility and is not efficient. Usage
of :class:`Poll` is recommended instead.
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
.. _class: Poll
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
class ``Poll``
--------------
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Methods
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
~~~~~~~
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
.. method:: poll.register(obj[, eventmask])
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Register ``obj`` for polling. ``eventmask`` is 1 for read, 2 for
write, 3 for read-write.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
.. method:: poll.unregister(obj)
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Unregister ``obj`` from polling.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
.. method:: poll.modify(obj, eventmask)
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Modify the ``eventmask`` for ``obj``.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
.. method:: poll.poll([timeout])
docs: select: Describe extra details.
2014-11-08 18:14:05 +00:00
Wait for at least one of the registered objects to become ready. Returns
list of ready objects, or empty list on timeout.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Timeout is in milliseconds.