Main Page Class Hierarchy Compound List Compound Members FailureException Class Reference
Thrown to indicate a non-fatal error has occurred in the service. More...
Inheritance diagram for FailureException:
List of all members.
Public Methods
FailureException (void) throw () Creates an exception with no error message. FailureException (const char *errorDescription, int errorCode=0) throw () Creates an exception with an error message. FailureException & operator= (const FailureException &rhs) The assignment operator. void applyCustomizedDebugAction (bool shouldApply) Specifies whether to apply the customizedDebugAction when this exception is thrown. Detailed Description
Thrown to indicate a non-fatal error has occurred in the service.After a FailureException has occurred, the service request can still be retried on other compute hosts.
For more details, please refer to the Application Development Guide.If a pointer to a
FailureException
object is thrown within the service, the memory it is pointing to will be freed automatically using the delete operator.
If your exception must be created on the heap then it is recommended that a smart pointer be thrown instead of a raw pointer to prevent any ambiguity.
eg.
FailureExceptionPtr ex = new FailureException("A failure exception occured ...");
...
throw ex;
NOTE :
- If you create an object of this type on the heap (e.g. using the
new
operator), it is always best to assign and use the appropriate smart pointer type, instead of using the raw pointer. If you use a smart pointer, you should never explicitly delete the object, since the smart pointer will automatically free the object.- If any of the methods of this class are called after the main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).
- See also:
- FailureExceptionPtr , SoamException
Constructor & Destructor Documentation
FailureException ( void ) throw ()
Creates an exception with no error message.
FailureException ( const char * errorDescription, int errorCode = 0 ) throw ()
Creates an exception with an error message.
Member Function Documentation
FailureException& operator= ( const FailureException & rhs )
The assignment operator.
This method will safely assign the exception being passed to the current exception.
- Returns:
- a reference to the current object.
void applyCustomizedDebugAction ( bool shouldApply ) [virtual]
Specifies whether to apply the customizedDebugAction when this exception is thrown.
This method can be used to specify whether to apply the customizedDebugAction, specified in the Service > Control > Method > Exception section of the application profile, when this exception is thrown. This behavior is applicable only if debugSetting="customized" in the Service section of the application profile. By default, if you do not call this method, the customizedDebugAction is applied when this exception is thrown.
You can use this method when you are throwing an expected exception and do not need to debug it. For example, if the customizedDebugAction="writeServiceEventReplayFiles" then you can avoid the overhead of creating unnecessary SERL files by calling applyCustomizedDebugAction(false) on the exception before throwing it.
- Parameters:
shouldApply [IN] -- Flag to indicate whether to apply customizedDebugAction. Reimplemented from SoamException.
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com
Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.