Pārlūkot izejas kodu

Add remaining XML-RPC methods.

Mike Naberezny 15 gadi atpakaļ
vecāks
revīzija
bdf8d30b66
3 mainītis faili ar 81 papildinājumiem un 4 dzēšanām
  1. 79 2
      docs/api.rst
  2. 1 1
      docs/configuration.rst
  3. 1 1
      docs/development.rst

+ 79 - 2
docs/api.rst

@@ -1,13 +1,90 @@
 XML-RPC API Documentation
 =========================
 
-.. automodule:: supervisor.rpcinterface
-
 Status and Control
 ------------------
 
+.. automodule:: supervisor.rpcinterface
+
   .. autoclass:: SupervisorNamespaceRPCInterface
 
     .. automethod:: getAPIVersion
 
     .. automethod:: getSupervisorVersion
+
+    .. automethod:: getIdentification
+    
+    .. automethod:: getState
+    
+    .. automethod:: getPID
+    
+    .. automethod:: readLog
+    
+    .. automethod:: clearLog
+    
+    .. automethod:: shutdown
+    
+    .. automethod:: restart
+  
+Process Control
+---------------
+
+.. automodule:: supervisor.rpcinterface
+
+  .. autoclass:: SupervisorNamespaceRPCInterface
+
+    .. automethod:: getProcessInfo
+    
+    .. automethod:: getAllProcessInfo
+    
+    .. automethod:: startProcess
+    
+    .. automethod:: startAllProcesses
+    
+    .. automethod:: startProcessGroup
+    
+    .. automethod:: stopProcessGroup
+    
+    .. automethod:: sendProcessStdin
+    
+    .. automethod:: sendRemoteCommEvent
+    
+    .. automethod:: addProcessGroup
+    
+    .. automethod:: removeProcessGroup
+
+Process Logging
+---------------
+
+.. automodule:: supervisor.rpcinterface
+
+  .. autoclass:: SupervisorNamespaceRPCInterface
+
+    .. automethod:: readProcessStdoutLog
+
+    .. automethod:: readProcessStderrLog
+
+    .. automethod:: tailProcessStdoutLog
+
+    .. automethod:: tailProcessStderrLog
+
+    .. automethod:: clearProcessLogs
+
+    .. automethod:: clearAllProcessLogs
+
+
+System Methods
+--------------
+
+.. automodule:: supervisor.xmlrpc
+
+  .. autoclass:: SystemNamespaceRPCInterface
+
+    .. automethod:: listMethods
+
+    .. automethod:: methodHelp
+
+    .. automethod:: methodSignature
+
+    .. automethod:: multicall
+                    

+ 1 - 1
docs/configuration.rst

@@ -1,7 +1,7 @@
 Configuration File Syntax and Semantics
 =======================================
 
-The supervisor configuration file is conventionally named
+The Supervisor configuration file is conventionally named
 :file:`supervisord.conf`.  It is used by both :program:`supervisord`
 and :program:`supervisorctl`.  If either application is started
 without the ``-c`` option (the option which is used to tell the

+ 1 - 1
docs/development.rst

@@ -49,7 +49,7 @@ Primary Authors and Maintainers
 
 - Chris McDonough (`Agendaless Consulting, Inc. <http://agendaless.com>`_)
 
-- Mike Naberezny (`Maintainable Software, Inc. <http://maintainable.com>`_)
+- Mike Naberezny (`Maintainable Software, LLC. <http://maintainable.com>`_)
 
 Contributors
 ~~~~~~~~~~~~