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 functions for handling d-bus client errors. 32 */ 33 34 #ifndef OTBR_DBUS_CLIENT_CLIENT_ERROR_HPP_ 35 #define OTBR_DBUS_CLIENT_CLIENT_ERROR_HPP_ 36 37 #include "openthread-br/config.h" 38 39 #include <string> 40 41 #include <dbus/dbus.h> 42 43 #include "dbus/common/error.hpp" 44 45 namespace otbr { 46 namespace DBus { 47 48 /** 49 * This function converts an error string to client error. 50 * 51 * @param[in] aErrorName The error string. 52 * 53 * @returns The corresponding otError. OT_ERROR_GENERIC will be returned 54 * if the error name is not defined in OpenThread. 55 */ 56 ClientError ConvertFromDBusErrorName(const std::string &aErrorName); 57 58 /** 59 * This function converts an DBus reply message to otError. 60 * 61 * @param[in] aMessage The dbus reply message. 62 * 63 * @returns The error code encoded in the message. 64 */ 65 ClientError CheckErrorMessage(DBusMessage *aMessage); 66 67 } // namespace DBus 68 } // namespace otbr 69 70 #endif // OTBR_DBUS_CLIENT_CLIENT_ERROR_HPP_ 71