nsframework/framework_unified/client/NS_NPServiceIf/include/ns_np_service_internal.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 /**
  18  * @file ns_np_service_internal.h
  19  * @brief \~english TestFramework provides interface for implementing functional test classes.
  20  *
  21  */
  22 /** @addtogroup BaseSystem
  23  *  @{
  24  */
  25 /** @addtogroup native_service
  26  *  @ingroup BaseSystem
  27  *  @{
  28  */
  29 /** @addtogroup framework_unified
  30  *  @ingroup native_service
  31  *  @{
  32  */
  33 #ifndef FRAMEWORK_UNIFIED_CLIENT_NS_NPSERVICEIF_INCLUDE_NS_NP_SERVICE_INTERNAL_H_
  34 #define FRAMEWORK_UNIFIED_CLIENT_NS_NPSERVICEIF_INCLUDE_NS_NP_SERVICE_INTERNAL_H_
  35
  36 ///////////////////////////////////////////////////////////////////////////////
  37 // Include Files
  38 ///////////////////////////////////////////////////////////////////////////////
  39 #include <native_service/frameworkunified_types.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 ////////////////////////////////////////////////////////////////////////////////////////////
  46 /// SendStopToNSNPP
  47 /// To be used by System Manager Service only. This API would push NPP Service to persist
  48 /// the data/files. Ideally this should be sent during system shutdown by System Manager Service
  49 ///
  50 /// \param [in] hNPMsgQ
  51 ///         HANDLE - Handle to message queue of Notification service.
  52 /// \param [in] pPublisherName
  53 ///         PCSTR - Name of the requesters message queue
  54 /// \param [in] eShutdownType
  55 ///         EFrameworkunifiedShutdownType - shutdown type
  56 /// \param [in] uiStopMsgData
  57 ///         UI_32 - Flag representing which data to persist and which data to delete
  58 ///         from persistent memory
  59 ///
  60 /// \return status
  61 ///         EFrameworkunifiedStatus - success or error
  62 ////////////////////////////////////////////////////////////////////////////////////////////
  63 EFrameworkunifiedStatus SendStopToNSNPP(HANDLE hNPMsgQ, PCSTR pPublisherName, EFrameworkunifiedShutdownType eShutdownType, UI_32 uiStopMsgData);
  64
  65
  66 #ifdef __cplusplus
  67 }
  68 #endif
  69
  70 #endif  // FRAMEWORK_UNIFIED_CLIENT_NS_NPSERVICEIF_INCLUDE_NS_NP_SERVICE_INTERNAL_H_
  71 /** @}*/
  72 /** @}*/
  73 /** @}*/
  74
  75 // EOF