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

docs/uselect: Describe more aspects of poll.register/modify behavior. 

E.g., register() can be called again for the same object, while modify()
will raise exception if object was not register()ed before.
This commit is contained in:
Paul Sokolovsky 2018-09-28 22:05:45 +03:00 committed by Damien George
parent 6ef783527d
commit d251f26688
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/library/uselect.rst
View File

@ -45,13 +45,18 @@ Methods
*eventmask* defaults to ``uselect.POLLIN | uselect.POLLOUT``. *eventmask* defaults to ``uselect.POLLIN | uselect.POLLOUT``.
It is OK to call this function multiple times for the same *obj*.
Successive calls will update *obj*'s eventmask to the value of
*eventmask* (i.e. will behave as `modify()`).
.. method:: poll.unregister(obj) .. method:: poll.unregister(obj)
Unregister *obj* from polling. Unregister *obj* from polling.
.. method:: poll.modify(obj, eventmask) .. method:: poll.modify(obj, eventmask)
Modify the *eventmask* for *obj*. Modify the *eventmask* for *obj*. If *obj* is not registered, `OSError`
is raised with error of ENOENT.
.. method:: poll.poll(timeout=-1) .. method:: poll.poll(timeout=-1)