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

Enumerations
enum	le_appInfo_State_t { LE_APPINFO_STOPPED, LE_APPINFO_RUNNING }
enum	le_appInfo_ProcState_t { LE_APPINFO_PROC_STOPPED, LE_APPINFO_PROC_RUNNING, LE_APPINFO_PROC_PAUSED }

Functions
void	le_appInfo_ConnectService (void)
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 appNameNumElements)
le_result_t	le_appInfo_GetHash (const char *appName, char *hashStr, size_t hashStrNumElements)

Detailed Description

Legato Application Information API include file.

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

Macro Definition Documentation

#define LE_APPINFO_MD5_STR_LEN   32

Length of an MD5 hash string.

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.
LE_APPINFO_PROC_PAUSED	Process has been paused.

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 client to the service

void le_appInfo_DisconnectService

(

void

)

Disconnect the client from the service

le_result_t le_appInfo_GetHash	(	const char *	appName,
		char *	hashStr,
		size_t	hashStrNumElements
	)

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.

Parameters

[in]	appName	Application name.
[out]	hashStr	Hash string.
[in]	hashStrNumElements

le_result_t le_appInfo_GetName	(	int32_t	pid,
		char *	appName,
		size_t	appNameNumElements
	)

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]	pid	PID of the process.
[out]	appName	Application name.
[in]	appNameNumElements

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.

Parameters

[in]	appName	Application name.
[in]	procName	Process 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.

Parameters

[in]

appName

Application name.