Files | Typedefs | Functions

le_instStat API Reference

Files

file  le_instStat_common.h
 
file  le_instStat_interface.h
 

Typedefs

typedef struct le_instStat_AppInstallEventHandler * le_instStat_AppInstallEventHandlerRef_t
 
typedef struct le_instStat_AppUninstallEventHandler * le_instStat_AppUninstallEventHandlerRef_t
 
typedef void(* le_instStat_AppInstallHandlerFunc_t) (const char *LE_NONNULL appName, void *contextPtr)
 
typedef void(* le_instStat_AppUninstallHandlerFunc_t) (const char *LE_NONNULL appName, void *contextPtr)
 
typedef void(* le_instStat_DisconnectHandler_t) (void *)
 

Functions

void le_instStat_ConnectService (void)
 
le_result_t le_instStat_TryConnectService (void)
 
LE_FULL_API void le_instStat_SetServerDisconnectHandler (le_instStat_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_instStat_DisconnectService (void)
 
le_instStat_AppInstallEventHandlerRef_t le_instStat_AddAppInstallEventHandler (le_instStat_AppInstallHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_instStat_RemoveAppInstallEventHandler (le_instStat_AppInstallEventHandlerRef_t handlerRef)
 
le_instStat_AppUninstallEventHandlerRef_t le_instStat_AddAppUninstallEventHandler (le_instStat_AppUninstallHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_instStat_RemoveAppUninstallEventHandler (le_instStat_AppUninstallEventHandlerRef_t handlerRef)
 

Detailed Description

Typedef Documentation

◆ le_instStat_AppInstallEventHandlerRef_t

typedef struct le_instStat_AppInstallEventHandler* le_instStat_AppInstallEventHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'le_instStat_AppInstallEvent'

◆ le_instStat_AppInstallHandlerFunc_t

typedef void(* le_instStat_AppInstallHandlerFunc_t) (const char *LE_NONNULL appName, void *contextPtr)

Handler for application install. Called when an application is installed.

◆ le_instStat_AppUninstallEventHandlerRef_t

typedef struct le_instStat_AppUninstallEventHandler* le_instStat_AppUninstallEventHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'le_instStat_AppUninstallEvent'

◆ le_instStat_AppUninstallHandlerFunc_t

typedef void(* le_instStat_AppUninstallHandlerFunc_t) (const char *LE_NONNULL appName, void *contextPtr)

Handler for application uninstall. Called when an application is uninstalled.

◆ le_instStat_DisconnectHandler_t

typedef void(* le_instStat_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ le_instStat_AddAppInstallEventHandler()

le_instStat_AppInstallEventHandlerRef_t le_instStat_AddAppInstallEventHandler ( le_instStat_AppInstallHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Handler for application install. Called when an application is installed. Reference type used by Add/Remove functions for EVENT 'le_instStat_AppInstallEvent' Handler for application uninstall. Called when an application is uninstalled. Reference type used by Add/Remove functions for EVENT 'le_instStat_AppUninstallEvent' Add handler function for EVENT 'le_instStat_AppInstallEvent'

This event provides a notification of when an application is installed.

Parameters
[in]handlerPtr
[in]contextPtr

◆ le_instStat_AddAppUninstallEventHandler()

le_instStat_AppUninstallEventHandlerRef_t le_instStat_AddAppUninstallEventHandler ( le_instStat_AppUninstallHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'le_instStat_AppUninstallEvent'

This event provides a notification of when an application is uninstalled.

Parameters
[in]handlerPtr
[in]contextPtr

◆ le_instStat_ConnectService()

void le_instStat_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.

◆ le_instStat_DisconnectService()

void le_instStat_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_instStat_RemoveAppInstallEventHandler()

void le_instStat_RemoveAppInstallEventHandler ( le_instStat_AppInstallEventHandlerRef_t  handlerRef)

Remove handler function for EVENT 'le_instStat_AppInstallEvent'

Parameters
[in]handlerRef

◆ le_instStat_RemoveAppUninstallEventHandler()

void le_instStat_RemoveAppUninstallEventHandler ( le_instStat_AppUninstallEventHandlerRef_t  handlerRef)

Remove handler function for EVENT 'le_instStat_AppUninstallEvent'

Parameters
[in]handlerRef

◆ le_instStat_SetServerDisconnectHandler()

LE_FULL_API void le_instStat_SetServerDisconnectHandler ( le_instStat_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_instStat_TryConnectService()

le_result_t le_instStat_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.