ship some documentation
[~helmut/onoff.git] / onoff / process.py
index aca7c4d..68deb97 100644 (file)
@@ -5,11 +5,36 @@ import signal
 from gi.repository import GObject
 
 from .common import ST_ACTIVE, ST_TRANSITION, OnoffDevice
+from .gobject import spawn_child
 
 logger = logging.getLogger("onoff.process")
 
 class OnoffProcess(OnoffDevice):
+    """A device that in activated by starting a process and deactivated by
+    killing the process.
+
+    @type pid: int or None
+    @ivar pid: is either None if there is no process or the pid of the
+            spawned process
+    @ivar starting: is either None or a GObject event source id of the
+            callback sigalling the end of the activation transition.
+    @ivar watch: is either None or a GObject event source id of the
+            callback waiting for the termination of the spawned process.
+    @type killed: bool
+    @ivar killed: indicates whether the termination signal has been sent
+            to the spawned process.
+    """
     def __init__(self, command, start_wait=0, termsig=signal.SIGTERM):
+        """
+        @type command: [str]
+        @param command: an argument vector to be executed. The first element
+                is used as executable and looked up in $PATH.
+        @param start_wait: duration of the transition period from inactive to
+                active in seconds.
+        @param termsig: termination signal to be sent to the process to
+                deactivate it. The process must exit in response to this
+                signal.
+        """
         OnoffDevice.__init__(self)
         self.command = command
         self.start_wait = start_wait
@@ -30,11 +55,8 @@ class OnoffProcess(OnoffDevice):
         assert self.pid is None
         assert self.starting is None
         logger.info("starting command %s", " ".join(self.command))
-        ret = GObject.spawn_async(self.command, flags=GObject.SPAWN_SEARCH_PATH | GObject.SPAWN_DO_NOT_REAP_CHILD)
-        self.pid = ret[0]
-        assert self.pid
+        self.pid, self.watch = spawn_child(self.command, self.process_died)
         logger.debug("started as pid %d", self.pid)
-        self.watch = GObject.child_watch_add(self.pid, self.process_died)
         self.starting = GObject.timeout_add(1000 * self.start_wait,
                                             self.process_started)
         self.changestate(self.state)