Files | Macros | Typedefs | Functions

le_pm API Reference

Files

file  le_pm_common.h
 
file  le_pm_interface.h
 

Macros

#define LE_PM_TAG_LEN   31
 
#define LE_PM_TAG_LEN_BYTES   32
 
#define LE_PM_REF_COUNT   1
 

Typedefs

typedef struct le_pm_WakeupSource * le_pm_WakeupSourceRef_t
 
typedef void(* le_pm_DisconnectHandler_t) (void *)
 

Functions

void le_pm_ConnectService (void)
 
le_result_t le_pm_TryConnectService (void)
 
LE_FULL_API void le_pm_SetServerDisconnectHandler (le_pm_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_pm_DisconnectService (void)
 
le_pm_WakeupSourceRef_t le_pm_NewWakeupSource (uint32_t createOpts, const char *LE_NONNULL wsTag)
 
le_result_t le_pm_StayAwake (le_pm_WakeupSourceRef_t wsRef)
 
le_result_t le_pm_Relax (le_pm_WakeupSourceRef_t wsRef)
 
le_result_t le_pm_ForceRelaxAndDestroyAllWakeupSource (void)
 

Detailed Description

Some useful constants

Macro Definition Documentation

◆ LE_PM_REF_COUNT

#define LE_PM_REF_COUNT   1

Option LE_PM_REF_COUNT to manage a reference counted wakeup source

◆ LE_PM_TAG_LEN

#define LE_PM_TAG_LEN   31

Maximum string length for a wake-up source tag (not including the null-terminator)

◆ LE_PM_TAG_LEN_BYTES

#define LE_PM_TAG_LEN_BYTES   32

Maximum string length for a wake-up source tag (including the null-terminator)

Typedef Documentation

◆ le_pm_DisconnectHandler_t

typedef void(* le_pm_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

◆ le_pm_WakeupSourceRef_t

typedef struct le_pm_WakeupSource* le_pm_WakeupSourceRef_t

Reference to wakeup source used by StayAwake and Relax function

Function Documentation

◆ le_pm_ConnectService()

void le_pm_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_pm_DisconnectService()

void le_pm_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_pm_ForceRelaxAndDestroyAllWakeupSource()

le_result_t le_pm_ForceRelaxAndDestroyAllWakeupSource ( void  )

Release and destroy all acquired wakeup source, kill all clients

Returns
  • LE_OK if the wakeup source is acquired
  • LE_NOT_PERMITTED if the le_pm_StayAwake() has not failed with LE_NO_MEMORY
  • LE_FAULT for other errors
Note
The service is available only if le_pm_StayAwake() has returned LE_NO_MEMORY. It should be used in the way to release and destroy all wakeup sources.

◆ le_pm_NewWakeupSource()

le_pm_WakeupSourceRef_t le_pm_NewWakeupSource ( uint32_t  createOpts,
const char *LE_NONNULL  wsTag 
)

Reference to wakeup source used by StayAwake and Relax function Create a wakeup source

Returns
  • Reference to wakeup source (to be used later for acquiring/releasing)
Note
The process exits if an invalid or existing tag is passed
Parameters
[in]createOptsWakeup source options
[in]wsTagContext-specific wakeup source tag

◆ le_pm_Relax()

le_result_t le_pm_Relax ( le_pm_WakeupSourceRef_t  wsRef)

Release a previously acquired wakeup source

Returns
  • LE_OK if the wakeup source is acquired
  • LE_NOT_FOUND if the wakeup source was not currently acquired
  • LE_FAULT for other errors
Note
The process exits if an invalid reference is passed
Parameters
[in]wsRefReference to a created wakeup source

◆ le_pm_SetServerDisconnectHandler()

LE_FULL_API void le_pm_SetServerDisconnectHandler ( le_pm_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_pm_StayAwake()

le_result_t le_pm_StayAwake ( le_pm_WakeupSourceRef_t  wsRef)

Acquire a wakeup source

Returns
  • LE_OK if the wakeup source is acquired
  • LE_NO_MEMORY if the wakeup sources limit is reached
  • LE_FAULT for other errors
Note
The process exits if an invalid reference is passed
The wakeup sources limit is fixed by the kernel CONFIG_PM_WAKELOCKS_LIMIT configuration variable
Parameters
[in]wsRefReference to a created wakeup source

◆ le_pm_TryConnectService()

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