Exception.hpp

Go to the documentation of this file.

#ifndef __GEMFIRE_EXCEPTION_H__
#define __GEMFIRE_EXCEPTION_H__
/*=========================================================================
 * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *========================================================================
 */

#include "gfcpp_globals.hpp"
#include "gf_types.hpp"

namespace gemfire {

  #define GF_EX_MSG_LIMIT 2048

  class Exception;
  typedef SharedPtr<Exception> ExceptionPtr;

  class DistributedSystem;

  class CPPCACHE_EXPORT Exception : public SharedBase
  {
  public:

    Exception(const char* msg1, const char* msg2 = NULL,
        bool forceTrace = false, const ExceptionPtr& cause = NULLPTR);

    Exception( const Exception& other );

    virtual Exception* clone() const;

    virtual ~Exception();

    virtual const char *  getMessage() const;
    virtual void showMessage() const;

    virtual void printStackTrace() const;

#ifndef _SOLARIS

    virtual size_t getStackTrace( char* buffer, size_t maxLength ) const;
#endif

    virtual const char* getName( ) const;

    virtual void raise()
    {
      throw *this;
    }

    inline ExceptionPtr getCause() const
    {
      return m_cause;
    }

  protected:
    Exception(const CacheableStringPtr& message, const StackTracePtr& stack,
        const ExceptionPtr& cause);

    static bool s_exceptionStackTraceEnabled;

    CacheableStringPtr m_message; //error message
    StackTracePtr m_stack;
    ExceptionPtr m_cause;

  private:
    static void setStackTraces(bool stackTraceEnabled);

    friend class DistributedSystem;
  };

} // namespace gemfire

#endif //ifndef __GEMFIRE_EXCEPTION_H__