summaryrefslogtreecommitdiff
path: root/ivi-layermanagement-api/ilmCommon/include/ilm_common.h
blob: fa86824a3f9afdd573005e7c0b755fcb7241e808 (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/***************************************************************************
*
* Copyright 2010,2011 BMW Car IT GmbH
* Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
*
*
* 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.
*
****************************************************************************/
#ifndef _ILM_COMMON_H_
#define _ILM_COMMON_H_

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include "ilm_types.h"

/**
 * \brief Initializes the IVI LayerManagement Client.
 *        in case of wayland this API will create a connection to wayland server
 *        and maintain own instance of the wl_display
 * \ingroup ilmCommon
 * \return ILM_SUCCESS if the method call was successful
 * \return ILM_FAILED if a connection can not be established to the services.
 */
ilmErrorTypes ilm_init(void);

/**
 * \brief Initializes the IVI LayerManagement Client.
 *        in case of wayland nativedisplay is the wl_display and connection
 *        will be created to the corresponding wayland server
 * \ingroup ilmCommon
 * \return ILM_SUCCESS if the method call was successful
 * \return ILM_FAILED if a connection can not be established to the services.
 */
ilmErrorTypes ilm_initWithNativedisplay(t_ilm_nativedisplay nativedisplay);

/**
 * \brief Returns initialization state of the IVI LayerManagement Client.
 * \ingroup ilmCommon
 * \return true if client library is initialized
 * \return false if client library is not initialized
 */
t_ilm_bool ilm_isInitialized(void);

/**
 * \brief Commit all changes and execute all enqueued commands since last commit.
 *        All enqueued command on the server site will be executed,
 *        regardless which client enqueued them
 * \ingroup ilmCommon
 * \return ILM_SUCCESS if the method call was successful
 * \return ILM_FAILED if the client can not call the method on the service.
 */
ilmErrorTypes ilm_commitChanges(void);

/**
 * \brief Destroys the IVI LayerManagement Client.
 * \ingroup ilmCommon
 * \return ILM_SUCCESS if the method call was successful
 * \return ILM_FAILED if the client can not be closed or was not initialized.
 */
ilmErrorTypes ilm_destroy(void);



#ifdef __cplusplus
} /**/
#endif /* __cplusplus */

#endif /* _ILM_COMMON_H_ */