diff options
author | 2020-11-19 12:45:32 +0900 | |
---|---|---|
committer | 2020-11-19 12:45:32 +0900 | |
commit | 8e0e00d21146a84c18f9cf9409e187b4fb0248aa (patch) | |
tree | ef791689dad216ac61091a1d1bd3b928d563aba6 /systemservice/interface_unified/library/include/system_service/ss_sm_client_if_local.h | |
parent | 18df6e21c6743a137e2760c52ca89d0789e90417 (diff) |
Init basesystem source codes.
Signed-off-by: Riku Nomoto <riku_nomoto@mail.toyota.co.jp>
Change-Id: I55aa2f1406ce7f751ae14140b613b53b68995528
Diffstat (limited to 'systemservice/interface_unified/library/include/system_service/ss_sm_client_if_local.h')
-rwxr-xr-x | systemservice/interface_unified/library/include/system_service/ss_sm_client_if_local.h | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/systemservice/interface_unified/library/include/system_service/ss_sm_client_if_local.h b/systemservice/interface_unified/library/include/system_service/ss_sm_client_if_local.h new file mode 100755 index 0000000..a4d0fa9 --- /dev/null +++ b/systemservice/interface_unified/library/include/system_service/ss_sm_client_if_local.h @@ -0,0 +1,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) +/** @}*/ +/** @}*/ +/** @}*/ |