video_in_hal/systemservice/interface_unified/library/include/system_service/ss_sm_client_if_local.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 /**
  17  * @file ss_sm_client_if_local.h
  18  * @brief \~english This file supports the api of debug dump response to System Manager
  19  */
  20 /** @addtogroup BaseSystem
  21  *  @{
  22  */
  23 /** @addtogroup system_service
  24  *  @ingroup BaseSystem
  25  *  @{
  26  */
  27 /** @addtogroup interface_unified
  28  *  @ingroup system_service
  29  *  @{
  30  */
  31 #ifndef __SS_SYSTEM_MANAGER_CLIENT_IF_LOCAL_H__  // NOLINT (build/header_guard)
  32 #define __SS_SYSTEM_MANAGER_CLIENT_IF_LOCAL_H__
  33
  34 #include <native_service/frameworkunified_framework_types.h>
  35 ////////////////////////////////////////////////////////////////////////////////////////////
  36 /// \ingroup system_manager
  37 /// \~english @par Summary:
  38 ///       Responds to SystemManager that debug dump output has finished
  39 /// \~english @param [in] f_messageStr
  40 ///       std::string & - Dump data
  41 /// \~english @retval
  42 ///       - None
  43 /// \~english @par Preconditions:
  44 ///       - None
  45 /// \~english @par Change of the internal state:
  46 ///       - No change of internal state by this API occurs
  47 /// \~english @par Causes of failures:
  48 ///       - None
  49 /// \~english @par Detail:
  50 ///       Send OnDebugDumpResponseReceived to SystemManager and request
  51 ///       to write the contents of dump data to /tmp/systemmanager_debugdump.log.\n
  52 ///       The maximum size of the dump buffer is 4KByte.\n
  53 ///       When dumping more than 4KBytes, the overflow from the buffer is discarded.
  54 ///
  55 /// \~english @par Classification:
  56 ///       - Public
  57 /// \~english @see
  58 ///
  59 ////////////////////////////////////////////////////////////////////////////////////////////
  60
  61 VOID SendDebugDumpResponseToSystemManager(std::string & f_messageStr);  // NOLINT (runtime/references)
  62
  63 #endif /*__SS_SYSTEM_MANAGER_CLIENT_IF_LOCAL_H__*/  // NOLINT (build/header_guard)
  64 /** @}*/
  65 /** @}*/
  66 /** @}*/