Macros | Typedefs | Enumerations | Functions

le_appInfo_interface.h File Reference

#include "legato.h"
#include "le_limit_interface.h"

Go to the source code of this file.

Macros

#define LE_APPINFO_MD5_STR_LEN   32
 

Typedefs

typedef void(* le_appInfo_DisconnectHandler_t) (void *)
 

Enumerations

enum  le_appInfo_State_t { LE_APPINFO_STOPPED = 0, LE_APPINFO_RUNNING = 1 }
 
enum  le_appInfo_ProcState_t { LE_APPINFO_PROC_STOPPED = 0, LE_APPINFO_PROC_RUNNING = 1 }
 

Functions

void le_appInfo_ConnectService (void)
 
le_result_t le_appInfo_TryConnectService (void)
 
void le_appInfo_SetServerDisconnectHandler (le_appInfo_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_appInfo_DisconnectService (void)
 
le_appInfo_State_t le_appInfo_GetState (const char *appName)
 
le_appInfo_ProcState_t le_appInfo_GetProcState (const char *appName, const char *procName)
 
le_result_t le_appInfo_GetName (int32_t pid, char *appName, size_t appNameSize)
 
le_result_t le_appInfo_GetHash (const char *appName, char *hashStr, size_t hashStrSize)
 

Detailed Description

Legato Application Information API include file.

Copyright (C) Sierra Wireless Inc.

Macro Definition Documentation

#define LE_APPINFO_MD5_STR_LEN   32

Length of an MD5 hash string.

Typedef Documentation

typedef void(* le_appInfo_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Enumeration Type Documentation

enum le_appInfo_ProcState_t

Process states.

Enumerator
LE_APPINFO_PROC_STOPPED 

Process has been stopped or never started.

LE_APPINFO_PROC_RUNNING 

Process is running.

enum le_appInfo_State_t

Application states.

Enumerator
LE_APPINFO_STOPPED 

Application has been stopped or never started.

LE_APPINFO_RUNNING 

Application is running.

Function Documentation

void le_appInfo_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_appInfo_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_appInfo_GetHash ( const char *  appName,
char *  hashStr,
size_t  hashStrSize 
)

Gets the application hash as a hexidecimal string. The application hash is a unique hash of the current version of the application.

Returns
LE_OK if the application has was successfully retrieved. LE_OVERFLOW if the application hash could not fit in the provided buffer. LE_NOT_FOUND if the application is not installed. LE_FAULT if there was an error.
Note
If the application name pointer is null or if its string is empty or of bad format it is a fatal error, the function will not return.
Parameters
[in]appNameApplication name.
[out]hashStrHash string.
[in]hashStrSize
le_result_t le_appInfo_GetName ( int32_t  pid,
char *  appName,
size_t  appNameSize 
)

Gets the application name of the process with the specified PID.

Returns
LE_OK if the application name was successfully found. LE_OVERFLOW if the application name could not fit in the provided buffer. LE_NOT_FOUND if the process is not part of an application. LE_FAULT if there was an error.
Parameters
[in]pidPID of the process.
[out]appNameApplication name.
[in]appNameSize
le_appInfo_ProcState_t le_appInfo_GetProcState ( const char *  appName,
const char *  procName 
)

Gets the state of the specified process in an application. This function only works for configured processes that the Supervisor starts directly.

Returns
The state of the specified process.
Note
If the application or process names pointers are null or if their strings are empty or of bad format it is a fatal error, the function will not return.
Parameters
[in]appNameApplication name.
[in]procNameProcess name.
le_appInfo_State_t le_appInfo_GetState ( const char *  appName)

Gets the state of the specified application. The state of unknown applications is STOPPED.

Returns
The state of the specified application.
Note
If the application name pointer is null or if its string is empty or of bad format it is a fatal error, the function will not return.
Parameters
[in]appNameApplication name.
void le_appInfo_SetServerDisconnectHandler ( le_appInfo_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_result_t le_appInfo_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.