[Supervisor-checkins] r789 - supervisor_manual/trunk/chapters

[Chris McDonough]

Author: Chris McDonough <chrism at agendaless.com>
Date: Fri Jul 25 23:19:10 2008
New Revision: 789

Log:
Add removeProcess and addProcess API docs.


Modified:
   supervisor_manual/trunk/chapters/api-process-control.xml

Modified: supervisor_manual/trunk/chapters/api-process-control.xml
==============================================================================
--- supervisor_manual/trunk/chapters/api-process-control.xml	(original)
+++ supervisor_manual/trunk/chapters/api-process-control.xml	Fri Jul 25 23:19:10 2008
@@ -517,8 +517,136 @@
     </para>
   </sect2>
 
+  <sect2 id="api.process-control.supervisor-addProcess">
+    <title>supervisor.addProcess() (added in 3.0a7)</title>
+
+    <para>
+      <programlisting><![CDATA[
+supervisor.addProcess(namespec)
+]]></programlisting>
+    </para>
+    
+    <table>
+      <title>supervisor.addProcess() Parameters</title>
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Type</entry>
+            <entry>Name</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>string</entry>
+            <entry>namespec</entry>
+            <entry>Name of the group and process</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <table>
+      <title>supervisor.addProcess() Return Value</title>
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Type</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>boolean</entry>
+            <entry>Always <code>TRUE</code></entry>                    
+          </row>
+        </tbody>
+      </tgroup>
+    </table>      
+    
+    <para>
+      The <code>supervisor.addProcess()</code> reads a process' config
+      from the supervisord.conf file and adds the process if it hasn't
+      already been added (or if it has been removed).  It automatically
+      starts the process if the process is set to autostart.
+    </para>
+    
+    <para>  
+      If the process named by the parameter <code>namespec</code> is not
+      known by Supervisor, a fault <code>BAD_NAME</code> is raised.
+    </para>
+    
+    <para>
+      If the process is already active, an <code>ALREADY_ADDED</code>
+      is raised.
+    </para>
+  </sect2>
+
+  <sect2 id="api.process-control.supervisor-removeProcess">
+    <title>supervisor.removeProcess() (added in 3.0a7)</title>
+
+    <para>
+      <programlisting><![CDATA[
+supervisor.removeProcess(namespec)
+]]></programlisting>
+    </para>
+    
+    <table>
+      <title>supervisor.removeProcess() Parameters</title>
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Type</entry>
+            <entry>Name</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>string</entry>
+            <entry>namespec</entry>
+            <entry>Name of the group and process</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <table>
+      <title>supervisor.removeProcess() Return Value</title>
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Type</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>boolean</entry>
+            <entry>Always <code>TRUE</code></entry>                    
+          </row>
+        </tbody>
+      </tgroup>
+    </table>      
+    
+    <para>
+      The <code>supervisor.removeProcess()</code> removes a process
+      from the supervisord process list.
+    </para>
+    
+    <para>  
+      If the process named by the parameter <code>namespec</code> is not
+      known by Supervisor, a fault <code>BAD_NAME</code> is raised.
+    </para>
+    
+    <para>
+      If the process is not yet stopped, a <code>STILL_RUNNING</code>
+      is raised.
+    </para>
+  </sect2>
+
 </sect1>
 
 <!--
 vim:se ts=4 sw=4 et:
--->
\ No newline at end of file
+-->