X-Git-Url: https://git.distorted.org.uk/~mdw/mLib-python/blobdiff_plain/5b1830f325c55c70d65fd020f08dd958493e528d..refs/heads/mdw/python3.pyke:/sel-file.pyx

diff --git a/sel-file.pyx b/sel-file.pyx
index f077e7c..9ff1029 100644
--- a/sel-file.pyx
+++ b/sel-file.pyx
@@ -28,6 +28,11 @@ SEL_WRITE = _SEL_WRITE
 SEL_EXCEPT = _SEL_EXC
 
 cdef class SelFile:
+  """
+  SelFile(FILE, [mode = SEL_READ], [readyproc = None])
+
+  Register a file (or socket, or, ...) with the select loop.
+  """
   cdef sel_file f
   cdef int _activep
   cdef readonly unsigned mode
@@ -46,12 +51,15 @@ cdef class SelFile:
     if me._activep:
       sel_rmfile(&me.f)
   property fd:
+    """SF.fd -> INT: the file descriptor"""
     def __get__(me):
       return me.f.fd
   property activep:
+    """SF.activep -> BOOL: is the descriptor active?"""
     def __get__(me):
       return _tobool(me._activep)
   property readyproc:
+    """SF.readyproc -> FUNC: call FUNC() when file is ready for I/O"""
     def __get__(me):
       return me._readyfunc
     def __set__(me, proc):
@@ -59,18 +67,21 @@ cdef class SelFile:
     def __del__(me):
       me._readyfunc = None
   def enable(me):
+    """SF.enable(): enable waiting on file"""
     if me._activep:
       raise ValueError, 'already enabled'
     sel_addfile(&me.f)
     me._enabled()
     return me
   def disable(me):
+    """SF.disable(): disable waiting on file"""
     if not me._activep:
       raise ValueError, 'already disabled'
     sel_rmfile(&me.f)
     me._disabled()
     return me
   def force(me):
+    """SF.force(): artificially mark file as ready"""
     sel_force(&me.f)
     return me
   cdef _enabled(me):
@@ -80,10 +91,13 @@ cdef class SelFile:
     me._activep = 0
     me.disabled()
   def enabled(me):
+    """SF.enabled(): called when file is enabled"""
     pass
   def disabled(me):
+    """SF.disabled(): called when file is disabled"""
     pass
   def ready(me):
+    """SF.ready(): called when file is ready for I/O"""
     return _maybecall(me._readyfunc, ())
 
 cdef void _filefunc(int fd, unsigned mode, void *arg):