Functions

le_sup_wdog_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Functions

void le_sup_wdog_ConnectService (void)
 
le_result_t le_sup_wdog_TryConnectService (void)
 
void le_sup_wdog_DisconnectService (void)
 
void le_sup_wdog_WatchdogTimedOut (uint32_t userId, uint32_t procId)
 

Detailed Description

Legato Supervisor Watchdog API include file.

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

Function Documentation

void le_sup_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_sup_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.

le_result_t le_sup_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.
void le_sup_wdog_WatchdogTimedOut ( uint32_t  userId,
uint32_t  procId 
)

WatchdogTimedOut is called by the Watchdog Daemon to alert the Supervisor that a watchdog has timed out and the Supervisor should check for configured actions for that app/process and execute them.

Parameters
[in]userId[IN] The Id of the user that owns the process
[in]procId[IN] The Id of the process that timed out