Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Macros | Functions
le_framework_common.h File Reference
#include "legato.h"

Go to the source code of this file.

Macros

#define IFGEN_LE_FRAMEWORK_PROTOCOL_ID   "28525bdc36d66247ae720424d0b28b51"
 
#define IFGEN_LE_FRAMEWORK_MSG_SIZE   12
 

Functions

LE_SHARED bool ifgen_le_framework_HasLocalBinding (void)
 
LE_SHARED void ifgen_le_framework_InitCommonData (void)
 
LE_SHARED void ifgen_le_framework_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_le_framework_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED le_result_t ifgen_le_framework_Stop (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_le_framework_Restart (le_msg_SessionRef_t _ifgen_sessionRef, bool manualRestart)
 
LE_SHARED bool ifgen_le_framework_IsStopping (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED bool ifgen_le_framework_IsReadOnly (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED void ifgen_le_framework_NotifyExpectedReboot (le_msg_SessionRef_t _ifgen_sessionRef)
 

Macro Definition Documentation

◆ IFGEN_LE_FRAMEWORK_PROTOCOL_ID

#define IFGEN_LE_FRAMEWORK_PROTOCOL_ID   "28525bdc36d66247ae720424d0b28b51"

◆ IFGEN_LE_FRAMEWORK_MSG_SIZE

#define IFGEN_LE_FRAMEWORK_MSG_SIZE   12

Function Documentation

◆ ifgen_le_framework_HasLocalBinding()

LE_SHARED bool ifgen_le_framework_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_le_framework_InitCommonData()

LE_SHARED void ifgen_le_framework_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_le_framework_CleanupCommonData()

LE_SHARED void ifgen_le_framework_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_le_framework_OpenSession()

LE_SHARED le_result_t ifgen_le_framework_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_le_framework_Stop()

LE_SHARED le_result_t ifgen_le_framework_Stop ( le_msg_SessionRef_t  _ifgen_sessionRef)

Stops the Legato framework.

Returns
LE_OK if successful. LE_DUPLICATE if the framework is in the process of shutting down (perhaps someone else has already requested the framework be stopped or restarted).

◆ ifgen_le_framework_Restart()

LE_SHARED le_result_t ifgen_le_framework_Restart ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  manualRestart 
)

Restarts the Legato framework.

Returns
LE_OK if the request was accepted and the restart procedure has begun. LE_DUPLICATE if the framework is already in the process of shutting down (perhaps someone else has already requested the framework be stopped or restarted).
Parameters
[in]manualRestartWas the restart manually triggered e.g. "legato restart"

◆ ifgen_le_framework_IsStopping()

LE_SHARED bool ifgen_le_framework_IsStopping ( le_msg_SessionRef_t  _ifgen_sessionRef)

Reports if the Legato framework is stopping.

Returns
true if the framework is stopping or rebooting false otherwise

◆ ifgen_le_framework_IsReadOnly()

LE_SHARED bool ifgen_le_framework_IsReadOnly ( le_msg_SessionRef_t  _ifgen_sessionRef)

Checks whether legato framework is Read-Only or not.

Returns
true if the framework is Read-Only false otherwise

◆ ifgen_le_framework_NotifyExpectedReboot()

LE_SHARED void ifgen_le_framework_NotifyExpectedReboot ( le_msg_SessionRef_t  _ifgen_sessionRef)

Mark the next reboot as expected. Should be called by short lived app that shutdown platform after a small wakeup. This prevents system not to rollback on expected reboot.