src/lib/support/ErrorStr.h

   1 /*
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *    Copyright (c) 2013-2017 Nest Labs, Inc.
   5  *
   6  *    Licensed under the Apache License, Version 2.0 (the "License");
   7  *    you may not use this file except in compliance with the License.
   8  *    You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *    Unless required by applicable law or agreed to in writing, software
  13  *    distributed under the License is distributed on an "AS IS" BASIS,
  14  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *    See the License for the specific language governing permissions and
  16  *    limitations under the License.
  17  */
  18
  19 /**
  20  *    @file
  21  *      This file defines functions to translate error codes and status reports
  22  *      used throughout the CHIP package into human-readable strings.
  23  *
  24  */
  25
  26 #pragma once
  27
  28 #include <stdint.h>
  29
  30 #include <support/DLLUtil.h>
  31
  32 namespace chip {
  33
  34 struct ErrorFormatter
  35 {
  36     typedef bool (*FormatFunct)(char * buf, uint16_t bufSize, int32_t err);
  37
  38     FormatFunct FormatError;
  39     ErrorFormatter * Next;
  40 };
  41
  42 extern const char * ErrorStr(int32_t err);
  43 extern void RegisterErrorFormatter(ErrorFormatter * errFormatter);
  44 extern void DeregisterErrorFormatter(ErrorFormatter * errFormatter);
  45 extern void FormatError(char * buf, uint16_t bufSize, const char * subsys, int32_t err, const char * desc);
  46
  47 extern const char * StatusReportStr(uint32_t profileId, uint16_t statusCode);
  48
  49 } // namespace chip