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