ship some documentation
[~helmut/onoff.git] / onoff / process.py
index d888842..68deb97 100644 (file)
@@ -10,7 +10,31 @@ 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