le_wdog_interface.h File Reference

#include "legato.h"
#include "le_wdog_common.h"

Go to the source code of this file.

Typedefs
typedef void(*	le_wdog_DisconnectHandler_t) (void *)

Functions
void	le_wdog_ConnectService (void)
le_result_t	le_wdog_TryConnectService (void)
LE_FULL_API void	le_wdog_SetServerDisconnectHandler (le_wdog_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	le_wdog_SetNonExitServerDisconnectHandler (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_result_t	le_wdog_GetWatchdogTimeout (uint64_t *millisecondsPtr)
le_result_t	le_wdog_GetMaxWatchdogTimeout (uint64_t *millisecondsPtr)

Detailed Description

Legato Watchdog Service include file.

Copyright (C) Sierra Wireless Inc.

Typedef Documentation

le_wdog_DisconnectHandler_t

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.

Function Documentation

le_wdog_ConnectService()

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 apiFilesC_client.

This function is created automatically.

le_wdog_TryConnectService()

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 apiFilesC_client.

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.

le_wdog_SetServerDisconnectHandler()

LE_FULL_API 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.

le_wdog_SetNonExitServerDisconnectHandler()

LE_FULL_API void le_wdog_SetNonExitServerDisconnectHandler	(	le_wdog_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning

When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

le_wdog_DisconnectService()

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 apiFilesC_client.

This function is created automatically.

le_wdog_Kick()

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.

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

• LE_WDOG_TIMEOUT_NEVER
• LE_WDOG_TIMEOUT_NOW 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.

le_wdog_Timeout()

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_wdog_GetWatchdogTimeout()

le_result_t le_wdog_GetWatchdogTimeout

(

uint64_t *

millisecondsPtr

)

Get the watchdog timeout configured for this process

Returns

• LE_OK The watchdog timeout is configured and returned
• LE_NOT_FOUND The watchdog timeout is not set

Parameters

[out]

millisecondsPtr

The watchdog timeout set for this process

le_wdog_GetMaxWatchdogTimeout()

le_result_t le_wdog_GetMaxWatchdogTimeout

(

uint64_t *

millisecondsPtr

)

Get the max watchdog timeout configured for this process

Returns

• LE_OK The max watchdog timeout is configured and returned
• LE_NOT_FOUND The max watchdog timeout is not set

Parameters

[out]

millisecondsPtr

The max watchdog timeout set for this process