HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions
rwsf::ClientFault Class Reference

Extends rwsf::Fault to represent a SOAP client fault. More...

#include <rwsf/webservice/Fault.h>

Inheritance diagram for rwsf::ClientFault:
rwsf::Fault rwsf::Exception

Public Member Functions

 ClientFault (const std::string &msg)
- Public Member Functions inherited from rwsf::Fault
 Fault ()
 Fault (FaultCode faultCode, const std::string &faultString)
virtual ~Fault () throw ()
std::string asString () const
EncodingStyle getEncodingStyle () const
Fault::FaultCode getFaultCode () const
std::string getFaultCodeAsString () const
std::string getFaultString () const
std::string getProperty (const std::string &key) const
virtual void init (const rwsf::Config &initParams)
void setEncodingStyle (EncodingStyle style)
void setFaultCode (Fault::FaultCode faultCode)
void setFaultString (const std::string &faultString)
void setProperty (const std::string &key, const std::string &value)
virtual const char * why () const
- Public Member Functions inherited from rwsf::Exception
 Exception (const ExceptionInfo &eInfo)
 Exception (const char *msg)
 Exception (const std::string &msg)
 Exception (const rwsf::ExceptionInfo &eInfo, const LocalizedMessage &msg)
 Exception (const Exception &)
virtual ~Exception () throw ()
virtual Exceptionclone (void) const
const char * getFileName () const
const char * getFunctionName () const
unsigned long getLineNumber () const
virtual bool operator!= (const Exception exc2)
Exceptionoperator= (const Exception &m)
virtual bool operator== (const Exception exc2)
virtual void raise (void) const
virtual const char * what () const throw ()

Additional Inherited Members

- Public Types inherited from rwsf::Fault
enum  EncodingStyle { Rpc, Document, Wrapped }
enum  FaultCode { VersionMismatch, MustUnderstand, Client, Server }
- Static Public Member Functions inherited from rwsf::Fault
static Fault::FaultCode getFaultCodeFromName (const rwsf::XmlName &name)

Detailed Description

An instance of class rwsf::ClientFault extends rwsf::Fault to represent a SOAP client fault. A SOAP client fault is used to indicate an error caused by incorrect information from the client or a bad SOAP request.

The main use of this class and rwsf::ServerFault is to generate a SOAP client fault or SOAP server fault in the server implementation. For instance, the generated sample server implementation contains the following code:

throw rwsf::ClientFault("Unrecognized values in message.");

You may choose to also throw an rwsf::ClientFault in the server implementation for several reasons, such as an out-of-range input parameter.

For more information on faults, see the Web Service Development Guide.

Constructor & Destructor Documentation

rwsf::ClientFault::ClientFault ( const std::string &  msg)

Creates an instance of a client fault containing the error text msg. The SOAP message is then passed to the constructor of rwsf::Fault.

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.