#include "legato.h"
Go to the source code of this file.
Macros | |
#define | LE_WDOG_TIMEOUT_NEVER -1 |
#define | LE_WDOG_TIMEOUT_NOW 0 |
Typedefs | |
typedef void(* | le_wdog_DisconnectHandler_t) (void *) |
typedef struct le_wdog_ExternalWatchdogHandler * | le_wdog_ExternalWatchdogHandlerRef_t |
typedef void(* | le_wdog_ExternalWatchdogHandlerFunc_t) (void *contextPtr) |
Functions | |
void | le_wdog_ConnectService (void) |
le_result_t | le_wdog_TryConnectService (void) |
void | le_wdog_SetServerDisconnectHandler (le_wdog_DisconnectHandler_t disconnectHandler, void *contextPtr) |
void | le_wdog_DisconnectService (void) |
void | le_wdog_Kick (void) |
void | le_wdog_Timeout (int32_t milliseconds) |
le_wdog_ExternalWatchdogHandlerRef_t | le_wdog_AddExternalWatchdogHandler (int32_t milliseconds, le_wdog_ExternalWatchdogHandlerFunc_t handlerPtr, void *contextPtr) |
void | le_wdog_RemoveExternalWatchdogHandler (le_wdog_ExternalWatchdogHandlerRef_t handlerRef) |
Detailed Description
Legato Watchdog Service include file.
Copyright (C) Sierra Wireless Inc.
Macro Definition Documentation
#define LE_WDOG_TIMEOUT_NEVER -1 |
Suspend the watchdog so that it never times out.
#define LE_WDOG_TIMEOUT_NOW 0 |
Timeout immediately
Typedef Documentation
typedef void(* le_wdog_DisconnectHandler_t) (void *) |
Special values that have specific meaning when used as durations in Timeout():
- LE_WDOG_TIMEOUT_NEVER
- LE_WDOG_TIMEOUT_NOW Type for handler called when a server disconnects.
typedef void(* le_wdog_ExternalWatchdogHandlerFunc_t) (void *contextPtr) |
External watchdog kick handler
typedef struct le_wdog_ExternalWatchdogHandler* le_wdog_ExternalWatchdogHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'le_wdog_ExternalWatchdog'
Function Documentation
le_wdog_ExternalWatchdogHandlerRef_t le_wdog_AddExternalWatchdogHandler | ( | int32_t | milliseconds, |
le_wdog_ExternalWatchdogHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'le_wdog_ExternalWatchdog'
Register an external watchdog kick handler.
Register an handler which will be triggered periodically if all monitored apps are alive.
- Parameters
-
[in] milliseconds The period to kick external watchdog [in] handlerPtr The handler for external watchdog kicks [in] contextPtr
void le_wdog_ConnectService | ( | void | ) |
Connect the current client thread to the service providing this API. Block until the service is available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.
This function is created automatically.
void le_wdog_DisconnectService | ( | void | ) |
Disconnect the current client thread from the service providing this API.
Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.
This function is created automatically.
void le_wdog_Kick | ( | void | ) |
Kicks the watchdog timer.
Once the watchdog has been kicked it must be kicked again before the expiration of the current effective timeout else the configured WatchdogAction will be executed.
void le_wdog_RemoveExternalWatchdogHandler | ( | le_wdog_ExternalWatchdogHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'le_wdog_ExternalWatchdog'
- Parameters
-
[in] handlerRef
void le_wdog_SetServerDisconnectHandler | ( | le_wdog_DisconnectHandler_t | disconnectHandler, |
void * | contextPtr | ||
) |
Set handler called when server disconnection is detected.
When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.
void le_wdog_Timeout | ( | int32_t | milliseconds | ) |
Set a time out.
The watchdog is kicked and a new effective timeout value is set. The new timeout will be effective until the next kick at which point it will revert to the original value.
- Parameters
-
[in] milliseconds The number of milliseconds until this timer expires
le_result_t le_wdog_TryConnectService | ( | void | ) |
Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.
This function is created automatically.
- Returns
- LE_OK if the client connected successfully to the service.
- LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
- LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
- LE_COMM_ERROR if the Service Directory cannot be reached.