LayerManagerClient/ilmCommon/include/ilm_common.h

   1 /***************************************************************************
   2 *
   3 * Copyright 2010,2011 BMW Car IT GmbH
   4 * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
   5 *
   6 *
   7 * Licensed under the Apache License, Version 2.0 (the "License");
   8 * you may not use this file except in compliance with the License.
   9 * You may obtain a copy of the License at
  10 *
  11 *        http://www.apache.org/licenses/LICENSE-2.0
  12 *
  13 * Unless required by applicable law or agreed to in writing, software
  14 * distributed under the License is distributed on an "AS IS" BASIS,
  15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 * See the License for the specific language governing permissions and
  17 * limitations under the License.
  18 *
  19 ****************************************************************************/
  20 #ifndef _ILM_COMMON_H_
  21 #define _ILM_COMMON_H_
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif /* __cplusplus */
  26
  27 #include "ilm_types.h"
  28 #include "ilm_configuration.h"
  29 #include "ilm_tools.h"
  30
  31 extern struct IpcModule gIpcModule;
  32
  33 /**
  34  * \brief Initializes the IVI LayerManagement Client.
  35  * \ingroup ilmCommon
  36  * \return ILM_SUCCESS if the method call was successful
  37  * \return ILM_FAILED if a connection can not be established to the services.
  38  */
  39 ilmErrorTypes ilm_init();
  40
  41 /**
  42  * \brief Returns initialization state of the IVI LayerManagement Client.
  43  * \ingroup ilmCommon
  44  * \return true if client library is initialized
  45  * \return false if client library is not initialized
  46  */
  47 t_ilm_bool ilm_isInitialized();
  48
  49 /**
  50  * \brief Commit all changes and execute all enqueued commands since last commit.
  51  * \ingroup ilmCommon
  52  * \return ILM_SUCCESS if the method call was successful
  53  * \return ILM_FAILED if the client can not call the method on the service.
  54  */
  55 ilmErrorTypes ilm_commitChanges();
  56
  57 /**
  58  * \brief Destroys the IVI LayerManagement Client.
  59  * \ingroup ilmCommon
  60  * \return ILM_SUCCESS if the method call was successful
  61  * \return ILM_FAILED if the client can not be closed or was not initialized.
  62  */
  63 ilmErrorTypes ilm_destroy();
  64
  65
  66
  67 #ifdef __cplusplus
  68 } /**/
  69 #endif /* __cplusplus */
  70
  71 #endif /* _ILM_COMMON_H_ */
  72
  73