Fixed some doxygen warnings.

[shibboleth/cpp-xmltooling.git] / xmltooling / soap / SOAPClient.h

diff --git a/xmltooling/soap/SOAPClient.h b/xmltooling/soap/SOAPClient.h
index 3263310..cc13587 100644 (file)
--- a/xmltooling/soap/SOAPClient.h
+++ b/xmltooling/soap/SOAPClient.h
@@ -29,6 +29,7 @@
 namespace soap11 {
 
     class XMLTOOL_API Envelope;
+    class XMLTOOL_API Fault;
 
     /**
      * Implements SOAP 1.1 messaging over a transport.
@@ -40,7 +41,13 @@ namespace soap11 {
     {
         MAKE_NONCOPYABLE(SOAPClient);
     public:
-        SOAPClient() : m_validate(false), m_transport(NULL) {}
+        /**
+         * Constructor
+         * 
+         * @param validate  true iff schema validation should be used 
+         */
+        SOAPClient(bool validate=false) : m_validate(validate), m_transport(NULL) {}
+        
         virtual ~SOAPClient();
         
         /**
@@ -73,8 +80,6 @@ namespace soap11 {
          * will be forthcoming, an exception is raised.
          * 
          * <p>The caller is responsible for freeing the returned envelope.
-         * 
-         * <p>Once a response is returned, the object will be reset for a subsequent call.
          */
         virtual Envelope* receive();
         
@@ -90,7 +95,15 @@ namespace soap11 {
          * @param transport reference to transport layer
          */
         virtual void prepareTransport(const xmltooling::SOAPTransport& transport) {}
-        
+
+        /**
+         * Handling of SOAP faults.
+         * 
+         * @param fault SOAP Fault received by client
+         * @return true iff the Fault should be treated as a fatal error
+         */
+        virtual bool handleFault(const soap11::Fault& fault);
+            
         /** Flag controlling schema validation. */
         bool m_validate;