src/cppcache/include/gfcpp/Exception.hpp

#pragma once

#ifndef GEODE_GFCPP_EXCEPTION_H_
#define GEODE_GFCPP_EXCEPTION_H_

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file
 */

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

namespace apache {
namespace geode {
namespace client {

#define GF_EX_MSG_LIMIT 2048

class Exception;
typedef SharedPtr<Exception> ExceptionPtr;

class DistributedSystem;

/**
 * @class Exception Exception.hpp
 * A description of an exception that occurred during a cache operation.
 */
class CPPCACHE_EXPORT Exception : public SharedBase {
  /**
   * @brief public methods
   */
 public:
  /** Creates an exception.
   * @param  msg1 message pointer, this is copied into the exception.
   * @param  msg2 optional extra message pointer, appended to msg1.
   * @param  forceTrace enables a stacktrace for this exception regardless of
   * stacktrace-enabled system property.
   * @param  cause optional cause of the exception which can be later
   *               retrieved using <code>getCause</code>
   **/
  Exception(const char* msg1, const char* msg2 = NULL, bool forceTrace = false,
            const ExceptionPtr& cause = NULLPTR);

  /** Creates an exception as a copy of the given other exception.
   * @param  other the original exception.
   *
   **/
  Exception(const Exception& other);

  /** Create a clone of this exception. */
  virtual Exception* clone() const;

  /**
   * @brief destructor
   */
  virtual ~Exception();

  /** Returns the message pointer
   *
   * @return  message pointer
   */
  virtual const char* getMessage() const;
  /** Show the message pointer
   *
   */
  virtual void showMessage() const;

  /** On some platforms, print a stacktrace from the location the exception
    * was created.
    */
  virtual void printStackTrace() const;

#ifndef _SOLARIS
  /** On some platforms, get a stacktrace string from the location the
    * exception was created.
    */
  virtual size_t getStackTrace(char* buffer, size_t maxLength) const;
#endif

  /** Return the name of this exception type. */
  virtual const char* getName() const;

  /**
   * Throw polymorphically; this allows storing an exception object
   * pointer and throwing it later.
   */
  virtual void raise() { throw * this; }

  inline ExceptionPtr getCause() const { return m_cause; }

 protected:
  /** internal constructor used to clone this exception */
  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 client
}  // namespace geode
}  // namespace apache

#endif // GEODE_GFCPP_EXCEPTION_H_