Update of /project/cl-soap/cvsroot/public_html In directory common-lisp.net:/tmp/cvs-serv25150

Modified Files: index.html Log Message: added a section on debugging and reporting errors

Date: Sun Oct 9 10:34:44 2005 Author: scaekenberghe

Index: public_html/index.html diff -u public_html/index.html:1.10 public_html/index.html:1.11 --- public_html/index.html:1.10 Wed Oct 5 15:24:08 2005 +++ public_html/index.html Sun Oct 9 10:34:43 2005 @@ -132,6 +132,32 @@ <li>Lot's of work remains to be done! All help is welcome.</li> </ul> </p> +<h3>Debugging and Reporting Errors</h3> +<p> + Common Lisp is a way better environment to develop and experiment with something like SOAP + than more mainstream languages like C, C++, Java or C#. + The listener, debugger and inspector are your friends! + To help in debugging, the following features were added to CL-SOAP. + The global variable <tt>cl-soap:*debug-stream*</tt> is the main toggle to enable debugging. + When NIL, debugging is disabled. + Otherwise, set it to some stream where you want debugging output to be written to. + For example, in a listener, do <tt>(setf *debug-stream* *standard-output*)</tt>. + This will result in the outgoing and incoming literal XML being written to that stream. + Furthermore, on each call, two more globals will be assigned: + <tt>cl-soap:*last-soap-call-xml*</tt> and <tt>cl-soap:*last-soap-result-xml*</tt> + will contain the LXML DOM representation of the XML of the outgoing SOAP call envelope + and of the incoming SOAP result envelope respectively. Since this is a DOM representation, + it is actually equal to what CL-SOAP produced before handing it off to S-XML to be rendered + and to what the S-XML parser produced (so it is already an interpretation) respectively. + A little convenience function called <tt>(cl-soap:report-soap-call)</tt> will pretty print + these last two variables. +</p> +<p> + When reporting problems with CL-SOAP, please include a listener transcript produced with + debugging enabled, with a full backtrace (in LispWorks issue a :bb for example) and a call to (report-soap-call). + Also, if you want the CL-SOAP team or community to be able to help you, it will help + enormeously if the service that you are calling is available on the internet. +</p> <h3>Next Phase(s) (Future)</h3> <p> <ul> @@ -170,6 +196,6 @@ Initial development was done by Sven Van Caekenberghe (Beta Nine) with testing by Alain Picard (Memetrics). <p> -<p>$Id: index.html,v 1.10 2005/10/05 13:24:08 scaekenberghe Exp $</p> +<p>$Id: index.html,v 1.11 2005/10/09 08:34:43 scaekenberghe Exp $</p> </body> </html>