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

[Mike Naberezny]

Author: Mike Naberezny <mike at maintainable.com>
Date: Thu May 21 23:58:27 2009
New Revision: 850

Log:
Document RemoteCommunicationEvent.

Modified:
   supervisor_manual/trunk/chapters/api-process-control.xml
   supervisor_manual/trunk/chapters/events.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	Thu May 21 23:58:27 2009
@@ -715,6 +715,65 @@
     </para>
   </sect2>
 
+  <sect2 id="api.process-control.supervisor-sendremotecommevent">
+    <title>supervisor.sendRemoteCommEvent() (added in 3.0a7)</title>
+
+    <para>
+      <programlisting><![CDATA[
+supervisor.sendRemoteCommEvent()
+]]></programlisting>
+    </para>
+
+        <table>
+          <title>supervisor.sendRemoteCommEvent() Parameters</title>
+          <tgroup cols="3">
+            <thead>
+              <row>
+                <entry>Type</entry>
+                <entry>Name</entry>  
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>string</entry>
+                <entry>type</entry>
+                <entry>Value for <code>type</code> in the event header</entry>
+              </row> 
+              <row>
+                <entry>string</entry>
+                <entry>data</entry>
+                <entry>Value for the event payload</entry>
+              </row> 
+            </tbody>   
+          </tgroup>
+        </table>
+        
+        <table>
+          <title>supervisor.sendRemoteCommEvent() 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.sendRemoteCommEvent()</code> method emits 
+          an event that will be received by event listener subprocesses 
+          subscribing to the <code>REMOTE_COMMUNICATION</code> event type.
+        </para>
+  </sect2>
+
   <sect2 id="api.process-control.supervisor-addProcessGroup">
     <title>supervisor.addProcessGroup() (added in 3.0a7)</title>
 

Modified: supervisor_manual/trunk/chapters/events.xml
==============================================================================
--- supervisor_manual/trunk/chapters/events.xml	(original)
+++ supervisor_manual/trunk/chapters/events.xml	Thu May 21 23:58:27 2009
@@ -998,6 +998,45 @@
 
     <table>
       <title>
+        <code>REMOTE_COMMUNICATION</code> Event Type
+      </title>
+      <tgroup cols="2">
+        <tbody>
+          <row>
+            <entry>Name</entry>
+            <entry>
+              <code>REMOTE_COMMUNICATION</code>
+            </entry>
+          </row>
+          <row>
+            <entry>Description</entry>
+            <entry>
+              REMOTE_COMMUNICATION -- an event type raised when the
+              <code>supervisor.sendRemoteCommEvent()</code> method 
+              is called on Supervisor's RPC interface.  The 
+              <code>type</code> and <code>data</code> are arguments 
+              of the RPC method.
+            </entry>
+          </row>
+          <row>
+            <entry>Body</entry>
+            <entry>
+              <programlisting>
+type:type
+data
+              </programlisting>
+            </entry>
+          </row> 
+          <row>
+            <entry>Subtype Of</entry>
+            <entry><code>EVENT</code></entry>
+          </row>   
+        </tbody>
+      </tgroup>
+    </table>
+
+    <table>
+      <title>
         <code>PROCESS_COMMUNICATION</code> Event Type
       </title>
       <tgroup cols="2">