le_wdog_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	LE_WDOG_TIMEOUT_NEVER   -1
#define	LE_WDOG_TIMEOUT_NOW   0

Functions
void	le_wdog_ConnectService (void)
void	le_wdog_DisconnectService (void)
void	le_wdog_Kick (void)
void	le_wdog_Timeout (int32_t milliseconds)

Detailed Description

Legato Watchdog Service include file.

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

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

Function Documentation

void le_wdog_ConnectService

(

void

)

Special values that have specific meaning when used as durations in Timeout():

• LE_WDOG_TIMEOUT_NEVER
• LE_WDOG_TIMEOUT_NOW Connect the client to the service

void le_wdog_DisconnectService

(

void

)

Disconnect the client from the service

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_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