Author: lou
Date: 2008-03-25 11:51:57 -0700 (Tue, 25 Mar 2008)
New Revision: 8399

Modified:
   openlaszlo/trunk/lps/components/rpc/xmlrpc.lzx
Log:
Change 20080325-lou-k by [EMAIL PROTECTED] on 2008-03-25 14:47:53 AST
    in /Users/lou/src/svn/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: add introductory paragraph and live code example from 3.4

Bugs Fixed: LPP-5657

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: (pending) 

Tests: visual verify



Modified: openlaszlo/trunk/lps/components/rpc/xmlrpc.lzx
===================================================================
--- openlaszlo/trunk/lps/components/rpc/xmlrpc.lzx      2008-03-25 18:50:35 UTC 
(rev 8398)
+++ openlaszlo/trunk/lps/components/rpc/xmlrpc.lzx      2008-03-25 18:51:57 UTC 
(rev 8399)
@@ -3,7 +3,6 @@
     <include href="rpc/rpc.lzx" />
     <include href="rpc/library/xmlrpc.js" />
 
-    <!--- A class to call XML-RPC services. -->
     <class name="xmlrpc" extends="rpc">
 
         <!--- (Required) XML-RPC service URL. The URL must be http. -->
@@ -61,7 +60,84 @@
             }
             super.init();
         </method>
-
+        <doc>
+            <tag name="shortdesc">
+                <text>XML-RPC implementation</text>
+            </tag>
+            <text>
+                <p>XML-RPC is simple spec that describes how to invoke a 
remote operation using
+                    XML over HTTP. Laszlo XML-RPC is part of <a 
href="../developers/rpc.html" target="laszlo-dguide" shape="rect">Laszlo
+                        RPC</a> and shares many of the same APIs and concept. 
Laszlo RPC includes <a href="../developers/rpc-soap.html" 
target="laszlo-dguide" shape="rect">SOAP</a> and <a 
href="../guide/rpc-javarpc.html" target="laszlo-dguide" 
shape="rect">JavaRPC</a>. For more information on XML-RPC,
+                    go to <a href="http://www.xmlrpc.com/"; 
shape="rect">XML-RPC.com</a>
+                </p>
+                
+                
+                <p>Most Laszlo RPC objects like JavaRPC and SOAP will set 
function stubs in the
+                    proxy property during load based on methods described by a 
class (for JavaRPC)
+                    or on a service description (using a WSDL in SOAP). 
Remotecall declarations
+                    refer to these function stubs and any remotecalls not 
pointing to a function
+                    stub that doesn't exist will generate an error/warning. In 
&lt;xmlrpc&gt;,
+                    function stubs are create based on remotecall 
declarations. Note that XML-RPC
+                    use dot notation for their operation names. Because that 
will conflict with the
+                    view system's notation, it's suggested that remotecalls 
are explictly named.</p>
+                <example>
+    &lt;canvas debug="true" height="400"&gt;
+    
+        &lt;debug x="10" y="40" width="450" height="350" /&gt;
+        
+        &lt;xmlrpc name="meerkat"
+                
service="http://www.oreillynet.com/meerkat/xml-rpc/server.php"&gt;
+            
+            &lt;handler name="onload"&gt;
+                Debug.write('meerkat XML-RPC service loaded');
+                Debug.write('proxy:');
+                Debug.inspect(this.proxy);
+            &lt;/handler&gt;
+            
+            &lt;handler name="ondata" args="data"&gt;
+                Debug.write('got data:', data);
+            &lt;/handler&gt;
+            
+            &lt;handler name="onerror" args="error"&gt;
+                Debug.write('onerror:', error);
+            &lt;/handler&gt;
+            
+            &lt;remotecall name="gc" funcname="meerkat.getCategories" /&gt;
+            
+        &lt;/xmlrpc&gt;
+        
+        &lt;button text="getCategories" x="10" y="10"&gt;
+            &lt;handler name="onclick"&gt;
+                Debug.write('getting categories...');
+                meerkat.gc.invoke()
+            &lt;/handler&gt;
+        &lt;/button&gt;
+    
+    &lt;/canvas&gt;
+                </example>
+                <p><b>See Also:</b></p>
+                    <ul>
+                        <li>
+                            <a href="../reference/rpc.html"><code 
class="classname">rpc</code></a>
+                        </li>
+                        <li>
+                            <a href="../reference/javarpc.html"><code 
class="classname">javarpc</code></a>
+                        </li>
+                        <li>
+                            <a href="../reference/soap.html"><code 
class="classname">soap</code></a>
+                        </li>
+                        <li>
+                            <a href="../reference/remotecall.html"><code 
class="classname">remotecall</code></a>
+                        </li>
+                        <li>
+                            <a href="../guide/rpc.html" target="laszlo-dguide" 
shape="rect">Developer's Guide: RPC chapter</a>
+                        </li>
+                        <li>
+                            <a href="../guide/rpc-xmlrpc.html" 
target="laszlo-dguide" shape="rect">Developer's Guide: XMLRPC chapter</a>
+                        </li>
+                    </ul>
+            </text>
+        </doc>
     </class>
 
 </library>


_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins

Reply via email to