summaryrefslogtreecommitdiff
path: root/src/persistence_client_library_lc_interface.h
blob: 64332f4c662c7a69b25b8a00f253ebcbc1722704 (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
#ifndef PERSISTENCE_CLIENT_LIBRARY_LC_INTERFACE_H
#define PERSISTENCE_CLIENT_LIBRARY_LC_INTERFACE_H

/******************************************************************************
 * Project         Persistency
 * (c) copyright   2012
 * Company         XS Embedded GmbH
 *****************************************************************************/
/******************************************************************************
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed
 * with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
******************************************************************************/
 /**
 * @file           persistence_client_library_lc_interface.h
 * @ingroup        Persistence client library
 * @author         Ingo Huerner
 * @brief          Implementation of the persistence client library lifecycle interface.
 * @see
 */

#include <dbus/dbus.h>


/**
 * @brief Check if a com.contiautomotive.NodeStateManager.LifecycleConsumer message has been received
 *
 * @param connection the debus connection
 * @param message the dbus message
 * @param user_data data handed over to this function
 *
 * @return DBUS_HANDLER_RESULT_HANDLED or DBUS_HANDLER_RESULT_NOT_YET_HANDLED
 */
DBusHandlerResult checkLifecycleMsg(DBusConnection * connection, DBusMessage * message, void * user_data);


/**
 * @brief send register message 'RegisterShutdownClient' to com.contiautomotive.NodeStateManager.Consumer
 *
 * @return 0 on success or -1 on error
 */
int register_lifecycle();


/**
 * @brief send register message 'UnRegisterShutdownClient' to com.contiautomotive.NodeStateManager.Consumer
 *
 * @return 0 on success or -1 on error
 */
int unregister_lifecycle();


/**
 * @brief process a shutdown message (close all open files, open databases, ...
 *
 * @param requestId the requestID
 */
void process_prepare_shutdown(unsigned char requestId, unsigned int status);



#endif /* PERSISTENCE_CLIENT_LIBRARY_LC_INTERFACE_H */