third_party/ot-br-posix/repo/src/dbus/server/error_helper.hpp

   1 /*
   2  *    Copyright (c) 2020, The OpenThread Authors.
   3  *    All rights reserved.
   4  *
   5  *    Redistribution and use in source and binary forms, with or without
   6  *    modification, are permitted provided that the following conditions are met:
   7  *    1. Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *    2. Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *    3. Neither the name of the copyright holder nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  *    POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /**
  30  * @file
  31  * This file includes definitions for helpers of handling errors.
  32  */
  33
  34 #ifndef OTBR_DBUS_SERVER_ERROR_HELPER_HPP_
  35 #define OTBR_DBUS_SERVER_ERROR_HELPER_HPP_
  36
  37 #include <string>
  38
  39 #include <dbus/dbus.h>
  40 #include <openthread/error.h>
  41
  42 #include "dbus/common/error.hpp"
  43
  44 namespace otbr {
  45 namespace DBus {
  46
  47 /**
  48  * This function returns the string representation of an otError.
  49  *
  50  * @param[in] aError  The otError value.
  51  *
  52  * @returns The string representation of an otError.
  53  *
  54  */
  55 const char *ConvertToDBusErrorName(otError aError);
  56
  57 } // namespace DBus
  58 } // namespace otbr
  59
  60 #endif // OTBR_DBUS_SERVER_ERROR_HELPER_HPP_