wdog_interface.h

Go to the documentation of this file.
1 /*
2  * ====================== WARNING ======================
3  *
4  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
5  * DO NOT MODIFY IN ANY WAY.
6  *
7  * ====================== WARNING ======================
8  */
9 
10 /**
11  * @page c_wdog Supervisor Watchdog API
12  *
13  * @ref wdog_interface.h "API Reference"
14  *
15  * A Supervisor API used by the Watchdog daemon to let the Supervisor know that a watched
16  * process has timed out
17  *
18  * <HR>
19  *
20  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
21  */
22 /**
23  * @file wdog_interface.h
24  *
25  * Legato @ref c_wdog include file.
26  *
27  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
28  */
29 
30 #ifndef WDOG_INTERFACE_H_INCLUDE_GUARD
31 #define WDOG_INTERFACE_H_INCLUDE_GUARD
32 
33 
34 #include "legato.h"
35 
36 //--------------------------------------------------------------------------------------------------
37 /**
38  *
39  * Connect the current client thread to the service providing this API. Block until the service is
40  * available.
41  *
42  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
43  * called before any other functions in this API. Normally, ConnectService is automatically called
44  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
45  *
46  * This function is created automatically.
47  */
48 //--------------------------------------------------------------------------------------------------
50 (
51  void
52 );
53 
54 //--------------------------------------------------------------------------------------------------
55 /**
56  *
57  * Try to connect the current client thread to the service providing this API. Return with an error
58  * if the service is not available.
59  *
60  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
61  * called before any other functions in this API. Normally, ConnectService is automatically called
62  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
63  *
64  * This function is created automatically.
65  *
66  * @return
67  * - LE_OK if the client connected successfully to the service.
68  * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
69  * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
70  * - LE_COMM_ERROR if the Service Directory cannot be reached.
71  */
72 //--------------------------------------------------------------------------------------------------
74 (
75  void
76 );
77 
78 //--------------------------------------------------------------------------------------------------
79 /**
80  *
81  * Disconnect the current client thread from the service providing this API.
82  *
83  * Normally, this function doesn't need to be called. After this function is called, there's no
84  * longer a connection to the service, and the functions in this API can't be used. For details, see
85  * @ref apiFilesC_client.
86  *
87  * This function is created automatically.
88  */
89 //--------------------------------------------------------------------------------------------------
91 (
92  void
93 );
94 
95 //--------------------------------------------------------------------------------------------------
96 /**
97  * WatchdogTimedOut is called by the Watchdog Daemon to alert the Supervisor that a watchdog has
98  * timed out and the Supervisor should check for configured actions for that app/process and
99  * execute them.
100  */
101 //--------------------------------------------------------------------------------------------------
103 (
104  uint32_t userId,
105  ///< [IN] [IN] The Id of the user that owns the process
106 
107  uint32_t procId
108  ///< [IN] [IN] The Id of the process that timed out
109 );
110 
111 
112 #endif // WDOG_INTERFACE_H_INCLUDE_GUARD
113 
le_result_t
Definition: le_basics.h:35
void wdog_WatchdogTimedOut(uint32_t userId, uint32_t procId)
void wdog_ConnectService(void)
le_result_t wdog_TryConnectService(void)
void wdog_DisconnectService(void)