-# -*-pyrex-*-
-#
-# $Id$
-#
-# File selectors
-#
-# (c) 2005 Straylight/Edgeware
-#
+### -*-pyrex-*-
+###
+### File selectors
+###
+### (c) 2005 Straylight/Edgeware
+###
-#----- Licensing notice -----------------------------------------------------
-#
-# This file is part of the Python interface to mLib.
-#
-# mLib/Python is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# mLib/Python is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with mLib/Python; if not, write to the Free Software Foundation,
-# Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+###----- Licensing notice ---------------------------------------------------
+###
+### This file is part of the Python interface to mLib.
+###
+### mLib/Python is free software; you can redistribute it and/or modify
+### it under the terms of the GNU General Public License as published by
+### the Free Software Foundation; either version 2 of the License, or
+### (at your option) any later version.
+###
+### mLib/Python is distributed in the hope that it will be useful,
+### but WITHOUT ANY WARRANTY; without even the implied warranty of
+### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+### GNU General Public License for more details.
+###
+### You should have received a copy of the GNU General Public License
+### along with mLib/Python; if not, write to the Free Software Foundation,
+### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
SEL_READ = _SEL_READ
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
cdef _readyfunc
- def __new__(me, fd, int mode = SEL_READ, readyproc = None,
+ def __cinit__(me, fd, int mode = SEL_READ, readyproc = None,
*hunoz, **hukairz):
if (mode != _SEL_READ and
mode != _SEL_WRITE and
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):
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):
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):
sf = <SelFile>arg
sf.ready()
-#----- That's all, folks ----------------------------------------------------
+###----- That's all, folks --------------------------------------------------