service/notification/cpp-wrapper/common/NSException.h

   1 /******************************************************************
   2  *
   3  * Copyright 2017 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  ******************************************************************/
  20
  21 /**
  22  * @file   NSException.h
  23  *
  24  * @brief   This file provides exception handling for Notification Service.
  25  */
  26
  27 #ifndef _NS_EXCEPTION_H_
  28 #define _NS_EXCEPTION_H_
  29
  30 #include <exception>
  31
  32 namespace OIC
  33 {
  34     namespace Service
  35     {
  36         /**
  37          * @class   NSException
  38          * @brief   This is the base exception of all type of exception thrown from Notification service module.
  39          */
  40         class NSException : public std::exception
  41         {
  42             public:
  43                 /**
  44                       * Constructor of NSException.
  45                       *
  46                       * @param message - String describing the error messsage.
  47                       */
  48                 NSException(const std::string &message) : m_message(message) {}
  49
  50                 /**
  51                       * API to get error message describing exception reason.
  52                       *
  53                       * @return Null terminated string.
  54                       */
  55                 virtual const char *what() const noexcept
  56                 {
  57                     return m_message.c_str();
  58                 }
  59
  60                 virtual ~NSException() throw() {}
  61
  62             private:
  63                 std::string m_message;
  64         };
  65     }
  66 }
  67 #endif /* _NS_EXCEPTION_H_ */